magiclabs-userstamp 2.0.2

data/lib/stamper.rb

@@ -0,0 +1,43 @@
+module Ddb #:nodoc:
+  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.included_modules.include?(Ddb::Userstamp::Stamper::InstanceMethods)
+          send(:extend, Ddb::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
+end
+
+ActiveRecord::Base.send(:include, Ddb::Userstamp::Stamper) if defined?(ActiveRecord)

data/lib/userstamp.rb

@@ -0,0 +1,52 @@
+require 'stamper'
+require 'stampable'
+require 'migration_helper'
+
+module Userstamp
+  VERSION = File.read( File.join(File.dirname(__FILE__),'..','VERSION') ).strip
+end
+
+module Ddb
+  module Controller
+    # 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 Userstamp
+      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 private
+      end
+    end
+  end
+end
+
+ActionController::Base.send(:include, Ddb::Controller) if defined?(ActionController)

data/magiclabs-userstamp.gemspec

@@ -0,0 +1,85 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "magiclabs-userstamp"
+  s.version = "2.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["DeLynn Berry"]
+  s.date = "2011-11-07"
+  s.email = "delynn@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE"
+  ]
+  s.files = [
+    "CHANGELOG",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "Rakefile",
+    "Readme.rdoc",
+    "VERSION",
+    "init.rb",
+    "lib/migration_helper.rb",
+    "lib/stampable.rb",
+    "lib/stamper.rb",
+    "lib/userstamp.rb",
+    "magiclabs-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/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",
+    "test/controllers/userstamp_controller.rb",
+    "test/helper.rb",
+    "test/models/comment.rb",
+    "test/models/foo.rb",
+    "test/models/person.rb",
+    "test/models/post.rb",
+    "test/models/user.rb",
+    "test/schema.rb",
+    "test/stamping_test.rb",
+    "test/userstamp_controller_test.rb",
+    "test/userstamp_test.rb"
+  ]
+  s.homepage = "https://github.com/magiclabs/userstamp"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.11"
+  s.summary = "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."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

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>

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/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>