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/classes/{Ddb/Userstamp → MagicUserstamp}/Stamper.html RENAMED Viewed

@@ -1,14 +1,14 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
+<?xml version="1.0" encoding="utf-8"?>
 <!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::Userstamp::Stamper</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <title>Module: MagicUserstamp::Stamper</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
   <script type="text/javascript">
   // <![CDATA[
@@ -50,13 +50,13 @@
         <table class="header-table">
         <tr class="top-aligned-row">
           <td><strong>Module</strong></td>
-          <td class="class-name-in-header">Ddb::Userstamp::Stamper</td>
+          <td class="class-name-in-header">MagicUserstamp::Stamper</td>
         </tr>
         <tr class="top-aligned-row">
             <td><strong>In:</strong></td>
             <td>
-                <a href="../../../files/lib/stamper_rb.html">
-                lib/stamper.rb
+                <a href="../../files/lib/magic_userstamp/stamper_rb.html">
+                lib/magic_userstamp/stamper.rb
                 </a>
         <br />
             </td>
@@ -87,8 +87,8 @@
     <div id="class-list">
       <h3 class="section-bar">Classes and Modules</h3>
-      Module <a href="Stamper/ClassMethods.html" class="link">Ddb::Userstamp::Stamper::ClassMethods</a><br />
-Module <a href="Stamper/InstanceMethods.html" class="link">Ddb::Userstamp::Stamper::InstanceMethods</a><br />
+      Module <a href="Stamper/ClassMethods.html" class="link">MagicUserstamp::Stamper::ClassMethods</a><br />
+Module <a href="Stamper/InstanceMethods.html" class="link">MagicUserstamp::Stamper::InstanceMethods</a><br />
     </div>

data/rdoc/classes/{Ddb/Userstamp → MagicUserstamp}/Stamper/ClassMethods.html RENAMED Viewed

@@ -1,14 +1,14 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
+<?xml version="1.0" encoding="utf-8"?>
 <!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::Userstamp::Stamper::ClassMethods</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <title>Module: MagicUserstamp::Stamper::ClassMethods</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
   <script type="text/javascript">
   // <![CDATA[
@@ -50,13 +50,13 @@
         <table class="header-table">
         <tr class="top-aligned-row">
           <td><strong>Module</strong></td>
-          <td class="class-name-in-header">Ddb::Userstamp::Stamper::ClassMethods</td>
+          <td class="class-name-in-header">MagicUserstamp::Stamper::ClassMethods</td>
         </tr>
         <tr class="top-aligned-row">
             <td><strong>In:</strong></td>
             <td>
-                <a href="../../../../files/lib/stamper_rb.html">
-                lib/stamper.rb
+                <a href="../../../files/lib/magic_userstamp/stamper_rb.html">
+                lib/magic_userstamp/stamper.rb
                 </a>
         <br />
             </td>
@@ -80,7 +80,7 @@
       <h3 class="section-bar">Methods</h3>
       <div class="name-list">
-      <a href="#M000001">model_stamper</a>&nbsp;&nbsp;
+      <a href="#M000003">model_stamper</a>&nbsp;&nbsp;
       </div>
     </div>
@@ -102,26 +102,26 @@
     <div id="methods">
       <h3 class="section-bar">Public Instance methods</h3>
-      <div id="method-M000001" class="method-detail">
-        <a name="M000001"></a>
+      <div id="method-M000003" class="method-detail">
+        <a name="M000003"></a>
         <div class="method-heading">
-          <a href="#M000001" class="method-signature">
+          <a href="#M000003" class="method-signature">
           <span class="method-name">model_stamper</span><span class="method-args">()</span>
           </a>
         </div>
         <div class="method-description">
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000001-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000001-source">
+            onclick="toggleCode('M000003-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000003-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/stamper.rb, line 9</span>
- 9:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">model_stamper</span>
-10:           <span class="ruby-comment cmt"># don't allow multiple calls</span>
-11:           <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">included_modules</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-constant">Ddb</span><span class="ruby-operator">::</span><span class="ruby-constant">Userstamp</span><span class="ruby-operator">::</span><span class="ruby-constant">Stamper</span><span class="ruby-operator">::</span><span class="ruby-constant">InstanceMethods</span>)
-12:           <span class="ruby-identifier">send</span>(<span class="ruby-identifier">:extend</span>, <span class="ruby-constant">Ddb</span><span class="ruby-operator">::</span><span class="ruby-constant">Userstamp</span><span class="ruby-operator">::</span><span class="ruby-constant">Stamper</span><span class="ruby-operator">::</span><span class="ruby-constant">InstanceMethods</span>)
-13:         <span class="ruby-keyword kw">end</span>
+    <span class="ruby-comment cmt"># File lib/magic_userstamp/stamper.rb, line 10</span>
+10:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">model_stamper</span>
+11:         <span class="ruby-comment cmt"># don't allow multiple calls</span>
+12:         <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">if</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">MagicUserstamp</span><span class="ruby-operator">::</span><span class="ruby-constant">Stamper</span><span class="ruby-operator">::</span><span class="ruby-constant">InstanceMethods</span>)
+13:         <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">extend</span>(<span class="ruby-constant">MagicUserstamp</span><span class="ruby-operator">::</span><span class="ruby-constant">Stamper</span><span class="ruby-operator">::</span><span class="ruby-constant">InstanceMethods</span>)
+14:       <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>

data/rdoc/classes/MagicUserstamp/Stamper/InstanceMethods.html ADDED Viewed

@@ -0,0 +1,208 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!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: MagicUserstamp::Stamper::InstanceMethods</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <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">MagicUserstamp::Stamper::InstanceMethods</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../files/lib/magic_userstamp/stamper_rb.html">
+                lib/magic_userstamp/stamper.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000006">reset_stamper</a>&nbsp;&nbsp;
+      <a href="#M000005">stamper</a>&nbsp;&nbsp;
+      <a href="#M000004">stamper=</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000006" class="method-detail">
+        <a name="M000006"></a>
+        <div class="method-heading">
+          <a href="#M000006" class="method-signature">
+          <span class="method-name">reset_stamper</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Sets the <a href="InstanceMethods.html#M000005">stamper</a> back to
+<tt>nil</tt> to prepare for the next request.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000006-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000006-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/magic_userstamp/stamper.rb, line 36</span>
+36:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reset_stamper</span>
+37:         <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>[<span class="ruby-node">&quot;#{self.to_s.downcase}_#{self.object_id}_stamper&quot;</span>] = <span class="ruby-keyword kw">nil</span>
+38:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000005" class="method-detail">
+        <a name="M000005"></a>
+        <div class="method-heading">
+          <a href="#M000005" class="method-signature">
+          <span class="method-name">stamper</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Retrieves the existing <a href="InstanceMethods.html#M000005">stamper</a>
+for the current request.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000005-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000005-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/magic_userstamp/stamper.rb, line 31</span>
+31:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stamper</span>
+32:         <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>[<span class="ruby-node">&quot;#{self.to_s.downcase}_#{self.object_id}_stamper&quot;</span>]
+33:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+      <div id="method-M000004" class="method-detail">
+        <a name="M000004"></a>
+        <div class="method-heading">
+          <a href="#M000004" class="method-signature">
+          <span class="method-name">stamper=</span><span class="method-args">(object)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Used to set the <a href="InstanceMethods.html#M000005">stamper</a> for a
+particular request. See the <a
+href="../../MagicUserstamp.html">MagicUserstamp</a> module for more details
+on how to use this method.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000004-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000004-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/magic_userstamp/stamper.rb, line 20</span>
+20:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stamper=</span>(<span class="ruby-identifier">object</span>)
+21:         <span class="ruby-identifier">object_stamper</span> = <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">object</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">ActiveRecord</span><span class="ruby-operator">::</span><span class="ruby-constant">Base</span>)
+22:           <span class="ruby-identifier">object</span>.<span class="ruby-identifier">send</span>(<span class="ruby-node">&quot;#{object.class.primary_key}&quot;</span>.<span class="ruby-identifier">to_sym</span>)
+23:         <span class="ruby-keyword kw">else</span>
+24:           <span class="ruby-identifier">object</span>
+25:         <span class="ruby-keyword kw">end</span>
+26:
+27:         <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>[<span class="ruby-node">&quot;#{self.to_s.downcase}_#{self.object_id}_stamper&quot;</span>] = <span class="ruby-identifier">object_stamper</span>
+28:       <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/rdoc/created.rid CHANGED Viewed

	@@ -1 +1 @@
1	- ~~Sat~~, 05 ~~Apr~~ ~~2008~~ 15:11:35 ~~-0600~~
1	+ Wed, 28 Oct 2009 19:22:13 +0900

data/rdoc/files/README_rdoc.html ADDED Viewed

@@ -0,0 +1,268 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!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=utf-8" />
+  <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>Wed Oct 28 19:22:06 +0900 2009</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <h1><a href="../classes/MagicUserstamp.html">MagicUserstamp</a></h1>
+<h2>Install</h2>
+<h3>as a plugin</h3>
+<pre>
+ ruby script/plugin install git://github.com/akm/magic_userstamp.git
+</pre>
+<h3>as a gem</h3>
+<p>
+insert following line to config/environment.rb
+</p>
+<pre>
+  config.gem 'magic_userstamp', :version =&gt; '0.1.0'
+</pre>
+<p>
+and
+</p>
+<pre>
+ $ sudo rake gems:install
+</pre>
+<p>
+Or install gem manually
+</p>
+<pre>
+ $ sudo gem install gemcutter
+ $ sudo gem tumble
+ $ sudo gem install magic_userstamp
+</pre>
+<h2>Simple Configuration</h2>
+<p>
+make config/initializers/magic_userstamp.rb
+</p>
+<p>
+The most simple setting
+</p>
+<pre>
+ require 'magic_userstamp'
+ # Comment out if you don't use t.userstamp at all in migrations
+ ActiveRecord::ConnectionAdapters::TableDefinition.send(:include, MagicUserstamp::MigrationHelper)
+ ActiveRecord::Base.module_eval do
+   include MagicUserstamp
+ end
+ MagicUserstamp::Config.setup.defaults
+ # If you have some classes which has loaded before Userstamp is loaded,
+ # set record_userstamp true
+ # Example: vestal_versions gem
+ # Version.record_userstamp = true if defined?(Version)
+</pre>
+<h2>Controller setting</h2>
+<p>
+add followings to ApplicationController or some controller
+</p>
+<pre>
+  before_filter :set_user
+  after_filter :reset_user
+ def set_user
+   user_id = session[:user] # ここではIDが帰ってくるはず。
+   User.model_stamper       # UserがIDを覚えられるようにする。
+   User.stamper = user_id   # IDを覚えておく。stamper=にはオブジェクトを渡してもOK。
+ end
+ def reset_user
+   User.model_stamper  # Userが覚えているIDを忘れることができるようにする。
+   User.reset_stamper  # Userが覚えているIDを実際に忘れる。
+ end
+</pre>
+<h2>Various Configuration</h2>
+<p>
+If you want to customize setting, chage
+config/initializers/magic_userstamp.rb
+</p>
+<p>
+The most simple setting
+</p>
+<pre>
+ MagicUserstamp::Config.setup.defaults
+</pre>
+<p>
+Specify User class name
+</p>
+<pre>
+ MagicUserstamp::Config.setup.defaults(:stamper_class_name =&gt; 'AdminUser')
+</pre>
+<p>
+Actually
+</p>
+<pre>
+ MagicUserstamp::Config.setup.defaults
+</pre>
+<p>
+means
+</p>
+<pre>
+ MagicUserstamp.config.setup do |config|
+   config.with_options(:stamper_class_name =&gt; 'User') do |c|
+     c.on(:create , :creator_id)
+     c.on(:update , :updater_id)
+     c.on(:destroy, :deleter_id)
+   end
+ end
+</pre>
+<p>
+Specify User class name and creator/updater columns
+</p>
+<pre>
+ MagicUserstamp.config.setup do |config|
+   config.with_options(:stamper_class_name =&gt; 'Person') do |c|
+     c.on(:create , :creator_person_id)
+     c.on(:update , :updater_person_id)
+     c.on(:destroy, :deleter_person_id)
+   end
+ end
+</pre>
+<p>
+Specify target stampable class names
+</p>
+<pre>
+ MagicUserstamp.config.setup do |config|
+   config.defaults(:stampable_class_names =&gt; %w(Book Schedule))
+</pre>
+<p>
+Specify target stampable class names and columns
+</p>
+<pre>
+ MagicUserstamp.config.setup do |config|
+   config.with_options(:stampable_class_names =&gt; %w(Book Schedule)) do |c|
+     c.on(:create , :creator_user_id)
+     c.on(:update , :updater_user_id)
+     c.on(:destroy, :deleter_user_id)
+   end
+ end
+</pre>
+<p>
+Use in compatibility mode
+</p>
+<pre>
+ MagicUserstamp.config.compatibles
+</pre>
+<p>
+Same as
+</p>
+<pre>
+ MagicUserstamp.config.setup do |c|
+   c.on(:create , :created_by)
+   c.on(:update , :updated_by)
+   c.on(:destroy, :deleted_by)
+ end
+</pre>
+<p>
+Complex pattern
+</p>
+<pre>
+ MagicUserstamp.config.setup do |config|
+   config.with_options(:stampable_class_names =&gt; %w(Book Schedule)) do |c|
+     c.on(:create , :creator_user_id)
+     c.on(:update , :updater_user_id)
+     c.on(:destroy, :deleter_user_id)
+   end
+   config.compatibles(:stamper_class_name =&gt; 'Person', :stampable_class_names =&gt; %w(Person Email))
+   config.defaults
+ end
+</pre>
+    </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>