magic_userstamp 0.1.0

data/lib/userstamp/stampable.rb

@@ -0,0 +1,147 @@
+# -*- coding: utf-8 -*-
+require 'userstamp'
+
+module Userstamp
+  # Determines what default columns to use for recording the current stamper.
+  # By default this is set to false, so the plug-in will use columns named
+  # <tt>creator_id</tt>, <tt>updater_id</tt>, and <tt>deleter_id</tt>.
+  #
+  # To turn compatibility mode on, place the following line in your environment.rb
+  # file:
+  #
+  #   Userstamp.compatibility_mode = true
+  #
+  # This will cause the plug-in to use columns named <tt>created_by</tt>,
+  # <tt>updated_by</tt>, and <tt>deleted_by</tt>.
+  mattr_accessor :compatibility_mode
+  @@compatibility_mode = false
+
+  VALID_OPTIONS_KEYS_FOR_STAMPABLE_ON = [
+    :attribute, # :column_name
+    :stamper_name,
+    :stamper_class_name,
+    :stamper_attr_name,
+    :attribute,
+    :actual_hook
+  ]
+  
+  def self.raise_unless_valid_options_for_stampable_on(options)
+    return if options.nil?
+    invalid_keys = (options.keys - VALID_OPTIONS_KEYS_FOR_STAMPABLE_ON)
+    raise "Invalid options keys: #{invalid_keys.inspect}" unless invalid_keys.empty?
+  end
+
+  # Extends the stamping functionality of ActiveRecord by automatically recording the model
+  # responsible for creating, updating, and deleting the current object. See the Stamper
+  # and Userstamp modules for further documentation on how the entire process works.
+  module Stampable
+    def self.included(base) #:nodoc:
+      base.extend(ClassMethods)
+      base.class_eval do
+        # Should ActiveRecord record userstamps? Defaults to true.
+        class_inheritable_accessor  :record_userstamp
+        self.record_userstamp = true
+      end
+    end
+
+    module ClassMethods
+      # This method is automatically called on for all classes that inherit from
+      # ActiveRecord, but if you need to customize how the plug-in functions, this is the
+      # method to use. Here's an example:
+      #
+      #   class Post < ActiveRecord::Base
+      #     stampable :stamper_class_name => :person,
+      #               :creator_attribute  => :create_user,
+      #               :updater_attribute  => :update_user,
+      #               :deleter_attribute  => :delete_user
+      #   end
+      #
+      # The method will automatically setup all the associations, and create <tt>before_save</tt>
+      # and <tt>before_create</tt> filters for doing the stamping.
+      def stampable(options = {})
+        reader_name = Userstamp.compatibility_mode ? :default_attribute_compatible : :default_attribute
+        options  = {
+          :stamper_class_name => "User",
+          :creator_attribute  => Event[:create ].send(reader_name),
+          :updater_attribute  => Event[:update ].send(reader_name),
+          :deleter_attribute  => Event[:destroy].send(reader_name)
+        }.update(options || {})
+
+        stamper_class_name = options[:stamper_class_name].to_s
+        stamper_class_name = stamper_class_name.camelize unless stamper_class_name =~ /^[A-Z]/
+
+        with_options(:stamper_class_name => stamper_class_name) do |s|
+          s.stampable_on(:create , :attribute => options[:creator_attribute])
+          s.stampable_on(:update , :attribute => options[:updater_attribute])
+          s.stampable_on(:destroy, :attribute => options[:deleter_attribute]) if defined?(Caboose::Acts::Paranoid)
+        end
+      end
+
+      def stampable_on(event_name, options = {})
+        Userstamp.raise_unless_valid_options_for_stampable_on(options)
+        event = Event[event_name]
+        reader_name = Userstamp.compatibility_mode ? :default_attribute_compatible : :default_attribute
+        options = {
+          :stamper_name => event.actor,
+          :stamper_class_name => "User",
+          # :stamper_attribute => nil
+          :attribute => event.send(reader_name),
+          :actual_hook => nil
+        }.update(options || {})
+
+        belongs_to_class_name = options[:stamper_class_name].to_s
+        belongs_to_class_name = belongs_to_class_name.singularize.camelize unless belongs_to_class_name =~ /^[A-Z]/
+        callback_method_name = "set_#{options[:attribute]}_on_#{event.name}"
+
+        line_no = __LINE__ + 2
+        method_definitions = <<-"EOS"
+          belongs_to(:#{options[:stamper_name]},
+            :class_name => '#{belongs_to_class_name}',
+            :foreign_key => '#{options[:attribute].to_s}')
+
+          #{options[:actual_hook] || event.actual_hook} :#{callback_method_name}
+
+          def #{callback_method_name}
+            if Userstamp.config.verbose?(self.class, "#{options[:attribute]}") && !self.record_userstamp
+              logger.debug("aborting #{self.name}.#{callback_method_name} cause of record_userstamp is nil/false")
+            end
+            return unless self.record_userstamp
+            if RAILS_ENV == 'development'
+              @@#{options[:attribute]}_stamper_class = "#{options[:stamper_class_name]}".constantize
+            else
+              @@#{options[:attribute]}_stamper_class ||= "#{options[:stamper_class_name]}".constantize
+            end
+            stamper_class = @@#{options[:attribute]}_stamper_class
+            stamper_class.model_stamper if stamper_class
+            stamper = stamper_class.stamper if stamper_class
+            send("#{options[:attribute]}=", stamper) if stamper
+            #{event.after_callback}
+          end
+        EOS
+        if Userstamp.config.verbose?(self, options[:attribute])
+          ActiveRecord::Base.logger.debug "=" * 100
+          ActiveRecord::Base.logger.debug self.name
+          ActiveRecord::Base.logger.debug method_definitions
+        end
+        module_eval(method_definitions, __FILE__, line_no)
+      end
+
+      # Temporarily allows you to turn stamping off. For example:
+      #
+      #   Post.without_stamps do
+      #     post = Post.find(params[:id])
+      #     post.update_attributes(params[:post])
+      #     post.save
+      #   end
+      def without_stamps
+        original_value = self.record_userstamp
+        self.record_userstamp = false
+        begin
+          yield
+        ensure
+          self.record_userstamp = original_value
+        end
+      end
+    end
+  end
+end

data/lib/userstamp/stamper.rb

@@ -0,0 +1,41 @@
+require 'userstamp'
+
+module Userstamp
+  module Stamper
+    def self.included(base) # :nodoc:
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def model_stamper
+        # don't allow multiple calls
+        return if self.is_a?(Userstamp::Stamper::InstanceMethods)
+        self.extend(Userstamp::Stamper::InstanceMethods)
+      end
+    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["#{self.to_s.downcase}_#{self.object_id}_stamper"] = object_stamper
+      end
+
+      # Retrieves the existing stamper for the current request.
+      def stamper
+        Thread.current["#{self.to_s.downcase}_#{self.object_id}_stamper"]
+      end
+
+      # Sets the stamper back to +nil+ to prepare for the next request.
+      def reset_stamper
+        Thread.current["#{self.to_s.downcase}_#{self.object_id}_stamper"] = nil
+      end
+    end
+  end
+end

data/lib/userstamp.rb

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+module Userstamp
+  autoload :Config, 'userstamp/config'
+  autoload :Controller, 'userstamp/controller'
+  autoload :Event, 'userstamp/event'
+  autoload :MagicColumns, 'userstamp/magic_columns'
+  autoload :MigrationHelper, 'userstamp/migration_helper'
+  autoload :Stampable, 'userstamp/stampable'
+  autoload :Stamper, 'userstamp/stamper'
+
+  class UserstampError < StandardError
+  end
+
+  def self.config
+    Config.instance
+  end
+end

data/magic_userstamp.gemspec

@@ -0,0 +1,124 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{magic_userstamp}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["akimatter"]
+  s.date = %q{2009-10-28}
+  s.description = %q{This Rails plugin 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.email = %q{akm2000@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.original",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG",
+     "LICENSE",
+     "README.original",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "lib/userstamp.rb",
+     "lib/userstamp/config.rb",
+     "lib/userstamp/controller.rb",
+     "lib/userstamp/event.rb",
+     "lib/userstamp/magic_columns.rb",
+     "lib/userstamp/migration_helper.rb",
+     "lib/userstamp/stampable.rb",
+     "lib/userstamp/stamper.rb",
+     "magic_userstamp.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/created.rid",
+     "rdoc/files/CHANGELOG.html",
+     "rdoc/files/LICENSE.html",
+     "rdoc/files/README.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",
+     "spec/compatibility_stamping_spec.rb",
+     "spec/config_spec.rb",
+     "spec/database.yml",
+     "spec/fixtures/comments.yml",
+     "spec/fixtures/people.yml",
+     "spec/fixtures/posts.yml",
+     "spec/fixtures/users.yml",
+     "spec/magic_column_spec.rb",
+     "spec/posts_controller_spec.rb",
+     "spec/resources/controllers/application_controller.rb",
+     "spec/resources/controllers/posts_controller.rb",
+     "spec/resources/controllers/users_controller.rb",
+     "spec/resources/controllers/userstamp_controller.rb",
+     "spec/resources/models/comment.rb",
+     "spec/resources/models/person.rb",
+     "spec/resources/models/ping.rb",
+     "spec/resources/models/post.rb",
+     "spec/resources/models/user.rb",
+     "spec/schema.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/stamping_spec.rb",
+     "spec/users_controller_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/akm/magic_userstamp}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{creator_id/updater_id/deleter_id support with setting outside models}
+  s.test_files = [
+    "spec/compatibility_stamping_spec.rb",
+     "spec/config_spec.rb",
+     "spec/magic_column_spec.rb",
+     "spec/posts_controller_spec.rb",
+     "spec/resources/controllers/application_controller.rb",
+     "spec/resources/controllers/posts_controller.rb",
+     "spec/resources/controllers/users_controller.rb",
+     "spec/resources/controllers/userstamp_controller.rb",
+     "spec/resources/models/comment.rb",
+     "spec/resources/models/person.rb",
+     "spec/resources/models/ping.rb",
+     "spec/resources/models/post.rb",
+     "spec/resources/models/user.rb",
+     "spec/schema.rb",
+     "spec/spec_helper.rb",
+     "spec/stamping_spec.rb",
+     "spec/users_controller_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/rdoc/classes/Ddb/Controller/Userstamp/InstanceMethods.html

@@ -0,0 +1,105 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: Ddb::Controller::Userstamp::InstanceMethods</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">Ddb::Controller::Userstamp::InstanceMethods</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../../files/lib/userstamp_rb.html">
+                lib/userstamp.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/rdoc/classes/Ddb/Controller/Userstamp.html

@@ -0,0 +1,125 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: Ddb::Controller::Userstamp</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">Ddb::Controller::Userstamp</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../files/lib/userstamp_rb.html">
+                lib/userstamp.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+The <a href="Userstamp.html">Userstamp</a> 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.
+</p>
+<p>
+See the documentation for <tt>set_stamper</tt> and <tt>reset_stamper</tt>
+for specific implementation details.
+</p>
+
+    </div>
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+    <div id="class-list">
+      <h3 class="section-bar">Classes and Modules</h3>
+
+      Module <a href="Userstamp/InstanceMethods.html" class="link">Ddb::Controller::Userstamp::InstanceMethods</a><br />
+
+    </div>
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/rdoc/classes/Ddb/Controller.html

@@ -0,0 +1,111 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: Ddb::Controller</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">Ddb::Controller</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/userstamp_rb.html">
+                lib/userstamp.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+    <div id="class-list">
+      <h3 class="section-bar">Classes and Modules</h3>
+
+      Module <a href="Controller/Userstamp.html" class="link">Ddb::Controller::Userstamp</a><br />
+
+    </div>
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>