RubyGems - magic_userstamp - Versions diffs - 0.1.0 → 0.1.1 - Mend

magic_userstamp 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (63) hide show

data/README.rdoc +78 -8
data/Rakefile +2 -1
data/VERSION +1 -1
data/init.rb +5 -7
data/lib/magic_userstamp.rb +27 -0
data/lib/{userstamp → magic_userstamp}/config.rb +11 -12
data/lib/{userstamp → magic_userstamp}/controller.rb +2 -2
data/lib/{userstamp → magic_userstamp}/event.rb +3 -3
data/lib/{userstamp → magic_userstamp}/magic_columns.rb +3 -3
data/lib/magic_userstamp/migration_helper.rb +17 -0
data/lib/{userstamp → magic_userstamp}/stampable.rb +15 -15
data/lib/{userstamp → magic_userstamp}/stamper.rb +5 -5
data/magic_userstamp.gemspec +36 -29
data/rdoc/classes/MagicUserstamp.html +233 -0
data/rdoc/classes/MagicUserstamp/Config.html +408 -0
data/rdoc/classes/MagicUserstamp/Config/Pattern.html +246 -0
data/rdoc/classes/{Ddb → MagicUserstamp}/Controller.html +7 -7
data/rdoc/classes/{Ddb/Controller/Userstamp → MagicUserstamp/Controller}/InstanceMethods.html +7 -7
data/rdoc/classes/MagicUserstamp/Event.html +367 -0
data/rdoc/classes/MagicUserstamp/MagicColumns.html +180 -0
data/rdoc/classes/MagicUserstamp/MagicColumns/ClassMethods.html +225 -0
data/rdoc/classes/MagicUserstamp/MagicUserstampError.html +111 -0
data/rdoc/classes/{Ddb/Userstamp → MagicUserstamp}/MigrationHelper.html +8 -8
data/rdoc/classes/MagicUserstamp/MigrationHelper/InstanceMethods.html +142 -0
data/rdoc/classes/MagicUserstamp/Stampable.html +157 -0
data/rdoc/classes/MagicUserstamp/Stampable/ClassMethods.html +259 -0
data/rdoc/classes/{Ddb/Userstamp → MagicUserstamp}/Stamper.html +9 -9
data/rdoc/classes/{Ddb/Userstamp → MagicUserstamp}/Stamper/ClassMethods.html +19 -19
data/rdoc/classes/MagicUserstamp/Stamper/InstanceMethods.html +208 -0
data/rdoc/created.rid +1 -1
data/rdoc/files/README_rdoc.html +268 -0
data/rdoc/files/lib/magic_userstamp/config_rb.html +108 -0
data/rdoc/files/lib/magic_userstamp/controller_rb.html +108 -0
data/rdoc/files/lib/{userstamp_rb.html → magic_userstamp/event_rb.html} +14 -7
data/rdoc/files/lib/magic_userstamp/magic_columns_rb.html +108 -0
data/rdoc/files/lib/{migration_helper_rb.html → magic_userstamp/migration_helper_rb.html} +12 -5
data/rdoc/files/lib/magic_userstamp/stampable_rb.html +108 -0
data/rdoc/files/lib/{stamper_rb.html → magic_userstamp/stamper_rb.html} +12 -5
data/rdoc/files/lib/{stampable_rb.html → magic_userstamp_rb.html} +6 -6
data/rdoc/fr_class_index.html +18 -13
data/rdoc/fr_file_index.html +11 -9
data/rdoc/fr_method_index.html +39 -9
data/rdoc/index.html +7 -5
data/spec/compatibility_stamping_spec.rb +3 -3
data/spec/config_spec.rb +5 -5
data/spec/magic_column_spec.rb +8 -8
data/spec/resources/controllers/magic_userstamp_controller.rb +9 -0
data/spec/resources/controllers/posts_controller.rb +2 -2
data/spec/resources/controllers/users_controller.rb +2 -2
data/spec/stamping_spec.rb +1 -1
metadata +36 -29
data/lib/userstamp.rb +0 -17
data/lib/userstamp/migration_helper.rb +0 -17
data/rdoc/classes/Ddb/Controller/Userstamp.html +0 -125
data/rdoc/classes/Ddb/Userstamp.html +0 -121
data/rdoc/classes/Ddb/Userstamp/MigrationHelper/InstanceMethods.html +0 -142
data/rdoc/classes/Ddb/Userstamp/Stampable.html +0 -128
data/rdoc/classes/Ddb/Userstamp/Stampable/ClassMethods.html +0 -222
data/rdoc/classes/Ddb/Userstamp/Stamper/InstanceMethods.html +0 -207
data/rdoc/files/CHANGELOG.html +0 -137
data/rdoc/files/LICENSE.html +0 -129
data/rdoc/files/README.html +0 -341
data/spec/resources/controllers/userstamp_controller.rb +0 -9

data/rdoc/files/LICENSE.html DELETED Viewed

@@ -1,129 +0,0 @@
-<?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>Tue Mar 11 20:24:59 -0600 2008</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.html DELETED Viewed

@@ -1,341 +0,0 @@
-<?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</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</h1>
-    <table class="header-table">
-    <tr class="top-aligned-row">
-      <td><strong>Path:</strong></td>
-      <td>README
-      </td>
-    </tr>
-    <tr class="top-aligned-row">
-      <td><strong>Last Update:</strong></td>
-      <td>Sat Apr 05 15:01:24 -0600 2008</td>
-    </tr>
-    </table>
-  </div>
-  <!-- banner header -->
-  <div id="bodyContent">
-  <div id="contextContent">
-    <div id="description">
-      <h1>Userstamp Plugin (v 2.0)</h1>
-<h2>Overview</h2>
-<p>
-The Userstamp Plugin 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>
-<p>
-Installation of the plugin can be done using the built in Rails plugin
-script. Issue the following command from the root of your application:
-</p>
-<pre>
-  script/plugin install git://github.com/delynn/userstamp.git
-</pre>
-<p>
-Once installed you will need to restart your application for the plugin to
-be loaded into the Rails environment.
-</p>
-<p>
-You might also be interested in using <a
-href="http://piston.rubyforge.org/index.html">Piston</a> to manage the
-importing and future updating of this plugin.
-</p>
-<h2>Usage</h2>
-<p>
-In this new version of the Userstamp plug-in, the assumption is that you
-have two different categories of objects; those that mani˝pulate, 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 Userstamp module for your
-controllers that assists in setting up your environment on a per request
-basis.
-</p>
-<p>
-To better understand how all this works, I think an example is in order.
-For this example we will assume that a weblog application is comprised of
-User and Post objects. The first thing we need to do is create the
-migrations for these objects, and the plug-in gives you a
-<tt>userstamps</tt> method for very easily doing this:
-</p>
-<pre>
-  class CreateUsers &lt; ActiveRecord::Migration
-    def self.up
-      create_table :users, :force =&gt; true do |t|
-        t.timestamps
-        t.userstamps
-        t.name
-      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.timestamps
-        t.userstamps
-        t.title
-      end
-    end
-    def self.down
-      drop_table :posts
-    end
-  end
-</pre>
-<p>
-Second, since Users are going to manipulate other objects in our project,
-we&#8216;ll use the <tt>model_stamper</tt> method in our User class:
-</p>
-<pre>
-  class User &lt; ActiveRecord::Base
-    model_stamper
-  end
-</pre>
-<p>
-Finally, we need to setup a controller to set the current user of the
-application. It&#8216;s recommended that you do this in your
-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 big change with this new version is that we are now using
-Thread.current to save the current stamper so as to avoid conflict with
-concurrent requests.
-</p>
-<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 Userstamp 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 Userstamp 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
-    acts_as_stampable :stamper_class_name =&gt; :person,
-                      :creator_attribute  =&gt; :create_user,
-                      :updater_attribute  =&gt; :update_user,
-                      :deleter_attribute  =&gt; :delete_user
-  end
-</pre>
-<p>
-If you are upgrading your application from the old version of Userstamp,
-there is a compatibility mode to have the plug-in use the old
-&quot;_by&quot; columns by default. To enable this mode, add the following
-line to the RAILS_ROOT/config/environment.rb file:
-</p>
-<pre>
-  Ddb::Userstamp.compatibility_mode = true
-</pre>
-<p>
-If you are having a difficult time getting the Userstamp plug-in to work, I
-recommend you checkout the sample application that I created. You can find
-this application on <a
-href="http://github.com/delynn/userstamp_sample">GitHub</a>
-</p>
-<h2>Uninstall</h2>
-<p>
-Uninstalling the plugin can be done using the built in Rails plugin script.
-Issue the following command from the root of your application:
-</p>
-<pre>
-  script/plugin remove userstamp
-</pre>
-<h2>Documentation</h2>
-<p>
-RDoc has been run on the plugin directory and is available in the doc
-directory.
-</p>
-<h2>Running Unit Tests</h2>
-<p>
-There are extensive unit tests in the &quot;test&quot; directory of the
-plugin. These test can be run individually by executing the following
-command from the userstamp directory:
-</p>
-<pre>
- ruby test/compatibility_stamping_test.rb
- ruby test/stamping_test.rb
- ruby test/userstamp_controller_test.rb
-</pre>
-<h2>Bugs &amp; Feedback</h2>
-<p>
-Bug reports and feedback are welcome via my delynn+userstamp@gmail.com
-email address. I also encouraged everyone to clone the git repository and
-make modifications&#8212;I&#8216;ll be more than happy to merge any changes
-from other people&#8216;s branches that would be beneficial to the whole
-project.
-</p>
-<h2>Credits and Special Thanks</h2>
-<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>
-    </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>