TicGit-ng 1.0.0

data/lib/ticgit-ng/cli.rb

@@ -0,0 +1,240 @@
+require 'ticgit-ng'
+require 'ticgit-ng/command'
+
+# used Cap as a model for this - thanks Jamis
+
+module TicGitNG
+  class CLI
+    def self.execute
+      parse(ARGV).execute!
+    end
+
+    def self.parse(args)
+      #new() calls initialize(...) below
+      cli = new(args)
+      cli.parse_options!
+      cli
+    end
+
+    attr_reader :action, :options, :args, :tic
+    attr_accessor :out
+
+    def initialize(args, path = '.', out = $stdout)
+      @args = args.dup
+      @tic = TicGitNG.open(path, :keep_state => true)
+      @options = OpenStruct.new
+      @out = out
+
+      @out.sync = true # so that Net::SSH prompts show up
+    rescue NoRepoFound
+      puts "No repo found"
+      exit
+    end
+
+    def execute!
+      if mod = Command.get(action)
+        extend(mod)
+
+        if respond_to?(:parser)
+          option_parser = Command.parser(action, &method(:parser))
+        else
+          option_parser = Command.parser(action)
+        end
+
+        option_parser.parse!(args)
+
+        execute if respond_to?(:execute)
+      else
+        puts usage
+
+        if args.empty? and !action
+          exit
+        else
+          puts('%p is not a command' % action)
+          exit 1
+        end
+      end
+    end
+
+    def parse_options! #:nodoc:
+      if args.empty?
+        puts "Please specify at least one action to execute."
+        puts
+        puts usage(args)
+        exit 1
+      end
+
+      @action = args.shift
+    end
+
+    def usage(args = nil)
+      old_args = args || [action, *self.args].compact
+
+      if respond_to?(:parser)
+        Command.parser('COMMAND', &method(:parser))
+        # option_parser.parse!(args)
+      else
+        Command.usage(old_args.first, old_args)
+      end
+    end
+
+    def get_editor_message(message_file = nil)
+      message_file = Tempfile.new('ticgitng_message').path if !message_file
+
+      editor = ENV["EDITOR"] || 'vim'
+      system("#{editor} #{message_file}");
+      message = File.readlines(message_file)
+      message = message.select { |line| line[0, 1] != '#' } # removing comments
+      if message.empty?
+        return false
+      else
+        return message
+      end
+    end
+
+    def ticket_show(t, more=nil)
+      days_ago = ((Time.now - t.opened) / (60 * 60 * 24)).round
+
+      data = [
+        ['Title',    t.title],
+        ['TicId',    t.ticket_id],
+        '',
+        ['Assigned', t.assigned],
+        ['Opened',   "#{t.opened} (#{days_ago} days)"],
+        ['State',    t.state.upcase],
+        ['Points',   t.points || 'no estimate'],
+        ['Tags',     t.tags.join(', ')],
+        ''
+      ]
+
+      data.each do |(key, value)|
+        puts(value ? "#{key}: #{value}" : key)
+      end
+
+      unless t.comments.empty?
+        puts "Comments (#{t.comments.size}):"
+        t.comments.reverse_each do |c|
+          puts "  * Added #{c.added.strftime('%m/%d %H:%M')} by #{c.user}"
+
+          wrapped = c.comment.split("\n").map{|line|
+            line.length > 80 ? line.gsub(/(.{1,80})(\s+|$)/, "\\1\n").strip : line
+          }.join("\n")
+
+          wrapped = wrapped.split("\n").map{|line| "\t#{line}" }
+
+          if wrapped.size > 6 and more.nil?
+            puts wrapped[0, 6].join("\n")
+            puts "\t** more... **"
+          else
+            puts wrapped.join("\n")
+          end
+          puts
+        end
+      end
+    end
+
+    class << self
+      attr_accessor :window_lines, :window_cols
+
+      TIOCGWINSZ_INTEL = 0x5413     # For an Intel processor
+      TIOCGWINSZ_PPC   = 0x40087468 # For a PowerPC processor
+      STDOUT_HANDLE    = 0xFFFFFFF5 # For windows
+
+      def reset_window_width
+        try_using(TIOCGWINSZ_PPC) ||
+        try_using(TIOCGWINSZ_INTEL) ||
+          try_windows ||
+          use_fallback
+      end
+
+      # Set terminal dimensions using ioctl syscall on *nix platform
+      # TODO: find out what is raised here on windows.
+      def try_using(mask)
+        buf = [0,0,0,0].pack("S*")
+
+        if $stdout.ioctl(mask, buf) >= 0
+          self.window_lines, self.window_cols = buf.unpack("S2")
+          true
+        end
+      rescue Errno::EINVAL
+      end
+
+      def try_windows
+        lines, cols = windows_terminal_size
+        self.window_lines, self.window_cols = lines, cols if lines and cols
+      end
+
+      # Determine terminal dimensions on windows platform
+      def windows_terminal_size
+        m_GetStdHandle = Win32API.new(
+          'kernel32', 'GetStdHandle', ['L'], 'L')
+        m_GetConsoleScreenBufferInfo = Win32API.new(
+          'kernel32', 'GetConsoleScreenBufferInfo', ['L', 'P'], 'L' )
+        format = 'SSSSSssssSS'
+        buf = ([0] * format.size).pack(format)
+        stdout_handle = m_GetStdHandle.call(STDOUT_HANDLE)
+
+        m_GetConsoleScreenBufferInfo.call(stdout_handle, buf)
+        (bufx, bufy, curx, cury, wattr,
+         left, top, right, bottom, maxx, maxy) = buf.unpack(format)
+        return bottom - top + 1, right - left + 1
+      rescue NameError
+      end
+
+      def use_fallback
+        self.window_lines, self.window_cols = 25, 80
+      end
+    end
+
+    def window_lines
+      TicGitNG::CLI.window_lines
+    end
+
+    def window_cols
+      TicGitNG::CLI.window_cols
+    end
+
+    if ''.respond_to?(:chars)
+      # assume 1.9
+      def just(value, size = 10, side = :left)
+        value = value.to_s
+
+        if value.bytesize > size
+          sub_value = "#{value[0, size - 1]}\xe2\x80\xa6"
+        else
+          sub_value = value[0, size]
+        end
+
+        just_common(sub_value, size, side)
+      end
+    else
+      def just(value, size = 10, side = :left)
+        chars = value.to_s.scan(/./um)
+
+        if chars.size > size
+          sub_value = "#{chars[0, size-1]}\xe2\x80\xa6"
+        else
+          sub_value = chars.join
+        end
+
+        just_common(sub_value, size, side)
+      end
+    end
+
+    def just_common(value, size, side)
+      case side
+      when :r, :right
+        value.rjust(size)
+      when :l, :left
+        value.ljust(size)
+      end
+    end
+
+    def puts(*strings)
+      @out.puts(*strings)
+    end
+  end
+end
+
+TicGitNG::CLI.reset_window_width
+Signal.trap("SIGWINCH") { TicGitNG::CLI.reset_window_width }

data/lib/ticgit-ng/command/assign.rb

@@ -0,0 +1,43 @@
+module TicGitNG
+  module Command
+    # Assigns a ticket to someone
+    #
+    # Usage:
+    # ti assign             (assign checked out ticket to current user)
+    # ti assign {1}         (assign ticket to current user)
+    # ti assign -c {1}      (assign ticket to current user and checkout the ticket)
+    # ti assign -u {name}   (assign ticket to specified user)
+    # ti assign -u {name} {1} (assign specified ticket to specified user)
+    module Assign
+      def parser(opts)
+        opts.banner = "Usage: ti assign [options] [ticket_id]"
+        opts.on_head(
+          "-u USER", "--user USER", "Assign the ticket to this user"){|v|
+          options.user = v
+        }
+        opts.on_head(
+          "-c TICKET", "--checkout TICKET", "Checkout this ticket"){|v|
+          options.checkout = v
+        }
+      end
+      def execute
+        handle_ticket_assign
+      end
+      def handle_ticket_assign
+        tic.ticket_checkout(options.checkout) if options.checkout
+        if ARGV.length == 1  #ti assign
+          tic_id=nil
+        elsif ARGV.length == 2 #ti assign {ticid}
+          tic_id=ARGV[2]
+        elsif ARGV.length == 3 #ti assign -u/-c {user/ticid}
+          if options.user
+            tic_id=nil
+          else
+            tic_id=options.checkout
+          end
+        end
+        tic.ticket_assign((options.user rescue nil), tic_id)
+      end
+    end
+  end
+end

data/lib/ticgit-ng/command/checkout.rb

@@ -0,0 +1,14 @@
+module TicGitNG
+  module Command
+    module Checkout
+      def parser(opts)
+        opts.banner = "ti checkout [ticid]"
+      end
+
+      def execute
+        tid = args[0]
+        tic.ticket_checkout(tid)
+      end
+    end
+  end
+end

data/lib/ticgit-ng/command/comment.rb

@@ -0,0 +1,36 @@
+module TicGitNG
+  module Command
+    module Comment
+      def parser(opts)
+        opts.banner = "Usage: ti comment [tic_id] [options]"
+        opts.on_head(
+          "-m MESSAGE", "--message MESSAGE",
+          "Message you would like to add as a comment"){|v|
+          options.message = v
+        }
+        opts.on_head(
+          "-f FILE", "--file FILE",
+          "A file that contains the comment you would like to add"){|v|
+          raise ArgumentError, "Only 1 of -f/--file and -m/--message can be specified" if options.message
+          raise ArgumentError, "File #{v} doesn't exist" unless File.file?(v)
+          raise ArgumentError, "File #{v} must be <= 2048 bytes" unless File.size(v) <= 2048
+          options.file = v
+        }
+      end
+
+      def execute
+        tid = args[0].strip if args[0]
+        message, file = options.message, options.file
+
+        if message
+          tic.ticket_comment(message, tid)
+        elsif file
+          tic.ticket_comment(File.read(file), tid)
+        else
+          return unless message = get_editor_message
+          tic.ticket_comment(message.join(''), tid)
+        end
+      end
+    end
+  end
+end

data/lib/ticgit-ng/command/list.rb

@@ -0,0 +1,80 @@
+module TicGitNG
+  module Command
+    # List tickets
+    module List
+      def parser(o)
+        o.banner = "Usage: ti list [options]"
+        o.on_head(
+          "-o ORDER", "--order ORDER",
+          "Field to order by - one of : assigned,state,date,title"){|v|
+          options.order = v
+        }
+
+        o.on_head(
+          "-t TAG[,TAG]", "--tags TAG[,TAG]", Array,
+          "List only tickets with specific tag(s)",
+          "Prefix the tag with '-' to negate"){|v|
+          options.tags ||= Set.new
+          options.tags.merge v
+        }
+
+        o.on_head(
+          "-s STATE[,STATE]", "--states STATE[,STATE]", Array,
+          "List only tickets in a specific state(s)",
+          "Prefix the state with '-' to negate"){|v|
+          options.states ||= Set.new
+          options.states.merge v
+        }
+
+        o.on_head(
+          "-a ASSIGNED", "--assigned ASSIGNED",
+          "List only tickets assigned to someone"){|v|
+          options.assigned = v
+        }
+
+        o.on_head("-S SAVENAME", "--saveas SAVENAME",
+                     "Save this list as a saved name"){|v|
+          options.save = v
+        }
+
+        o.on_head("-l", "--list", "Show the saved queries"){|v|
+          options.list = true
+        }
+      end
+
+      def execute
+        options.saved = args[0] if args[0]
+
+        if tickets = tic.ticket_list(options.to_hash)
+          counter = 0
+          cols = [80, window_cols].max
+
+          puts
+          puts [' ', just('#', 4, 'r'),
+            just('TicId', 6),
+            just('Title', cols - 56),
+            just('State', 5),
+            just('Date', 5),
+            just('Assgn', 8),
+            just('Tags', 20) ].join(" ")
+
+          puts "-" * cols
+
+          tickets.each do |t|
+            counter += 1
+            tic.current_ticket == t.ticket_name ? add = '*' : add = ' '
+            puts [add, just(counter, 4, 'r'),
+              t.ticket_id[0,6],
+              just(t.title, cols - 56),
+              just(t.state, 5),
+              t.opened.strftime("%m/%d"),
+              just(t.assigned_name, 8),
+              just(t.tags.join(','), 20) ].join(" ")
+          end
+          puts
+        end
+
+      end
+    end
+  end
+end

data/lib/ticgit-ng/command/milestone.rb

@@ -0,0 +1,26 @@
+module TicGitNG
+  module Command
+    # tic milestone
+    # tic milestone migration1 (list tickets)
+    # tic milestone -n migration1 3/4/08 (new milestone)
+    # tic milestone -a {1} (add ticket to milestone)
+    # tic milestone -d migration1 (delete)
+    module Milestone
+      def parser(opts)
+        opts.banner = "Usage: ti milestone [milestone_name] [options] [date]"
+
+        opts.on_head(
+          "-n MILESTONE", "--new MILESTONE",
+          "Add a new milestone to this project"){|v| options.new = v }
+
+        opts.on_head(
+          "-a TICKET", "--new TICKET",
+          "Add a ticket to this milestone"){|v| options.add = v }
+
+        opts.on_head(
+          "-d MILESTONE", "--delete MILESTONE",
+          "Remove a milestone"){|v| options.remove = v }
+      end
+    end
+  end
+end

data/lib/ticgit-ng/command/new.rb

@@ -0,0 +1,46 @@
+module TicGitNG
+  module Command
+    module New
+      def parser(opts)
+        opts.banner = "Usage: ti new [options]"
+        opts.on_head(
+          "-t TITLE", "--title TITLE",
+          "Title to use for the name of the new ticket"){|v| options.title = v }
+      end
+
+      def execute
+        if title = options.title
+          ticket_show(tic.ticket_new(title, options.to_hash))
+        else
+          # interactive
+          message_file = Tempfile.new('ticgit_message').path
+          File.open(message_file, 'w') do |f|
+            f.puts "\n# ---"
+            f.puts "tags:"
+            f.puts "# first line will be the title of the tic, the rest will be the first comment"
+            f.puts "# if you would like to add initial tags, put them on the 'tags:' line, comma delim"
+          end
+          if message = get_editor_message(message_file)
+            title = message.shift
+            if title && title.chomp.length > 0
+              title = title.chomp
+              if message.last[0, 5] == 'tags:'
+                tags = message.pop
+                tags = tags.gsub('tags:', '')
+                tags = tags.split(',').map { |t| t.strip }
+              end
+              if message.size > 0
+                comment = message.join("")
+              end
+              ticket_show(tic.ticket_new(title, :comment => comment, :tags => tags))
+            else
+              puts "You need to at least enter a title"
+            end
+          else
+            puts "It seems you wrote nothing"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ticgit-ng/command/points.rb

@@ -0,0 +1,28 @@
+module TicGitNG
+  module Command
+    # Assigns points to a ticket
+    #
+    # Usage:
+    # ti points {1} {points}   (assigns points to a specified ticket)
+    module Points
+      def parser(opts)
+        opts.banner = "ti points [ticket_id] points"
+      end
+
+      def execute
+        case args.size
+        when 1
+          new_points = args[0].to_i
+        when 2
+          tid = args[0]
+          new_points = args[1].to_i
+        else
+          puts usage
+          exit 1
+        end
+
+        tic.ticket_points(new_points, tid)
+      end
+    end
+  end
+end

data/lib/ticgit-ng/command/recent.rb

@@ -0,0 +1,29 @@
+module TicGitNG
+  module Command
+    module Recent
+      def parser(opts)
+        opts.banner = 'Usage: ti recent'
+      end
+
+      def execute
+        # "args[0]" seems to be superfluous.  It's usage
+        # is undocumented, and supplying an argument
+        # doesn't seem to do anything.
+        #
+        # Im guessing the purpose of args[0] was to provide a
+        # specific ticket_id whos history would be looked up
+        # intead of looking up the history for all tickets.
+        #
+        # #FIXME Reimplement that functionality and updte
+        # docs to match
+        tic.ticket_recent(args[0]).each do |commit|
+          sha = commit.sha[0, 7]
+          date = commit.date.strftime("%m/%d %H:%M")
+          message = commit.message
+
+          puts "#{sha}  #{date}\t#{message}"
+        end
+      end
+    end
+  end
+end

data/lib/ticgit-ng/command/show.rb

@@ -0,0 +1,18 @@
+module TicGitNG
+  module Command
+    module Show
+      def parser(opts)
+        opts.banner = "Usage: ti show [--full] [ticid]"
+        opts.on_head(
+          "-f", "--full", "Show long comments in full, don't truncate after the 5th line"){|v|
+          options.full= v
+        }
+      end
+
+      def execute
+        t = tic.ticket_show(args[0])
+        ticket_show(t, options.full ) if t
+      end
+    end
+  end
+end

data/lib/ticgit-ng/command/state.rb

@@ -0,0 +1,45 @@
+module TicGitNG
+  module Command
+    module State
+      def parser(opts)
+        opts.banner = "Usage: ti state [ticid] state"
+      end
+
+      def execute
+        if args.size > 1
+          tid, new_state = args[0].strip, args[1].strip
+
+          if valid_state?(new_state)
+            tic.ticket_change(new_state, tid)
+          else
+            puts "Invalid State - please choose from: #{joined_states}"
+          end
+        elsif args.size > 0
+          # new state
+          new_state = args[0].chomp
+
+          if valid_state?(new_state)
+            tic.ticket_change(new_state)
+          else
+            puts "Invalid State - please choose from: #{joined_states}"
+          end
+        else
+          puts 'You need to at least specify a new state for the current ticket'
+          puts "please choose from: #{joined_states}"
+        end
+      end
+
+      def valid_state?(state)
+        available_states.include?(state)
+      end
+
+      def available_states
+        tic.tic_states.sort
+      end
+
+      def joined_states
+        available_states.join(', ')
+      end
+    end
+  end
+end

data/lib/ticgit-ng/command/sync.rb

@@ -0,0 +1,29 @@
+module TicGitNG
+  module Command
+    module Sync
+      def parser(opts)
+        opts.banner = "Usage: ti sync [options]"
+        opts.on_head(
+          "-r REPO", "--repo REPO", "Sync ticgit-ng branch with REPO"){|v|
+          options.repo = v
+        }
+        opts.on_head(
+          "-n", "--no-push", "Do not push to the remote repo"){|v|
+          options.no_push = true
+        }
+      end
+
+      def execute
+        if options.repo and options.no_push
+          tic.sync_tickets(options.repo, false)
+        elsif options.repo
+          tic.sync_tickets(options.repo)
+        elsif options.no_push
+          tic.sync_tickets('origin', false)
+        else
+          tic.sync_tickets()
+        end
+      end
+    end
+  end
+end

data/lib/ticgit-ng/command/tag.rb

@@ -0,0 +1,31 @@
+module TicGitNG
+  module Command
+    module Tag
+      def parser(opts)
+        opts.banner = "Usage: ti tag [tic_id] [options] [tag_name] "
+        opts.on_head(
+          "-d", "--delete",
+          "Remove this tag from the ticket"){|v| options.remove = v }
+      end
+
+      def execute
+        if options.remove
+          puts 'remove'
+        end
+
+        if ARGV.size > 3
+          tid = ARGV[1].chomp
+          tic.ticket_tag(ARGV[3].chomp, tid, options)
+        elsif ARGV.size > 2 #tag 
+          tic.ticket_tag(ARGV[2], nil, options)
+				elsif ARGV.size == 2 #tag add 'tag_foobar'
+					tic.ticket_tag(ARGV[1], nil, options)
+        else
+          puts 'You need to at least specify one tag to add'
+          puts
+          puts parser
+        end
+      end
+    end
+  end
+end