stephencelis-ghi 0.1.0 → 0.1.1

data/History.rdoc

@@ -1,3 +1,17 @@
+=== 0.1.1 / 2009-05/01
+
+* 3 major enhancements
+
+  * Use `more' (or $GHI_PAGER) to accommodate lengthy output.
+  * Default to "-l" if Dir.pwd is a git repo.
+  * Accept numbered args/flags to shortcut "show" (e.g., "ghi -2", "ghi 2")
+
+
+* 1 minor enhancement
+
+  * Update --url flag to GitHub's new convention.
+
+
 === 0.1.0 / 2009-04-27
 
 * 2 major enhancements

data/README.rdoc

@@ -38,9 +38,14 @@ Go:
 ghi works simply from within a repository. Some short examples:
 
   ghi -l                    # Lists all open issues
+  ghi                       # Shorter shorthand for "ghi -l"
+  ghi -v                    # Lists all open issues, verbosely (includes body)
   ghi -lc                   # Lists all closed issues
   ghi -l "doesn't work"     # Searches for open issues matching "doesn't work"
   ghi -l invalid -c         # Searches for closed issues matching "invalid"
+  ghi -l1                   # Shows issue 1
+  ghi -1                    # Shorter shorthand for "ghi -l1"
+  ghi 1                     # Shorter shorthand still
   ghi -o                    # Opens a new issue (in your $EDITOR)
   ghi -o "New issue"        # Opens a new issue with the title "New issue"
   ghi -o "Title" -m "Body"  # Opens a new issue with specified title and body
@@ -54,8 +59,8 @@ ghi works simply from within a repository. Some short examples:
   ghi -t1 "tag"             # Labels issue 1 with "tag"
   ghi -d1 "tag"             # Removes the label, "tag"
   ghi --claim 1             # Tags issue 1 with your GitHub username
-  open `ghi -u`             # Loads issues in your browser.
-  open `ghi -u1`            # Loads an issue in your browser.
+  ghi -u                    # Loads issues in your browser.
+  ghi -u1                   # Loads an issue in your browser.
 
 
 ghi also works anywhere:
@@ -66,10 +71,13 @@ ghi also works anywhere:
 
 ghi uses ANSI colors if you use them in git.
 
+ghi looks for a <tt>$GHI_PAGER</tt> variable for paging.
+
 
 == CONTRIBUTORS
 
 * Jamie Macey (http://blog.tracefunc.com)
+* Hiroshi Nakamura (http://github.com/nahi)
 
 
 === CONTRIBUTE?

data/bin/ghi

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
 
 require "ghi/cli"
+$stdout.sync = true
 GHI::CLI::Executable.new.parse!(ARGV)

data/lib/ghi/cli.rb

@@ -4,6 +4,12 @@ require "ghi"
 require "ghi/api"
 require "ghi/issue"
 
+begin
+  require "launchy"
+rescue LoadError
+  # No launchy!
+end
+
 module GHI::CLI #:nodoc:
   module FileHelper
     def launch_editor(file)
@@ -33,7 +39,7 @@ module GHI::CLI #:nodoc:
     private
 
     def editor
-      ENV["VISUAL"] || ENV["EDITOR"] || "vi"
+      ENV["GHI_EDITOR"] || ENV["VISUAL"] || ENV["EDITOR"] || "vi"
     end
 
     def gitdir
@@ -64,17 +70,23 @@ module GHI::CLI #:nodoc:
   end
 
   module FormattingHelper
-    def list_format(issues, term = nil)
-      l = if term
-        ["# #{state.to_s.capitalize} #{term.inspect} issues on #{user}/#{repo}"]
+    def list_header(term = nil)
+      if term
+        "# #{state.to_s.capitalize} #{term.inspect} issues on #{user}/#{repo}"
       else
-        ["# #{state.to_s.capitalize} issues on #{user}/#{repo}"]
+        "# #{state.to_s.capitalize} issues on #{user}/#{repo}"
       end
+    end
 
-      l += unless issues.empty?
-        issues.map { |i| "  #{i.number.to_s.rjust 3}: #{truncate i.title, 72}" }
+    def list_format(issues, verbosity = nil)
+      unless issues.empty?
+        if verbosity
+          issues.map { |i| ["=" * 79] + show_format(i) }
+        else
+          issues.map { |i| "  #{i.number.to_s.rjust 3}: #{truncate i.title, 72}" }
+        end
       else
-        ["none"]
+        "none"
       end
     end
 
@@ -149,7 +161,7 @@ module GHI::CLI #:nodoc:
     rescue NoMethodError
       # Do nothing.
     ensure
-      Kernel.puts(*args)
+      $stdout.puts(*args)
     end
 
     def colorize?
@@ -160,36 +172,53 @@ module GHI::CLI #:nodoc:
         false
       end
     end
+
+    def prepare_stdout
+      return if @prepared || @no_pager || !$stdout.isatty
+      colorize? # Check for colorization.
+      $stdout = IO.popen pager, "w"
+      @prepared = true
+    end
+
+    def pager
+      ENV["GHI_PAGER"] || "more -EMR"
+    end
   end
 
   class Executable
     include FileHelper, FormattingHelper
 
     attr_reader :message, :local_user, :local_repo, :user, :repo, :api,
-      :action, :state, :search_term, :number, :title, :body, :tag, :args
+      :action, :search_term, :number, :title, :body, :tag, :args, :verbosity
 
     def parse!(*argv)
       @args = argv
+
+      `git config --get remote.origin.url`.match %r{([^:/]+)/([^/]+).git$}
+      @user, @repo = $1, $2
+
       option_parser.parse!(*args)
 
-      if action.nil?
+      if action.nil? && fallback_parsing(*args).nil?
         puts option_parser
         exit
       end
-
-      run!
-    rescue OptionParser::InvalidOption, OptionParser::MissingArgument,
-        OptionParser::AmbiguousOption => e
+    rescue OptionParser::InvalidOption => e
+      if fallback_parsing(*e.args).nil?
+        warn "#{File.basename $0}: #{e.message}"
+        puts option_parser
+        exit 1
+      end
+    rescue OptionParser::MissingArgument, OptionParser::AmbiguousOption => e
       warn "#{File.basename $0}: #{e.message}"
       puts option_parser
       exit 1
+    ensure
+      run!
+      $stdout.close_write
     end
 
     def run!
-      `git config --get remote.origin.url`.match %r{([^:/]+)/([^/]+).git$}
-      @local_user, @local_repo = $1, $2
-      @user ||= @local_user
-      @repo ||= @local_repo
       @api = GHI::API.new user, repo
 
       case action
@@ -221,6 +250,10 @@ module GHI::CLI #:nodoc:
       @commenting
     end
 
+    def state
+      @state || :open
+    end
+
     private
 
     def option_parser
@@ -231,7 +264,7 @@ module GHI::CLI #:nodoc:
           @action = :list
           case v
           when nil, /^o(?:pen)?$/
-            @state = :open
+            # Defaults.
           when /^\d+$/
             @action = :show
             @number = v.to_i
@@ -239,13 +272,21 @@ module GHI::CLI #:nodoc:
             @state = :closed
           when /^u$/
             @action = :url
+          when /^v$/
+            @verbosity = true
           else
             @action = :search
-            @state ||= :open
             @search_term = v
           end
         end
 
+        opts.on("-v", "--verbose") do |v|
+          if v
+            @action ||= :list
+            @verbosity = true
+          end
+        end
+
         opts.on("-o", "--open", "--reopen [title|number]") do |v|
           @action = :open
           case v
@@ -254,7 +295,6 @@ module GHI::CLI #:nodoc:
             @number = v.to_i
           when /^l$/
             @action = :list
-            @state = :open
           when /^m$/
             @title = args * " "
           when /^u$/
@@ -276,7 +316,11 @@ module GHI::CLI #:nodoc:
             @action = :url
             @state = :closed
           when nil
-            @action = :close
+            if @action.nil? || @number
+              @action = :close
+            else
+              @state = :closed
+            end
           else
             raise OptionParser::InvalidOption
           end
@@ -355,6 +399,10 @@ module GHI::CLI #:nodoc:
           @colorize = v
         end
 
+        opts.on("--[no-]pager") do |v|
+          @no_pager = (v == false)
+        end
+
         opts.on_tail("-V", "--version") do
           puts "#{File.basename($0)}: v#{GHI::VERSION}"
           exit
@@ -368,16 +416,21 @@ module GHI::CLI #:nodoc:
     end
 
     def search
+      prepare_stdout
+      puts list_header(search_term)
       issues = api.search search_term, state
-      puts list_format(issues, search_term)
+      puts list_format(issues, verbosity)
     end
 
     def list
-      issues = api.list state
-      puts list_format(issues)
+      prepare_stdout
+      puts list_header
+      issues = api.list(state)
+      puts list_format(issues, verbosity)
     end
 
     def show
+      prepare_stdout
       issue = api.show number
       puts show_format(issue)
     end
@@ -460,9 +513,23 @@ module GHI::CLI #:nodoc:
 
     def url
       url = "http://github.com/#{user}/#{repo}/issues"
-      url << "/#{state}"       unless state.nil?
-      url << "/#{number}/find" unless number.nil?
-      puts url
+      if number.nil?
+        url << "/#{state}" unless state == :open
+      else
+        url << "#issue/#{number}"
+      end
+      defined?(Launchy) ? Launchy.open(url) : puts(url)
+    end
+
+    def fallback_parsing(*arguments)
+      if user && repo
+        if arguments.to_s.empty?
+          @action = :list
+        elsif arguments.to_s =~ /^-?(\d+)$/
+          @action = :show
+          @number = $1
+        end
+      end
     end
   end
 end

data/spec/ghi/cli_spec.rb

@@ -6,6 +6,8 @@ describe GHI::CLI::Executable do
   before :each do
     @cli = GHI::CLI::Executable.new
     @cli.stub!(:api).and_return(mock(GHI::API))
+    $stdout.stub! :close_write
+    IO.stub!(:popen).and_return $stdout
   end
 
   describe "parsing" do
@@ -21,7 +23,7 @@ describe GHI::CLI::Executable do
         @cli.should_receive(@action)
         @cli.parse! @args
         @cli.action.should == @action
-        @cli.state.should  == @state
+        @cli.state.should  == (@state || :open)
         @cli.number.should == @number
         @cli.search_term.should == @term
         @cli.title.should == @title

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: stephencelis-ghi
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Stephen Celis
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-27 00:00:00 -07:00
+date: 2009-05-01 00:00:00 -07:00
 default_executable: ghi
 dependencies: []