originator 3.0 → 3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3538e1c300e8493901bf8065ce785c5d10e2d8f9
-  data.tar.gz: f947dd914d4e6f737b96c1b6a92208b6692d3564
+SHA256:
+  metadata.gz: 255e2766d89233e360a23010fb669e17b159caf6460ac74b86b6f0b509dfd921
+  data.tar.gz: 2e6172c95b4c0d462153e113add845c41d5da6710417cb94851ba03e7d4ac922
 SHA512:
-  metadata.gz: 00ae6b73e6ad3a1c0e9e6662e26ee820a74e6c3b962aafa9555c0a1eb5c7b58fca8c88c2a527204be25abd1a39f2e16f51031eaafc93782818701959031e127d
-  data.tar.gz: be4df2f560d977609e744903eb87e6ddf343943af176cdabcdb14f7f21dbe6ced80bf5aaeb66b616a32d7135e4a88bc8a1d003532f8a0d7a455602e9b228f832
+  metadata.gz: ed521be226d553afcf9c93d50ffbd8b498fbee4fdaaf673e7b5d7b271c092117b31b74b12ea77f348f1094a4b5243caf53cacd98768c7d0f98d31ced294dc200
+  data.tar.gz: 1218e9fb60f3eee0bcf60d8dbb0dc6c54414c7ebb58a9fb4c9b1cc32fe0a1737518a7398ec65de7738b0d7c0e86da3c8b6f172a3efec0a882cf280434f85c904

data/CHANGELOG

@@ -1,3 +1,11 @@
+3.2 (2026-03-06)
+
+* fix: Do not prefix stamper_class_name [Thomas von Deyen]
+
+3.1 (2017-09-07)
+
+* Rails 5.1 compatibility [Thomas von Deyen]
+
 3.0 (2016-09-13)
 
 * Removed Rails < 4 support [Thomas von Deyen]

data/Gemfile

@@ -1,8 +1,12 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
-gem 'rake'
-gem 'redgreen'
-gem 'activesupport'
-gem 'sqlite3'
+gem "rake"
+gem "activesupport"
+gem "sqlite3"
+gem "test-unit"
+gem "rails-controller-testing"
+gem "rdoc"
+
+gem "gem-release", "~> 2.2"

data/Rakefile

@@ -1,30 +1,30 @@
 #!/usr/bin/env rake
 
-require 'rake/testtask'
+require "rake/testtask"
 
 begin
-  require 'rdoc/task'
+  require "rdoc/task"
 rescue LoadError
-  require 'rdoc/rdoc'
-  require 'rake/rdoctask'
+  require "rdoc/rdoc"
+  require "rake/rdoctask"
   RDoc::Task = Rake::RDocTask
 end
 
-desc 'Default: run unit tests.'
+desc "Default: run unit tests."
 task :default => :test
 
-desc 'Test the userstamp plugin.'
+desc "Test the userstamp plugin."
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "lib"
+  t.pattern = "test/**/*_test.rb"
   t.verbose = true
 end
 
-desc 'Generate documentation for the userstamp plugin.'
+desc "Generate documentation for the userstamp plugin."
 RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Userstamp'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('Readme.rdoc', 'CHANGELOG', 'LICENSE')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "Userstamp"
+  rdoc.options << "--line-numbers" << "--inline-source"
+  rdoc.rdoc_files.include("Readme.rdoc", "CHANGELOG", "LICENSE")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end

data/VERSION

@@ -1 +1 @@
-3.0
+3.2

data/lib/migration_helper.rb

@@ -16,4 +16,6 @@ module Ddb
   end
 end
 
-ActiveRecord::ConnectionAdapters::TableDefinition.send(:include, Ddb::Userstamp::MigrationHelper)
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::ConnectionAdapters::TableDefinition.send(:include, Ddb::Userstamp::MigrationHelper)
+end

data/lib/stampable.rb

@@ -26,26 +26,30 @@ module Ddb #:nodoc:
           include InstanceMethods
 
           # Should ActiveRecord record userstamps? Defaults to true.
-          class_attribute  :record_userstamp
+          class_attribute :record_userstamp
           self.record_userstamp = true
 
           # Which class is responsible for stamping? Defaults to :user.
-          class_attribute  :stamper_class_name
+          class_attribute :stamper_class_name
 
           # What column should be used for the creator stamp?
           # Defaults to :creator_id when compatibility mode is off
           # Defaults to :created_by when compatibility mode is on
-          class_attribute  :creator_attribute
+          class_attribute :creator_attribute
 
           # What column should be used for the updater stamp?
           # Defaults to :updater_id when compatibility mode is off
           # Defaults to :updated_by when compatibility mode is on
-          class_attribute  :updater_attribute
+          class_attribute :updater_attribute
 
           # What column should be used for the deleter stamp?
           # Defaults to :deleter_id when compatibility mode is off
           # Defaults to :deleted_by when compatibility mode is on
-          class_attribute  :deleter_attribute
+          class_attribute :deleter_attribute
+
+          # Define if the belongs_to association should be optional or not
+          # Defaults to true to mantain the old behavior
+          class_attribute :userstamp_optional
         end
       end
 
@@ -59,7 +63,8 @@ module Ddb #:nodoc:
         #               :creator_attribute  => :create_user,
         #               :updater_attribute  => :update_user,
         #               :deleter_attribute  => :delete_user
-        #               :deleter            => true
+        #               :deleter            => true,
+        #               :optional           => true
         #   end
         #
         # The method will automatically setup all the associations, and create <tt>before_save</tt>
@@ -68,30 +73,32 @@ module Ddb #:nodoc:
         # acts_as_paranoid or you set the :deleter_attribute or set the :deleter option to true.
         def stampable(options = {})
           compatability = Ddb::Userstamp.compatibility_mode
-          defaults  = {
+          defaults = {
             :stamper_class_name => :user,
-            :creator_attribute  => (compatability ? :created_by : :creator_id),
-            :updater_attribute  => (compatability ? :updated_by : :updater_id),
-            :deleter_attribute  => (compatability ? :deleted_by : :deleter_id),
-            :deleter            => !!(options.has_key?(:deleter_attribute) or defined?(Caboose::Acts::Paranoid))
+            :creator_attribute => (compatability ? :created_by : :creator_id),
+            :updater_attribute => (compatability ? :updated_by : :updater_id),
+            :deleter_attribute => (compatability ? :deleted_by : :deleter_id),
+            :optional => true,
+            :deleter => !!(options.has_key?(:deleter_attribute) or defined?(Caboose::Acts::Paranoid)),
           }.merge(options)
 
           self.stamper_class_name = defaults[:stamper_class_name].to_sym
-          self.creator_attribute  = defaults[:creator_attribute].to_sym
-          self.updater_attribute  = defaults[:updater_attribute].to_sym
-          self.deleter_attribute  = defaults[:deleter_attribute].to_sym
+          self.creator_attribute = defaults[:creator_attribute].to_sym
+          self.updater_attribute = defaults[:updater_attribute].to_sym
+          self.deleter_attribute = defaults[:deleter_attribute].to_sym
+          self.userstamp_optional = !!defaults[:optional]
 
           class_eval do
-            klass = "::#{stamper_class_name.to_s.singularize.camelize}"
-            belongs_to :creator, :class_name => klass, :foreign_key => creator_attribute
-            belongs_to :updater, :class_name => klass, :foreign_key => updater_attribute
+            klass = stamper_class_name.to_s.camelize
+            belongs_to :creator, :class_name => klass, :foreign_key => creator_attribute, optional: userstamp_optional
+            belongs_to :updater, :class_name => klass, :foreign_key => updater_attribute, optional: userstamp_optional
 
             before_validation :set_updater_attribute
             before_validation :set_creator_attribute, :on => :create
 
             if defaults[:deleter]
-              belongs_to :deleter, :class_name => klass, :foreign_key => deleter_attribute
-              before_destroy  :set_deleter_attribute
+              belongs_to :deleter, :class_name => klass, :foreign_key => deleter_attribute, optional: userstamp_optional
+              before_destroy :set_deleter_attribute
             end
           end
         end
@@ -118,35 +125,37 @@ module Ddb #:nodoc:
 
       module InstanceMethods #:nodoc:
         private
-          def has_stamper?
-            !self.class.stamper_class.nil? && !self.class.stamper_class.stamper.nil? rescue false
-          end
 
-          def set_creator_attribute
-            return unless self.record_userstamp
-            if respond_to?(self.creator_attribute.to_sym) && has_stamper?
-              self.send("#{self.creator_attribute}=".to_sym, self.class.stamper_class.stamper)
-            end
+        def has_stamper?
+          !self.class.stamper_class.nil? && !self.class.stamper_class.stamper.nil? rescue false
+        end
+
+        def set_creator_attribute
+          return unless self.record_userstamp
+          if respond_to?(self.creator_attribute.to_sym) && has_stamper?
+            self.send("#{self.creator_attribute}=".to_sym, self.class.stamper_class.stamper)
           end
+        end
 
-          def set_updater_attribute
-            return unless self.record_userstamp
-            if respond_to?(self.updater_attribute.to_sym) && has_stamper?
-              self.send("#{self.updater_attribute}=".to_sym, self.class.stamper_class.stamper)
-            end
+        def set_updater_attribute
+          return unless self.record_userstamp
+          if respond_to?(self.updater_attribute.to_sym) && has_stamper?
+            self.send("#{self.updater_attribute}=".to_sym, self.class.stamper_class.stamper)
           end
+        end
 
-          def set_deleter_attribute
-            return unless self.record_userstamp
-            if respond_to?(self.deleter_attribute.to_sym) && has_stamper?
-              self.send("#{self.deleter_attribute}=".to_sym, self.class.stamper_class.stamper)
-              save
-            end
+        def set_deleter_attribute
+          return unless self.record_userstamp
+          if respond_to?(self.deleter_attribute.to_sym) && has_stamper?
+            self.send("#{self.deleter_attribute}=".to_sym, self.class.stamper_class.stamper)
+            save
           end
+        end
+
         #end private
       end
     end
   end
 end
 
-ActiveRecord::Base.send(:include, Ddb::Userstamp::Stampable) if defined?(ActiveRecord)
+ActiveSupport.on_load(:active_record) { include Ddb::Userstamp::Stampable }

data/lib/stamper.rb

@@ -18,10 +18,10 @@ module Ddb #:nodoc:
         # 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
+              object.send("#{object.class.primary_key}".to_sym)
+            else
+              object
+            end
 
           Thread.current["#{self.to_s.downcase}_#{self.object_id}_stamper"] = object_stamper
         end
@@ -40,4 +40,4 @@ module Ddb #:nodoc:
   end
 end
 
-ActiveRecord::Base.send(:include, Ddb::Userstamp::Stamper) if defined?(ActiveRecord)
+ActiveSupport.on_load(:active_record) { include Ddb::Userstamp::Stamper }

data/lib/userstamp.rb

@@ -1,9 +1,9 @@
-require 'stamper'
-require 'stampable'
-require 'migration_helper'
+require "stamper"
+require "stampable"
+require "migration_helper"
 
 module Userstamp
-  VERSION = File.read( File.join(File.dirname(__FILE__),'..','VERSION') ).strip
+  VERSION = File.read(File.join(File.dirname(__FILE__), "..", "VERSION")).strip
 end
 
 module Ddb
@@ -17,36 +17,38 @@ module Ddb
     # specific implementation details.
     module Userstamp
       def self.included(base) # :nodoc:
-        base.send           :include, InstanceMethods
-        base.before_action  :set_stamper
-        base.after_action   :reset_stamper
+        base.send :include, InstanceMethods
+        base.before_action :set_stamper
+        base.after_action :reset_stamper
       end
 
       module InstanceMethods
         private
-          # The <tt>set_stamper</tt> 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 <tt>current_user</tt> 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
-          # the controller where you are including the Userstamp module.
-          def set_stamper
-            User.stamper = self.current_user
-          end
 
-          # The <tt>reset_stamper</tt> 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 the controller where you are including the
-          # Userstamp module.
-          def reset_stamper
-            User.reset_stamper
-          end
+        # The <tt>set_stamper</tt> 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 <tt>current_user</tt> 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
+        # the controller where you are including the Userstamp module.
+        def set_stamper
+          User.stamper = self.current_user
+        end
+
+        # The <tt>reset_stamper</tt> 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 the controller where you are including the
+        # Userstamp module.
+        def reset_stamper
+          User.reset_stamper
+        end
+
         #end private
       end
     end
   end
 end
 
-ActionController::Base.send(:include, Ddb::Controller) if defined?(ActionController)
+ActiveSupport.on_load(:action_controller_base) { include Ddb::Controller }

data/originator.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = "originator"
-  s.version = File.read(File.join(File.dirname(__FILE__), 'VERSION')).strip
+  s.version = File.read(File.join(File.dirname(__FILE__), "VERSION")).strip
 
   s.authors = ["DeLynn Berry", "Thomas von Deyen"]
   s.homepage = "https://github.com/AlchemyCMS/originator"
@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
 
   s.extra_rdoc_files = [
-    "LICENSE"
+    "LICENSE",
   ]
   s.files = [
     "CHANGELOG",
@@ -27,31 +27,6 @@ Gem::Specification.new do |s|
     "lib/stamper.rb",
     "lib/userstamp.rb",
     "originator.gemspec",
-    "rdoc/classes/Ddb/Controller.html",
-    "rdoc/classes/Ddb/Controller/Userstamp.html",
-    "rdoc/classes/Ddb/Controller/Userstamp/InstanceMethods.html",
-    "rdoc/classes/Ddb/Userstamp.html",
-    "rdoc/classes/Ddb/Userstamp/MigrationHelper.html",
-    "rdoc/classes/Ddb/Userstamp/MigrationHelper/InstanceMethods.html",
-    "rdoc/classes/Ddb/Userstamp/Stampable.html",
-    "rdoc/classes/Ddb/Userstamp/Stampable/ClassMethods.html",
-    "rdoc/classes/Ddb/Userstamp/Stamper.html",
-    "rdoc/classes/Ddb/Userstamp/Stamper/ClassMethods.html",
-    "rdoc/classes/Ddb/Userstamp/Stamper/InstanceMethods.html",
-    "rdoc/classes/Userstamp.html",
-    "rdoc/created.rid",
-    "rdoc/files/CHANGELOG.html",
-    "rdoc/files/LICENSE.html",
-    "rdoc/files/Readme_rdoc.html",
-    "rdoc/files/lib/migration_helper_rb.html",
-    "rdoc/files/lib/stampable_rb.html",
-    "rdoc/files/lib/stamper_rb.html",
-    "rdoc/files/lib/userstamp_rb.html",
-    "rdoc/fr_class_index.html",
-    "rdoc/fr_file_index.html",
-    "rdoc/fr_method_index.html",
-    "rdoc/index.html",
-    "rdoc/rdoc-style.css",
     "test/compatibility_stamping_test.rb",
     "test/controllers/posts_controller.rb",
     "test/controllers/users_controller.rb",
@@ -65,18 +40,19 @@ Gem::Specification.new do |s|
     "test/schema.rb",
     "test/stamping_test.rb",
     "test/userstamp_controller_test.rb",
-    "test/userstamp_test.rb"
+    "test/userstamp_test.rb",
   ]
   s.require_paths = ["lib"]
   s.rubygems_version = "1.8.11"
 
-  s.add_runtime_dependency 'actionpack', '>= 4.0', '< 5.1'
-  s.add_runtime_dependency 'activerecord', '>= 4.0', '< 5.1'
+  s.add_runtime_dependency "actionpack", ">= 4.0"
+  s.add_runtime_dependency "activerecord", ">= 4.0"
+  s.add_runtime_dependency "activesupport", ">= 4.0"
 
-  if s.respond_to? :specification_version then
+  if s.respond_to? :specification_version
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new("1.2.0")
     else
     end
   else

data/test/compatibility_stamping_test.rb

@@ -1,23 +1,12 @@
-require 'test/helper'
+require_relative "helper"
 
-class CompatibilityStampingTests < Test::Unit::TestCase  # :nodoc:
+class CompatibilityStampingTests < Test::Unit::TestCase # :nodoc:
   def setup
     create_test_models
     Ddb::Userstamp.compatibility_mode = true
-    require 'test/models/comment'
+    require_relative "models/comment"
     Comment.delete_all
-    @first_comment = Comment.create!(:comment => 'a comment', :post => @first_post)
-  end
-
-  def test_comment_creation_with_stamped_integer
-    Person.stamper = @nicole.id
-    assert_equal @nicole.id, Person.stamper
-
-    comment = Comment.create(:comment => "Test Comment - 2")
-    assert_equal @nicole.id, comment.created_by
-    assert_equal @nicole.id, comment.updated_by
-    assert_equal @nicole, comment.creator
-    assert_equal @nicole, comment.updater
+    @first_comment = Comment.create!(:comment => "a comment", :post => @first_post)
   end
 
   def test_comment_creation_with_stamped_integer
@@ -40,7 +29,7 @@ class CompatibilityStampingTests < Test::Unit::TestCase  # :nodoc:
     assert_equal @delynn, comment.creator
     assert_equal @delynn, comment.updater
   end
-  
+
   def test_comment_updating_with_stamped_object
     Person.stamper = @nicole
     assert_equal @nicole.id, Person.stamper
@@ -66,4 +55,4 @@ class CompatibilityStampingTests < Test::Unit::TestCase  # :nodoc:
     assert_equal @delynn, @first_comment.creator
     assert_equal @nicole, @first_comment.updater
   end
-end
+end

data/test/controllers/posts_controller.rb

@@ -1,9 +1,9 @@
 class PostsController < UserstampController
   def edit
     @post = Post.find(params[:id])
-    render(:inline  => "<%= @post.title %>")
+    render(:inline => "<%= @post.title %>")
   end
-  
+
   def update
     @post = Post.find(params[:id])
     @post.update_attributes(params[:post])
@@ -11,16 +11,16 @@ class PostsController < UserstampController
   end
 
   protected
-    def current_user
-      Person.find(session[:person_id])
-    end
-    
-    def set_stamper
-      Person.stamper = self.current_user
-    end
 
-    def reset_stamper
-      Person.reset_stamper
-    end    
-  #end
-end
+  def current_user
+    Person.find(session[:person_id])
+  end
+
+  def set_stamper
+    Person.stamper = self.current_user
+  end
+
+  def reset_stamper
+    Person.reset_stamper
+  end
+end

data/test/controllers/users_controller.rb

@@ -1,7 +1,7 @@
 class UsersController < UserstampController
   def edit
     @user = User.find(params[:id])
-    render(:inline  => "<%= @user.name %>")
+    render(:inline => "<%= @user.name %>")
   end
 
   def update
@@ -9,4 +9,4 @@ class UsersController < UserstampController
     @user.update_attributes(params[:user])
     render(:inline => "<%= @user.name %>")
   end
-end
+end

data/test/controllers/userstamp_controller.rb

@@ -2,8 +2,8 @@ class UserstampController < ActionController::Base
   include Ddb::Controller::Userstamp
 
   protected
-    def current_user
-      User.find(session[:user_id])
-    end
-  #end
-end
+
+  def current_user
+    User.find(session[:user_id])
+  end
+end

data/test/helper.rb

@@ -1,43 +1,35 @@
-require 'rubygems'
+require "rubygems"
 
-$LOAD_PATH.unshift('lib')
+$LOAD_PATH.unshift("lib")
 
 # load normal stuff
-require 'active_support'
-require 'active_record'
-require 'action_controller'
-require 'init'
+require "active_support"
+require "active_record"
+require "action_controller"
+require "originator"
 
 # connect to db
 ActiveRecord::Base.establish_connection({
   :adapter => "sqlite3",
   :database => ":memory:",
 })
-require 'test/schema'
+require_relative "schema"
 
 # load test framework
-require 'test/unit'
-begin
-  require 'redgreen'
-rescue LoadError
-end
-require 'active_support/test_case'
-require 'action_controller/test_case'
-require 'action_controller/test_process'
-require 'action_controller/integration'
+require "test/unit"
+require "active_support/test_case"
+require "action_controller/test_case"
+require "rails/controller/testing/test_process"
+require "rails/controller/testing/integration"
 
 # load test models/controllers
-require 'test/controllers/userstamp_controller'
-require 'test/controllers/users_controller'
-require 'test/controllers/posts_controller'
-require 'test/models/user'
-require 'test/models/person'
-require 'test/models/post'
-require 'test/models/foo'
-
-ActionController::Routing::Routes.draw do |map|
-  map.connect ':controller/:action/:id'
-end
+require_relative "controllers/userstamp_controller"
+require_relative "controllers/users_controller"
+require_relative "controllers/posts_controller"
+require_relative "models/user"
+require_relative "models/person"
+require_relative "models/post"
+require_relative "models/foo"
 
 def reset_to_defaults
   Ddb::Userstamp.compatibility_mode = false
@@ -49,13 +41,13 @@ def create_test_models
   Person.delete_all
   Post.delete_all
 
-  @zeus = User.create!(:name => 'Zeus')
-  @hera = User.create!(:name => 'Hera')
+  @zeus = User.create!(:name => "Zeus")
+  @hera = User.create!(:name => "Hera")
   User.stamper = @zeus.id
 
-  @delynn = Person.create!(:name => 'Delynn')
-  @nicole = Person.create!(:name => 'Nicole')
+  @delynn = Person.create!(:name => "Delynn")
+  @nicole = Person.create!(:name => "Nicole")
   Person.stamper = @delynn.id
 
-  @first_post = Post.create!(:title => 'a title')
-end
+  @first_post = Post.create!(:title => "a title")
+end

data/test/models/comment.rb

@@ -1,5 +1,5 @@
 # this class is only meant for compatability mode testing
 class Comment < ActiveRecord::Base
-  stampable   :stamper_class_name => :person
-  belongs_to  :post
-end
+  stampable :stamper_class_name => :person
+  belongs_to :post
+end

data/test/models/foo.rb

@@ -1,3 +1,3 @@
 class Foo < ActiveRecord::Base
   stampable :deleter_attribute => :deleter_id
-end
+end

data/test/models/person.rb

@@ -1,3 +1,4 @@
 class Person < ActiveRecord::Base
   model_stamper
-end
+  stampable
+end