github_cli 0.4.1 → 0.4.2

data/.travis.yml

@@ -4,6 +4,11 @@ branches:
   only: master
 notifications:
   email:false
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - jruby
+    - rbx-19mode
 rvm:
   - 1.9.2
   - 1.9.3

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+0.4.2 (July 12, 2012)
+
+* Add 'did you mean' help for mistyped commands.
+* Add utility function for finding common prefix.
+* Extract command usage and completion classes.
+* Fix bug with all commands listing.
+* Add arguments parser for required and optional arguments.
+* Add non-required argument parsing to repository creation.
+* Add new error type for required arguments.
+* Fix bug with creating authorizations.
+
 0.4.1 (June 28, 2012)
 
 * Add search api commands.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    github_cli (0.4.1)
+    github_cli (0.4.2)
       github_api (~> 0.6)
       thor
 

data/README.md

@@ -41,6 +41,28 @@ This will setup a `.githubrc` configuration file in your home directory with
 all the global settings. During the install process you will be prompted for your
 `authentication token`.
 
+### Arguments
+
+The required arguments come first as per command description, then follow the optional arguments inside a `params` flag.
+
+You can create repository by supplying parameters in the following way:
+
+```shell
+ghc repo create octokit --params=description:'Test repo for kitty.'
+```
+
+To create repository inside organization:
+
+```shell
+ghc repo create github/octokit --params=description:'Test repo for kitty.'
+```
+
+To find out which options are required and optional type:
+
+```shell
+ghc repo help create
+```
+
 ### Getting a list of commands
 
 You can list all GitHub APIs comamnds:
@@ -55,6 +77,38 @@ to limit returned results pass `pattern`
 $ ghc list re*   # Returns all commands matching the pattern
 ```
 
+### Output Format
+
+The API responses can be formatted as `csv`, `json`, `pretty`, `table`.
+
+By default responses are in tabular format. Tables are available in `horizontal` and `vertical` mode. To enforce table display pass `:h` and `:v` respectively. Otherwise a default orientation will be picked depending on the request made and terminal size.
+
+```shell
+ghc user get -u peter-murach --format=table:h
+
+┏━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳
+┃ type     ┃ login    ┃ public_… ┃ blog     ┃ hireable ┃ followe… ┃ followi… ┃ location ┃ html_url ┃ name     ┃
+┣━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋
+┃ User     ┃ peter-m… ┃ 14       ┃ peter-m… ┃ false    ┃ 18       ┃ 52       ┃ Sheffie… ┃ https:/… ┃ Piotr M… ┃
+┗━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻
+```
+
+To get `csv` formatting for easy command piping do
+
+```shell
+ghc repo ls -u wycats --format=csv
+```
+
+### Output Paging
+
+By default all responses are paged. You can switch off paging by supplying `no-pager` flag.
+
+```shell
+ghc --no-pager user ls -u wycats
+```
+
+Also you can supply you preferred `pager`, otherwise the paging program is taken from environment variable PAGER if defined or defaults to "less".
+
 ### API
 
 Interact with git data:
@@ -73,6 +127,7 @@ Interact with issues:
 $ ghc issue
 $ ghc label
 $ ghc milestone
+$ ghc comment
 ```
 
 Interact with repositories:
@@ -80,6 +135,7 @@ Interact with repositories:
 ```shell
 $ ghc repo
 $ ghc collab
+$ ghc content
 $ ghc download
 $ ghc fork
 $ ghc hook
@@ -121,52 +177,6 @@ Interact with search:
 $ ghc search
 ```
 
-### Output Format
-
-The API responses can be formatted as `csv`, `json`, `pretty`, `table`.
-
-By default responses are in tabular format. Tables are available in `horizontal` and `vertical` mode. To enforce table display pass `:h` and `:v` respectively. Otherwise a default orientation will be picked depending on the request made and terminal size.
-
-```shell
-ghc user get -u peter-murach --format=table:h
-
-┏━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳
-┃ type     ┃ login    ┃ public_… ┃ blog     ┃ hireable ┃ followe… ┃ followi… ┃ location ┃ html_url ┃ name     ┃
-┣━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋
-┃ User     ┃ peter-m… ┃ 14       ┃ peter-m… ┃ false    ┃ 18       ┃ 52       ┃ Sheffie… ┃ https:/… ┃ Piotr M… ┃
-┗━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻
-```
-
-To get `csv` formatting for easy command piping do
-
-```shell
-ghc repo ls -u wycats --format=csv
-```
-
-### Output Paging
-
-By default all responses are paged. You can switch off paging by supplying `no-pager` flag.
-
-```shell
-ghc --no-pager user ls -u wycats
-```
-
-Also you can supply you preferred `pager`, otherwise the paging program is taken from environment variable PAGER if defined or defaults to "less".
-
-### Examples
-
-You can create repository by supplying required parameters
-
-```shell
-ghc repo create --params=name:'octocat' description:'Test repo for kitty.'
-```
-
-To find out which options are required type
-
-```shell
-ghc repo help create
-```
-
 ## Contributing
 
 1. Fork it

data/features/completion.feature

@@ -0,0 +1,32 @@
+Feature: Command Completion
+
+  Scenario: Suggest alternative
+
+    When I run `ghc blah`
+    Then the exit status should be 0
+    And the output should contain:
+    """
+    Did you mean this?
+            blob
+    """
+
+  Scenario: Suggest more than one
+
+    When I run `ghc convent`
+    Then the exit status should be 0
+    And the output should contain:
+    """
+    Did you mean this?
+            collab
+            commit
+            content
+    """
+
+  Scenario: Suggset nothing
+
+    When I run `ghc xen`
+    Then the exit status should be 0
+    And the output should not contain:
+    """
+    Did you mean this?
+    """

data/features/executable.feature

@@ -18,17 +18,6 @@ Feature: The GHC Executable
       |      |
       | help |
 
-  Scenario: Getting Usage for Commands
-
-    When I run `ghc`
-    Then the exit status should be 0
-    And the output should contain "Usage: ghc"
-      And the output should contain "[--config]"
-      And the output should contain "[--no-color]"
-      And the output should contain "[--no-pager]"
-      And the output should contain "[--version]"
-      And the output should contain "[--verbose]"
-
   Scenario Outline: Getting Subcommands
 
     When I run `ghc <command>`

data/features/support/hooks.rb

@@ -1,6 +1,7 @@
 require 'fileutils'
 
 Before do
+  @aruba_timeout_seconds = 5
   @real_home = ENV['HOME']
   fake_home = File.join('/tmp', 'fakehome')
   FileUtils.rm_rf fake_home if File.exists? fake_home

data/features/usage.feature

@@ -0,0 +1,18 @@
+Feature: Command Usage
+
+  Scenario: Getting Usage for Commands
+
+    When I run `ghc`
+    Then the exit status should be 0
+    And the output should contain "Usage: ghc"
+      And the output should contain "[--config]"
+      And the output should contain "[--no-color]"
+      And the output should contain "[--no-pager]"
+      And the output should contain "[--version]"
+      And the output should contain "[--verbose]"
+
+  Scenario: Specific usage for command
+
+    When I run `ghc repo`
+    Then the exit status should be 0
+    And the output should contain "repo <subcommand>"

data/github_cli.gemspec

@@ -3,7 +3,7 @@ require File.expand_path('../lib/github_cli/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Piotr Murach"]
-  gem.email         = ["pmurach@gmail.com"]
+  gem.email         = [""]
   gem.description   = %q{CLI-based access to GitHub API v3}
   gem.summary       = %q{github_cli is a set of tools that provide full command line access to GitHub API v3}
   gem.homepage      = "http://github.com/peter-murach/github_cli"

data/lib/github_cli/api.rb

@@ -4,10 +4,14 @@ module GithubCLI
   # The API class is the main entry point for creating GithubCLI APIs.
   class API
 
+    ENDPOINT = ''
+
     @@api = nil
 
     class << self
 
+      attr_reader :config
+
       def github_api
         @@api ||= begin
           @@api = configure_api

data/lib/github_cli/command/arguments.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+module GithubCLI
+  class Command
+    # Makes it easy to parse required and options arguments.
+    class Arguments
+
+      SEPARATOR = '/'
+
+      attr_reader :args
+
+      def initialize(args)
+        @args = args
+      end
+
+      # Returns seperated arguments
+      def parse
+        required, non_required = nil, nil
+
+        if !args.empty?
+          required = args
+          non_required, required = required.split('/', 2) if required.index('/')
+        else
+          raise RequiredArgumentMissingError, "No value provided for required argument"
+        end
+        [non_required, required]
+      end
+
+      # Returns a concise string representation of Arguments instance
+      #
+      def inspect
+        "#<#{self.class.inspect} @args=#{args.inspect}"
+      end
+
+    end # Arguments
+  end # Command
+end # GithubCLI

data/lib/github_cli/command/completion.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+module GithubCLI
+  # Provides command completion/suggestion for mistyped command or subcommand.
+  class Command
+    class Completion
+      include GithubCLI::Util
+
+      # Command to be looked up.
+      attr_accessor :command
+
+      def initialize(command)
+        @command = command
+      end
+
+      DEFAULT_INDENT = 8
+
+      # If there is more than one possible alternative, show all of them.
+      #
+      def find_command_possibilities
+        max_length = 1
+        commands = Command.all.select do |cmd|
+          prefix = Util.longest_common_prefix(command, cmd.namespace)
+          if !prefix.empty? && (prefix.length >= max_length)
+            max_length = prefix.length
+            cmd
+          end
+        end
+        commands.map(&:namespace).uniq.sort
+      end
+
+      # Options
+      # indent - Indent suggested commands by specified value.
+      #
+      def format_command_possibilities(options={})
+        possibilities = find_command_possibilities
+        string = ""
+        indent = options[:indent] || DEFAULT_INDENT
+        if possibilities.size >= 1
+          string << "\n\nDid you mean this?\n"
+          possibilities.each do |possibility|
+            string << " " * indent + "#{possibility}\n"
+          end
+        end
+        string
+      end
+
+      # Returns a concise string representation of Completion instance
+      #
+      def inspect
+        "#<#{self.class.inspect} @command=#{command.inspect}"
+      end
+
+    end # Completion
+  end # Command
+end # GithubCLI

data/lib/github_cli/command/usage.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+
+module GithubCLI
+  # Responsible for manipulating commands usage string.
+  class Command
+    class Usage
+
+      DEFAULT_INDENT = 11
+
+      # Returns command
+      attr_reader :command
+
+      # Returns command flags
+      attr_reader :flags
+
+      # Initializes an usage instance
+      #
+      def initialize(command, flags, options={})
+        @command = Command.command_to_show(command)
+        @flags   = flags
+      end
+
+      # Options
+      # indent - Indent the line with by indent value. Assumes that the first
+      #          the first line is already filled in with other padding.
+      # length - Line length, otherwise the default terminal width is assumed.
+      def format_usage(options={})
+        synopsis = "#{flags} #{command} <subcommand> [<args>]"
+        indent = options[:indent] || DEFAULT_INDENT
+        padding = sprintf("%#{indent}s",'')
+        length  = options[:length] || Terminal.default_width
+        wrap synopsis, length, indent, padding
+      end
+
+      def tokenize_text(text)
+        text.split(/\s+/).map(&:chomp).reject(&:empty?)
+      end
+
+      # Wraps text at the given line length using given indent value.
+      #
+      def wrap(text, length, indent=0, padding=0)
+        if text.length > length - indent
+          paragraphs = []
+          line = ''
+          tokenize_text(text).each do |fragment|
+            if line.length < length - indent
+              line << fragment + ' '
+            else
+              paragraphs << line
+              line = padding + fragment + ' '
+            end
+          end
+          paragraphs << line
+          text = paragraphs.join("\n")
+        end
+        text
+      end
+
+      # Returns a concise string representation of Usage instance
+      #
+      def inspect
+        "#<#{self.class.inspect} @command=#{command.inspect} @flags=#{flags.inspect}"
+      end
+
+    end # Usage
+  end # Command
+end # GithubCLI

data/lib/github_cli/command.rb

@@ -29,9 +29,15 @@ module GithubCLI
       }
     end
 
-    map "ls" => :list,
-        "all" => :list,
-        "del" => :delete
+    ALIASES = {
+      "ls"  => :list,
+      "all" => :list,
+      "del" => :delete,
+      "rm"  => :delete,
+      "c"   => :create,
+      "e"   => :edit
+    }
+    map ALIASES
 
     class_option :params, :type => :hash, :default => {}, :aliases => '-p',
                  :desc => 'Request parameters e.i per_page:100'
@@ -74,6 +80,8 @@ module GithubCLI
         klass.namespace.split(':').last
       end
 
+      # Decide whether to show specific command or placeholder
+      #
       def command_to_show(command)
         command_token = Command.all.find do |cmd|
           end_index = command.index('<').nil? ? -1 : command.index('<')

data/lib/github_cli/commands/authorizations.rb

@@ -6,29 +6,31 @@ module GithubCLI
     namespace :auth
 
     desc 'list', 'Lists your authorizations'
-    method_option :params, :type => :hash, :default => {},
-                  :desc => 'Additional request parameters e.i per_page:100'
+    long_desc <<-DESC
+      You can only list your own tokens, and only through Basic Authentication.
+    DESC
     def list
       Authorization.all options[:params], options[:formats]
     end
 
     desc 'get <id>', 'Get a single authorization'
-    method_option :params, :type => :hash, :default => {},
-                  :desc => 'Additional request parameters e.i per_page:100'
+    long_desc <<-DESC
+      You can only access your own token, and only through Basic Authentication.
+    DESC
     def get(id)
       Authorization.get id, options[:params], options[:format]
     end
 
-    desc 'create <user> <repo>', 'Create a new authorization'
+    desc 'create', 'Create a new authorization'
     long_desc <<-DESC
+      You can only create your own token, and only through Basic Authentication.\n
+
       Inputs
 
       scopes - Optional array - A list of scopes that this authorization is in.\n
       note - Optional string - A note to remind you what the OAuth token is for.\n
       note_url - Optional string - A URL to remind you what the OAuth token is for.
     DESC
-    method_option :params, :type => :hash, :default => {},
-                  :desc => 'Additonal request parameters e.i per_page:100'
     def create
       Authorization.create options[:params], options[:format]
     end
@@ -48,8 +50,6 @@ module GithubCLI
     end
 
     desc 'delete <id>', 'Delete an authorization'
-    method_option :params, :type => :hash, :default => {},
-                  :desc => 'Additonal request parameters e.i per_page:100'
     def delete(id)
       Authorization.delete id, options[:params], options[:format]
     end

data/lib/github_cli/commands/emails.rb

@@ -10,7 +10,7 @@ module GithubCLI
       Email.all options[:params], options[:format]
     end
 
-    desc 'add <email(s)>', 'Add email address(es) for the authenticated user'
+    desc 'add <email(s)>...', 'Add email address(es) for the authenticated user'
     long_desc <<-DESC
       You can include a single email address or an array of addresses
     DESC
@@ -18,7 +18,7 @@ module GithubCLI
       Email.add emails, options[:params], options[:format]
     end
 
-    desc 'delete <email(s)>', 'Delete email address(es) for the authenticated user'
+    desc 'delete <email(s)>...', 'Delete email address(es) for the authenticated user'
     long_desc <<-DESC
       You can include a single email address or an array of addresses
     DESC

data/lib/github_cli/commands/repositories.rb

@@ -4,8 +4,9 @@ module GithubCLI
   class Commands::Repositories < Command
 
     namespace :repo
+    # TODO: format_type options[:format]
 
-    desc 'list', 'Lists all repositories'
+    desc 'list', 'Lists all repositories for the authenticated user'
     method_option :org, :type => :string, :aliases => ["-o"],
                   :desc => 'List repositories for <organization>',
                   :banner => '<organization>'
@@ -26,13 +27,12 @@ module GithubCLI
       Repository.get user, repo, options[:params], options[:format]
     end
 
-    desc 'create', 'Create a new repository for the authenticated user.'
+    desc 'create [<org>/]<name>', 'Create a new repository <name> for the authenticated user.'
     long_desc <<-DESC
       Create a new repository for the autheticated user.
 
       Parameters
 
-        name - Required string \n
         description - Optional string \n
         homepage - Optional string \n
         private - Optional boolean - true to create a private repository, false to create a public one \n
@@ -45,10 +45,11 @@ module GithubCLI
     method_option :org, :type => :string, :aliases => ["-o"],
                   :desc => 'Create repository in <organization>',
                   :banner => '<organization>'
-    def create
-      if options[:org]
-        options[:params]['org'] = options[:org]
-      end
+    def create(args)
+      org, options[:params]['name'] = Arguments.new(args).parse
+      options[:params]['org'] = org if org
+      options[:params]['org'] = options[:org] if options[:org]
+
       Repository.create options[:params], options[:format]
     end
 

data/lib/github_cli/config.rb

@@ -2,10 +2,13 @@
 
 module GithubCLI
   class Config
-    COMMAND_KEY = 'commands'
+
+    COMMAND_KEY  = 'commands'
     COMMAND_HELP = 'help'
 
-    def initialize(root)
+    attr_reader :root
+
+    def initialize(root, options={})
       @root = root
       @local_config  = local_options_file
       @global_config = global_options_file
@@ -69,7 +72,7 @@ module GithubCLI
   private
 
     def local_options_file
-      Pathname.new "#{@root}/.githubrc"
+      Pathname.new "#{root}/.githubrc"
     end
 
     def global_options_file
@@ -90,5 +93,9 @@ module GithubCLI
       value
     end
 
+    def inspect
+      "#{self.class.inspect} @root=#{root}"
+    end
+
   end # Config
 end # GithubCLI

data/lib/github_cli/dsl.rb

@@ -17,5 +17,12 @@ module GithubCLI
     def on_error(&block)
       @@error_block = block
     end
+
+    def before(&block)
+    end
+
+    def configure(&block)
+    end
+
   end
 end

data/lib/github_cli/errors.rb

@@ -12,6 +12,10 @@ module GithubCLI
     status_code 5
   end
 
+  class RequiredArgumentMissingError < GithubCLIError
+    status_code 6
+  end
+
   # Raised when a configuration file is corrupt or missing.
   class ConfigFileNotFound < GithubCLIError
     status_code 10

data/lib/github_cli/terminal.rb

@@ -3,6 +3,7 @@
 module GithubCLI
   # Responsible for display and size detection.
   class Terminal
+
     DEFAULT_WIDTH  = 80
     DEFAULT_HEIGHT = 40
 
@@ -38,25 +39,13 @@ module GithubCLI
         @pager ||= Pager.new
       end
 
-      def print_commands(pattern=nil)
-        Terminal.line "\n" + GithubCLI.program_name + "\n"
-        Terminal.newline
-        GithubCLI.ui.info "Commands:"
-
-        commands = Command.all.select do |cmd|
+      def find_commands(pattern=nil)
+        Command.all.select do |cmd|
           cmd if pattern && cmd.namespace =~ pattern
-        end.map do |cmd|
-          build_command cmd
-        end
-
-        if !commands.empty?
-          GithubCLI.ui.print_table commands, :truncate => true
-        else
-          print_command_not_found pattern.to_s.gsub(/\W|/, '')[3..-1]
         end
       end
 
-      def build_command(cmd, indent=3)
+      def build_command_output(cmd, indent=3)
         prefix = " " * indent
         if cmd.namespace.empty?
           ["#{prefix + cmd.usage}", cmd.desc]
@@ -65,6 +54,19 @@ module GithubCLI
         end
       end
 
+      def print_commands(pattern=nil)
+        Terminal.line "\n" + GithubCLI.program_name + "\n\n"
+
+        commands = find_commands(pattern).map { |cmd| build_command_output cmd }
+
+        if !commands.empty?
+          GithubCLI.ui.info "Commands:"
+          GithubCLI.ui.print_table commands, :truncate => true
+        else
+          print_command_not_found pattern.to_s.gsub(/\W|/, '')[3..-1]
+        end
+      end
+
       def print_command_not_found(cmd)
         GithubCLI.ui.info "ghc: '#{cmd}' is not a ghc command. See 'ghc --help'."
       end
@@ -74,42 +76,11 @@ module GithubCLI
 
 #{GithubCLI.program_name}
 
-Usage: ghc #{format_usage(flags, command, :indent => 11)}
+Usage: ghc #{GithubCLI::Command::Usage.new(command, flags).format_usage }
 
         TEXT
       end
 
-      # Options
-      # indent - Indent the line with by indent value. Assumes that the first
-      #          the first line is already filled in with other padding.
-      # length - Line length, otherwise the default terminal width is assumed.
-      def format_usage(flags, command, options={})
-        synopsis = "#{flags} #{command} <subcommand> [<args>]"
-        indent = options[:indent] || 0
-        padding = sprintf("%#{indent}s",'')
-        length  = options[:length] || default_width
-        wrap synopsis, length, indent, padding
-      end
-
-      # Wraps text at the given line length using given indent value.
-      def wrap(text, length, indent=0, padding=0)
-        if text.length > length - indent
-          paragraphs = []
-          line = ''
-          text.split(/\s+/).map(&:chomp).reject(&:empty?).each do |fragment|
-            if line.length < length - indent
-              line << fragment + ' '
-            else
-              paragraphs << line
-              line = padding + fragment + ' '
-            end
-          end
-          paragraphs << line
-          text = paragraphs.join("\n")
-        end
-        text
-      end
-
     end
 
   end # Terminal

data/lib/github_cli/thor_ext.rb

@@ -1,3 +1,4 @@
+require 'github_cli'
 require 'thor'
 
 class Thor
@@ -12,7 +13,7 @@ class Thor
       end
       list.sort!{ |a,b| a[0] <=> b[0] }
 
-      GithubCLI::Terminal.print_usage global_flags, GithubCLI::Command.command_to_show(list[0][0])
+      GithubCLI::Terminal.print_usage global_flags, list[0][0]
 
       shell.say "Commands:"
       shell.print_table(list, :indent => 2, :truncate => true)
@@ -39,6 +40,15 @@ class Thor
         def help(task = nil, subcommand = true); super; end
       RUBY
     end
+
+    def handle_no_task_error(cmd, has_namespace = $thor_runner) #:nodoc:
+      possibilities = "#{GithubCLI::Command::Completion.new(cmd).format_command_possibilities}"
+      if has_namespace
+        raise UndefinedTaskError, "Could not find task #{cmd.inspect} in #{namespace.inspect} namespace. " + possibilities
+      else
+        raise UndefinedTaskError, "Could not find command #{cmd.inspect}. " + possibilities
+      end
+    end
   end
 
   desc "help <command>", "Describe available commands or one specific command"

data/lib/github_cli/util.rb

@@ -4,6 +4,8 @@ module GithubCLI
   module Util
     extend self
 
+    # Converts deeply nested hash into only one level structure
+    #
     def flatten_hash(prefix=nil, hash)
       new_hash ||= {}
       hash.each do |key, val|
@@ -26,6 +28,8 @@ module GithubCLI
       end
     end
 
+    # Attempts to convert value object to string
+    #
     def convert_value(value)
       case value
       when true  then "true"
@@ -38,6 +42,7 @@ module GithubCLI
 
     # Shortens string
     # :trailing - trailing character in place of cutout string
+    #
     def truncate(string, width, options={})
       trailing = options[:trailing] || '…'
 
@@ -52,6 +57,7 @@ module GithubCLI
     # Pads a string
     # padder - padding character
     # align  - align :left, :right, :center
+    #
     def pad(string, width, options={})
       supported = [:left, :right, :center]
       padder = options[:padder] || ' '
@@ -74,5 +80,11 @@ module GithubCLI
       end
       string
     end
+
+    # Compares two strings to find common prefix
+    #
+    def longest_common_prefix(string_1, string_2)
+      ("#{string_1}\0#{string_2}").match(/^(.*).*\0\1/i).to_a[1]
+    end
   end
 end # GithubCLI

data/lib/github_cli/version.rb

@@ -1,3 +1,3 @@
 module GithubCLI
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

data/lib/github_cli.rb

@@ -9,6 +9,7 @@ require 'github_cli/thor_ext'
 require 'github_cli/version'
 require 'github_cli/errors'
 
+# Base module which adds Github API to the command line
 module GithubCLI
   autoload :DSL,       'github_cli/dsl'
   autoload :Config,    'github_cli/config'
@@ -26,10 +27,13 @@ module GithubCLI
   autoload :Util,      'github_cli/util'
 
   require 'github_cli/apis'
+  require 'github_cli/command/completion'
+  require 'github_cli/command/usage'
+  require 'github_cli/command/arguments'
 
   extend DSL
 
-  program_name 'Github CLI client'
+  program_name 'GitHub API v3 CLI client'
 
   class << self
     attr_writer :ui, :config

data/spec/github_cli/pager_spec.rb

@@ -3,13 +3,8 @@ require 'spec_helper'
 describe GithubCLI::Pager do
 
   context '#pager_command' do
-    it 'chooses default pagers if none present' do
-      GithubCLI::System.stub(:command?) { true }
-      described_class.pager_command.to_s.should =~ /less/
-    end
-
     it 'permits custom commands' do
-      cmd = 'mine'
+      cmd = 'more'
       GithubCLI::System.stub(:command?) { true }
       described_class.pager_command(cmd).should == cmd
     end

data/spec/github_cli/util_spec.rb

@@ -44,4 +44,16 @@ describe GithubCLI::Util do
       subject.convert_value(values).should eq(["123", "baz", "2.3"])
     end
   end
+
+  describe '#longest_common_prefix' do
+    it 'finds common prefix' do
+      a = 'tribe'; b = 'tree'
+      subject.longest_common_prefix(a,b).should == "tr"
+    end
+
+    it 'fails to find common prefix' do
+      a = 'foo'; b = 'bar'
+      subject.longest_common_prefix(a,b).should be_empty
+    end
+  end
 end # GithubCLI::Util

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github_cli
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-28 00:00:00.000000000Z
+date: 2012-07-12 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api
-  requirement: &2156342420 !ruby/object:Gem::Requirement
+  requirement: &2153403460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '0.6'
   type: :runtime
   prerelease: false
-  version_requirements: *2156342420
+  version_requirements: *2153403460
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &2156342000 !ruby/object:Gem::Requirement
+  requirement: &2153403000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156342000
+  version_requirements: *2153403000
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156341520 !ruby/object:Gem::Requirement
+  requirement: &2153402520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156341520
+  version_requirements: *2153402520
 - !ruby/object:Gem::Dependency
   name: aruba
-  requirement: &2156341020 !ruby/object:Gem::Requirement
+  requirement: &2153401860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156341020
+  version_requirements: *2153401860
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2156340580 !ruby/object:Gem::Requirement
+  requirement: &2153401360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156340580
+  version_requirements: *2153401360
 description: CLI-based access to GitHub API v3
 email:
-- pmurach@gmail.com
+- ''
 executables:
 - ghc
 extensions: []
@@ -88,6 +88,7 @@ files:
 - features/blob.feature
 - features/collaborator.feature
 - features/commit.feature
+- features/completion.feature
 - features/content.feature
 - features/download.feature
 - features/email.feature
@@ -113,9 +114,9 @@ files:
 - features/tag.feature
 - features/team.feature
 - features/tree.feature
+- features/usage.feature
 - features/user.feature
 - features/watching.feature
-- fixtures/.githubrc
 - fixtures/simple_config
 - ghc_logo.png
 - github_cli.gemspec
@@ -151,6 +152,9 @@ files:
 - lib/github_cli/apis/watching.rb
 - lib/github_cli/cli.rb
 - lib/github_cli/command.rb
+- lib/github_cli/command/arguments.rb
+- lib/github_cli/command/completion.rb
+- lib/github_cli/command/usage.rb
 - lib/github_cli/commands.rb
 - lib/github_cli/commands/authorizations.rb
 - lib/github_cli/commands/blobs.rb
@@ -233,6 +237,7 @@ test_files:
 - features/blob.feature
 - features/collaborator.feature
 - features/commit.feature
+- features/completion.feature
 - features/content.feature
 - features/download.feature
 - features/email.feature
@@ -258,6 +263,7 @@ test_files:
 - features/tag.feature
 - features/team.feature
 - features/tree.feature
+- features/usage.feature
 - features/user.feature
 - features/watching.feature
 - spec/github_cli/api_spec.rb

data/fixtures/.githubrc

@@ -1,9 +0,0 @@
----
-oauth_token: ad7f9asdf97as98df7as9fd7
-basic_auth: 'login:password'
-host:
-user:
-repo:
-commands:
-  issue-list: { inputs: 'ticket' }
-  issue-get: {}