elasticsearch-model 6.1.1 → 7.2.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitignore +3 -1
- data/Gemfile +18 -1
- data/LICENSE.txt +199 -10
- data/README.md +47 -48
- data/Rakefile +29 -13
- data/elasticsearch-model.gemspec +53 -39
- data/examples/activerecord_article.rb +17 -0
- data/examples/activerecord_associations.rb +34 -1
- data/examples/activerecord_custom_analyzer.rb +19 -2
- data/examples/activerecord_mapping_completion.rb +17 -0
- data/examples/activerecord_mapping_edge_ngram.rb +17 -0
- data/examples/couchbase_article.rb +17 -0
- data/examples/datamapper_article.rb +17 -0
- data/examples/mongoid_article.rb +17 -0
- data/examples/ohm_article.rb +17 -0
- data/examples/riak_article.rb +17 -0
- data/gemfiles/3.0.gemfile +18 -1
- data/gemfiles/4.0.gemfile +18 -1
- data/gemfiles/5.0.gemfile +18 -1
- data/gemfiles/6.0.gemfile +21 -3
- data/lib/elasticsearch/model/adapter.rb +17 -0
- data/lib/elasticsearch/model/adapters/active_record.rb +17 -0
- data/lib/elasticsearch/model/adapters/default.rb +17 -0
- data/lib/elasticsearch/model/adapters/mongoid.rb +17 -0
- data/lib/elasticsearch/model/adapters/multiple.rb +29 -4
- data/lib/elasticsearch/model/callbacks.rb +17 -0
- data/lib/elasticsearch/model/client.rb +17 -5
- data/lib/elasticsearch/model/ext/active_record.rb +17 -0
- data/lib/elasticsearch/model/hash_wrapper.rb +17 -0
- data/lib/elasticsearch/model/importing.rb +60 -16
- data/lib/elasticsearch/model/indexing.rb +72 -46
- data/lib/elasticsearch/model/multimodel.rb +18 -1
- data/lib/elasticsearch/model/naming.rb +19 -19
- data/lib/elasticsearch/model/proxy.rb +64 -24
- data/lib/elasticsearch/model/response/aggregations.rb +17 -0
- data/lib/elasticsearch/model/response/base.rb +22 -1
- data/lib/elasticsearch/model/response/pagination/kaminari.rb +17 -0
- data/lib/elasticsearch/model/response/pagination/will_paginate.rb +17 -0
- data/lib/elasticsearch/model/response/pagination.rb +17 -0
- data/lib/elasticsearch/model/response/records.rb +17 -1
- data/lib/elasticsearch/model/response/result.rb +17 -0
- data/lib/elasticsearch/model/response/results.rb +18 -0
- data/lib/elasticsearch/model/response/suggestions.rb +17 -0
- data/lib/elasticsearch/model/response.rb +17 -0
- data/lib/elasticsearch/model/searching.rb +17 -0
- data/lib/elasticsearch/model/serializing.rb +17 -0
- data/lib/elasticsearch/model/version.rb +18 -1
- data/lib/elasticsearch/model.rb +27 -62
- data/spec/elasticsearch/model/adapter_spec.rb +17 -0
- data/spec/elasticsearch/model/adapters/active_record/associations_spec.rb +17 -0
- data/spec/elasticsearch/model/adapters/active_record/basic_spec.rb +281 -226
- data/spec/elasticsearch/model/adapters/active_record/dynamic_index_name_spec.rb +17 -0
- data/spec/elasticsearch/model/adapters/active_record/import_spec.rb +18 -12
- data/spec/elasticsearch/model/adapters/active_record/multi_model_spec.rb +17 -0
- data/spec/elasticsearch/model/adapters/active_record/namespaced_model_spec.rb +18 -1
- data/spec/elasticsearch/model/adapters/active_record/pagination_spec.rb +17 -0
- data/spec/elasticsearch/model/adapters/active_record/parent_child_spec.rb +18 -1
- data/spec/elasticsearch/model/adapters/active_record/serialization_spec.rb +17 -0
- data/spec/elasticsearch/model/adapters/active_record_spec.rb +17 -0
- data/spec/elasticsearch/model/adapters/default_spec.rb +17 -0
- data/spec/elasticsearch/model/adapters/mongoid/basic_spec.rb +17 -0
- data/spec/elasticsearch/model/adapters/mongoid/multi_model_spec.rb +28 -11
- data/spec/elasticsearch/model/adapters/mongoid_spec.rb +17 -0
- data/spec/elasticsearch/model/adapters/multiple_spec.rb +17 -0
- data/spec/elasticsearch/model/callbacks_spec.rb +17 -0
- data/spec/elasticsearch/model/client_spec.rb +20 -3
- data/spec/elasticsearch/model/hash_wrapper_spec.rb +17 -0
- data/spec/elasticsearch/model/importing_spec.rb +29 -0
- data/spec/elasticsearch/model/indexing_spec.rb +127 -56
- data/spec/elasticsearch/model/module_spec.rb +19 -26
- data/spec/elasticsearch/model/multimodel_spec.rb +17 -0
- data/spec/elasticsearch/model/naming_spec.rb +22 -5
- data/spec/elasticsearch/model/proxy_spec.rb +26 -1
- data/spec/elasticsearch/model/response/aggregations_spec.rb +17 -0
- data/spec/elasticsearch/model/response/base_spec.rb +17 -0
- data/spec/elasticsearch/model/response/pagination/kaminari_spec.rb +85 -23
- data/spec/elasticsearch/model/response/pagination/will_paginate_spec.rb +17 -0
- data/spec/elasticsearch/model/response/records_spec.rb +17 -0
- data/spec/elasticsearch/model/response/response_spec.rb +17 -0
- data/spec/elasticsearch/model/response/result_spec.rb +17 -0
- data/spec/elasticsearch/model/response/results_spec.rb +29 -0
- data/spec/elasticsearch/model/searching_search_request_spec.rb +17 -0
- data/spec/elasticsearch/model/searching_spec.rb +17 -0
- data/spec/elasticsearch/model/serializing_spec.rb +17 -0
- data/spec/spec_helper.rb +37 -5
- data/spec/support/app/answer.rb +18 -1
- data/spec/support/app/article.rb +17 -0
- data/spec/support/app/article_for_pagination.rb +17 -0
- data/spec/support/app/article_no_type.rb +37 -0
- data/spec/support/app/article_with_custom_serialization.rb +17 -0
- data/spec/support/app/article_with_dynamic_index_name.rb +17 -0
- data/spec/support/app/author.rb +17 -0
- data/spec/support/app/authorship.rb +17 -0
- data/spec/support/app/category.rb +17 -0
- data/spec/support/app/comment.rb +17 -0
- data/spec/support/app/episode.rb +17 -0
- data/spec/support/app/image.rb +17 -0
- data/spec/support/app/import_article.rb +17 -0
- data/spec/support/app/mongoid_article.rb +17 -0
- data/spec/support/app/namespaced_book.rb +17 -0
- data/spec/support/app/parent_and_child_searchable.rb +21 -4
- data/spec/support/app/post.rb +17 -0
- data/spec/support/app/question.rb +17 -0
- data/spec/support/app/searchable.rb +17 -0
- data/spec/support/app/series.rb +17 -0
- data/spec/support/app.rb +27 -2
- metadata +42 -56
- data/spec/elasticsearch/model/naming_inheritance_spec.rb +0 -184
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e1aecf263867f2176d7819eccd7e23f9b37bc85132223b8f64398ab85736ea75
|
4
|
+
data.tar.gz: af80ff000fcf065f2694141bfcdc282a947cfea05f5ece2f11a24897f5753039
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 246ae4f642a662a4a0c5fe6e26581c052c15ddf868d9b47b640c3f996e584056a8facc4004d61151647e67e6624d1bb16cad90a4513f303ad0afdeaf84b1eedf
|
7
|
+
data.tar.gz: 406c37164bb6fc16068d2edcf6e1183d9c2ba34420d57fab9d3f288416fd0d75173ecc4ad3f37236051d517db717c4fb37ae2d44663f87a6b28213637ea8f7a5
|
data/.gitignore
CHANGED
data/Gemfile
CHANGED
@@ -1,9 +1,26 @@
|
|
1
|
+
# Licensed to Elasticsearch B.V. under one or more contributor
|
2
|
+
# license agreements. See the NOTICE file distributed with
|
3
|
+
# this work for additional information regarding copyright
|
4
|
+
# ownership. Elasticsearch B.V. licenses this file to you under
|
5
|
+
# the Apache License, Version 2.0 (the "License"); you may
|
6
|
+
# not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing,
|
12
|
+
# software distributed under the License is distributed on an
|
13
|
+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
14
|
+
# KIND, either express or implied. See the License for the
|
15
|
+
# specific language governing permissions and limitations
|
16
|
+
# under the License.
|
17
|
+
|
1
18
|
source 'https://rubygems.org'
|
2
19
|
|
3
20
|
# Specify your gem's dependencies in elasticsearch-model.gemspec
|
4
21
|
gemspec
|
5
22
|
|
6
23
|
group :development, :testing do
|
7
|
-
gem 'rspec'
|
8
24
|
gem 'pry-nav'
|
25
|
+
gem 'rspec'
|
9
26
|
end
|
data/LICENSE.txt
CHANGED
@@ -1,13 +1,202 @@
|
|
1
|
-
Copyright (c) 2014 Elasticsearch
|
2
1
|
|
3
|
-
|
4
|
-
|
5
|
-
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
6
5
|
|
7
|
-
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
8
7
|
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/README.md
CHANGED
@@ -1,18 +1,14 @@
|
|
1
1
|
# Elasticsearch::Model
|
2
2
|
|
3
|
-
The `elasticsearch-model` library builds on top of the
|
4
|
-
the [`elasticsearch`](https://github.com/elastic/elasticsearch-ruby) library.
|
3
|
+
The `elasticsearch-model` library builds on top of the the [`elasticsearch`](https://github.com/elastic/elasticsearch-ruby) library.
|
5
4
|
|
6
|
-
It aims to simplify integration of Ruby classes ("models"), commonly found
|
7
|
-
e.g. in [Ruby on Rails](http://rubyonrails.org) applications, with the
|
8
|
-
[Elasticsearch](http://www.elasticsearch.org) search and analytics engine.
|
5
|
+
It aims to simplify integration of Ruby classes ("models"), commonly found e.g. in [Ruby on Rails](http://rubyonrails.org) applications, with the [Elasticsearch](https://www.elastic.co) search and analytics engine.
|
9
6
|
|
10
7
|
## Compatibility
|
11
8
|
|
12
|
-
This library is compatible with Ruby
|
9
|
+
This library is compatible with Ruby 2.4 and higher.
|
13
10
|
|
14
|
-
The library version numbers follow the Elasticsearch major versions
|
15
|
-
is compatible with the Elasticsearch `master` branch, therefore, with the next major version.
|
11
|
+
The library version numbers follow the Elasticsearch major versions. The `main` branch is compatible with the latest Elasticsearch stack stable release.
|
16
12
|
|
17
13
|
| Rubygem | | Elasticsearch |
|
18
14
|
|:-------------:|:-:| :-----------: |
|
@@ -20,7 +16,7 @@ is compatible with the Elasticsearch `master` branch, therefore, with the next m
|
|
20
16
|
| 2.x | → | 2.x |
|
21
17
|
| 5.x | → | 5.x |
|
22
18
|
| 6.x | → | 6.x |
|
23
|
-
|
|
19
|
+
| main | → | 7.x |
|
24
20
|
|
25
21
|
## Installation
|
26
22
|
|
@@ -73,9 +69,7 @@ This will extend the model with functionality related to Elasticsearch.
|
|
73
69
|
|
74
70
|
#### Feature Extraction Pattern
|
75
71
|
|
76
|
-
Instead of including the `Elasticsearch::Model` module directly in your model,
|
77
|
-
you can include it in a "concern" or "trait" module, which is quite common pattern in Rails applications,
|
78
|
-
using e.g. `ActiveSupport::Concern` as the instrumentation:
|
72
|
+
Instead of including the `Elasticsearch::Model` module directly in your model, you can include it in a "concern" or "trait" module, which is quite common pattern in Rails applications, using e.g. `ActiveSupport::Concern` as the instrumentation:
|
79
73
|
|
80
74
|
```ruby
|
81
75
|
# In: app/models/concerns/searchable.rb
|
@@ -122,7 +116,7 @@ See the `Elasticsearch::Model` module documentation for technical information.
|
|
122
116
|
|
123
117
|
### The Elasticsearch client
|
124
118
|
|
125
|
-
The module will set up a [client](https://github.com/elastic/elasticsearch-ruby/tree/
|
119
|
+
The module will set up a [client](https://github.com/elastic/elasticsearch-ruby/tree/main/elasticsearch),
|
126
120
|
connected to `localhost:9200`, by default. You can access and use it as any other `Elasticsearch::Client`:
|
127
121
|
|
128
122
|
```ruby
|
@@ -145,14 +139,14 @@ Elasticsearch::Model.client = Elasticsearch::Client.new log: true
|
|
145
139
|
You might want to do this during your application bootstrap process, e.g. in a Rails initializer.
|
146
140
|
|
147
141
|
Please refer to the
|
148
|
-
[`elasticsearch-transport`](https://github.com/elastic/elasticsearch-ruby/tree/
|
142
|
+
[`elasticsearch-transport`](https://github.com/elastic/elasticsearch-ruby/tree/main/elasticsearch-transport)
|
149
143
|
library documentation for all the configuration options, and to the
|
150
144
|
[`elasticsearch-api`](http://rubydoc.info/gems/elasticsearch-api) library documentation
|
151
145
|
for information about the Ruby client API.
|
152
146
|
|
153
147
|
### Importing the data
|
154
148
|
|
155
|
-
The first thing you'll want to do is
|
149
|
+
The first thing you'll want to do is import your data into the index:
|
156
150
|
|
157
151
|
```ruby
|
158
152
|
Article.import
|
@@ -254,7 +248,7 @@ response.records.order(:title).to_a
|
|
254
248
|
The `records` method returns the real instances of your model, which is useful when you want to access your
|
255
249
|
model methods -- at the expense of slowing down your application, of course.
|
256
250
|
In most cases, working with `results` coming from Elasticsearch is sufficient, and much faster. See the
|
257
|
-
[`elasticsearch-rails`](https://github.com/elastic/elasticsearch-rails/tree/
|
251
|
+
[`elasticsearch-rails`](https://github.com/elastic/elasticsearch-rails/tree/main/elasticsearch-rails)
|
258
252
|
library for more information about compatibility with the Ruby on Rails framework.
|
259
253
|
|
260
254
|
When you want to access both the database `records` and search `results`, use the `each_with_hit`
|
@@ -290,11 +284,8 @@ NOTE: It is _not_ possible to chain other methods on top of the `records` object
|
|
290
284
|
|
291
285
|
#### Pagination
|
292
286
|
|
293
|
-
You can implement pagination with the `from` and `size` search parameters. However, search results
|
294
|
-
|
295
|
-
[`will_paginate`](https://github.com/mislav/will_paginate) gems.
|
296
|
-
(The pagination gems must be added before the Elasticsearch gems in your Gemfile,
|
297
|
-
or loaded first in your application.)
|
287
|
+
You can implement pagination with the `from` and `size` search parameters. However, search results can be automatically paginated with the [`kaminari`](http://rubygems.org/gems/kaminari) or [`will_paginate`](https://github.com/mislav/will_paginate) gems.
|
288
|
+
(The pagination gems must be added before the Elasticsearch gems in your Gemfile, or loaded first in your application.)
|
298
289
|
|
299
290
|
If Kaminari or WillPaginate is loaded, use the familiar paging methods:
|
300
291
|
|
@@ -322,8 +313,7 @@ Elasticsearch::Model::Response::Response.__send__ :include, Elasticsearch::Model
|
|
322
313
|
|
323
314
|
#### The Elasticsearch DSL
|
324
315
|
|
325
|
-
In most situations, you'll want to pass the search definition
|
326
|
-
in the Elasticsearch [domain-specific language](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl.html) to the client:
|
316
|
+
In most situations, you'll want to pass the search definition in the Elasticsearch [domain-specific language](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html) to the client:
|
327
317
|
|
328
318
|
```ruby
|
329
319
|
response = Article.search query: { match: { title: "Fox Dogs" } },
|
@@ -333,8 +323,7 @@ response.results.first.highlight.title
|
|
333
323
|
# ["Quick brown <em>fox</em>"]
|
334
324
|
```
|
335
325
|
|
336
|
-
You can pass any object which implements a `to_hash` method, which is called automatically,
|
337
|
-
so you can use a custom class or your favourite JSON builder to build the search definition:
|
326
|
+
You can pass any object which implements a `to_hash` method, which is called automatically, so you can use a custom class or your favourite JSON builder to build the search definition:
|
338
327
|
|
339
328
|
```ruby
|
340
329
|
require 'jbuilder'
|
@@ -354,8 +343,7 @@ response.results.first.title
|
|
354
343
|
# => "Quick brown fox"
|
355
344
|
```
|
356
345
|
|
357
|
-
Also, you can use the [**`elasticsearch-dsl`**](https://github.com/elastic/elasticsearch-ruby/tree/
|
358
|
-
the Elasticsearch Query DSL:
|
346
|
+
Also, you can use the [**`elasticsearch-dsl`**](https://github.com/elastic/elasticsearch-ruby/tree/main/elasticsearch-dsl) library, which provides a specialized Ruby API for the Elasticsearch Query DSL:
|
359
347
|
|
360
348
|
```ruby
|
361
349
|
require 'elasticsearch/dsl'
|
@@ -495,7 +483,11 @@ class Article < ActiveRecord::Base
|
|
495
483
|
end
|
496
484
|
|
497
485
|
after_commit on: [:update] do
|
498
|
-
|
486
|
+
if self.published?
|
487
|
+
__elasticsearch__.update_document
|
488
|
+
else
|
489
|
+
__elasticsearch__.delete_document
|
490
|
+
end
|
499
491
|
end
|
500
492
|
|
501
493
|
after_commit on: [:destroy] do
|
@@ -537,7 +529,11 @@ class Indexer
|
|
537
529
|
record = Article.find(record_id)
|
538
530
|
Client.index index: 'articles', type: 'article', id: record.id, body: record.__elasticsearch__.as_indexed_json
|
539
531
|
when /delete/
|
540
|
-
|
532
|
+
begin
|
533
|
+
Client.delete index: 'articles', type: 'article', id: record_id
|
534
|
+
rescue Elasticsearch::Transport::Transport::Errors::NotFound
|
535
|
+
logger.debug "Article not found, ID: #{record_id}"
|
536
|
+
end
|
541
537
|
else raise ArgumentError, "Unknown operation '#{operation}'"
|
542
538
|
end
|
543
539
|
end
|
@@ -744,31 +740,34 @@ curl -# https://download.elasticsearch.org/elasticsearch/elasticsearch/elasticse
|
|
744
740
|
SERVER=start TEST_CLUSTER_COMMAND=$PWD/tmp/elasticsearch-1.0.0.RC1/bin/elasticsearch bundle exec rake test:all
|
745
741
|
```
|
746
742
|
|
747
|
-
### Single Table Inheritance
|
743
|
+
### Single Table Inheritance support
|
748
744
|
|
749
|
-
|
750
|
-
elasticsearch settings (index mappings, etc) on a parent model could be inherited by a child model leading to different
|
751
|
-
model documents being indexed into the same Elasticsearch index. This feature depended on the ability to set a `type`
|
752
|
-
for a document in Elasticsearch. The Elasticsearch team has deprecated support for `types`, as is described
|
745
|
+
Versions < 7.0.0 of this gem supported inheritance-- more specifically, `Single Table Inheritance`. With this feature,
|
746
|
+
elasticsearch settings (index mappings, etc) on a parent model could be inherited by a child model leading to different
|
747
|
+
model documents being indexed into the same Elasticsearch index. This feature depended on the ability to set a `type`
|
748
|
+
for a document in Elasticsearch. The Elasticsearch team has deprecated support for `types`, as is described
|
753
749
|
[here.](https://www.elastic.co/guide/en/elasticsearch/reference/current/removal-of-types.html)
|
754
|
-
This gem will also remove support for types and `Single Table Inheritance` in version 7.0 as it enables an anti-pattern.
|
755
|
-
Please save different model documents in separate indices. If you want to use STI, you can include an artificial
|
750
|
+
This gem will also remove support for types and `Single Table Inheritance` in version 7.0 as it enables an anti-pattern.
|
751
|
+
Please save different model documents in separate indices. If you want to use STI, you can include an artificial
|
756
752
|
`type` field manually in each document and use it in other operations.
|
757
753
|
|
758
754
|
## License
|
759
755
|
|
760
756
|
This software is licensed under the Apache 2 license, quoted below.
|
761
757
|
|
762
|
-
|
763
|
-
|
764
|
-
|
765
|
-
|
758
|
+
Licensed to Elasticsearch B.V. under one or more contributor
|
759
|
+
license agreements. See the NOTICE file distributed with
|
760
|
+
this work for additional information regarding copyright
|
761
|
+
ownership. Elasticsearch B.V. licenses this file to you under
|
762
|
+
the Apache License, Version 2.0 (the "License"); you may
|
763
|
+
not use this file except in compliance with the License.
|
766
764
|
You may obtain a copy of the License at
|
767
|
-
|
768
|
-
|
769
|
-
|
770
|
-
Unless required by applicable law or agreed to in writing,
|
771
|
-
distributed under the License is distributed on an
|
772
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
773
|
-
See the License for the
|
774
|
-
|
765
|
+
|
766
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
767
|
+
|
768
|
+
Unless required by applicable law or agreed to in writing,
|
769
|
+
software distributed under the License is distributed on an
|
770
|
+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
771
|
+
KIND, either express or implied. See the License for the
|
772
|
+
specific language governing permissions and limitations
|
773
|
+
under the License.
|
data/Rakefile
CHANGED
@@ -1,26 +1,42 @@
|
|
1
|
-
|
1
|
+
# Licensed to Elasticsearch B.V. under one or more contributor
|
2
|
+
# license agreements. See the NOTICE file distributed with
|
3
|
+
# this work for additional information regarding copyright
|
4
|
+
# ownership. Elasticsearch B.V. licenses this file to you under
|
5
|
+
# the Apache License, Version 2.0 (the "License"); you may
|
6
|
+
# not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing,
|
12
|
+
# software distributed under the License is distributed on an
|
13
|
+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
14
|
+
# KIND, either express or implied. See the License for the
|
15
|
+
# specific language governing permissions and limitations
|
16
|
+
# under the License.
|
2
17
|
|
3
|
-
|
4
|
-
task :default => 'test:unit'
|
5
|
-
task :test => 'test:unit'
|
18
|
+
require 'bundler/gem_tasks'
|
6
19
|
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
20
|
+
desc 'Run unit tests'
|
21
|
+
task default: 'test:all'
|
22
|
+
task test: 'test:all'
|
23
|
+
|
24
|
+
gemfiles = ['5.0.gemfile', '6.0.gemfile']
|
25
|
+
gemfiles << '4.0.gemfile' if RUBY_VERSION < '2.7'
|
26
|
+
GEMFILES = gemfiles.freeze
|
12
27
|
|
13
28
|
namespace :bundle do
|
14
29
|
desc 'Install dependencies for all the Gemfiles in /gemfiles. Optionally define env variable RAILS_VERSIONS. E.g. RAILS_VERSIONS=3.0,5.0'
|
15
30
|
task :install do
|
16
31
|
unless defined?(JRUBY_VERSION)
|
17
|
-
puts '-'*80
|
32
|
+
puts '-' * 80
|
18
33
|
gemfiles = ENV['RAILS_VERSIONS'] ? ENV['RAILS_VERSIONS'].split(',').map { |v| "#{v}.gemfile"} : GEMFILES
|
19
34
|
gemfiles.each do |gemfile|
|
20
|
-
|
35
|
+
puts "GEMFILE: #{gemfile}"
|
36
|
+
Bundler.with_unbundled_env do
|
21
37
|
sh "bundle install --gemfile #{File.expand_path('../gemfiles/'+gemfile, __FILE__)}"
|
22
38
|
end
|
23
|
-
puts '-'*80
|
39
|
+
puts '-' * 80
|
24
40
|
end
|
25
41
|
end
|
26
42
|
end
|
@@ -30,12 +46,12 @@ end
|
|
30
46
|
|
31
47
|
require 'rake/testtask'
|
32
48
|
namespace :test do
|
33
|
-
|
34
49
|
desc 'Run all tests. Optionally define env variable RAILS_VERSIONS. E.g. RAILS_VERSIONS=3.0,5.0'
|
35
50
|
task :all, [:rails_versions] do |task, args|
|
36
51
|
gemfiles = ENV['RAILS_VERSIONS'] ? ENV['RAILS_VERSIONS'].split(',').map {|v| "#{v}.gemfile"} : GEMFILES
|
37
52
|
puts '-' * 80
|
38
53
|
gemfiles.each do |gemfile|
|
54
|
+
puts "GEMFILE: #{gemfile}"
|
39
55
|
sh "BUNDLE_GEMFILE='#{File.expand_path("../gemfiles/#{gemfile}", __FILE__)}' " +
|
40
56
|
" bundle exec rspec"
|
41
57
|
puts '-' * 80
|
data/elasticsearch-model.gemspec
CHANGED
@@ -1,54 +1,68 @@
|
|
1
|
+
# Licensed to Elasticsearch B.V. under one or more contributor
|
2
|
+
# license agreements. See the NOTICE file distributed with
|
3
|
+
# this work for additional information regarding copyright
|
4
|
+
# ownership. Elasticsearch B.V. licenses this file to you under
|
5
|
+
# the Apache License, Version 2.0 (the "License"); you may
|
6
|
+
# not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing,
|
12
|
+
# software distributed under the License is distributed on an
|
13
|
+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
14
|
+
# KIND, either express or implied. See the License for the
|
15
|
+
# specific language governing permissions and limitations
|
16
|
+
# under the License.
|
17
|
+
|
1
18
|
# coding: utf-8
|
2
|
-
|
19
|
+
|
20
|
+
lib = File.expand_path('lib', __dir__)
|
3
21
|
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
22
|
require 'elasticsearch/model/version'
|
5
23
|
|
6
24
|
Gem::Specification.new do |s|
|
7
|
-
s.name =
|
25
|
+
s.name = 'elasticsearch-model'
|
8
26
|
s.version = Elasticsearch::Model::VERSION
|
9
|
-
s.authors = [
|
10
|
-
s.email = [
|
11
|
-
s.description =
|
12
|
-
s.summary =
|
13
|
-
s.homepage =
|
14
|
-
s.license =
|
27
|
+
s.authors = ['Karel Minarik']
|
28
|
+
s.email = ['karel.minarik@elasticsearch.org']
|
29
|
+
s.description = 'ActiveModel/Record integrations for Elasticsearch.'
|
30
|
+
s.summary = 'ActiveModel/Record integrations for Elasticsearch.'
|
31
|
+
s.homepage = 'https://github.com/elasticsearch/elasticsearch-rails/'
|
32
|
+
s.license = 'Apache 2'
|
15
33
|
|
16
34
|
s.files = `git ls-files`.split($/)
|
17
35
|
s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
36
|
s.test_files = s.files.grep(%r{^(test|spec|features)/})
|
19
|
-
s.require_paths = [
|
20
|
-
|
21
|
-
s.extra_rdoc_files = [ "README.md", "LICENSE.txt" ]
|
22
|
-
s.rdoc_options = [ "--charset=UTF-8" ]
|
23
|
-
|
24
|
-
s.required_ruby_version = ">= 2.2"
|
25
|
-
|
26
|
-
s.add_dependency "elasticsearch", '~> 6'
|
27
|
-
s.add_dependency "activesupport", '> 3'
|
28
|
-
s.add_dependency "hashie"
|
29
|
-
|
30
|
-
s.add_development_dependency "bundler"
|
31
|
-
s.add_development_dependency "rake", "~> 11.1"
|
32
|
-
|
33
|
-
s.add_development_dependency "elasticsearch-extensions"
|
37
|
+
s.require_paths = ['lib']
|
34
38
|
|
35
|
-
s.
|
36
|
-
s.
|
39
|
+
s.extra_rdoc_files = ['README.md', 'LICENSE.txt']
|
40
|
+
s.rdoc_options = ['--charset=UTF-8']
|
37
41
|
|
38
|
-
s.
|
39
|
-
s.add_development_dependency "kaminari"
|
40
|
-
s.add_development_dependency "will_paginate"
|
42
|
+
s.required_ruby_version = '>= 2.4'
|
41
43
|
|
42
|
-
s.
|
43
|
-
s.
|
44
|
-
s.
|
45
|
-
s.add_development_dependency "mocha"
|
46
|
-
s.add_development_dependency "turn"
|
47
|
-
s.add_development_dependency "yard"
|
48
|
-
s.add_development_dependency "ruby-prof" unless defined?(JRUBY_VERSION)
|
49
|
-
s.add_development_dependency "pry"
|
44
|
+
s.add_dependency 'activesupport', '> 3'
|
45
|
+
s.add_dependency 'elasticsearch', '~> 7'
|
46
|
+
s.add_dependency 'hashie'
|
50
47
|
|
51
|
-
s.add_development_dependency
|
52
|
-
s.add_development_dependency
|
53
|
-
s.add_development_dependency
|
48
|
+
s.add_development_dependency 'activemodel', '> 3'
|
49
|
+
s.add_development_dependency 'bundler'
|
50
|
+
s.add_development_dependency 'cane'
|
51
|
+
s.add_development_dependency 'kaminari'
|
52
|
+
s.add_development_dependency 'minitest'
|
53
|
+
s.add_development_dependency 'mocha'
|
54
|
+
s.add_development_dependency 'pry'
|
55
|
+
s.add_development_dependency 'rake', '~> 12'
|
56
|
+
s.add_development_dependency 'require-prof'
|
57
|
+
s.add_development_dependency 'shoulda-context'
|
58
|
+
s.add_development_dependency 'simplecov'
|
59
|
+
s.add_development_dependency 'test-unit'
|
60
|
+
s.add_development_dependency 'turn'
|
61
|
+
s.add_development_dependency 'will_paginate'
|
62
|
+
s.add_development_dependency 'yard'
|
63
|
+
unless defined?(JRUBY_VERSION)
|
64
|
+
s.add_development_dependency 'oj'
|
65
|
+
s.add_development_dependency 'ruby-prof'
|
66
|
+
s.add_development_dependency 'sqlite3'
|
67
|
+
end
|
54
68
|
end
|