copyable 0.0.1

data/spec/helper/test_tables.rb

@@ -0,0 +1,135 @@
+module Copyable
+  class TestTables
+
+    def self.create!
+      return if @already_created_tables
+      ActiveRecord::Migration.class_eval do
+        suppress_messages do
+
+          # All tables are prefaced with "copyable_" to avoid name collisions
+          # with other tables in the test database.
+
+          create_table :copyable_albums, force: true do |t|
+            t.string :name, null: false
+            t.timestamps
+          end
+
+          create_table :copyable_amenities, force: true do |t|
+            t.string   :name
+            t.integer  :copyable_vehicle_id
+            t.integer  :copyable_owner_id
+            t.timestamps
+          end
+
+          create_table :copyable_addresses, force: true do |t|
+            t.string   :address1,                 null: false
+            t.string   :address2
+            t.string   :city,                     null: false
+            t.string   :state,                    null: false
+            t.integer  :copyable_pet_profile_id,  null: false
+            t.timestamps
+          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
+          end
+
+          create_table :copyable_coins, force: true do |t|
+            t.string  :kind
+            t.integer :year
+            t.timestamps
+          end
+
+          create_table :copyable_owners, force: true do |t|
+            t.string :name, null: false
+            t.timestamps
+          end
+
+          create_table :copyable_pet_foods, force: true do |t|
+            t.string :name, null: false
+            t.timestamps
+          end
+
+          create_table :copyable_pet_foods_pets, force: true, id: false do |t|
+            t.integer :copyable_pet_id,      null: false
+            t.integer :copyable_pet_food_id, null: false
+          end
+
+          create_table :copyable_pet_profiles, force: true do |t|
+            t.string   :description,     null: false
+            t.string   :nickname
+            t.integer  :copyable_pet_id, null: false
+            t.timestamps
+          end
+
+          create_table :copyable_pet_sitters, force: true do |t|
+            t.string  :name, null: false
+            t.timestamps
+          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
+          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
+          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
+          end
+
+          create_table :copyable_pictures, force: true do |t|
+            t.string  :name
+            t.integer :imageable_id
+            t.string  :imageable_type
+            t.integer :picture_album_id
+            t.timestamps
+          end
+
+          create_table :copyable_products, force: true do |t|
+            t.string  :name
+            t.timestamps
+          end
+
+          create_table :copyable_toys, force: true do |t|
+            t.string   :name
+            t.string   :kind
+            t.integer  :copyable_pet_id
+            t.timestamps
+          end
+
+          create_table :copyable_trees, force: true do |t|
+            t.string  :kind
+            t.timestamps
+          end
+
+          create_table :copyable_vehicles, force: true do |t|
+            t.string  :name
+            t.integer :copyable_owner_id
+            t.timestamps
+          end
+
+          create_table :copyable_warranties, force: true do |t|
+            t.string   :name
+            t.integer  :copyable_amenity_id
+            t.timestamps
+          end
+
+        end
+      end
+      @already_created_tables = true
+    end
+
+  end
+end

data/spec/model_hooks_spec.rb

@@ -0,0 +1,66 @@
+require_relative 'helper/copyable_spec_helper'
+
+describe Copyable::ModelHooks do
+  context 'callbacks' do
+
+    # Note: the relevant callbacks are defined in CopyableTree in helper/test_models.rb
+
+    describe '.disable!' do
+      before(:each) do
+        puts "Dennis before!"
+        Copyable::ModelHooks.disable!(CopyableTree)
+      end
+      after(:each) do
+        puts "Dennis after"
+        Copyable::ModelHooks.reenable!(CopyableTree)
+      end
+      it 'should prevent callbacks from executing' do
+        puts "Dennis 1"
+        expect {
+          tree = CopyableTree.create!(kind: 'magnolia')
+        }.to_not raise_error
+        puts "Dennis 2"
+      end
+      it 'should not prevent model actions from executing' do
+        puts "Dennis 4"
+        expect(CopyableTree.count).to eq(0)
+        tree = 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)
+        Copyable::ModelHooks.reenable!(CopyableTree)
+        expect {
+          tree = CopyableTree.create!(kind: 'magnolia')
+        }.to raise_error(RuntimeError, "callback2 called")
+      end
+    end
+  end
+
+  context 'observers' do
+
+    # Note: the relevant model and observer class is defined in helper/test_models.rb
+
+    describe '.disable!' do
+      before(:each) do
+        Copyable::ModelHooks.disable!(CopyableCar)
+      end
+      after(:each) do
+        Copyable::ModelHooks.reenable!(CopyableCar)
+      end
+      it 'should prevent observers from executing' do
+        expect {
+          car = CopyableCar.create!(make: 'Ferrari', model: 'California', year: 2009)
+        }.to_not raise_error
+      end
+      it 'should not prevent model actions from executing' do
+        expect(CopyableCar.count).to eq(0)
+        car = CopyableCar.create!(make: 'Ferrari', model: 'California', year: 2009)
+        expect(CopyableCar.count).to eq(1)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'active_support/all'
+require 'active_support/testing/time_helpers'
+require 'database_cleaner'
+
+Bundler.require(:default, :test)
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+
+RSpec.configure do |config|
+
+  config.before(:suite) do
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.append_after(:each) do
+    DatabaseCleaner.clean
+  end
+
+end
+

data/spec/stress_test_spec.rb

@@ -0,0 +1,261 @@
+require_relative 'helper/copyable_spec_helper'
+
+describe 'a model hierarchy with lots of variations in copyable behavior' do
+  before(:each) do
+
+    #***************************************************************************
+    #  Define all of the copyable declarations.
+
+    undefine_copyable_in CopyablePet
+    class CopyablePet < ActiveRecord::Base
+      copyable do
+        disable_all_callbacks_and_observers_except_validate
+        columns({
+          name:        :copy,
+          kind:        :copy,
+          birth_year:  lambda { |orig| orig.birth_year + 1 },
+        })
+        associations({
+          copyable_toys:                    :do_not_copy,
+          copyable_pet_tag:                 :copy,
+          copyable_pet_profile:             :copy,
+          copyable_pet_foods:               :copy_only_habtm_join_records,
+          copyable_pet_sitting_patronages:  :copy,
+        })
+      end
+    end
+
+    undefine_copyable_in CopyableToy
+    class CopyableToy < ActiveRecord::Base
+      copyable do
+        disable_all_callbacks_and_observers_except_validate
+        columns({
+          name:             :copy,
+          kind:             :copy,
+          copyable_pet_id:  :copy,
+        })
+        associations({
+        })
+      end
+    end
+
+    undefine_copyable_in CopyablePetTag
+    class CopyablePetTag < ActiveRecord::Base
+      copyable do
+        disable_all_callbacks_and_observers_except_validate
+        columns({
+          registered_name:  :copy,
+          copyable_pet_id:  :copy,
+        })
+        associations({
+        })
+      end
+    end
+
+    undefine_copyable_in CopyablePetFood
+    class CopyablePetFood < ActiveRecord::Base
+      copyable do
+        disable_all_callbacks_and_observers_except_validate
+        columns({
+          name:  :copy,
+        })
+        associations({
+          copyable_pets:  :copy_only_habtm_join_records,
+        })
+      end
+    end
+
+    undefine_copyable_in CopyablePetSitter
+    class CopyablePetSitter < ActiveRecord::Base
+      copyable do
+        disable_all_callbacks_and_observers_except_validate
+        columns({
+          name:  :copy,
+        })
+        associations({
+          copyable_pet_sitting_patronages:  :copy,
+        })
+        after_copy do |original_model, new_model|
+          new_model.name = new_model.name + '*'
+          new_model.save!
+        end
+      end
+    end
+
+    undefine_copyable_in CopyablePetSittingPatronage
+    class CopyablePetSittingPatronage < ActiveRecord::Base
+      copyable do
+        disable_all_callbacks_and_observers_except_validate
+        columns({
+          copyable_pet_id:        :copy,
+          copyable_pet_sitter_id: :copy,
+        })
+        associations({
+        })
+      end
+    end
+
+    undefine_copyable_in CopyablePetProfile
+    class CopyablePetProfile < ActiveRecord::Base
+      copyable do
+        disable_all_callbacks_and_observers_except_validate
+        columns({
+          description:      lambda { |orig| 'overwrite' },
+          nickname:         :do_not_copy,
+          copyable_pet_id:  :copy,
+        })
+        associations({
+          copyable_address:  :copy,
+        })
+      end
+    end
+
+    undefine_copyable_in CopyableAddress
+    class CopyableAddress < ActiveRecord::Base
+      copyable do
+        disable_all_callbacks_and_observers_except_validate
+        columns({
+          address1:                 :copy,
+          address2:                 :copy,
+          city:                     :copy,
+          state:                    :copy,
+          copyable_pet_profile_id:  :copy,
+        })
+        associations({
+        })
+      end
+    end
+
+    #***************************************************************************
+    #  Create the models.
+
+    # foods
+    @chow_mix = CopyablePetFood.create!(name: 'chow mix')
+    @mushy_food = CopyablePetFood.create!(name: 'mushy food')
+    @meal_scraps = CopyablePetFood.create!(name: 'meal scraps')
+
+    # sitters
+    @marty = CopyablePetSitter.create!(name: 'Martin Luther King, Jr.')
+    @bob = CopyablePetSitter.create!(name: 'Robert Frost')
+    @bubba = CopyablePetSitter.create!(name: 'William Jefferson Clinton')
+
+    # Rover
+    @rover = CopyablePet.create!(
+      name: 'Rover',
+      kind: 'canine',
+      birth_year: 2009)
+    @plastic_bone = CopyableToy.create!(
+      name: 'favorite bone',
+      kind: 'plastic squeaky toy',
+      copyable_pet: @rover)
+    @rovers_tag = CopyablePetTag.create!(
+      registered_name: 'Rover McSmith #3872D',
+      copyable_pet: @rover)
+    @rovers_profile = CopyablePetProfile.create!(
+      description: 'part Dachshund, part Great Dane, totally badass',
+      nickname: 'Wubby Wubby Roverkins',
+      copyable_pet: @rover)
+    @rovers_address = CopyableAddress.create!(
+      address1: '5 Maple St',
+      city: 'Mapleton',
+      state: 'MA',
+      copyable_pet_profile: @rovers_profile)
+    @rover_bubba_patronage = CopyablePetSittingPatronage.create!(
+      copyable_pet: @rover,
+      copyable_pet_sitter: @bubba)
+    @rover.copyable_pet_foods << @chow_mix
+    @rover.copyable_pet_foods << @meal_scraps
+
+    # Toonces
+    @toonces = CopyablePet.create!(
+      name: 'toonces',
+      kind: 'feline',
+      birth_year: 2005)
+    @yarn = CopyableToy.create!(
+      name: 'red yarn',
+      kind: 'just yarn',
+      copyable_pet: @toonces)
+    @toonces_tag = CopyablePetTag.create!(
+      registered_name: 'Toonces McSmith #3879F',
+      copyable_pet: @toonces)
+    @toonces_profile = CopyablePetProfile.create!(
+      description: 'really bad driver',
+      nickname: '*$#!',
+      copyable_pet: @toonces)
+    @tooncess_address = CopyableAddress.create!(
+      address1: '5 Maple St #2',
+      city: 'Mapleton',
+      state: 'MA',
+      copyable_pet_profile: @toonces_profile)
+    @toonces_bubba_patronage = CopyablePetSittingPatronage.create!(
+      copyable_pet: @toonces,
+      copyable_pet_sitter: @bubba)
+    @toonces_marty_patronage = CopyablePetSittingPatronage.create!(
+      copyable_pet: @toonces,
+      copyable_pet_sitter: @marty)
+    @toonces.copyable_pet_foods << @mushy_food
+  end
+
+  it 'should copy without error' do
+    expect {
+      @rover.create_copy!
+      @toonces.create_copy!
+    }.to_not raise_error
+  end
+
+  it 'should not copy toys' do
+    expect(CopyableToy.count).to eq(2)
+    @rover.create_copy!
+    @toonces.create_copy!
+    expect(CopyableToy.count).to eq(2)
+  end
+
+  it 'should not copy pet profile nickname' do
+    copied_rover = @rover.create_copy!
+    expect(copied_rover.copyable_pet_profile.nickname).to be_nil
+  end
+
+  it 'should not copy pet sitters when copying pets' do
+    expect(CopyablePetSitter.count).to eq(3)
+    @rover.create_copy!
+    @toonces.create_copy!
+    expect(CopyablePetSitter.count).to eq(3)
+  end
+
+  it 'should add a * to the pet sitter name after copying' do
+    expect(@marty.create_copy!.name).to eq('Martin Luther King, Jr.*')
+    expect(@bob.create_copy!.name).to eq('Robert Frost*')
+  end
+
+  it 'should allow columns to be overriden' do
+    copied_rover = @rover.create_copy!(
+      override: {
+        name: 'overridden name',
+        kind: 'overridden kind',
+        birth_year: 1900 })
+    expect(copied_rover.name).to eq('overridden name')
+    expect(copied_rover.kind).to eq('overridden kind')
+    expect(copied_rover.birth_year).to eq(1900)
+  end
+
+  it 'should allow multiple copying' do
+    expect {
+      3.times { @rover.create_copy! }
+    }.to_not raise_error
+  end
+
+  it 'should have exactly the expected records after copying' do
+    @rover.create_copy!
+    expect(CopyablePet.count).to eq(3)
+    expect(CopyablePet.where(name: 'Rover').count).to eq(2)
+    expect(CopyableToy.count).to eq(2)
+    expect(CopyablePetTag.count).to eq(3)
+    expect(CopyablePetTag.where(registered_name: 'Rover McSmith #3872D').count).to eq(2)
+    expect(CopyablePetFood.count).to eq(3)
+    expect(CopyablePetSitter.count).to eq(3)
+    expect(CopyablePetSittingPatronage.count).to eq(4)
+    expect(CopyablePetProfile.count).to eq(3)
+    expect(CopyableAddress.count).to eq(3)
+    expect(CopyableAddress.where(address1: '5 Maple St').count).to eq(2)
+  end
+end