chewy 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 618e32a755ee2b5035e4640b4a7969e76492689f
-  data.tar.gz: 420d6db94ffd55a322246a27e3537467c334782d
+  metadata.gz: 37f0fefa72376c597d5ad48d1d6796371f15f809
+  data.tar.gz: 9f5400688fbdbd4e84022645c40aeeb9cafc665b
 SHA512:
-  metadata.gz: 9db80b8a18cfc60735822fcd5b9c6e761221a8c485e04fb23088c1cdf4f83f43090a7b211949656eb9c989cf0b3832852b87cde3aa8d888558db157a1e38edc6
-  data.tar.gz: be4cb7e42fd04ec7607d9ad9e12dc1cbd664fd004b046b2a756e584760c3a488bf296563ecad006288e45557027db1f2b588d27db45d721e2f70391e9b0ef988
+  metadata.gz: 076944d46b1082021ad1966e4be3543e1ac0a71a559e7013bd6f95879446ba5810fe7304af7b4b4c05775ebbfcbe2f9df5954d4a287411f3bceeb86621fac6fa
+  data.tar.gz: b5b8ee2719b6d19c478d5ec9e7551340f83e7aeb71de2757dbea33781995ddb82f54b9fab98e006200f8c7344f36fbd79aa556eda5ec11b84506d9a1283005d1

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # master
 
-# Version 0.2.1
+# Version 0.2.3
+
+  * `.import!` indexes method, raises import errors.
+
+  * `.import!` types method, raises import errors. Useful for specs.
+
+# Version 0.2.2
 
   * Auto-resolved analyzers and analyzers repository:
 

data/lib/chewy/config.rb

@@ -12,11 +12,11 @@ module Chewy
     def self.repository name
       plural_name = name.to_s.pluralize
 
-      class_eval <<-EOS
+      class_eval <<-METHOD, __FILE__, __LINE__ + 1
         def #{name}(name, options = nil)
           options ? #{plural_name}[name.to_sym] = options : #{plural_name}[name.to_sym]
         end
-      EOS
+      METHOD
     end
 
     def initialize

data/lib/chewy/errors.rb

@@ -10,4 +10,18 @@ module Chewy
 
   class UnderivableType < Error
   end
+
+  class FailedImport < Error
+    def initialize type, errors
+      output = "Import failed for `#{type}` with:\n"
+      errors.each do |action, errors|
+        output << "    #{action.to_s.humanize} errors:\n"
+        errors.each do |error, documents|
+          output << "      `#{error}`\n"
+          output << "        on #{documents.count} documents: #{documents}\n"
+        end
+      end
+      super output
+    end
+  end
 end

data/lib/chewy/index.rb

@@ -80,11 +80,11 @@ module Chewy
       type_class = Chewy::Type.new(self, target, options, &block)
       self.type_hash = type_hash.merge(type_class.type_name => type_class)
 
-      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+      class_eval <<-METHOD, __FILE__, __LINE__ + 1
         def self.#{type_class.type_name}
           type_hash['#{type_class.type_name}']
         end
-      RUBY
+      METHOD
     end
 
     # Types method has double usage.

data/lib/chewy/index/actions.rb

@@ -117,17 +117,22 @@ module Chewy
 
         # Perform import operation for every defined type
         #
-        #   UsersIndex.import
-        #   UsersIndex.import refresh: false # to disable index refreshing after import
-        #   UsersIndex.import suffix: Time.now.to_i # imports data to index with specified suffix if such is exists
-        #   UsersIndex.import batch_size: 300 # import batch size
-        #
-        def import options = {}
-          objects = options.extract!(*type_names.map(&:to_sym))
-          types.map do |type|
-            args = [objects[type.type_name.to_sym], options.dup].reject(&:blank?)
-            type.import *args
-          end.all?
+        #   UsersIndex.import                           # imports default data for every index type
+        #   UsersIndex.import user: User.active         # imports specified objects for user type and default data for other types
+        #   UsersIndex.import refresh: false            # to disable index refreshing after import
+        #   UsersIndex.import suffix: Time.now.to_i     # imports data to index with specified suffix if such is exists
+        #   UsersIndex.import batch_size: 300           # import batch size
+        #
+        [:import, :import!].each do |method|
+          class_eval <<-METHOD, __FILE__, __LINE__ + 1
+            def #{method} options = {}
+              objects = options.extract!(*type_names.map(&:to_sym))
+              types.map do |type|
+                args = [objects[type.type_name.to_sym], options.dup].reject(&:blank?)
+                type.#{method} *args
+              end.all?
+            end
+          METHOD
         end
 
         # Deletes, creates and imports data to the index.

data/lib/chewy/query/pagination.rb

@@ -15,11 +15,11 @@ module Chewy
 
           delegate :default_per_page, :max_per_page, :max_pages, to: :_kaminari_config
 
-          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          class_eval <<-METHOD, __FILE__, __LINE__ + 1
             def #{::Kaminari.config.page_method_name}(num = 1)
               limit(limit_value).offset(limit_value * ([num.to_i, 1].max - 1))
             end
-          RUBY
+          METHOD
         end
 
         def total_count

data/lib/chewy/type/import.rb

@@ -4,13 +4,17 @@ module Chewy
       extend ActiveSupport::Concern
 
       module ClassMethods
-        def bulk options = {}
-          suffix = options.delete(:suffix)
-          result = client.bulk options.merge(index: index.build_index_name(suffix: suffix), type: type_name)
-
-          extract_errors result
-        end
-
+        # Perform import operation for specified documents.
+        # Returns true or false depending on success.
+        #
+        #   UsersIndex::User.import                          # imports default data set
+        #   UsersIndex::User.import User.active              # imports active users
+        #   UsersIndex::User.import [1, 2, 3]                # imports users with specified ids
+        #   UsersIndex::User.import users                    # imports users collection
+        #   UsersIndex::User.import refresh: false           # to disable index refreshing after import
+        #   UsersIndex::User.import suffix: Time.now.to_i    # imports data to index with specified suffix if such is exists
+        #   UsersIndex::User.import batch_size: 300          # import batch size
+        #
         def import *args
           import_options = args.extract_options!
           bulk_options = import_options.extract!(:refresh, :suffix).reverse_merge!(refresh: true)
@@ -27,21 +31,39 @@ module Chewy
           end
         end
 
-      private
+        # Perform import operation for specified documents.
+        # Raises Chewy::FailedImport exception in case of import errors.
+        #
+        #   UsersIndex::User.import!                          # imports default data set
+        #   UsersIndex::User.import! User.active              # imports active users
+        #   UsersIndex::User.import! [1, 2, 3]                # imports users with specified ids
+        #   UsersIndex::User.import! users                    # imports users collection
+        #   UsersIndex::User.import! refresh: false           # to disable index refreshing after import
+        #   UsersIndex::User.import! suffix: Time.now.to_i    # imports data to index with specified suffix if such is exists
+        #   UsersIndex::User.import! batch_size: 300          # import batch size
+        #
+        def import! *args
+          errors = nil
+          subscriber = ActiveSupport::Notifications.subscribe('import_objects.chewy') do |*args|
+            errors = args.last[:errors]
+          end
+          import *args
+          ActiveSupport::Notifications.unsubscribe(subscriber)
+          raise Chewy::FailedImport.new(self, errors) if errors.present?
+          true
+        end
 
-        def extract_errors result
-          result && result['items'].map do |item|
-            action = item.keys.first.to_sym
-            data = item.values.first
-            {action: action, id: data['_id'], error: data['error']} if data['error']
-          end.compact.group_by { |item| item[:action] }.map do |action, items|
-            errors = items.group_by { |item| item[:error] }.map do |error, items|
-              {error => items.map { |item| item[:id] }}
-            end.reduce(&:merge)
-            {action => errors}
-          end.reduce(&:merge) || {}
+        # Wraps elasticsearch-ruby client indices bulk method.
+        # Adds `:suffix` option to bulk import to index with specified suffix.
+        def bulk options = {}
+          suffix = options.delete(:suffix)
+          result = client.bulk options.merge(index: index.build_index_name(suffix: suffix), type: type_name)
+
+          extract_errors result
         end
 
+      private
+
         def bulk_body action_objects
           action_objects.each.with_object([]) do |(action, objects), result|
             result.concat(if action == :delete
@@ -75,6 +97,19 @@ module Chewy
         def object_data object
           (self.root_object ||= build_root).compose(object)[type_name.to_sym]
         end
+
+        def extract_errors result
+          result && result['items'].map do |item|
+            action = item.keys.first.to_sym
+            data = item.values.first
+            {action: action, id: data['_id'], error: data['error']} if data['error']
+          end.compact.group_by { |item| item[:action] }.map do |action, items|
+            errors = items.group_by { |item| item[:error] }.map do |error, items|
+              {error => items.map { |item| item[:id] }}
+            end.reduce(&:merge)
+            {action => errors}
+          end.reduce(&:merge) || {}
+        end
       end
     end
   end

data/lib/chewy/version.rb

@@ -1,3 +1,3 @@
 module Chewy
-  VERSION = '0.2.2'
+  VERSION = '0.2.4'
 end

data/spec/chewy/index/actions_spec.rb

@@ -267,6 +267,54 @@ describe Chewy::Index::Actions do
     end
   end
 
+  describe '.import' do
+    before do
+      stub_model(:city)
+      stub_index(:cities) do
+        define_type City
+      end
+    end
+    let!(:dummy_cities) { 3.times.map { |i| City.create(name: "name#{i}") } }
+
+    specify { CitiesIndex.import.should == true }
+
+    context do
+      before do
+        stub_index(:cities) do
+          define_type City do
+            field :name, type: 'object'
+          end
+        end.tap(&:create!)
+      end
+
+      specify { CitiesIndex.import(city: dummy_cities).should == false }
+    end
+  end
+
+  describe '.import!' do
+    before do
+      stub_model(:city)
+      stub_index(:cities) do
+        define_type City
+      end
+    end
+    let!(:dummy_cities) { 3.times.map { |i| City.create(name: "name#{i}") } }
+
+    specify { CitiesIndex.import!.should == true }
+
+    context do
+      before do
+        stub_index(:cities) do
+          define_type City do
+            field :name, type: 'object'
+          end
+        end.tap(&:create!)
+      end
+
+      specify { expect { CitiesIndex.import!(city: dummy_cities) }.to raise_error Chewy::FailedImport }
+    end
+  end
+
   describe '.reset!' do
     before do
       stub_model(:city)

data/spec/chewy/type/import_spec.rb

@@ -20,10 +20,6 @@ describe Chewy::Type::Import do
   let!(:dummy_cities) { 3.times.map { |i| City.create(name: "name#{i}") } }
   let(:city) { CitiesIndex::City }
 
-  describe '.bulk' do
-
-  end
-
   describe '.import' do
     specify { city.import.should be_true }
     specify { city.import([]).should be_true }
@@ -179,4 +175,20 @@ describe Chewy::Type::Import do
       end
     end
   end
+
+  describe '.import!' do
+    specify { expect { city.import!.should }.not_to raise_error }
+
+    context do
+      before do
+        stub_index(:cities) do
+          define_type City do
+            field :name, type: 'object'
+          end
+        end.tap(&:create!)
+      end
+
+      specify { expect { city.import!(dummy_cities) }.to raise_error Chewy::FailedImport }
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chewy
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - pyromaniac
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-26 00:00:00.000000000 Z
+date: 2014-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake