activerecord-userstamp 2.1.1 → 3.0.0

data/spec/lib/configuration_spec.rb

@@ -0,0 +1,20 @@
+require 'rails_helper'
+
+RSpec.describe 'Configuration' do
+  describe '.configure' do
+    it 'yields a block with the config argument' do
+      block = nil
+      ActiveRecord::Userstamp.configure do |config|
+        block = config
+      end
+      expect(block).to be(ActiveRecord::Userstamp::Configuration)
+    end
+  end
+
+  describe '.config' do
+    it 'matches default_stamper and default_stamper_class' do
+      config = ActiveRecord::Userstamp.config
+      expect(config.default_stamper_class.name).to eq(config.default_stamper)
+    end
+  end
+end

data/spec/lib/migration_spec.rb

@@ -1,26 +1,69 @@
 require 'rails_helper'
 
 RSpec.describe 'Migration helpers', type: :model do
-  class self::Random < ActiveRecord::Base
-    stampable
+  after do
+    ActiveRecord::Userstamp.configure do |config|
+      config.creator_attribute = :creator_id
+      config.updater_attribute = :updater_id
+      config.deleter_attribute = :deleter_id
+    end
   end
-  subject { self.class::Random.new }
 
-  temporary_table(:randoms) do |t|
-    t.userstamps
+  context 'when default attribute names are used' do
+    class self::DefaultRandom < ActiveRecord::Base
+      stampable
+    end
+    subject { self.class::DefaultRandom.new }
+
+    temporary_table(:default_randoms) do |t|
+      t.userstamps(null: false)
+    end
+
+    with_temporary_table(:default_randoms) do
+      it 'has a creator_id association' do
+        expect(subject.has_attribute?(:creator_id)).to be true
+        expect(subject.class.columns.find {|c| c.name == 'creator_id' }.null).to be false
+      end
+
+      it 'has an updater_id association' do
+        expect(subject.has_attribute?(:updater_id)).to be true
+        expect(subject.class.columns.find {|c| c.name == 'updater_id' }.null).to be false
+      end
+
+      it 'has a deleter_id association' do
+        expect(subject.has_attribute?(:deleter_id)).to be true
+        expect(subject.class.columns.find {|c| c.name == 'deleter_id' }.null).to be false
+      end
+    end
   end
 
-  with_temporary_table(:randoms) do
-    it 'has a creator_id association' do
-      expect(subject.has_attribute?(:creator_id)).to be true
+  context 'when overridden attribute names are used' do
+    class self::OverriddenRandom < ActiveRecord::Base
+      stampable
     end
+    subject { self.class::OverriddenRandom.new }
 
-    it 'has an updater_id association' do
-      expect(subject.has_attribute?(:updater_id)).to be true
+    temporary_table(:overridden_randoms) do |t|
+      ActiveRecord::Userstamp.configure do |config|
+        config.creator_attribute = :created_by
+        config.updater_attribute = :updated_by
+        config.deleter_attribute = :deleted_by
+      end
+      t.userstamps
     end
 
-    it 'has a deleter_id association' do
-      expect(subject.has_attribute?(:deleter_id)).to be false
+    with_temporary_table(:overridden_randoms) do
+      it 'has a created_by attribute' do
+        expect(subject.has_attribute?(:created_by)).to be true
+      end
+
+      it 'has an updated_by attribute' do
+        expect(subject.has_attribute?(:updated_by)).to be true
+      end
+
+      it 'has a deleted_by attribute' do
+        expect(subject.has_attribute?(:deleted_by)).to be true
+      end
     end
   end
 end

data/spec/lib/stamping_spec.rb

@@ -1,170 +1,210 @@
-require 'rails_helper'
-
-RSpec.describe 'Stamping', type: :model do
-  before(:each) do
-    reset_to_defaults
-    User.stamper = @zeus
-    Person.stamper = @delynn
-  end
-
-  context 'when creating a Person' do
-    context 'when the stamper is an object' do
-      it 'sets the correct creator and updater' do
-        expect(User.stamper).to eq(@zeus.id)
-
-        person = Person.create(:name => "David")
-        expect(person.creator_id).to eq(@zeus.id)
-        expect(person.updater_id).to eq(@zeus.id)
-        expect(person.creator).to eq(@zeus)
-        expect(person.updater).to eq(@zeus)
-      end
-    end
-
-    context 'when the stamper is an ID' do
-      it 'sets the correct creator and updater' do
-        User.stamper = @hera.id
-        expect(User.stamper).to eq(@hera.id)
-
-        person = Person.create(:name => "Daniel")
-        expect(person.creator_id).to eq(@hera.id)
-        expect(person.updater_id).to eq(@hera.id)
-        expect(person.creator).to eq(@hera)
-        expect(person.updater).to eq(@hera)
-      end
-    end
-  end
-
-  context 'when creating a Post' do
-    context 'when the stamper is an object' do
-      it 'sets the correct creator and updater' do
-        expect(Person.stamper).to eq(@delynn.id)
-
-        post = Post.create(:title => "Test Post - 1")
-        expect(post.creator_id).to eq(@delynn.id)
-        expect(post.updater_id).to eq(@delynn.id)
-        expect(post.creator).to eq(@delynn)
-        expect(post.updater).to eq(@delynn)
-      end
-    end
-
-    context 'when the stamper is an ID' do
-      it 'sets the correct creator and updater' do
-        Person.stamper = @nicole.id
-        expect(Person.stamper).to eq(@nicole.id)
-
-        post = Post.create(:title => "Test Post - 2")
-        expect(post.creator_id).to eq(@nicole.id)
-        expect(post.updater_id).to eq(@nicole.id)
-        expect(post.creator).to eq(@nicole)
-        expect(post.updater).to eq(@nicole)
-      end
-    end
-  end
-
-  context 'when updating a Person' do
-    context 'when the stamper is an object' do
-      it 'sets the correct updater' do
-        User.stamper = @hera
-        expect(User.stamper).to eq(@hera.id)
-
-        @delynn.name << " Berry"
-        @delynn.save
-        @delynn.reload
-        expect(@delynn.creator).to eq(@zeus)
-        expect(@delynn.updater).to eq(@hera)
-        expect(@delynn.creator_id).to eq(@zeus.id)
-        expect(@delynn.updater_id).to eq(@hera.id)
-      end
-    end
-  end
-
-  context 'when the stamper is an ID' do
-    it 'sets the correct updater' do
-      User.stamper = @hera.id
-      expect(User.stamper).to eq(@hera.id)
-
-      @delynn.name << " Berry"
-      @delynn.save
-      @delynn.reload
-      expect(@delynn.creator_id).to eq(@zeus.id)
-      expect(@delynn.updater_id).to eq(@hera.id)
-      expect(@delynn.creator).to eq(@zeus)
-      expect(@delynn.updater).to eq(@hera)
-    end
-  end
-
-  context 'when updating a Post' do
-    context 'when the stamper is an ID' do
-      it 'sets the correct updater' do
-        Person.stamper = @nicole.id
-        expect(Person.stamper).to eq(@nicole.id)
-
-        @first_post.title << " - Updated"
-        @first_post.save
-        @first_post.reload
-        expect(@first_post.creator_id).to eq(@delynn.id)
-        expect(@first_post.updater_id).to eq(@nicole.id)
-        expect(@first_post.creator).to eq(@delynn)
-        expect(@first_post.updater).to eq(@nicole)
-      end
-    end
-
-    context 'when the stamper is an object' do
-      it 'sets the correct updater' do
-        Person.stamper = @nicole
-        expect(Person.stamper).to eq(@nicole.id)
-
-        @first_post.title << " - Updated"
-        @first_post.save
-        @first_post.reload
-        expect(@first_post.creator_id).to eq(@delynn.id)
-        expect(@first_post.updater_id).to eq(@nicole.id)
-        expect(@first_post.creator).to eq(@delynn)
-        expect(@first_post.updater).to eq(@nicole)
-      end
-    end
-  end
-
-  context 'when destroying a Post' do
-    context 'when the stamper is an ID' do
-      it 'sets the deleter' do
-        expect(@first_post.deleted_at).to be_nil
-
-        Person.stamper = @nicole.id
-        expect(Person.stamper).to eq(@nicole.id)
-
-        @first_post.destroy
-        @first_post.save
-        @first_post.reload
-
-        expect(@first_post.deleted_at).to be_present
-        expect(@first_post.deleter_id).to eq(@nicole.id)
-      end
-    end
-  end
-
-  context 'when no deleter column is present' do
-    it 'does not create a deleter relation' do
-      expect(@delynn.respond_to?('creator')).to eq(true)
-      expect(@delynn.respond_to?('updater')).to eq(true)
-      expect(@delynn.respond_to?('deleter')).to eq(false)
-    end
-  end
-
-  context 'when a deleter column is present' do
-    it 'creates a deleter relation' do
-      expect(@first_post.respond_to?('creator')).to eq(true)
-      expect(@first_post.respond_to?('updater')).to eq(true)
-      expect(@first_post.respond_to?('deleter')).to eq(true)
-    end
-  end
-
-  context 'when the deleter attribute is explicitly set' do
-    it 'creates a deleter relation' do
-      @foo = Foo.create
-      expect(@foo.respond_to?('creator')).to eq(true)
-      expect(@foo.respond_to?('updater')).to eq(true)
-      expect(@foo.respond_to?('deleter')).to eq(true)
-    end
-  end
-end
+require 'rails_helper'
+
+RSpec.describe 'Stamping', type: :model do
+  before(:each) do
+    reset_to_defaults
+    User.stamper = @zeus
+    Person.stamper = @delynn
+  end
+
+  context 'when creating a Person' do
+    context 'when the stamper is an object' do
+      it 'sets the correct creator and updater' do
+        expect(User.stamper).to eq(@zeus.id)
+
+        person = Person.create(name: 'David')
+        expect(person.creator_id).to eq(@zeus.id)
+        expect(person.updater_id).to eq(@zeus.id)
+        expect(person.creator).to eq(@zeus)
+        expect(person.updater).to eq(@zeus)
+      end
+
+      context 'when a creator is specified' do
+        it 'does not reset the creator' do
+          expect(User.stamper).to eq(@zeus.id)
+
+          person = Person.create(name: 'David', creator: @hera)
+          expect(person.creator_id).to eq(@hera.id)
+          expect(person.updater_id).to eq(@zeus.id)
+          expect(person.creator).to eq(@hera)
+          expect(person.updater).to eq(@zeus)
+        end
+      end
+
+      context 'when saving without validations' do
+        it 'sets the correct creator and updater' do
+          expect(User.stamper).to eq(@zeus.id)
+
+          person = Person.new(name: 'David')
+          person.save(validate: false)
+          expect(person.creator_id).to eq(@zeus.id)
+          expect(person.updater_id).to eq(@zeus.id)
+          expect(person.creator).to eq(@zeus)
+          expect(person.updater).to eq(@zeus)
+        end
+      end
+
+      context 'when temporarily disabling stampng' do
+        it 'does not set the creator and updater' do
+          expect(User.stamper).to eq(@zeus.id)
+
+          Person.without_stamps do
+            person = Person.create(name: 'David')
+            expect(person.creator_id).to be_nil
+            expect(person.updater_id).to be_nil
+            expect(person.creator).to be_nil
+            expect(person.updater).to be_nil
+          end
+        end
+      end
+    end
+
+    context 'when the stamper is an ID' do
+      it 'sets the correct creator and updater' do
+        User.stamper = @hera.id
+        expect(User.stamper).to eq(@hera.id)
+
+        person = Person.create(name: 'Daniel')
+        expect(person.creator_id).to eq(@hera.id)
+        expect(person.updater_id).to eq(@hera.id)
+        expect(person.creator).to eq(@hera)
+        expect(person.updater).to eq(@hera)
+      end
+    end
+  end
+
+  context 'when creating a Post' do
+    context 'when the stamper is an object' do
+      it 'sets the correct creator and updater' do
+        expect(Person.stamper).to eq(@delynn.id)
+
+        post = Post.create(title: 'Test Post - 1')
+        expect(post.creator_id).to eq(@delynn.id)
+        expect(post.updater_id).to eq(@delynn.id)
+        expect(post.creator).to eq(@delynn)
+        expect(post.updater).to eq(@delynn)
+      end
+    end
+
+    context 'when the stamper is an ID' do
+      it 'sets the correct creator and updater' do
+        Person.stamper = @nicole.id
+        expect(Person.stamper).to eq(@nicole.id)
+
+        post = Post.create(title: 'Test Post - 2')
+        expect(post.creator_id).to eq(@nicole.id)
+        expect(post.updater_id).to eq(@nicole.id)
+        expect(post.creator).to eq(@nicole)
+        expect(post.updater).to eq(@nicole)
+      end
+    end
+  end
+
+  context 'when updating a Person' do
+    context 'when the stamper is an object' do
+      it 'sets the correct updater' do
+        User.stamper = @hera
+        expect(User.stamper).to eq(@hera.id)
+
+        @delynn.name << " Berry"
+        @delynn.save
+        @delynn.reload
+        expect(@delynn.creator).to eq(@zeus)
+        expect(@delynn.updater).to eq(@hera)
+        expect(@delynn.creator_id).to eq(@zeus.id)
+        expect(@delynn.updater_id).to eq(@hera.id)
+      end
+    end
+
+    context 'when temporarily disabling stamping' do
+      it 'does not set the updater' do
+        User.stamper = @zeus
+        expect(User.stamper).to eq(@zeus.id)
+
+        original_updater = @delynn.updater
+        Person.without_stamps do
+          @delynn.name << " Berry"
+          @delynn.save
+          @delynn.reload
+          expect(@delynn.creator).to eq(@zeus)
+          expect(@delynn.updater).to eq(original_updater)
+          expect(@delynn.creator_id).to eq(@zeus.id)
+          expect(@delynn.updater_id).to eq(original_updater.id)
+        end
+      end
+    end
+  end
+
+  context 'when the stamper is an ID' do
+    it 'sets the correct updater' do
+      User.stamper = @hera.id
+      expect(User.stamper).to eq(@hera.id)
+
+      @delynn.name << " Berry"
+      @delynn.save
+      @delynn.reload
+      expect(@delynn.creator_id).to eq(@zeus.id)
+      expect(@delynn.updater_id).to eq(@hera.id)
+      expect(@delynn.creator).to eq(@zeus)
+      expect(@delynn.updater).to eq(@hera)
+    end
+  end
+
+  context 'when updating a Post' do
+    context 'when the stamper is an ID' do
+      it 'sets the correct updater' do
+        Person.stamper = @nicole.id
+        expect(Person.stamper).to eq(@nicole.id)
+
+        @first_post.title << " - Updated"
+        @first_post.save
+        @first_post.reload
+        expect(@first_post.creator_id).to eq(@delynn.id)
+        expect(@first_post.updater_id).to eq(@nicole.id)
+        expect(@first_post.creator).to eq(@delynn)
+        expect(@first_post.updater).to eq(@nicole)
+      end
+    end
+
+    context 'when the stamper is an object' do
+      it 'sets the correct updater' do
+        Person.stamper = @nicole
+        expect(Person.stamper).to eq(@nicole.id)
+
+        @first_post.title << " - Updated"
+        @first_post.save
+        @first_post.reload
+        expect(@first_post.creator_id).to eq(@delynn.id)
+        expect(@first_post.updater_id).to eq(@nicole.id)
+        expect(@first_post.creator).to eq(@delynn)
+        expect(@first_post.updater).to eq(@nicole)
+      end
+    end
+  end
+
+  context 'when destroying a Post' do
+    context 'when the stamper is an ID' do
+      it 'sets the deleter' do
+        expect(@first_post.deleted_at).to be_nil
+
+        Person.stamper = @nicole.id
+        expect(Person.stamper).to eq(@nicole.id)
+
+        @first_post.destroy
+        @first_post.save
+        @first_post.reload
+
+        expect(@first_post.deleted_at).to be_present
+        expect(@first_post.deleter_id).to eq(@nicole.id)
+      end
+    end
+  end
+
+  context 'when a deleter attribute is specified' do
+    it 'creates a deleter relation' do
+      expect(@first_post.respond_to?('creator')).to eq(true)
+      expect(@first_post.respond_to?('updater')).to eq(true)
+      expect(@first_post.respond_to?('deleter')).to eq(true)
+    end
+  end
+end