chewy 5.2.0 → 6.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (103) hide show
  1. checksums.yaml +4 -4
  2. data/.circleci/config.yml +36 -10
  3. data/CHANGELOG.md +219 -326
  4. data/Gemfile +1 -1
  5. data/README.md +9 -21
  6. data/chewy.gemspec +1 -1
  7. data/gemfiles/rails.6.1.activerecord.gemfile +1 -1
  8. data/lib/chewy/config.rb +2 -20
  9. data/lib/chewy/fields/base.rb +0 -6
  10. data/lib/chewy/index.rb +2 -0
  11. data/lib/chewy/index/actions.rb +5 -1
  12. data/lib/chewy/multi_search.rb +62 -0
  13. data/lib/chewy/search.rb +1 -4
  14. data/lib/chewy/search/pagination/will_paginate.rb +1 -1
  15. data/lib/chewy/search/parameters/none.rb +1 -3
  16. data/lib/chewy/search/request.rb +25 -24
  17. data/lib/chewy/search/scrolling.rb +4 -1
  18. data/lib/chewy/type.rb +4 -1
  19. data/lib/chewy/type/adapter/orm.rb +6 -3
  20. data/lib/chewy/type/import.rb +1 -0
  21. data/lib/chewy/type/syncer.rb +4 -5
  22. data/lib/chewy/type/witchcraft.rb +3 -1
  23. data/lib/chewy/type/wrapper.rb +11 -1
  24. data/lib/chewy/version.rb +1 -1
  25. data/migration_guide.md +18 -0
  26. data/spec/chewy/config_spec.rb +0 -21
  27. data/spec/chewy/index/actions_spec.rb +24 -0
  28. data/spec/chewy/index_spec.rb +16 -39
  29. data/spec/chewy/journal_spec.rb +21 -17
  30. data/spec/chewy/minitest/search_index_receiver_spec.rb +11 -9
  31. data/spec/chewy/multi_search_spec.rb +85 -0
  32. data/spec/chewy/rake_helper_spec.rb +102 -87
  33. data/spec/chewy/rspec/update_index_spec.rb +47 -46
  34. data/spec/chewy/runtime_spec.rb +2 -2
  35. data/spec/chewy/search/parameters/indices_spec.rb +6 -7
  36. data/spec/chewy/search/parameters/none_spec.rb +1 -1
  37. data/spec/chewy/search/parameters_spec.rb +1 -1
  38. data/spec/chewy/search/request_spec.rb +82 -67
  39. data/spec/chewy/search/response_spec.rb +19 -15
  40. data/spec/chewy/search/scrolling_spec.rb +25 -16
  41. data/spec/chewy/search_spec.rb +45 -41
  42. data/spec/chewy/stash_spec.rb +14 -12
  43. data/spec/chewy/type/adapter/active_record_spec.rb +13 -1
  44. data/spec/chewy/type/import/bulk_builder_spec.rb +9 -94
  45. data/spec/chewy/type/import/journal_builder_spec.rb +9 -7
  46. data/spec/chewy/type/mapping_spec.rb +3 -1
  47. data/spec/chewy/type/witchcraft_spec.rb +15 -0
  48. data/spec/chewy/type/wrapper_spec.rb +3 -1
  49. data/spec/chewy_spec.rb +0 -7
  50. data/spec/spec_helper.rb +0 -7
  51. data/spec/support/active_record.rb +20 -0
  52. metadata +8 -78
  53. data/LEGACY_DSL.md +0 -497
  54. data/gemfiles/ruby3.gemfile +0 -10
  55. data/lib/chewy/query.rb +0 -1142
  56. data/lib/chewy/query/compose.rb +0 -68
  57. data/lib/chewy/query/criteria.rb +0 -191
  58. data/lib/chewy/query/filters.rb +0 -244
  59. data/lib/chewy/query/loading.rb +0 -110
  60. data/lib/chewy/query/nodes/and.rb +0 -25
  61. data/lib/chewy/query/nodes/base.rb +0 -17
  62. data/lib/chewy/query/nodes/bool.rb +0 -34
  63. data/lib/chewy/query/nodes/equal.rb +0 -34
  64. data/lib/chewy/query/nodes/exists.rb +0 -20
  65. data/lib/chewy/query/nodes/expr.rb +0 -28
  66. data/lib/chewy/query/nodes/field.rb +0 -110
  67. data/lib/chewy/query/nodes/has_child.rb +0 -15
  68. data/lib/chewy/query/nodes/has_parent.rb +0 -15
  69. data/lib/chewy/query/nodes/has_relation.rb +0 -59
  70. data/lib/chewy/query/nodes/match_all.rb +0 -11
  71. data/lib/chewy/query/nodes/missing.rb +0 -20
  72. data/lib/chewy/query/nodes/not.rb +0 -25
  73. data/lib/chewy/query/nodes/or.rb +0 -25
  74. data/lib/chewy/query/nodes/prefix.rb +0 -19
  75. data/lib/chewy/query/nodes/query.rb +0 -20
  76. data/lib/chewy/query/nodes/range.rb +0 -63
  77. data/lib/chewy/query/nodes/raw.rb +0 -15
  78. data/lib/chewy/query/nodes/regexp.rb +0 -35
  79. data/lib/chewy/query/nodes/script.rb +0 -20
  80. data/lib/chewy/query/pagination.rb +0 -25
  81. data/spec/chewy/query/criteria_spec.rb +0 -700
  82. data/spec/chewy/query/filters_spec.rb +0 -201
  83. data/spec/chewy/query/loading_spec.rb +0 -124
  84. data/spec/chewy/query/nodes/and_spec.rb +0 -12
  85. data/spec/chewy/query/nodes/bool_spec.rb +0 -14
  86. data/spec/chewy/query/nodes/equal_spec.rb +0 -32
  87. data/spec/chewy/query/nodes/exists_spec.rb +0 -18
  88. data/spec/chewy/query/nodes/has_child_spec.rb +0 -59
  89. data/spec/chewy/query/nodes/has_parent_spec.rb +0 -59
  90. data/spec/chewy/query/nodes/match_all_spec.rb +0 -11
  91. data/spec/chewy/query/nodes/missing_spec.rb +0 -16
  92. data/spec/chewy/query/nodes/not_spec.rb +0 -14
  93. data/spec/chewy/query/nodes/or_spec.rb +0 -12
  94. data/spec/chewy/query/nodes/prefix_spec.rb +0 -16
  95. data/spec/chewy/query/nodes/query_spec.rb +0 -12
  96. data/spec/chewy/query/nodes/range_spec.rb +0 -32
  97. data/spec/chewy/query/nodes/raw_spec.rb +0 -11
  98. data/spec/chewy/query/nodes/regexp_spec.rb +0 -43
  99. data/spec/chewy/query/nodes/script_spec.rb +0 -15
  100. data/spec/chewy/query/pagination/kaminari_spec.rb +0 -5
  101. data/spec/chewy/query/pagination/will_paginate_spec.rb +0 -5
  102. data/spec/chewy/query/pagination_spec.rb +0 -39
  103. data/spec/chewy/query_spec.rb +0 -637
@@ -1,68 +0,0 @@
1
- module Chewy
2
- class Query
3
- module Compose
4
- protected
5
-
6
- def _filtered_query(query, filter, options = {})
7
- query = {match_all: {}} if !query.present? && filter.present?
8
-
9
- if filter.present?
10
- filtered = if query.present?
11
- {query: {filtered: {
12
- query: query,
13
- filter: filter
14
- }}}
15
- else
16
- {query: {filtered: {
17
- filter: filter
18
- }}}
19
- end
20
- filtered[:query][:filtered][:strategy] = options[:strategy].to_s if options[:strategy].present?
21
- filtered
22
- elsif query.present?
23
- {query: query}
24
- else
25
- {}
26
- end
27
- end
28
-
29
- def _queries_join(queries, logic)
30
- queries = queries.compact
31
-
32
- if queries.many? || (queries.present? && logic == :must_not)
33
- case logic
34
- when :dis_max
35
- {dis_max: {queries: queries}}
36
- when :must, :should, :must_not
37
- {bool: {logic => queries}}
38
- else
39
- if logic.is_a?(Float)
40
- {dis_max: {queries: queries, tie_breaker: logic}}
41
- else
42
- {bool: {should: queries, minimum_should_match: logic}}
43
- end
44
- end
45
- else
46
- queries.first
47
- end
48
- end
49
-
50
- def _filters_join(filters, logic)
51
- filters = filters.compact
52
-
53
- if filters.many? || (filters.present? && logic == :must_not)
54
- case logic
55
- when :and, :or
56
- {logic => filters}
57
- when :must, :should, :must_not
58
- {bool: {logic => filters}}
59
- else
60
- {bool: {should: filters, minimum_should_match: logic}}
61
- end
62
- else
63
- filters.first
64
- end
65
- end
66
- end
67
- end
68
- end
@@ -1,191 +0,0 @@
1
- require 'chewy/query/compose'
2
-
3
- module Chewy
4
- class Query
5
- class Criteria
6
- include Compose
7
- ARRAY_STORAGES = %i[queries filters post_filters sort fields types scores].freeze
8
- HASH_STORAGES = %i[options search_options request_options facets aggregations suggest script_fields].freeze
9
- STORAGES = ARRAY_STORAGES + HASH_STORAGES
10
-
11
- def initialize(options = {})
12
- @options = options.merge(
13
- query_mode: Chewy.query_mode,
14
- filter_mode: Chewy.filter_mode,
15
- post_filter_mode: Chewy.post_filter_mode || Chewy.filter_mode
16
- )
17
- end
18
-
19
- def ==(other)
20
- other.is_a?(self.class) && storages == other.storages
21
- end
22
-
23
- {ARRAY_STORAGES => '[]', HASH_STORAGES => '{}'}.each do |storages, default|
24
- storages.each do |storage|
25
- class_eval <<-METHODS, __FILE__, __LINE__ + 1
26
- def #{storage}
27
- @#{storage} ||= #{default}
28
- end
29
- METHODS
30
- end
31
- end
32
-
33
- STORAGES.each do |storage|
34
- define_method "#{storage}?" do
35
- send(storage).any?
36
- end
37
- end
38
-
39
- def none?
40
- !!options[:none]
41
- end
42
-
43
- def update_options(modifier)
44
- options.merge!(modifier)
45
- end
46
-
47
- def update_request_options(modifier)
48
- request_options.merge!(modifier)
49
- end
50
-
51
- def update_search_options(modifier)
52
- search_options.merge!(modifier)
53
- end
54
-
55
- def update_facets(modifier)
56
- facets.merge!(modifier)
57
- end
58
-
59
- def update_scores(modifier)
60
- @scores = scores + Array.wrap(modifier).reject(&:blank?)
61
- end
62
-
63
- def update_aggregations(modifier)
64
- aggregations.merge!(modifier)
65
- end
66
-
67
- def update_suggest(modifier)
68
- suggest.merge!(modifier)
69
- end
70
-
71
- def update_script_fields(modifier)
72
- script_fields.merge!(modifier)
73
- end
74
-
75
- %i[filters queries post_filters].each do |storage|
76
- class_eval <<-RUBY, __FILE__, __LINE__ + 1
77
- def update_#{storage}(modifier)
78
- @#{storage} = #{storage} + Array.wrap(modifier).reject(&:blank?)
79
- end
80
- RUBY
81
- end
82
-
83
- def update_sort(modifier, options = {})
84
- @sort = nil if options[:purge]
85
- modifier = Array.wrap(modifier).flatten.map do |element|
86
- element.is_a?(Hash) ? element.map { |k, v| {k => v} } : element
87
- end.flatten
88
- @sort = sort + modifier
89
- end
90
-
91
- %w[fields types].each do |storage|
92
- define_method "update_#{storage}" do |modifier, options = {}|
93
- variable = "@#{storage}"
94
- instance_variable_set(variable, nil) if options[:purge]
95
- modifier = send(storage) | Array.wrap(modifier).flatten.map(&:to_s).reject(&:blank?)
96
- instance_variable_set(variable, modifier)
97
- end
98
- end
99
-
100
- def merge!(other)
101
- STORAGES.each do |storage|
102
- send("update_#{storage}", other.send(storage))
103
- end
104
- self
105
- end
106
-
107
- def merge(other)
108
- clone.merge!(other)
109
- end
110
-
111
- def request_body
112
- body = _filtered_query(_request_query, _request_filter, options.slice(:strategy))
113
-
114
- if options[:simple]
115
- {body: body.presence || {query: {match_all: {}}}}
116
- else
117
- body[:post_filter] = _request_post_filter if post_filters?
118
- body[:facets] = facets if facets?
119
- body[:aggregations] = aggregations if aggregations?
120
- body[:suggest] = suggest if suggest?
121
- body[:sort] = sort if sort?
122
- body[:_source] = fields if fields?
123
- body[:script_fields] = script_fields if script_fields?
124
-
125
- body = _boost_query(body)
126
-
127
- {body: body.merge!(_request_options)}.merge!(search_options)
128
- end
129
- end
130
-
131
- protected
132
-
133
- def storages
134
- STORAGES.map { |storage| send(storage) }
135
- end
136
-
137
- def initialize_clone(origin)
138
- STORAGES.each do |storage|
139
- value = origin.send(storage)
140
- instance_variable_set("@#{storage}", value.deep_dup)
141
- end
142
- end
143
-
144
- def _boost_query(body)
145
- return body unless scores?
146
- query = body.delete :query
147
- filter = body.delete :filter
148
- if query && filter
149
- query = {filtered: {query: query, filter: filter}}
150
- filter = nil
151
- end
152
- score = {}
153
- score[:functions] = scores
154
- score[:boost_mode] = options[:boost_mode] if options[:boost_mode]
155
- score[:score_mode] = options[:score_mode] if options[:score_mode]
156
- score[:query] = query if query
157
- score[:filter] = filter if filter
158
- body.tap { |b| b[:query] = {function_score: score} }
159
- end
160
-
161
- def _request_options
162
- Hash[request_options.map do |key, value|
163
- [key, value.is_a?(Proc) ? value.call : value]
164
- end]
165
- end
166
-
167
- def _request_query
168
- _queries_join(queries, options[:query_mode])
169
- end
170
-
171
- def _request_filter
172
- filter_mode = options[:filter_mode]
173
- request_filter = if filter_mode == :and
174
- filters
175
- else
176
- [_filters_join(filters, filter_mode)]
177
- end
178
-
179
- _filters_join([_request_types, *request_filter], :and)
180
- end
181
-
182
- def _request_types
183
- _filters_join(types.map { |type| {type: {value: type}} }, :or)
184
- end
185
-
186
- def _request_post_filter
187
- _filters_join(post_filters, options[:post_filter_mode])
188
- end
189
- end
190
- end
191
- end
@@ -1,244 +0,0 @@
1
- require 'chewy/query/nodes/base'
2
- require 'chewy/query/nodes/expr'
3
- require 'chewy/query/nodes/field'
4
- require 'chewy/query/nodes/bool'
5
- require 'chewy/query/nodes/and'
6
- require 'chewy/query/nodes/or'
7
- require 'chewy/query/nodes/not'
8
- require 'chewy/query/nodes/raw'
9
- require 'chewy/query/nodes/exists'
10
- require 'chewy/query/nodes/missing'
11
- require 'chewy/query/nodes/range'
12
- require 'chewy/query/nodes/prefix'
13
- require 'chewy/query/nodes/regexp'
14
- require 'chewy/query/nodes/equal'
15
- require 'chewy/query/nodes/query'
16
- require 'chewy/query/nodes/script'
17
- require 'chewy/query/nodes/has_child'
18
- require 'chewy/query/nodes/has_parent'
19
- require 'chewy/query/nodes/match_all'
20
-
21
- module Chewy
22
- class Query
23
- # Context provides simplified DSL functionality for filters declaring.
24
- # You can use logic operations <tt>&</tt> and <tt>|</tt> to concat
25
- # expressions.
26
- #
27
- # @example
28
- # UsersIndex.filter{ (article.title =~ /Honey/) & (age < 42) & !rate }
29
- #
30
- #
31
- class Filters
32
- def initialize(outer = nil, &block)
33
- @block = block
34
- @outer = outer || eval('self', block.binding, __FILE__, __LINE__)
35
- end
36
-
37
- # Outer scope call
38
- # Block evaluates in the external context
39
- #
40
- # @example
41
- # def name
42
- # 'Friend'
43
- # end
44
- #
45
- # UsersIndex.filter{ name == o{ name } } # => {filter: {term: {name: 'Friend'}}}
46
- #
47
- def o(&block)
48
- @outer.instance_exec(&block)
49
- end
50
-
51
- # Returns field node
52
- # Used if method_missing is not working by some reason.
53
- # Additional expression options might be passed as second argument hash.
54
- #
55
- # @example
56
- # UsersIndex.filter{ f(:name) == 'Name' } == UsersIndex.filter{ name == 'Name' } # => true
57
- # UsersIndex.filter{ f(:name, execution: :bool) == ['Name1', 'Name2'] } ==
58
- # UsersIndex.filter{ name(execution: :bool) == ['Name1', 'Name2'] } # => true
59
- #
60
- # Supports block for getting field name from the outer scope
61
- #
62
- # @example
63
- # def field
64
- # :name
65
- # end
66
- #
67
- # UsersIndex.filter{ f{ field } == 'Name' } == UsersIndex.filter{ name == 'Name' } # => true
68
- #
69
- def f(name = nil, *args, &block)
70
- name = block ? o(&block) : name
71
- Nodes::Field.new name, *args
72
- end
73
-
74
- # Returns script filter
75
- # Just script filter. Supports additional params.
76
- #
77
- # @example
78
- # UsersIndex.filter{ s('doc["num1"].value > 1') }
79
- # UsersIndex.filter{ s('doc["num1"].value > param1', param1: 42) }
80
- #
81
- # Supports block for getting script from the outer scope
82
- #
83
- # @example
84
- # def script
85
- # 'doc["num1"].value > param1 || 1'
86
- # end
87
- #
88
- # UsersIndex.filter{ s{ script } } == UsersIndex.filter{ s('doc["num1"].value > 1') } # => true
89
- # UsersIndex.filter{ s(param1: 42) { script } } == UsersIndex.filter{ s('doc["num1"].value > 1', param1: 42) } # => true
90
- #
91
- def s(*args, &block)
92
- params = args.extract_options!
93
- script = block ? o(&block) : args.first
94
- Nodes::Script.new script, params
95
- end
96
-
97
- # Returns query filter
98
- #
99
- # @example
100
- # UsersIndex.filter{ q(query_string: {query: 'name: hello'}) }
101
- #
102
- # Supports block for getting query from the outer scope
103
- #
104
- # @example
105
- # def query
106
- # {query_string: {query: 'name: hello'}}
107
- # end
108
- #
109
- # UsersIndex.filter{ q{ query } } == UsersIndex.filter{ q(query_string: {query: 'name: hello'}) } # => true
110
- #
111
- def q(query = nil, &block)
112
- Nodes::Query.new block ? o(&block) : query
113
- end
114
-
115
- # Returns raw expression
116
- # Same as filter with arguments instead of block, but can participate in expressions
117
- #
118
- # @example
119
- # UsersIndex.filter{ r(term: {name: 'Name'}) }
120
- # UsersIndex.filter{ r(term: {name: 'Name'}) & (age < 42) }
121
- #
122
- # Supports block for getting raw filter from the outer scope
123
- #
124
- # @example
125
- # def filter
126
- # {term: {name: 'Name'}}
127
- # end
128
- #
129
- # UsersIndex.filter{ r{ filter } } == UsersIndex.filter{ r(term: {name: 'Name'}) } # => true
130
- # UsersIndex.filter{ r{ filter } } == UsersIndex.filter(term: {name: 'Name'}) # => true
131
- #
132
- def r(raw = nil, &block)
133
- Nodes::Raw.new block ? o(&block) : raw
134
- end
135
-
136
- # Bool filter chainable methods
137
- # Used to create bool query. Nodes are passed as arguments.
138
- #
139
- # @example
140
- # UsersIndex.filter{ must(age < 42, name == 'Name') }
141
- # UsersIndex.filter{ should(age < 42, name == 'Name') }
142
- # UsersIndex.filter{ must(age < 42).should(name == 'Name1', name == 'Name2') }
143
- # UsersIndex.filter{ should_not(age >= 42).must(name == 'Name1') }
144
- #
145
- %w[must must_not should].each do |method|
146
- define_method method do |*exprs|
147
- Nodes::Bool.new.send(method, *exprs)
148
- end
149
- end
150
-
151
- # Initializes has_child filter.
152
- # Chainable interface acts the same as main query interface. You can pass plain
153
- # filters or plain queries or filter with DSL block.
154
- #
155
- # @example
156
- # UsersIndex.filter{ has_child('user').filter(term: {role: 'Admin'}) }
157
- # UsersIndex.filter{ has_child('user').filter{ role == 'Admin' } }
158
- # UsersIndex.filter{ has_child('user').query(match: {name: 'borogoves'}) }
159
- #
160
- # Filters and queries might be combined and filter_mode and query_mode are configurable:
161
- #
162
- # @example
163
- # UsersIndex.filter do
164
- # has_child('user')
165
- # .filter{ name: 'Peter' }
166
- # .query(match: {name: 'Peter'})
167
- # .filter{ age > 42 }
168
- # .filter_mode(:or)
169
- # end
170
- #
171
- def has_child(type) # rubocop:disable Naming/PredicateName
172
- Nodes::HasChild.new(type, @outer)
173
- end
174
-
175
- # Initializes has_parent filter.
176
- # Chainable interface acts the same as main query interface. You can pass plain
177
- # filters or plain queries or filter with DSL block.
178
- #
179
- # @example
180
- # UsersIndex.filter{ has_parent('user').filter(term: {role: 'Admin'}) }
181
- # UsersIndex.filter{ has_parent('user').filter{ role == 'Admin' } }
182
- # UsersIndex.filter{ has_parent('user').query(match: {name: 'borogoves'}) }
183
- #
184
- # Filters and queries might be combined and filter_mode and query_mode are configurable:
185
- #
186
- # @example
187
- # UsersIndex.filter do
188
- # has_parent('user')
189
- # .filter{ name: 'Peter' }
190
- # .query(match: {name: 'Peter'})
191
- # .filter{ age > 42 }
192
- # .filter_mode(:or)
193
- # end
194
- #
195
- def has_parent(type) # rubocop:disable Naming/PredicateName
196
- Nodes::HasParent.new(type, @outer)
197
- end
198
-
199
- # Just simple match_all filter.
200
- #
201
- def match_all
202
- Nodes::MatchAll.new
203
- end
204
-
205
- # Creates field or exists node
206
- # Additional options for further expression might be passed as hash
207
- #
208
- # @example
209
- # UsersIndex.filter{ name == 'Name' } == UsersIndex.filter(term: {name: 'Name'}) # => true
210
- # UsersIndex.filter{ name? } == UsersIndex.filter(exists: {term: 'name'}) # => true
211
- # UsersIndex.filter{ name(execution: :bool) == ['Name1', 'Name2'] } ==
212
- # UsersIndex.filter(terms: {name: ['Name1', 'Name2'], execution: :bool}) # => true
213
- #
214
- # Also field names might be chained to use dot-notation for ES field names
215
- #
216
- # @example
217
- # UsersIndex.filter{ article.title =~ 'Hello' }
218
- # UsersIndex.filter{ article.tags? }
219
- #
220
- def method_missing(method, *args) # rubocop:disable Style/MethodMissing
221
- method = method.to_s
222
- if method =~ /\?\Z/
223
- Nodes::Exists.new method.gsub(/\?\Z/, '')
224
- else
225
- f method, *args
226
- end
227
- end
228
-
229
- # Evaluates context block, returns top node.
230
- # For internal usage.
231
- #
232
- def __result__
233
- instance_exec(&@block)
234
- end
235
-
236
- # Renders evaluated filters.
237
- # For internal usage.
238
- #
239
- def __render__
240
- __result__.__render__ # haha, wtf?
241
- end
242
- end
243
- end
244
- end