elasticsearch-model 0.1.4 → 0.1.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzQ5M2Q0YTQyMWFiNTY5OGIwNzYyMTA2NTkzOGFmNDczZWQzZjQ4Mg==
+    MjRiMDMxMDViNGQxODdmNTQ3Nzc4N2IyOWYyMTdiNzhlMmIzZWZhYw==
   data.tar.gz: !binary |-
-    N2QyZDk1ODYzYjJlY2E3MGY0ZGNlNmFlZDBkMGYzMTk0NzdlMTlmOQ==
+    NjE4NjI4NDBkNDdjNTU4MjU1YTJhZDU0MzRmZTk1NDdkMTgxNDc1Mw==
 SHA512:
   metadata.gz: !binary |-
-    NGI1ZTM1ODZhYmY1NmVhZmYxYTRjNjRkNTMyYjYxOWY5MzZhY2JkYTlmOWY1
-    ZTlhMWI1NTkwOWNlYWVjNWU3ZWQxZTM3NWQ5MDIyZmUxNzRlYjJjNzk0Mjk4
-    MzU2OTU3NmQzNjRjYzNkZmQ1MmI3MTdmZjAxYjlmYWY3MWEzYWY=
+    NWJhZjZjNzRiYmYwOTVlZjc4ZTk0ZTRhMWRkNWI0MWMxZTAxODVmYzAwZTM5
+    NDc4MTkxMDZlOTRlMDc1MDkyMGUwZTNjZDU4MWE2Y2I5YmQ4MGI2NDA0NDVi
+    NDI0MGUxNjdjOTE2MTQ4MmM2OTcwM2ZjMDA5Nzg3YTcwY2YzOTg=
   data.tar.gz: !binary |-
-    Y2ZjZGM0MGY4OWFhMzZkNmI0NTU4YTlhYzkzNGZmN2FhNGUxZDg2N2NkOGQ3
-    ZjM2YjIzNTYxODk2MmJjYWViZmU2NGI5YWI0NjBhNGMyOThiYWVlOTRiYjI5
-    ZjUzYWNlNDZhMWM4N2MwYjE3ZmMwMDBiNzVkOTNmNTEwMTJmOTc=
+    NGM2NGM2NTBjNTEzMzdhNjZmYzI5MzM4NDZiYjEwOTQ4Y2Y2NWQyYTZiYWZl
+    YWExZWQzZmI5NWRmOWRjNzExMDE3NGFjMTM2ODk4NDliOTNkOWI1M2UwZjRk
+    MjA1MWFiODE1ZWY5ZGExZDMxZWZmNzIxNzNhNDAyMDlkZjdjZWI=

data/CHANGELOG.md

@@ -1,4 +1,12 @@
-## 0.1.3
+## 0.1.5
+
+* Improved documentation
+* Fixes and improvements to the "will_paginate" integration
+* Added a `:preprocess` option to the `import` method
+* Changed, that attributes are fetched from `as_indexed_json` in the `update_document` method
+* Added an option to the import method to return an array of error messages instead of just count
+* Fixed many problems with dependency hell
+* Fixed tests so they run on Ruby 2.2
 
 ## 0.1.2
 

data/README.md

@@ -126,7 +126,7 @@ Article.__elasticsearch__.client = Elasticsearch::Client.new host: 'api.server.o
 Or configure the client for all models:
 
 ```ruby
-Elasticsearch::Model.client = Elasticsearch::Client.new log:true
+Elasticsearch::Model.client = Elasticsearch::Client.new log: true
 ```
 
 You might want to do this during you application bootstrap process, e.g. in a Rails initializer.
@@ -146,6 +146,9 @@ Article.import
 # => 0
 ```
 
+It's possible to import only records from a specific `scope`, transform the batch with the `transform`
+and `preprocess` options, or re-create the index by deleting it and creating it with correct mapping with the `force` option -- look for examples in the method documentation.
+
 No errors were reported during importing, so... let's search the index!
 
 
@@ -507,7 +510,8 @@ Article.first.__elasticsearch__.as_indexed_json
 # => {"id"=>1, "title"=>"Quick brown fox"}
 ```
 
-If you want to customize the serialization, just implement the `as_indexed_json` method yourself:
+If you want to customize the serialization, just implement the `as_indexed_json` method yourself,
+for instance with the [`as_json`](http://api.rubyonrails.org/classes/ActiveModel/Serializers/JSON.html#method-i-as_json) method:
 
 ```ruby
 class Article
@@ -524,6 +528,9 @@ Article.first.as_indexed_json
 
 The re-defined method will be used in the indexing methods, such as `index_document`.
 
+Please note that in Rails 3, you need to either set `include_root_in_json: false`, or prevent adding
+the "root" in the JSON representation with other means.
+
 #### Relationships and Associations
 
 When you have a more complicated structure/schema, you need to customize the `as_indexed_json` method -

data/Rakefile

@@ -22,12 +22,18 @@ namespace :test do
     # test.warning = true
   end
 
-  Rake::TestTask.new(:integration) do |test|
+  Rake::TestTask.new(:run_integration) do |test|
     Rake::Task['test:ci_reporter'].invoke if ENV['CI']
     test.libs << 'lib' << 'test'
     test.test_files = FileList["test/integration/**/*_test.rb"]
   end
 
+  desc "Run integration tests against ActiveModel 3 and 4"
+  task :integration do
+    sh "BUNDLE_GEMFILE='#{File.expand_path('../gemfiles/3.0.gemfile', __FILE__)}' bundle exec rake test:run_integration" unless defined?(RUBY_VERSION) && RUBY_VERSION > '2.2'
+    sh "BUNDLE_GEMFILE='#{File.expand_path('../gemfiles/4.0.gemfile', __FILE__)}' bundle exec rake test:run_integration"
+  end
+
   Rake::TestTask.new(:all) do |test|
     Rake::Task['test:ci_reporter'].invoke if ENV['CI']
     test.libs << 'lib' << 'test'

data/elasticsearch-model.gemspec

@@ -34,26 +34,24 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "sqlite3"
   s.add_development_dependency "activemodel",   "> 3.0"
-  s.add_development_dependency "activerecord",  "> 4.0"
 
   s.add_development_dependency "oj"
   s.add_development_dependency "kaminari"
   s.add_development_dependency "will_paginate"
-  # NOTE: Do not add Mongoid here, keep only in 3/4 files
 
-  s.add_development_dependency "minitest", "~> 4.0"
+  s.add_development_dependency "minitest", "~> 4"
+  s.add_development_dependency "test-unit" if defined?(RUBY_VERSION) && RUBY_VERSION > '2.2'
   s.add_development_dependency "shoulda-context"
   s.add_development_dependency "mocha"
   s.add_development_dependency "turn"
   s.add_development_dependency "yard"
   s.add_development_dependency "ruby-prof"
   s.add_development_dependency "pry"
-  s.add_development_dependency "ci_reporter"
+  s.add_development_dependency "ci_reporter", "~> 1.9"
 
   if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
     s.add_development_dependency "simplecov"
     s.add_development_dependency "cane"
     s.add_development_dependency "require-prof"
-    s.add_development_dependency "coveralls"
   end
 end

data/gemfiles/4.0.gemfile

@@ -9,4 +9,3 @@ gemspec path: '../'
 
 gem 'activemodel',  '~> 4'
 gem 'activerecord', '~> 4'
-gem 'mongoid',      '~> 4.0.0.beta1'

data/lib/elasticsearch/model/adapters/active_record.rb

@@ -78,17 +78,19 @@ module Elasticsearch
 
         module Importing
 
-          # Fetch batches of records from the database
+          # Fetch batches of records from the database (used by the import method)
+          #
           #
           # @see http://api.rubyonrails.org/classes/ActiveRecord/Batches.html ActiveRecord::Batches.find_in_batches
           #
           def __find_in_batches(options={}, &block)
             named_scope = options.delete(:scope)
+            preprocess = options.delete(:preprocess)
 
             scope = named_scope ? self.__send__(named_scope) : self
 
             scope.find_in_batches(options) do |batch|
-              yield batch
+              yield (preprocess ? self.__send__(preprocess, batch) : batch)
             end
           end
 

data/lib/elasticsearch/model/importing.rb

@@ -76,16 +76,36 @@ module Elasticsearch
         #
         #    Article.import transform: transform
         #
+        # @example Update the batch before yielding it
+        #
+        #     class Article
+        #       # ...
+        #       def enrich(batch)
+        #         batch.each do |item|
+        #           item.metadata = MyAPI.get_metadata(item.id)
+        #         end
+        #         batch
+        #       end
+        #     end
+        #
+        #    Article.import preprocess: enrich
+        #
+        # @example Return an array of error elements instead of the number of errors, eg.
+        #          to try importing these records again
+        #
+        #    Article.import return: 'errors'
+        #
         def import(options={}, &block)
-          errors       = 0
+          errors       = []
           refresh      = options.delete(:refresh)   || false
           target_index = options.delete(:index)     || index_name
           target_type  = options.delete(:type)      || document_type
           transform    = options.delete(:transform) || __transform
+          return_value = options.delete(:return)    || 'count'
 
           unless transform.respond_to?(:call)
             raise ArgumentError,
-                  "Pass an object responding to `call` as the :transport option, #{transform.class} given"
+                  "Pass an object responding to `call` as the :transform option, #{transform.class} given"
           end
 
           if options.delete(:force)
@@ -100,12 +120,17 @@ module Elasticsearch
 
             yield response if block_given?
 
-            errors += response['items'].map { |k, v| k.values.first['error'] }.compact.length
+            errors +=  response['items'].select { |k, v| k.values.first['error'] }
           end
 
           self.refresh_index! if refresh
 
-          return errors
+          case return_value
+            when 'errors'
+              errors
+            else
+              errors.size
+          end
         end
 
         def __batch_to_bulk(batch, transform)

data/lib/elasticsearch/model/indexing.rb

@@ -336,7 +336,7 @@ module Elasticsearch
         def update_document(options={})
           if changed_attributes = self.instance_variable_get(:@__changed_attributes)
             attributes = if respond_to?(:as_indexed_json)
-              changed_attributes.select { |k,v| self.as_indexed_json.keys.include? k }
+              self.as_indexed_json.select { |k,v| changed_attributes.keys.map(&:to_s).include? k.to_s }
             else
               changed_attributes
             end

data/lib/elasticsearch/model/response/pagination.rb

@@ -102,11 +102,19 @@ module Elasticsearch
 
             # Include the paging methods in results and records
             #
-            methods = [:current_page, :per_page, :total_entries, :total_pages, :previous_page, :next_page, :out_of_bounds?]
+            methods = [:current_page, :offset, :length, :per_page, :total_entries, :total_pages, :previous_page, :next_page, :out_of_bounds?]
             Elasticsearch::Model::Response::Results.__send__ :delegate, *methods, to: :response
             Elasticsearch::Model::Response::Records.__send__ :delegate, *methods, to: :response
           end
 
+          def offset
+            (current_page - 1) * per_page
+          end
+
+          def length
+            search.definition[:size]
+          end
+
           # Main pagination method
           #
           # @example

data/lib/elasticsearch/model/version.rb

@@ -1,5 +1,5 @@
 module Elasticsearch
   module Model
-    VERSION = "0.1.4"
+    VERSION = "0.1.5"
   end
 end

data/test/integration/active_record_associations_parent_child.rb

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'active_record'
 
 class Question < ActiveRecord::Base
   include Elasticsearch::Model

data/test/integration/active_record_associations_test.rb

@@ -1,91 +1,5 @@
 require 'test_helper'
-
-# ----- Models definition -------------------------------------------------------------------------
-
-class Category < ActiveRecord::Base
-  has_and_belongs_to_many :posts
-end
-
-class Author < ActiveRecord::Base
-  has_many :authorships
-
-  def full_name
-    [first_name, last_name].compact.join(' ')
-  end
-end
-
-class Authorship < ActiveRecord::Base
-  belongs_to :author
-  belongs_to :post, touch: true
-end
-
-class Comment < ActiveRecord::Base
-  belongs_to :post, touch: true
-end
-
-class Post < ActiveRecord::Base
-  has_and_belongs_to_many :categories, after_add:    [ lambda { |a,c| a.__elasticsearch__.index_document } ],
-                                       after_remove: [ lambda { |a,c| a.__elasticsearch__.index_document } ]
-  has_many                :authorships
-  has_many                :authors, through: :authorships
-  has_many                :comments
-end
-
-# ----- Search integration via Concern module -----------------------------------------------------
-
-module Searchable
-  extend ActiveSupport::Concern
-
-  included do
-    include Elasticsearch::Model
-    include Elasticsearch::Model::Callbacks
-
-    # Set up the mapping
-    #
-    settings index: { number_of_shards: 1, number_of_replicas: 0 } do
-      mapping do
-        indexes :title,      analyzer: 'snowball'
-        indexes :created_at, type: 'date'
-
-        indexes :authors do
-          indexes :first_name
-          indexes :last_name
-          indexes :full_name, type: 'multi_field' do
-            indexes :full_name
-            indexes :raw, analyzer: 'keyword'
-          end
-        end
-
-        indexes :categories, analyzer: 'keyword'
-
-        indexes :comments, type: 'nested' do
-          indexes :text
-          indexes :author
-        end
-      end
-    end
-
-    # Customize the JSON serialization for Elasticsearch
-    #
-    def as_indexed_json(options={})
-      {
-        title: title,
-        text:  text,
-        categories: categories.map(&:title),
-        authors:    authors.as_json(methods: [:full_name], only: [:full_name, :first_name, :last_name]),
-        comments:   comments.as_json(only: [:text, :author])
-      }
-    end
-
-    # Update document in the index after touch
-    #
-    after_touch() { __elasticsearch__.index_document }
-  end
-end
-
-# Include the search integration
-#
-Post.__send__ :include, Searchable
+require 'active_record'
 
 module Elasticsearch
   module Model
@@ -133,6 +47,93 @@ module Elasticsearch
             end
           end
 
+          # ----- Models definition -------------------------------------------------------------------------
+
+          class Category < ActiveRecord::Base
+            has_and_belongs_to_many :posts
+          end
+
+          class Author < ActiveRecord::Base
+            has_many :authorships
+
+            def full_name
+              [first_name, last_name].compact.join(' ')
+            end
+          end
+
+          class Authorship < ActiveRecord::Base
+            belongs_to :author
+            belongs_to :post, touch: true
+          end
+
+          class Comment < ActiveRecord::Base
+            belongs_to :post, touch: true
+          end
+
+          class Post < ActiveRecord::Base
+            has_and_belongs_to_many :categories, after_add:    [ lambda { |a,c| a.__elasticsearch__.index_document } ],
+                                                 after_remove: [ lambda { |a,c| a.__elasticsearch__.index_document } ]
+            has_many                :authorships
+            has_many                :authors, through: :authorships
+            has_many                :comments
+          end
+
+          # ----- Search integration via Concern module -----------------------------------------------------
+
+          module Searchable
+            extend ActiveSupport::Concern
+
+            included do
+              include Elasticsearch::Model
+              include Elasticsearch::Model::Callbacks
+
+              # Set up the mapping
+              #
+              settings index: { number_of_shards: 1, number_of_replicas: 0 } do
+                mapping do
+                  indexes :title,      analyzer: 'snowball'
+                  indexes :created_at, type: 'date'
+
+                  indexes :authors do
+                    indexes :first_name
+                    indexes :last_name
+                    indexes :full_name, type: 'multi_field' do
+                      indexes :full_name
+                      indexes :raw, analyzer: 'keyword'
+                    end
+                  end
+
+                  indexes :categories, analyzer: 'keyword'
+
+                  indexes :comments, type: 'nested' do
+                    indexes :text
+                    indexes :author
+                  end
+                end
+              end
+
+              # Customize the JSON serialization for Elasticsearch
+              #
+              def as_indexed_json(options={})
+                {
+                  title: title,
+                  text:  text,
+                  categories: categories.map(&:title),
+                  authors:    authors.as_json(methods: [:full_name], only: [:full_name, :first_name, :last_name]),
+                  comments:   comments.as_json(only: [:text, :author])
+                }
+              end
+
+              # Update document in the index after touch
+              #
+              after_touch() { __elasticsearch__.index_document }
+            end
+          end
+
+          # Include the search integration
+          #
+          Post.__send__ :include, Searchable
+
           # ----- Reset the index -----------------------------------------------------------------
 
           Post.delete_all

data/test/integration/active_record_basic_test.rb

@@ -1,23 +1,11 @@
 require 'test_helper'
+require 'active_record'
 
 puts "ActiveRecord #{ActiveRecord::VERSION::STRING}", '-'*80
 
 module Elasticsearch
   module Model
     class ActiveRecordBasicIntegrationTest < Elasticsearch::Test::IntegrationTestCase
-
-      class ::Article < ActiveRecord::Base
-        include Elasticsearch::Model
-        include Elasticsearch::Model::Callbacks
-
-        settings index: { number_of_shards: 1, number_of_replicas: 0 } do
-          mapping do
-            indexes :title,      type: 'string', analyzer: 'snowball'
-            indexes :created_at, type: 'date'
-          end
-        end
-      end
-
       context "ActiveRecord basic integration" do
         setup do
           ActiveRecord::Schema.define(:version => 1) do
@@ -27,6 +15,18 @@ module Elasticsearch
             end
           end
 
+          class ::Article < ActiveRecord::Base
+            include Elasticsearch::Model
+            include Elasticsearch::Model::Callbacks
+
+            settings index: { number_of_shards: 1, number_of_replicas: 0 } do
+              mapping do
+                indexes :title,      type: 'string', analyzer: 'snowball'
+                indexes :created_at, type: 'date'
+              end
+            end
+          end
+
           Article.delete_all
           Article.__elasticsearch__.create_index! force: true
 

data/test/integration/active_record_custom_serialization_test.rb

@@ -1,24 +1,25 @@
 require 'test_helper'
+require 'active_record'
 
 module Elasticsearch
   module Model
     class ActiveRecordCustomSerializationTest < Elasticsearch::Test::IntegrationTestCase
+      context "ActiveRecord model with custom JSON serialization" do
+        setup do
+          class ::ArticleWithCustomSerialization < ActiveRecord::Base
+            include Elasticsearch::Model
+            include Elasticsearch::Model::Callbacks
 
-      class ::ArticleWithCustomSerialization < ActiveRecord::Base
-        include Elasticsearch::Model
-        include Elasticsearch::Model::Callbacks
-
-        mapping do
-          indexes :title
-        end
+            mapping do
+              indexes :title
+            end
 
-        def as_indexed_json(options={})
-          as_json(options.merge root: false).slice('title')
-        end
-      end
+            def as_indexed_json(options={})
+              # as_json(options.merge root: false).slice('title')
+              { title: self.title }
+            end
+          end
 
-      context "ActiveRecord model with custom JSON serialization" do
-        setup do
           ActiveRecord::Schema.define(:version => 1) do
             create_table ArticleWithCustomSerialization.table_name do |t|
               t.string   :title

data/test/integration/active_record_import_test.rb

@@ -1,22 +1,9 @@
 require 'test_helper'
+require 'active_record'
 
 module Elasticsearch
   module Model
     class ActiveRecordImportIntegrationTest < Elasticsearch::Test::IntegrationTestCase
-
-      class ::ImportArticle < ActiveRecord::Base
-        include Elasticsearch::Model
-
-        scope :popular, -> { where('views >= 50') }
-
-        mapping do
-          indexes :title,      type: 'string'
-          indexes :views,      type: 'integer'
-          indexes :numeric,    type: 'integer'
-          indexes :created_at, type: 'date'
-        end
-      end
-
       context "ActiveRecord importing" do
         setup do
           ActiveRecord::Schema.define(:version => 1) do
@@ -28,6 +15,19 @@ module Elasticsearch
             end
           end
 
+          class ::ImportArticle < ActiveRecord::Base
+            include Elasticsearch::Model
+
+            scope :popular, -> { where('views >= 50') }
+
+            mapping do
+              indexes :title,      type: 'string'
+              indexes :views,      type: 'integer'
+              indexes :numeric,    type: 'integer'
+              indexes :created_at, type: 'date'
+            end
+          end
+
           ImportArticle.delete_all
           ImportArticle.__elasticsearch__.create_index! force: true
           ImportArticle.__elasticsearch__.client.cluster.health wait_for_status: 'yellow'

data/test/integration/active_record_namespaced_model_test.rb

@@ -1,18 +1,9 @@
 require 'test_helper'
+require 'active_record'
 
 module Elasticsearch
   module Model
     class ActiveRecordNamespacedModelIntegrationTest < Elasticsearch::Test::IntegrationTestCase
-
-      module ::MyNamespace
-        class Article < ActiveRecord::Base
-          include Elasticsearch::Model
-          include Elasticsearch::Model::Callbacks
-
-          mapping { indexes :title }
-        end
-      end
-
       context "Namespaced ActiveRecord model integration" do
         setup do
           ActiveRecord::Schema.define(:version => 1) do
@@ -21,6 +12,15 @@ module Elasticsearch
             end
           end
 
+          module ::MyNamespace
+            class Article < ActiveRecord::Base
+              include Elasticsearch::Model
+              include Elasticsearch::Model::Callbacks
+
+              mapping { indexes :title }
+            end
+          end
+
           MyNamespace::Article.delete_all
           MyNamespace::Article.__elasticsearch__.create_index! force: true
 

data/test/integration/active_record_pagination_test.rb

@@ -1,26 +1,24 @@
 require 'test_helper'
+require 'active_record'
 
 module Elasticsearch
   module Model
     class ActiveRecordPaginationTest < Elasticsearch::Test::IntegrationTestCase
+      context "ActiveRecord pagination" do
+        setup do
+          class ::ArticleForPagination < ActiveRecord::Base
+            include Elasticsearch::Model
 
-      class ::ArticleForPagination < ActiveRecord::Base
-        include Elasticsearch::Model
-
-        scope :published, -> { where(published: true) }
+            scope :published, -> { where(published: true) }
 
-        settings index: { number_of_shards: 1, number_of_replicas: 0 } do
-          mapping do
-            indexes :title,      type: 'string', analyzer: 'snowball'
-            indexes :created_at, type: 'date'
+            settings index: { number_of_shards: 1, number_of_replicas: 0 } do
+              mapping do
+                indexes :title,      type: 'string', analyzer: 'snowball'
+                indexes :created_at, type: 'date'
+              end
+            end
           end
-        end
-      end
-
-      Kaminari::Hooks.init
 
-      context "ActiveRecord pagination" do
-        setup do
           ActiveRecord::Schema.define(:version => 1) do
             create_table ::ArticleForPagination.table_name do |t|
               t.string   :title
@@ -29,6 +27,8 @@ module Elasticsearch
             end
           end
 
+          Kaminari::Hooks.init
+
           ArticleForPagination.delete_all
           ArticleForPagination.__elasticsearch__.create_index! force: true
 

data/test/test_helper.rb

@@ -10,15 +10,21 @@ at_exit { Elasticsearch::Test::IntegrationTestCase.__run_at_exit_hooks }
 
 puts '-'*80
 
-require 'test/unit'
+if defined?(RUBY_VERSION) && RUBY_VERSION > '2.2'
+  require 'test-unit'
+  require 'mocha/test_unit'
+else
+  require 'minitest/autorun'
+  require 'mocha/mini_test'
+end
+
 require 'shoulda-context'
-require 'mocha/setup'
-require 'turn' unless ENV["TM_FILEPATH"] || ENV["NOTURN"] || RUBY_1_8
+
+require 'turn' unless ENV["TM_FILEPATH"] || ENV["NOTURN"] || defined?(RUBY_VERSION) && RUBY_VERSION > '2.2'
 
 require 'ansi'
 require 'oj'
 
-require 'active_record'
 require 'active_model'
 
 require 'kaminari'
@@ -40,7 +46,7 @@ module Elasticsearch
       def setup
         ActiveRecord::Base.establish_connection( :adapter => 'sqlite3', :database => ":memory:" )
         logger = ::Logger.new(STDERR)
-        logger.formatter = lambda { |s, d, p, m| "#{m.ansi(:faint, :cyan)}\n" }
+        logger.formatter = lambda { |s, d, p, m| "\e[2;36m#{m}\e[0m\n" }
         ActiveRecord::Base.logger = logger unless ENV['QUIET']
 
         ActiveRecord::LogSubscriber.colorize_logging = false

data/test/unit/adapter_active_record_test.rb

@@ -104,6 +104,23 @@ class Elasticsearch::Model::AdapterActiveRecordTest < Test::Unit::TestCase
         DummyClassForActiveRecord.__find_in_batches(scope: :published) do; end
       end
 
+      should "preprocess the batch if option provided" do
+        class << DummyClassForActiveRecord
+          # Updates/transforms the batch while fetching it from the database
+          # (eg. with information from an external system)
+          #
+          def update_batch(batch)
+            batch.collect { |b| b.to_s + '!' }
+          end
+        end
+
+        DummyClassForActiveRecord.expects(:__find_in_batches).returns( [:a, :b] )
+
+        DummyClassForActiveRecord.__find_in_batches(preprocess: :update_batch) do |batch|
+          assert_same_elements ["a!", "b!"], batch
+        end
+      end
+
       context "when transforming models" do
         setup do
           @transform = DummyClassForActiveRecord.__transform

data/test/unit/callbacks_test.rb

@@ -22,6 +22,7 @@ class Elasticsearch::Model::CallbacksTest < Test::Unit::TestCase
       ::DummyCallbacksModel.expects(:__send__).with do |method, parameter|
         assert_equal :include, method
         assert_equal DummyCallbacksAdapter::CallbacksMixin, parameter
+        true
       end
 
       Elasticsearch::Model::Callbacks.included(DummyCallbacksModel)

data/test/unit/importing_test.rb

@@ -48,7 +48,7 @@ class Elasticsearch::Model::ImportingTest < Test::Unit::TestCase
       assert_equal 0, DummyImportingModel.import
     end
 
-    should "return number of errors" do
+    should "return the number of errors" do
       Elasticsearch::Model::Adapter.expects(:from_class)
                                    .with(DummyImportingModel)
                                    .returns(DummyImportingAdapter)
@@ -66,6 +66,24 @@ class Elasticsearch::Model::ImportingTest < Test::Unit::TestCase
       assert_equal 1, DummyImportingModel.import
     end
 
+    should "return an array of error elements" do
+      Elasticsearch::Model::Adapter.expects(:from_class)
+                                   .with(DummyImportingModel)
+                                   .returns(DummyImportingAdapter)
+
+      DummyImportingModel.__send__ :include, Elasticsearch::Model::Importing
+
+      client = mock('client')
+      client.expects(:bulk).returns({'items' => [ {'index' => {}}, {'index' => {'error' => 'FAILED'}} ]})
+
+      DummyImportingModel.stubs(:client).returns(client)
+      DummyImportingModel.stubs(:index_name).returns('foo')
+      DummyImportingModel.stubs(:document_type).returns('foo')
+      DummyImportingModel.stubs(:__batch_to_bulk)
+
+      assert_equal [{'index' => {'error' => 'FAILED'}}], DummyImportingModel.import(return: 'errors')
+    end
+
     should "yield the response" do
       Elasticsearch::Model::Adapter.expects(:from_class)
                                    .with(DummyImportingModel)
@@ -90,10 +108,12 @@ class Elasticsearch::Model::ImportingTest < Test::Unit::TestCase
       DummyImportingModel.expects(:__find_in_batches).with do |options|
         assert_equal 'bar', options[:foo]
         assert_nil   options[:force]
+        true
       end
 
       DummyImportingModel.expects(:create_index!).with do |options|
         assert_equal true, options[:force]
+        true
       end
 
       DummyImportingModel.expects(:index_name).returns('foo')

data/test/unit/indexing_test.rb

@@ -164,6 +164,7 @@ class Elasticsearch::Model::IndexingTest < Test::Unit::TestCase
         instance.expects(:instance_variable_set).with do |name, value|
           assert_equal :@__changed_attributes, name
           assert_equal({foo: 'Two'}, value)
+          true
         end
 
         ::DummyIndexingModelWithCallbacks.__send__ :include, Elasticsearch::Model::Indexing::InstanceMethods
@@ -182,6 +183,7 @@ class Elasticsearch::Model::IndexingTest < Test::Unit::TestCase
           assert_equal 'bar',  payload[:type]
           assert_equal '1',    payload[:id]
           assert_equal 'JSON', payload[:body]
+          true
         end
 
         instance.expects(:client).returns(client)
@@ -199,6 +201,7 @@ class Elasticsearch::Model::IndexingTest < Test::Unit::TestCase
 
         client.expects(:index).with do |payload|
           assert_equal 'A',  payload[:parent]
+          true
         end
 
         instance.expects(:client).returns(client)
@@ -218,6 +221,7 @@ class Elasticsearch::Model::IndexingTest < Test::Unit::TestCase
           assert_equal 'foo',  payload[:index]
           assert_equal 'bar',  payload[:type]
           assert_equal '1',    payload[:id]
+          true
         end
 
         instance.expects(:client).returns(client)
@@ -234,6 +238,7 @@ class Elasticsearch::Model::IndexingTest < Test::Unit::TestCase
 
         client.expects(:delete).with do |payload|
           assert_equal 'A',  payload[:parent]
+          true
         end
 
         instance.expects(:client).returns(client)
@@ -267,6 +272,7 @@ class Elasticsearch::Model::IndexingTest < Test::Unit::TestCase
           assert_equal 'bar',  payload[:type]
           assert_equal '1',    payload[:id]
           assert_equal({foo: 'bar'}, payload[:body][:doc])
+          true
         end
 
         instance.expects(:client).returns(client)
@@ -282,10 +288,32 @@ class Elasticsearch::Model::IndexingTest < Test::Unit::TestCase
         instance = ::DummyIndexingModelWithCallbacksAndCustomAsIndexedJson.new
 
         # Set the fake `changes` hash
-        instance.instance_variable_set(:@__changed_attributes, {foo: 'B', bar: 'D' })
+        instance.instance_variable_set(:@__changed_attributes, {'foo' => 'B', 'bar' => 'D' })
 
         client.expects(:update).with do |payload|
-          assert_equal({foo: 'B'}, payload[:body][:doc])
+          assert_equal({:foo => 'B'}, payload[:body][:doc])
+          true
+        end
+
+        instance.expects(:client).returns(client)
+        instance.expects(:index_name).returns('foo')
+        instance.expects(:document_type).returns('bar')
+        instance.expects(:id).returns('1')
+
+        instance.update_document
+      end
+
+      should "get attributes from as_indexed_json during partial update" do
+        client   = mock('client')
+        instance = ::DummyIndexingModelWithCallbacksAndCustomAsIndexedJson.new
+
+        instance.instance_variable_set(:@__changed_attributes, { 'foo' => { 'bar' => 'BAR'} })
+        # Overload as_indexed_json
+        instance.expects(:as_indexed_json).returns({ 'foo' => 'BAR' })
+
+        client.expects(:update).with do |payload|
+          assert_equal({'foo' => 'BAR'}, payload[:body][:doc])
+          true
         end
 
         instance.expects(:client).returns(client)
@@ -336,6 +364,7 @@ class Elasticsearch::Model::IndexingTest < Test::Unit::TestCase
           assert_equal 'dummy_indexing_model_for_recreates', payload[:index]
           assert_equal 1,         payload[:body][:settings][:index][:number_of_shards]
           assert_equal 'keyword', payload[:body][:mappings][:dummy_indexing_model_for_recreate][:properties][:foo][:analyzer]
+          true
         end.returns({})
 
         DummyIndexingModelForRecreate.expects(:client).returns(client).at_least_once
@@ -414,10 +443,12 @@ class Elasticsearch::Model::IndexingTest < Test::Unit::TestCase
         should "create the custom index" do
           @indices.expects(:exists).with do |arguments|
             assert_equal 'custom-foo', arguments[:index]
+            true
           end
 
           @indices.expects(:create).with do |arguments|
             assert_equal 'custom-foo', arguments[:index]
+            true
           end
 
           DummyIndexingModelForRecreate.create_index! index: 'custom-foo'
@@ -426,6 +457,7 @@ class Elasticsearch::Model::IndexingTest < Test::Unit::TestCase
         should "delete the custom index" do
           @indices.expects(:delete).with do |arguments|
             assert_equal 'custom-foo', arguments[:index]
+            true
           end
 
           DummyIndexingModelForRecreate.delete_index! index: 'custom-foo'
@@ -434,6 +466,7 @@ class Elasticsearch::Model::IndexingTest < Test::Unit::TestCase
         should "refresh the custom index" do
           @indices.expects(:refresh).with do |arguments|
             assert_equal 'custom-foo', arguments[:index]
+            true
           end
 
           DummyIndexingModelForRecreate.refresh_index! index: 'custom-foo'

data/test/unit/proxy_test.rb

@@ -48,6 +48,7 @@ class Elasticsearch::Model::SearchTest < Test::Unit::TestCase
       instance.__elasticsearch__.expects(:instance_variable_set).with do |name, value|
         assert_equal :@__changed_attributes, name
         assert_equal({foo: 'Two'}, value)
+        true
       end
 
       ::DummyProxyModelWithCallbacks.__send__ :include, Elasticsearch::Model::Proxy

data/test/unit/response_pagination_kaminari_test.rb

@@ -34,6 +34,7 @@ class Elasticsearch::Model::ResponsePaginationKaminariTest < Test::Unit::TestCas
             .with do |definition|
               assert_equal 25, definition[:from]
               assert_equal 25, definition[:size]
+              true
             end
           .returns(RESPONSE)
 
@@ -51,6 +52,7 @@ class Elasticsearch::Model::ResponsePaginationKaminariTest < Test::Unit::TestCas
             .with do |definition|
               assert_equal 75, definition[:from]
               assert_equal 25, definition[:size]
+              true
             end
           .returns(RESPONSE)
 

data/test/unit/response_pagination_will_paginate_test.rb

@@ -30,8 +30,10 @@ class Elasticsearch::Model::ResponsePaginationWillPaginateTest < Test::Unit::Tes
       @expected_methods = [
         # methods needed by WillPaginate::CollectionMethods
         :current_page,
+        :offset,
         :per_page,
         :total_entries,
+        :length,
 
         # methods defined by WillPaginate::CollectionMethods
         :total_pages,
@@ -66,6 +68,19 @@ class Elasticsearch::Model::ResponsePaginationWillPaginateTest < Test::Unit::Tes
       end
     end
 
+    context "#offset method" do
+      should "calculate offset using current_page and per_page" do
+        @response.per_page(3).page(3)
+        assert_equal 6, @response.offset
+      end
+    end
+    context "#length method" do
+      should "return count of paginated results" do
+        @response.per_page(3).page(3)
+        assert_equal 3, @response.length
+      end
+    end
+
     context "#paginate method" do
       should "set from/size using defaults" do
         @response.klass.client
@@ -73,6 +88,7 @@ class Elasticsearch::Model::ResponsePaginationWillPaginateTest < Test::Unit::Tes
             .with do |definition|
               assert_equal 0, definition[:from]
               assert_equal 33, definition[:size]
+              true
             end
           .returns(RESPONSE)
 
@@ -90,6 +106,7 @@ class Elasticsearch::Model::ResponsePaginationWillPaginateTest < Test::Unit::Tes
             .with do |definition|
               assert_equal 33, definition[:from]
               assert_equal 33, definition[:size]
+              true
             end
           .returns(RESPONSE)
 
@@ -107,6 +124,7 @@ class Elasticsearch::Model::ResponsePaginationWillPaginateTest < Test::Unit::Tes
             .with do |definition|
               assert_equal 18, definition[:from]
               assert_equal 9, definition[:size]
+              true
             end
           .returns(RESPONSE)
 
@@ -118,12 +136,13 @@ class Elasticsearch::Model::ResponsePaginationWillPaginateTest < Test::Unit::Tes
         assert_equal 9, @response.search.definition[:size]
       end
 
-      should "searches for page 1 if specified page is < 1" do
+      should "search for first page if specified page is < 1" do
         @response.klass.client
           .expects(:search)
             .with do |definition|
               assert_equal 0, definition[:from]
               assert_equal 33, definition[:size]
+              true
             end
           .returns(RESPONSE)
 

data/test/unit/searching_search_request_test.rb

@@ -18,6 +18,7 @@ class Elasticsearch::Model::SearchRequestTest < Test::Unit::TestCase
     should "pass the search definition as a simple query" do
       @client.expects(:search).with do |params|
         assert_equal 'foo', params[:q]
+        true
       end
       .returns({})
 
@@ -28,6 +29,7 @@ class Elasticsearch::Model::SearchRequestTest < Test::Unit::TestCase
     should "pass the search definition as a Hash" do
       @client.expects(:search).with do |params|
         assert_equal( {foo: 'bar'}, params[:body] )
+        true
       end
       .returns({})
 
@@ -38,6 +40,7 @@ class Elasticsearch::Model::SearchRequestTest < Test::Unit::TestCase
     should "pass the search definition as a JSON string" do
       @client.expects(:search).with do |params|
         assert_equal( '{"foo":"bar"}', params[:body] )
+        true
       end
       .returns({})
 
@@ -52,6 +55,7 @@ class Elasticsearch::Model::SearchRequestTest < Test::Unit::TestCase
 
       @client.expects(:search).with do |params|
         assert_equal( {foo: 'bar'}, params[:body] )
+        true
       end
       .returns({})
 
@@ -63,6 +67,7 @@ class Elasticsearch::Model::SearchRequestTest < Test::Unit::TestCase
       @client.expects(:search).with do |params|
         assert_equal 'foo', params[:q]
         assert_equal 15,    params[:size]
+        true
       end
       .returns({})
 

data/test/unit/searching_test.rb

@@ -24,6 +24,7 @@ class Elasticsearch::Model::SearchingTest < Test::Unit::TestCase
           assert_equal DummySearchingModel, klass
           assert_equal 'foo', query
           assert_equal({default_operator: 'AND'}, options)
+          true
         end
         .returns( stub('search') )
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-model
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Karel Minarik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-18 00:00:00.000000000 Z
+date: 2014-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: elasticsearch
@@ -122,20 +122,6 @@ dependencies:
     - - ! '>'
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>'
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>'
-      - !ruby/object:Gem::Version
-        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +170,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: shoulda-context
   requirement: !ruby/object:Gem::Requirement
@@ -280,16 +266,16 @@ dependencies:
   name: ci_reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -332,20 +318,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 description: ActiveModel/Record integrations for Elasticsearch.
 email:
 - karel.minarik@elasticsearch.org