activerecord-userstamp 2.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aeb470b53728ed92b0b74621e4bd002a41d56275
+  data.tar.gz: c3c5f02aa4d41923407b92c17e99e6ceba1889a7
+SHA512:
+  metadata.gz: fcd728fc959bb391efb41b47259541d385b1146039992f6a9860f34dc601fadef888258e3f080246a155aa40ad19bfb6452dc84fcf20632322e6fc8b5148f461
+  data.tar.gz: 43e02f3aea8be19d8a11148603b3cc6e875dce661ee3f55923594091140b3b928bc634773b81163c307dc1af772d77b56a86d57f361e0af38c5cd46d848e0f83

data/.gitignore

@@ -0,0 +1,5 @@
+*.log
+*.sqlite3
+/.rdoc
+/.bundle
+/spec/examples.txt

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,16 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.6
+  - 2.2.2
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+
+bundler_args: "--jobs=3 --retry=3"
+cache: bundler
+
+before_install:
+  - gem update bundler

data/CHANGELOG

@@ -0,0 +1,26 @@
+2.0 (2-17-2008)
+    * [Ben  Wyrosdick] - Added a migration helper that gives migration scripts a <tt>userstamps</tt>
+                         method.
+    * [Marshall Roch]  - Stamping can be temporarily turned off using the 'without_stamps' class
+                         method. 
+      Example:
+        Post.without_stamps do
+          post = Post.find(params[:id])
+          post.update_attributes(params[:post])
+          post.save
+        end
+
+    * Models that should receive updates made by 'stampers' now use the acts_as_stampable class
+      method. This sets up the belongs_to relationships and also injects private methods for use by
+      the individual callback filter methods.
+
+    * Models that are responsible for updating now use the acts_as_stamper class method. This
+      injects the stamper= and stamper methods that are thread safe and should be updated per
+      request by a controller.
+
+    * The Userstamp module is now meant to be included with one of your project's controllers (the
+      Application Controller is recommended). It creates a before filter called 'set_stampers' that
+      is responsible for setting all the current Stampers.
+
+1.0 (01-18-2006)
+    * Initial Release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2006-2008 DeLynn Berry
+Copyright (c) 2014-2015 Joel Low
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,220 @@
+# ActiveRecord-Userstamp [![Build Status](https://travis-ci.org/lowjoel/activerecord-userstamp.svg)](https://travis-ci.org/lowjoel/activerecord-userstamp) [![Coverage Status](https://coveralls.io/repos/lowjoel/activerecord-userstamp/badge.svg?branch=master&service=github)](https://coveralls.io/github/lowjoel/activerecord-userstamp?branch=master) [![Code Climate](https://codeclimate.com/github/lowjoel/activerecord-userstamp/badges/gpa.svg)](https://codeclimate.com/github/lowjoel/activerecord-userstamp)
+
+## Overview
+
+Userstamp extends `ActiveRecord::Base` to add automatic updating of `creator`, `updater`, and 
+`deleter` attributes. It is based loosely on `ActiveRecord::Timestamp`.
+
+Two class methods (`model_stamper` and `stampable`) are implemented in this gem. The `model_stamper`
+method is used in models that are responsible for creating, updating, or deleting other objects.
+Typically this would be the `User` model of your application. The `stampable` method is used in 
+models that are subject to being created, updated, or deleted by stampers.
+
+## Forkception
+
+This is a fork of:
+
+ - the [magiclabs-userstamp](https://github.com/magiclabs/userstamp) gem
+ - which is a fork of [Michael Grosser's](https://github.com/grosser)
+   [userstamp gem] (https://github.com/grosser/userstamp) 
+ - which is a fork of the original [userstamp plugin](https://github.com/delynn/userstamp) by
+   [delynn](https://github.com/delynn)
+
+In addition to these, I have cherry picked ideas and changes from the following forks:
+
+ - [simplificator](https://github.com/simplificator/userstamp)
+ - [akm](https://github.com/akm/magic_userstamp)
+ - [konvenit](https://github.com/konvenit/userstamp)
+
+Finally, this gem only supports Ruby 2.0 and above. Yes, you really should upgrade to a supported
+version of Ruby.
+
+## Features
+### Soft-deletes
+The reason for this is because the original userstamp plugin does not support databases utilising
+soft deletes. They are not tested explicitly within this gem, but it is expected to work with the
+following gems:
+
+ - [acts_as_paranoid](https://github.com/ActsAsParanoid/acts_as_paranoid)
+ - [paranoia](https://github.com/radar/paranoia)
+
+The `stampable` method has been modified to allow additional arguments to be passed to the 
+creator/updater relations. This allows declarations like:
+
+```ruby
+  stampable with_deleted: true
+```
+
+to result in a `belongs_to` relation which looks like:
+
+```ruby
+  belongs_to :creator, class_name: '::User', foreign_key: :created_by, with_deleted: true
+```
+
+Do create a ticket if it is broken, with a pull-request if possible.  
+
+### Customisable column names/types
+While examining the userstamp gem's network on Github, it was noticed that quite a few forks were
+made to allow customisability in the name and type of the column with the database migration.
+
+This gem now supports customised column names.
+
+### Saving before validation
+This fork includes changes to perform model stamping before validation. This allows models to
+enforce the presence of stamp attributes:
+
+```ruby
+  validates :created_by, :presence => true
+  validates :updated_by, :presence => true
+```
+
+Furthermore, the `creator` attribute is set only if the value is blank allowing for a manual
+override.
+
+## Usage
+Assume that we are building a blog application, with User and Post objects. Add the following 
+to the application's Gemfile:
+
+```ruby
+  gem 'activerecord-userstamp'
+```
+
+Ensure that each model has a set of columns for creators, updaters, and deleters (if applicable.)
+
+```ruby
+  class CreateUsers < ActiveRecord::Migration
+    def self.up
+      create_table :users, :force => true do |t|
+        ...
+        t.userstamps # use t.userstamps(true) if you also want 'deleter_id'
+      end
+    end
+
+    def self.down
+      drop_table :users
+    end
+  end
+
+  class CreatePosts < ActiveRecord::Migration
+    def self.up
+      create_table :posts, :force => true do |t|
+        ...
+        t.userstamps # use t.userstamps(true) if you also want 'deleter_id'
+      end
+    end
+
+    def self.down
+      drop_table :posts
+    end
+  end
+```
+
+Declare the stamper on the User model:
+
+```ruby
+  class User < ActiveRecord::Base
+    model_stamper
+  end
+```
+
+And declare that the Posts are stampable:
+
+```ruby
+  class Post < ActiveRecord::Base
+    stampable
+  end
+```
+
+If your stamper is called `User`, that's it; you're done.
+
+## Customisation
+More than likely you want all your associations setup on your stamped objects, and that's where the
+`stampable` class method comes in. So in our example we'll want to use this method in both our 
+User and Post classes:
+
+```ruby
+  class User < ActiveRecord::Base
+    model_stamper
+    stampable
+  end
+
+  class Post < ActiveRecord::Base
+    stampable
+  end
+```
+
+Okay, so what all have we done? The `model_stamper` class method injects two methods into the
+`User` class. They are `#stamper=` and `#stamper` and look like this:
+
+  def stamper=(object)
+    object_stamper = if object.is_a?(ActiveRecord::Base)
+      object.send("#{object.class.primary_key}".to_sym)
+    else
+      object
+    end
+
+    Thread.current["#{self.to_s.downcase}_#{self.object_id}_stamper"] = object_stamper
+  end
+
+  def stamper
+    Thread.current["#{self.to_s.downcase}_#{self.object_id}_stamper"]
+  end
+
+The `stampable` method allows you to customize what columns will get stamped, and also creates the
+`creator`, `updater`, and `deleter` associations.
+
+The Userstamp module that we included into our ApplicationController uses the setter method to
+set which user is currently making the request. By default the 'set_stampers' method works perfectly
+with the RestfulAuthentication[http://svn.techno-weenie.net/projects/plugins/restful_authentication] plug-in:
+
+  def set_stampers
+    User.stamper = self.current_user
+  end
+
+If you aren't using ActsAsAuthenticated, then you need to create your own version of the
+<tt>set_stampers</tt> method in the controller where you've included the Userstamp module.
+
+Now, let's get back to the Stampable module (since it really is the interesting one). The Stampable
+module sets up before_* filters that are responsible for setting those attributes at the appropriate
+times. It also creates the belongs_to relationships for you.
+
+If you need to customize the columns that are stamped, the <tt>stampable</tt> method can be
+completely customized. Here's an quick example:
+
+  class Post < ActiveRecord::Base
+    stampable :stamper_class_name => :person,
+              :creator_attribute  => :create_user,
+              :updater_attribute  => :update_user,
+              :deleter_attribute  => :delete_user,
+              :deleter => true,
+              :with_deleted => true
+  end
+
+## Upgrading
+### Upgrading from delynn's 1.x/2.x with `compatibility_mode`
+The major difference between 1.x and 2.x is the naming of the columns. This version of the gem 
+allows specifying the name of the column from the gem configuration.
+
+Furthermore, there is no need to include the `Userstamp` module in `ApplicationController`.
+
+However, this is where the bulk of the work is: since this is a fork of insphire's gem, where he 
+has removed making every `ActiveRecord::Base` subclass automatically a 
+
+### Upgrading from magiclabs-userstamp
+
+There is no need to include the `Userstamp` module in `ApplicationController`.
+
+## Tests
+Run
+
+    $ bundle exec rspec
+
+## Authors
+ - [DeLynn Berry](http://delynnberry.com/): The original idea for this plugin came from the Rails
+   Wiki article entitled
+   [Extending ActiveRecord](http://wiki.rubyonrails.com/rails/pages/ExtendingActiveRecordExample)
+ - [Michael Grosser](http://pragmatig.com)
+ - [John Dell](http://blog.spovich.com/)
+ - [Chris Hilton](https://github.com/chrismhilton)
+ - [Thomas von Deyen](https://github.com/tvdeyen)
+ - [Joel Low](http://joelsplace.sg)

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+require 'rdoc/task'
+desc 'Generate documentation for the userstamp plugin.'
+Rake::RDocTask.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')
+end

data/activerecord-userstamp.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record/userstamp/version'
+
+Gem::Specification.new do |s|
+  s.name = 'activerecord-userstamp'
+  s.version = ActiveRecord::Userstamp::VERSION
+  s.authors = ['Joel Low']
+  s.email = ['joel@joelsplace.sg']
+
+  s.summary = 'Adds magic creator and updater attributes to your ActiveRecord models.'
+  s.description = 'This gem extends ActiveRecord::Base to add automatic updating of created_by and updated_by attributes of your models in much the same way that the ActiveRecord::Timestamp module updates created_(at/on) and updated_(at/on) attributes.'
+  s.homepage = 'https://github.com/lowjoel/activerecord-userstamp'
+  s.license  = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'activesupport', '~> 4.2'
+  s.add_dependency 'activerecord', '~> 4.2'
+
+  s.add_development_dependency 'actionview', '~> 4.2'
+  s.add_development_dependency 'tzinfo-data'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rdoc'
+  s.add_development_dependency 'rspec-rails', '~> 3.3'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'coveralls'
+  s.add_development_dependency 'codeclimate-test-reporter'
+  s.add_development_dependency 'sqlite3'
+end

data/lib/active_record/userstamp.rb

@@ -0,0 +1,14 @@
+module ActiveRecord::Userstamp
+  extend ActiveSupport::Autoload
+
+  autoload :Stampable
+  autoload :Stamper
+
+  eager_autoload do
+    autoload :ControllerAdditions
+    autoload :MigrationAdditions
+    autoload :ModelAdditions
+  end
+
+  eager_load!
+end

data/lib/active_record/userstamp/controller_additions.rb

@@ -0,0 +1,41 @@
+# The Userstamp module, when included into a controller, adds a before filter
+# (named <tt>set_stamper</tt>) and an after filter (name <tt>reset_stamper</tt>).
+# These methods assume a couple of things, but can be re-implemented in your
+# controller to better suite your application.
+#
+# See the documentation for <tt>set_stamper</tt> and <tt>reset_stamper</tt> for
+# specific implementation details.
+module ActiveRecord::Userstamp::ControllerAdditions
+  def self.included(base) # :nodoc:
+    base.send           :include, InstanceMethods
+    base.before_filter  :set_stamper
+    base.after_filter   :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
+  end
+end
+
+if defined?(ActionController)
+  ActionController::Base.send(:include, ActiveRecord::Userstamp::ControllerAdditions)
+end

data/lib/active_record/userstamp/migration_additions.rb

@@ -0,0 +1,16 @@
+module ActiveRecord::Userstamp::MigrationHelper
+  def self.included(base) # :nodoc:
+    base.send(:include, InstanceMethods)
+  end
+
+  module InstanceMethods
+    def userstamps(include_deleted_by = false, *args)
+      column(ActiveRecord::Userstamp.compatibility_mode ? :created_by : :creator_id, :integer, *args)
+      column(ActiveRecord::Userstamp.compatibility_mode ? :updated_by : :updater_id, :integer, *args)
+      column(ActiveRecord::Userstamp.compatibility_mode ? :deleted_by : :deleter_id, :integer, *args) if include_deleted_by
+    end
+  end
+end
+
+ActiveRecord::ConnectionAdapters::TableDefinition.send(:include,
+  ActiveRecord::Userstamp::MigrationHelper)

data/lib/active_record/userstamp/model_additions.rb

@@ -0,0 +1,3 @@
+module ActiveRecord::Userstamp::ModelAdditions; end
+ActiveRecord::Base.send(:include, ActiveRecord::Userstamp::Stampable)
+ActiveRecord::Base.send(:include, ActiveRecord::Userstamp::Stamper)