active_merge 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,26 @@
+= ActiveMerge
+
+Declares the <tt>ActiveMerge</tt> module for extending ActiveRecord models.
+
+The module contains the <tt>merge</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
+
+    class Post < ActiveRecord
+      extend ActiveMerge
+      has_many :comments 
+    end
+
+    Post.all.merge!
+    # This will merge all the posts into the first one.
+    # The other posts will be deleted after their comment are reattached
+    # to the first post.
+
+== License
+
+This project rocks and uses link:MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,17 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActiveMerge'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks

data/lib/active_merge/service.rb

@@ -0,0 +1,166 @@
+# encoding: utf-8
+module ActiveMerge
+
+  # Сервисный объект (паттерн Service Object), отвечающий за объединение
+  # всех записей ActiveRecord, переданных в аргументе.
+  #
+  # При инициализации указывается ActiveRecord::Association или массив объектов.
+  # Из массива выбираются только сохраненные объекты ActiveRecord, причем все
+  # они должны быть объектами одного класса.
+  #
+  # При объединении:
+  # * Сохраняется первый объект (с наименьшим id)
+  # * У всех прочих объектов ассоциации has_many перепривязываются к первому объекту
+  # * После перепривязки все объекты, кроме первого, удаляются.
+  #
+  # В результате остается только один объект, к которому привязаны все подобъекты,
+  # ранее относившиеся к объединяемым записям.
+  #
+  # == Пример:
+  #
+  #     # Рассмотрим модель королевства, имеющего много графств и жителей
+  #     class Kingdom < ActiveRecord::Base
+  #       has_many :shires
+  #       has_many :men
+  #     end
+  #
+  #     class Shire < ActiveRecord::Base
+  #       belongs_to :kingdom
+  #     end
+  #
+  #     class Man < ActiveRecord::Base
+  #       belongs_to :kingdom
+  #     end
+  #
+  #     # У Британии есть 100 тыс. жителей и 10 графств
+  #     britain  = Kingdom.create!
+  #     1000000.times.each{ britain.men.create! }
+  #     10.times.each{ britain.shires.create! }
+  #
+  #     # У Шотландии есть 30 тыс. жителей и 5 графств
+  #     scotland = Kingdom.create!
+  #     300000.times.each{ britain.men.create! }
+  #     5.times.each{ britain.shires.create! }
+  #
+  #     # Объединяем королевства
+  #     Service.new(Kingdom.all).submit!
+  #
+  #     # К Британии (добавлена ранее) присоединены шотландские люди и графства
+  #     britain.reload.men.count # => 130000
+  #     britain.reload.shires.count # => 15
+  #
+  #     # Королевство Шотландия удалено
+  #     Kingdom.find_by(scotland.id)  # => nil
+  #
+  # == Обратите внимание!
+  #
+  # Объединение происходит единой транзакцией. При любой ошибке все изменения
+  # отменяются.
+  #
+  # Если в примере выше графство не может быть перепривязано к новому
+  # королевству (незыблемость суверенитета):
+  #
+  #     class Shire
+  #       attr_readonly :kingdom_id
+  #     end
+  #
+  # то объединения не произойдет!
+  #
+  class Service
+
+    def initialize(list = [])
+      list = _extract_from list
+      @item, @items = list.first, Array(list[1..-1])
+    end
+
+    attr_reader :item, :items, :klass, :klasses
+
+    # Возвращает класс объединяемых объектов
+    def klass
+      @klass ||= item.class
+    end
+
+    # Возвращает хэш, в котором ключами выступают связи has_many,
+    # а значениями - foreign keys
+    def klasses
+      @klasses ||= klass.reflect_on_all_associations(:has_many).
+        inject({}){ |hash, item| hash.merge(item.name => item.foreign_key) }
+    end
+
+    # Объединяет все записи из переменной #items с записью в переменной #item
+    #
+    # При этом:
+    # * все ссылки на записи из массива #items (связь has_many) перепривязываются к #item
+    # * все записи #items удаляются
+    #
+    # При любой ошибке все сделанные изменения отменяются.
+    #
+    def provide
+      ActiveRecord::Base.transaction requires_new: true do
+        _raise :blank if items.blank?
+        items.each{ |item| _merge_one(item) }
+      end
+    end
+
+    private
+
+      # Вызывает исключение указанного типа с переданными парамертами
+      def _raise(type, item = nil)
+        options = item ? { type: item.class.name.underscore, id: item.id } : {}
+        options.merge! scope: %w(active_merge errors service)
+        raise I18n.t(type, options)
+      end
+
+      # Извлекает из списка только сохраненные объекты ActiveRecord
+      # Если список содержит элементы ActiveRecord разных классов, возвращает
+      # пустой массив.
+      def _extract_from(list)
+        begin
+          list  = list.select{ |item| _valid? item }
+          klass = list.first.class
+          list.each { |item| raise unless item.class == klass }
+          list.sort_by { |item| item.id }
+        rescue
+          []
+        end
+      end
+
+      # Проверяет, что объект является сохраненным объектом ActiveRecord
+      def _valid?(item)
+        begin
+          item.class.ancestors.include?(ActiveRecord::Base) && item.persisted?
+        rescue
+          false
+        end
+      end
+
+      # Объединяет указанный объект с объектом из переменной #item
+      # * Перепривязывает ссылки на объект #item
+      # * Удаляет объект, переданный в аргументе
+      def _merge_one(item)
+        klasses.each do |list, foreign_key|
+          item.send(list).each { |ref| _rebind! ref, foreign_key }
+        end
+        _destroy! item
+      end
+
+      # Перепривязывает запись к первому объединяемому объекту
+      def _rebind!(item, foreign_key)
+        begin
+          item.send "#{ foreign_key }=", self.item.id
+          item.save!
+        rescue
+          _raise :rebind, item
+        end
+      end
+
+      # Удаляет запись, сохраняя ошибки
+      def _destroy!(item)
+        begin
+          item.destroy!
+        rescue
+          _raise :destroy, item
+        end
+      end
+  end
+end

data/lib/active_merge/version.rb

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

data/lib/active_merge.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+# Модуль содержит методы объединения записей ActiveRecord
+#
+# После расширения класса, унаследованного от <tt>ActiveRecord::Base</tt>
+# становится доступен метод класса <tt>::merge_all</tt>, объединяющий записи.
+#
+module ActiveMerge
+  extend ActiveSupport::Autoload
+  autoload :Service
+
+  # Объединение указанных записей.
+  #
+  #     class Lord < ActiveRecord::Base
+  #       extend ActiveMerge
+  #     end
+  #
+  #     Lord.all.merge_all   # => объединяет все записи
+  #     Lord.where(id > 100) # => объединяет все записи с id > 100
+  #
+  # Детали см. в описании метода <tt>ActiveMerge::Service#provide</tt>
+  #
+  def merge_all
+    ActiveMerge::Service.new(self).provide
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: active_merge
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Kozin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.3
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Declares the ActiveMerge module with the 'merge!' class method.
+email:
+- andrew.kozin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/active_merge/service.rb
+- lib/active_merge/version.rb
+- lib/active_merge.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: https://github.com/nepalez/active_merge
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Merges instances of an ActiveRecord class.
+test_files: []
+has_rdoc: