clone_util 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjM3YTg5OWQwYzcyMTA4YjRkYTg0YzNhYmIxN2FmNmJkMWQ5YTExYg==
+  data.tar.gz: !binary |-
+    MmUzNWViODhmZTM4YjZjYzYxOGQyZjRhYzMyZmI5YmVlYTgzMzQ3Yg==
+SHA512:
+  metadata.gz: !binary |-
+    MjA4ZWJiMmM3Njg4MjU5NDk1OTgwOWJjYjdhOWVjYjgxOTE0YzFhZTkwNDI5
+    YzVjNTQxODhhYjZhZWMyOTk0ZDAzNDM5OGQ3YzIzNmU5YjliOTMxZjczNTlh
+    MTBlY2U3ZGVlZTRlNDY5YjVkZGQ3ZTYxMjQzOWY1YTUxZjRmMDQ=
+  data.tar.gz: !binary |-
+    NzMxZDRjZDQ3NWVjZDMwODFlOTM3M2M5YzkxMjk4MTJmZGI3ZTE0NDgwNmY4
+    NjAyMjQyNzA3ZWZmMDczODAyZGVkMDM2YmI1ZjFlNTc4NzNiNTExNDIyY2I5
+    NjkwZDhkNjFmNjViYTRmNjQ3ODJkOGVhOWJkYWM0MDEzMGM2ZGE=

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in clone_util.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TODO: Write your name
+
+MIT License
+
+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.md

@@ -0,0 +1,127 @@
+# CloneUtil
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'clone_util'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clone_util
+
+## Usage
+
+#Call deep_clone with the parent object which should copy all its children
+Ex: School.first.deep_clone
+
+#Add deep_clone_options in the models which needs to be copied with the parent
+Ex: deep_clone_options(:associations => [:departments, :laboratories])
+
+Example:
+
+Models:
+
+class School < ActiveRecord::Base
+  has_many :laboratories
+  has_many :departments
+
+  deep_clone_options(:associations => [:departments, :laboratories])
+
+  def copy
+    self.deep_clone
+  end
+end
+
+class Laboratory < ActiveRecord::Base
+  belongs_to :school
+  belongs_to :department
+
+  deep_clone_options(:parent_id_att => [:school_id],
+                     :equivalent_associations => [:department]  )
+end
+
+class Department < ActiveRecord::Base
+  belongs_to :school
+  has_many :students
+
+  deep_clone_options(:parent_id_att => [:school_id],
+                     :associations => [:students])
+end
+
+class Student < ActiveRecord::Base
+  belongs_to :department
+end
+
+Migrations:
+
+class CreateSchools < ActiveRecord::Migration
+  def change
+    create_table :schools do |t|
+      t.string :name
+
+      t.timestamps null: false
+    end
+  end
+end
+
+class CreateLaboratories < ActiveRecord::Migration
+  def change
+    create_table :laboratories do |t|
+      t.string :name
+      t.integer :department_id
+      t.integer :school_id
+
+      t.timestamps null: false
+    end
+  end
+end
+
+class CreateDepartments < ActiveRecord::Migration
+  def change
+    create_table :departments do |t|
+      t.string :name
+      t.integer :school_id
+
+      t.timestamps null: false
+    end
+  end
+end
+
+class CreateStudents < ActiveRecord::Migration
+  def change
+    create_table :students do |t|
+      t.string :name
+      t.integer :age
+      t.integer :department_id
+      
+      t.timestamps null: false
+    end
+  end
+end
+
+# Seed File:
+School.create([{ name: 'school1'}])
+Department.create([{ name: 'department1', :school_id => 1 }])
+Laboratory.create([{ name: 'Lab1', :school_id => 1, :department_id => 1 }, { name: 'Lab2', :school_id => 1, :department_id => 1 }])
+Student.create([{ name: 'student1', :department_id => 1 }, { name: 'student2', :department_id => 1 }])
+
+Include the models and run the above migrations
+Finally below command gives you the clone result
+
+School.first.deep_clone
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/clone_util/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/clone_util.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clone_util/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clone_util"
+  spec.version       = CloneUtil::VERSION
+  spec.authors       = "Srijith C"
+  spec.email         = "srijithc038@gmail.com"
+  spec.summary       = "Copy the ActiveRecord objects recursively"
+  spec.description   = "This gem helps us to copy the ActiveRecord objects recursively"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/clone_util.rb

@@ -0,0 +1,122 @@
+module ActiveRecord
+  class Base
+    def self.deep_clone_options(options={})                           
+      class_eval do
+        
+        @clone_options = options
+
+        def self.allow_dup
+          @clone_options[:allow_dup]
+        end
+        
+        def self.clone_info    
+          @clone_options
+        end
+        
+        def self.clone_associations
+          @clone_options[:associations]
+        end
+        
+        def self.equivalent_associations
+          @clone_options[:equivalent_associations]
+        end
+        
+        def self.unequal_attrs
+          unequal_attrs = ['id']
+          unequal_attrs.concat(@clone_options[:unequal_attributes]) if @clone_options[:unequal_attributes]
+          unequal_attrs
+        end
+        
+        def self.ignore_attributes
+          ignore_attributes = ['created_at', 'updated_at', 'created_by_id', 'updated_by_id']
+          ignore_attributes << @clone_options[:parent_id_attr].first if @clone_options[:parent_id_attr]
+          ignore_attributes
+        end
+        
+        def self.parent_id_attr
+          @clone_options[:parent_id_attr]
+        end
+        
+        def deep_clone
+          recursive_clone
+        end
+        
+        #TODO Should be private/protected
+        def recursive_clone(parent_object_id   = nil,
+            clone_id_hash      = {} )
+
+          self.transaction do
+            cloned_object = dup
+
+            unequal_attrs = self.class.clone_info[:unequal_attributes] || []
+            unequal_attrs.each do |a|
+              cloned_object.send("#{a.to_s}=", nil)
+            end
+              
+            #Set parent object_id
+            if self.class.parent_id_attr and parent_object_id
+              cloned_object.send("#{self.class.parent_id_attr[0].to_s}=", parent_object_id)
+            end
+
+            begin
+              obj_attrs = cloned_object.attributes.clone
+              self.class.ignore_attributes.each { |a| obj_attrs.delete(a.to_s)}
+              if self.class.parent_id_attr and parent_object_id
+                obj_attrs["#{self.class.parent_id_attr[0].to_s}"] = parent_object_id
+              end
+                 
+              cloned_object.save!
+              clone_id_hash["#{self.class.table_name}_#{self.id}"] = cloned_object.id
+            rescue Exception  => e
+              logger.info("deepclone: Clone save failed for " + cloned_object.inspect)
+              raise e
+            end
+
+            add_cloned_associations(cloned_object, clone_id_hash)
+            add_equivalent_associations(cloned_object, clone_id_hash)
+                        
+            clone_id_hash["#{self.class.table_name}_#{self.id}"] = cloned_object.id
+            cloned_object
+          end # transaction
+        end # recursive_clone
+
+        def add_equivalent_associations(cloned_object, clone_id_hash)
+          if self.class.equivalent_associations
+            self.class.equivalent_associations.each do |association|
+              assocn = self.class.reflect_on_association(association)
+              assocn_table_name = eval(assocn.class_name).table_name
+              assocn_id = send(assocn.foreign_key)
+              if assocn_id and (equivalent_id = clone_id_hash["#{assocn_table_name}_#{assocn_id}"])
+                cloned_object.send("#{assocn.foreign_key}=", equivalent_id)
+              end
+            end
+            cloned_object.save!
+          end
+        end
+
+        def add_cloned_associations(cloned_object, clone_id_hash)
+          if self.class.clone_associations
+            self.class.clone_associations.each do |association|
+              assocn = self.class.reflect_on_association(association)
+              if assocn.macro == :has_many
+                send(association).each do |obj|
+                  c_obj = obj.respond_to?('deep_clone') ? obj.recursive_clone(cloned_object.id, clone_id_hash) : obj.dup
+                  cloned_object.send(association) << c_obj unless c_obj.nil?
+                end
+              elsif assocn.macro == :has_and_belongs_to_many
+                cloned_object.send("#{association.to_s}=", send(association))
+              elsif (assocn.macro == :belongs_to) or (assocn.macro == :has_one)
+                source_obj = send(association)
+                unless source_obj.nil?
+                  c_obj = source_obj.respond_to?('deep_clone') ? source_obj.recursive_clone(cloned_object.id, clone_id_hash) : source_obj.dup
+                  cloned_object.send("#{association.to_s}=", c_obj) unless c_obj.nil?
+                end
+              end
+            end
+          end
+        end
+        
+      end # class_eval
+    end # deep_clone_options
+  end # Base
+end

data/lib/clone_util/version.rb

@@ -0,0 +1,3 @@
+module CloneUtil
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: clone_util
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Srijith C
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: This gem helps us to copy the ActiveRecord objects recursively
+email: srijithc038@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- clone_util.gemspec
+- lib/clone_util.rb
+- lib/clone_util/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Copy the ActiveRecord objects recursively
+test_files: []