chewy 0.10.1 → 7.0.0

data/migration_guide.md

@@ -0,0 +1,34 @@
+# Migration guide
+
+This document outlines the steps you need to take when migrating between major versions of
+Chewy and Elasticsearch. For simplicity's sake the guide will assume that you're using
+Chewy alongside a matching Elasticsearch version.
+
+## Chewy 6/Elasticsearch 6 to Chewy 7/Elasticsearch 7
+
+In order to upgrade Chewy 6/Elasticsearch 6 to Chewy 7/Elasticsearch 7 in the most seamless manner you have to:
+
+* Upgrade to the latest 6.x stable releases, namely Chewy 6.0, Elasticsearch 6.8
+* Study carefully [Breaking changes in 7.0](https://www.elastic.co/guide/en/elasticsearch/reference/current/breaking-changes-7.0.htmll), make sure your application conforms.
+* Run your test suite on Chewy 7 / Elasticsearch 7
+* Run manual tests on Chewy 7 / Elasticsearch 7
+* Upgrade to Chewy 7
+* Perform a [rolling upgrade](https://www.elastic.co/guide/en/elasticsearch/reference//rolling-upgrades.html) of Elasticsearch
+
+## Chewy 5/Elasticsearch 5 to Chewy 6/Elasticsearch 6
+
+In order to upgrade Chewy 5/Elasticsearch 5 to Chewy 6/Elasticsearch 6 in the most seamless manner you have to:
+
+* Upgrade to the latest 5.x stable releases, namely Chewy 5.2, Elasticsearch 5.6
+* [Migrate any multi-typed indexes into single-typed](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/removal-of-types.html)
+  * Using [multi-index queries](https://github.com/toptal/chewy/pull/657) could be helpful
+  * Parent/Child [relationship is deprecated](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/removal-of-types.html#parent-child-mapping-types) in favor of the [join field](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/parent-join.html)
+* Handle deprecation of `string` type & `not_analyzed` value for the `index` mapping parameter:
+  * replace fields with `{ type: 'string', index: 'not_analyzed'}` by `{type: 'keyword'}`
+  * replace fields with `{ type: 'string', index: 'analyzed'}` by `{type: 'text'}`
+* `PathHierarchy` tokenizer' param `delimiter` now accepts only one argument, [others should be replaced by character filter ](https://discuss.elastic.co/t/multichar-delimiter-in-path-hierarchy-tokenizer/16203)
+* Make sure you don't use any other of the [deprecated Elasticsearch 5 features](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/breaking-changes-6.0.html)
+* Run your test suite on Chewy 6 / Elasticsearch 6
+* Run manual tests on Chewy 6 / Elasticsearch 6
+* Upgrade to Chewy 6
+* Perform a [rolling upgrade](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/rolling-upgrades.html) of Elasticsearch

data/spec/chewy/config_spec.rb

@@ -6,9 +6,6 @@ describe Chewy::Config do
   its(:logger) { should be_nil }
   its(:transport_logger) { should be_nil }
   its(:transport_logger) { should be_nil }
-  its(:query_mode) { should == :must }
-  its(:filter_mode) { should == :and }
-  its(:post_filter_mode) { should be_nil }
   its(:root_strategy) { should == :base }
   its(:request_strategy) { should == :atomic }
   its(:use_after_commit_callbacks) { should == true }
@@ -54,24 +51,6 @@ describe Chewy::Config do
     end
   end
 
-  describe '#search_class=' do
-    specify do
-      expect { subject.search_class = Chewy::Query }
-        .to change { subject.search_class }
-        .from(be < Chewy::Search::Request)
-        .to(be < Chewy::Query)
-    end
-
-    context do
-      before { hide_const('Kaminari') }
-
-      specify do
-        expect(subject.search_class.included_modules)
-          .to include(Chewy::Search::Pagination::WillPaginate)
-      end
-    end
-  end
-
   describe '#search_class' do
     context 'nothing is defined' do
       before do
@@ -137,5 +116,21 @@ describe Chewy::Config do
     specify do
       expect(subject.configuration).to include(indices_path: 'app/custom_indices_path')
     end
+
+    context 'when Rails::VERSION constant is defined' do
+      it 'looks for configuration in "config/chewy.yml"' do
+        module Rails
+          VERSION = '5.1.1'.freeze
+
+          def self.root
+            Pathname.new(__dir__)
+          end
+        end
+
+        expect(File).to receive(:exist?)
+          .with(Pathname.new(__dir__).join('config', 'chewy.yml'))
+        subject.configuration
+      end
+    end
   end
 end

data/spec/chewy/fields/base_spec.rb

@@ -63,7 +63,7 @@ describe Chewy::Fields::Base do
     end
 
     context 'implicit values' do
-      let(:field) { described_class.new(:name, type: 'string') }
+      let(:field) { described_class.new(:name, type: 'integer') }
       before do
         field.children.push(described_class.new(:name))
         field.children.push(described_class.new(:untouched))
@@ -87,8 +87,8 @@ describe Chewy::Fields::Base do
 
   describe '#mappings_hash' do
     let(:field) { described_class.new(:name, type: :object) }
-    let(:fields1) { Array.new(2) { |i| described_class.new("name#{i + 1}", type: "string#{i + 1}") } }
-    let(:fields2) { Array.new(2) { |i| described_class.new("name#{i + 3}", type: "string#{i + 3}") } }
+    let(:fields1) { Array.new(2) { |i| described_class.new("name#{i + 1}", type: "integer#{i + 1}") } }
+    let(:fields2) { Array.new(2) { |i| described_class.new("name#{i + 3}", type: "integer#{i + 3}") } }
     before do
       fields1.each { |m| field.children.push(m) }
       fields2.each { |m| fields1[0].children.push(m) }
@@ -96,28 +96,30 @@ describe Chewy::Fields::Base do
 
     specify do
       expect(field.mappings_hash).to eq(name: {type: :object, properties: {
-        name1: {type: 'string1', fields: {
-          name3: {type: 'string3'}, name4: {type: 'string4'}
-        }}, name2: {type: 'string2'}
+        name1: {type: 'integer1', fields: {
+          name3: {type: 'integer3'}, name4: {type: 'integer4'}
+        }}, name2: {type: 'integer2'}
       }})
     end
 
     context do
-      let(:field) { described_class.new(:name, type: :string) }
-      let(:fields1) { Array.new(2) { |i| described_class.new("name#{i + 1}") } }
+      let(:field) { described_class.new(:name, type: :integer) }
+      let(:fields1) do
+        [described_class.new(:name1), described_class.new(:name2, type: 'integer')]
+      end
 
       specify do
-        expect(field.mappings_hash).to eq(name: {type: :string, fields: {
+        expect(field.mappings_hash).to eq(name: {type: :integer, fields: {
           name1: {type: 'object', properties: {
-            name3: {type: 'string3'}, name4: {type: 'string4'}
-          }}, name2: {type: 'string'}
+            name3: {type: 'integer3'}, name4: {type: 'integer4'}
+          }}, name2: {type: 'integer'}
         }})
       end
     end
   end
 
   context 'integration' do
-    context 'objects, hashes and arrays' do
+    context 'default field type' do
       before do
         stub_index(:events) do
           define_type :event do
@@ -126,26 +128,33 @@ describe Chewy::Fields::Base do
               field :id
               field :licenses do
                 field :id
-                field :name
+                field :created_at, type: 'time'
               end
             end
           end
         end
       end
 
+      around do |example|
+        previous_type = Chewy.default_field_type
+        Chewy.default_field_type = 'integer'
+        example.run
+        Chewy.default_field_type = previous_type
+      end
+
       specify do
         expect(EventsIndex::Event.mappings_hash).to eq(event: {
           properties: {
-            id: {type: 'string'},
+            id: {type: 'integer'},
             category: {
               type: 'object',
               properties: {
-                id: {type: 'string'},
+                id: {type: 'integer'},
                 licenses: {
                   type: 'object',
                   properties: {
-                    id: {type: 'string'},
-                    name: {type: 'string'}
+                    id: {type: 'integer'},
+                    created_at: {type: 'time'}
                   }
                 }
               }
@@ -153,83 +162,72 @@ describe Chewy::Fields::Base do
           }
         })
       end
+    end
 
-      context 'default field type' do
-        around do |example|
-          previous_type = Chewy.default_field_type
-          Chewy.default_field_type = 'text'
-          example.run
-          Chewy.default_field_type = previous_type
-        end
-
-        specify do
-          expect(EventsIndex::Event.mappings_hash).to eq(event: {
-            properties: {
-              id: {type: 'text'},
-              category: {
-                type: 'object',
-                properties: {
-                  id: {type: 'text'},
-                  licenses: {
-                    type: 'object',
-                    properties: {
-                      id: {type: 'text'},
-                      name: {type: 'text'}
-                    }
-                  }
-                }
-              }
-            }
-          })
+    context 'objects, hashes and arrays' do
+      before do
+        stub_index(:events) do
+          define_type :event do
+            field :id
+            field :category do
+              field :id
+              field :licenses do
+                field :id
+                field :name
+              end
+            end
+          end
         end
       end
 
+      # rubocop:disable Style/BracesAroundHashParameters
       specify do
-        expect(EventsIndex::Event.root_object.compose(
-                 id: 1, category: {id: 2, licenses: {id: 3, name: 'Name'}}
-        )).to eq('id' => 1, 'category' => {'id' => 2, 'licenses' => {'id' => 3, 'name' => 'Name'}})
+        expect(EventsIndex::Event.root.compose({
+          id: 1, category: {id: 2, licenses: {id: 3, name: 'Name'}}
+        })).to eq('id' => 1, 'category' => {'id' => 2, 'licenses' => {'id' => 3, 'name' => 'Name'}})
       end
 
       specify do
-        expect(EventsIndex::Event.root_object.compose(id: 1, category: [
+        expect(EventsIndex::Event.root.compose({id: 1, category: [
           {id: 2, 'licenses' => {id: 3, name: 'Name1'}},
           {id: 4, licenses: nil}
-        ])).to eq('id' => 1, 'category' => [
+        ]})).to eq('id' => 1, 'category' => [
           {'id' => 2, 'licenses' => {'id' => 3, 'name' => 'Name1'}},
           {'id' => 4, 'licenses' => nil.as_json}
         ])
       end
 
       specify do
-        expect(EventsIndex::Event.root_object.compose('id' => 1, category: {id: 2, licenses: [
+        expect(EventsIndex::Event.root.compose({'id' => 1, category: {id: 2, licenses: [
           {id: 3, name: 'Name1'}, {id: 4, name: 'Name2'}
-        ]})).to eq('id' => 1, 'category' => {'id' => 2, 'licenses' => [
+        ]}})).to eq('id' => 1, 'category' => {'id' => 2, 'licenses' => [
           {'id' => 3, 'name' => 'Name1'}, {'id' => 4, 'name' => 'Name2'}
         ]})
       end
 
       specify do
-        expect(EventsIndex::Event.root_object.compose(id: 1, category: [
+        expect(EventsIndex::Event.root.compose({id: 1, category: [
           {id: 2, licenses: [
             {id: 3, 'name' => 'Name1'}, {id: 4, name: 'Name2'}
           ]},
           {id: 5, licenses: []}
-        ])).to eq('id' => 1, 'category' => [
+        ]})).to eq('id' => 1, 'category' => [
           {'id' => 2, 'licenses' => [
             {'id' => 3, 'name' => 'Name1'}, {'id' => 4, 'name' => 'Name2'}
           ]},
           {'id' => 5, 'licenses' => []}
         ])
       end
+      # rubocop:enable Style/BracesAroundHashParameters
 
       specify do
-        expect(EventsIndex::Event.root_object.compose(
+        expect(EventsIndex::Event.root.compose(
                  double(id: 1, category: double(id: 2, licenses: double(id: 3, name: 'Name')))
         )).to eq('id' => 1, 'category' => {'id' => 2, 'licenses' => {'id' => 3, 'name' => 'Name'}})
       end
 
       specify do
-        expect(EventsIndex::Event.root_object.compose(double(id: 1, category: [
+        expect(EventsIndex::Event.root.compose(double(id: 1, category: [
           double(id: 2, licenses: double(id: 3, name: 'Name1')),
           double(id: 4, licenses: nil)
         ]))).to eq('id' => 1, 'category' => [
@@ -239,7 +237,7 @@ describe Chewy::Fields::Base do
       end
 
       specify do
-        expect(EventsIndex::Event.root_object.compose(double(id: 1, category: double(id: 2, licenses: [
+        expect(EventsIndex::Event.root.compose(double(id: 1, category: double(id: 2, licenses: [
           double(id: 3, name: 'Name1'), double(id: 4, name: 'Name2')
         ])))).to eq('id' => 1, 'category' => {'id' => 2, 'licenses' => [
           {'id' => 3, 'name' => 'Name1'}, {'id' => 4, 'name' => 'Name2'}
@@ -247,7 +245,7 @@ describe Chewy::Fields::Base do
       end
 
       specify do
-        expect(EventsIndex::Event.root_object.compose(double(id: 1, category: [
+        expect(EventsIndex::Event.root.compose(double(id: 1, category: [
           double(id: 2, licenses: [
             double(id: 3, name: 'Name1'), double(id: 4, name: 'Name2')
           ]),
@@ -265,11 +263,11 @@ describe Chewy::Fields::Base do
       before do
         stub_index(:events) do
           define_type :event do
-            field :id
+            field :id, type: 'integer'
             field :category, value: -> { categories } do
-              field :id
+              field :id, type: 'integer'
               field :licenses, value: -> { license } do
-                field :id
+                field :id, type: 'integer'
                 field :name
               end
             end
@@ -278,7 +276,7 @@ describe Chewy::Fields::Base do
       end
 
       specify do
-        expect(EventsIndex::Event.root_object.compose(
+        expect(EventsIndex::Event.root.compose(
                  double(id: 1, categories: double(id: 2, license: double(id: 3, name: 'Name')))
         )).to eq('id' => 1, 'category' => {'id' => 2, 'licenses' => {'id' => 3, 'name' => 'Name'}})
       end
@@ -288,8 +286,8 @@ describe Chewy::Fields::Base do
       before do
         stub_index(:events) do
           define_type :event do
-            field :id
-            field :name, type: 'string' do
+            field :id, type: 'integer'
+            field :name, type: 'integer' do
               field :raw, analyzer: 'my_own'
             end
             field :category, type: 'object'
@@ -300,11 +298,11 @@ describe Chewy::Fields::Base do
       specify do
         expect(EventsIndex::Event.mappings_hash).to eq(event: {
           properties: {
-            id: {type: 'string'},
+            id: {type: 'integer'},
             name: {
-              type: 'string',
+              type: 'integer',
               fields: {
-                raw: {analyzer: 'my_own', type: 'string'}
+                raw: {analyzer: 'my_own', type: Chewy.default_field_type}
               }
             },
             category: {type: 'object'}
@@ -313,7 +311,7 @@ describe Chewy::Fields::Base do
       end
 
       specify do
-        expect(EventsIndex::Event.root_object.compose(
+        expect(EventsIndex::Event.root.compose(
                  double(id: 1, name: 'Jonny', category: double(id: 2, as_json: {'name' => 'Borogoves'}))
         )).to eq(
           'id' => 1,
@@ -323,7 +321,7 @@ describe Chewy::Fields::Base do
       end
 
       specify do
-        expect(EventsIndex::Event.root_object.compose(
+        expect(EventsIndex::Event.root.compose(
                  double(id: 1, name: 'Jonny', category: [
                    double(id: 2, as_json: {'name' => 'Borogoves1'}),
                    double(id: 3, as_json: {'name' => 'Borogoves2'})
@@ -388,7 +386,7 @@ describe Chewy::Fields::Base do
       end
 
       specify do
-        expect(CountriesIndex::Country.root_object.compose(country_with_cities)).to eq('id' => 1, 'cities' => [
+        expect(CountriesIndex::Country.root.compose(country_with_cities)).to eq('id' => 1, 'cities' => [
           {'id' => 1, 'name' => 'City1'}, {'id' => 2, 'name' => 'City2'}
         ])
       end
@@ -407,7 +405,7 @@ describe Chewy::Fields::Base do
         end
 
         specify do
-          expect(CitiesIndex::City.root_object.compose(
+          expect(CitiesIndex::City.root.compose(
                    City.create!(id: 1, country: Country.create!(id: 1, name: 'Country'))
           )).to eq('id' => 1, 'country' => {'id' => 1, 'name' => 'Country'})
         end

data/spec/chewy/fields/root_spec.rb

@@ -5,7 +5,7 @@ describe Chewy::Fields::Root do
 
   describe '#dynamic_template' do
     specify do
-      field.dynamic_template 'hello', type: 'string'
+      field.dynamic_template 'hello', type: 'keyword'
       field.dynamic_template 'hello*', :integer
       field.dynamic_template 'hello.*'
       field.dynamic_template(/hello/)
@@ -14,7 +14,7 @@ describe Chewy::Fields::Root do
       field.dynamic_template(/hello\..*/)
 
       expect(field.mappings_hash).to eq(product: {dynamic_templates: [
-        {template_1: {mapping: {type: 'string'}, match: 'hello'}},
+        {template_1: {mapping: {type: 'keyword'}, match: 'hello'}},
         {template_2: {mapping: {}, match_mapping_type: 'integer', match: 'hello*'}},
         {template_3: {mapping: {}, path_match: 'hello.*'}},
         {template_4: {mapping: {}, match: 'hello', match_pattern: 'regexp'}},
@@ -32,10 +32,10 @@ describe Chewy::Fields::Root do
       end
 
       specify do
-        field.dynamic_template 'hello', type: 'string'
+        field.dynamic_template 'hello', type: 'keyword'
         expect(field.mappings_hash).to eq(product: {dynamic_templates: [
           {template_42: {mapping: {}, match: ''}},
-          {template_1: {mapping: {type: 'string'}, match: 'hello'}}
+          {template_1: {mapping: {type: 'keyword'}, match: 'hello'}}
         ]})
       end
     end
@@ -53,11 +53,11 @@ describe Chewy::Fields::Root do
       let(:city) { City.new(name: 'London', rating: 100) }
 
       specify do
-        expect(PlacesIndex::City.send(:build_root).compose(city))
+        expect(PlacesIndex::City.root.compose(city))
           .to match(hash_including('name' => 'London', 'rating' => 100))
       end
       specify do
-        expect(PlacesIndex::City.send(:build_root).compose(city, fields: %i[name borogoves]))
+        expect(PlacesIndex::City.root.compose(city, fields: %i[name borogoves]))
           .to eq('name' => 'London')
       end
     end
@@ -74,11 +74,11 @@ describe Chewy::Fields::Root do
       let(:city) { double(name: 'London', rating: 100) }
 
       specify do
-        expect(PlacesIndex::City.send(:build_root).compose(city))
+        expect(PlacesIndex::City.root.compose(city))
           .to eq('name' => 'London', 'rating' => 100)
       end
       specify do
-        expect(PlacesIndex::City.send(:build_root).compose(city, fields: %i[name borogoves]))
+        expect(PlacesIndex::City.root.compose(city, fields: %i[name borogoves]))
           .to eq('name' => 'London')
       end
     end
@@ -95,12 +95,12 @@ describe Chewy::Fields::Root do
       let(:city) { double(name: 'London', rating: 100) }
 
       specify do
-        expect(PlacesIndex::City.send(:build_root).compose(city))
+        expect(PlacesIndex::City.root.compose(city))
           .to eq('name' => 'LondonModified', 'rating' => 101)
       end
 
       specify do
-        expect(PlacesIndex::City.send(:build_root).compose(city, fields: %i[name borogoves]))
+        expect(PlacesIndex::City.root.compose(city, fields: %i[name borogoves]))
           .to eq('name' => 'LondonModified')
       end
     end
@@ -120,12 +120,12 @@ describe Chewy::Fields::Root do
       let(:city) { double(name: 'London', rating: 100) }
 
       specify do
-        expect(PlacesIndex::City.send(:build_root).compose(city))
+        expect(PlacesIndex::City.root.compose(city))
           .to eq('name' => 'LondonModifiedModified', 'rating' => 101)
       end
 
       specify do
-        expect(PlacesIndex::City.send(:build_root).compose(city, fields: %i[name borogoves]))
+        expect(PlacesIndex::City.root.compose(city, fields: %i[name borogoves]))
           .to eq('name' => 'LondonModifiedModified')
       end
     end
@@ -141,7 +141,7 @@ describe Chewy::Fields::Root do
     end
 
     specify do
-      expect(PlacesIndex::City.send(:build_root).child_hash).to match(
+      expect(PlacesIndex::City.root.child_hash).to match(
         name: an_instance_of(Chewy::Fields::Base).and(have_attributes(name: :name)),
         rating: an_instance_of(Chewy::Fields::Base).and(have_attributes(name: :rating))
       )