TicGit-ng 1.0.0

data/lib/ticgit-ng/command.rb

@@ -0,0 +1,77 @@
+module TicGitNG
+  module Command
+    COMMANDS = {}
+    DOC = {}
+
+    def self.register(mod_name, doc, *commands)
+      autoload(mod_name, "ticgit-ng/command/#{mod_name.downcase}")
+      DOC[commands] = doc
+      commands.each{|cmd| COMMANDS[cmd] = mod_name }
+    end
+
+    register 'Assign', 'Assings a ticket to someone', 'assign'
+    register 'Attach', 'Attach file to ticket', 'attach'
+    register 'Checkout', 'Checkout a ticket', 'checkout', 'co'
+    register 'Comment', 'Comment on a ticket', 'comment'
+    register 'List', 'List tickets', 'list'
+    register 'Milestone', 'List and modify milestones', 'milestone'
+    register 'New', 'Create a new ticket', 'new'
+    register 'Points', 'Assign points to a ticket', 'points'
+    register 'Recent', 'List recent activities', 'recent'
+    register 'Show', 'Show a ticket', 'show'
+    register 'State', 'Change state of a ticket', 'state'
+    register 'Tag', 'Modify tags of a ticket', 'tag'
+    register 'Sync', 'Sync tickets', 'sync'
+
+    def self.get(command)
+      if mod_name = COMMANDS[command]
+        const_get(mod_name)
+      end
+    end
+
+    def self.usage(action, args)
+      option_parser = parser(action, &method(:default_usage))
+      option_parser.parse!(args)
+      option_parser
+    end
+
+    def self.default_usage(o)
+      o.banner = "Usage: ti COMMAND [FLAGS] [ARGS]"
+      o.top.append ' ', nil, nil
+      o.top.append 'The available ticgit commands are:', nil, nil
+
+      DOC.each do |commands, doc|
+        # get the longest version
+        command = commands.sort_by{|cmd| cmd.size }.last
+        o.top.append("    %-32s %s" % [command, doc], nil, nil)
+      end
+    end
+
+    def self.parser(action, &block)
+      OptionParser.new do |o|
+        o.banner = "Usage: ti #{action} [FLAGS] [ARGS]"
+
+        o.base.append ' ', nil, nil
+        o.base.append 'Common options:', nil, nil
+        o.on_tail('-v', '--version', 'Show the version number'){
+          puts TicGitNG::VERSION
+          exit
+        }
+        o.on_tail('-h', '--help', 'Display this help'){
+          puts o
+          exit
+        }
+
+        if block_given?
+          yield(o) if block_given?
+          unless o.top.list.empty?
+            if action
+              o.top.prepend "Options for #{action} command:", nil, nil
+              o.top.prepend ' ', nil, nil
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ticgit-ng/comment.rb

@@ -0,0 +1,17 @@
+module TicGitNG
+  class Comment
+
+    attr_reader :base, :user, :added, :comment
+
+    def initialize(base, file_name, sha)
+      @base = base
+      @comment = base.git.gblob(sha).contents rescue nil
+
+      type, date, user = file_name.split('_')
+
+      @added = Time.at(date.to_i)
+      @user = user
+    end
+
+  end
+end

data/lib/ticgit-ng/ticket.rb

@@ -0,0 +1,233 @@
+module TicGitNG
+  class Ticket
+
+    attr_reader :base, :opts
+    attr_accessor :ticket_id, :ticket_name
+    attr_accessor :title, :state, :milestone, :assigned, :opened, :points
+    attr_accessor :comments, :tags, :attachments # arrays
+
+    def initialize(base, options = {})
+      options[:user_name] ||= base.git.config('user.name')
+      options[:user_email] ||= base.git.config('user.email')
+
+      @base = base
+      @opts = options || {}
+
+      @state = 'open' # by default
+      @comments = []
+      @tags = []
+      @attachments = []
+    end
+
+    def self.create(base, title, options = {})
+      t = Ticket.new(base, options)
+      t.title = title
+      t.ticket_name = self.create_ticket_name(title)
+      t.save_new
+      t
+    end
+
+    def self.open(base, ticket_name, ticket_hash, options = {})
+      tid = nil
+
+      t = Ticket.new(base, options)
+      t.ticket_name = ticket_name
+
+      title, date = self.parse_ticket_name(ticket_name)
+      t.opened = date
+
+      ticket_hash['files'].each do |fname, value|
+        if fname == 'TICKET_ID'
+          tid = value
+        elsif fname == 'TICKET_TITLE'
+          t.title = base.git.gblob(value).contents
+        else
+          # matching
+          data = fname.split('_')
+
+          case data[0]
+          when 'ASSIGNED'
+            t.assigned = data[1]
+          when 'ATTACHMENT'
+            t.attachments << TicGitNG::Attachment.new(base, fname, value)
+          when 'COMMENT'
+            t.comments << TicGitNG::Comment.new(base, fname, value)
+          when 'POINTS'
+            t.points = base.git.gblob(value).contents.to_i
+          when 'STATE'
+            t.state = data[1]
+          when 'TAG'
+            t.tags << data[1]
+          when 'TITLE'
+            t.title = base.git.gblob(value).contents
+          end
+        end
+      end
+
+      t.ticket_id = tid
+      t
+    end
+
+
+    def self.parse_ticket_name(name)
+      epoch, title, rand = name.split('_')
+      title = title.gsub('-', ' ')
+      return [title, Time.at(epoch.to_i)]
+    end
+
+    # write this ticket to the git database
+    def save_new
+      base.in_branch do |wd|
+        base.logger.info "saving #{ticket_name}"
+
+        Dir.mkdir(ticket_name)
+        Dir.chdir(ticket_name) do
+          base.new_file('TICKET_ID', ticket_name)
+          base.new_file('TICKET_TITLE', title)
+          base.new_file('ASSIGNED_' + email, email)
+          base.new_file('STATE_' + state, state)
+          base.new_file('TITLE', title)
+
+          # add initial comment
+          #COMMENT_080315060503045__schacon_at_gmail
+          base.new_file(comment_name(email), opts[:comment]) if opts[:comment]
+
+          # add initial tags
+          if opts[:tags] && opts[:tags].size > 0
+            opts[:tags] = opts[:tags].map { |t| t.strip }.compact
+            opts[:tags].each do |tag|
+              if tag.size > 0
+                tag_filename = 'TAG_' + Ticket.clean_string(tag)
+                if !File.exists?(tag_filename)
+                  base.new_file(tag_filename, tag_filename)
+                end
+              end
+            end
+          end
+        end
+        base.git.add
+        base.git.commit("added ticket #{ticket_name}")
+      end
+      # ticket_id
+    end
+
+    def self.clean_string(string)
+      string.downcase.gsub(/[^a-z0-9]+/i, '-')
+    end
+
+    def add_comment(comment)
+      return false if !comment
+      base.in_branch do |wd|
+        Dir.chdir(ticket_name) do
+          base.new_file(comment_name(email), comment)
+        end
+        base.git.add
+        base.git.commit("added comment to ticket #{ticket_name}")
+      end
+    end
+
+    def change_state(new_state)
+      return false if !new_state
+      return false if new_state == state
+
+      base.in_branch do |wd|
+        Dir.chdir(ticket_name) do
+          base.new_file('STATE_' + new_state, new_state)
+        end
+        base.git.remove(File.join(ticket_name,'STATE_' + state))
+        base.git.add
+        base.git.commit("added state (#{new_state}) to ticket #{ticket_name}")
+      end
+    end
+
+    def change_assigned(new_assigned)
+      new_assigned ||= email
+      old_assigned= assigned || ''
+      return false if new_assigned == old_assigned
+
+      base.in_branch do |wd|
+        Dir.chdir(ticket_name) do
+          base.new_file('ASSIGNED_' + new_assigned, new_assigned)
+        end
+        base.git.remove(File.join(ticket_name,'ASSIGNED_' + old_assigned))
+        base.git.add
+        base.git.commit("assigned #{new_assigned} to ticket #{ticket_name}")
+      end
+    end
+
+    def change_points(new_points)
+      return false if new_points == points
+
+      base.in_branch do |wd|
+        Dir.chdir(ticket_name) do
+          base.new_file('POINTS', new_points)
+        end
+        base.git.add
+        base.git.commit("set points to #{new_points} for ticket #{ticket_name}")
+      end
+    end
+
+    def add_tag(tag)
+      return false if !tag
+      added = false
+      tags = tag.split(',').map { |t| t.strip }
+      base.in_branch do |wd|
+        Dir.chdir(ticket_name) do
+          tags.each do |add_tag|
+            if add_tag.size > 0
+              tag_filename = 'TAG_' + Ticket.clean_string(add_tag)
+              if !File.exists?(tag_filename)
+                base.new_file(tag_filename, tag_filename)
+                added = true
+              end
+            end
+          end
+        end
+        if added
+          base.git.add
+          base.git.commit("added tags (#{tag}) to ticket #{ticket_name}")
+        end
+      end
+    end
+
+    def remove_tag(tag)
+      return false if !tag
+      removed = false
+      tags = tag.split(',').map { |t| t.strip }
+      base.in_branch do |wd|
+        tags.each do |add_tag|
+          tag_filename = File.join(ticket_name, 'TAG_' + Ticket.clean_string(add_tag))
+          if File.exists?(tag_filename)
+            base.git.remove(tag_filename)
+            removed = true
+          end
+        end
+        if removed
+          base.git.commit("removed tags (#{tag}) from ticket #{ticket_name}")
+        end
+      end
+    end
+
+    def path
+      File.join(state, ticket_name)
+    end
+
+    def comment_name(email)
+      'COMMENT_' + Time.now.to_i.to_s + '_' + email
+    end
+
+    def email
+      opts[:user_email] || 'anon'
+    end
+
+    def assigned_name
+      assigned.split('@').first rescue ''
+    end
+
+    def self.create_ticket_name(title)
+      [Time.now.to_i.to_s, Ticket.clean_string(title), rand(999).to_i.to_s].join('_')
+    end
+
+
+  end
+end

data/lib/ticgit-ng/version.rb

@@ -0,0 +1,3 @@
+module TicGitNG
+  VERSION = '1.0.0'
+end

data/lib/ticgit-ng.rb

@@ -0,0 +1,35 @@
+require 'fileutils'
+require 'logger'
+require 'optparse'
+require 'ostruct'
+require 'set'
+require 'yaml'
+
+# Add the directory containing this file to the start of the load path if it
+# isn't there already.
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+# requires git >= 1.0.5
+require 'git'
+require 'ticgit-ng/base'
+require 'ticgit-ng/cli'
+
+module TicGitNG
+  autoload :VERSION, 'ticgit-ng/version'
+  autoload :Comment, 'ticgit-ng/comment'
+  autoload :Ticket, 'ticgit-ng/ticket'
+
+  # options
+  #   :logger => Logger.new(STDOUT)
+  def self.open(git_dir, options = {})
+    Base.new(git_dir, options)
+  end
+
+  class OpenStruct < ::OpenStruct
+    def to_hash
+      @table.dup
+    end
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification 
+name: TicGit-ng
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Scott Chacon
+- Jeff Welling
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-15 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: git
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: TicGit-ng is a simple ticketing system, roughly similar to the Lighthouse model, that is based in git.
+email: 
+- Jeff.Welling@gmail.com
+executables: 
+- ti
+- ticgitweb
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/ti
+- bin/ticgitweb
+- lib/ticgit-ng.rb
+- lib/ticgit-ng/base.rb
+- lib/ticgit-ng/ticket.rb
+- lib/ticgit-ng/cli.rb
+- lib/ticgit-ng/version.rb
+- lib/ticgit-ng/command/assign.rb
+- lib/ticgit-ng/command/state.rb
+- lib/ticgit-ng/command/new.rb
+- lib/ticgit-ng/command/recent.rb
+- lib/ticgit-ng/command/sync.rb
+- lib/ticgit-ng/command/show.rb
+- lib/ticgit-ng/command/points.rb
+- lib/ticgit-ng/command/milestone.rb
+- lib/ticgit-ng/command/tag.rb
+- lib/ticgit-ng/command/comment.rb
+- lib/ticgit-ng/command/list.rb
+- lib/ticgit-ng/command/checkout.rb
+- lib/ticgit-ng/command.rb
+- lib/ticgit-ng/comment.rb
+- LICENSE_MIT
+- LICENSE_GPL
+- README.mkd
+has_rdoc: true
+homepage: https://github.com/jeffWelling/ticgit
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: ticgit-ng
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Git based distributed ticketing system
+test_files: []
+