dtf 0.2.8 → 0.2.9

data/app/models/analysis_case.rb

@@ -1,5 +1,8 @@
 # encoding: UTF-8
 
+# AnalysisCase defines the 'test premise', which is broken down into steps called CaseTests
+#
+# AnalysisCases own CaseTests. Users own each CaseTest through its AnalysisCase
 class AnalysisCase < ActiveRecord::Base
 
   attr_accessible :name, :description

data/app/models/case_test.rb

@@ -1,5 +1,6 @@
 # encoding: UTF-8
 
+# CaseTest is the recording of each individual step of an AnalysisCase's 'test premise'
 class CaseTest < ActiveRecord::Base
 
   attr_accessible :description, :cmd

data/app/models/user.rb

@@ -1,5 +1,6 @@
 # encoding: UTF-8
 
+# User class owns all Verification Suites in the DTF system
 class User < ActiveRecord::Base
 
   attr_accessible :full_name, :email_address, :user_name

data/app/models/verification_suite.rb

@@ -1,5 +1,16 @@
 # encoding: UTF-8
 
+# VerificationSuite is the core container class. 
+#
+# ASSOCIATIONS BREAKDOWN: It contains many AnalysisCases. Each AnalysisCase contains 
+# multiple case_tests, owned by both the User and the AnalysisCase. The goal is to 
+# make 'packs' of tests which Users can share between Suites, grouped by Cases, and 
+# even share those Tests between Cases. 
+# 
+# Also, Users should be able to share their individual Test(s), AnalysisCase(s), through 
+# their VerificationSuite(s) with other Users for inclusion in their own AnalysisCase(s) 
+# and Suite(s) allowing for mix-and-match batching.
+
 class VerificationSuite < ActiveRecord::Base
 
   attr_accessible :name, :description
@@ -9,14 +20,4 @@ class VerificationSuite < ActiveRecord::Base
   has_many :analysis_cases, :dependent => :destroy
   has_many :case_tests, :through => :analysis_cases, :dependent => :destroy
 
-  # ASSOCIATIONS BREAKDOWN
-  # ----------------------
-  # Each VerificationSuite is comprised of many AnalysisCases, Each AnalysisCase
-  # contain multiple case_tests, owned by both the User and the AnalysisCase.
-  # The goal is to make 'packs' of tests which Users can share between Suites,
-  # grouped by Cases, and even share those Tests between Cases. Also, Users
-  # should be able to share their individual Test(s), AnalysisCase(s), and
-  # VerificationSuite(s) with other Users for inclusion in their own
-  # AnalysisCase(s) and Suite(s) allowing for mix-and-match batching.
-
 end

data/doc/AnalysisCase.html

@@ -101,8 +101,23 @@
 </dl>
 <div class="clear"></div>
 
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>AnalysisCase defines the 'test premise', which is broken down into steps
+called CaseTests</p>
+
+<p>AnalysisCases own CaseTests. Users own each CaseTest through its
+AnalysisCase</p>
 
 
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+
 
 
 
@@ -114,7 +129,7 @@
 </div>
 
     <div id="footer">
-  Generated on Thu Sep 20 00:16:43 2012 by
+  Generated on Thu Sep 20 10:37:21 2012 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.2.1 (ruby-1.9.3).
 </div>

data/doc/CaseTest.html

@@ -101,7 +101,19 @@
 </dl>
 <div class="clear"></div>
 
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>CaseTest is the recording of each individual step of an AnalysisCase's
+'test premise'</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
 
+</div>
 
 
 
@@ -114,7 +126,7 @@
 </div>
 
     <div id="footer">
-  Generated on Thu Sep 20 00:16:43 2012 by
+  Generated on Thu Sep 20 10:37:21 2012 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.2.1 (ruby-1.9.3).
 </div>

data/doc/Dtf.html

@@ -104,7 +104,7 @@
         <dt id="VERSION-constant" class="">VERSION =
           
         </dt>
-        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.2.7</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.2.8</span><span class='tstring_end'>&quot;</span></span></pre></dd>
       
     </dl>
   
@@ -120,7 +120,7 @@
 </div>
 
     <div id="footer">
-  Generated on Thu Sep 20 00:16:43 2012 by
+  Generated on Thu Sep 20 10:37:21 2012 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.2.1 (ruby-1.9.3).
 </div>

data/doc/Dtf/Command.html

@@ -103,8 +103,8 @@
   <div class="discussion">
     
 <p>Dtf::Command contains all sub-commands availabe in the DTF master gem. All
-methods recieve the @cmd and @cmd_opts parsed from the command-line. They
-are what was captured in the ivars in Dtf::HelpSystem</p>
+methods receive the @cmd and @cmd_opts returned by
+Dtf::OptionsParser.parse_cmds()</p>
 
 
   </div>
@@ -293,31 +293,31 @@ and <b>must</b> be unique in the system.</p>
       <pre class="lines">
 
 
-128
-129
-130
-131
-132
-133
-134
-135
-136
-137
-138
-139
-140
-141
-142
 143
 144
 145
 146
 147
 148
-149</pre>
+149
+150
+151
+152
+153
+154
+155
+156
+157
+158
+159
+160
+161
+162
+163
+164</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/dtf.rb', line 128</span>
+      <pre class="code"><span class="info file"># File 'lib/dtf.rb', line 143</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_create_user'>create_user</span><span class='lparen'>(</span><span class='id identifier rubyid_cmd'>cmd</span><span class='comma'>,</span> <span class='id identifier rubyid_cmd_opts'>cmd_opts</span><span class='rparen'>)</span>
   <span class='kw'>if</span> <span class='lbracket'>[</span><span class='symbol'>:user_name_given</span><span class='comma'>,</span> <span class='symbol'>:full_name_given</span><span class='comma'>,</span> <span class='symbol'>:email_address_given</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_all?'>all?</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_sym'>sym</span><span class='op'>|</span> <span class='id identifier rubyid_cmd_opts'>cmd_opts</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='id identifier rubyid_sym'>sym</span><span class='rparen'>)</span> <span class='rbrace'>}</span> <span class='kw'>then</span>
@@ -388,23 +388,23 @@ Verification Suite's use. e.g. --description "RSpec Verification"</p>
       <pre class="lines">
 
 
-216
-217
-218
-219
-220
-221
-222
-223
-224
-225
-226
-227
-228
-229</pre>
+231
+232
+233
+234
+235
+236
+237
+238
+239
+240
+241
+242
+243
+244</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/dtf.rb', line 216</span>
+      <pre class="code"><span class="info file"># File 'lib/dtf.rb', line 231</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_create_vs'>create_vs</span><span class='lparen'>(</span><span class='id identifier rubyid_cmd'>cmd</span><span class='comma'>,</span> <span class='id identifier rubyid_cmd_opts'>cmd_opts</span><span class='rparen'>)</span>
   <span class='kw'>if</span> <span class='lbracket'>[</span><span class='symbol'>:user_name_given</span><span class='comma'>,</span> <span class='symbol'>:name_given</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_all?'>all?</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_sym'>sym</span><span class='op'>|</span> <span class='id identifier rubyid_cmd_opts'>cmd_opts</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='id identifier rubyid_sym'>sym</span><span class='rparen'>)</span> <span class='rbrace'>}</span> <span class='kw'>then</span>
@@ -470,21 +470,6 @@ which is the generic in-house User shipped with DTF.</p>
       <pre class="lines">
 
 
-167
-168
-169
-170
-171
-172
-173
-174
-175
-176
-177
-178
-179
-180
-181
 182
 183
 184
@@ -503,10 +488,25 @@ which is the generic in-house User shipped with DTF.</p>
 197
 198
 199
-200</pre>
+200
+201
+202
+203
+204
+205
+206
+207
+208
+209
+210
+211
+212
+213
+214
+215</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/dtf.rb', line 167</span>
+      <pre class="code"><span class="info file"># File 'lib/dtf.rb', line 182</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_delete_user'>delete_user</span><span class='lparen'>(</span><span class='id identifier rubyid_cmd'>cmd</span><span class='comma'>,</span> <span class='id identifier rubyid_cmd_opts'>cmd_opts</span><span class='rparen'>)</span>
   <span class='kw'>if</span> <span class='lbracket'>[</span><span class='symbol'>:user_name_given</span><span class='comma'>,</span> <span class='symbol'>:delete_all</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_all?'>all?</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_sym'>sym</span><span class='op'>|</span> <span class='id identifier rubyid_cmd_opts'>cmd_opts</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='id identifier rubyid_sym'>sym</span><span class='rparen'>)</span> <span class='rbrace'>}</span> <span class='kw'>then</span>
@@ -582,19 +582,19 @@ the Verification Suite you wish to delete, as provided by @vs.id</p>
       <pre class="lines">
 
 
-238
-239
-240
-241
-242
-243
-244
-245
-246
-247</pre>
+253
+254
+255
+256
+257
+258
+259
+260
+261
+262</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/dtf.rb', line 238</span>
+      <pre class="code"><span class="info file"># File 'lib/dtf.rb', line 253</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_delete_vs'>delete_vs</span><span class='lparen'>(</span><span class='id identifier rubyid_cmd'>cmd</span><span class='comma'>,</span> <span class='id identifier rubyid_cmd_opts'>cmd_opts</span><span class='rparen'>)</span>
   <span class='kw'>if</span> <span class='lbracket'>[</span><span class='symbol'>:user_name_given</span><span class='comma'>,</span> <span class='symbol'>:id_given</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_all?'>all?</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_sym'>sym</span><span class='op'>|</span> <span class='id identifier rubyid_cmd_opts'>cmd_opts</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='id identifier rubyid_sym'>sym</span><span class='rparen'>)</span> <span class='rbrace'>}</span> <span class='kw'>then</span>
@@ -629,8 +629,9 @@ execute and then hands off to the appropriate method. All methods are a 1:1
 match in their name. e.g 'create_user' sub-command is matched to the
 'create_user' method of this class.</p>
 
-<p>This method requires, and processes, 2 arguments. The 'cmd' to process, and
-any 'cmd_opts' of that sub-command.</p>
+<p>This method requires, and processes, 2 arguments. The first is a String,
+the second is a Hash. They are the 'cmd' to process and any
+options/parameters, stored in the 'cmd_opts' hash, of that sub-command.</p>
 
 
   </div>
@@ -644,28 +645,28 @@ any 'cmd_opts' of that sub-command.</p>
       <pre class="lines">
 
 
-100
-101
-102
-103
-104
-105
-106
-107
-108
-109
-110
-111
-112
-113
-114
 115
 116
 117
-118</pre>
+118
+119
+120
+121
+122
+123
+124
+125
+126
+127
+128
+129
+130
+131
+132
+133</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/dtf.rb', line 100</span>
+      <pre class="code"><span class="info file"># File 'lib/dtf.rb', line 115</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_process'>process</span><span class='lparen'>(</span><span class='id identifier rubyid_cmd'>cmd</span><span class='comma'>,</span> <span class='id identifier rubyid_cmd_opts'>cmd_opts</span><span class='rparen'>)</span>
   <span class='kw'>case</span> <span class='id identifier rubyid_cmd'>cmd</span>
@@ -696,7 +697,7 @@ any 'cmd_opts' of that sub-command.</p>
 </div>
 
     <div id="footer">
-  Generated on Thu Sep 20 00:16:43 2012 by
+  Generated on Thu Sep 20 10:37:21 2012 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.2.1 (ruby-1.9.3).
 </div>

data/doc/Dtf/ErrorSystem.html

@@ -99,7 +99,18 @@
 </dl>
 <div class="clear"></div>
 
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>Dtf::ErrorSystem is DTF's custom error management class</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
 
+</div>
 
 
 
@@ -131,7 +142,9 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>Reusable object error display method.</p>
+</div></span>
   
 </li>
 
@@ -154,7 +167,7 @@
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Reusable error response method.</p>
+<p>Reusable error raising and response method.</p>
 </div></span>
   
 </li>
@@ -178,22 +191,38 @@
   
 
   
-</h3><table class="source_code">
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Reusable object error display method.</p>
+
+<p>Takes an Object as arg and displays that Object's full error messages. Will
+return the @user object's full error messages, 1 per line.</p>
+
+<p>Example usage: Dtf::ErrorSystem.display_errors(@user)</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-20
-21
-22
-23
-24
-25
-26</pre>
+27
+28
+29
+30
+31
+32
+33</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/dtf.rb', line 20</span>
+      <pre class="code"><span class="info file"># File 'lib/dtf.rb', line 27</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_display_errors'>display_errors</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
   <span class='comment'># TODO: Refactor error display to take sub-command as an arg
@@ -219,7 +248,8 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Reusable error response method</p>
+<p>Reusable error raising and response method. Returns exit status code of '1'
+via abort().</p>
 
 
   </div>
@@ -233,25 +263,23 @@
       <pre class="lines">
 
 
-11
-12
 13
 14
 15
 16
 17
-18</pre>
+18
+19</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/dtf.rb', line 11</span>
+      <pre class="code"><span class="info file"># File 'lib/dtf.rb', line 13</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_raise_error'>raise_error</span><span class='lparen'>(</span><span class='id identifier rubyid_cmd'>cmd</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span>
 <span class='kw'>rescue</span>
   <span class='gvar'>$stderr</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ERROR! </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_cmd'>cmd</span><span class='rbrace'>}</span><span class='tstring_content'> did not receive all required options.</span><span class='tstring_end'>&quot;</span></span>
   <span class='gvar'>$stderr</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Please execute \'dtf </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_cmd'>cmd</span><span class='rbrace'>}</span><span class='tstring_content'> -h\' for more information.</span><span class='tstring_end'>&quot;</span></span>
-  <span class='comment'># Set non-zero exit value on error, for scripting use.
-</span>  <span class='id identifier rubyid_abort'>abort</span><span class='lparen'>(</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_abort'>abort</span><span class='lparen'>(</span><span class='rparen'>)</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -263,7 +291,7 @@
 </div>
 
     <div id="footer">
-  Generated on Thu Sep 20 00:16:43 2012 by
+  Generated on Thu Sep 20 10:37:21 2012 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.2.1 (ruby-1.9.3).
 </div>

data/doc/Dtf/OptionsParser.html

@@ -102,7 +102,8 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
     
-<p>End of Dtf::ErrorSystem class</p>
+<p>Dtf::OptionsParser is DTF's command/options/parameters parsing class. It
+also doubles as DTF's help system.</p>
 
 
   </div>
@@ -165,7 +166,9 @@
   
 
   
-    <span class="summary_desc"><div class='inline'></div></span>
+    <span class="summary_desc"><div class='inline'>
+<p>ARGV parsing method and options builder.</p>
+</div></span>
   
 </li>
 
@@ -188,27 +191,28 @@
   
 
   
-</h3><table class="source_code">
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>ARGV parsing method and options builder. Method depends on Trollop gem.</p>
+
+<p>Dynamically builds, and returns, the @cmd_opts Hash based on contents of
+@cmd, and provides the help system for options/parameters.</p>
+
+<p>Returned Values: @cmd [Type: String] and @cmd_opts [Type: Hash]</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-34
-35
-36
-37
-38
-39
-40
-41
-42
-43
-44
-45
-46
-47
-48
 49
 50
 51
@@ -245,10 +249,25 @@
 82
 83
 84
-85</pre>
+85
+86
+87
+88
+89
+90
+91
+92
+93
+94
+95
+96
+97
+98
+99
+100</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/dtf.rb', line 34</span>
+      <pre class="code"><span class="info file"># File 'lib/dtf.rb', line 49</span>
 
 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_parse_cmds'>parse_cmds</span>
   <span class='comment'># Global options default to '--version|-v' and '--help|-h'
@@ -300,7 +319,7 @@
     <span class='const'>Trollop</span><span class='op'>::</span><span class='id identifier rubyid_die'>die</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Unknown DTF sub-command: </span><span class='embexpr_beg'>#{</span><span class='ivar'>@cmd</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
   <span class='kw'>end</span>
   
-  <span class='kw'>return</span> <span class='ivar'>@cmd</span><span class='comma'>,</span> <span class='ivar'>@cmd_opts</span> <span class='comment'># Specifically return @cmd and its @cmd_opts 
+  <span class='kw'>return</span> <span class='ivar'>@cmd</span><span class='comma'>,</span> <span class='ivar'>@cmd_opts</span> <span class='comment'># Explicitly return @cmd and its @cmd_opts 
 </span><span class='kw'>end</span></pre>
     </td>
   </tr>
@@ -312,7 +331,7 @@
 </div>
 
     <div id="footer">
-  Generated on Thu Sep 20 00:16:43 2012 by
+  Generated on Thu Sep 20 10:37:21 2012 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.2.1 (ruby-1.9.3).
 </div>

data/doc/User.html

@@ -101,7 +101,18 @@
 </dl>
 <div class="clear"></div>
 
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>User class owns all Verification Suites in the DTF system</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
 
+</div>
 
 
 
@@ -114,7 +125,7 @@
 </div>
 
     <div id="footer">
-  Generated on Thu Sep 20 00:16:43 2012 by
+  Generated on Thu Sep 20 10:37:21 2012 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.2.1 (ruby-1.9.3).
 </div>

data/doc/VerificationSuite.html

@@ -101,7 +101,28 @@
 </dl>
 <div class="clear"></div>
 
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>VerificationSuite is the core container class.</p>
+
+<p>ASSOCIATIONS BREAKDOWN: It contains many AnalysisCases. Each AnalysisCase
+contains  multiple case_tests, owned by both the User and the AnalysisCase.
+The goal is to  make 'packs' of tests which Users can share between Suites,
+grouped by Cases, and  even share those Tests between Cases.</p>
+
+<p>Also, Users should be able to share their individual Test(s),
+AnalysisCase(s), through  their VerificationSuite(s) with other Users for
+inclusion in their own AnalysisCase(s)  and Suite(s) allowing for
+mix-and-match batching.</p>
+
 
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
 
 
 
@@ -114,7 +135,7 @@
 </div>
 
     <div id="footer">
-  Generated on Thu Sep 20 00:16:43 2012 by
+  Generated on Thu Sep 20 10:37:21 2012 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.2.1 (ruby-1.9.3).
 </div>

data/doc/_index.html

@@ -190,7 +190,7 @@
 </div>
 
     <div id="footer">
-  Generated on Thu Sep 20 00:16:43 2012 by
+  Generated on Thu Sep 20 10:37:21 2012 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.2.1 (ruby-1.9.3).
 </div>

data/doc/file.README.html

@@ -247,7 +247,7 @@ Options:
 </div></div>
 
     <div id="footer">
-  Generated on Thu Sep 20 00:16:43 2012 by
+  Generated on Thu Sep 20 10:37:21 2012 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.2.1 (ruby-1.9.3).
 </div>

data/doc/index.html

@@ -247,7 +247,7 @@ Options:
 </div></div>
 
     <div id="footer">
-  Generated on Thu Sep 20 00:16:43 2012 by
+  Generated on Thu Sep 20 10:37:21 2012 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.2.1 (ruby-1.9.3).
 </div>

data/doc/top-level-namespace.html

@@ -105,7 +105,7 @@
 </div>
 
     <div id="footer">
-  Generated on Thu Sep 20 00:16:43 2012 by
+  Generated on Thu Sep 20 10:37:21 2012 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.2.1 (ruby-1.9.3).
 </div>

data/lib/dtf.rb

@@ -1,22 +1,29 @@
 # encoding: UTF-8
 
 require "dtf/version"
-require 'trollop' # Used to implement help system
+require 'trollop'
 
 module Dtf
   load "#{File.join(File.dirname(__FILE__), "/config/environment.rb")}"
 
+  # Dtf::ErrorSystem is DTF's custom error management class
   class ErrorSystem
-    # Reusable error response method
+    # Reusable error raising and response method.
+    # Returns exit status code of '1' via abort().
     def self.raise_error(cmd)
       raise ArgumentError
     rescue
       $stderr.puts "ERROR! #{cmd} did not receive all required options."
       $stderr.puts "Please execute \'dtf #{cmd} -h\' for more information."
-      # Set non-zero exit value on error, for scripting use.
       abort()
     end
 
+    # Reusable object error display method.
+    #
+    # Takes an Object as arg and displays that Object's full error messages.
+    # Will return the @user object's full error messages, 1 per line.
+    #
+    # Example usage: Dtf::ErrorSystem.display_errors(@user)
     def self.display_errors(obj)
       # TODO: Refactor error display to take sub-command as an arg
       # and display obj.errors.full_messages.each properly for each arg type.
@@ -25,12 +32,20 @@ module Dtf
       end
     end
     
-  end # End of Dtf::ErrorSystem class
+  end
 
+  # Dtf::OptionsParser is DTF's command/options/parameters parsing class.
+  # It also doubles as DTF's help system.
   class OptionsParser
     # List of all sub-commands known within the Help System
     SUB_COMMANDS = %w(create_user delete_user create_vs delete_vs)
     
+    # ARGV parsing method and options builder. Method depends on Trollop gem.
+    #
+    # Dynamically builds, and returns, the @cmd_opts Hash based on contents of @cmd,
+    # and provides the help system for options/parameters.
+    #
+    # Returned Values: @cmd [Type: String] and @cmd_opts [Type: Hash]
     def self.parse_cmds
       # Global options default to '--version|-v' and '--help|-h'
       global_opts = Trollop::options do
@@ -81,14 +96,13 @@ module Dtf
         Trollop::die "Unknown DTF sub-command: #{@cmd.inspect}"
       end
       
-      return @cmd, @cmd_opts # Specifically return @cmd and its @cmd_opts 
+      return @cmd, @cmd_opts # Explicitly return @cmd and its @cmd_opts 
     end
-  end # End Dtf::OptionsParser clas
+  end
 
 
   # Dtf::Command contains all sub-commands availabe in the DTF master gem.
-  # All methods recieve the @cmd and @cmd_opts parsed from the command-line.
-  # They are what was captured in the ivars in Dtf::HelpSystem
+  # All methods receive the @cmd and @cmd_opts returned by Dtf::OptionsParser.parse_cmds()
   class Command
 
     # Process both the requested command and all/any parameters.
@@ -96,7 +110,8 @@ module Dtf
     # off to the appropriate method. All methods are a 1:1 match in their name.
     # e.g 'create_user' sub-command is matched to the 'create_user' method of this class.
     #
-    # This method requires, and processes, 2 arguments. The 'cmd' to process, and any 'cmd_opts' of that sub-command.
+    # This method requires, and processes, 2 arguments. The first is a String, the second is a Hash.
+    # They are the 'cmd' to process and any options/parameters, stored in the 'cmd_opts' hash, of that sub-command.
     def self.process(cmd, cmd_opts)
       case cmd
         when "create_user"
@@ -246,6 +261,6 @@ module Dtf
       end
     end
 
-  end # End of class
+  end
 
 end # End of module

data/lib/dtf/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module Dtf
-  VERSION = "0.2.8"
+  VERSION = "0.2.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dtf
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.9
   prerelease: 
 platform: ruby
 authors: