Skip to content

Commit 43eda24

Browse files
russcamMpdreamz
authored andcommitted
Deprecate fuzziness ratio (#2045)
See #1997 It looks like this was deprecated in 1.7 and removed in 2.0 - https://www.elastic.co/guide/en/elasticsearch/reference/1.7/common-options.html#fuzziness Since it still exists in NEST 2.x, I've marked as deprecated here - will no-op in NEST 2.x
1 parent 90b6ae1 commit 43eda24

File tree

8 files changed

+25
-3
lines changed

8 files changed

+25
-3
lines changed

Diff for: src/Nest/DSL/Suggest/Fuzziness.cs

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
namespace Nest
1+
using System;
2+
3+
namespace Nest
24
{
35
public class Fuzziness : IFuzziness
46
{
@@ -7,6 +9,8 @@ public class Fuzziness : IFuzziness
79
private double? _ratio;
810
bool IFuzziness.Auto { get { return this._auto; } }
911
int? IFuzziness.EditDistance { get { return this._editDistance; } }
12+
13+
[Obsolete("Deprecated in Elasticsearch 2.0")]
1014
double? IFuzziness.Ratio { get { return this._ratio; } }
1115

1216
public static Fuzziness Auto { get { return new Fuzziness() { _auto = true }; } }
@@ -16,6 +20,7 @@ public static Fuzziness EditDistance(int distance)
1620
return new Fuzziness() { _editDistance = distance };
1721
}
1822

23+
[Obsolete("Deprecated in Elasticsearch 2.0")]
1924
public static Fuzziness Ratio(double ratio)
2025
{
2126
return new Fuzziness() { _ratio = ratio };

Diff for: src/Nest/DSL/Suggest/FuzzySuggestDescriptor.cs

+2
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ public FuzzySuggestDescriptor<T> Fuzziness(int editDistance)
5959
Self.Fuzziness = Nest.Fuzziness.EditDistance(editDistance);
6060
return this;
6161
}
62+
63+
[Obsolete("Deprecated in Elasticsearch 2.0")]
6264
public FuzzySuggestDescriptor<T> Fuzziness(double ratio)
6365
{
6466
Self.Fuzziness = Nest.Fuzziness.Ratio(ratio);

Diff for: src/Nest/DSL/Suggest/IFuzziness.cs

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
using Nest.Resolvers.Converters;
1+
using System;
2+
using Nest.Resolvers.Converters;
23
using Newtonsoft.Json;
34

45
namespace Nest
@@ -8,6 +9,8 @@ public interface IFuzziness
89
{
910
bool Auto { get; }
1011
int? EditDistance { get; }
12+
13+
[Obsolete("Deprecated in Elasticsearch 2.0")]
1114
double? Ratio { get; }
1215
}
1316
}

Diff for: src/Nest/Resolvers/Converters/FuzzinessConverter.cs

+5-1
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,10 @@ public override void WriteJson(JsonWriter writer, object value, JsonSerializer s
1515
{
1616
var v = value as IFuzziness;
1717
if (v.Auto) writer.WriteValue("AUTO");
18-
else if (v.EditDistance.HasValue) writer.WriteValue(v.EditDistance.Value);
18+
else if (v.EditDistance.HasValue) writer.WriteValue(v.EditDistance.Value);
19+
#pragma warning disable 618
1920
else if (v.Ratio.HasValue) writer.WriteValue(v.Ratio.Value);
21+
#pragma warning restore 618
2022
else writer.WriteNull();
2123
}
2224

@@ -32,7 +34,9 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist
3234
if (reader.TokenType == JsonToken.Float)
3335
{
3436
var ratio = (reader.Value as double?).GetValueOrDefault(0);
37+
#pragma warning disable 618
3538
return Fuzziness.Ratio(ratio);
39+
#pragma warning restore 618
3640
}
3741
return null;
3842
}

Diff for: src/Tests/Nest.Tests.Unit/ObjectInitializer/Search/SearchRequestTests.cs

+2
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,9 @@ public SearchRequestTests()
7474
ShardSize = 10,
7575
Fuzzy = new FuzzySuggester
7676
{
77+
#pragma warning disable 618
7778
Fuzziness = Fuzziness.Ratio(0.3),
79+
#pragma warning restore 618
7880
PrefixLength = 4
7981
}
8082

Diff for: src/Tests/Nest.Tests.Unit/ObjectInitializer/Suggest/SuggestRequestTests.cs

+2
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ public SuggestRequestTests()
3333
ShardSize = 10,
3434
Fuzzy = new FuzzySuggester
3535
{
36+
#pragma warning disable 618
3637
Fuzziness = Fuzziness.Ratio(0.3),
38+
#pragma warning restore 618
3739
PrefixLength = 4
3840
}
3941
}

Diff for: src/Tests/Nest.Tests.Unit/Search/InitializerSyntax/InitializerExample.cs

+2
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,9 @@ public void FullExample_InitializerSyntax_Search()
9494
ShardSize = 10,
9595
Fuzzy = new FuzzySuggester
9696
{
97+
#pragma warning disable 618
9798
Fuzziness = Fuzziness.Ratio(0.3),
99+
#pragma warning restore 618
98100
PrefixLength = 4
99101
}
100102

Diff for: src/Tests/Nest.Tests.Unit/Search/Suggest/CompletionSuggestTests.cs

+2
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,9 @@ public void CompletionSuggestDescriptorFuzzinessDoubleTest()
9393
var completionSuggestDescriptor = new CompletionSuggestDescriptor<ElasticsearchProject>()
9494
.OnField("suggest")
9595
.Text("n")
96+
#pragma warning disable 618
9697
.Fuzzy(f => f.Fuzziness(0.4));
98+
#pragma warning restore 618
9799

98100
var json = TestElasticClient.Serialize(completionSuggestDescriptor);
99101

0 commit comments

Comments
 (0)