chewy 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55ee493bcdd9f0f001572ffade6a8fef187fd9fd0a87176dd52f07b18db6ec39
-  data.tar.gz: 1ed5e0e4d39c7e8b2202051322c7c312078ba644c62f49c320153d6bd2054ee7
+  metadata.gz: ce34ae965f4efd39230e5e7fd8cd6d63a17c5e645745f7565ad4feea944244bb
+  data.tar.gz: b4fcade45c69fd1003b22d0b3a1a7e6e1f2f042f422fcf5dc510250d7c63bf6f
 SHA512:
-  metadata.gz: 9fe7425716df8484306cee104f3b3365a9ae36d2e6496b0653b88dd9a13f8e78f48a6d4f579f0e9a2887fb2d36632a1bd970c901d3ba10c87f9fd6405b56327d
-  data.tar.gz: f1c81281f0343256c47b20e52bf9363df6bc1c86f3c53e031f4facdb93d223fe6685e74ea3b048b5869a8d0c09ba0a0672c100a303d8b6cabd358e71de141c03
+  metadata.gz: 2266cf1f1b14d4dd70f0c34c07f3b722fc8a15b9532bc8a7c332f387634982b3ccac87a1bb692ca0023d588692cfb3f090f2410f3775a3e2678f3d08d762045a
+  data.tar.gz: 9ca016cc817585547e994597a08e14c7484dc13a5f9a7d35b1685cb9135b604b0ba94221120c87dbe4a2b6c3e67dec3a105f2de2014eb82e8081b45dad960f31

data/.circleci/config.yml

@@ -0,0 +1,214 @@
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+version: 2.1
+
+es56-env: &es56-env
+  cluster.name: elasticsearch
+  transport.host: localhost
+  network.host: 127.0.0.1
+  http.port: 9250
+  discovery.type: single-node
+  xpack.security.enabled: false
+  xpack.monitoring.enabled: false
+
+workflows:
+  build:
+    jobs:
+      - rubocop
+      - rspec-ruby-26-activerecord61
+      - rspec-ruby-26-activerecord60
+      - rspec-ruby-26-activerecord52
+      - rspec-ruby-26-mongoid
+      - rspec-ruby-27-activerecord61
+      - rspec-ruby-27-activerecord60
+      - rspec-ruby-27-activerecord52
+      - rspec-ruby-27-mongoid
+      - rspec-ruby-30-activerecord61
+
+commands:
+  rspec-test:
+    description: Test rspec in current ruby
+    parameters:
+      pre-steps:
+        description: Necessary steps after checkout
+        type: steps
+        default: []
+    steps:
+      - checkout
+      - run:
+          name: ruby version
+          command: |
+            ruby -e "STDERR.puts RUBY_VERSION; puts RUBY_VERSION.gsub(/^(\d+)\.(\d+)\..*/, '\1_\2')" > .ruby.version
+      - run:
+          name: Gemfile.lock version
+          command: |
+           echo "$GEMFILE.lock" > .Gemfile.lock.path
+      - steps: << parameters.pre-steps >>
+      - restore_cache:
+          keys:
+            - dependencies-{{ checksum ".ruby.version" }}-{{ checksum ".Gemfile.lock.path" }}
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle --gemfile=$GEMFILE
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: dependencies-{{ checksum ".ruby.version" }}-{{ checksum ".Gemfile.lock.path" }}
+      - run:
+          name: Disable replication of elastic indices
+          command: |
+            curl -XPUT 'http://localhost:9250/_all/_settings?preserve_existing=true' -d '{
+              "index.number_of_replicas":"0"
+            }'
+      - run:
+          name: run tests
+          command: |
+            ruby -v
+            git config --global user.email "you@example.com"
+            git config --global user.name "Your Name"
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+            BUNDLE_GEMFILE=$GEMFILE bundle exec rspec --format progress --format RspecJunitFormatter --out /tmp/test-results/rspec.xml $TEST_FILES
+      - store_test_results:
+          path: /tmp/test-results
+
+jobs:
+  rubocop:
+    docker:
+      - image: circleci/ruby:2.6
+    working_directory: ~/repo
+    steps:
+      - checkout
+      - run:
+          name: ruby version
+          command: |
+            ruby -e "STDERR.puts RUBY_VERSION; puts RUBY_VERSION.gsub(/^(\d+)\.(\d+)\..*/, '\1_\2')" > .ruby.version
+      - run:
+          name: Gemfile.lock version
+          command: |
+           echo "$GEMFILE.lock" > .Gemfile.lock.path
+      - restore_cache:
+          keys:
+            - dependencies-{{ checksum ".ruby.version" }}-{{ checksum ".Gemfile.lock.path" }}
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle --binstubs=/usr/local/bundle/bin
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: dependencies-{{ checksum ".ruby.version" }}-{{ checksum ".Gemfile.lock.path" }}
+      - run:
+          name: run rubocop
+          command: |
+            bundle exec rubocop --format simple
+
+  rspec-ruby-26-activerecord52:
+    docker:
+      - image: circleci/ruby:2.6
+      - image: docker.elastic.co/elasticsearch/elasticsearch:5.6.7
+        environment:
+          <<: *es56-env
+    working_directory: ~/repo
+    environment:
+      GEMFILE: gemfiles/rails.5.2.activerecord.gemfile
+    steps:
+      - rspec-test
+
+  rspec-ruby-26-activerecord60:
+    docker:
+      - image: circleci/ruby:2.6
+      - image: docker.elastic.co/elasticsearch/elasticsearch:5.6.7
+        environment:
+          <<: *es56-env
+    working_directory: ~/repo
+    environment:
+      GEMFILE: gemfiles/rails.6.0.activerecord.gemfile
+    steps:
+      - rspec-test
+
+  rspec-ruby-26-activerecord61:
+    docker:
+      - image: circleci/ruby:2.6
+      - image: docker.elastic.co/elasticsearch/elasticsearch:5.6.7
+        environment:
+          <<: *es56-env
+    working_directory: ~/repo
+    environment:
+      GEMFILE: gemfiles/rails.6.1.activerecord.gemfile
+    steps:
+      - rspec-test
+
+  rspec-ruby-26-mongoid:
+    docker:
+      - image: circleci/ruby:2.6
+      - image: circleci/mongo:4.2.5
+      - image: docker.elastic.co/elasticsearch/elasticsearch:5.6.7
+        environment:
+          <<: *es56-env
+    working_directory: ~/repo
+    environment:
+      GEMFILE: gemfiles/rails.5.2.mongoid.6.4.gemfile
+    steps:
+      - rspec-test
+
+  rspec-ruby-27-activerecord52:
+    docker:
+      - image: circleci/ruby:2.7
+      - image: docker.elastic.co/elasticsearch/elasticsearch:5.6.7
+        environment:
+          <<: *es56-env
+    working_directory: ~/repo
+    environment:
+      GEMFILE: gemfiles/rails.5.2.activerecord.gemfile
+    steps:
+      - rspec-test
+
+  rspec-ruby-27-activerecord60:
+    docker:
+      - image: circleci/ruby:2.7
+      - image: docker.elastic.co/elasticsearch/elasticsearch:5.6.7
+        environment:
+          <<: *es56-env
+    working_directory: ~/repo
+    environment:
+      GEMFILE: gemfiles/rails.6.0.activerecord.gemfile
+    steps:
+      - rspec-test
+
+  rspec-ruby-27-activerecord61:
+    docker:
+      - image: circleci/ruby:2.7
+      - image: docker.elastic.co/elasticsearch/elasticsearch:5.6.7
+        environment:
+          <<: *es56-env
+    working_directory: ~/repo
+    environment:
+      GEMFILE: gemfiles/rails.6.1.activerecord.gemfile
+    steps:
+      - rspec-test
+
+  rspec-ruby-27-mongoid:
+    docker:
+      - image: circleci/ruby:2.7
+      - image: circleci/mongo:4.2.5
+      - image: docker.elastic.co/elasticsearch/elasticsearch:5.6.7
+        environment:
+          <<: *es56-env
+    working_directory: ~/repo
+    environment:
+      GEMFILE: gemfiles/rails.5.2.mongoid.6.4.gemfile
+    steps:
+      - rspec-test
+
+  rspec-ruby-30-activerecord61:
+    docker:
+      - image: circleci/ruby:3.0
+      - image: docker.elastic.co/elasticsearch/elasticsearch:5.6.7
+        environment:
+          <<: *es56-env
+    working_directory: ~/repo
+    environment:
+      GEMFILE: gemfiles/rails.6.1.activerecord.gemfile
+    steps:
+      - rspec-test

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # master
 
+# Version 5.2.0
+
+## Changes
+
+  * Add support for Ruby 3 (@lowang, #734)
+
+  * Correct deprecation warning for Elasticsearch 5.6 to 6: empty query for`_delete_by_query`, delete by alias, `index_already_exists_exception` renaming (@bhacaz, #735)
+
+  * Update gemspec dependencies for Rails. Update CI gemfiles and matrix to tests against current LTS Rails versions. (@bhacaz, #733)
+
+  * Tweak some wording and formatting; add a note about compatibility; update copyright; remove broken logo; update the CI badge (@bbatsov)
+
+  * Update instructions for AWS ElasticSearch (@olancheg, #714)
+  
+  * Fix more ruby 2.7 keyword params deprecation warnings (@aglushkov, #728)
+  
+  * Fixed all deprecation warnings in Ruby 2.7 (@gseddon, #715)
+
+  * Added Ruby 2.7 to CircleCI config (@mrzasa, #718)  
+
+  * Allow configuration of Active Job queue name (@mrzasa, #707)
+
+  * Setup CI on CircleCI (@mrzasa, #711)
+
+  * Fix deprecation warning for contructing new BigDecimal (@AlexVPopov, #710)
+
 # Version 5.1.0
 
 ## Breaking changes

data/Gemfile

@@ -24,3 +24,5 @@ gem 'guard-rspec'
 
 gem 'redcarpet'
 gem 'yard'
+
+eval(File.read('gemfiles/ruby3.gemfile'), nil, 'gemfiles/ruby3.gemfile') if RUBY_VERSION >= '3.0.0' # rubocop:disable Security/Eval

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 pyromaniac
+Copyright (c) 2013-2021 Toptal, LLC
 
 MIT License
 

data/README.md

@@ -1,14 +1,11 @@
 [![Gem Version](https://badge.fury.io/rb/chewy.svg)](http://badge.fury.io/rb/chewy)
-[![Build Status](https://travis-ci.org/toptal/chewy.svg)](https://travis-ci.org/toptal/chewy)
+[![CircleCI](https://circleci.com/gh/toptal/chewy/tree/master.svg?style=svg)](https://circleci.com/gh/toptal/chewy/tree/master)
 [![Code Climate](https://codeclimate.com/github/toptal/chewy.svg)](https://codeclimate.com/github/toptal/chewy)
 [![Inline docs](http://inch-ci.org/github/toptal/chewy.svg?branch=master)](http://inch-ci.org/github/toptal/chewy)
 
-<p align="right">Sponsored by</p>
-<p align="right"><a href="https://www.toptal.com/"><img src="https://www.toptal.com/assets/public/blocks/logo/big.png" alt="Toptal" width="105" height="34"></a></p>
-
 # Chewy
 
-Chewy is an ODM and wrapper for [the official Elasticsearch client](https://github.com/elastic/elasticsearch-ruby).
+Chewy is an ODM (Object Document Mapper), built on top of the [the official Elasticsearch client](https://github.com/elastic/elasticsearch-ruby).
 
 ## Table of Contents
 
@@ -51,13 +48,14 @@ Chewy is an ODM and wrapper for [the official Elasticsearch client](https://gith
     * [chewy:deploy](#chewydeploy)
     * [Parallelizing rake tasks](#parallelizing-rake-tasks)
     * [chewy:journal](#chewyjournal)
-  * [Rspec integration](#rspec-integration)
+  * [RSpec integration](#rspec-integration)
   * [Minitest integration](#minitest-integration)
-* [TODO a.k.a coming soon](#todo-aka-coming-soon)
 * [Contributing](#contributing)
 
 ## Why Chewy?
 
+In this section we'll cover why you might want to use Chewy instead of the official `elasticsearch-ruby` client gem.
+
 * Multi-model indices.
 
   Index classes are independent from ORM/ODM models. Now, implementing e.g. cross-model autocomplete is much easier. You can just define the index and work with it in an object-oriented style. You can define several types for index - one per indexed model.
@@ -76,10 +74,9 @@ Chewy is an ODM and wrapper for [the official Elasticsearch client](https://gith
 
 * Support for ActiveRecord, [Mongoid](https://github.com/mongoid/mongoid) and [Sequel](https://github.com/jeremyevans/sequel).
 
-
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's `Gemfile`:
 
     gem 'chewy'
 
@@ -91,13 +88,29 @@ Or install it yourself as:
 
     $ gem install chewy
 
+## Compatibility
+
+### Ruby
+
+Chewy is compatible with MRI 2.5-3.0¹. 
+
+> ¹ Ruby 3 is only supported with Rails 6.1
+
+### Elasticsearch
+
+Chewy 5 is compatible with Elasticsearch 5. Future versions of Chewy will support Elasticsearch 6 and Elasticsearch 7.
+
 ## Usage
 
 ### Client settings
 
-There are two ways to configure the Chewy client: the `Chewy.settings` hash and `chewy.yml`
+There are two ways to configure the Chewy client:
 
-You can create this file manually or run `rails g chewy:install`.
+* via the hash `Chewy.settings`
+* via the configuration file `chewy.yml`
+
+You can create `chewy.yml` manually or run `rails g chewy:install` to
+generate it.
 
 ```ruby
 # config/initializers/chewy.rb
@@ -129,25 +142,29 @@ Chewy.logger = Logger.new(STDOUT)
 
 See [config.rb](lib/chewy/config.rb) for more details.
 
-#### Aws Elastic Search
-If you would like to use AWS's ElasticSearch using an IAM user policy, you will need to sign your requests for the `es:*` action by injecting the appropriate headers passing a proc to `transport_options`.
+#### AWS Elasticsearch
+
+If you would like to use AWS's Elasticsearch using an IAM user policy, you will need to sign your requests for the `es:*` action by injecting the appropriate headers passing a proc to `transport_options`.
+You'll need an additional gem for Faraday middleware: add `gem 'faraday_middleware-aws-sigv4'` to your Gemfile.
 
 ```ruby
- Chewy.settings = {
-    host: 'http://my-es-instance-on-aws.us-east-1.es.amazonaws.com:80',
-    transport_options: {
-      headers: { content_type: 'application/json' },
-      proc: -> (f) do
-          f.request :aws_signers_v4,
-                    service_name: 'es',
-                    region: 'us-east-1',
-                    credentials: Aws::Credentials.new(
-                      ENV['AWS_ACCESS_KEY'],
-                      ENV['AWS_SECRET_ACCESS_KEY'])
-      end
-    }
+require 'faraday_middleware/aws_sigv4'
+
+Chewy.settings = {
+  host: 'http://my-es-instance-on-aws.us-east-1.es.amazonaws.com:80',
+  port: 80, # 443 for https host
+  transport_options: {
+    headers: { content_type: 'application/json' },
+    proc: -> (f) do
+        f.request :aws_sigv4,
+                  service: 'es',
+                  region: 'us-east-1',
+                  access_key_id: ENV['AWS_ACCESS_KEY'],
+                  secret_access_key: ENV['AWS_SECRET_ACCESS_KEY']
+    end
   }
-  ```
+}
+```
 
 ### Index definition
 
@@ -678,6 +695,11 @@ Chewy.strategy(:sidekiq) do
 end
 ```
 
+The default queue name is `chewy`, you can customize it in settings: `sidekiq.queue_name`
+```
+Chewy.settings[:sidekiq] = {queue: :low}
+```
+
 #### `:active_job`
 
 This does the same thing as `:atomic`, but using ActiveJob. This will inherit the ActiveJob configuration settings including the `active_job.queue_adapter` setting for the environment. Patch `Chewy::Strategy::ActiveJob::Worker` for index updates improving.
@@ -688,6 +710,11 @@ Chewy.strategy(:active_job) do
 end
 ```
 
+The default queue name is `chewy`, you can customize it in settings: `active_job.queue_name`
+```
+Chewy.settings[:active_job] = {queue: :low}
+```
+
 #### `:shoryuken`
 
 This does the same thing as `:atomic`, but asynchronously using shoryuken. Patch `Chewy::Strategy::Shoryuken::Worker` for index updates improving.
@@ -1061,7 +1088,7 @@ rake chewy:journal:apply["$(date -v-1H -u +%FT%TZ)"] # apply journaled changes f
 rake chewy:journal:apply["$(date -v-1H -u +%FT%TZ)",users] # apply journaled changes for the past hour on UsersIndex only
 ```
 
-### Rspec integration
+### RSpec integration
 
 Just add `require 'chewy/rspec'` to your spec_helper.rb and you will get additional features: See [update_index.rb](lib/chewy/rspec/update_index.rb) for more details.
 
@@ -1082,12 +1109,6 @@ If you use `DatabaseCleaner` in your tests with [the `transaction` strategy](htt
 Chewy.use_after_commit_callbacks = !Rails.env.test?
 ```
 
-## TODO a.k.a coming soon:
-
-* Typecasting support
-* update_all support
-* Maybe, closer ORM/ODM integration, creating index classes implicitly
-
 ## Contributing
 
 1. Fork it (http://github.com/toptal/chewy/fork)
@@ -1103,3 +1124,8 @@ Use the following Rake tasks to control the Elasticsearch cluster while developi
 rake elasticsearch:start # start Elasticsearch cluster on 9250 port for tests
 rake elasticsearch:stop # stop Elasticsearch
 ```
+
+## Copyright
+
+Copyright (c) 2013-2021 Toptal, LLC. See [LICENSE.txt](LICENSE.txt) for
+further details.

data/chewy.gemspec

@@ -5,8 +5,8 @@ require 'chewy/version'
 Gem::Specification.new do |spec| # rubocop:disable BlockLength
   spec.name          = 'chewy'
   spec.version       = Chewy::VERSION
-  spec.authors       = ['pyromaniac']
-  spec.email         = ['kinwizard@gmail.com']
+  spec.authors       = ['Toptal, LLC', 'pyromaniac']
+  spec.email         = ['open-source@toptal.com', 'kinwizard@gmail.com']
   spec.summary       = 'Elasticsearch ODM client wrapper'
   spec.description   = 'Chewy provides functionality for Elasticsearch index handling, documents import mappings and chainable query DSL'
   spec.homepage      = 'https://github.com/toptal/chewy'
@@ -22,7 +22,7 @@ Gem::Specification.new do |spec| # rubocop:disable BlockLength
   spec.add_development_dependency 'elasticsearch-extensions'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'resque_spec'
-  spec.add_development_dependency 'rspec', '~> 3.7.0'
+  spec.add_development_dependency 'rspec', '>= 3.7.0'
   spec.add_development_dependency 'rspec-collection_matchers'
   spec.add_development_dependency 'rspec-its'
   spec.add_development_dependency 'rubocop', '0.52.1'
@@ -32,7 +32,7 @@ Gem::Specification.new do |spec| # rubocop:disable BlockLength
   spec.add_development_dependency 'method_source'
   spec.add_development_dependency 'unparser'
 
-  spec.add_dependency 'activesupport', '>= 4.0'
+  spec.add_dependency 'activesupport', '>= 5.2'
   spec.add_dependency 'elasticsearch', '>= 2.0.0'
   spec.add_dependency 'elasticsearch-dsl'
 end