RubyGems - magiclabs-userstamp - Versions diffs - 2.0.2 - Mend

magiclabs-userstamp 2.0.2

Files changed (53) hide show

data/CHANGELOG +26 -0
data/Gemfile +11 -0
data/Gemfile.lock +55 -0
data/LICENSE +20 -0
data/Rakefile +38 -0
data/Readme.rdoc +163 -0
data/VERSION +1 -0
data/init.rb +1 -0
data/lib/migration_helper.rb +19 -0
data/lib/stampable.rb +154 -0
data/lib/stamper.rb +43 -0
data/lib/userstamp.rb +52 -0
data/magiclabs-userstamp.gemspec +85 -0
data/rdoc/classes/Ddb/Controller.html +111 -0
data/rdoc/classes/Ddb/Controller/Userstamp.html +125 -0
data/rdoc/classes/Ddb/Controller/Userstamp/InstanceMethods.html +105 -0
data/rdoc/classes/Ddb/Userstamp.html +121 -0
data/rdoc/classes/Ddb/Userstamp/MigrationHelper.html +111 -0
data/rdoc/classes/Ddb/Userstamp/MigrationHelper/InstanceMethods.html +142 -0
data/rdoc/classes/Ddb/Userstamp/Stampable.html +128 -0
data/rdoc/classes/Ddb/Userstamp/Stampable/ClassMethods.html +225 -0
data/rdoc/classes/Ddb/Userstamp/Stamper.html +112 -0
data/rdoc/classes/Ddb/Userstamp/Stamper/ClassMethods.html +142 -0
data/rdoc/classes/Ddb/Userstamp/Stamper/InstanceMethods.html +207 -0
data/rdoc/classes/Userstamp.html +118 -0
data/rdoc/created.rid +1 -0
data/rdoc/files/CHANGELOG.html +137 -0
data/rdoc/files/LICENSE.html +129 -0
data/rdoc/files/Readme_rdoc.html +301 -0
data/rdoc/files/lib/migration_helper_rb.html +101 -0
data/rdoc/files/lib/stampable_rb.html +101 -0
data/rdoc/files/lib/stamper_rb.html +101 -0
data/rdoc/files/lib/userstamp_rb.html +110 -0
data/rdoc/fr_class_index.html +38 -0
data/rdoc/fr_file_index.html +33 -0
data/rdoc/fr_method_index.html +33 -0
data/rdoc/index.html +24 -0
data/rdoc/rdoc-style.css +208 -0
data/test/compatibility_stamping_test.rb +69 -0
data/test/controllers/posts_controller.rb +26 -0
data/test/controllers/users_controller.rb +12 -0
data/test/controllers/userstamp_controller.rb +9 -0
data/test/helper.rb +61 -0
data/test/models/comment.rb +5 -0
data/test/models/foo.rb +3 -0
data/test/models/person.rb +3 -0
data/test/models/post.rb +13 -0
data/test/models/user.rb +3 -0
data/test/schema.rb +54 -0
data/test/stamping_test.rb +138 -0
data/test/userstamp_controller_test.rb +103 -0
data/test/userstamp_test.rb +7 -0
metadata +105 -0

@@ -0,0 +1,129 @@
+<?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>File: LICENSE</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="fileHeader">
+    <h1>LICENSE</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>LICENSE
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Fri Apr 30 22:27:46 +0200 2010</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+Copyright (c) 2006-2008 DeLynn Berry
+</p>
+<p>
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+&quot;Software&quot;), 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:
+</p>
+<p>
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+</p>
+<p>
+THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, 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.
+</p>
+    </div>
+   </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/files/Readme_rdoc.html ADDED

@@ -0,0 +1,301 @@
+<?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>File: Readme.rdoc</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="fileHeader">
+    <h1>Readme.rdoc</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>Readme.rdoc
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Mon Aug 09 21:09:43 +0200 2010</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+<a href="../classes/Userstamp.html">Userstamp</a>
+</p>
+<h2>Overview</h2>
+<p>
+<a href="../classes/Userstamp.html">Userstamp</a> extends <a
+href="http://api.rubyonrails.com/classes/ActiveRecord/Base.html">ActiveRecord::Base</a>
+to add automatic updating of &#8216;creator&#8217;, &#8216;updater&#8217;,
+and &#8216;deleter&#8217; attributes. It is based loosely on the <a
+href="http://api.rubyonrails.com/classes/ActiveRecord/Timestamp.html">ActiveRecord::Timestamp</a>
+module.
+</p>
+<p>
+Two class methods (<tt>model_stamper</tt> and <tt>stampable</tt>) are
+implemented in this plugin. The <tt>model_stamper</tt> method is used in
+models that are responsible for creating, updating, or deleting other
+objects. The <tt>stampable</tt> method is used in models that are subject
+to being created, updated, or deleted by &#8216;stampers&#8217;.
+</p>
+<h2>Installation</h2>
+<pre>
+ - As Rails plugin: `script/plugin install git://github.com/delynn/userstamp.git `
+ - As gem: ` sudo gem install userstamp `
+</pre>
+<h2>Usage</h2>
+<p>
+The assumption is that you have two different categories of objects; those
+that manipulate, and those that are manipulated. For those objects that are
+being manipulated there&#8216;s the Stampable module and for the
+manipulators there&#8216;s the Stamper module. There&#8216;s also the
+actual <a href="../classes/Userstamp.html">Userstamp</a> module for your
+controllers that assists in setting up your environment on a per request
+basis.
+</p>
+<h3>Example</h3>
+<p>
+Assume a weblog application has User and Post objects. # 1: Create the
+migrations for these objects
+</p>
+<pre>
+  class CreateUsers &lt; ActiveRecord::Migration
+    def self.up
+      create_table :users, :force =&gt; 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 &lt; ActiveRecord::Migration
+    def self.up
+      create_table :posts, :force =&gt; 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
+</pre>
+<p>
+# 2: Users are going to manipulate Post&#8216;s, use the
+<tt>model_stamper</tt>:
+</p>
+<pre>
+  class User &lt; ActiveRecord::Base
+    model_stamper
+  end
+</pre>
+<p>
+# 3: Set the current user in the ApplicationController:
+</p>
+<pre>
+  class ApplicationController &lt; ActionController::Base
+    include Userstamp
+  end
+</pre>
+<p>
+If all you are interested in is making sure all tables that have the proper
+columns are stamped by the currently logged in user you can stop right
+here. More than likely you want all your associations setup on your stamped
+objects, and that&#8216;s where the <tt>stampable</tt> class method comes
+in. So in our example we&#8216;ll want to use this method in both our User
+and Post classes:
+</p>
+<pre>
+  class User &lt; ActiveRecord::Base
+    model_stamper
+    stampable
+  end
+  class Post &lt; ActiveRecord::Base
+    stampable
+  end
+</pre>
+<p>
+Okay, so what all have we done? The <tt>model_stamper</tt> class method
+injects two methods into the User class. They are stamper= and stamper and
+look like this:
+</p>
+<pre>
+  def stamper=(object)
+    object_stamper = if object.is_a?(ActiveRecord::Base)
+      object.send(&quot;#{object.class.primary_key}&quot;.to_sym)
+    else
+      object
+    end
+    Thread.current[&quot;#{self.to_s.downcase}_#{self.object_id}_stamper&quot;] = object_stamper
+  end
+  def stamper
+    Thread.current[&quot;#{self.to_s.downcase}_#{self.object_id}_stamper&quot;]
+  end
+</pre>
+<p>
+The <tt>stampable</tt> method allows you to customize what columns will get
+stamped, and also creates the <tt>creator</tt>, <tt>updater</tt>, and
+<tt>deleter</tt> associations.
+</p>
+<p>
+The <a href="../classes/Userstamp.html">Userstamp</a> module that we
+included into our ApplicationController uses the setter method to set which
+user is currently making the request. By default the
+&#8216;set_stampers&#8217; method works perfectly with the <a
+href="http://svn.techno-weenie.net/projects/plugins/restful_authentication">RestfulAuthentication</a>
+plug-in:
+</p>
+<pre>
+  def set_stampers
+    User.stamper = self.current_user
+  end
+</pre>
+<p>
+If you aren&#8216;t using ActsAsAuthenticated, then you need to create your
+own version of the <tt>set_stampers</tt> method in the controller where
+you&#8216;ve included the <a href="../classes/Userstamp.html">Userstamp</a>
+module.
+</p>
+<p>
+Now, let&#8216;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.
+</p>
+<p>
+If you need to customize the columns that are stamped, the
+<tt>stampable</tt> method can be completely customized. Here&#8216;s an
+quick example:
+</p>
+<pre>
+  class Post &lt; ActiveRecord::Base
+    stampable :stamper_class_name =&gt; :person,
+              :creator_attribute  =&gt; :create_user,
+              :updater_attribute  =&gt; :update_user,
+              :deleter_attribute  =&gt; :delete_user
+  end
+</pre>
+<h2>Upgrade from 1.x</h2>
+<pre>
+ # config/environment.rb
+ Ddb::Userstamp.compatibility_mode = true
+</pre>
+<p>
+<a href="http://github.com/delynn/userstamp_sample">Example userstamp
+application</a>
+</p>
+<h2>Running Unit Tests</h2>
+<pre>
+ All: rake
+ One: ruby test/compatibility_stamping_test.rb
+</pre>
+<h2>Author</h2>
+<p>
+<a href="http://delynnberry.com/">DeLynn Berry</a>
+</p>
+<p>
+The original idea for this plugin came from the Rails Wiki article entitled
+<a
+href="http://wiki.rubyonrails.com/rails/pages/ExtendingActiveRecordExample">Extending
+ActiveRecord</a>.
+</p>
+<h2>Contributors / maintenance / enhancement</h2>
+<ul>
+<li><a href="http://pragmatig.com">Michael Grosser</a>
+</li>
+<li><a href="http://blog.spovich.com/">John Dell</a>
+</li>
+</ul>
+    </div>
+   </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/files/lib/migration_helper_rb.html ADDED

@@ -0,0 +1,101 @@
+<?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>File: migration_helper.rb</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="fileHeader">
+    <h1>migration_helper.rb</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>lib/migration_helper.rb
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Mon Aug 09 20:17:35 +0200 2010</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>