dtf 0.2.7 → 0.2.8

data/doc/top-level-namespace.html

@@ -100,160 +100,12 @@
 
 
 
-  
-    <h2>
-      Instance Method Summary
-      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
-    </h2>
-
-    <ul class="summary">
-      
-        <li class="public ">
-  <span class="summary_signature">
-    
-      <a href="#display_errors-instance_method" title="#display_errors (instance method)">- (Object) <strong>display_errors</strong>(cmd) </a>
-    
-
-    
-  </span>
-  
-  
-  
-  
-  
-  
-  
-
-  
-    <span class="summary_desc"><div class='inline'></div></span>
-  
-</li>
-
-      
-        <li class="public ">
-  <span class="summary_signature">
-    
-      <a href="#raise_error-instance_method" title="#raise_error (instance method)">- (Object) <strong>raise_error</strong>(cmd) </a>
-    
-
-    
-  </span>
-  
-  
-  
-  
-  
-  
-  
-
-  
-    <span class="summary_desc"><div class='inline'>
-<p>Reusable error response method.</p>
-</div></span>
-  
-</li>
-
-      
-    </ul>
-  
 
 
-
-  <div id="instance_method_details" class="method_details_list">
-    <h2>Instance Method Details</h2>
-
-    
-      <div class="method_details first">
-  <h3 class="signature first" id="display_errors-instance_method">
-  
-    - (<tt>Object</tt>) <strong>display_errors</strong>(cmd) 
-  
-
-  
-
-  
-</h3><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-
-
-13
-14
-15
-16</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/dtf/error_system.rb', line 13</span>
-
-<span class='kw'>def</span> <span class='id identifier rubyid_display_errors'>display_errors</span><span class='lparen'>(</span><span class='id identifier rubyid_cmd'>cmd</span><span class='rparen'>)</span>
-  <span class='comment'># TODO: Refactor error display to take sub-command as an arg
-</span>  <span class='comment'># and display obj.errors.messages.each properly for each arg type.
-</span><span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-    
-      <div class="method_details ">
-  <h3 class="signature " id="raise_error-instance_method">
-  
-    - (<tt>Object</tt>) <strong>raise_error</strong>(cmd) 
-  
-
-  
-
-  
-</h3><div class="docstring">
-  <div class="discussion">
-    
-<p>Reusable error response method</p>
-
-
-  </div>
-</div>
-<div class="tags">
-  
-
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-
-
-3
-4
-5
-6
-7
-8
-9
-10
-11</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/dtf/error_system.rb', line 3</span>
-
-<span class='kw'>def</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'>See '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 help with this sub-command</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='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-    
-  </div>
-
 </div>
 
     <div id="footer">
-  Generated on Sun Sep 16 12:04:53 2012 by
+  Generated on Thu Sep 20 00:16:43 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/dtf.gemspec

@@ -4,8 +4,8 @@ require File.expand_path('../lib/dtf/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors           = ["David Deryl Downey"]
   gem.email             = ["me@daviddwdowney.com"]
-  gem.description       = %q{DTF is a modular testing framework skeleton. This is the control gem which contains the Suite's db schema(s) and control/management scripts.}
-  gem.summary           = %q{DTF is a modular testing framework. This is the control gem.}
+  gem.description       = %q{DTF is a modular testing framework skeleton. This is the control gem containing the db schema(s) and command-line script.}
+  gem.summary           = %q{DTF is a modular testing framework. This is the master gem for the DTF framework.}
   gem.homepage          = "https://github.com/dtf-gems/dtf"
   gem.license           = 'MIT'
   gem.platform          = Gem::Platform::RUBY

data/lib/dtf.rb

@@ -1,41 +1,122 @@
 # encoding: UTF-8
 
 require "dtf/version"
+require 'trollop' # Used to implement help system
 
 module Dtf
   load "#{File.join(File.dirname(__FILE__), "/config/environment.rb")}"
 
+  class ErrorSystem
+    # Reusable error response method
+    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
+
+    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.
+      obj.errors.full_messages.all.each do |msg|
+        $stderr.puts "#{msg}"
+      end
+    end
+    
+  end # End of Dtf::ErrorSystem class
+
+  class OptionsParser
+    # List of all sub-commands known within the Help System
+    SUB_COMMANDS = %w(create_user delete_user create_vs delete_vs)
+    
+    def self.parse_cmds
+      # Global options default to '--version|-v' and '--help|-h'
+      global_opts = Trollop::options do
+        version "DTF v#{Dtf::VERSION}"
+        banner <<-EOS
+        #{version}
+        (c) Copyright 2012 David Deryl Downey / Deryl R. Doucette. All Rights Reserved.
+        This is free software; see the LICENSE file for copying conditions.
+        There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+        Usage:
+              dtf -v|--version -h|--help [[sub_cmds <options>] -h|--help]
+
+        Valid [sub_cmds] are: create_(user|vs), delete_(user|vs)
+        See 'dtf [sub_cmd] -h' for each sub_cmd's details and options
+
+      EOS
+        stop_on SUB_COMMANDS
+      end
+
+      @cmd = ARGV.shift
+      @cmd_opts = case @cmd
+      when "create_user"
+        Trollop::options do
+          opt(:user_name, desc="Username for new TF user - REQUIRED", opts={:type => :string, :short => '-u'})
+          opt(:full_name, desc="Real name for new TF user - REQUIRED", opts={:type => :string, :short => '-n'})
+          opt(:email_address, desc="Email address for new TF user - REQUIRED", opts={:type => :string, :short => '-e'})
+        end
+      when "create_vs"
+        Trollop::options do
+          opt(:user_name, desc="TF user to associate this VS with - REQUIRED", opts={:type => :string, :short => '-u'})
+          opt(:name, desc="Name for new VS - REQUIRED", opts={:type => :string, :short => '-n'})
+          opt(:description, desc="Description of VS's intended use - OPTIONAL", opts={:type => :string, :short => '-d', :default => ''})
+        end
+      when "delete_user"
+        Trollop::options do
+          opt(:user_name, desc="Username of TF user to delete - REQUIRED", opts={:type => :string, :short => '-u'})
+          opt(:delete_all, desc="Delete _all_ VSs this user owns", :type => :flag, :default => true)
+        end
+      when "delete_vs"
+        Trollop::options do
+          opt(:user_name, desc="Username of VS owner - REQUIRED", opts={:type => :string, :short => '-u'})
+          opt(:id, desc="ID of VS to be deleted - REQUIRED", opts={:type => :int, :short => '-i'})
+        end
+      when nil
+        Trollop::die "No command specified! Please specify an applicable command"
+      else
+        Trollop::die "Unknown DTF sub-command: #{@cmd.inspect}"
+      end
+      
+      return @cmd, @cmd_opts # Specifically return @cmd and its @cmd_opts 
+    end
+  end # End Dtf::OptionsParser clas
+
+
   # 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
   class Command
-    
+
     # Process both the requested command and all/any parameters.
     # NOTE: This method is the 'master' method. It parses @cmd for which sub-command to 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. 
+    # 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.
     def self.process(cmd, cmd_opts)
       case cmd
         when "create_user"
-          create_user(cmd, cmd_opts)
+          self.create_user(cmd, cmd_opts)
 
         when "delete_user"
-          delete_user(cmd, cmd_opts)
+          self.delete_user(cmd, cmd_opts)
 
         when "create_vs"
-          create_vs(cmd, cmd_opts)
+          self.create_vs(cmd, cmd_opts)
 
         when "delete_vs"
-          delete_vs(cmd, cmd_opts)
+          self.delete_vs(cmd, cmd_opts)
 
         else
-          $stderr.puts "Unknown DTF sub-command: #{cmd.inspect}"
+          $stderr.puts "Unknown DTF sub-command: #{cmd}"
           abort()
       end
     end
-    
+
     # This sub-command is used to add a User to the Test Framework system
     #
     # Required Parameters are:
@@ -48,7 +129,7 @@ module Dtf
       if [:user_name_given, :full_name_given, :email_address_given].all? { |sym| cmd_opts.key?(sym) } then
         user = User.where(user_name:     cmd_opts[:user_name],
                            full_name:     cmd_opts[:full_name],
-                           email_address: cmd_opts[:email_address]).first_or_create
+                           email_address: cmd_opts[:email_address]).create
 
         # Check to make sure user was actually saved to the db
         if user.persisted? then
@@ -56,17 +137,17 @@ module Dtf
         else
           # Oops, it wasn't! Notify user and display any error message(s)
           $stderr.puts "ERROR: #{cmd_opts[:user_name].to_s} was NOT created! Please fix the following errors and try again:"
-          user.errors.messages.keys.each do |key|
-            $stderr.puts "#{key.to_s.capitalize.gsub('_', ' ').to_s} #{user.errors.messages[key][0].to_s}!"
+          user.errors.full_messages.each do |msg|
+            $stderr.puts "#{msg}"
           end
           # Now throw a proper error code to the system, while exiting the script
           abort()
         end
       else
-        raise_error(cmd) # This error here is thrown when not all params are provided
+        Dtf::ErrorSystem.raise_error(cmd) # This error here is thrown when not all params are provided
       end
     end
-    
+
     # This sub-command removes a User from the Testing Framework system
     #
     # Required Parameters are:
@@ -101,18 +182,23 @@ module Dtf
         else
           puts "#{cmd} called with '--delete-all' set or on by default! Deleting all VSs owned by #{cmd_opts[:user_name]}"
           user = User.find_by_user_name(cmd_opts[:user_name])
-          user.verification_suites.all.each do |vs|
-            VerificationSuite.delete(vs)
-          end
-          if user.verification_suites.empty? then
-            User.delete(user)
+          if ! user.nil? then
+            user.verification_suites.all.each do |vs|
+              VerificationSuite.delete(vs)
+            end
+            if user.verification_suites.empty? then
+              User.delete(user)
+            end
+          else
+            $stderr.puts "ERROR: No user named \'#{cmd_opts[:user_name].to_s}\' found!"
+            abort()
           end
         end
       else
-        raise_error(cmd)
+        Dtf::ErrorSystem.raise_error(cmd)
       end
     end
-    
+
     # This sub-command generates, adds, and associates a Verification Suite in the Testing Framework system.
     #
     # Required Parameters are:
@@ -138,7 +224,7 @@ module Dtf
           abort()
         end
       else
-        raise_error(cmd)
+        Dtf::ErrorSystem.raise_error(cmd)
       end
     end
 
@@ -156,9 +242,9 @@ module Dtf
         vs   = user.verification_suites.find(cmd_opts[:id])
         VerificationSuite.delete(vs)
       else
-        raise_error(cmd)
+        Dtf::ErrorSystem.raise_error(cmd)
       end
-    end    
+    end
 
   end # End of class
 

data/lib/dtf/version.rb

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

data/spec/models/analysis_case_spec.rb

@@ -14,18 +14,21 @@ describe "AnalysisCase" do
     
     it "should be invalid without being assigned to a verification suite" do    
       analysis_case.should_not be_valid
+      analysis_case.errors.should_not be_empty
       analysis_case[:verification_suite_id].should be_nil
       analysis_case.new_record?.should be_true
     end  
   
     it "should be invalid without a name" do    
       analysis_case.should_not be_valid
+      analysis_case.errors.should_not be_empty
       analysis_case.errors.messages[:name].should eq(["can't be blank"])
       analysis_case.new_record?.should be_true
     end
     
     it "should be invalid without a description" do    
       analysis_case.should_not be_valid
+      analysis_case.errors.should_not be_empty
       analysis_case.errors.messages[:description].should eq(["can't be blank"])
       analysis_case.new_record?.should be_true
     end
@@ -49,7 +52,7 @@ describe "AnalysisCase" do
 
     it "should have a valid name and description" do    
       analysis_case.should be_valid
-      analysis_case.errors.messages.should be_empty
+      analysis_case.errors.should be_empty
       analysis_case.name.should_not be_nil
       analysis_case.description.should_not be_nil
     end  

data/spec/models/case_test_spec.rb

@@ -14,18 +14,21 @@ describe "CaseTest" do
     
     it "should be invalid without being assigned to a analysis case" do
       case_test.should_not be_valid
+      case_test.errors.should_not be_empty
       case_test[:analysis_case_id].should be_nil
       case_test.new_record?.should be_true
     end  
   
     it "should be invalid without a cmd" do    
       case_test.should_not be_valid
+      case_test.errors.should_not be_empty
       case_test.errors.messages[:cmd].should eq(["can't be blank"])
       case_test.new_record?.should be_true
     end
     
     it "should be invalid without a description" do    
       case_test.should_not be_valid
+      case_test.errors.should_not be_empty
       case_test.errors.messages[:description].should eq(["can't be blank"])
       case_test.new_record?.should be_true
     end
@@ -52,7 +55,7 @@ describe "CaseTest" do
 
     it "should have a valid cmd and description" do    
       case_test.should be_valid
-      case_test.errors.messages.should be_empty
+      case_test.errors.should be_empty
       case_test.cmd.should_not be_nil
       case_test.description.should_not be_nil
     end