userstamper 4.0.0

data/spec/lib/migration_spec.rb

@@ -0,0 +1,60 @@
+require 'rails_helper'
+
+RSpec.describe 'Migration helpers', type: :model do
+  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
+    end
+  end
+
+  context 'when overridden attribute names are used' do
+    before(:each) do
+      Userstamper.configure do |config|
+        config.creator_attribute = :created_by
+        config.updater_attribute = :updated_by
+      end
+      class self.class::OverriddenRandom < ActiveRecord::Base
+        stampable
+      end
+    end
+    after(:each) do
+      Userstamper.configure do |config|
+        config.creator_attribute = :creator_id
+        config.updater_attribute = :updater_id
+      end
+    end
+
+    subject { self.class::OverriddenRandom.new }
+
+    temporary_table(:overridden_randoms) do |t|
+      t.userstamps
+    end
+
+    with_temporary_table(:overridden_randoms, :each) 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
+    end
+  end
+end

data/spec/lib/stamper_spec.rb

@@ -0,0 +1,66 @@
+require 'rails_helper'
+
+RSpec.describe 'Stamper' do
+  describe '.model_stamper' do
+    it 'can only be included once' do
+      expect(User.singleton_class.included_modules.count(
+        Userstamper::Stamper::InstanceMethods)).to eq(1)
+
+      User.class_eval do
+        stamper
+      end
+
+      expect(User.singleton_class.included_modules.count(
+        Userstamper::Stamper::InstanceMethods)).to eq(1)
+    end
+  end
+
+  describe '.stamper' do
+    it 'defaults to nil' do
+      User.reset_stamper
+      expect(User.stamper).to be_nil
+    end
+  end
+
+  describe '.stamper=' do
+    it 'assigns the stamper' do
+      stamper = User.new
+      User.stamper = stamper
+      expect(User.stamper).to eq(stamper)
+    end
+
+    context 'when the stamper is nil' do
+      it 'resets the stamper' do
+        User.stamper = nil
+        expect(User.stamper).to be(nil)
+      end
+    end
+  end
+
+  describe '.reset_stamper' do
+    it 'resets the stamper' do
+      User.reset_stamper
+      expect(User.stamper).to be_nil
+    end
+  end
+
+  describe '.with_stamper' do
+    context 'when within the block' do
+      it 'uses the correct stamper' do
+        stamper = User.create(name: 'Joel')
+        User.with_stamper(stamper) do
+          expect(User.stamper).to eq(stamper)
+        end
+      end
+    end
+
+    context 'when exiting the block' do
+      it 'restores the stamper' do
+        expect do
+          User.with_stamper(User.create(name: 'Joel')) do
+          end
+        end.not_to change { User.stamper }
+      end
+    end
+  end
+end

data/spec/lib/stamping_spec.rb

@@ -0,0 +1,235 @@
+require 'rails_helper'
+
+RSpec.describe 'Stamping', type: :model do
+  before(:each) do
+    define_first_post
+    User.stamper = @zeus
+    Person.stamper = @delynn
+  end
+
+  context 'when creating a Person' do
+    context 'when the stamper is an object' do
+      it 'sets using the the association' do
+        User.stamper = @zeus
+        expect(User.stamper).to eq(@zeus)
+
+        person = Person.new
+        expect(person).to receive(:creator=)
+        person.valid?
+      end
+
+      it 'sets the correct creator and updater' do
+        expect(User.stamper).to eq(@zeus)
+
+        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)
+
+          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
+
+        it 'does not reset the creator' do
+          expect(User.stamper).to eq(@zeus)
+
+          person = Person.create(name: 'David', creator_id: @hera.id)
+          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)
+
+          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)
+
+          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 using the the association ID' do
+        User.stamper = @zeus.id
+        expect(User.stamper).to eq(@zeus.id)
+
+        person = Person.new
+        expect(person).to receive(:creator_id=)
+        person.valid?
+      end
+
+      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)
+
+        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)
+
+        @delynn.name = @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 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 = @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 temporarily disabling stamping' do
+      it 'does not set the updater' do
+        User.stamper = @zeus
+        expect(User.stamper).to eq(@zeus)
+
+        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 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 = @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)
+
+        @first_post.title = @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 using a generated model' do
+    it 'does not query the model on the columns' do
+      class self.class::Post2 < Post
+      end
+      allow(self.class::Post2).to receive(:column_names).and_raise(StandardError)
+
+      class self.class::Post2
+        has_and_belongs_to_many :tags
+      end
+    end
+  end
+
+  context 'when using an anonymous model' do
+    it 'does not query the model on the columns' do
+      post_3_class = Class.new(ActiveRecord::Base) do
+        def self.table_name
+          'Post'
+        end
+      end
+      expect(post_3_class.table_name).not_to be_empty
+    end
+  end
+end

data/spec/lib/userstamp_spec.rb

@@ -0,0 +1,4 @@
+require 'rails_helper'
+
+RSpec.describe Userstamper do
+end

data/spec/rails_helper.rb

@@ -0,0 +1,7 @@
+ENV['RAILS_ENV'] ||= 'test'
+require 'spec_helper'
+
+require File.expand_path('dummy/config/environment.rb', __dir__)
+require 'rspec/rails'
+
+Dir[__dir__ + '/support/**/*'].each { |f| require f if File.file?(f) }

data/spec/spec_helper.rb

@@ -0,0 +1,98 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'bundler/setup'
+require 'pry'
+Bundler.setup
+
+require 'coverage_helper'
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end