dtf 0.2.2 → 0.2.3

data/.rspec

@@ -1 +1 @@
--r turnip/rspec --color
+-r turnip/rspec --color --format doc

data/.travis.yml

@@ -1,5 +1,7 @@
 rvm:
   - 1.9.3
+before_install:
+  - gem update bundler
 before_script:
   - RAILS_ENV='development' bundle exec thor dtf_setup:config
   - RAILS_ENV='development' bundle exec rake db:migrate
@@ -10,7 +12,10 @@ notifications:
   irc:
     channels:
       - "irc.freenode.org#dtf-gems"
+    on_success: always
+    on_failure: always
   email:
     recipients:
-      - me@deryldoucette.com
-    on_failure: change
+      - me@daviddwdowney.com
+    on_success: always
+    on_failure: always

data/Gemfile

@@ -1,6 +1,6 @@
-# -*- coding: UTF-8 -*-
-
+# encoding: UTF-8
 source 'https://rubygems.org'
+ruby "1.9.3"
 
 # Specify your gem's dependencies in dtf.gemspec
 group :development, :test do
@@ -21,6 +21,7 @@ group :development, :test do
   gem "jist"
   gem "pry-theme"
   gem 'simplecov'
+  gem 'database_cleaner'
 end
 
 gemspec

data/README.md

@@ -77,12 +77,111 @@ really is when it comes to version numbers and what they mean. This _will_ be a
 
 
 ## Installation
-
-To Be Announced
+DTF uses Thor for setup and configuration, and has 3 possible sub-tasks under task name 'dtf_setup':
+
+```sh
+∴ thor list
+dtf_setup
+---------
+thor dtf_setup:config [NAME]  # Copy db configuration file(s)
+thor dtf_setup:install        # Installs database migrations, the main schema, and configuration files
+```
+
+As you can see, you can copy just the db config files, and/or the migrations, and main schema.
+
+```sh
+∴ thor help dtf_setup
+Tasks:
+  thor dtf_setup:config [NAME]  # Copy db configuration file(s)
+  thor dtf_setup:help [TASK]    # Describe available tasks or one specific task
+  thor dtf_setup:install        # Installs database migrations, the main schema, and configuration files
+```
+
+To see how to install everything you would run the following command:
+
+```sh
+∴ thor dtf_setup:help install
+Usage:
+  thor dtf_setup:install
+
+Options:
+  [--force]  
+
+Installs database migrations, the main schema, and configuration files
+```
+
+To see how to install just the configuration files for accessing the database(s), you would run:
+
+```sh
+∴ thor dtf_setup:help config
+Usage:
+  thor dtf_setup:config [NAME]
+
+Options:
+  [--force]  
+
+Copy db configuration file(s)
+```
+
+Once the configuration files and/or database migrations are in place, the remaining setup is handled by 'rake'.
+To see all possible commands, you would run 'rake -T', and pick the one(s) you need.
+
+```sh
+∴ rake -T
+rake build              # Build dtf-0.2.2.gem into the pkg directory
+rake db:create          # Create the database from config/database.yml for the current Rails.env (use db:create:all to create all dbs i...
+rake db:drop            # Drops the database for the current Rails.env (use db:drop:all to drop all databases)
+rake db:fixtures:load   # Load fixtures into the current environment's database.
+rake db:migrate         # Migrate the database (options: VERSION=x, VERBOSE=false).
+rake db:migrate:status  # Display status of migrations
+rake db:new_migration   # Create a new migration
+rake db:rollback        # Rolls the schema back to the previous version (specify steps w/ STEP=n).
+rake db:schema:dump     # Create a db/schema.rb file that can be portably used against any DB supported by AR
+rake db:schema:load     # Load a schema.rb file into the database
+rake db:seed            # Load the seed data from db/seeds.rb
+rake db:setup           # Create the database, load the schema, and initialize with the seed data (use db:reset to also drop the db first)
+rake db:structure:dump  # Dump the database structure to db/structure.sql. Specify another file with DB_STRUCTURE=db/my_structure.sql
+rake db:version         # Retrieves the current schema version number
+rake install            # Build and install dtf-0.2.2.gem into system gems
+rake release            # Create tag v0.2.2 and build and push dtf-0.2.2.gem to Rubygems
+```
 
 
 ## Usage
-
-To Be Announced
-
-
+Once you have finished configuring your database(s) and applying all migrations, you are now ready to work with
+DTF directly. The following is a summary of all current possible commands, and their expected options/parameters:
+
+```sh
+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
+
+dtf create_user -h
+Options:
+      --user-name, -u <s>:   Username for new TF user - REQUIRED
+      --full-name, -n <s>:   Real name for new TF user - REQUIRED
+  --email-address, -e <s>:   Email address for new TF user - REQUIRED
+               --help, -h:   Show this message
+
+dtf delete_user -h
+Options:
+               --user-name, -u <s>:   Username of TF user to delete - REQUIRED
+  --delete-all, --no-delete-all, -d:   Delete _all_ VSs this user owns (default: true)
+                         --help, -h:   Show this message
+
+dtf create_vs -h
+Options:
+    --user-name, -u <s>:   TF user to associate this VS with - REQUIRED
+         --name, -n <s>:   Name for new VS - REQUIRED
+  --description, -d <s>:   Description of VS's intended use - OPTIONAL (default: )
+             --help, -h:   Show this message
+
+dtf delete_vs -h
+Options:
+  --user-name, -u <s>:   Username of VS owner - REQUIRED
+         --id, -i <i>:   ID of VS to be deleted - REQUIRED
+           --help, -h:   Show this message
+```
+
+Enjoy!

data/Rakefile

@@ -1,4 +1,6 @@
 #!/usr/bin/env rake
+# encoding: UTF-8
+
 require "bundler/gem_tasks"
 
 begin

data/app/models/analysis_case.rb

@@ -1,4 +1,4 @@
-# -*- coding: UTF-8 -*-
+# encoding: UTF-8
 
 class AnalysisCase < ActiveRecord::Base
 

data/app/models/case_test.rb

@@ -1,4 +1,4 @@
-# -*- coding: UTF-8 -*-
+# encoding: UTF-8
 
 class CaseTest < ActiveRecord::Base
 

data/app/models/user.rb

@@ -1,9 +1,10 @@
-# -*- coding: UTF-8 -*-
+# encoding: UTF-8
 
 class User < ActiveRecord::Base
 
   attr_accessible :full_name, :email_address, :user_name
-  validates_presence_of :full_name, :email_address, :user_name
+  validates :full_name, :email_address, :user_name, :presence => true
+  validates :user_name, :email_address, :uniqueness => true
 
   has_many :verification_suites, :dependent => :destroy
   has_many :analysis_cases, :through => :verification_suites, :dependent => :destroy

data/app/models/verification_suite.rb

@@ -1,4 +1,4 @@
-# -*- coding: UTF-8 -*-
+# encoding: UTF-8
 
 class VerificationSuite < ActiveRecord::Base
 

data/bin/dtf

@@ -1,28 +1,31 @@
 #!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) Copyright 2012 David Deryl Downey / Deryl R. Doucette. All Rights Reserved.
 #
-# This is the master script to be used to manage the various Verification Suites,
-# Analysis Cases, and Case Tests
-#
-# Ex: dtf create_user -u|--user @user_name -n|--name "John Public" -e|--email
-# "j@public.com"
-#
-# -u -n and -e are _required_ parameters
-#
-# Accessing the help system
-# Ex: dtf help create_user
+# This is the master script for managing Users and Verification Suites
 
 require 'dtf'
-require 'optparse'
 
-options = {}
+# -- LOAD HELP SYSTEM
+require 'dtf/dtf_help_system'
+
+# -- LOAD ERROR SYSTEM
+require 'dtf/dtf_error_system'
 
-OptionParser.new do |opts|
-  opts.banner = "Usage: dtf <cmd> [options]"
+
+# -- START MAIN APPLICATION
+# Ensure we have *all* required options for each possible sub_cmd
+case @cmd
+  when "create_user"
+    Dtf::DtfCommands.create_user(@cmd_opts)
+  
+  when "delete_user"
+    Dtf::DtfCommands.delete_user(@cmd, @cmd_opts)
+  
+  when "create_vs"
+    Dtf::DtfCommands.create_vs(@cmd_opts)
   
-  opts.on("-h", "--help",
-          "Show this message") do |h|
-    options[:help] = h
-    puts opts
-  end
+  when "delete_vs"
+    Dtf::DtfCommands.delete_vs(@cmd, @cmd_opts)
 
-end.parse!
+end

data/db/seeds.rb

@@ -0,0 +1,4 @@
+# encoding: UTF-8
+require 'dtf'
+
+User.create(full_name: "Library Owner", email_address: "library_owner@localhost.lan", user_name: "library_owner")

data/doc/AnalysisCase.html

@@ -0,0 +1,123 @@
+<!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>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: AnalysisCase
+  
+    &mdash; Documentation by YARD 0.8.2.1
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!" + escape(window.location.href);
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="_index.html">Index (A)</a> &raquo;
+    
+    
+    <span class="title">AnalysisCase</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Class: AnalysisCase
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">ActiveRecord::Base</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">ActiveRecord::Base</li>
+          
+            <li class="next">AnalysisCase</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+      </dd>
+    
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">app/models/analysis_case.rb</dd>
+  
+</dl>
+<div class="clear"></div>
+
+
+
+
+
+
+
+
+
+  
+
+</div>
+
+    <div id="footer">
+  Generated on Fri Sep 14 22:41: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>
+
+  </body>
+</html>

data/doc/CaseTest.html

@@ -0,0 +1,123 @@
+<!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>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: CaseTest
+  
+    &mdash; Documentation by YARD 0.8.2.1
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!" + escape(window.location.href);
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="_index.html">Index (C)</a> &raquo;
+    
+    
+    <span class="title">CaseTest</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Class: CaseTest
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">ActiveRecord::Base</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">ActiveRecord::Base</li>
+          
+            <li class="next">CaseTest</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+      </dd>
+    
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">app/models/case_test.rb</dd>
+  
+</dl>
+<div class="clear"></div>
+
+
+
+
+
+
+
+
+
+  
+
+</div>
+
+    <div id="footer">
+  Generated on Fri Sep 14 22:41: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>
+
+  </body>
+</html>