github_cli 0.6.0 → 0.6.1

data/.travis.yml

@@ -16,8 +16,9 @@ matrix:
     - rvm: ruby-head
     - rvm: jruby-head
     - rvm: jruby-18mode
-    - rvm: rbx-18mode
     - rvm: jruby-19mode
+    - rvm: rbx-18mode
+    - rvm: rbx-19mode
 branches:
   only: master
 notifications:

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+0.6.1 (June 9, 2013)
+
+* Add stat command for Statistics API
+* Change command class to dynamically load usage for subcommands
+
 0.6.0 (June 1, 2013)
 
 * Add authorize command to ease pain with getting authenticated

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    github_cli (0.6.0)
+    github_cli (0.6.1)
       github_api (~> 0.10)
 
 GEM

data/features/statistics.feature

@@ -0,0 +1,53 @@
+Feature: gcli stat
+
+  @ci-run
+  Scenario: Available commands
+
+    When I run `gcli stat`
+    Then the exit status should be 0
+      And the output should contain "stat contribs"
+      And the output should contain "stat activity"
+      And the output should contain "stat frequency"
+      And the output should contain "stat participation"
+      And the output should contain "stat card"
+
+  Scenario: List contributions
+    Given the GitHub API server:
+    """
+    get('/repos/peter-murach/tty/stats/contributors') { status 200 }
+    """
+    When I run `gcli stat contribs peter-murach tty`
+    Then the exit status should be 0
+
+  Scenario: List commit activity
+    Given the GitHub API server:
+    """
+    get('/repos/peter-murach/tty/stats/commit_activity') { status 200 }
+    """
+    When I run `gcli stat activity peter-murach tty`
+    Then the exit status should be 0
+
+  Scenario: List code frequency
+    Given the GitHub API server:
+    """
+    get('/repos/peter-murach/tty/stats/code_frequency') { status 200 }
+    """
+    When I run `gcli stat frequency peter-murach tty`
+    Then the exit status should be 0
+
+  Scenario: List participation
+    Given the GitHub API server:
+    """
+    get('/repos/peter-murach/tty/stats/participation') { status 200 }
+    """
+    When I run `gcli stat participation peter-murach tty`
+    Then the exit status should be 0
+
+  Scenario: List punch card
+    Given the GitHub API server:
+    """
+    get('/repos/peter-murach/tty/stats/punch_card') { status 200 }
+    """
+    When I run `gcli stat card peter-murach tty`
+    Then the exit status should be 0
+

data/lib/github_cli/apis/statistics.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+module GithubCLI
+  class Statistics < API
+
+    def self.contributors(user, repo, params, options)
+      output options do
+        github_api(options).repos.stats.contributors user, repo, params
+      end
+    end
+
+    def self.activity(user, repo, params, options)
+      output options do
+        github_api(options).repos.stats.commit_activity user, repo, params
+      end
+    end
+
+    def self.frequency(user, repo, params, options)
+      output options do
+        github_api(options).repos.stats.code_frequency user, repo, params
+      end
+    end
+
+    def self.participation(user, repo, params, options)
+      output options do
+        github_api(options).repos.stats.participation user, repo, params
+      end
+    end
+
+    def self.card(user, repo, params, options)
+      output options do
+        github_api(options).repos.stats.punch_card user, repo, params
+      end
+    end
+
+  end # Statistics
+end # GithubCLI

data/lib/github_cli/command/usage.rb

@@ -25,7 +25,7 @@ module GithubCLI
       #          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>]"
+        synopsis = "#{flags}#{command} <subcommand> [<args>]"
         indent = options[:indent] || DEFAULT_INDENT
         padding = sprintf("%#{indent}s",'')
         length  = options[:length] || Terminal.default_width

data/lib/github_cli/command.rb

@@ -1,23 +1,14 @@
 # encoding: utf-8
 
 module GithubCLI
+
+  # Main class with utility methods for building commands.
   class Command < Thor
     include Thor::Actions
 
-    API_CLASSES = %w(
-      c_l_i
-      repo download key fork hook watch collab content
-      issue label milestone
-      tag tree blob reference commit
-      pull
-      user email follower
-      org member team
-      event
-      search
-    )
-
     HELP_COMMAND = 'help'
 
+    # Internally used command representation
     class Comm < Struct.new(:namespace, :name, :desc, :usage); end
 
     def self.output_formats
@@ -45,53 +36,44 @@ module GithubCLI
                  :desc => "Format of the output. Type table:h to display table horizontally."
     class_option :quiet, :type => :boolean, :aliases => "-q",
                  :desc => "Suppress response output"
-
     class_option :params, :type => :hash, :default => {}, :aliases => '-p',
                  :desc => 'Request parameters e.i per_page:100'
 
-    class << self
-
-      def banner(task, namespace=true, subcommand=true)
-        "#{basename} #{task.formatted_usage(self, true, subcommand)}"
-      end
+    def self.is_api_command?(namespace)
+      !%w[c_l_i command thor].include?(namespace)
+    end
 
-      def all
-        commands = []
-        Thor::Base.subclasses.each do |klass|
-          namespace = extract_namespace(klass)
-          next unless is_api_command?(namespace)
-          namespace = "" if namespace.index(API_CLASSES.first)
+    def self.extract_namespace(klass)
+      klass.namespace.split(':').last
+    end
 
-          klass.tasks.each do |task|
-            next if task.last.name.index HELP_COMMAND
-            commands << Comm.new(namespace,
-                                task.last.name,
-                                task.last.description,
-                                task.last.usage)
-          end
+    # Search for all commands
+    #
+    def self.all
+      commands = []
+      Thor::Base.subclasses.each do |klass|
+        namespace = extract_namespace(klass)
+        next unless is_api_command?(namespace)
+
+        klass.tasks.each do |task|
+          last_task = task.last
+          name = last_task.name
+          next if name.index HELP_COMMAND
+          commands << Comm.new(namespace, name, last_task.description, last_task.usage)
         end
-        commands
-      end
-
-      def is_api_command?(klass)
-        return false unless API_CLASSES.include?(klass.to_s)
-        return true
-      end
-
-      def extract_namespace(klass)
-        klass.namespace.split(':').last
       end
+      commands
+    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('<')
-          !cmd.namespace.empty? && command[0..end_index].include?(cmd.namespace)
-        end
-        command_token ? command_token.namespace : '<command>'
+    # Decide whether to show specific command or display placeholder
+    #
+    def self.command_to_show(command)
+      command_token = Command.all.find do |cmd|
+        cmd_index = command.index('<') || -1
+        namespace = cmd.namespace
+        !namespace.empty? && command[0..cmd_index].include?(namespace)
       end
-
+      command_token ? command_token.namespace : '<command>'
     end
 
   end # Command

data/lib/github_cli/commands/statistics.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+module GithubCLI
+  class Commands::Statistics < Command
+
+    namespace :stat
+
+    desc 'contribs <user> <repo>', 'Get contributors list with additions, deletions, and commit counts'
+    def contribs(user, repo)
+      global_options = options.dup
+      params = options[:params].dup
+      Util.hash_without!(global_options, params.keys + ['params'])
+      Statistics.contributors(user, repo, params, global_options)
+    end
+
+    desc 'activity <user> <repo>', 'Get the last year of commit activity data'
+    def activity(user, repo)
+      global_options = options.dup
+      params = options[:params].dup
+      Util.hash_without!(global_options, params.keys + ['params'])
+      Statistics.activity(user, repo, params, global_options)
+    end
+
+    desc 'frequency <user> <repo>', 'Get the number of additions and deletions per week'
+    def frequency(user, repo)
+      global_options = options.dup
+      params = options[:params].dup
+      Util.hash_without!(global_options, params.keys + ['params'])
+      Statistics.frequency(user, repo, params, global_options)
+    end
+
+    desc 'participation <user> <repo>', 'Get the weekly commit count for the repo owner and everyone else'
+    def participation(user, repo)
+      global_options = options.dup
+      params = options[:params].dup
+      Util.hash_without!(global_options, params.keys + ['params'])
+      Statistics.participation(user, repo, params, global_options)
+    end
+
+    desc 'card <user> <repo>', 'Get the number of commits per hour in each day'
+    def card(user, repo)
+      global_options = options.dup
+      params = options[:params].dup
+      Util.hash_without!(global_options, params.keys + ['params'])
+      Statistics.card(user, repo, params, global_options)
+    end
+
+  end # Commands::Statistics
+end # GithubCLI

data/lib/github_cli/commands.rb

@@ -28,6 +28,7 @@ module GithubCLI
     autoload :Repositories,   'github_cli/commands/repositories'
     autoload :Search,         'github_cli/commands/search'
     autoload :Starring,       'github_cli/commands/starring'
+    autoload :Statistics,     'github_cli/commands/statistics'
     autoload :Statuses,       'github_cli/commands/statuses'
     autoload :Tags,           'github_cli/commands/tags'
     autoload :Teams,          'github_cli/commands/teams'

data/lib/github_cli/subcommands.rb

@@ -81,6 +81,9 @@ module GithubCLI
     desc "star", "Leverage Starring API"
     subcommand "star", GithubCLI::Commands::Starring
 
+    desc "stat", "Leverage Statistics API"
+    subcommand "stat", GithubCLI::Commands::Statistics
+
     desc "status", "Leverage Statuses API"
     subcommand "status", GithubCLI::Commands::Statuses
 

data/lib/github_cli/terminal.rb

@@ -72,7 +72,7 @@ module GithubCLI
         GithubCLI.ui.info "#{exec_name}: '#{cmd}' is not a #{exec_name} command. See '#{exec_name} --help'."
       end
 
-      def print_usage(flags, command='<command>')
+      def print_usage(flags, command)
         GithubCLI.ui.info <<-TEXT
 
 #{GithubCLI.program_name}

data/lib/github_cli/thor_ext.rb

@@ -12,7 +12,8 @@ class Thor
       end
       list.sort!{ |a,b| a[0] <=> b[0] }
 
-      GithubCLI::Terminal.print_usage global_flags, list[0][0]
+      command = subcommand ? list[0][0] : '<command>'
+      GithubCLI::Terminal.print_usage(global_flags, command)
 
       shell.say "Commands:"
       shell.print_table(list, :indent => 3, :truncate => true)

data/lib/github_cli/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module GithubCLI
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
 end

data/spec/github_cli/cli_spec.rb

@@ -1,5 +1,66 @@
 require 'spec_helper'
 
 describe GithubCLI::CLI do
+  let(:object) { described_class }
+  let(:config) { stub(:config).as_null_object }
+  let(:ui) { stub(:ui) }
 
+  before {
+    GithubCLI.stub(:ui).and_return(ui)
+    GithubCLI.stub(:config).and_return(config)
+  }
+
+  context 'whoami' do
+    let(:config) { {'user.login' => nil } }
+
+    it 'checks config for user info' do
+      ui.should_receive(:info).with(/Not authed/)
+      subject.invoke 'whoami', []
+    end
+  end
+
+  context 'init' do
+    it 'confirms config creation' do
+      ui.should_receive(:confirm).with(/Writing new configuration file/)
+      File.stub(:exists?).and_return(false)
+      subject.invoke "init", []
+    end
+
+    it 'aborts if config already exists' do
+      ui.should_receive(:error).with(/Not overwritting existing/)
+      File.stub(:exists?).and_return(true)
+      expect { subject.invoke "init", [] }.to raise_error(SystemExit)
+    end
+
+    it 'allows to overwrite existing config' do
+      ui.should_receive(:confirm).with(/Writing new configuration file/)
+      File.stub(:exists?).and_return(true)
+      subject.invoke "init", [], {:force => true}
+    end
+  end
+
+  context 'config' do
+    let(:name) { 'core.editor' }
+
+    before {
+      File.stub(:exists?).and_return(true)
+      GithubCLI::Terminal.stub(:line)
+    }
+
+    it 'aborts without config file' do
+      ui.should_receive(:error).with(/Configuration file does not exist/)
+      File.stub(:exists?).and_return(false)
+      expect { subject.invoke "config", [] }.to raise_error(SystemExit)
+    end
+
+    it 'prints option for list flag' do
+      GithubCLI::Terminal.should_receive(:print_config).with(name)
+      subject.invoke "config", [name], {:list => true}
+    end
+
+    it 'print whole config without parameters' do
+      GithubCLI::Terminal.should_receive(:print_config)
+      subject.invoke "config", []
+    end
+  end
 end

data/spec/github_cli/commands/statistics_spec.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe GithubCLI::Commands::Statistics do
+  let(:format) { {'format' => 'table'} }
+  let(:user)   { 'peter-murach' }
+  let(:repo)   { 'github_cli' }
+  let(:api_class) { GithubCLI::Statistics }
+
+  it "invokes stat:contribs" do
+    api_class.should_receive(:contributors).with(user, repo, {}, format)
+    subject.invoke "stat:contribs", [user, repo]
+  end
+
+  it "invokes stat:activity" do
+    api_class.should_receive(:activity).with(user, repo, {}, format)
+    subject.invoke "stat:activity", [user, repo]
+  end
+
+  it "invokes stat:frequency" do
+    api_class.should_receive(:frequency).with(user, repo, {}, format)
+    subject.invoke "stat:frequency", [user, repo]
+  end
+
+  it "invokes stat:participation" do
+    api_class.should_receive(:participation).with(user, repo, {}, format)
+    subject.invoke "stat:participation", [user, repo]
+  end
+
+  it "invokes stat:card" do
+    api_class.should_receive(:card).with(user, repo, {}, format)
+    subject.invoke "stat:card", [user, repo]
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github_cli
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-01 00:00:00.000000000Z
+date: 2013-06-09 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api
-  requirement: &2153441100 !ruby/object:Gem::Requirement
+  requirement: &2156012000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '0.10'
   type: :runtime
   prerelease: false
-  version_requirements: *2153441100
+  version_requirements: *2156012000
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153440620 !ruby/object:Gem::Requirement
+  requirement: &2156010900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153440620
+  version_requirements: *2156010900
 - !ruby/object:Gem::Dependency
   name: aruba
-  requirement: &2153440100 !ruby/object:Gem::Requirement
+  requirement: &2156003180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153440100
+  version_requirements: *2156003180
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2153439280 !ruby/object:Gem::Requirement
+  requirement: &2156002240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153439280
+  version_requirements: *2156002240
 - !ruby/object:Gem::Dependency
   name: communist
-  requirement: &2153438820 !ruby/object:Gem::Requirement
+  requirement: &2156001040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153438820
+  version_requirements: *2156001040
 - !ruby/object:Gem::Dependency
   name: ronn
-  requirement: &2153438080 !ruby/object:Gem::Requirement
+  requirement: &2155997580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153438080
+  version_requirements: *2155997580
 description: CLI-based access to GitHub API v3
 email:
 - ''
@@ -128,6 +128,7 @@ files:
 - features/search.feature
 - features/search_commands.feature
 - features/starring.feature
+- features/statistics.feature
 - features/statuses.feature
 - features/support/env.rb
 - features/support/hooks.rb
@@ -168,6 +169,7 @@ files:
 - lib/github_cli/apis/repository.rb
 - lib/github_cli/apis/search.rb
 - lib/github_cli/apis/starring.rb
+- lib/github_cli/apis/statistics.rb
 - lib/github_cli/apis/status.rb
 - lib/github_cli/apis/tag.rb
 - lib/github_cli/apis/team.rb
@@ -206,6 +208,7 @@ files:
 - lib/github_cli/commands/repositories.rb
 - lib/github_cli/commands/search.rb
 - lib/github_cli/commands/starring.rb
+- lib/github_cli/commands/statistics.rb
 - lib/github_cli/commands/statuses.rb
 - lib/github_cli/commands/tags.rb
 - lib/github_cli/commands/teams.rb
@@ -296,6 +299,7 @@ files:
 - spec/github_cli/commands/references_spec.rb
 - spec/github_cli/commands/repositories_spec.rb
 - spec/github_cli/commands/starring_spec.rb
+- spec/github_cli/commands/statistics_spec.rb
 - spec/github_cli/commands/statuses_spec.rb
 - spec/github_cli/commands/tags_spec.rb
 - spec/github_cli/commands/teams_spec.rb
@@ -379,6 +383,7 @@ test_files:
 - features/search.feature
 - features/search_commands.feature
 - features/starring.feature
+- features/statistics.feature
 - features/statuses.feature
 - features/support/env.rb
 - features/support/hooks.rb
@@ -417,6 +422,7 @@ test_files:
 - spec/github_cli/commands/references_spec.rb
 - spec/github_cli/commands/repositories_spec.rb
 - spec/github_cli/commands/starring_spec.rb
+- spec/github_cli/commands/statistics_spec.rb
 - spec/github_cli/commands/statuses_spec.rb
 - spec/github_cli/commands/tags_spec.rb
 - spec/github_cli/commands/teams_spec.rb