activerecord-userstamp 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a7867df9eb9d4eea12bdad4a66da1c5412e0593
-  data.tar.gz: b888a7d64f3f13306a2e0cf371775d3e99ba7aba
+  metadata.gz: 56c177f02be82c8c7a1a66cf7b7392d862b25efa
+  data.tar.gz: 7f8d80e37b76903dcc04125b62657355d96e0619
 SHA512:
-  metadata.gz: 91875d1531de92434925a3408e7da73bd84b82a56490d4687409dd68c4169b33aa3e0e616a10f225829fd2257b42e61cfb1cc5a5b2d8957d4c645617bbec5555
-  data.tar.gz: d11f8898d2a39b569a76e9e124f78036a4dbcd2d46f396e1df94256d4861a31232df35b3d5e0cde13249d7a693d3ea1e32628eba13b4978d41f950fd7384da05
+  metadata.gz: ff83831f18094fc7fd05d4f8396b38eae47e1b3d45a180f9909964d6d333fdd660ca420df7d79c0df1cc45c3df7ecf0b500844b84ae0d83d5ad4bfe27429a4e0
+  data.tar.gz: 1b5a4812a59624987bd4a9201b5845ed3a23f7af40c1b7b01bf749dffc2410047e50a841d39786a40d0b50b12412d90417791cc7926ee5874b155d86cd745660

data/.gitignore

@@ -2,3 +2,4 @@
 *.sqlite3
 /.rdoc
 /spec/examples.txt
+/.bundle

data/CHANGELOG.md

@@ -1,4 +1,18 @@
  # Changelog
+ ## 3.0.2 (12-7-2015)
+  * Joel Low          - Depending on what was set to a stamper (ID or record object), the
+                        association ID or association setter is used to assign the
+                        creator/updater/deleter attributes. This only applies if the attributes
+                        end with `_id`; otherwise the attribute would be used verbatim (e.g. the
+                        compatibility mode `created_by`).
+  * Joel Low          - Provide a `with_stamper` method to specify the stamper for a given
+                        stamper class during the execution of the block.
+  * Joel Low          - Ensure that the `set_stamper` and `reset_stamper` calls from the
+                        controller are always paired so that the stamper state is always properly
+                        restored. `set_stamper` and `reset_stamper` is now deprecated and will be
+                        removed in ActiveRecord::Userstamp 3.1 and replaced with a single
+                        `with_stamper` `around_action` callback.
+
  ## 3.0.1 (11-7-2015)
   * Joel Low          - Only declare the creator/updater/deleter associations when the table has
                         the attribute columns. If the columns cannot be determined (e.g. if the

data/lib/active_record/userstamp/controller_additions.rb

@@ -8,26 +8,38 @@ module ActiveRecord::Userstamp::ControllerAdditions
   extend ActiveSupport::Concern
 
   included do
-    before_filter :set_stamper
-    after_filter :reset_stamper
+    around_action :with_stamper
   end
 
   private
 
-  # The +set_stamper+ method as implemented here assumes a couple of things. First, that you are
+  # This {#with_stamper} method sets the stamper for the duration of the action. This ensures
+  # that exceptions raised within the controller action would properly restore the previous stamper.
+  #
+  # TODO: Remove set_stamper/reset_stamper
+  def with_stamper
+    set_stamper
+    yield
+  ensure
+    reset_stamper
+  end
+
+  # The {#set_stamper} method as implemented here assumes a couple of things. First, that you are
   # using a +User+ model as the stamper and second that your controller has a +current_user+
   # method that contains the currently logged in stamper. If either of these are not the case in
   # your application you will want to manually add your own implementation of this method to the
   # private section of your +ApplicationController+
   def set_stamper
+    @_userstamp_stamper = ActiveRecord::Userstamp.config.default_stamper_class.stamper
     ActiveRecord::Userstamp.config.default_stamper_class.stamper = current_user
   end
 
-  # The +reset_stamper+ method as implemented here assumes that a +User+ model is being used as
+  # The {#reset_stamper} method as implemented here assumes that a +User+ model is being used as
   # the stamper. If this is not the case then you will need to manually add your own
   # implementation of this method to the private section of your +ApplicationController+
   def reset_stamper
-    ActiveRecord::Userstamp.config.default_stamper_class.reset_stamper
+    ActiveRecord::Userstamp.config.default_stamper_class.stamper = @_userstamp_stamper
+    @_userstamp_stamper = nil
   end
 end
 

data/lib/active_record/userstamp/stampable.rb

@@ -95,29 +95,29 @@ module ActiveRecord::Userstamp::Stampable
   end
 
   def set_creator_attribute
-    creator_attribute = ActiveRecord::Userstamp.config.creator_attribute
-    return if !has_stamper? || creator_attribute.nil? || !has_attribute?(creator_attribute)
+    attribute = ActiveRecord::Userstamp.config.creator_attribute
+    return if !has_stamper? || attribute.nil? || !has_attribute?(attribute)
 
-    current_attribute_value = send(creator_attribute)
+    current_attribute_value = send(attribute)
     return if current_attribute_value.present?
 
-    send("#{creator_attribute}=", self.class.stamper_class.stamper)
+    ActiveRecord::Userstamp::Utilities.assign_attribute(self, attribute)
   end
 
   def set_updater_attribute
-    updater_attribute = ActiveRecord::Userstamp.config.updater_attribute
-    return if !has_stamper? || updater_attribute.nil? || !has_attribute?(updater_attribute)
+    attribute = ActiveRecord::Userstamp.config.updater_attribute
+    return if !has_stamper? || attribute.nil? || !has_attribute?(attribute)
 
     return if !self.new_record? && !self.changed?
 
-    send("#{updater_attribute}=", self.class.stamper_class.stamper)
+    ActiveRecord::Userstamp::Utilities.assign_attribute(self, attribute)
   end
 
   def set_deleter_attribute
-    deleter_attribute = ActiveRecord::Userstamp.config.deleter_attribute
-    return if !has_stamper? || deleter_attribute.nil? || !has_attribute?(deleter_attribute)
+    attribute = ActiveRecord::Userstamp.config.deleter_attribute
+    return if !has_stamper? || attribute.nil? || !has_attribute?(attribute)
 
-    send("#{deleter_attribute}=", self.class.stamper_class.stamper)
+    ActiveRecord::Userstamp::Utilities.assign_attribute(self, attribute)
     save
   end
 end

data/lib/active_record/userstamp/stamper.rb

@@ -1,47 +1,54 @@
-module ActiveRecord::Userstamp
-  module Stamper
-    extend ActiveSupport::Concern
-
-    included do
-      extend ClassMethods
+module ActiveRecord::Userstamp::Stamper
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def model_stamper
+      # don't allow multiple calls
+      return if singleton_class.included_modules.include?(InstanceMethods)
+      extend ActiveRecord::Userstamp::Stamper::InstanceMethods
     end
+  end
 
-    module ClassMethods
-      def model_stamper
-        # don't allow multiple calls
-        return if self.included_modules.include?(ActiveRecord::Userstamp::Stamper::InstanceMethods)
-        send(:extend, ActiveRecord::Userstamp::Stamper::InstanceMethods)
-      end
+  module InstanceMethods
+    # Used to set the current stamper for this model.
+    #
+    # @overload stamper=(object_id)
+    #   @param [Fixnum] object_id The ID of the stamper.
+    #   @return [Fixnum]
+    # @overload stamper=(object)
+    #   @param [ActiveRecord::Base] object The stamper object.
+    #   @return [ActiveRecord::Base]
+    def stamper=(object)
+      Thread.current[stamper_identifier] = object
     end
 
-    module InstanceMethods
-      # Used to set the stamper for a particular request. See the Userstamp module for more
-      # details on how to use this method.
-      def stamper=(object)
-        object_stamper = if object.is_a?(ActiveRecord::Base)
-          object.send("#{object.class.primary_key}".to_sym)
-        else
-          object
-        end
-
-        Thread.current[stamper_identifier] = object_stamper
-      end
+    # Retrieves the existing stamper.
+    def stamper
+      Thread.current[stamper_identifier]
+    end
 
-      # Retrieves the existing stamper for the current request.
-      def stamper
-        Thread.current[stamper_identifier]
-      end
+    # Sets the stamper back to +nil+ to prepare for the next request.
+    def reset_stamper
+      self.stamper = nil
+    end
 
-      # Sets the stamper back to +nil+ to prepare for the next request.
-      def reset_stamper
-        Thread.current[stamper_identifier] = nil
-      end
+    # For the duration that execution is within the provided block, the stamper for this class
+    # would be the specified value.
+    #
+    # This replaces the {#stamper=} and {#reset_stamper} pair because this guarantees exception
+    # safety.
+    def with_stamper(stamper)
+      old_stamper = self.stamper
+      self.stamper = stamper
+      yield
+    ensure
+      self.stamper = old_stamper
+    end
 
-      private
+    private
 
-      def stamper_identifier
-        "#{self.to_s.downcase}_#{self.object_id}_stamper"
-      end
+    def stamper_identifier
+      "#{self.to_s.downcase}_#{self.object_id}_stamper"
     end
   end
 end

data/lib/active_record/userstamp/utilities.rb

@@ -36,5 +36,19 @@ module ActiveRecord::Userstamp::Utilities
   rescue ActiveRecord::StatementInvalid => _
     nil
   end
-end
 
+  # Assigns the given attribute to the record, based on the model's stamper.
+  #
+  # If the stamper is a record, then it is assigned to the attribute; if it is a number, then it
+  # is assigned to the +_id+ attribute
+  #
+  # @param [ActiveRecord::Base] record The record to assign.
+  # @param [Symbol] attribute The attribute to assign.
+  def self.assign_attribute(record, attribute)
+    attribute = attribute.to_s
+    stamp_value = record.class.stamper_class.stamper
+
+    attribute = attribute[0..-4] if !stamp_value.is_a?(Fixnum) && attribute.end_with?('_id')
+    record.send("#{attribute}=", stamp_value)
+  end
+end

data/lib/active_record/userstamp/version.rb

@@ -1,4 +1,4 @@
 module ActiveRecord; end
 module ActiveRecord::Userstamp
-  VERSION = '3.0.1'
+  VERSION = '3.0.2'
 end

data/spec/controllers/posts_controller_spec.rb

@@ -4,9 +4,7 @@ RSpec.describe PostsController, type: :controller do
   controller do
   end
 
-  before(:each) do
-    reset_to_defaults
-  end
+  before(:each) { define_first_post }
 
   context 'when updating a Post' do
     it 'sets the correct updater' do

data/spec/controllers/users_controller_spec.rb

@@ -4,10 +4,6 @@ RSpec.describe UsersController, type: :controller do
   controller do
   end
 
-  before(:each) do
-    reset_to_defaults
-  end
-
   context 'when updating a User' do
     it 'sets the correct updater' do
       request.session = { user_id: @hera.id }
@@ -38,4 +34,17 @@ RSpec.describe UsersController, type: :controller do
       simulate_second_request
     end
   end
+
+  context 'when the handler raises an exception' do
+    before { @stamper = User.stamper }
+    it 'restores the correct stamper' do
+      begin
+        request.session = { user_id: @zeus.id }
+        post :create
+      rescue
+      end
+
+      expect(User.stamper).to be(@stamper)
+    end
+  end
 end

data/spec/dummy/app/controllers/posts_controller.rb

@@ -10,6 +10,10 @@ class PostsController < ApplicationController
     render(inline: "<%= @post.title %>")
   end
 
+  def create
+    fail
+  end
+
   protected
 
   def current_user
@@ -17,7 +21,7 @@ class PostsController < ApplicationController
   end
 
   def set_stamper
-    Person.stamper = self.current_user
+    Person.stamper = current_user
   end
 
   def reset_stamper

data/spec/dummy/app/controllers/users_controller.rb

@@ -10,6 +10,10 @@ class UsersController < ApplicationController
     render(inline: "<%= @user.name %>")
   end
 
+  def create
+    fail
+  end
+
   private
 
   def user_params

data/spec/lib/migration_spec.rb

@@ -1,14 +1,6 @@
 require 'rails_helper'
 
 RSpec.describe 'Migration helpers', type: :model do
-  after do
-    ActiveRecord::Userstamp.configure do |config|
-      config.creator_attribute = :creator_id
-      config.updater_attribute = :updater_id
-      config.deleter_attribute = :deleter_id
-    end
-  end
-
   context 'when default attribute names are used' do
     class self::DefaultRandom < ActiveRecord::Base
       stampable
@@ -38,21 +30,31 @@ RSpec.describe 'Migration helpers', type: :model do
   end
 
   context 'when overridden attribute names are used' do
-    class self::OverriddenRandom < ActiveRecord::Base
-      stampable
-    end
-    subject { self.class::OverriddenRandom.new }
-
-    temporary_table(:overridden_randoms) do |t|
+    before(:each) do
       ActiveRecord::Userstamp.configure do |config|
         config.creator_attribute = :created_by
         config.updater_attribute = :updated_by
         config.deleter_attribute = :deleted_by
       end
+      class self.class::OverriddenRandom < ActiveRecord::Base
+        stampable
+      end
+    end
+    after(:each) 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::OverriddenRandom.new }
+
+    temporary_table(:overridden_randoms) do |t|
       t.userstamps
     end
 
-    with_temporary_table(:overridden_randoms) do
+    with_temporary_table(:overridden_randoms, :each) do
       it 'has a created_by attribute' do
         expect(subject.has_attribute?(:created_by)).to be true
       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(
+        ActiveRecord::Userstamp::Stamper::InstanceMethods)).to eq(1)
+
+      User.class_eval do
+        stamper
+      end
+
+      expect(User.singleton_class.included_modules.count(
+        ActiveRecord::Userstamp::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

@@ -2,15 +2,24 @@ require 'rails_helper'
 
 RSpec.describe 'Stamping', type: :model do
   before(:each) do
-    reset_to_defaults
+    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.id)
+        expect(User.stamper).to eq(@zeus)
 
         person = Person.create(name: 'David')
         expect(person.creator_id).to eq(@zeus.id)
@@ -21,7 +30,7 @@ RSpec.describe 'Stamping', type: :model do
 
       context 'when a creator is specified' do
         it 'does not reset the creator' do
-          expect(User.stamper).to eq(@zeus.id)
+          expect(User.stamper).to eq(@zeus)
 
           person = Person.create(name: 'David', creator: @hera)
           expect(person.creator_id).to eq(@hera.id)
@@ -29,11 +38,21 @@ RSpec.describe 'Stamping', type: :model do
           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.id)
+          expect(User.stamper).to eq(@zeus)
 
           person = Person.new(name: 'David')
           person.save(validate: false)
@@ -46,7 +65,7 @@ RSpec.describe 'Stamping', type: :model do
 
       context 'when temporarily disabling stampng' do
         it 'does not set the creator and updater' do
-          expect(User.stamper).to eq(@zeus.id)
+          expect(User.stamper).to eq(@zeus)
 
           Person.without_stamps do
             person = Person.create(name: 'David')
@@ -60,6 +79,15 @@ RSpec.describe 'Stamping', type: :model do
     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)
@@ -76,7 +104,7 @@ RSpec.describe 'Stamping', type: :model do
   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)
+        expect(Person.stamper).to eq(@delynn)
 
         post = Post.create(title: 'Test Post - 1')
         expect(post.creator_id).to eq(@delynn.id)
@@ -104,7 +132,7 @@ RSpec.describe 'Stamping', type: :model 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)
+        expect(User.stamper).to eq(@hera)
 
         @delynn.name << " Berry"
         @delynn.save
@@ -116,10 +144,25 @@ RSpec.describe 'Stamping', type: :model do
       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 temporarily disabling stamping' do
       it 'does not set the updater' do
         User.stamper = @zeus
-        expect(User.stamper).to eq(@zeus.id)
+        expect(User.stamper).to eq(@zeus)
 
         original_updater = @delynn.updater
         Person.without_stamps do
@@ -135,21 +178,6 @@ RSpec.describe 'Stamping', type: :model do
     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
@@ -169,7 +197,7 @@ RSpec.describe 'Stamping', type: :model do
     context 'when the stamper is an object' do
       it 'sets the correct updater' do
         Person.stamper = @nicole
-        expect(Person.stamper).to eq(@nicole.id)
+        expect(Person.stamper).to eq(@nicole)
 
         @first_post.title << " - Updated"
         @first_post.save

data/spec/support/database_helpers.rb

@@ -1,20 +1,22 @@
-def reset_to_defaults
-  create_test_models
+def define_first_post
+  @first_post = Post.create!(title: 'a title')
 end
 
-def create_test_models
-  User.delete_all
-  Person.delete_all
-  Post.delete_all
-  Comment.delete_all
-
-  @zeus = User.create!(name: 'Zeus')
-  @hera = User.create!(name: 'Hera')
-  User.stamper = @zeus.id
+RSpec.configure do |config|
+  config.before(:each) do
+    User.delete_all
+    Person.delete_all
+    Post.delete_all
+    Comment.delete_all
+    User.reset_stamper
+    Person.reset_stamper
 
-  @delynn = Person.create!(name: 'Delynn')
-  @nicole = Person.create!(name: 'Nicole')
-  Person.stamper = @delynn.id
+    @zeus = User.create!(name: 'Zeus')
+    @hera = User.create!(name: 'Hera')
+    User.stamper = @zeus.id
 
-  @first_post = Post.create!(title: 'a title')
+    @delynn = Person.create!(name: 'Delynn')
+    @nicole = Person.create!(name: 'Nicole')
+    Person.stamper = @delynn.id
+  end
 end

data/spec/support/with_temporary_table.rb

@@ -17,28 +17,29 @@ module ActiveRecord::TemporaryTable::TestGroupHelpers
   # Using the temporary table defined previously, run the examples in this group.
   #
   # @param [Symbol] table_name The name of the table to use.
+  # @param [Symbol] create_at When to create the table. Defaults to :context.
   # @param [Proc] proc The examples requiring the use of the temporary table.
-  def with_temporary_table(table_name, &proc)
+  def with_temporary_table(table_name, create_at = :context, &proc)
     context "with temporary table #{table_name}" do |*params|
-      before(:context) do
-        ActiveRecord::TemporaryTable::TestGroupHelpers.before_context(table_name, send(table_name))
+      before(create_at) do
+        ActiveRecord::TemporaryTable::TestGroupHelpers.create_table(table_name, send(table_name))
       end
 
-      after(:context) do
-        ActiveRecord::TemporaryTable::TestGroupHelpers.after_context(table_name)
+      after(create_at) do
+        ActiveRecord::TemporaryTable::TestGroupHelpers.drop_table(table_name)
       end
 
       module_exec(*params, &proc)
     end
   end
 
-  def self.before_context(table_name, table_definition)
+  def self.create_table(table_name, table_definition)
     ActiveRecord::Migration.suppress_messages do
       ActiveRecord::Migration.create_table(table_name, &table_definition)
     end
   end
 
-  def self.after_context(table_name)
+  def self.drop_table(table_name)
     ActiveRecord::Migration.suppress_messages do
       ActiveRecord::Migration.drop_table(table_name)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-userstamp
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Joel Low
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-11 00:00:00.000000000 Z
+date: 2015-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -244,6 +244,7 @@ files:
 - spec/dummy/public/favicon.ico
 - spec/lib/configuration_spec.rb
 - spec/lib/migration_spec.rb
+- spec/lib/stamper_spec.rb
 - spec/lib/stamping_spec.rb
 - spec/lib/userstamp_spec.rb
 - spec/rails_helper.rb