active_merge 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94958ab074d4d742ad174a71fa0681622073ac3c
-  data.tar.gz: b8ab11b01746280d598ffc584622d17131384b6a
+  metadata.gz: 9908a773d23bf5b0b67850538549bf130646b257
+  data.tar.gz: e61c2879ca3ff6a256ac575651c69432b97c3c15
 SHA512:
-  metadata.gz: 95b4c45ac956d9dec90090f4d51b44ec34b35321ce510c8d85e1d60f787558e7c5dd6ff22ed00b7582561480eba0e4c5c8c96d9e931712253c36cd33f3a7420b
-  data.tar.gz: 966ecb1a67d54ff45bb23a46cef7d5369394851fb9b4707758d9341b48e5769a6098ae7ff1955a41984a91c9cb99cbd5115fa00ef86feff94cbd2b7517d33b0b
+  metadata.gz: d189fc4e6e22e3806c1bcf7350130718c4e85170c6d9b51924a7b206cbbdbec9ecae588d339a36bec6fc2650b7a75d3883d51d718663159226b94e7cae6b4511
+  data.tar.gz: eccd6bbd86184af049cb31f3229b4c575ab9ba478c7b0b4a7e3ba97af443ec62467424761f25f8e5bd89ea9c3446dc000f3f73b789a787a1c16d13eb961fd1ac

data/CHANGELOG.rdoc

@@ -0,0 +1,16 @@
+= Список изменений в версиях
+
+== v.1.0.4
+
+* The gem is allowed to use with rails 4.1
+
+== v.1.0.2
+
+* Documentation bug fixed. References to the <tt>#merge</tt> changed to the <tt>#merge_all</tt>
+
+== v.1.0.1
+
+* The <tt>Service#klass</tt> and <tt>Service#klasses</tt> methods removed
+* The <tt>Service</tt> class includes <tt>ActiveModels::Validations</tt>
+* The <tt>Service#valid?</tt> method added
+* Service object errors collected in the <tt>Service#errors</tt>

data/{MIT-LICENSE → LICENSE}

@@ -1,4 +1,4 @@
-Copyright 2014 YOURNAME
+Copyright 2014 Andrew Kozin
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -28,4 +28,4 @@ When merging a list of instances:
 
 == License
 
-This project rocks and uses link:MIT-LICENSE.
+This project rocks and uses MIT-LICENSE[link:LICENSE].

data/Rakefile

@@ -20,10 +20,22 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
 Bundler::GemHelper.install_tasks
 
 require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
-task default: :spec
+task :default do
+  sh "bundle exec rake db:migrate RAILS_ENV=test"
+  sh "mkdir spec/dummy/tmp" do |ok, res|
+    nunitSuccessFlag = false
+  end
+  sh "mkdir spec/dummy/tmp/cache" do |ok, res|
+    nunitSuccessFlag = false
+  end
+  sh "bundle exec rspec spec"
+end

data/lib/active_merge/service.rb

@@ -1,24 +1,29 @@
 # encoding: utf-8
 module ActiveMerge
 
-  # Сервисный объект (паттерн Service Object), отвечающий за объединение
-  # всех записей ActiveRecord, переданных в аргументе.
+  # Service Object responds for merging given ActiveRecord instances into the
+  # first one
   #
-  # При инициализации указывается ActiveRecord::Association или массив объектов.
-  # Из массива выбираются только сохраненные объекты ActiveRecord, причем все
-  # они должны быть объектами одного класса.
+  # Object initializes either with ActiveRecord::Association or array of objects.
+  # If the argument is an array, then only those items taken into account, that:
   #
-  # При объединении:
-  # * Сохраняется первый объект (с наименьшим id)
-  # * У всех прочих объектов ассоциации has_many перепривязываются к первому объекту
-  # * После перепривязки все объекты, кроме первого, удаляются.
+  # * inherited from the <tt>ActiveRecord::Base</tt>
+  # * persisted
+  # * are objects of one class
   #
-  # В результате остается только один объект, к которому привязаны все подобъекты,
-  # ранее относившиеся к объединяемым записям.
+  # == Merging algorithm
   #
-  # == Пример:
+  # * The item with minimal <tt>id</tt> selected from the service argument. It will remaine intact.
+  # * All objects, that the other items links to via "has_many" assotiation, are selected...
+  # * ... and are rebound to the first item
+  # * After rebinding any item from the service argument, except the first one, to be deleted.
   #
-  #     # Рассмотрим модель королевства, имеющего много графств и жителей
+  # As a result it is only the first object from the argument remains intact,
+  # and all the instances that belonged to the other ones are now belongs to it.
+  #
+  # == Example:
+  #
+  #     # Let any kingdom has many shires and men
   #     class Kingdom < ActiveRecord::Base
   #       has_many :shires
   #       has_many :men
@@ -32,102 +37,82 @@ module ActiveMerge
   #       belongs_to :kingdom
   #     end
   #
-  #     # У Британии есть 100 тыс. жителей и 10 графств
+  #     # Britain has 10 shires and 100 thousands men lives there
   #     britain  = Kingdom.create!
-  #     1000000.times.each{ britain.men.create! }
+  #     100000.times.each{ britain.men.create! }
   #     10.times.each{ britain.shires.create! }
   #
-  #     # У Шотландии есть 30 тыс. жителей и 5 графств
+  #     # Scotland has 5 shires and 30 thousands living men
   #     scotland = Kingdom.create!
-  #     300000.times.each{ britain.men.create! }
-  #     5.times.each{ britain.shires.create! }
+  #     30000.times.each{ scotland.men.create! }
+  #     5.times.each{ scotland.shires.create! }
   #
-  #     # Объединяем королевства
+  #     # Lets merge all the kingdoms:
   #     Service.new(Kingdom.all).submit!
   #
-  #     # К Британии (добавлена ранее) присоединены шотландские люди и графства
+  #     # Now union Britain (because it is Britain that was created first) 
+  #     # has all those 15 shires and 130 thousand men
+  #     # from both the old good Britain and the old good Scotland.
   #     britain.reload.men.count # => 130000
   #     britain.reload.shires.count # => 15
   #
-  #     # Королевство Шотландия удалено
+  #     # And, alas, the Scotland Kingdom doesn't exists any more
   #     Kingdom.find_by(scotland.id)  # => nil
   #
-  # == Обратите внимание!
+  # == Warning!
   #
-  # Объединение происходит единой транзакцией. При любой ошибке все изменения
-  # отменяются.
+  # The merge provided as a whole transaction. In case any error occures, all
+  # the changes rolled back.
   #
-  # Если в примере выше графство не может быть перепривязано к новому
-  # королевству (незыблемость суверенитета):
+  # Let (see the example above) the shire cannot be rebount to another kingdom:
   #
   #     class Shire
   #       attr_readonly :kingdom_id
   #     end
   #
-  # то объединения не произойдет!
+  # then merging won't be finished.
+  #
+  # Not only shires, but also the scots remain living in their Scotland,
+  # not in the United Kingdom!
   #
-  class Service
+  class Service < ActivePatterns::BaseService
     include ActiveModel::Validations
 
-    def initialize(list = [])
-      list = extract_from list
+    def initialize(list = nil)
+      list = Items.new list
       @item, @items = list.first, Array(list[1..-1])
     end
 
     attr_reader :item, :items, :klass, :klasses
     validates   :items, presence: true
 
-    # Объединяет все записи из переменной #items с записью в переменной #item
-    #
-    # При этом:
-    # * все ссылки на записи из массива #items перепривязываются к #item
-    # * все записи #items удаляются
-    #
-    # При любой ошибке все сделанные изменения отменяются.
-    #
+    # Merges all the #items to the #item as a whole transaction
     def provide
-      ActiveRecord::Base.transaction requires_new: true do
-        raise unless valid?
-        items.each{ |item| merge self.item, item }
+      transaction do
+        items.each do |item|
+          service = SimpleService.new(self.item, item)
+          change(service) { service.provide }
+        end
       end
     end
 
     private
 
-      # Извлекает из списка только сохраненные объекты ActiveRecord
-      # Если список содержит элементы ActiveRecord разных классов, возвращает
-      # пустой массив.
-      def extract_from(list)
-        begin
-          list = select_active_records_from list
-          list = select_by_class_from list
-        rescue
-          []
+      # Returns only persisted items of the same ActiveRecord model
+      class Items < Array
+        def initialize(items)
+          items = Array(items).map{ |item| Item.new item }.compact
+          items = [] if items.map{ |item| item.class }.uniq.count > 1
+          super items.sort_by{ |item| item.id }
         end
       end
 
-      # Выбирает сохраненные объекты ActiveRecord
-      def select_active_records_from(list)
-        list.select do |item|
-          item.class.ancestors.include?(ActiveRecord::Base) && item.persisted?
-        end
-      end
-
-      # Выбирает объекты того же класса, что и у первой записи списка
-      def select_by_class_from(list)
-        klass = list.first.class
-        list.each { |item| raise unless item.class == klass }
-        list.sort_by { |item| item.id }
-      end
-
-      # Объединяет две записи.
-      # Переносит ошибки в текущий объект.
-      def merge(first, second)
-        service = ActiveMerge::SimpleService.new(first, second)
-        begin
-          service.provide
-        rescue
-          service.errors.each{ |key, val| errors.add key, val } and raise
+      # Initializes a persisted item of an ActiveRecord model
+      class Item
+        def self.new(item)
+          return unless item.class.ancestors.include? ActiveRecord::Base
+          return unless item.persisted?
+          item
         end
       end
   end

data/lib/active_merge/simple_service.rb

@@ -1,16 +1,16 @@
 # encoding: utf-8
 module ActiveMerge
 
-  # Сервисный объект (паттерн Service Object), отвечающий за объединение
-  # двух записей ActiveRecord
+  # Service Object responds for merging two ActiveRecord instances as a whole
+  # transaction.
   #
-  # В ходе объединения все ссылки на вторую запись перепривязываются к первой,
-  # затем вторая запись удаляется
+  # All objects linked to the second instance via "has_many" association
+  # are re-associated to the first one.
+  # 
+  # Then the second instance removed.
+  # All errors collected in the #errors method.
   #
-  # В случае любой ошибки вызывается исключение, а ошибка добавляется в массив
-  # <tt>errors</tt>
-  #
-  class SimpleService
+  class SimpleService < ActivePatterns::BaseService
     include ActiveModel::Validations
 
     def initialize(first, second)
@@ -28,49 +28,46 @@ module ActiveMerge
     validates :second, presence: true
 
     def provide
-      ActiveRecord::Base.transaction requires_new: true do
-        raise unless valid?
-        refs.each{ |item, key| rebind(item, key) }
-        destroy
+      transaction do
+        Links.new(second).each { |item, key| rebind(item, key) }
+        change(second) { second.destroy! }
       end
     end
 
     private
 
-      # Возвращает хэш, в котором ключами выступают связи has_many,
-      # а значениями - foreign keys
-      def klasses
-        second.class.reflect_on_all_associations(:has_many).
-          inject({}){ |hash, item| hash.merge(item.name => item.foreign_key) }
-      end
+      # Initializes a hash, whose keys are instances linked to given one,
+      # and their values are names of methods for linking to another object.
+      class Links
+        class << self
+
+          def new(item)
+            @item = item
+            return hash
+          end
+
+          # Returns a hash whose keys are "has_many" associations' names
+          # and their values are corresponding foreign keys
+          def refs
+            @item.class.reflect_on_all_associations(:has_many).
+              inject({}){ |hash, item| hash.merge(item.name => item.foreign_key) }
+          end
 
-      # Возвращает хэш, в котором ключами выступают объекты, ссылающихся на 
-      # #second, а значениями - методы присвоения ссылки на #first.
-      def refs
-        @refs = {}
-        klasses.each do |list, key|
-          second.send(list).each{ |item| @refs[item] = "#{ key }=" }
+          def hash
+            @hash = {}
+            refs.each do |name, foreign_key|
+              @item.send(name).each{ |item| @hash[item] = "#{ foreign_key }=" }
+            end
+            @hash
+          end
         end
-        return @refs
       end
 
-      # Выполняет перепривязку указанного объекта к первому аргументу
-      # Ошибки накапливаются в массиве <tt>errors</tt>
+      # Re-assigns given object to the #first
       def rebind(item, key)
-        begin
+        change item do
           item.send key, first.id
           item.save!
-        rescue
-          item.errors.each{ |key, val| errors.add key, val } and raise
-        end
-      end
-
-      # Удаляет объединяемый объект
-      def destroy
-        begin
-          second.destroy!
-        rescue
-          second.errors.each{ |key, val| errors.add key, val } and raise
         end
       end
   end

data/lib/active_merge/version.rb

@@ -1,4 +1,3 @@
 module ActiveMerge
-  # Текущая версия плагина
-  VERSION = "1.0.4"
+  VERSION = "1.0.5"
 end

data/lib/active_merge.rb

@@ -1,9 +1,9 @@
-# encoding: utf-8
+require "active_patterns"
 
-# Модуль содержит методы объединения записей ActiveRecord
+# Declares service object for merging ActiveRecord instances.
 #
-# После расширения класса, унаследованного от <tt>ActiveRecord::Base</tt>
-# становится доступен метод класса <tt>::merge_all</tt>, объединяющий записи.
+# After extending your active record model with the module,
+# new <tt>::merge_all</tt> method is available.
 #
 module ActiveMerge
   extend ActiveSupport::Autoload
@@ -11,18 +11,18 @@ module ActiveMerge
   autoload :SimpleService
   autoload :Service
 
-  # Объединение указанных записей.
+  # Merges instances from the association
   #
   #     class Lord < ActiveRecord::Base
   #       extend ActiveMerge
   #     end
   #
-  #     Lord.all.merge_all   # => объединяет все записи
-  #     Lord.where(id > 100) # => объединяет все записи с id > 100
+  #     Lord.all.merge_all              # => merges all the class instances
+  #     Lord.where("id > :id", id: 100) # => merges instances with id > 100
   #
-  # Детали см. в описании метода <tt>ActiveMerge::Service#provide</tt>
+  # See details in <tt>ActiveMerge::Service#provide</tt> documentation.
   #
   def merge_all
-    ActiveMerge::Service.new(self).provide
+    ActiveMerge::Service.new(all).provide
   end
 end

data/spec/active_merge/service_spec.rb

@@ -0,0 +1,205 @@
+# encoding: utf-8
+require "spec_helper"
+
+module ActiveMerge
+  describe Service do
+
+    describe "#item" do
+
+      it "объявлен" do
+        Service.new.should respond_to :item
+      end
+    end
+
+    describe "#items" do
+
+      it "объявлен" do
+        Service.new.should respond_to :items
+      end
+    end
+
+    describe "::new" do
+
+      let!(:items) { 3.times.map{ Man.create! }}
+
+      context "если передан запрос ActiveRelations" do
+
+        let!(:service) { Service.new Man.all }
+
+        it "присваивает переменной item первый объект (с минимальным id)" do
+          service.item.should eq Man.first
+        end
+
+        it "присваивает переменной items все объекты, кроме первого (с минимальным id)" do
+          service.items.should eq Man.all.order("id ASC").to_a[1..-1]
+        end
+      end
+
+      context "если запрос возвращает только один элемент" do
+
+        let!(:service) { Service.new Man.where(id: Man.first.id) }
+
+        it "присваивает переменной item первый объект (с минимальным id)" do
+          service.item.should eq Man.first
+        end
+
+        it "присваивает переменной items пустой массив" do
+          service.items.should eq []
+        end
+      end
+
+      context "если запрос возвращает пустой массив" do
+
+        let!(:service) { Service.new Man.where(id: 0) }
+
+        it "присваивает nil переменной item" do
+          service.item.should be_nil
+        end
+
+        it "присваивает пустой массив переменной items" do
+          service.items.should eq []
+        end
+      end
+
+      context "если передан массив объектов ActiveRecord вместе с другими, non-Active record элементами" do
+
+        let!(:service) { Service.new (items + [Man.new, nil, 1]).shuffle }
+
+        it "присваивает переменной item первый объект (с минимальным id)" do
+          service.item.should eq Man.first
+        end
+
+        it "присваивает переменной items все сохраненные объекты, кроме первого (с минимальным id)" do
+          service.items.should eq Man.all.order("id ASC").to_a[1..-1]
+        end
+      end
+
+      context "если переданный массив содержит только один сохраненный объект ActiveRecord" do
+
+        let!(:service) { Service.new [Man.first, 1, nil, Man.new] }
+
+        it "присваивает переменной item первый объект (с минимальным id)" do
+          service.item.should eq Man.first
+        end
+
+        it "присваивает переменной items пустой массив" do
+          service.items.should eq []
+        end
+      end
+
+      context "если массив не содержит сохраненных объектов ActiveRecord" do
+
+        let!(:service) { Service.new [1, nil, Man.new] }
+
+        it "присваивает nil переменной item" do
+          service.item.should be_nil
+        end
+
+        it "присваивает пустой массив переменной items" do
+          service.items.should eq []
+        end
+      end
+
+      context "если массив содержит сохраненные объекты ActiveRecord разных классов" do
+
+        let!(:service) { Service.new [Man.first, Domain.create!] }
+
+        it "присваивает nil переменной item" do
+          service.item.should be_nil
+        end
+
+        it "присваивает пустой массив переменной items" do
+          service.items.should eq []
+        end
+      end
+
+      context "если атрибут не передан" do
+
+        let!(:service) { Service.new }
+
+        it "присваивает nil переменной item" do
+          service.item.should be_nil
+        end
+
+        it "присваивает пустой массив переменной items" do
+          service.items.should eq []
+        end
+      end
+    end
+
+    describe "#valid?" do
+
+      it "возвращает true если список записей для присоединения установлен" do
+        Service.new(2.times.map{ Lord.create! }).should be_valid
+      end
+
+      it "возвращает false если список записей для присоединения пуст" do
+        service = Service.new [Lord.create!]
+        service.should_not be_valid
+        service.errors.should_not be_blank
+      end
+    end
+
+    describe "#provide" do
+
+      let!(:lords)   { 2.times.map{ Lord.create! }}
+      let!(:domains) { lords.map{ |lord| lord.domains.create! }}
+      let!(:men)     { lords.map{ |lord| lord.men.create! }}
+      let!(:service) { Service.new lords }
+
+      context "если перепривязка разрешена" do
+
+        it "не вызывает исключений" do
+          expect{ service.provide }.not_to raise_error
+        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
+        end
+      end
+
+      context "если перепривязка не может быть выполнена" do
+
+        before do
+          service.items.last.stub(:destroy!).and_raise
+          service.items.last.stub(:errors).and_return({ base: "Удаление запрещено." })
+        end
+
+        it "вызывает исключение" do
+          expect{ service.provide }.to raise_error
+        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
+          end
+        end
+
+        it "добавляет ошибки в массив" do
+          begin; service.provide; rescue; end
+          service.errors.should_not be_blank
+        end
+      end
+
+      context "если атрибут #items пуст" do
+
+        before { service.stub(:items).and_return [] }
+
+        it "вызывает исключение" do
+          expect{ service.provide }.to raise_error
+        end
+
+        it "добавляет ошибки в массив" do
+          begin; service.provide; rescue; end
+          service.errors.should_not be_blank
+        end
+      end
+    end
+  end
+end