mini-smart-box 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. checksums.yaml +7 -0
  2. data/elasticsearch-rails-8.0.1/CHANGELOG.md +44 -0
  3. data/elasticsearch-rails-8.0.1/Gemfile +38 -0
  4. data/elasticsearch-rails-8.0.1/LICENSE.txt +202 -0
  5. data/elasticsearch-rails-8.0.1/README.md +149 -0
  6. data/elasticsearch-rails-8.0.1/Rakefile +67 -0
  7. data/elasticsearch-rails-8.0.1/elasticsearch-rails.gemspec +67 -0
  8. data/elasticsearch-rails-8.0.1/lib/elasticsearch/rails/instrumentation/controller_runtime.rb +58 -0
  9. data/elasticsearch-rails-8.0.1/lib/elasticsearch/rails/instrumentation/log_subscriber.rb +67 -0
  10. data/elasticsearch-rails-8.0.1/lib/elasticsearch/rails/instrumentation/publishers.rb +53 -0
  11. data/elasticsearch-rails-8.0.1/lib/elasticsearch/rails/instrumentation/railtie.rb +44 -0
  12. data/elasticsearch-rails-8.0.1/lib/elasticsearch/rails/instrumentation.rb +53 -0
  13. data/elasticsearch-rails-8.0.1/lib/elasticsearch/rails/lograge.rb +57 -0
  14. data/elasticsearch-rails-8.0.1/lib/elasticsearch/rails/tasks/import.rb +128 -0
  15. data/elasticsearch-rails-8.0.1/lib/elasticsearch/rails/version.rb +22 -0
  16. data/elasticsearch-rails-8.0.1/lib/elasticsearch/rails.rb +24 -0
  17. data/elasticsearch-rails-8.0.1/lib/rails/templates/01-basic.rb +364 -0
  18. data/elasticsearch-rails-8.0.1/lib/rails/templates/02-pretty.rb +348 -0
  19. data/elasticsearch-rails-8.0.1/lib/rails/templates/03-expert.rb +358 -0
  20. data/elasticsearch-rails-8.0.1/lib/rails/templates/04-dsl.rb +146 -0
  21. data/elasticsearch-rails-8.0.1/lib/rails/templates/05-settings-files.rb +88 -0
  22. data/elasticsearch-rails-8.0.1/lib/rails/templates/articles.yml.gz +0 -0
  23. data/elasticsearch-rails-8.0.1/lib/rails/templates/articles_settings.json +1 -0
  24. data/elasticsearch-rails-8.0.1/lib/rails/templates/index.html.dsl.erb +178 -0
  25. data/elasticsearch-rails-8.0.1/lib/rails/templates/index.html.erb +178 -0
  26. data/elasticsearch-rails-8.0.1/lib/rails/templates/indexer.rb +44 -0
  27. data/elasticsearch-rails-8.0.1/lib/rails/templates/search.css +76 -0
  28. data/elasticsearch-rails-8.0.1/lib/rails/templates/search_controller_test.dsl.rb +148 -0
  29. data/elasticsearch-rails-8.0.1/lib/rails/templates/search_controller_test.rb +148 -0
  30. data/elasticsearch-rails-8.0.1/lib/rails/templates/searchable.dsl.rb +234 -0
  31. data/elasticsearch-rails-8.0.1/lib/rails/templates/searchable.rb +224 -0
  32. data/elasticsearch-rails-8.0.1/lib/rails/templates/seeds.rb +75 -0
  33. data/elasticsearch-rails-8.0.1/spec/instrumentation/log_subscriber_spec.rb +57 -0
  34. data/elasticsearch-rails-8.0.1/spec/instrumentation_spec.rb +103 -0
  35. data/elasticsearch-rails-8.0.1/spec/lograge_spec.rb +52 -0
  36. data/elasticsearch-rails-8.0.1/spec/spec_helper.rb +65 -0
  37. data/mini-smart-box.gemspec +11 -0
  38. metadata +76 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: c4b6ff07fbda0a14c091de77a8e8aa9ef3030b7e90b12d29c5bfb6eb21b5f183
4
+ data.tar.gz: 4a52bee0878d7dd0060cb496d11c480d0ac33ef4005831b384f6a47b20756d6f
5
+ SHA512:
6
+ metadata.gz: 2bcfd736384bdfaa21ae6e993fd595c8b6a927776b446a6b777172aed23c824cf0682658e52ae3a3ca8f3099c7a1cb1d1321ca056443305616f56bf9422a5b2a
7
+ data.tar.gz: 21c00d1417f68221e953ee91777b88e00e1ed4143ca07714d113c4f3827fce3817fce31fb8607436e462069205dc3baf0e9716c819c8f60a817dbb3ce02957cf
@@ -0,0 +1,44 @@
1
+ ## 0.1.9
2
+
3
+ * Added checks for proper launch order and other updates to the example application templates
4
+ * Updated the example application to work with Elasticsearch 2.x
5
+ * Used the `suggest` method instead of `response['suggest']` in the application template
6
+
7
+ ## 0.1.8
8
+
9
+ * Added an example application template that loads settings from a file
10
+ * Added missing require in the seeds.rb file for the expert template
11
+ * Fixed double include of the aliased method (execute_without_instrumentation)
12
+ * Fixed the error when getting the search_controller_test.rb asset in `03-expert.rb` template
13
+ * Updated URLs for getting raw assets from Github in the `03-expert.rb` template
14
+
15
+ ## 0.1.7
16
+
17
+ * Updated dependencies for the gem and example applications
18
+ * Fixed various small errors in the `01-basic.rb` template
19
+ * Fixed error when inserting the Kaminari gem into Gemfile in the 02-pretty.rb template
20
+ * Fixed incorrect regex for adding Rails instrumentation into the application.rb in the `02-pretty.rb` template
21
+ * Fixed other small errors in the `02-pretty.rb` template
22
+ * Improved and added tests for the generated application from the `02-pretty.rb` template
23
+ * Added the `04-dsl.rb` template which uses the `elasticsearch-dsl` gem to build the search definition
24
+
25
+ ## 0.1.6
26
+
27
+ * Fixed errors in templates for the Rails example applications
28
+ * Fixed errors in the importing Rake task
29
+ * Refactored and updated the instrumentation support to allow integration with `Persistence::Model`
30
+
31
+ ## 0.1.5
32
+
33
+ * Fixed an exception when no suggestions were returned in the `03-expert` example application template
34
+
35
+ ## 0.1.2
36
+
37
+ * Allow passing an ActiveRecord scope to the importing Rake task
38
+
39
+ ## 0.1.1
40
+
41
+ * Improved the Rake tasks
42
+ * Improved the example application templates
43
+
44
+ ## 0.1.0 (Initial Version)
@@ -0,0 +1,38 @@
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
+
18
+ source 'https://rubygems.org'
19
+
20
+ # Specify your gem's dependencies in elasticsearch-rails.gemspec
21
+ gemspec
22
+
23
+ gem 'elasticsearch-model',
24
+ path: File.expand_path('../elasticsearch-model', __dir__),
25
+ require: false
26
+
27
+ gem 'elasticsearch-persistence',
28
+ path: File.expand_path('../elasticsearch-persistence', __dir__),
29
+ require: false
30
+
31
+ group :development, :testing do
32
+ gem 'pry-nav'
33
+ gem 'rspec'
34
+ unless defined?(JRUBY_VERSION)
35
+ gem 'sqlite3'
36
+ gem 'debug'
37
+ end
38
+ end
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
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.
@@ -0,0 +1,149 @@
1
+ # Elasticsearch::Rails
2
+
3
+ The `elasticsearch-rails` library is a companion for the
4
+ the [`elasticsearch-model`](https://github.com/elastic/elasticsearch-rails/tree/main/elasticsearch-model)
5
+ library, providing features suitable for Ruby on Rails applications.
6
+
7
+ ## Compatibility
8
+
9
+ This library is compatible with Ruby 3.1 and higher.
10
+
11
+ The version numbers follow the Elasticsearch major versions. Currently the `main` branch is compatible with version `8.x` of the Elasticsearch stack.
12
+
13
+ | Rubygem | | Elasticsearch |
14
+ |:-------:|:-:|:-------------:|
15
+ | 0.1 | → | 1.x |
16
+ | 2.x | → | 2.x |
17
+ | 5.x | → | 5.x |
18
+ | 6.x | → | 6.x |
19
+ | 7.x | → | 7.x |
20
+ | 8.x | → | 8.x |
21
+ | main | → | 8.x |
22
+
23
+ ## Installation
24
+
25
+ Install the package from [Rubygems](https://rubygems.org):
26
+
27
+ gem install elasticsearch-rails
28
+
29
+ To use an unreleased version, either add it to your `Gemfile` for [Bundler](http://bundler.io):
30
+
31
+ gem 'elasticsearch-rails', git: 'git://github.com/elastic/elasticsearch-rails.git', branch: '5.x'
32
+
33
+ or install it from a source code checkout:
34
+
35
+ git clone https://github.com/elastic/elasticsearch-rails.git
36
+ cd elasticsearch-rails/elasticsearch-rails
37
+ bundle install
38
+ rake install
39
+
40
+ ## Features
41
+
42
+ ### Rake Tasks
43
+
44
+ To facilitate importing data from your models into Elasticsearch, require the task definition in your application,
45
+ eg. in the `lib/tasks/elasticsearch.rake` file:
46
+
47
+ ```ruby
48
+ require 'elasticsearch/rails/tasks/import'
49
+ ```
50
+
51
+ To import the records from your `Article` model, run:
52
+
53
+ ```bash
54
+ $ bundle exec rake environment elasticsearch:import:model CLASS='Article'
55
+ ```
56
+
57
+ To limit the imported records to a certain
58
+ ActiveRecord [scope](http://guides.rubyonrails.org/active_record_querying.html#scopes),
59
+ pass it to the task:
60
+
61
+ ```bash
62
+ $ bundle exec rake environment elasticsearch:import:model CLASS='Article' SCOPE='published'
63
+ ```
64
+
65
+ Run this command to display usage instructions:
66
+
67
+ ```bash
68
+ $ bundle exec rake -D elasticsearch
69
+ ```
70
+
71
+ ### ActiveSupport Instrumentation
72
+
73
+ To display information about the search request (duration, search definition) during development,
74
+ and to include the information in the Rails log file, require the component in your `application.rb` file:
75
+
76
+ ```ruby
77
+ require 'elasticsearch/rails/instrumentation'
78
+ ```
79
+
80
+ You should see an output like this in your application log in development environment:
81
+
82
+ Article Search (321.3ms) { index: "articles", type: "article", body: { query: ... } }
83
+
84
+ Also, the total duration of the request to Elasticsearch is displayed in the Rails request breakdown:
85
+
86
+ Completed 200 OK in 615ms (Views: 230.9ms | ActiveRecord: 0.0ms | Elasticsearch: 321.3ms)
87
+
88
+ There's a special component for the [Lograge](https://github.com/roidrage/lograge) logger.
89
+ Require the component in your `application.rb` file (and set `config.lograge.enabled`):
90
+
91
+ ```ruby
92
+ require 'elasticsearch/rails/lograge'
93
+ ```
94
+
95
+ You should see the duration of the request to Elasticsearch as part of each log event:
96
+
97
+ method=GET path=/search ... status=200 duration=380.89 view=99.64 db=0.00 es=279.37
98
+
99
+ ### Rails Application Templates
100
+
101
+ You can generate a fully working example Ruby on Rails application, with an `Article` model and a search form,
102
+ to play with (it generates the application skeleton and leaves you with a _Git_ repository to explore the
103
+ steps and the code) with the
104
+ [`01-basic.rb`](https://github.com/elastic/elasticsearch-rails/blob/main/elasticsearch-rails/lib/rails/templates/01-basic.rb) template:
105
+
106
+ ```bash
107
+ rails new searchapp --skip --skip-bundle --template https://raw.github.com/elastic/elasticsearch-rails/main/elasticsearch-rails/lib/rails/templates/01-basic.rb
108
+ ```
109
+
110
+ Run the same command again, in the same folder, with the
111
+ [`02-pretty`](https://github.com/elastic/elasticsearch-rails/blob/main/elasticsearch-rails/lib/rails/templates/02-pretty.rb)
112
+ template to add features such as a custom `Article.search` method, result highlighting and
113
+ [_Bootstrap_](http://getbootstrap.com) integration:
114
+
115
+ ```bash
116
+ rails new searchapp --skip --skip-bundle --template https://raw.github.com/elastic/elasticsearch-rails/main/elasticsearch-rails/lib/rails/templates/02-pretty.rb
117
+ ```
118
+
119
+ Run the same command with the [`03-expert.rb`](https://github.com/elastic/elasticsearch-rails/blob/main/elasticsearch-rails/lib/rails/templates/03-expert.rb)
120
+ template to refactor the application into a more complex use case,
121
+ with couple of hundreds of The New York Times articles as the example content.
122
+ The template will extract the Elasticsearch integration into a `Searchable` "concern" module,
123
+ define complex mapping, custom serialization, implement faceted navigation and suggestions as a part of
124
+ a complex query, and add a _Sidekiq_-based worker for updating the index in the background.
125
+
126
+ ```bash
127
+ rails new searchapp --skip --skip-bundle --template https://raw.github.com/elastic/elasticsearch-rails/main/elasticsearch-rails/lib/rails/templates/03-expert.rb
128
+ ```
129
+
130
+ ## License
131
+
132
+ This software is licensed under the Apache 2 license, quoted below.
133
+
134
+ Licensed to Elasticsearch B.V. under one or more contributor
135
+ license agreements. See the NOTICE file distributed with
136
+ this work for additional information regarding copyright
137
+ ownership. Elasticsearch B.V. licenses this file to you under
138
+ the Apache License, Version 2.0 (the "License"); you may
139
+ not use this file except in compliance with the License.
140
+ You may obtain a copy of the License at
141
+
142
+ http://www.apache.org/licenses/LICENSE-2.0
143
+
144
+ Unless required by applicable law or agreed to in writing,
145
+ software distributed under the License is distributed on an
146
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
147
+ KIND, either express or implied. See the License for the
148
+ specific language governing permissions and limitations
149
+ under the License.
@@ -0,0 +1,67 @@
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
+
18
+ require "bundler/gem_tasks"
19
+
20
+ desc "Run unit tests"
21
+ task default: 'test:unit'
22
+ task test: 'test:unit'
23
+
24
+ # ----- Test tasks ------------------------------------------------------------
25
+
26
+ require 'rake/testtask'
27
+ require 'rspec/core/rake_task'
28
+
29
+ namespace :test do
30
+ RSpec::Core::RakeTask.new(:spec)
31
+
32
+ Rake::TestTask.new(:all) do |test|
33
+ test.verbose = false
34
+ test.warning = false
35
+ test.deps = [:spec] unless defined?(JRUBY_VERSION)
36
+ end
37
+
38
+ task unit: :spec
39
+ end
40
+
41
+ namespace :bundle do
42
+ desc 'Install gem dependencies'
43
+ task :install do
44
+ puts '-' * 80
45
+ Bundler.with_unbundled_env do
46
+ sh 'bundle install'
47
+ end
48
+ puts '-' * 80
49
+ end
50
+ end
51
+
52
+ # ----- Documentation tasks ---------------------------------------------------
53
+
54
+ require 'yard'
55
+ YARD::Rake::YardocTask.new(:doc) do |t|
56
+ t.options = %w| --embed-mixins --markup=markdown |
57
+ end
58
+
59
+ # ----- Code analysis tasks ---------------------------------------------------
60
+
61
+ if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
62
+ require 'cane/rake_task'
63
+ Cane::RakeTask.new(:quality) do |cane|
64
+ cane.abc_max = 15
65
+ cane.no_style = true
66
+ end
67
+ end
@@ -0,0 +1,67 @@
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
+
18
+ # coding: utf-8
19
+ lib = File.expand_path('../lib', __FILE__)
20
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
21
+ require 'elasticsearch/rails/version'
22
+
23
+ Gem::Specification.new do |s|
24
+ s.name = 'elasticsearch-rails'
25
+ s.version = Elasticsearch::Rails::VERSION
26
+ s.authors = ['Elastic Client Library Maintainers']
27
+ s.email = ['client-libs@elastic.co']
28
+ s.description = 'Ruby on Rails integrations for Elasticsearch.'
29
+ s.summary = 'Ruby on Rails integrations for Elasticsearch.'
30
+ s.homepage = 'https://github.com/elasticsearch/elasticsearch-rails/'
31
+ s.license = 'Apache 2'
32
+ s.metadata = {
33
+ 'homepage_uri' => 'https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/ruby_on_rails.html',
34
+ 'changelog_uri' => 'https://github.com/elastic/elasticsearch-rails/blob/main/CHANGELOG.md',
35
+ 'source_code_uri' => 'https://github.com/elastic/elasticsearch-rails/',
36
+ 'bug_tracker_uri' => 'https://github.com/elastic/elasticsearch-rails/issues'
37
+ }
38
+
39
+ s.files = `git ls-files`.split($/)
40
+ s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
41
+ s.test_files = s.files.grep(%r{^(test|spec|features)/})
42
+ s.require_paths = ['lib']
43
+
44
+ s.extra_rdoc_files = ['README.md', 'LICENSE.txt']
45
+ s.rdoc_options = ['--charset=UTF-8']
46
+
47
+ s.required_ruby_version = '>= 3'
48
+
49
+ s.add_development_dependency 'bundler'
50
+ s.add_development_dependency 'cane'
51
+ s.add_development_dependency 'lograge'
52
+ s.add_development_dependency 'minitest'
53
+ s.add_development_dependency 'mocha'
54
+ s.add_development_dependency 'pry'
55
+ s.add_development_dependency 'rails', '> 3.1'
56
+ s.add_development_dependency 'rake', '~> 12'
57
+ s.add_development_dependency 'require-prof'
58
+ s.add_development_dependency 'shoulda-context'
59
+ s.add_development_dependency 'simplecov'
60
+ s.add_development_dependency 'test-unit'
61
+ s.add_development_dependency 'turn'
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
+ end
67
+ end
@@ -0,0 +1,58 @@
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
+
18
+ require 'active_support/core_ext/module/attr_internal'
19
+
20
+ module Elasticsearch
21
+ module Rails
22
+ module Instrumentation
23
+
24
+ # Hooks into ActionController to display Elasticsearch runtime
25
+ #
26
+ # @see https://github.com/rails/rails/blob/master/activerecord/lib/active_record/railties/controller_runtime.rb
27
+ #
28
+ module ControllerRuntime
29
+ extend ActiveSupport::Concern
30
+
31
+ protected
32
+
33
+ attr_internal :elasticsearch_runtime
34
+
35
+ def cleanup_view_runtime
36
+ elasticsearch_rt_before_render = Elasticsearch::Rails::Instrumentation::LogSubscriber.reset_runtime
37
+ runtime = super
38
+ elasticsearch_rt_after_render = Elasticsearch::Rails::Instrumentation::LogSubscriber.reset_runtime
39
+ self.elasticsearch_runtime = elasticsearch_rt_before_render + elasticsearch_rt_after_render
40
+ runtime - elasticsearch_rt_after_render
41
+ end
42
+
43
+ def append_info_to_payload(payload)
44
+ super
45
+ payload[:elasticsearch_runtime] = (elasticsearch_runtime || 0) + Elasticsearch::Rails::Instrumentation::LogSubscriber.reset_runtime
46
+ end
47
+
48
+ module ClassMethods
49
+ def log_process_action(payload)
50
+ messages, elasticsearch_runtime = super, payload[:elasticsearch_runtime]
51
+ messages << ("Elasticsearch: %.1fms" % elasticsearch_runtime.to_f) if elasticsearch_runtime
52
+ messages
53
+ end
54
+ end
55
+ end
56
+ end
57
+ end
58
+ end