Tracker 0.1.0 → 0.1.2

data/README

@@ -15,4 +15,4 @@
   * Make sure the options are valid.  You can add new options in the hash in tracker.rb.
   
 == LICENSE
-See MIT-LICENSE.
+See MIT-LICENSE.

data/bin/trac

@@ -4,8 +4,8 @@
 
 # Handles connection to the database
 
-require "rubygems"
-require_gem "Tracker"
+require File.dirname(__FILE__) + "/../lib/interface.rb"
+require File.dirname(__FILE__) + "/../lib/database.rb"
 
 # The default database file_name
 DEFAULT_DATABASE_FILE_NAME = ".tracker_db"
@@ -25,7 +25,7 @@ def no_database_error(database_file = "the current")
 end
 
 # Is the user creating a new database?
-if ARGV.include?("create") 
+if ARGV.include?("create") && !ARGV.include?("help") 
   if File.exists?(database)
     puts "A '.tracker_db' database already exists in the current directory.  Try removing it to create a new one."
     exit
@@ -43,7 +43,7 @@ while !File.exists?(database) && iteration < 10
 end
 
 # Could we find the database?
-if iteration == 10 && !ARGV.include?("help") && !ARGV.include?("--file") && !ARGV.include?("-f")
+if iteration == 10 && !ARGV.include?("help") && !ARGV.include?("-h") && !ARGV.include?("--help") && !ARGV.include?("--file") && !ARGV.include?("-f")
   no_database_error
 else
   if ARGV.include?("-f") || ARGV.include?("--file")

data/lib/action.rb

@@ -75,5 +75,146 @@ module Action
     names = bugs.collect { |bug| bug.name }
     return names.uniq
   end
+
+  def self.help_create
+    puts "create: Creates the database in the current directory."
+    puts "usage: trac create"
+    puts ""
+    puts "Creates the file '.tracker_db' in the current directory if it doesn't already exist.  This file is the SQLite3 database that Tracker will use to store your data in."
+  end
+
+  def self.help_append
+    puts "append: Appends the description of a ticket with new comment."
+    puts "usage: trac append [-i ID | -n NAME | -d DESCRIPTION]"
+    puts ""
+    puts "Prompts the user for another description of the ticket.  Tracker will append the additional information to the description field of the ticket."
+    puts ""
+    puts "Available options:"
+    puts "  -i ID | --id ID | ID"
+    puts "  -n NAME | --name NAME | NAME"
+    puts "  -d DESCRIPTION | --description DESCRIPTION"
+    puts ""
+    puts "Sample usage: trac append -n 'old_bug' -d 'This is a new description.'"
+  end
+  
+  def self.help_close
+    puts "close: Closes a ticket."
+    puts "usage: trac close [-i ID | -n NAME]"
+    puts ""
+    puts "Closes the ticket with the given ID or NAME.  Can be used with a shorthand notation - 'trac close ticket_name' is the same as 'trac close -n ticket_name'."
+    puts ""
+    puts "Available options:"
+    puts "  -i ID | --id ID | ID"
+    puts "  -n NAME | --name NAME | NAME"
+  end
+
+  def self.help_delete
+    puts "delete: Deletes a ticket from the database."
+    puts "usage: trac delete [-i ID | -n NAME]"
+    puts ""
+    puts "Deletes the ticket, permanently, from the database.  Be careful with this command, you _cannot_ recover any tickets that are deleted and there are _no_ warnings that ask 'Are you sure?'"
+    puts ""
+    puts "Available options:"
+    puts "  -i ID | --id ID | ID"
+    puts "  -n NAME | --name NAME | NAME"
+  end
+
+  def self.help_list
+    puts "list: Lists all open tickets for viewing."
+    puts "usage: trac list [-i ID | -n NAME | -p PRIORITY | -a AREA | -c | -o]"
+    puts ""
+    puts "This command accepts conditions to filter which tickets are listed:
+  * trac list -p 1
+    Lists all tickets with priority 1.
+  * trac list -a SOME_AREA
+    Lists all tickets with area SOME_AREA.
+  * trac list --closed
+    Lists all closed tickets (by default, will only list open tickets)."
+    puts ""
+    puts "Available options:"
+    puts "  -i ID | --id ID | ID"
+    puts "  -n NAME | --name NAME | NAME"
+    puts "  -p PRIORITY | --priority PRIORITY"
+    puts "  -a AREA | --area AREA"
+    puts "  -d DESCRIPTION | --description DESCRIPTION"
+    puts "  -c | --closed"
+    puts "  -o | --open"
+  end
+
+  def self.help_help
+    puts "help: Displays help messages."
+    puts "usage: trac help [COMMAND]"
+    puts ""
+    puts "Displays the help message for [COMMAND].  For a list of commands, just use 'trac help' with no arguments."
+  end
+
+  def self.help_new
+    puts "new: Creates a new ticket to enter in the database."
+    puts "usage: trac new [-n NAME | -p PRIORITY | -a AREA | -d DESCRIPTION]"
+    puts ""
+    puts "If no options are given, this command will prompt you for all required fields.  If an option is given, that option is used for the ticket."
+    puts ""
+    puts "Sample usage: trac new -n NEW_TICKET_NAME"
+  end
+
+  def self.help_open
+    puts "open: Opens a ticket."
+    puts "usage: trac open [-i ID | -n NAME]"
+    puts ""
+    puts "Opens the ticket with the given ID or NAME.  Can be used with a shorthand notation - 'trac open ticket_name' is the same as 'trac open -n ticket_name'."
+    puts ""
+    puts "Available options:"
+    puts "  -i ID | --id ID | ID"
+    puts "  -n NAME | --name NAME | NAME"
+  end
+
+  def self.help_update
+    puts "update: Updates a ticket's fields."
+    puts "usage: trac update [-i ID | -n NAME | -p PRIORITY | -a AREA]"
+    puts ""
+    puts "Will update a ticket's name, priority, and/or area.  To use it, just supply the command with either a name or id and the new updated fields:
+  * trac update -n some_ticket -p 1
+    Changes the ticket with name 'some_ticket' to have a priority of 1.
+  * trac update -i 2 -n new_name
+    Changes ticket #2 to have the name 'new_name'."
+    puts ""
+    puts "Available options:"
+    puts "  -i ID | --id ID | ID"
+    puts "  -n NAME | --name NAME | NAME"
+    puts "  -p PRIORITY | --priority PRIORITY"
+    puts "  -a AREA | --area AREA"
+  end
+
+  def self.help_areas
+    puts "areas: Lists all areas."
+    puts "usage: trac areas [-i ID | -n NAME | -p PRIORITY | -a AREA | -c | -o]"
+    puts ""
+    puts "This command is the same as 'trac list' except instead of displaying the entire ticket, it only displays the ticket's areas.  This command is meant to be used as a quick look-up for existing areas."
+    puts ""
+    puts "Available options:"
+    puts "  -i ID | --id ID | ID"
+    puts "  -n NAME | --name NAME | NAME"
+    puts "  -p PRIORITY | --priority PRIORITY"
+    puts "  -a AREA | --area AREA"
+    puts "  -d DESCRIPTION | --description DESCRIPTION"
+    puts "  -c | --closed"
+    puts "  -o | --open"
+  end
+
+  def self.help_names
+    puts "names: Lists all areas."
+    puts "usage: trac names [-i ID | -n NAME | -p PRIORITY | -a AREA | -c | -o]"
+    puts ""
+    puts "This command is the same as 'trac list' except instead of displaying the entire ticket, it only displays the ticket's names.  This command is meant to be used as a quick look-up for existing names."
+    puts ""
+    puts "Available options:"
+    puts "  -i ID | --id ID | ID"
+    puts "  -n NAME | --name NAME | NAME"
+    puts "  -p PRIORITY | --priority PRIORITY"
+    puts "  -a AREA | --area AREA"
+    puts "  -d DESCRIPTION | --description DESCRIPTION"
+    puts "  -c | --closed"
+    puts "  -o | --open"
+    end
 end
 

data/lib/bug.rb

@@ -3,10 +3,10 @@ require_gem 'activerecord'
 
 # Fields are name (string), priority (int), area (string), status (boolean).
 class Bug < ActiveRecord::Base
-  has_many :bug_descriptions, :exclusively_dependent => true
+  has_many :bug_descriptions, :dependent => :delete_all
   before_create :save_date_time
   before_update :save_date_time
-
+  
   # Is the bug open?
   def open?
     !status

data/lib/interface.rb

@@ -3,14 +3,19 @@ require File.dirname(__FILE__) + "/database.rb"
 require File.dirname(__FILE__) + "/action.rb"
 require File.dirname(__FILE__) + "/bug.rb"
 require File.dirname(__FILE__) + "/bug_description.rb"
+require 'yaml'
 
 # The Interface's job is to act as the interface between the user and the Action module.  The Interface will make sure that messages are outputted to the user and pass along actions to the Action module depending on whatever the command is.
 class Interface
     
   # Let the tracker interface have access to the bugger - controller
   def initialize()
-    @filename = File.basename(__FILE__)
-    @all_options = ["name", "priority", "area", "description"]
+    @filename = "trac"
+    config = {}
+    if File.exist?(ENV['HOME'] + "/.tracrc")
+      config = open(ENV['HOME'] + '/.tracrc') { |f| YAML.load(f) }
+    end
+    @all_options = ["name", "priority", "area", "description"].delete_if { |i| config.has_key? i }
   end
   
   # Parses ARGV and executes the correct bugger operations
@@ -27,33 +32,42 @@ class Interface
     if command.include?("append")       # Appends a description to existing bug
       hash = include_name_or_id(hash)
       hash[:description] = Prompter.description? if !hash.has_key?(:description)
-      Action::append_description(hash)
+      Action.append_description(hash)
     elsif command.include?("areas")
       puts "Searched ticket areas are:"
-      Action::list_areas(hash).each { |area| puts " * " + area }
+      Action.list_areas(hash).each { |area| puts " * " + area }
     elsif command.include?("names")
       puts "Searched ticket names are:"
-      Action::list_names(hash).each { |name| puts " * " + name }
+      Action.list_names(hash).each { |name| puts " * " + name }
     elsif command.include?("close")     # Closes an existing bug
       hash = include_name_or_id(hash)
-      Action::close_bug(hash)
+      Action.close_bug(hash)
     elsif command.include?("delete")    # Deletes the bug from the database
       hash = include_name_or_id(hash)
-      Action::delete_bug(hash)
+      Action.delete_bug(hash)
     elsif command.include?("list")      # Lists either all open bugs or bugs by conditions
-      bugs = Action::list_bugs(hash)
+      bugs = Action.list_bugs(hash)
       puts bugs.collect { |bug| get_print_info(bug) }.join("\n") if bugs.size > 0
     elsif command.include?("new")       # Creates a new bug
       set_options(@all_options, hash)
-      Action::new_bug(hash)
+      Action.new_bug(hash)
     elsif command.include?("open")      # Opens a closed bug
       hash = include_name_or_id(hash)
-      Action::open_bug(hash)
+      Action.open_bug(hash)
     elsif command.include?("update")
       hash = include_name_or_id(hash)
-      Action::update_bug(hash)
+      Action.update_bug(hash)
     elsif command.include?("help") || command.include?("--help") # Prints usage
-      print_usage
+      if !hash.has_key?(:name)
+        print_usage
+      elsif
+        method_name = "help_" + hash[:name]
+        if Action.respond_to?(method_name)
+          Action.send(method_name) 
+        else
+          puts "The command #{hash[:name]} doesn't exist - try 'trac help' for a list of commands."
+        end
+      end
     else
       puts "Try '#{@filename} help'."
     end
@@ -112,8 +126,8 @@ class Interface
     working_string << "Ticket(#{bug.id}):    #{bug.name}\n" if bug.id < 10
     working_string << "Ticket(#{bug.id}):   #{bug.name}\n" if bug.id >= 10 && bug.id < 100
     working_string << "Ticket(#{bug.id}):  #{bug.name}\n" if bug.id >= 100
-    working_string << "Priority:     #{bug.priority}\n"
-    working_string << "Area:         #{bug.area}\n"
+    working_string << "Priority:     #{bug.priority}\n" unless bug.priority.nil?
+    working_string << "Area:         #{bug.area}\n" unless bug.area.nil?
     working_string << "Description - #{bug.date_time.to_s(:short)}:\n"
     descriptions = bug.bug_descriptions.collect { |desc| " * " + desc.description }.join
     working_string << descriptions
@@ -136,7 +150,7 @@ class Interface
     puts "  close  [-i ID | -n NAME]"
     puts "  delete [-i ID | -n NAME]"
     puts "  list   [-i ID | -n NAME | -p PRIORITY | -a AREA | -c | -o]"
-    puts "  help"
+    puts "  help   [command]"
     puts "  new    [-n NAME | -p PRIORITY | -a AREA | -d DESCRIPTION]"
     puts "  open   [-i ID | -n NAME]"
     puts "  update [-i ID | -n NAME | -p PRIORITY | -a AREA]"

data/{tests/tc_action.rb → test/test_action.rb}

@@ -4,7 +4,7 @@ require File.dirname(__FILE__) + "/../lib/action.rb"
 require File.dirname(__FILE__) + "/../lib/database.rb"
 require File.dirname(__FILE__) + "/../lib/bug_description.rb"
 
-class TestBugger < Test::Unit::TestCase
+class TestAction < Test::Unit::TestCase
   def setup
     Database::connect_to_database(".tracker_db")
     @bug_names = ["First", "Second", "Third", "Fourth"]
@@ -12,7 +12,8 @@ class TestBugger < Test::Unit::TestCase
     @bug_priorities = [1, 2, 3, 4]
     @bug_areas = ["One", "Two", "Three", "Four"]
     @bug_status = [true, true, false, false]
-    @descriptions = ["First description", "Second description", "Third description"]
+    @descriptions =
+      ["First description", "Second description", "Third description"]
   end
   
   def teardown
@@ -23,19 +24,23 @@ class TestBugger < Test::Unit::TestCase
   end  
 
   def test_append_description
-    bug = Bug.create(:name => "test_append_description", :priority => 1, :area => "none")
-    Action::append_description(:id => bug.id, :description => "Hello")
-    Action::append_description(:name => "test_append_description", :description => "World")
+    bug = Bug.create(:name => "test_append_description", 
+                     :priority => 1, :area => "none")
+    Action.append_description(:id => bug.id, :description => "Hello")
+    Action.append_description(:name => "test_append_description", 
+                               :description => "World")
     assert_equal(bug.bug_descriptions[0].description, "Hello")
     assert_equal(bug.bug_descriptions[1].description, "World")
   end
   
   # An empty description should NOT be appened.
   def test_append_description_that_is_empty
-    bug = Bug.create(:name => "test_append_empty_description", :priority => 1, :area => "none")
+    bug = Bug.create(:name => "test_append_empty_description", 
+                     :priority => 1, :area => "none")
     descriptions_to_test = ["", " ", "  ", "\n", "\n\n", " \n ", "\n ", " \n"]
     descriptions_to_test.each do |string|
-      Action::append_description(:name => "test_append_empty_description", :description => string)
+      Action.append_description(:name => "test_append_empty_description", 
+                                 :description => string)
     end
     bug = Bug.find(bug.id)
     assert_equal(0, bug.bug_descriptions.size)
@@ -43,7 +48,7 @@ class TestBugger < Test::Unit::TestCase
   
   def test_close_bug
     bug = Bug.find_by_status(false)
-    Action::close_bug(:id => bug.id)
+    Action.close_bug(:id => bug.id)
     bug = Bug.find_by_id(bug.id)
     assert(bug.closed?)
     bug.status = false
@@ -51,39 +56,44 @@ class TestBugger < Test::Unit::TestCase
   end
   
   def test_delete_bug
-    bug = Bug.create(:name => "test_delete_bug", :priority => 2, :area => "none")
-    Action::delete_bug(:name => "test_delete_bug")
+    bug = Bug.create(:name => "test_delete_bug", 
+                     :priority => 2, :area => "none")
+    Action.delete_bug(:name => "test_delete_bug")
     assert(!Bug.find_by_name("test_delete_bug"))
   end
   
   def test_list_bugs
-    bugs = Action::list_bugs
+    bugs = Action.list_bugs
     bugs.each { |bug| assert(@bug_names.include?(bug.name)) }
-    bugs = Action::list_bugs(:name => "First")
+    bugs = Action.list_bugs(:name => "First")
     assert_equal(0, bugs.size)
-    bugs = Action::list_bugs(:status => false)
+    bugs = Action.list_bugs(:status => false)
     assert_equal(2, bugs.size)
   end
   
   # Make sure the listed bugs with a condition are ALL opened
   def test_open_list_bugs
     first = Bug.create(:name => "Another open bug", :area => "Four")
-    second = Bug.create(:name => "Another closed bug", :area => "Four", :status => true)
-    bugs = Action::list_bugs(:area => "Four")
+    second = Bug.create(:name => "Another closed bug", 
+                        :area => "Four", :status => true)
+    bugs = Action.list_bugs(:area => "Four")
     bugs.each { |bug| assert(bug.open?) }
   end
   
   def test_new_bug
-    bug = Action::new_bug(:name => "test_new_bug", :priority => 1, :area => "none", :description => "This is a test description")
+    bug = Action.new_bug(:name => "test_new_bug", 
+                          :priority => 1, :area => "none", 
+                          :description => "This is a test description")
     assert(bug)
     assert(Bug.find_by_name("test_new_bug"))
     assert_equal(Bug.find_by_name("test_new_bug").name, "test_new_bug")
-    assert_equal(bug.bug_descriptions[0].description, "This is a test description")
+    assert_equal(bug.bug_descriptions[0].description, 
+                "This is a test description")
   end
   
   def test_open_bug
     bug = Bug.find_by_status(true)
-    Action::open_bug(:id => bug.id)
+    Action.open_bug(:id => bug.id)
     bug = Bug.find_by_id(bug.id)
     assert(bug.open?)
     bug.status = true
@@ -91,9 +101,11 @@ class TestBugger < Test::Unit::TestCase
   end
   
   def test_update_bug
-    bug = Bug.create(:name => "test_update_bug", :priority => 1, :area => "none")
+    bug = Bug.create(:name => "test_update_bug", 
+                     :priority => 1, :area => "none")
     assert(bug)
-    Action::update_bug(:id => bug.id, :name => "new_name", :priority => 2, :area => "Nothing")
+    Action.update_bug(:id => bug.id, :name => "new_name", 
+                       :priority => 2, :area => "Nothing")
     bug = Bug.find_by_id(bug.id)
     assert_equal("new_name", bug.name)
     assert_equal("Nothing", bug.area)
@@ -102,34 +114,34 @@ class TestBugger < Test::Unit::TestCase
   
   # Should list all _open_ areas
   def test_list_areas
-    areas = Action::list_areas
+    areas = Action.list_areas
     known_areas = ["Four", "Three"]
     areas.each { |area| assert(known_areas.include?(area)) }
   end
   
   # Should list all bug areas with the condition given
   def test_list_areas_with_conditions
-    areas = Action::list_areas(:name => "Fourth")
+    areas = Action.list_areas(:name => "Fourth")
     assert_equal("Four", areas[0])
-    areas = Action::list_areas(:priority => 3)
+    areas = Action.list_areas(:priority => 3)
     assert_equal("Three", areas[0])
   end
   
   # Should list all _open_ bug names
   def test_list_names
-    names = Action::list_names
+    names = Action.list_names
     known_names = ["Fourth", "Third"]
     names.each { |name| assert(known_names.include?(name)) }
   end
   
   # Should list all  _open_ bug names with the conditions given
   def test_list_names_with_conditions
-    names = Action::list_names(:name => "Third")
+    names = Action.list_names(:name => "Third")
     assert_equal("Third", names[0])
-    names = Action::list_names(:priority => 2)
+    names = Action.list_names(:priority => 2)
     assert_equal(nil, names[0])
-    names = Action::list_names(:priority => 2, :status => true)
+    names = Action.list_names(:priority => 2, :status => true)
     assert_equal("Second", names[0])
   end
-  
-end
+
+end

data/{tests/tc_bug.rb → test/test_bug.rb}

@@ -1,6 +1,8 @@
 require "test/unit"
 
 require File.dirname(__FILE__) + "/../lib/bug.rb"
+require File.dirname(__FILE__) + "/../lib/bug_description.rb"
+require File.dirname(__FILE__) + "/../lib/database.rb"
 
 class TestBug < Test::Unit::TestCase
   def setup
@@ -62,4 +64,4 @@ class TestBug < Test::Unit::TestCase
     assert_raise(ActiveRecord::RecordNotFound) { Bug.find(id) }
   end
   
-end
+end

data/{tests/tc_bug_description.rb → test/test_bug_description.rb}

@@ -1,6 +1,7 @@
 require "test/unit"
 
 require File.dirname(__FILE__) + "/../lib/bug_description.rb"
+require File.dirname(__FILE__) + "/../lib/database.rb"
 
 class TestBugDescription < Test::Unit::TestCase
   def setup

data/{tests/tc_interface.rb → test/test_interface.rb}

@@ -3,7 +3,15 @@ require "test/unit"
 require File.dirname(__FILE__) + "/../lib/interface.rb"
 
 class TestInterface < Test::Unit::TestCase
+  def setup
+    @interface = Interface.new
+  end
+  
   def test_truth
     assert(true, "Test truth.")
   end
+  
+  def test_parse_help
+    assert true
+  end
 end

metadata

@@ -3,9 +3,9 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: Tracker
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2006-08-23 00:00:00 -07:00
-summary: Command-line bug tracking database application.
+  version: 0.1.2
+date: 2007-01-20 00:00:00 -08:00
+summary: Bug tracking application with a command-line interface and a backend SQLite3 database.
 require_paths: 
 - lib
 email: bienhd@gmail.com
@@ -28,16 +28,12 @@ cert_chain:
 authors: 
 - Hugh Bien
 files: 
-- bin/fixture.rb
-- bin/package
 - bin/trac
-- tests/fixtures.yml
-- tests/tc_action.rb
-- tests/tc_bug.rb
-- tests/tc_bug_description.rb
-- tests/tc_integration.rb
-- tests/tc_interface.rb
-- tests/ts_tracker.rb
+- test/test_action.rb
+- test/test_bug.rb
+- test/test_bug_description.rb
+- test/test_integration.rb
+- test/test_interface.rb
 - lib/action.rb
 - lib/bug.rb
 - lib/bug_description.rb
@@ -48,8 +44,12 @@ files:
 - db/migrate
 - README
 - MIT-LICENSE
-test_files: []
-
+test_files: 
+- test/test_action.rb
+- test/test_bug.rb
+- test/test_bug_description.rb
+- test/test_integration.rb
+- test/test_interface.rb
 rdoc_options: []
 
 extra_rdoc_files: 

data/bin/fixture.rb

@@ -1,37 +0,0 @@
-#!/usr/bin/env ruby
-
-require "yaml"
-require "rubygems"
-require_gem "activerecord"
-
-# Load the fixtures file and database
-fixtures_file = ARGV[0] || "tests/fixtures.yml"
-database = ARGV[1] || ".tracker_db"
-
-# Load the YAML information
-yaml = YAML.load_file(fixtures_file)
-
-# Connect to the database file
-ActiveRecord::Base.establish_connection(
-  :adapter => "sqlite3",
-  :database => database
-)
-
-class Bug < ActiveRecord::Base
-end
-
-class BugDescription < ActiveRecord::Base
-end
-
-class String
-  def to_constant
-    return Bug if self == "Bug"
-    return BugDescription if self == "BugDescription"
-  end
-end
-
-yaml.each_pair do |key, value|
-  key.to_constant.create( value )
-end
-
-

data/bin/package

@@ -1,12 +0,0 @@
-#!/usr/bin/env bash
-
-cd lib
-cat *.rb >> final_package
-mv final_package ..
-cd ..
-cat tracker >> final_package
-sed -e 's/^require.*$//g' final_package > temp
-rm final_package
-cat lib/requires temp > final_package
-rm temp
-chmod a+x final_package

data/tests/fixtures.yml

@@ -1,3 +0,0 @@
-Bug:
-  name: Test
-  

data/tests/ts_tracker.rb

@@ -1,13 +0,0 @@
-#!/usr/bin/env ruby
-
-# Adds current directory - test - and the lib directory to current PATH
-$:.unshift File.join(File.dirname(__FILE__))
-
-# require needed library files
-require 'test/unit'
-require File.dirname(__FILE__) + "/../lib/database.rb"
-
-# Run all tests
-test_cases = `ls #{File.dirname(__FILE__)}`.split("\n").select{ |f| f =~ /tc.*\.rb/ }.each do |file|
-  require File.join(File.dirname(__FILE__), file)
-end