github_cli 0.4.4 → 0.5.0

data/.gitignore

@@ -7,3 +7,4 @@ pkg
 *.swp
 log
 *.sqlite3
+lib/github_cli/man

data/.travis.yml

@@ -3,11 +3,9 @@ before_install:
 matrix:
   allow_failures:
     - rvm: ruby-head
-    - rvm: rbx-19mode
 rvm:
   - 1.9.2
   - 1.9.3
-  - rbx-19mode
   - ruby-head
 branches:
   only: master

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+0.5.0 (August 17, 2012) - IMPORTANT!!!
+
+* Change editor settings to seek first local config before system properties.
+* Change config key format and add config file location setup.
+* Change init command to allow for local and global config files.
+* Add new default configuration options to .githubrc file.
+* Fix bug with setting config file options.
+* Add pretty printing of config entries with pattern matching.
+* Add config command for setting, unsetting and listing of options with tests.
+* Change executable command name from *ghc* to *gcli*
+* Add manpages for gcli executable and config command.
+* Setup automatic manpage trigger on help command.
+* Add raketask for vendoring gems and vendor thor.
+
 0.4.4 (July 15, 2012)
 
 * Fix bug with tree retrieval and add feature tests.

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    github_cli (0.4.4)
+    github_cli (0.5.0)
       github_api (~> 0.6)
-      thor
 
 GEM
   remote: https://rubygems.org/
@@ -37,10 +36,12 @@ GEM
       nokogiri (~> 1.5.2)
       oauth2
     hashie (1.2.0)
+    hpricot (0.8.6)
     httpauth (0.1)
     json (1.7.3)
     multi_json (1.3.6)
     multipart-post (1.1.5)
+    mustache (0.99.4)
     nokogiri (1.5.3)
     oauth2 (0.7.1)
       faraday (~> 0.8)
@@ -51,6 +52,11 @@ GEM
     rack-protection (1.2.0)
       rack
     rake (0.9.2.2)
+    rdiscount (1.6.8)
+    ronn (0.7.3)
+      hpricot (>= 0.8.2)
+      mustache (>= 0.7.0)
+      rdiscount (>= 1.5.8)
     rspec (2.10.0)
       rspec-core (~> 2.10.0)
       rspec-expectations (~> 2.10.0)
@@ -63,7 +69,6 @@ GEM
       rack (~> 1.3, >= 1.3.6)
       rack-protection (~> 1.2)
       tilt (~> 1.3, >= 1.3.3)
-    thor (0.15.2)
     tilt (1.3.3)
 
 PLATFORMS
@@ -74,4 +79,5 @@ DEPENDENCIES
   communist
   github_cli!
   rake
+  ronn
   rspec

data/README.md

@@ -26,41 +26,61 @@ Or install it yourself as:
 Run it:
 
 ```shell
-$ ghc
+$ gcli
 ```
 
 ### Initialize a configuration file
 
-The first step is to create a configuration file:
+The first step is to create a configuration file, either global in home directory or local inside the project:
 
 ```shell
-$ ghc init
+$ gcli init [--global|--local]
 ```
 
-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`.
+This will setup a `.githubrc` configuration file in your home/project directory
+with all the global settings. During the install process you will be prompted
+for your `authentication token`.
+
+Moreover, `gcli config` command allows you to set/get any configuration option such as output format, editor or oauth token.
+
+For instance, to check value for your `token` do
+
+```shell
+$ gcli config [--global|--local] auth.token
+```
+
+and to set the value do
+
+```shell
+$ gcli config [--global|--local] auth.token lh23l4kj234....
+```
+
+To list specific options
+
+```shell
+$ gcli config [--global|--local] --list [regex]
+```
 
 ### Arguments
 
-The required arguments come first as per command description, then follow the optional arguments inside a `params` flag.
+The required arguments come first as per command description, then are followed by the optional arguments supplied inside a `params` flag.
 
-You can create repository by supplying parameters in the following way:
+For instance, one can create repository by supplying parameters in the following way:
 
 ```shell
-ghc repo create octokit --params=description:'Test repo for kitty.'
+$ gcli 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.'
+$ gcli repo create github/octokit --params=description:'Test repo for kitty.'
 ```
 
-To find out which options are required and optional type:
+To find out which options are required and which are optional - type:
 
 ```shell
-ghc repo help create
+$ gcli repo help create
 ```
 
 ### Getting a list of commands
@@ -68,13 +88,13 @@ ghc repo help create
 You can list all GitHub APIs comamnds:
 
 ```shell
-$ ghc list
+$ gcli list
 ```
 
 to limit returned results pass `pattern`
 
 ```shell
-$ ghc list re*   # Returns all commands matching the pattern
+$ gcli list re*   # Returns all commands matching the pattern
 ```
 
 ### Output Format
@@ -84,19 +104,19 @@ 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
+gcli 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… ┃
-┗━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻
+┏━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳
+┃ type     ┃ login    ┃ public_… ┃ blog     ┃ hireable ┃ followe… ┃ followi… ┃ location ┃ html_url ┃
+┣━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋━━━━━━━━━━╋
+┃ User     ┃ peter-m… ┃ 14       ┃ peter-m… ┃ false    ┃ 18       ┃ 52       ┃ Sheffie… ┃ https:/… ┃
+┗━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻━━━━━━━━━━┻
 ```
 
 To get `csv` formatting for easy command piping do
 
 ```shell
-ghc repo ls -u wycats --format=csv
+gcli repo ls -u wycats --format=csv
 ```
 
 ### Output Paging
@@ -104,7 +124,7 @@ ghc repo ls -u wycats --format=csv
 By default all responses are paged. You can switch off paging by supplying `no-pager` flag.
 
 ```shell
-ghc --no-pager user ls -u wycats
+gcli --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".
@@ -114,67 +134,67 @@ Also you can supply you preferred `pager`, otherwise the paging program is taken
 Interact with git data:
 
 ```shell
-$ ghc blob
-$ ghc commit
-$ ghc ref
-$ ghc tag
-$ ghc tree
+$ gcli blob
+$ gcli commit
+$ gcli ref
+$ gcli tag
+$ gcli tree
 ```
 
 Interact with issues:
 
 ```shell
-$ ghc issue
-$ ghc label
-$ ghc milestone
-$ ghc comment
+$ gcli issue
+$ gcli label
+$ gcli milestone
+$ gcli comment
 ```
 
 Interact with repositories:
 
 ```shell
-$ ghc repo
-$ ghc collab
-$ ghc content
-$ ghc download
-$ ghc fork
-$ ghc hook
-$ ghc key
-$ ghc watching
+$ gcli repo
+$ gcli collab
+$ gcli content
+$ gcli download
+$ gcli fork
+$ gcli hook
+$ gcli key
+$ gcli watching
 ```
 
 Interact with gists:
 
 ```shell
-$ ghc gist
+$ gcli gist
 ```
 
 Interact with users:
 
 ```shell
-$ ghc user
-$ ghc email
-$ ghc follower
+$ gcli user
+$ gcli email
+$ gcli follower
 ```
 
 Interact with organizations:
 
 ```shell
-$ ghc org
-$ ghc member
-$ ghc team
+$ gcli org
+$ gcli member
+$ gcli team
 ```
 
 Interact with authorizations:
 
 ```shell
-$ ghc auth
+$ gcli auth
 ```
 
 Interact with search:
 
 ```shell
-$ ghc search
+$ gcli search
 ```
 
 ## Contributing

data/Rakefile

@@ -1,4 +1,5 @@
-#!/usr/bin/env rake
+# -*- encoding: utf-8 -*-
+$:.unshift File.expand_path('../lib', __FILE__)
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "cucumber/rake/task"
@@ -10,3 +11,48 @@ end
 Cucumber::Rake::Task.new(:features)
 
 task :default => [:spec, :features]
+
+task :release => ["man:clean", "man:build"]
+
+begin
+  require 'ronn'
+
+  namespace :man do
+
+    directory "lib/github_cli/man"
+
+    FileList["man/*.ronn"].each do |ronn|
+      basename = File.basename(ronn, ".ronn")
+      roff = "lib/github_cli/man/#{basename}"
+
+      file roff => ["lib/github_cli/man", ronn] do
+        sh "#{Gem.ruby} -S ronn --roff --pipe #{ronn} > #{roff}"
+      end
+
+      file "#{roff}.txt" => roff do
+        sh "groff -Wall -mtty-char -mandoc -Tascii #{roff} | col -b > #{roff}.txt"
+      end
+
+      task :build_all_pages => "#{roff}.txt"
+    end
+
+    desc "Build the man pages"
+    task :build => "man:build_all_pages"
+
+    desc 'Clean up the buit man pages'
+    task :clean do
+      rm_rf "lib/github_cli/man"
+    end
+  end
+end
+
+namespace :vendor do
+  desc "Build"
+  task :build => :clean do
+    sh "git clone git://github.com/wycats/thor.git lib/github_cli/vendor/thor"
+  end
+
+  task :clean do
+    rm_rf "lib/github_cli/vendor"
+  end
+end

data/bin/gcli

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+lib_dir = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift lib_dir if File.directory?(lib_dir)
+
+require "github_cli"
+begin
+  GithubCLI::CLI.start
+rescue Interrupt => e
+  GithubCLI.ui.error "\nQuitting..."
+  GithubCLI.ui.debug e.backtrace.join("\n")
+  exit 1
+rescue SystemExit => e
+  exit e.status
+rescue Exception => e
+  GithubCLI.ui.error "Fatal error has occurred. " + e.message.to_s
+  GithubCLI.ui.debug e.backtrace.join("\n")
+  exit 1
+end

data/bin/ghc

@@ -1,18 +1,2 @@
 #!/usr/bin/env ruby
-lib_dir = File.expand_path("../../lib", __FILE__)
-$LOAD_PATH.unshift lib_dir if File.directory?(lib_dir)
-
-require "github_cli"
-begin
-  GithubCLI::CLI.start
-rescue Interrupt => e
-  GithubCLI.ui.error "\nQuitting..."
-  GithubCLI.ui.debug e.backtrace.join("\n")
-  exit 1
-rescue SystemExit => e
-  exit e.status
-rescue Exception => e
-  GithubCLI.ui.error "Fatal error has occurred. " + e.message
-  GithubCLI.ui.debug e.backtrace.join("\n")
-  exit 1
-end
+$stdout.print "[DEPRECATED] Please use `gcli` instead."

data/features/blob.feature

@@ -1,18 +1,18 @@
-Feature: ghc blob
+Feature: gcli blob
 
   Scenario: Available commands
 
-    When I run `ghc blob`
+    When I run `gcli blob`
     Then the exit status should be 0
-      And the output should contain "ghc blob get"
-      And the output should contain "ghc blob create"
+      And the output should contain "gcli blob get"
+      And the output should contain "gcli blob create"
 
   Scenario: Get blob
     Given the GitHub API server:
     """
     get('/repos/wycats/thor/git/blobs/59b23de9b91d') { status 200 }
     """
-    When I run `ghc blob get wycats thor 59b23de9b91d`
+    When I run `gcli blob get wycats thor 59b23de9b91d`
     Then the exit status should be 0
 
   Scenario: Create blob
@@ -20,5 +20,5 @@ Feature: ghc blob
     """
     post('/repos/wycats/thor/git/blobs') { status 200 }
     """
-    When I run `ghc blob create wycats thor --params=content:'Content' encoding:'utf-8'`
+    When I run `gcli blob create wycats thor --params=content:'Content' encoding:'utf-8'`
     Then the exit status should be 0

data/features/collaborator.feature

@@ -1,20 +1,20 @@
-Feature: ghc collab
+Feature: gcli collab
 
   Scenario: Available commands
 
-    When I run `ghc collab`
+    When I run `gcli collab`
     Then the exit status should be 0
-      And the output should contain "ghc collab list"
-      And the output should contain "ghc collab add"
-      And the output should contain "ghc collab collab"
-      And the output should contain "ghc collab remove"
+      And the output should contain "gcli collab list"
+      And the output should contain "gcli collab add"
+      And the output should contain "gcli collab collab"
+      And the output should contain "gcli collab remove"
 
   Scenario: List collaborators
     Given the GitHub API server:
     """
     get('/repos/wycats/thor/collaborators') { status 200 }
     """
-    When I run `ghc collab ls wycats thor`
+    When I run `gcli collab ls wycats thor`
     Then the exit status should be 0
 
   Scenario: Add collaborator
@@ -22,7 +22,7 @@ Feature: ghc collab
     """
     put('/repos/wycats/thor/collaborators/octocat') { status 200 }
     """
-    When I run `ghc collab add wycats thor octocat`
+    When I run `gcli collab add wycats thor octocat`
     Then the exit status should be 0
 
   Scenario: Remove collaborator
@@ -30,7 +30,7 @@ Feature: ghc collab
     """
     delete('/repos/wycats/thor/collaborators/octocat') { status 200 }
     """
-    When I run `ghc collab remove wycats thor octocat`
+    When I run `gcli collab remove wycats thor octocat`
     Then the exit status should be 0
 
   Scenario: Check if collaborator
@@ -38,6 +38,6 @@ Feature: ghc collab
     """
     delete('/repos/wycats/thor/collaborators/octocat') { status 200 }
     """
-    When I run `ghc collab collab wycats thor octocat`
+    When I run `gcli collab collab wycats thor octocat`
     Then the exit status should be 0
 

data/features/commit.feature

@@ -1,18 +1,18 @@
-Feature: ghc commit
+Feature: gcli commit
 
   Scenario: Available commands
 
-    When I run `ghc commit`
+    When I run `gcli commit`
     Then the exit status should be 0
-      And the output should contain "ghc commit get"
-      And the output should contain "ghc commit create"
+      And the output should contain "gcli commit get"
+      And the output should contain "gcli commit create"
 
   Scenario: Get commit
     Given the GitHub API server:
     """
     get('/repos/wycats/thor/git/commits/59b23de9b91d') { status 200 }
     """
-    When I run `ghc commit get wycats thor 59b23de9b91d`
+    When I run `gcli commit get wycats thor 59b23de9b91d`
     Then the exit status should be 0
 
   Scenario: Create commit
@@ -20,5 +20,5 @@ Feature: ghc commit
     """
     post('/repos/wycats/thor/git/commits') { status 200 }
     """
-    When I run `ghc commit create wycats thor --params=message:'my commit' tree:827efc parents:['7d1b31e']`
+    When I run `gcli commit create wycats thor --params=message:'my commit' tree:827efc parents:['7d1b31e']`
     Then the exit status should be 0

data/features/completion.feature

@@ -2,7 +2,7 @@ Feature: Command Completion
 
   Scenario: Suggest alternative
 
-    When I run `ghc blah`
+    When I run `gcli blah`
     Then the exit status should be 0
     And the output should contain:
     """
@@ -12,7 +12,7 @@ Feature: Command Completion
 
   Scenario: Suggest more than one
 
-    When I run `ghc convent`
+    When I run `gcli convent`
     Then the exit status should be 0
     And the output should contain:
     """
@@ -24,7 +24,7 @@ Feature: Command Completion
 
   Scenario: Suggset nothing
 
-    When I run `ghc xen`
+    When I run `gcli xen`
     Then the exit status should be 0
     And the output should not contain:
     """

data/features/config.feature

@@ -0,0 +1,55 @@
+Feature: Configuration file
+
+  Scenario: Config requires scope
+    When I run `gcli config`
+    Then the output should contain:
+    """
+    Invalid scope given. Please use --local or --global.
+    """
+
+  Scenario: Missing global file
+    When I run `gcli config --global`
+    Then the output should contain:
+    """
+    global configuration file does not exist. Please use `gcli init --global`
+    """
+
+  Scenario: Missing local file
+    When I run `gcli config --local`
+    Then the output should contain:
+    """
+    local configuration file does not exist. Please use `gcli init --local`
+    """
+
+  Scenario: List global file options
+    Given I run `gcli init --global` interactively
+      And I type "token"
+    When I run `gcli config --global`
+    Then the output should contain:
+    """
+    Configuration options:
+    """
+
+  Scenario: Read existing option
+    Given I run `gcli init --global` interactively
+      And I type "abc123"
+    When I successfully run `gcli config --global auth.token`
+    Then the stdout should contain "abc123"
+
+  Scenario: Read missing option
+    Given I run `gcli init --global` interactively
+      And I type "abc123"
+    When I run `gcli config --global missing.key`
+    Then the exit status should be 0
+
+  Scenario: Write existing option
+    Given I run `gcli init --global` interactively
+      And I type "abc123"
+    When I successfully run `gcli config --global auth.token eee555`
+    Then the stdout should contain "eee555"
+
+  Scenario: Write missing option
+    Given I run `gcli init --global` interactively
+      And I type "abc123"
+    When I successfully run `gcli config --global core.token eee555`
+    Then the stdout should contain "eee555"

data/features/content.feature

@@ -1,19 +1,19 @@
-Feature: ghc content
+Feature: gcli content
 
   Scenario: Available commands
 
-    When I run `ghc content`
+    When I run `gcli content`
     Then the exit status should be 0
-      And the output should contain "ghc content get"
-      And the output should contain "ghc content readme"
-      And the output should contain "ghc content archive"
+      And the output should contain "gcli content get"
+      And the output should contain "gcli content readme"
+      And the output should contain "gcli content archive"
 
   Scenario: Readme
     Given the GitHub API server:
     """
     get('/repos/wycats/thor/readme') { status 200 }
     """
-    When I run `ghc content readme wycats thor`
+    When I run `gcli content readme wycats thor`
     Then the exit status should be 0
 
   Scenario: Get content
@@ -21,7 +21,7 @@ Feature: ghc content
     """
     get('/repos/wycats/thor/contents/lib') { status 200 }
     """
-    When I run `ghc content get wycats thor lib`
+    When I run `gcli content get wycats thor lib`
     Then the exit status should be 0
 
   Scenario: Archive
@@ -29,7 +29,7 @@ Feature: ghc content
     """
     get('/repos/wycats/thor/zipball/master') { status 200 }
     """
-    When I run `ghc content archive wycats thor`
+    When I run `gcli content archive wycats thor`
     Then the exit status should be 0
 
   Scenario: Archive with params
@@ -37,5 +37,5 @@ Feature: ghc content
     """
     get('/repos/wycats/thor/tarball/new_feature') { status 200 }
     """
-    When I run `ghc content archive wycats thor --params=archive_format:tarball ref:new_feature`
+    When I run `gcli content archive wycats thor --params=archive_format:tarball ref:new_feature`
     Then the exit status should be 0