active_merge 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9908a773d23bf5b0b67850538549bf130646b257
-  data.tar.gz: e61c2879ca3ff6a256ac575651c69432b97c3c15
+  metadata.gz: 3a852fec8deb9d07be3fc9c377d1094a12a3574c
+  data.tar.gz: 9dc95d04b550e50ffbf1250c11ee578a35c60729
 SHA512:
-  metadata.gz: d189fc4e6e22e3806c1bcf7350130718c4e85170c6d9b51924a7b206cbbdbec9ecae588d339a36bec6fc2650b7a75d3883d51d718663159226b94e7cae6b4511
-  data.tar.gz: eccd6bbd86184af049cb31f3229b4c575ab9ba478c7b0b4a7e3ba97af443ec62467424761f25f8e5bd89ea9c3446dc000f3f73b789a787a1c16d13eb961fd1ac
+  metadata.gz: 2c57dcfd9df06c76630812169fc38e815b059b33e23b6f9c623eb3324469177ed4f41384ac5eda12ed199e82770b5a4f0bbbcb3c55d239b7b946e6e364edfaf7
+  data.tar.gz: 5a606c8a1aa4ade555780ecad0dee9e303ae76b3a05c118ce42150b4b8d46485ab82009aa3762d52380110772d6d6fca16828db7380e8b9e4177a803a63d1c65

data/README.rdoc

@@ -7,14 +7,17 @@
 
 Declares the <tt>ActiveMerge</tt> module for extending ActiveRecord models.
 
+== Main usage
+
 The module contains the <tt>merge_all</tt> class method for merging
 class instances into the first one.
 
 When merging a list of instances:
+
 * all "has_many" relatives are reattached to the instance with the lowest id
 * all the instances except for the first one (with the lowest id) are deleted
 
-== Example
+=== Example
 
     class Post < ActiveRecord
       extend ActiveMerge
@@ -26,6 +29,23 @@ When merging a list of instances:
     # The other posts will be deleted after their comment are reattached
     # to the first post.
 
+== Skipping validations and callbacks
+
+You can use the <tt>validate: false</tt> option.
+
+With this option set any activerecord validation and callback are skipped.
+
+    Post.all.merge_all validate: false
+
+**Warning**
+
+Only activerecord validations and callbacks are skipped! Raising other errors
+(by database etc.) will cause all changes to roll back as before.
+
+== Version changes
+
+See the CHANGELOG[link:CHANGELOG.rdoc].
+
 == License
 
-This project rocks and uses MIT-LICENSE[link:LICENSE].
+This project rocks and uses MIT LICENSE[link:LICENSE].

data/lib/active_merge/service.rb

@@ -48,7 +48,7 @@ module ActiveMerge
   #     5.times.each{ scotland.shires.create! }
   #
   #     # Lets merge all the kingdoms:
-  #     Service.new(Kingdom.all).submit!
+  #     Service.new(Kingdom.all).provide
   #
   #     # Now union Britain (because it is Britain that was created first) 
   #     # has all those 15 shires and 130 thousand men
@@ -61,8 +61,8 @@ module ActiveMerge
   #
   # == Warning!
   #
-  # The merge provided as a whole transaction. In case any error occures, all
-  # the changes rolled back.
+  # The merge provided as a whole transaction. In case of any error, all
+  # changes roll back.
   #
   # Let (see the example above) the shire cannot be rebount to another kingdom:
   #
@@ -70,10 +70,16 @@ module ActiveMerge
   #       attr_readonly :kingdom_id
   #     end
   #
-  # then merging won't be finished.
+  # In this case the merge won't be finished. Not only shires, but also 
+  # scots remain living in their old good Scotland!
   #
-  # Not only shires, but also the scots remain living in their Scotland,
-  # not in the United Kingdom!
+  # == Skipping activerecord validations
+  #
+  # You can use the <tt>validate: false</tt> option.
+  #
+  # With this option set any activerecord validation and callback are skipped.
+  #
+  #     Service.new(Kingdom.all).provide validate: false
   #
   class Service < ActivePatterns::BaseService
     include ActiveModel::Validations
@@ -87,11 +93,11 @@ module ActiveMerge
     validates   :items, presence: true
 
     # Merges all the #items to the #item as a whole transaction
-    def provide
+    def provide(options = {})
       transaction do
         items.each do |item|
           service = SimpleService.new(self.item, item)
-          change(service) { service.provide }
+          change(service) { service.provide(options) }
         end
       end
     end

data/lib/active_merge/simple_service.rb

@@ -27,10 +27,10 @@ module ActiveMerge
 
     validates :second, presence: true
 
-    def provide
+    def provide(options = {})
       transaction do
-        Links.new(second).each { |item, key| rebind(item, key) }
-        change(second) { second.destroy! }
+        Links.new(second).each { |item, key| rebind(item, key, options) }
+        remove(options)
       end
     end
 
@@ -63,11 +63,16 @@ module ActiveMerge
         end
       end
 
+      # Deletes or destroys second object
+      def remove(validate: true)
+        change(second) { validate ? second.destroy! : second.delete }
+      end
+
       # Re-assigns given object to the #first
-      def rebind(item, key)
+      def rebind(item, key, options)
         change item do
           item.send key, first.id
-          item.save!
+          item.save! options
         end
       end
   end

data/lib/active_merge/version.rb

@@ -1,3 +1,3 @@
 module ActiveMerge
-  VERSION = "1.0.5"
+  VERSION = "1.1.0"
 end

data/lib/active_merge.rb

@@ -20,9 +20,15 @@ module ActiveMerge
   #     Lord.all.merge_all              # => merges all the class instances
   #     Lord.where("id > :id", id: 100) # => merges instances with id > 100
   #
+  # You can use the <tt>validate: false</tt> option.
+  #
+  # With this option set any activerecord validation and callback are skipped.
+  #
+  #     Post.all.merge_all validate: false
+  #
   # See details in <tt>ActiveMerge::Service#provide</tt> documentation.
   #
-  def merge_all
-    ActiveMerge::Service.new(all).provide
+  def merge_all(options = {})
+    ActiveMerge::Service.new(all).provide(options)
   end
 end

data/spec/active_merge/service_spec.rb

@@ -146,58 +146,184 @@ module ActiveMerge
       let!(:domains) { lords.map{ |lord| lord.domains.create! }}
       let!(:men)     { lords.map{ |lord| lord.men.create! }}
       let!(:service) { Service.new lords }
+      
+      context "if :validate option isn't set" do
 
-      context "если перепривязка разрешена" do
+        context "and no exceptions raised:" do
 
-        it "не вызывает исключений" do
-          expect{ service.provide }.not_to raise_error
+          it "merges the objects" do
+            service.provide
+            Lord.count.should eq 1
+            Lord.first.domains.count.should eq 2
+            Lord.first.men.count.should eq 2
+          end
+        end
+
+        context "and the service's own validation returns false:" do
+
+          before { service.stub(:valid?).and_return false }
+
+          it "raises an exception" do
+            expect{ service.provide }.to raise_error
+          end
+
+          it "doesn't make any change to db" do
+            expect{ begin; service.provide; rescue; end }.not_to change{ Lord.all.to_a }
+            expect{ begin; service.provide; rescue; end }.not_to change{ Domain.all.to_a }
+            expect{ begin; service.provide; rescue; end }.not_to change{ Man.all.to_a }
+          end
+        end
+
+        context "and a validation returns false when rebinding a link:" do
+
+          before do
+            Man.any_instance.stub(:valid?).and_return false
+            Man.any_instance.stub(:errors).and_return({ base: "record_invalid" })
+          end
+
+          it "raises an exception" do
+            expect{ service.provide }.to raise_error
+          end
+
+          it "doesn't make any change to db" do
+            expect{ begin; service.provide; rescue; end }.not_to change{ Lord.all.to_a }
+            expect{ begin; service.provide; rescue; end }.not_to change{ Domain.all.to_a }
+            expect{ begin; service.provide; rescue; end }.not_to change{ Man.all.to_a }
+          end
+
+          it "adds corresponding errors to the #errors" do
+            begin; service.provide; rescue; end
+            service.errors.should_not be_blank
+          end
         end
 
-        it "объединяет записи" do
-          begin; service.provide; rescue; end
-          Lord.count.should eq 1
-          Lord.first.domains.count.should eq 2
-          Lord.first.men.count.should eq 2
+        context "and a callback returns false when destroying an object:" do
+
+          before do
+            Lord.before_destroy(){ false }
+            Lord.any_instance.stub(:errors).and_return({ base: "record_invalid" })
+          end
+          after{ Lord.reset_callbacks(:destroy) }
+
+          it "raises an exception" do
+            expect{ service.provide }.to raise_error
+          end
+
+          it "doesn't make any change to db" do
+            expect{ begin; service.provide; rescue; end }.not_to change{ Lord.all.to_a }
+            expect{ begin; service.provide; rescue; end }.not_to change{ Domain.all.to_a }
+            expect{ begin; service.provide; rescue; end }.not_to change{ Man.all.to_a }
+          end
+
+          it "adds corresponding errors to the #errors" do
+            begin; service.provide; rescue; end
+            service.errors.should_not be_blank
+          end
         end
       end
 
-      context "если перепривязка не может быть выполнена" do
+      context "if :validate option is set to false" do
+
+        context "and no exceptions raised:" do
 
-        before do
-          service.items.last.stub(:destroy!).and_raise
-          service.items.last.stub(:errors).and_return({ base: "Удаление запрещено." })
+          it "merges the objects" do
+            service.provide validate: false
+            Lord.count.should eq 1
+            Lord.first.domains.count.should eq 2
+            Lord.first.men.count.should eq 2
+          end
         end
 
-        it "вызывает исключение" do
-          expect{ service.provide }.to raise_error
+        context "and a validation returns false when rebinding a link:" do
+
+          before do
+            Man.any_instance.stub(:valid?).and_return false
+            Man.any_instance.stub(:errors).and_return({ base: "record_invalid" })
+          end
+
+          it "merges the objects" do
+            service.provide validate: false
+            Lord.count.should eq 1
+            Lord.first.domains.count.should eq 2
+            Lord.first.men.count.should eq 2
+          end
         end
 
-        it "не объединяет записи" do
-          begin; service.provide; rescue; end
-          Lord.count.should eq 2
-          Lord.all.each do |lord|
-            lord.domains.count.should eq 1
-            lord.men.count.should eq 1
+        context "and a callback returns false when destroying an object:" do
+
+          before do
+            Lord.before_destroy(){ false }
+            Lord.any_instance.stub(:errors).and_return({ base: "record_invalid" })
+          end
+          after{ Lord.reset_callbacks(:destroy) }
+
+          it "merges the objects" do
+            service.provide validate: false
+            Lord.count.should eq 1
+            Lord.first.domains.count.should eq 2
+            Lord.first.men.count.should eq 2
           end
         end
 
-        it "добавляет ошибки в массив" do
-          begin; service.provide; rescue; end
-          service.errors.should_not be_blank
+        context "and the service's own validation returns false:" do
+
+          before { service.stub(:valid?).and_return false }
+
+          it "raises an exception" do
+            expect{ service.provide validate: false }.to raise_error
+          end
+
+          it "doesn't make any change to db" do
+            expect{ begin; service.provide validate: false; rescue; end }.not_to change{ Lord.all.to_a }
+            expect{ begin; service.provide validate: false; rescue; end }.not_to change{ Domain.all.to_a }
+            expect{ begin; service.provide validate: false; rescue; end }.not_to change{ Man.all.to_a }
+          end
         end
-      end
 
-      context "если атрибут #items пуст" do
+        context "and db recording fails when rebinding a link:" do
 
-        before { service.stub(:items).and_return [] }
+          before do
+            Man.any_instance.stub(:save!){ fail }
+            Man.any_instance.stub(:errors).and_return({ base: "record_invalid" })
+          end
 
-        it "вызывает исключение" do
-          expect{ service.provide }.to raise_error
+          it "raises an exception" do
+            expect{ service.provide validate: false }.to raise_error
+          end
+
+          it "doesn't make any change to db" do
+            expect{ begin; service.provide validate: false; rescue; end }.not_to change{ Lord.all.to_a }
+            expect{ begin; service.provide validate: false; rescue; end }.not_to change{ Domain.all.to_a }
+            expect{ begin; service.provide validate: false; rescue; end }.not_to change{ Man.all.to_a }
+          end
+
+          it "adds corresponding errors to the #errors" do
+            begin; service.provide validate: false; rescue; end
+            service.errors.should_not be_blank
+          end
         end
 
-        it "добавляет ошибки в массив" do
-          begin; service.provide; rescue; end
-          service.errors.should_not be_blank
+        context "and merged object's delete fails:" do
+
+          before do
+            Lord.any_instance.stub(:delete){ fail }
+            Lord.any_instance.stub(:errors).and_return({ base: "record_invalid" })
+          end
+
+          it "raises an exception" do
+            expect{ service.provide validate: false }.to raise_error
+          end
+
+          it "doesn't make any change to db" do
+            expect{ begin; service.provide validate: false; rescue; end }.not_to change{ Lord.all.to_a }
+            expect{ begin; service.provide validate: false; rescue; end }.not_to change{ Domain.all.to_a }
+            expect{ begin; service.provide validate: false; rescue; end }.not_to change{ Man.all.to_a }
+          end
+
+          it "adds corresponding errors to the #errors" do
+            begin; service.provide validate: false; rescue; end
+            service.errors.should_not be_blank
+          end
         end
       end
     end

data/spec/active_merge_spec.rb

@@ -9,11 +9,15 @@ describe ActiveMerge do
 
     let!(:lords) { 3.times.map{ Lord.create! }}
 
-    it "доступен" do
+    it "defined" do
       Lord.should respond_to :merge_all
     end
 
-    it "объединяет записи указанного запроса" do
+    it "allows options" do
+      Lord.should respond_to(:merge_all).with(1).argument
+    end
+
+    it "merges records from given request" do
       Lord.where("id < 3").merge_all
       Lord.all.pluck(:id).should eq [1, 3]
     end