es-elasticity 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04e7ce66153cf480adc1bf812e4008990cfbe42e
-  data.tar.gz: 2921aadea55a478b5828fe5c951e69f2d40f92da
+  metadata.gz: 720cd13dc5ba2ce7e66491cf089672f11d8a755d
+  data.tar.gz: 203824852dd40864503b465430fa401fec2d758e
 SHA512:
-  metadata.gz: 96f0fec58b65a740c6fcde60eeddbd304312bee52a37fdac467ce41f738226d0554d18ff11433b54ccaedd004626baaddd84fbbc69a8cfaa54b0b03fe7d79dca
-  data.tar.gz: d85e97773d2ebb371de50e484cbe7f13cde68da36e15e76ceceb89aa4c0dbfb33c6a576b9de161e792a20693e751a42ac8f58e5d1be1bc9b21b6cbdef471d1b7
+  metadata.gz: 1bfd03d5807b389ba5d9cd38105ce26d997c1ae2d028462b1f28a6f271d1220e375c32c48af8c700cd232a881648599524a56e0ccc912c0489739d55509820af
+  data.tar.gz: 9246d84d925302de828eab261f940039b64bf28c6b72df57ae512c9854aeda14dd095a57cf62aa5da2f88ddd3769ba5ae226ec8ac60b70c8a0b05cb02da8e01b

data/CHANGELOG

@@ -1,3 +1,7 @@
+v0.8.0
+ - Make Elasticity::Strategies::AliasIndex the default
+ - Use mapping instead of mappings, we wanna be consistent to ES not to elasticsearch-ruby
+ - Better automatic index name and document type
 v0.7.1
 	- add more response info to raised exceptions from reindexing
 v0.6.5

data/README.md

@@ -391,17 +391,20 @@ Note that the method takes a relation and not a class, so the following is also
 Search::User.adults.active_records(User.where(active: true))
 ```
 
-## Roadmap
+## Upgrading from 0.7.0 to 0.8.0
+The default persistance strategy changed from SingleIndex to AliasIndex in version 0.8.0 Add the following to your Document configuration to maintain the legacy behaviour.
 
-- [ ] Make Elasticity::Strategies::AliasIndex the default
-- [ ] Use mapping instead of mappings, we wanna be consistent to ES not to elasticsearch-ruby
+```ruby
+  c.strategy = Elasticity::Strategies::SingleIndex
+```
+
+## Roadmap
 - [ ] Define from_active_record interface
 - [ ] Write more detailed documentation section for:
   - [ ] Model definition
   - [ ] Indexing, Bulk Indexing and Delete By Query
   - [ ] Search and Multi Search
   - [ ] ActiveRecord integration
-- [ ] Better automatic index name and document type
 - [ ] Support for multiple document types
 - [ ] Get rid of to_document, generate automatically based on attributes
 - [ ] Add some delegations on Document to Index

data/lib/elasticity/base_document.rb

@@ -8,7 +8,7 @@ module Elasticity
     # Configure the given klass, changing default parameters and resetting
     # some of the internal state.
     def self.configure(&block)
-      self.config = IndexConfig.new(Elasticity.config, self.name.underscore, &block)
+      self.config = IndexConfig.new(Elasticity.config, self.index_config_defaults, &block)
     end
 
     # Define common attributes for all documents
@@ -49,5 +49,22 @@ module Elasticity
     def created?
       @created || false
     end
+
+    private
+
+    def self.index_config_defaults
+      {
+        document_type: default_document_type,
+        index_base_name: default_index_base_name
+      }
+    end
+
+    def self.default_document_type
+      self.name.gsub('::', '_').underscore
+    end
+
+    def self.default_index_base_name
+      ActiveSupport::Inflector.pluralize(default_document_type)
+    end
   end
 end

data/lib/elasticity/index_config.rb

@@ -5,8 +5,10 @@ module Elasticity
 
     attr_accessor *ATTRS
 
-    def initialize(elasticity_config, default_document_type)
-      @document_type = default_document_type
+    def initialize(elasticity_config, defaults = {})
+      defaults.each do |k,v|
+        instance_variable_set("@#{k}",v)
+      end
       @elasticity_config = elasticity_config
       yield(self)
       validate!
@@ -48,7 +50,7 @@ module Elasticity
     end
 
     def strategy
-      @strategy ||= Strategies::SingleIndex
+      @strategy ||= Strategies::AliasIndex
     end
 
     private

data/lib/elasticity/strategies/alias_index.rb

@@ -238,6 +238,14 @@ module Elasticity
       end
 
       def mappings
+        ActiveSupport::Deprecation.warn(
+          'Elasticity::Strategies::AliasIndex#mappings is deprecated, '\
+          'use mapping instead'
+        )
+        mapping
+      end
+
+      def mapping
         @client.index_get_mapping(index: @main_alias, type: @document_type).values.first
       rescue Elasticsearch::Transport::Transport::Errors::NotFound
         nil

data/lib/elasticity/strategies/single_index.rb

@@ -85,6 +85,14 @@ module Elasticity
       end
 
       def mappings
+        ActiveSupport::Deprecation.warn(
+          'Elasticity::Strategies::SingleIndex#mappings is deprecated, '\
+          'use mapping instead'
+        )
+        mapping
+      end
+
+      def mapping
         @client.index_get_mapping(index: @index_name, type: @document_type).values.first
       rescue Elasticsearch::Transport::Transport::Errors::NotFound
         nil

data/lib/elasticity/version.rb

@@ -1,3 +1,3 @@
 module Elasticity
-  VERSION = "0.7.1"
+  VERSION = "0.8.0"
 end

data/spec/units/document_spec.rb

@@ -39,7 +39,7 @@ RSpec.describe Elasticity::Document do
   end
 
   before :each do
-    allow(Elasticity::Strategies::SingleIndex).to receive(:new).and_return(strategy)
+    allow(Elasticity::Strategies::AliasIndex).to receive(:new).and_return(strategy)
   end
 
   it "requires subclasses to define to_document method" do

data/spec/units/index_config_spec.rb

@@ -0,0 +1,29 @@
+require 'elasticity/index_config'
+
+RSpec.describe Elasticity::IndexConfig do
+  let(:elasticity_config) { double }
+  subject {  }
+
+    let(:defaults) do
+      {
+        index_base_name: 'users',
+        document_type: 'user'
+      }
+    end
+
+  it 'accepts default configuration options' do
+    config = described_class.new(elasticity_config, defaults) {}
+    expect(config.index_base_name).to eql('users')
+    expect(config.document_type).to eql('user')
+  end
+
+  it 'overrides defaults' do
+    config = described_class.new(elasticity_config, defaults) do |c|
+      c.index_base_name = 'user_documents'
+      c.document_type = 'users'
+    end
+
+    expect(config.index_base_name).to eql('user_documents')
+    expect(config.document_type).to eql('users')
+  end
+end

data/spec/units/strategies/single_index_spec.rb

@@ -21,17 +21,17 @@ RSpec.describe Elasticity::Strategies::SingleIndex, elasticsearch: true do
 
   it "allows creating, recreating and deleting an index" do
     subject.create(index_def)
-    expect(subject.mappings).to eq(index_def)
+    expect(subject.mapping).to eq(index_def)
 
     subject.recreate(index_def)
-    expect(subject.mappings).to eq(index_def)
+    expect(subject.mapping).to eq(index_def)
 
     subject.delete
-    expect(subject.mappings).to be nil
+    expect(subject.mapping).to be nil
   end
 
   it "returns nil for mapping and settings when index does not exist" do
-    expect(subject.mappings).to be nil
+    expect(subject.mapping).to be nil
     expect(subject.settings).to be nil
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: es-elasticity
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Rodrigo Kochenburger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-10 00:00:00.000000000 Z
+date: 2017-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -218,6 +218,7 @@ files:
 - spec/functional/segmented_spec.rb
 - spec/rspec_config.rb
 - spec/units/document_spec.rb
+- spec/units/index_config_spec.rb
 - spec/units/index_mapper_spec.rb
 - spec/units/multi_search_spec.rb
 - spec/units/search_spec.rb
@@ -242,7 +243,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: ActiveModel-based library for working with Elasticsearch
@@ -251,7 +252,9 @@ test_files:
 - spec/functional/segmented_spec.rb
 - spec/rspec_config.rb
 - spec/units/document_spec.rb
+- spec/units/index_config_spec.rb
 - spec/units/index_mapper_spec.rb
 - spec/units/multi_search_spec.rb
 - spec/units/search_spec.rb
 - spec/units/strategies/single_index_spec.rb
+has_rdoc: