Tracker 0.1.2 → 1.0.0

data/README

@@ -1,18 +1,45 @@
-== Using tracker (or whatever it's named)
-  tracker help
-  Can be used with alternative file, use the -f option.
-  tracker -f /path/to/sqlite3_file
-  
-== Dependencies
-  Ruby 1.8
-  SWIG
-  SQLite3
-  SQLite3-Ruby interface
-  
-== To add a new action
-  * Implement it in Bug class (for whatever bug needs that doesn't have)
-  * Add the command to the factory in lib/factory.rb
-  * Make sure the options are valid.  You can add new options in the hash in tracker.rb.
-  
-== LICENSE
-See MIT-LICENSE.
+== What is Tracker? ==
+
+Tracker 1.0 is a remake of Tracker (see http://tracker.rubyforge.org).  It's going to be a leaner/quicker ticket tracker.
+
+Tracker is meant for personal projects where you want to keep track of bugs that pop up or features.  The database is a local sqlite3 file that can be uploaded into your Subversion repository.
+
+This program and all software is released under the MIT License.  Feel free to use it, modify it, steal from it, etc. for personal or commercial use.
+
+
+== About ==
+
+Author:       Hugh Bien
+Email:        bienhd@gmail.com
+Guide:        http://recursive2.wordpress.com/2007/05/11/re-introducing-tracker/
+Repository:   http://recursive2.com/svn/public/tracker
+Changelog:    Use `svn log`
+
+Below are checklists for the upcoming milestone and BDD checklist.  The milestone checklist shows what features I'm aiming for.  The BDD checklist is sort of a break down of the feature I'm currently working on.
+
+To see a complete list of features and bugs, use `trac list` on the .tracker_db for this project.
+
+
+== Version 1.1.0 Milestone :: May 20, 2007 ==
+
+[ ] trac help 'command' should spit out help messages for each command
+[ ] Extract the class 'Output' from 'Tracker'.
+[ ] HTML output report
+[ ] specifications for the 'trac' binary
+[ ] bug fixes from v1.0.0
+
+
+== BDD Checklist ==
+
+[ ] trac help
+[ ] trac help bootstrap
+[ ] trac help list
+[ ] trac help search
+[ ] trac help create
+[ ] trac help show
+[ ] trac help update
+[ ] trac help delete
+[ ] trac help add
+[ ] trac help remove
+[ ] trac help open
+[ ] trac help close

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rake'
+require 'spec/rake/spectask'
+require 'rake/gempackagetask'
+require 'rake/clean'
+
+CLEAN.include('pkg', 'doc')
+
+gem_spec = Gem::Specification.new do |s|
+  s.name = "Tracker"
+  s.version = "1.0.0"
+  s.summary = "A command line ticket tracker for solo projects."
+  
+  # Spec Files
+  s.test_files = FileList['specs/*_spec.rb']
+  
+  # Executables
+  s.executables = ['trac']
+  
+  # Other related files
+  s.files = FileList['README', 'Rakefile', 'lib/*.rb']
+end
+
+namespace :build do
+  Rake::GemPackageTask.new(gem_spec) do |pkg|
+    pkg.need_zip = false
+    pkg.need_tar = false
+  end
+end
+
+namespace :spec do
+  desc "Runs all specifications"
+  Spec::Rake::SpecTask.new('all') do |t|
+    t.spec_files = FileList['spec/*_spec.rb']
+  end
+
+  desc "Generate specdocs for examples"
+  Spec::Rake::SpecTask.new('doc') do |t|
+    t.spec_files = FileList['spec/*_spec.rb']
+    t.spec_opts = ["--format", "s"]
+  end
+  
+  desc "Generate HTML report for specifications"
+  Spec::Rake::SpecTask.new('html') do |t|
+    `spec -f html spec/*_spec.rb > site/spec.html`
+  end
+  
+  desc "Runs autotest using RSpec"
+  task :autotest do
+    require './spec/rspec_autotest'
+    RspecAutotest.run
+  end
+end

data/bin/trac

@@ -1,65 +1,82 @@
 #!/usr/bin/env ruby
-# Tracker is under the MIT-LICENSE
-# Please see http://ieng6.ucsd.edu/~hbien/tracker for more information about Tracker.
+require File.dirname(__FILE__) + "/../lib/environment.rb"
 
-# Handles connection to the database
+params = {}
 
-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"
-
-# -----------------------------------------------------------------------------
-# Begin executing the script here.
-# -----------------------------------------------------------------------------
-
-# What file should we use for the database?
-database = DEFAULT_DATABASE_FILE_NAME
-
-# What to do if no database can be found
-def no_database_error(database_file = "the current")
-  puts "Could not find '.tracker_db' in #{database_file} or any parent directories."
-  puts "Try '#{File.basename(__FILE__)} create' to create a new database in the current directory or '#{File.basename(__FILE__)} help' to see available commands."
-  exit
-end
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{$0} <subcommand> [options]\n" +
+                "Tracker is a ticket tracker for personal projects.\n" +
+                "\nAvailable Subcommands:\n" +
+                "    bootstrap\n" +
+                "    list     (--open | --closed)\n" +
+                "    search   PHRASE\n" +
+                "    create   --message STRING --keywords STRING\n" +
+                "    show     ID\n" +
+                "    update   ID --message STRING --keywords STRING\n" +
+                "    delete   ID\n" +
+                "    add      ID --message STRING\n" +
+                "    remove   ID --position INT\n" +
+                "    open     ID\n" +
+                "    close    ID\n\n"
+  
+  opts.on("-m", "--message [STRING]", "sets the message of your ticket or comment") do |message|
+    params[:message] = message
+  end
 
-# Is the user creating a new database?
-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."
+  opts.on("-k", "--keywords [STRING]", "sets the keywords of your ticket") do |keywords|
+    params[:keywords] = keywords
+  end  
+  
+  opts.on("-i", "--id [INT]", "sets the id of the ticket you want") do |id|
+    params[:id] = id
+  end
+  
+  opts.on("-p", "--position [INT]", "position of a comment") do |position|
+    params[:position] = position
+  end
+  
+  opts.on("-l", "--limit [INT]", "limit the number of tickets to list or search for") do |limit|
+    params[:limit] = limit
+  end
+  
+  opts.on("-o", "--open", "list open tickets only") do
+    params[:state] = Ticket::OPEN
+  end
+  
+  opts.on("-c", "--closed", "list closed tickets only") do
+    params[:state] = Ticket::CLOSED
+  end
+  
+  opts.on("-h", "--help", "display this help menu and exit") do
+    puts opts
     exit
-  else
-    Database::create_database(database)
+  end
+  
+  opts.on("-v", "--version", "shows version of Tracker (v1.0.0)") do
+    puts "Tracker v1.0.0"
     exit
   end
 end
 
-# Find the database in parent directories
-iteration = 0
-while !File.exists?(database) && iteration < 10
-  iteration += 1
-  database = File.join("..", database)
+# For unknown commands
+unless %w[bootstrap list search create show update delete add remove open close -h --help -v --version].include?(ARGV[0])
+  puts "Unknown command: '#{ARGV[0]}'\n" +
+       "Type '#{$0} --help' for usage."
+  exit
 end
 
-# Could we find the database?
-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")
-    index = ARGV.index("-f") + 1 if ARGV.include?("-f")
-    index = ARGV.index("--file") + 1 if ARGV.include?("--file")
-    database = ARGV[index]
-    database = File.join(database, ".tracker_db") if File.directory?(database)
-    no_database_error(database) if !File.exist?(database)
-  end
-  # if we did, execute command
-  Database::connect_to_database(database)
-  parser = Interface.new
-  begin
-    parser.parse_command(ARGV)
-  rescue Exception => error
-    puts "Error executing database instructions: " + error
+begin
+  # Runs the application
+  parser.parse!(ARGV)
+  tracker = Tracker.new
+
+  # Turn ID into ARGV[1] if necessary
+  if %w[show update delete search add remove open close].include?(ARGV[0])
+    params[:id] ||= ARGV[1]
   end
+  
+  # Print the results
+  puts tracker.send(ARGV[0], params)
+rescue ActiveRecord::StatementInvalid
+  puts "Database error.  Use 'trac bootstrap' to create a new database."
 end
-

data/lib/comment.rb

@@ -0,0 +1,7 @@
+class Comment < ActiveRecord::Base
+  belongs_to :ticket
+  acts_as_list :scope => :ticket
+  after_save do |comment|
+    comment.ticket ? comment.ticket.save! : nil
+  end
+end

data/lib/environment.rb

@@ -0,0 +1,31 @@
+require "rubygems"
+require "active_record"
+require "stringio"
+require "optparse"
+
+require File.dirname(__FILE__) + "/ticket.rb"
+require File.dirname(__FILE__) + "/comment.rb"
+require File.dirname(__FILE__) + "/tracker.rb"
+
+# Find .tracker_db
+module Environment
+  # Search for the database unless you're doing a bootstrap
+  if ARGV[0] != "bootstrap" && ENV['TRACKER_ENV'] != "testing"
+    directory = "."
+    i = 0
+    6.times do
+      break if File.exists?(directory + "/.tracker_db")
+      directory += "/.."
+      i += 1
+    end    
+    directory = nil if i == 6
+  end
+  
+  DIRECTORY = directory || "."
+  DATABASE = ENV['TRACKER_ENV'] == "testing" ? DIRECTORY + "/.tracker_test_db" : DIRECTORY + "/.tracker_db"
+end
+
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => Environment::DATABASE
+)

data/lib/ticket.rb

@@ -0,0 +1,38 @@
+class Ticket < ActiveRecord::Base
+  has_many :comments, :order => "position", :dependent => :delete_all
+  
+  OPEN, CLOSED = 0, 1
+  
+  def self.search(phrase, options = {})
+    conditions = { :state => (options.delete(:state) || OPEN) }
+    self.with_scope(:find => options.merge(:conditions => conditions) ) do
+      self.find(:all, :conditions => ["keywords LIKE ? OR message LIKE ?", "%" + phrase + "%", "%" + phrase + "%"])
+    end
+  end
+  
+  def summary
+    digits = self.number.to_s.length
+    trim_to = 65 - digits
+    self.message.length > 60 ? self.message[0..trim_to] + "..." : self.message
+  end
+    
+  def open
+    self.update_attributes!(:state => OPEN)
+  end
+  
+  def close
+    self.update_attributes!(:state => CLOSED)
+  end
+    
+  def open?
+    self.state == 0
+  end
+  
+  def closed?
+    self.state == 1
+  end
+  
+  def number
+    self.id
+  end
+end

data/lib/tracker.rb

@@ -0,0 +1,127 @@
+class Tracker
+  def bootstrap(params = {})
+    $stdout = StringIO.new
+    ActiveRecord::Schema.define do
+      create_table "tickets" do |t|
+        t.column "keywords", :string
+        t.column "message", :text
+        t.column "state", :int, :default => 0
+        t.column "updated_at", :datetime
+      end
+      
+      create_table "comments" do |t|
+        t.column "ticket_id", :int
+        t.column "position", :int
+        t.column "message", :text
+      end
+    end
+    result = "New database '#{Environment::DATABASE}' was created"
+  rescue ActiveRecord::StatementInvalid => e
+    result = "Could not create the database '#{Environment::DATABASE}' because it already exists"
+  ensure
+    $stdout = STDOUT
+    return result
+  end
+  
+  def create(params = {})
+    ticket = Ticket.create(params)
+    "Created new ticket ##{ticket.number}"
+  end
+  
+  def show(params = {})
+    find_ticket(params[:id]) do |ticket|
+      show_ticket(ticket)
+    end
+  end
+  
+  def list(params = {})
+    conditions = { :state => Ticket::OPEN }.merge(params)
+    tickets = Ticket.with_scope(:find => { :conditions => conditions }) do
+      Ticket.find(:all, :order => "updated_at DESC")
+    end
+    
+    return list_tickets(tickets)
+  end
+  
+  def search(params = {})
+    phrase = params.delete(:id)
+    tickets = Ticket.search(phrase, params.merge(:order => "updated_at DESC"))
+    
+    return list_tickets(tickets)
+  end
+  
+  def update(params = {})
+    find_ticket(params[:id]) do |ticket|
+      params.delete(:id)
+      ticket.update_attributes!(params)
+      "Ticket ##{ticket.number} was updated"
+    end
+  end
+  
+  def delete(params = {})
+    find_ticket(params[:id]) do |ticket|
+      ticket.destroy
+      "Ticket ##{ticket.number} was deleted"
+    end
+  end
+  
+  def add(params = {})
+    find_ticket(params[:id]) do |ticket|
+      ticket.comments.create(:message => params[:message])
+      "New comment was added to ticket ##{ticket.number}"
+    end
+  end
+  
+  def remove(params = {})
+    find_ticket(params[:id]) do |ticket|
+      ticket.comments[params[:position] - 1].destroy
+      "Comment ##{params[:position]} was removed from ticket ##{ticket.number}"
+    end
+  end
+  
+  def open(params = {})
+    find_ticket(params[:id]) do |ticket|
+      ticket.open
+      "Opened ticket ##{ticket.number}"
+    end
+  end
+  
+  def close(params = {})
+    find_ticket(params[:id]) do |ticket|
+      ticket.close
+      "Closed ticket ##{ticket.number}"
+    end
+  end
+  
+  private
+  def find_ticket(ticket_id)
+    ticket = Ticket.find_by_id(ticket_id)
+    if ticket
+      yield ticket
+    else
+      "Could not find ticket ##{ticket_id}"
+    end
+  end
+  
+  def list_tickets(tickets)
+    if tickets == nil || tickets.size == 0
+      "There are currently no tickets in the database"
+    elsif tickets.size == 1
+      show_ticket(tickets[0])
+    else
+      tickets.reverse.map do |ticket|
+        "##{ticket.number}:#{" " * (5 - ticket.number.to_s.length)}#{ticket.summary}"
+      end.join("\n")
+    end
+  end
+  
+  def show_ticket(ticket)
+    "Ticket:     ##{ticket.number}\n" +
+    (ticket.keywords.blank? ? "" : "Keywords:   #{ticket.keywords}\n") +
+    "Messages: - #{ticket.updated_at.to_s(:short)}\n" +
+    " * - #{ticket.message}\n" +
+    ticket.comments.map do |comment|
+      " #{comment.position} - #{comment.message}"
+    end.join("\n")
+  end
+end