mack-data_factory 0.6.1.2 → 0.7.0

data/README

@@ -16,34 +16,36 @@ Let's say that I have 2 models: Item and User, and Item belongs to user.  So the
     class ItemFactory
         include Mack::Data::Factory
         
-        field :title, "MyItem"
-        field :owner_id, {:user => 'id'}
+        field :title, :default => "MyItem"
+        association :owner_id, {:user => 'id'}
     end
     
     class UserFactory
         include Mack::Data::Factory
         
-        field :username, "planters", :length => 25, :content => :alpha
-        field :password, "roastedPeanuts", :immutable => true
+        field :username, :default => "planters", :length => 25, :content => :alpha
+        field :password, :default => "roastedPeanuts", :immutable => true
     end
     
-So, the 2 classes above defined the factory for item and user.  As you can see, each factory will need to explicitly 
-list all the fields that it will populate, and for each field, you can define rules on how the content is generated.
+So, the 2 classes above defined the factory for item and user.  As you can see, each factory will need to explicitly list all the fields that it will populate, and for each field, you can define rules on how the content is generated.  
+
 Important: For each field defined in the factory, you will need to make sure that there's a corresponding setter 
 method in the model class (e.g. Item class is required to have title= and owner_id=).
 
-For numeric content, you can specify the start number and end number, and the content generator will generate a random number 
-between that range.
+For numeric content, you can specify the start number and end number, and the content generator will generate a random number between that range.
 
-For all fields, you can specify :immutable to true, which means for all instances created, the content for that field
-will not change.
+For all fields, you can specify :immutable to true, which means for all instances created, the default value for that field will not change.
 
+To define a default value for a field, you use the :default options (e.g. field :username, :default => 'planters')
 
 Supported content types: 
   # Strings and Numbers
   - :alpha --> alphabets.  rules: [:length, :min_length, :max_length]
   - :alphanumeric --> alphabets and number.  rules: same as :alpha
   - :numeric --> numbers [optional, because if the field's default value is number, its content type will automatically set to numeric)
+  # Time and Money
+  - :time --> generate random time object.  rules: [:start_time, :end_time].  It will generate random time between the given start and end time if available, otherwise it'll generate random time between 'now' and 1 day from 'now'
+  - :money --> generate random amount of money. rules: [:min, :max].  It will generate random money amount (of BigDecimal type) between the given min and max amount.
   # Internet related content
   - :email --> generate random email address
   - :username --> generate random username
@@ -69,21 +71,18 @@ Supported content types:
 class ItemFactory
     include Mack::Data::Factory
     
-    field :title, "MyItem"
-    field :owner_id, {:user => 'id'}, {:assoc => :first}
+    field :title, :default => "MyItem"
+    association :owner_id, {:user => 'id'}, :first
 end
 
 class UserFactory
     include Mack::Data::Factory
     
-    field :username, "planters", :length => 25, :content => :alpha
-    field :password, "roastedPeanuts", :immutable => true
+    field :username, :default => "planters", :length => 25, :content => :alpha
+    field :password, :default => "roastedPeanuts", :immutable => true
 end
 
-In the above example, the ItemFactory define the owner_id field's value as {:user => 'id'}.  When the factory is run,
-it will generate value for owner_id as 'the id of the user #x'.  You can also pass in rules to define which instance 
-of user that the id will be retrieved from.  The rules are: :first, :last, :random, and :spread.  The default is :spread.
-Definition of the association rules:
+In the above example, the ItemFactory define the owner_id field as an association to {:user => 'id'}.  When the factory is run, it will generate value for owner_id as 'the id of the user #x'.  You can also pass in rules to define which instance of user that the id will be retrieved from.  The rules are: :first, :last, :random, and :spread.  The default is :spread.  Definition of the association rules:
   :first  --> always associate with the first object that this object belongs to.  If there are 10 users [id = 0 - 10], then the item will always get associated with user #0 (i.e. item's owner_id always == 0)
   :last   --> always associate with the last object that this object belongs to.  If there are 10 users [id = 0 - 10], then the item will always get associated with user #10 (i.e. item's owner_id always == 9)
   :random --> always associate with the Nth object that this object belongs to (and N is random). If there are 10 users [id = 0 - 10], then the item will get associated with user #n (i.e. item's owner_id == rand(10))
@@ -121,11 +120,11 @@ the following:
     class UserFactory
         include Mack::Data::Factory
     
-        field :username, "planters", :length => 25, :content => :alpha
-        field :password, "roastedPeanuts", :immutable => true
+        field :username, :default => "planters", :length => 25, :content => :alpha
+        field :password, :default => "roastedPeanuts", :immutable => true
         
         scope_for(:long_username) do
-            field :username, "planters", :length => 128, :content => :alpha
+            field :username, :default => "planters", :length => 128, :content => :alpha
         end
     end
     
@@ -147,10 +146,10 @@ accomplish that:
     class UserFactory
         include Mack::Data::Factory
         
-        field :username, "planters" do |def_value, rules, index| 
+        field :username, :default => "planters" do |def_value, rules, index| 
             "#{def_value}#{index}"
         end
-        field :password, "roastedPeanuts", :immutable => true
+        field :password, :default => "roastedPeanuts", :immutable => true
         
     end
 

data/doc/classes/Kernel.html

@@ -80,8 +80,8 @@
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000051">factories</a>&nbsp;&nbsp;
-      <a href="#M000052">run_factories</a>&nbsp;&nbsp;
+      <a href="#M000052">factories</a>&nbsp;&nbsp;
+      <a href="#M000053">run_factories</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -103,11 +103,11 @@
     <div id="methods">
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000051" class="method-detail">
-        <a name="M000051"></a>
+      <div id="method-M000052" class="method-detail">
+        <a name="M000052"></a>
 
         <div class="method-heading">
-          <a href="#M000051" class="method-signature">
+          <a href="#M000052" class="method-signature">
           <span class="method-name">factories</span><span class="method-args">(tag, &amp;block)</span>
           </a>
         </div>
@@ -115,7 +115,7 @@
         <div class="method-description">
           <p>
 Convenient routine to create an execution chain of <a
-href="Kernel.html#M000051">factories</a>
+href="Kernel.html#M000052">factories</a>
 </p>
 <p>
 Example:
@@ -128,7 +128,7 @@ Example:
 </pre>
 <p>
 Then to execute the chains, you&#8216;ll need to call <a
-href="Kernel.html#M000052">run_factories</a>, and pass in the name of the
+href="Kernel.html#M000053">run_factories</a>, and pass in the name of the
 chain you want to execute.
 </p>
 <p>
@@ -142,8 +142,8 @@ Example:
 executed later
 </p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000051-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000051-source">
+            onclick="toggleCode('M000052-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000052-source">
 <pre>
     <span class="ruby-comment cmt"># File lib/mack-data_factory/core_extensions/kernel.rb, line 28</span>
 28:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">factories</span>(<span class="ruby-identifier">tag</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
@@ -155,11 +155,11 @@ executed later
         </div>
       </div>
 
-      <div id="method-M000052" class="method-detail">
-        <a name="M000052"></a>
+      <div id="method-M000053" class="method-detail">
+        <a name="M000053"></a>
 
         <div class="method-heading">
-          <a href="#M000052" class="method-signature">
+          <a href="#M000053" class="method-signature">
           <span class="method-name">run_factories</span><span class="method-args">(tag)</span>
           </a>
         </div>
@@ -169,12 +169,12 @@ executed later
 Run defined factory chain
 </p>
 <p>
-@see <a href="Kernel.html#M000051">factories</a> @tag &#8212; the name of
+@see <a href="Kernel.html#M000052">factories</a> @tag &#8212; the name of
 the factory chain to be run @return true if successful, false otherwise
 </p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000052-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000052-source">
+            onclick="toggleCode('M000053-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000053-source">
 <pre>
     <span class="ruby-comment cmt"># File lib/mack-data_factory/core_extensions/kernel.rb, line 39</span>
 39:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">run_factories</span>(<span class="ruby-identifier">tag</span>)

data/doc/classes/Mack.html

@@ -116,12 +116,6 @@
 
     <div id="section">
 
-    <div id="class-list">
-      <h3 class="section-bar">Classes and Modules</h3>
-
-      Module <a href="Mack/Data.html" class="link">Mack::Data</a><br />
-
-    </div>
 
 
 

data/doc/classes/Mack/Data/Bridge.html

@@ -86,12 +86,12 @@
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000049">count</a>&nbsp;&nbsp;
-      <a href="#M000046">get</a>&nbsp;&nbsp;
-      <a href="#M000047">get_all</a>&nbsp;&nbsp;
-      <a href="#M000048">get_first</a>&nbsp;&nbsp;
-      <a href="#M000045">new</a>&nbsp;&nbsp;
-      <a href="#M000050">save</a>&nbsp;&nbsp;
+      <a href="#M000050">count</a>&nbsp;&nbsp;
+      <a href="#M000047">get</a>&nbsp;&nbsp;
+      <a href="#M000048">get_all</a>&nbsp;&nbsp;
+      <a href="#M000049">get_first</a>&nbsp;&nbsp;
+      <a href="#M000046">new</a>&nbsp;&nbsp;
+      <a href="#M000051">save</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -113,19 +113,19 @@
     <div id="methods">
       <h3 class="section-bar">Public Class methods</h3>
 
-      <div id="method-M000045" class="method-detail">
-        <a name="M000045"></a>
+      <div id="method-M000046" class="method-detail">
+        <a name="M000046"></a>
 
         <div class="method-heading">
-          <a href="#M000045" class="method-signature">
+          <a href="#M000046" class="method-signature">
           <span class="method-name">new</span><span class="method-args">()</span>
           </a>
         </div>
       
         <div class="method-description">
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000045-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000045-source">
+            onclick="toggleCode('M000046-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000046-source">
 <pre>
     <span class="ruby-comment cmt"># File lib/mack-data_factory/orm_api_bridge/bridge.rb, line 9</span>
  9:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
@@ -139,19 +139,19 @@
 
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000049" class="method-detail">
-        <a name="M000049"></a>
+      <div id="method-M000050" class="method-detail">
+        <a name="M000050"></a>
 
         <div class="method-heading">
-          <a href="#M000049" class="method-signature">
+          <a href="#M000050" class="method-signature">
           <span class="method-name">count</span><span class="method-args">(obj, *args)</span>
           </a>
         </div>
       
         <div class="method-description">
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000049-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000049-source">
+            onclick="toggleCode('M000050-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000050-source">
 <pre>
     <span class="ruby-comment cmt"># File lib/mack-data_factory/orm_api_bridge/bridge.rb, line 26</span>
 26:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">count</span>(<span class="ruby-identifier">obj</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
@@ -162,19 +162,19 @@
         </div>
       </div>
 
-      <div id="method-M000046" class="method-detail">
-        <a name="M000046"></a>
+      <div id="method-M000047" class="method-detail">
+        <a name="M000047"></a>
 
         <div class="method-heading">
-          <a href="#M000046" class="method-signature">
+          <a href="#M000047" class="method-signature">
           <span class="method-name">get</span><span class="method-args">(obj, *args)</span>
           </a>
         </div>
       
         <div class="method-description">
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000046-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000046-source">
+            onclick="toggleCode('M000047-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000047-source">
 <pre>
     <span class="ruby-comment cmt"># File lib/mack-data_factory/orm_api_bridge/bridge.rb, line 14</span>
 14:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get</span>(<span class="ruby-identifier">obj</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
@@ -185,19 +185,19 @@
         </div>
       </div>
 
-      <div id="method-M000047" class="method-detail">
-        <a name="M000047"></a>
+      <div id="method-M000048" class="method-detail">
+        <a name="M000048"></a>
 
         <div class="method-heading">
-          <a href="#M000047" class="method-signature">
+          <a href="#M000048" class="method-signature">
           <span class="method-name">get_all</span><span class="method-args">(obj, *args)</span>
           </a>
         </div>
       
         <div class="method-description">
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000047-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000047-source">
+            onclick="toggleCode('M000048-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000048-source">
 <pre>
     <span class="ruby-comment cmt"># File lib/mack-data_factory/orm_api_bridge/bridge.rb, line 18</span>
 18:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_all</span>(<span class="ruby-identifier">obj</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
@@ -208,19 +208,19 @@
         </div>
       </div>
 
-      <div id="method-M000048" class="method-detail">
-        <a name="M000048"></a>
+      <div id="method-M000049" class="method-detail">
+        <a name="M000049"></a>
 
         <div class="method-heading">
-          <a href="#M000048" class="method-signature">
+          <a href="#M000049" class="method-signature">
           <span class="method-name">get_first</span><span class="method-args">(obj, *args)</span>
           </a>
         </div>
       
         <div class="method-description">
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000048-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000048-source">
+            onclick="toggleCode('M000049-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000049-source">
 <pre>
     <span class="ruby-comment cmt"># File lib/mack-data_factory/orm_api_bridge/bridge.rb, line 22</span>
 22:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_first</span>(<span class="ruby-identifier">obj</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
@@ -231,19 +231,19 @@
         </div>
       </div>
 
-      <div id="method-M000050" class="method-detail">
-        <a name="M000050"></a>
+      <div id="method-M000051" class="method-detail">
+        <a name="M000051"></a>
 
         <div class="method-heading">
-          <a href="#M000050" class="method-signature">
+          <a href="#M000051" class="method-signature">
           <span class="method-name">save</span><span class="method-args">(obj, *args)</span>
           </a>
         </div>
       
         <div class="method-description">
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000050-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000050-source">
+            onclick="toggleCode('M000051-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000051-source">
 <pre>
     <span class="ruby-comment cmt"># File lib/mack-data_factory/orm_api_bridge/bridge.rb, line 30</span>
 30:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">save</span>(<span class="ruby-identifier">obj</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)

data/doc/classes/Mack/Data/Factory/ClassMethods.html

@@ -80,9 +80,10 @@
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
+      <a href="#M000004">association</a>&nbsp;&nbsp;
       <a href="#M000002">create</a>&nbsp;&nbsp;
       <a href="#M000003">field</a>&nbsp;&nbsp;
-      <a href="#M000004">scope_for</a>&nbsp;&nbsp;
+      <a href="#M000005">scope_for</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -104,6 +105,33 @@
     <div id="methods">
       <h3 class="section-bar">Public Instance methods</h3>
 
+      <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">association</span><span class="method-args">(model_attrib_sym, assoc_map, assoc_rule = :spread)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Define an <a href="ClassMethods.html#M000004">association</a> rule for this
+<a href="ClassMethods.html#M000003">field</a>
+</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/mack-data_factory/data_factory.rb, line 88</span>
+88:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">association</span>(<span class="ruby-identifier">model_attrib_sym</span>, <span class="ruby-identifier">assoc_map</span>, <span class="ruby-identifier">assoc_rule</span> = <span class="ruby-identifier">:spread</span>)
+89:           <span class="ruby-identifier">field</span>(<span class="ruby-identifier">model_attrib_sym</span>, {<span class="ruby-identifier">:default</span> =<span class="ruby-operator">&gt;</span> {<span class="ruby-identifier">:df_assoc_map</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">assoc_map</span>}, <span class="ruby-identifier">:assoc</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">assoc_rule</span>})
+90:         <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
       <div id="method-M000002" class="method-detail">
         <a name="M000002"></a>
 
@@ -122,7 +150,7 @@ Example: class CarFactory
 </p>
 <pre>
    include Mack::Data::Factory
-   field :name, &quot;honda&quot; { |def_value, rules, index| &quot;#{def_value} #{['civic', 'accord', 'pilot'].randomize[0]}&quot;}
+   field :name, :default =&gt; &quot;honda&quot; { |def_value, rules, index| &quot;#{def_value} #{['civic', 'accord', 'pilot'].randomize[0]}&quot;}
 </pre>
 <p>
 end
@@ -195,7 +223,7 @@ params:
 
         <div class="method-heading">
           <a href="#M000003" class="method-signature">
-          <span class="method-name">field</span><span class="method-args">(model_attrib_sym, default_value, options = {}, &amp;block)</span>
+          <span class="method-name">field</span><span class="method-args">(model_attrib_sym, options = {}, &amp;block)</span>
           </a>
         </div>
       
@@ -209,19 +237,19 @@ value and rules and an optional content generator for this factory
           <div class="method-source-code" id="M000003-source">
 <pre>
     <span class="ruby-comment cmt"># File lib/mack-data_factory/data_factory.rb, line 81</span>
-81:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">field</span>(<span class="ruby-identifier">model_attrib_sym</span>, <span class="ruby-identifier">default_value</span>, <span class="ruby-identifier">options</span> = {}, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
-82:           <span class="ruby-identifier">field_manager</span>.<span class="ruby-identifier">add</span>(<span class="ruby-identifier">scope</span>, <span class="ruby-identifier">model_attrib_sym</span>, <span class="ruby-identifier">default_value</span>, <span class="ruby-identifier">options</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
+81:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">field</span>(<span class="ruby-identifier">model_attrib_sym</span>, <span class="ruby-identifier">options</span> = {}, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
+82:           <span class="ruby-identifier">field_manager</span>.<span class="ruby-identifier">add</span>(<span class="ruby-identifier">scope</span>, <span class="ruby-identifier">model_attrib_sym</span>, <span class="ruby-identifier">options</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
 83:         <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>
       </div>
 
-      <div id="method-M000004" class="method-detail">
-        <a name="M000004"></a>
+      <div id="method-M000005" class="method-detail">
+        <a name="M000005"></a>
 
         <div class="method-heading">
-          <a href="#M000004" class="method-signature">
+          <a href="#M000005" class="method-signature">
           <span class="method-name">scope_for</span><span class="method-args">(tag) {|| ...}</span>
           </a>
         </div>
@@ -233,15 +261,15 @@ href="ClassMethods.html#M000003">field</a> defined in a scope will
 overwrite its cousin in the default scope.
 </p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000004-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000004-source">
+            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/mack-data_factory/data_factory.rb, line 89</span>
-89:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">scope_for</span>(<span class="ruby-identifier">tag</span>)
-90:           <span class="ruby-identifier">set_scope</span>(<span class="ruby-identifier">tag</span>)
-91:           <span class="ruby-keyword kw">yield</span>
-92:           <span class="ruby-identifier">set_scope</span>(<span class="ruby-identifier">:default</span>)
-93:         <span class="ruby-keyword kw">end</span>
+     <span class="ruby-comment cmt"># File lib/mack-data_factory/data_factory.rb, line 96</span>
+ 96:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">scope_for</span>(<span class="ruby-identifier">tag</span>)
+ 97:           <span class="ruby-identifier">set_scope</span>(<span class="ruby-identifier">tag</span>)
+ 98:           <span class="ruby-keyword kw">yield</span>
+ 99:           <span class="ruby-identifier">set_scope</span>(<span class="ruby-identifier">:default</span>)
+100:         <span class="ruby-keyword kw">end</span>
 </pre>
           </div>
         </div>