github_cli 0.4.4 → 0.5.0

data/lib/github_cli/config.rb

@@ -4,10 +4,15 @@ module GithubCLI
   class Config
 
     COMMAND_KEY  = 'commands'
+
     COMMAND_HELP = 'help'
 
+    # Contains information of where the command is run from.
     attr_reader :root
 
+    # Location scope of currently used configuration file.
+    attr_reader :location
+
     def initialize(root, options={})
       @root = root
       @local_config  = local_options_file
@@ -20,15 +25,15 @@ module GithubCLI
     end
 
     def [](key)
-      data[key] || data[COMMAND_KEY][key] rescue nil
+      data[key] || data["#{COMMAND_KEY}.#{key}"] rescue nil
     end
 
     def fetch(key, default=nil)
-      data[key] || default || raise(IndexError.new("key #{key} not found"))
+      self[key] || default || raise(IndexError.new("key #{key} not found"))
     end
 
     def delete(key)
-      @data.delete(key)
+      data.delete(key)
     end
 
     def data
@@ -39,11 +44,27 @@ module GithubCLI
       data.keys
     end
 
+    def all
+      data
+    end
+
+    def pretty(pattern="")
+      all.keys.zip(all.values).map do |el|
+        el.last.nil? ? [el.first, 'UNDEFINED'] : el
+      end.select { |el| el.first =~ /^#{pattern}.*$/i }
+    end
+
+    def location=(loc)
+      @location = loc
+      @data = nil
+    end
+
     def save(config)
-      config[COMMAND_KEY] = {}
       Command.all.each do |cmd|
-        if !cmd.namespace.empty? && cmd.name != COMMAND_HELP
-          config[COMMAND_KEY]["#{cmd.namespace}-#{cmd.name}"] = { }
+        composite_key = "#{COMMAND_KEY}.#{cmd.namespace}.#{cmd.name}"
+        if !cmd.namespace.empty? && cmd.name != COMMAND_HELP &&
+           !config.has_key?(composite_key)
+          config[composite_key]= {}
         end
       end
       File.open(path, 'w', 0600) do |file|
@@ -62,7 +83,7 @@ module GithubCLI
     end
 
     def path
-      if File.exists?(local_options_file)
+      if location == 'local' || File.exists?(local_options_file)
         local_options_file
       else
         global_options_file
@@ -80,7 +101,7 @@ module GithubCLI
         Pathname.new File.join(Thor::Util.user_home, ".githubrc")
       rescue ArgumentError
         GithubCLI.ui.warn "Unable to find ~/.githubrc because the HOME environment variable is not set"
-        nil
+        exit 1
       end
     end
 
@@ -88,7 +109,7 @@ module GithubCLI
       unless data[key] == value
         data[key] = value
         data.delete(key) if value.nil?
-        save data.to_yaml
+        save data
       end
       value
     end

data/lib/github_cli/editor.rb

@@ -4,22 +4,27 @@ module GithubCLI
   # This class determines editor to use to open the output.
   class Editor
 
-    def initialize(options={})
+    attr_accessor :filename
+
+    def initialize(filename, options={})
+      @filename = filename
     end
 
     def editor
-      editors = [ ENV['GHC_EDITOR'], ENV['VISUAL'], ENV['EDITOR'], 'vi' ]
-      editor = GithubCLI.config['editor']
-      editor ||= editors.find { |e| !e.nil? && !e.empty? }
+      editors = [ ENV['GCLI_EDITOR'], ENV['VISUAL'], ENV['EDITOR'], 'vi' ]
+      editors.unshift(GithubCLI.config['core.editor'])
+      editors.compact.uniq.find { |editor| System.command? editor }
     end
 
-    def open(name)
+    def open(name=nil)
       if editor
-        command = "#{editor} #{name}"
+        command = "#{editor} #{filename}"
         success = system(command)
         GithubCLI.ui.info "Could not run '#{command}'" unless success
+        exit success
       else
         GithubCLI.info("To open output, set $EDITOR or $VISUL")
+        exit 1
       end
     end
 

data/lib/github_cli/man/gcli-config.1

@@ -0,0 +1,102 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "GCLI\-CONFIG" "1" "July 2012" "" ""
+.
+.SH "NAME"
+\fBgcli\-config\fR \- Get or set global or local configuration options
+.
+.SH "SYNOPSIS"
+\fBgcli config\fR \-\-global|\-\-local name [value]
+.
+.br
+\fBgcli config\fR \-\-global|\-\-local \fB\-l | \-list\fR [name_regex]
+.
+.br
+\fBgcli config\fR \-\-global|\-\-local \fB\-e | \-\-edit\fR
+.
+.SH "DESCRIPTION"
+You can query/set options with this command\. The name is actually a hash key string that is a composite one, nested with dots\. If only name is provided, a value will be retrieved\. If two parameters are given then value will be set or updated depending whether it already exists or not\.\en
+.
+.P
+There two types of config files, global and project specific\. When modifying options ensure that you modifying the correct config\.
+.
+.P
+This command line will fail (with the exit code ret) if:
+.
+.IP "1." 4
+The config file is invalid\.
+.
+.IP "" 0
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-\-global\fR
+Writes configuration settings to global ~/\.githubrc file inside user home directory\.
+.
+.TP
+\fB\-\-local\fR
+Writes cofinguration settings inside the current directory to the \.githubrc file\.
+.
+.TP
+\fB\-l, \-\-list\fR
+List all variables set in config file\.
+.
+.TP
+\fB\-e, \-\-edit\fR
+Opens an editor to modify the specified config file\.
+.
+.IP
+Defaults to \fBvi\fR editor if non specified\. It first looks inside \-\-global or \-\-local config, then searches environement variables \fBEDITOR\fR and \fBVISUAL\fR before assuming default\.
+.
+.SH "CONFIGURATION FILE"
+The \fBgcli\fR configuration file contains a number of variables that affect the way the GitHub API is quried\.
+.
+.SS "SYNTAX"
+The configuration file is written in \fByaml\fR\. Therfore all formatting rules are derived from yaml specification\.
+.
+.SS "VARIABLES"
+.
+.TP
+\fBauth\.token\fR
+Authentication token\.
+.
+.TP
+\fBauth\.basic\fR
+Basic credentials in the form \fBlogin:password\fR\.
+.
+.TP
+\fBcore\.endpoint\fR
+Sets host path used as the base for all requests to GitHub API v3\.
+.
+.TP
+\fBcore\.editor\fR
+Sets the editor to be used when opening files\. By default \fBvi\fR is specified\.
+.
+.TP
+\fBcore\.pager\fR
+The command that will be used to paginate output\. Can be overridden with PAGER environment variable\. less
+.
+.TP
+\fBcore\.no\-pager\fR
+false
+.
+.TP
+\fBcore\.no\-color\fR
+If set to true disables color output\. By default is set to false\.
+.
+.TP
+\fBcore\.format\fR
+Determines output formatting\. Defaults to table output\.
+.
+.TP
+\fBcore\.auto\fR
+Automatic pagination of requests to GitHub\.
+.
+.TP
+\fBcore\.aliases\fR
+Global aliases used by commands\.
+.
+.SH "AUTHOR"
+Piotr Murach

data/lib/github_cli/man/gcli-config.1.txt

@@ -0,0 +1,96 @@
+GCLI-CONFIG(1)							GCLI-CONFIG(1)
+
+
+
+NAME
+       gcli-config - Get or set global or local configuration options
+
+SYNOPSIS
+       gcli config --global|--local name [value]
+       gcli config --global|--local -l | -list [name_regex]
+       gcli config --global|--local -e | --edit
+
+DESCRIPTION
+       You  can  query/set  options  with this command. The name is actually a
+       hash key string that is a composite one, nested with dots. If only name
+       is  provided,  a  value	will be retrieved. If two parameters are given
+       then value will be set or updated depending whether it  already	exists
+       or not.\n
+
+       There two types of config files, global and project specific. When mod-
+       ifying options ensure that you modifying the correct config.
+
+       This command line will fail (with the exit code ret) if:
+
+       1.  The config file is invalid.
+
+
+
+OPTIONS
+       --global
+	      Writes configuration settings to global ~/.githubrc file	inside
+	      user home directory.
+
+       --local
+	      Writes  cofinguration  settings  inside the current directory to
+	      the .githubrc file.
+
+       -l, --list
+	      List all variables set in config file.
+
+       -e, --edit
+	      Opens an editor to modify the specified config file.
+
+	      Defaults to vi editor if non specified. It  first  looks	inside
+	      --global or --local config, then searches environement variables
+	      EDITOR and VISUAL before assuming default.
+
+CONFIGURATION FILE
+       The gcli configuration file contains a number of variables that	affect
+       the way the GitHub API is quried.
+
+   SYNTAX
+       The  configuration  file  is  written  in yaml. Therfore all formatting
+       rules are derived from yaml specification.
+
+   VARIABLES
+       auth.token
+	      Authentication token.
+
+       auth.basic
+	      Basic credentials in the form login:password.
+
+       core.endpoint
+	      Sets host path used as the base for all requests to  GitHub  API
+	      v3.
+
+       core.editor
+	      Sets  the editor to be used when opening files. By default vi is
+	      specified.
+
+       core.pager
+	      The command that will be used to paginate output. Can  be  over-
+	      ridden with PAGER environment variable. less
+
+       core.no-pager
+	      false
+
+       core.no-color
+	      If  set  to  true  disables  color  output. By default is set to
+	      false.
+
+       core.format
+	      Determines output formatting. Defaults to table output.
+
+       core.auto
+	      Automatic pagination of requests to GitHub.
+
+       core.aliases
+	      Global aliases used by commands.
+
+AUTHOR
+       Piotr Murach
+
+
+
+				   July 2012			GCLI-CONFIG(1)

data/lib/github_cli/man/gcli-repo.1

@@ -0,0 +1,16 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "GCLI\-REPO" "1" "July 2012" "" ""
+.
+.SH "NAME"
+\fBgcli\-repo\fR \- Manage repository data
+.
+.SH "SYNOPSIS"
+\fBgcli repo\fR \fBbranches\fR user repo
+.
+.br
+\fBgcli repo\fR \fBcontribs|contributors\fR user repo
+.
+.br
+

data/lib/github_cli/man/gcli-repo.1.txt

@@ -0,0 +1,15 @@
+GCLI-REPO(1)							  GCLI-REPO(1)
+
+
+
+NAME
+       gcli-repo - Manage repository data
+
+SYNOPSIS
+       gcli repo branches user repo
+       gcli repo contribs|contributors user repo
+
+
+
+
+				   July 2012			  GCLI-REPO(1)

data/lib/github_cli/man/gcli.1

@@ -0,0 +1,34 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "GCLI" "1" "July 2012" "" ""
+.
+.SH "NAME"
+\fBgcli\fR \- Command Line Access to GitHub API v3
+.
+.SH "SYNOPSIS"
+\fBgcli\fR COMMAND SUBCOMMAND [\fIargs\fR]
+.
+.SH "DESCRIPTION"
+The \fBgcli\fR utility integrates command line with GitHub API v3\.
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-\-token\fR
+Authentication token\.
+.
+.TP
+\fB\-\-no\-color\fR
+Prints output without color\.
+.
+.TP
+\fB\-\-pager\fR
+Sets command to be used for paging results\. This option can be also set in the configuration file\.
+.
+.TP
+\fB\-\-verbose\fR
+Include
+.
+.SH "AUTHOR"
+Piotr Murach

data/lib/github_cli/man/gcli.1.txt

@@ -0,0 +1,33 @@
+GCLI(1) 							       GCLI(1)
+
+
+
+NAME
+       gcli - Command Line Access to GitHub API v3
+
+SYNOPSIS
+       gcli COMMAND SUBCOMMAND [args]
+
+DESCRIPTION
+       The gcli utility integrates command line with GitHub API v3.
+
+OPTIONS
+       --token
+	      Authentication token.
+
+       --no-color
+	      Prints output without color.
+
+       --pager
+	      Sets  command  to be used for paging results. This option can be
+	      also set in the configuration file.
+
+       --verbose
+	      Include
+
+AUTHOR
+       Piotr Murach
+
+
+
+				   July 2012			       GCLI(1)

data/lib/github_cli/manpage.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+module GithubCLI
+  module Manpage
+    extend self
+
+    MANPAGES = %w[
+      gcli-config.1
+    ]
+
+    def has?(command)
+      yield self if MANPAGES.include? command
+    end
+
+    # The groff command with extra arguments to turn
+    # roff into terminal output
+    def groff
+      "groff -Wall -mtty-char -mandoc -Tascii"
+    end
+
+    # Check if groff is installed on the system
+    def has_groff?
+      System.command? 'groff'
+    end
+
+    # Check if man is installed on the system
+    def has_man?
+      System.command? 'man'
+    end
+
+    def show(command)
+      root = File.expand_path("../man", __FILE__)
+
+      if has_groff?
+        system "#{groff} #{root}/#{command} | #{Pager.pager_command}"
+      else
+        system "#{Pager.pager_command} #{root}/#{command}.txt"
+      end
+    end
+
+  end # Manpage
+end # GithubCLI

data/lib/github_cli/pager.rb

@@ -62,5 +62,5 @@ module GithubCLI
         read_io.close
       end
     end
-  end # System
+  end # Pager
 end # GithubCLI

data/lib/github_cli/terminal.rb

@@ -68,7 +68,8 @@ module GithubCLI
       end
 
       def print_command_not_found(cmd)
-        GithubCLI.ui.info "ghc: '#{cmd}' is not a ghc command. See 'ghc --help'."
+        exec_name = GithubCLI.executable_name
+        GithubCLI.ui.info "#{exec_name}: '#{cmd}' is not a #{exec_name} command. See '#{exec_name} --help'."
       end
 
       def print_usage(flags, command='<command>')
@@ -76,11 +77,16 @@ module GithubCLI
 
 #{GithubCLI.program_name}
 
-Usage: ghc #{GithubCLI::Command::Usage.new(command, flags).format_usage }
+Usage: #{GithubCLI.executable_name} #{GithubCLI::Command::Usage.new(command, flags).format_usage }
 
         TEXT
       end
 
+      def print_config(pattern=nil)
+        GithubCLI.ui.info "Configuration options:"
+        GithubCLI.ui.print_table GithubCLI.config.pretty(pattern)
+      end
+
     end
 
   end # Terminal

data/lib/github_cli/thor_ext.rb

@@ -1,5 +1,6 @@
-require 'github_cli'
+$:.unshift File.expand_path('../vendor/thor', __FILE__)
 require 'thor'
+require 'github_cli'
 
 class Thor
   include Thor::Base
@@ -51,8 +52,18 @@ class Thor
     end
   end
 
+  MANPAGES = %w[
+    gcli-config.1
+  ]
+
   desc "help <command>", "Describe available commands or one specific command"
   def help(task = nil, subcommand = false)
+    command = "gcli-#{task}.1"
+
+    GithubCLI::Manpage.has?(command) do |manpage|
+      manpage.show(command) && return
+    end
+
     task ? self.class.task_help(shell, task) : self.class.help(shell, subcommand)
   end
 end # Thor

data/lib/github_cli/vendor.rb

@@ -0,0 +1,10 @@
+vendor_dir = File.expand_path('../vendor', __FILE__)
+
+# Add any vendored libraries into search path
+Dir.glob(vendor_dir + '/*').each do |dir|
+  $LOAD_PATH.unshift File.join(dir, 'lib')
+end
+$:.unshift File.expand_path('../vendor/thor', __FILE__)
+
+require 'thor'
+require 'thor/group'

data/lib/github_cli/version.rb

@@ -1,3 +1,3 @@
 module GithubCLI
-  VERSION = "0.4.4"
+  VERSION = "0.5.0"
 end

data/lib/github_cli.rb

@@ -2,8 +2,7 @@
 
 require 'yaml'
 require 'pathname'
-require 'thor'
-require 'thor/group'
+require 'github_cli/vendor'
 require 'github_api'
 require 'github_cli/thor_ext'
 require 'github_cli/version'
@@ -19,6 +18,8 @@ module GithubCLI
   autoload :Terminal,  'github_cli/terminal'
   autoload :System,    'github_cli/system'
   autoload :Pager,     'github_cli/pager'
+  autoload :Editor,    'github_cli/editor'
+  autoload :Manpage,   'github_cli/manpage'
   autoload :Commands,  'github_cli/commands'
   autoload :Helpers,   'github_cli/helpers'
   autoload :Formatter, 'github_cli/formatter'
@@ -42,6 +43,10 @@ module GithubCLI
       @ui ||= UI.new
     end
 
+    def executable_name
+      File.basename($PROGRAM_NAME)
+    end
+
     def default_configfile
       Helpers.default_configfile
     end

data/man/gcli-config.1.ronn

@@ -0,0 +1,82 @@
+gcli-config(1) - Get or set global or local configuration options
+=================================================================
+
+## SYNOPSIS
+
+`gcli config` --global|--local name [value]<br>
+`gcli config` --global|--local `-l | -list` [name_regex]<br>
+`gcli config` --global|--local `-e | --edit`
+
+## DESCRIPTION
+
+You can query/set options with this command. The name is actually a hash key
+string that is a composite one, nested with dots. If only name is provided, a
+value will be retrieved. If two parameters are given then value will be set
+or updated depending whether it already exists or not.\n
+
+There two types of config files, global and project specific. When modifying
+options ensure that you modifying the correct config.
+
+This command line will fail (with the exit code ret) if:
+
+1. The config file is invalid.
+
+## OPTIONS
+
+* `--global`:
+  Writes configuration settings to global ~/.githubrc file inside user home directory.
+
+* `--local`:
+  Writes cofinguration settings inside the current directory to the .githubrc file.
+
+* `-l, --list`:
+  List all variables set in config file.
+
+* `-e, --edit`:
+  Opens an editor to modify the specified config file.
+
+  Defaults to `vi` editor if non specified. It first looks inside --global or --local config, then searches environement variables `EDITOR` and `VISUAL` before assuming default.
+
+## CONFIGURATION FILE
+
+The `gcli` configuration file contains a number of variables that affect the way the GitHub API is quried.
+
+### SYNTAX
+
+The configuration file is written in `yaml`. Therfore all formatting rules are derived from yaml specification.
+
+### VARIABLES
+
+*  `auth.token`:
+  Authentication token.
+
+*  `auth.basic`: 
+  Basic credentials in the form `login:password`.
+
+*  `core.endpoint`:
+  Sets host path used as the base for all requests to GitHub API v3.
+
+*  `core.editor`:
+  Sets the editor to be used when opening files. By default `vi` is specified.
+
+*  `core.pager`:
+  The command that will be used to paginate output. Can be overridden with PAGER environment variable. less
+
+*  `core.no-pager`:
+  false
+
+*  `core.no-color`:
+  If set to true disables color output. By default is set to false.
+
+*  `core.format`:
+  Determines output formatting. Defaults to table output.
+
+*  `core.auto`:
+   Automatic pagination of requests to GitHub.
+
+*  `core.aliases`:
+  Global aliases used by commands.
+
+## AUTHOR
+
+  Piotr Murach

data/man/gcli-repo.1.ronn

@@ -0,0 +1,7 @@
+gcli-repo(1) - Manage repository data
+=====================================
+
+## SYNOPSIS
+
+`gcli repo` `branches` user repo<br>
+`gcli repo` `contribs|contributors` user repo<br>