copyable 0.1.2 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0859ce58af81fc332e91f2bbd28a5b366bf4ea39
-  data.tar.gz: f8f723985693eb36ef020438477df278bd5d6cd7
+SHA256:
+  metadata.gz: 4469dfa2f2d809e14bbe2f9d23c57ee23594e37612e06ac939dcc050d6b7dcff
+  data.tar.gz: 1bae8a3e7e44b95e8be919cd0db60a9d80855ca5572c9ff72e01ee123e8ff607
 SHA512:
-  metadata.gz: 29faf86afe9848520ee195c143d11ae2d0e4b9f58c957394e00cd4f05399d4b75639c6aef3a274e63ebf7264900d83a6f81562ab6864806aec9a949738868173
-  data.tar.gz: 4160086a9126941852f26add5112e3ee6ad91a9fd7318d4a1e3dde1b81c00f3c3a360ea23c14cea43381ee82a796728d9b4c648840b3b7e552071187b1e6a8c2
+  metadata.gz: c76b4c56537dd07a094042c832f1410a68ed709cdcbdf00e7c891ec14c164fc081c7b0732b5c9263aa1af79bc048738b5ee70e8a790d9b43df7c1f35166ec57b
+  data.tar.gz: 579d1c0532a0fdf37575e8e732d5a2f578c0e6acd5e6ed21159f361fe2ae381a4d2a0415710f61cd61cb24b99042090302d8d62a44981d4d2ab385baea363b0b

data/.travis.yml

@@ -1,3 +1,3 @@
 language: ruby
 rvm:
-  - 2.0.0
+  - 2.7.2

data/README.md

@@ -121,16 +121,9 @@ The advice must be one of the following:
 
 ## Callbacks
 
-It depends on the situation as to whether you would want a particular callback to be fired when a model is copied.  Since the logic of callbacks is situational, Copyable makes the decision to completely disable all callbacks and observers for the duration of the `create_copy!` method.  The only exception are callbacks and observers related to validation.
-
-To make it easier to reason about the code, and for the sake of being obvious, every copyable declaration *must* include a declaration called `disable_all_callbacks_and_observers_except_validate`.  This declaration itself does not do anything; it exists as documentation.
-
-    copyable do
-      disable_all_callbacks_and_observers_except_validate
-      ...
-    end
-
-
+It depends on the situation as to whether you would want a particular callback to be fired when a model is copied.  Since the logic of callbacks is situational, Copyable makes the decision to bypass callbacks
+when saving the copied models by using raw SQL insert statements during the copy. It will check
+validations unless `skip_validations` is passed to `create_copy`.
 
 ## The After Copy Declaration
 
@@ -267,4 +260,4 @@ So the recommended approach is to use `after_copy` to tweak the columns of the c
 
 ## About
 
-Copyable was developed at [District Management Group](https://dmgroupK12.com).
+Copyable was developed at [District Management Group](https://dmgroupK12.com).

data/copyable.gemspec

@@ -6,8 +6,8 @@ require 'copyable/version'
 Gem::Specification.new do |spec|
   spec.name          = "copyable"
   spec.version       = Copyable::VERSION
-  spec.authors       = ["Wyatt Greene", "Dennis Chan"]
-  spec.email         = ["dchan@dmcouncil.org"]
+  spec.authors       = ["Wyatt Greene", "Dennis Chan", "Anne Geiersbach", "Parker Morse"]
+  spec.email         = ["dchan@dmgroupK12.com", "ageiersbach@dmgroupK12.com", "pmorse@dmgroupK12.com"]
   spec.summary       = %q{ActiveRecord copier}
   spec.description   = %q{Copyable makes it easy to copy ActiveRecord models.}
   spec.homepage      = "https://github.com/dmcouncil/copyable"
@@ -18,11 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activerecord", "~>4.1.0"
+  spec.add_dependency "activerecord", "5.2.6"
 
-  spec.add_development_dependency "database_cleaner", "~> 1.4.0"
-  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "database_cleaner", "~> 2"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "sqlite3", "~> 1.3.6"
 end

data/lib/copyable/copyable_extension.rb

@@ -49,6 +49,8 @@ module Copyable
               # fill in each column of this brand new model according to the
               # instructions given in the copyable declaration
               column_overrides = options[:override] || {}
+              # merge with global override hash if exists
+              column_overrides = column_overrides.merge(options[:global_override]) if options[:global_override]
               Declarations::Columns.execute(main.column_list, original_model, new_model, column_overrides)
               # save that sucker!
               Copyable::Saver.save!(new_model, options[:skip_validations])
@@ -61,7 +63,7 @@ module Copyable
               # declaration
 
               skip_associations = options[:skip_associations] || []
-              Declarations::Associations.execute(main.association_list, original_model, new_model, options[:skip_validations], skip_associations)
+              Declarations::Associations.execute(main.association_list, original_model, new_model, options[:global_override], options[:skip_validations], skip_associations)
               # run the after_copy block if it exists
               Declarations::AfterCopy.execute(main.after_copy_block, original_model, new_model)
             ensure

data/lib/copyable/declarations/associations.rb

@@ -6,11 +6,12 @@ module Copyable
 
         # this is the algorithm for copying associated records according to the
         # instructions given in the copyable declaration
-        def execute(association_list, original_model, new_model, skip_validations, skip_associations)
+        def execute(association_list, original_model, new_model, global_override = {}, skip_validations, skip_associations)
           @skip_validations = skip_validations
           @skip_associations = skip_associations
+          @global_override = global_override
           association_list.each do |assoc_name, advice|
-            association = original_model.class.reflections[assoc_name.to_sym]
+            association = original_model.class.reflections[assoc_name.to_s]
             check_advice(association, advice, original_model)
             unless advice == :do_not_copy || skip_associations.include?(assoc_name.to_sym)
               copy_association(association, original_model, new_model)
@@ -27,14 +28,14 @@ module Copyable
             message << "has unrecognized advice '#{advice}'."
             raise AssociationError.new(message)
           end
-          if association.macro == :has_and_belongs_to_many && advice == :copy
+          if association.is_a?(ActiveRecord::Reflection::HasAndBelongsToManyReflection) && advice == :copy
             message = "Error in copyable:associations of "
             message << "#{original_model.class.name}: the association '#{association.name}' "
             message << "only supports the :copy_only_habtm_join_records advice, not the :copy advice, "
             message << "because it is a has_and_belongs_to_many association."
             raise AssociationError.new(message)
           end
-          if association.macro != :has_and_belongs_to_many && advice == :copy_only_habtm_join_records
+          if !association.is_a?(ActiveRecord::Reflection::HasAndBelongsToManyReflection) && advice == :copy_only_habtm_join_records
             message = "Error in copyable:associations of "
             message << "#{original_model.class.name}: the association '#{association.name}' "
             message << "only supports the :copy advice, not the :copy_only_habtm_join_records advice, "
@@ -44,15 +45,14 @@ module Copyable
         end
 
         def copy_association(association, original_model, new_model)
-          case association.macro
-          when :has_many
+          if association.is_a?(ActiveRecord::Reflection::HasManyReflection)
             copy_has_many(association, original_model, new_model)
-          when :has_one
+          elsif association.is_a?(ActiveRecord::Reflection::HasOneReflection)
             copy_has_one(association, original_model, new_model)
-          when :has_and_belongs_to_many
+          elsif association.is_a?(ActiveRecord::Reflection::HasAndBelongsToManyReflection)
             copy_habtm(association, original_model, new_model)
           else
-            raise "Unsupported association #{association.macro}" # should never happen, since we filter out belongs_to
+            raise "Unsupported association #{association.class}" # should never happen, since we filter out belongs_to
           end
         end
 
@@ -79,6 +79,7 @@ module Copyable
               copied_record = original_record.create_copy!(
                 override: { association.foreign_key => parent_model.id },
                 __called_recursively: true,
+                global_override: @global_override,
                 skip_validations: @skip_validations,
                 skip_associations: @skip_associations)
             else

data/lib/copyable/model_hooks.rb

@@ -16,30 +16,33 @@ module Copyable
 
     def self.disable_all_callbacks(klass)
       klass.class_eval do
-        # Don't do it if it was already done
-        return if self.method_defined? :__disabled__run_callbacks
-
-        alias_method :__disabled__run_callbacks, :run_callbacks
-        # We are violently duck-punching ActiveRecord because ActiveRecord
-        # gives us no way to turn off callbacks.  My apologies to the
-        # squeamish.
-        def run_callbacks(kind, *args, &block)
-          if block_given?
-            yield
-          else
-            true
-          end
+        return if self.method_defined? :old_save! # Don't do this more than once
+
+        @all_callbacks_disabled = true
+        class << self
+          attr_reader :all_callbacks_disabled
+        end
+
+        alias_method :old_save!, :save!
+
+        # Hold my beer while we bypass all the Rails callbacks
+        # in favor of some raw SQL
+        def save!
+          Copyable::Saver.save!(self)
         end
       end
     end
 
     def self.reenable_all_callbacks(klass)
       klass.class_eval do
-        # Only do it if the disabled callbacks are defined
-        return unless self.method_defined? :__disabled__run_callbacks
+        return unless self.method_defined? :old_save! # Don't do this more than once
+        @all_callbacks_disabled = false
+        class << self
+          attr_reader :all_callbacks_disabled
+        end
 
-        alias_method :run_callbacks, :__disabled__run_callbacks
-        remove_method :__disabled__run_callbacks
+        alias_method :save!, :old_save!
+        remove_method :old_save!
       end
     end
 

data/lib/copyable/option_checker.rb

@@ -1,7 +1,7 @@
 module Copyable
   class OptionChecker
 
-    VALID_OPTIONS = [:override, :skip_validations, :skip_associations]
+    VALID_OPTIONS = [:override, :global_override, :skip_validations, :skip_associations]
     VALID_PRIVATE_OPTIONS = [:__called_recursively]  # for copyable's internal use only
 
     def self.check!(options)

data/lib/copyable/saver.rb

@@ -1,19 +1,27 @@
 module Copyable
   class Saver
 
+    def self.direct_sql_insert!(new_model)
+      new_model.send(:_create_record) # bypass all callbacks and validations
+    end
+
+    def self.direct_sql_update!(new_model)
+      new_model.send(:_update_record) # bypass all callbacks and validations
+    end
+
     # this is the algorithm for saving the new record
-    def self.save!(new_model, skip_validations)
-      unless skip_validations
-        ModelHooks.reenable!(new_model.class) # we must re-enable or validation does not work
-        if !new_model.valid?(:create)
-          ModelHooks.disable!(new_model.class)
-          raise(ActiveRecord::RecordInvalid.new(new_model))
-        else
-          ModelHooks.disable!(new_model.class)
-        end
+    def self.save!(new_model, skip_validations=false)
+      unless skip_validations || new_model.valid?(:create)
+        raise(ActiveRecord::RecordInvalid.new(new_model))
       end
-      new_model.save!
-    end
 
+      if new_model.class.all_callbacks_disabled && new_model.id.nil?
+        self.direct_sql_insert!(new_model)
+      elsif new_model.class.all_callbacks_disabled
+        self.direct_sql_update!(new_model)
+      else
+        new_model.save!
+      end
+    end
   end
 end

data/lib/copyable/syntax_checking/association_checker.rb

@@ -10,7 +10,8 @@ module Copyable
     def expected_entries
       all_associations = model_class.reflect_on_all_associations
       required_associations = all_associations.select do |ass|
-        (ass.macro != :belongs_to) && ass.options[:through].blank?
+        !ass.is_a?(ActiveRecord::Reflection::BelongsToReflection) &&
+        !ass.is_a?(ActiveRecord::Reflection::ThroughReflection)
       end
       required_associations.map(&:name).map(&:to_s)
     end

data/lib/copyable/version.rb

@@ -1,3 +1,3 @@
 module Copyable
-  VERSION = "0.1.2"
+  VERSION = "0.3.2"
 end

data/lib/tasks/copyable.rake

@@ -39,7 +39,8 @@ task :copyable => :environment do
 
   all_associations = model_class.reflect_on_all_associations
   required_associations = all_associations.select do |ass|
-    (ass.macro != :belongs_to) && ass.options[:through].blank?
+    !ass.is_a?(ActiveRecord::Reflection::BelongsToReflection) &&
+    !ass.is_a?(ActiveRecord::Reflection::ThroughReflection)    
   end
   associations = required_associations.map(&:name).map(&:to_s)
   max_length = associations.map(&:length).max

data/spec/deep_structure_copy_spec.rb

@@ -129,6 +129,20 @@ describe 'complex model hierarchies:' do
         expect(CopyableVehicle.count).to eq(2)
         expect(CopyableAmenity.count).to eq(2)
       end
+
+      context 'with a global override, can copy vehicle with new owner' do
+        before(:each) do
+          @jane = CopyableOwner.create!(name: 'Jane')
+        end
+
+        it 'should copy the records correctly' do
+          @copy_of_joes_car = @porsche.create_copy!(global_override: { copyable_owner_id: @jane.id })
+          expect(CopyableVehicle.count).to eq(2)
+          expect(CopyableAmenity.count).to eq(2)
+          expect(@copy_of_joes_car.copyable_owner_id).to eq(@jane.id)
+          expect(@copy_of_joes_car.copyable_amenities.map(&:copyable_owner_id).uniq).to eq([@jane.id])
+        end
+      end
     end
 
     context 'with many models, some having redundant associations' do

data/spec/helper/test_tables.rb

@@ -11,14 +11,14 @@ module Copyable
 
           create_table :copyable_albums, force: true do |t|
             t.string :name, null: false
-            t.timestamps
+            t.timestamps null: false
           end
 
           create_table :copyable_amenities, force: true do |t|
             t.string   :name
             t.integer  :copyable_vehicle_id
             t.integer  :copyable_owner_id
-            t.timestamps
+            t.timestamps null: false
           end
 
           create_table :copyable_addresses, force: true do |t|
@@ -27,30 +27,30 @@ module Copyable
             t.string   :city,                     null: false
             t.string   :state,                    null: false
             t.integer  :copyable_pet_profile_id,  null: false
-            t.timestamps
+            t.timestamps null: false
           end
 
           create_table :copyable_cars, force: true do |t|
             t.string   :make,   null: false
             t.string   :model,  null: false
             t.integer  :year,   null: false
-            t.timestamps
+            t.timestamps null: false
           end
 
           create_table :copyable_coins, force: true do |t|
             t.string  :kind
             t.integer :year
-            t.timestamps
+            t.timestamps null: false
           end
 
           create_table :copyable_owners, force: true do |t|
             t.string :name, null: false
-            t.timestamps
+            t.timestamps null: false
           end
 
           create_table :copyable_pet_foods, force: true do |t|
             t.string :name, null: false
-            t.timestamps
+            t.timestamps null: false
           end
 
           create_table :copyable_pet_foods_pets, force: true, id: false do |t|
@@ -62,31 +62,31 @@ module Copyable
             t.string   :description,     null: false
             t.string   :nickname
             t.integer  :copyable_pet_id, null: false
-            t.timestamps
+            t.timestamps null: false
           end
 
           create_table :copyable_pet_sitters, force: true do |t|
             t.string  :name, null: false
-            t.timestamps
+            t.timestamps null: false
           end
 
           create_table :copyable_pet_sitting_patronages, force: true do |t|
             t.integer  :copyable_pet_id,        null: false
             t.integer  :copyable_pet_sitter_id, null: false
-            t.timestamps
+            t.timestamps null: false
           end
 
           create_table :copyable_pet_tags, force: true do |t|
             t.string   :registered_name, null: false
             t.integer  :copyable_pet_id, null: false
-            t.timestamps
+            t.timestamps null: false
           end
 
           create_table :copyable_pets, force: true do |t|
             t.string  :name,        null: false
             t.string  :kind,        null: false
             t.integer :birth_year
-            t.timestamps
+            t.timestamps null: false
           end
 
           create_table :copyable_pictures, force: true do |t|
@@ -94,36 +94,36 @@ module Copyable
             t.integer :imageable_id
             t.string  :imageable_type
             t.integer :picture_album_id
-            t.timestamps
+            t.timestamps null: false
           end
 
           create_table :copyable_products, force: true do |t|
             t.string  :name
-            t.timestamps
+            t.timestamps null: false
           end
 
           create_table :copyable_toys, force: true do |t|
             t.string   :name
             t.string   :kind
             t.integer  :copyable_pet_id
-            t.timestamps
+            t.timestamps null: false
           end
 
           create_table :copyable_trees, force: true do |t|
             t.string  :kind
-            t.timestamps
+            t.timestamps null: false
           end
 
           create_table :copyable_vehicles, force: true do |t|
             t.string  :name
             t.integer :copyable_owner_id
-            t.timestamps
+            t.timestamps null: false
           end
 
           create_table :copyable_warranties, force: true do |t|
             t.string   :name
             t.integer  :copyable_amenity_id
-            t.timestamps
+            t.timestamps null: false
           end
 
         end

data/spec/model_hooks_spec.rb

@@ -9,85 +9,31 @@ describe Copyable::ModelHooks do
       before(:each) do
         Copyable::ModelHooks.disable!(CopyableTree)
       end
+
       after(:each) do
         Copyable::ModelHooks.reenable!(CopyableTree)
       end
-      it 'should prevent callbacks from executing' do
-        expect {
-          CopyableTree.create!(kind: 'magnolia')
-        }.to_not raise_error
+
+      it 'defines an instance variable on the class' do
+        expect(CopyableTree.all_callbacks_disabled).to eq(true)
       end
+
       it 'should not prevent model actions from executing' do
         expect(CopyableTree.count).to eq(0)
-        CopyableTree.create!(kind: 'magnolia')
-        expect(CopyableTree.count).to eq(1)
       end
     end
 
     describe '.reenable!' do
-      it 'should allow callbacks to execute again' do
-        Copyable::ModelHooks.disable!(CopyableTree)
+      it 'defines an instance variable on the class' do
         Copyable::ModelHooks.reenable!(CopyableTree)
-        expect {
-          CopyableTree.create!(kind: 'magnolia')
-        }.to raise_error(RuntimeError, "callback2 called")
+        expect(CopyableTree.all_callbacks_disabled).to eq(false)
       end
-    end
-  end
-
-  context 'validations' do
 
-    # Note: the relevant model and observer class is defined in helper/test_models.rb
-
-    describe '.disable!' do
-      before(:each) do
-        Copyable::ModelHooks.disable!(CopyableCoin)
-      end
-      after(:each) do
-        Copyable::ModelHooks.reenable!(CopyableCoin)
-      end
-      it 'should prevent validations from executing' do
-        expect {
-          CopyableCoin.create!(year: -10)
-        }.to_not raise_error
-      end
-      it 'should not prevent model actions from executing' do
-        expect(CopyableCoin.count).to eq(0)
-        CopyableCoin.create!(year: -10)
-        expect(CopyableCoin.count).to eq(1)
-      end
-    end
-
-    describe '.reenable!' do
-      it 'should allow validations to execute again' do
-        Copyable::ModelHooks.disable!(CopyableCoin)
-        Copyable::ModelHooks.reenable!(CopyableCoin)
+      it 'should allow callbacks to execute again' do
         expect {
-          CopyableCoin.create!(year: -10)
-        }.to raise_error(ActiveRecord::RecordInvalid)
+          CopyableTree.create!(kind: 'magnolia')
+        }.to raise_error(RuntimeError, "callback2 called")
       end
     end
   end
-
-  describe 'nested disables and enables' do
-    it 'should allow callbacks to execute again' do
-      Copyable::ModelHooks.disable!(CopyableTree)
-      expect { CopyableTree.create!(kind: 'magnolia') }.to_not raise_error
-
-      Copyable::ModelHooks.disable!(CopyableCoin)
-      expect { CopyableCoin.create!(year: -10) }.to_not raise_error
-
-      Copyable::ModelHooks.disable!(CopyableTree)
-      expect { CopyableTree.create!(kind: 'magnolia') }.to_not raise_error
-
-      Copyable::ModelHooks.reenable!(CopyableCoin)
-      expect { CopyableCoin.create!(year: -10) }.to raise_error(ActiveRecord::RecordInvalid)
-
-      Copyable::ModelHooks.reenable!(CopyableTree)
-      expect { CopyableTree.create!(kind: 'magnolia') }.to raise_error(RuntimeError)
-
-      Copyable::ModelHooks.reenable!(CopyableTree)
-      expect { CopyableTree.create!(kind: 'magnolia') }.to raise_error(RuntimeError)
-    end
-  end
 end

metadata

@@ -1,58 +1,60 @@
 --- !ruby/object:Gem::Specification
 name: copyable
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.2
 platform: ruby
 authors:
 - Wyatt Greene
 - Dennis Chan
-autorequire: 
+- Anne Geiersbach
+- Parker Morse
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-03-14 00:00:00.000000000 Z
+date: 2021-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 5.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 5.2.6
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -85,19 +87,21 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.6
 description: Copyable makes it easy to copy ActiveRecord models.
 email:
-- dchan@dmcouncil.org
+- dchan@dmgroupK12.com
+- ageiersbach@dmgroupK12.com
+- pmorse@dmgroupK12.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -158,7 +162,7 @@ homepage: https://github.com/dmcouncil/copyable
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -173,9 +177,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: ActiveRecord copier
 test_files: