defunkt-github 0.3.1 → 0.3.2

data/Manifest

@@ -1,15 +1,15 @@
+History.txt
 LICENSE
-Manifest
-README
-bin/gh
+Manifest.txt
+README.txt
+Rakefile
 bin/github
 commands/commands.rb
 commands/helpers.rb
-github-gem.gemspec
+lib/github.rb
 lib/github/command.rb
 lib/github/extensions.rb
 lib/github/helper.rb
-lib/github.rb
 spec/command_spec.rb
 spec/extensions_spec.rb
 spec/github_spec.rb

data/README

@@ -22,7 +22,7 @@ Pulling Upstream Changes
 
 Let's say you just forked `github-gem` on GitHub from defunkt.
 
-  $ github clone git://github.com/YOU/github-gem.git
+  $ github clone YOU/github-gem
   $ cd github-gem
   $ github pull defunkt
 

data/commands/commands.rb

@@ -5,7 +5,18 @@ command :home do |user|
   end
 end
 
+desc "Automatically set configuration info, or pass args to specify."
+usage "github config [my_username] [my_repo_name]"
+command :config do |user, repo|
+  user ||= ENV['USER']
+  repo ||= File.basename(FileUtils.pwd)
+  git "config --global github.user #{user}"
+  git "config github.repo #{repo}"
+  puts "Configured with github.user #{user}, github.repo #{repo}"
+end
+
 desc "Open this repo in a web browser."
+usage "github browse [user] [branch]"
 command :browse do |user, branch|
   if helper.project
     # if one arg given, treat it as a branch name
@@ -20,119 +31,6 @@ command :browse do |user, branch|
   end
 end
 
-desc "Project network tools - sub-commands : web [user], list, fetch, commits"
-flags :after => "Only show commits after a certain date"
-flags :before => "Only show commits before a certain date"
-flags :shas => "Only show shas"
-flags :project => "Filter commits on a certain project"
-flags :author => "Filter commits on a email address of author"
-flags :applies => "Filter commits to patches that apply cleanly"
-flags :noapply => "Filter commits to patches that do not apply cleanly"
-flags :nocache => "Do not use the cached network data"
-flags :cache => "Use the network data even if it's expired"
-flags :sort => "How to sort : date(*), branch, author"
-flags :common => "Show common branch point"
-flags :thisbranch => "Look at branches that match the current one"
-flags :limit => "Only look through the first X heads - useful for really large projects"
-command :network do |command, user|
-  return if !helper.project
-  user ||= helper.owner
-
-  case command
-  when 'web'
-    helper.open helper.network_page_for(user)
-  when 'list'
-    data = helper.get_network_data(user, options)
-    data['users'].each do |hsh|
-      puts [ hsh['name'].ljust(20), hsh['heads'].map {|a| a['name']}.uniq.join(', ') ].join(' ')
-    end
-  when 'fetch'
-    # fetch each remote we don't have
-    data = helper.get_network_data(user, options)
-    data['users'].each do |hsh|
-      u = hsh['name']
-      GitHub.invoke(:track, u) unless helper.tracking?(u)
-      puts "fetching #{u}"
-      GitHub.invoke(:fetch_all, u)
-    end
-  when 'commits'
-    # show commits we don't have yet
-    
-    $stderr.puts 'gathering heads'
-    cherry = []
-    
-    if helper.cache_commits_data(options)
-      ids = []
-      data = helper.get_network_data(user, options)
-      data['users'].each do |hsh|
-        u = hsh['name']
-        if options[:thisbranch]
-          user_ids = hsh['heads'].map { |a| a['id'] if a['name'] == helper.current_branch }.compact
-        else
-          user_ids = hsh['heads'].map { |a| a['id'] }
-        end
-        user_ids.each do |id|
-          if !helper.has_commit?(id) && helper.cache_expired?
-            GitHub.invoke(:track, u) unless helper.tracking?(u)
-            puts "fetching #{u}"
-            GitHub.invoke(:fetch_all, u)
-          end
-        end
-        ids += user_ids
-      end
-      ids.uniq!
-    
-      $stderr.puts 'has heads'
-    
-      # check that we have all these shas locally
-      local_heads = helper.local_heads
-      local_heads_not = local_heads.map { |a| "^#{a}"}
-      looking_for = (ids - local_heads) + local_heads_not
-      commits = helper.get_commits(looking_for)
-    
-      $stderr.puts 'ID SIZE:' + ids.size.to_s
-            
-      ignores = helper.ignore_sha_array
-    
-      ids.each do |id|
-        next if ignores[id] || !commits.assoc(id)
-        cherries = helper.get_cherry(id)
-        cherries = helper.remove_ignored(cherries, ignores)
-        cherry += cherries
-        helper.ignore_shas([id]) if cherries.size == 0
-        $stderr.puts "checking head #{id} : #{cherry.size.to_s}"
-        break if options[:limit] && cherry.size > options[:limit].to_i
-      end
-    end
-    
-    if cherry.size > 0 || !helper.cache_commits_data(options)
-      helper.print_network_cherry_help if !options[:shas]
-      
-      if helper.cache_commits_data(options)
-        $stderr.puts "caching..."
-        $stderr.puts "commits: " + cherry.size.to_s
-        our_commits = cherry.map { |item| c = commits.assoc(item[1]); [item, c] if c }
-        our_commits.delete_if { |item| item == nil } 
-        helper.cache_commits(our_commits)
-      else
-        $stderr.puts "using cached..."
-        our_commits = helper.commits_cache
-      end
-      
-      helper.print_commits(our_commits, options)
-    else
-      puts "no unapplied commits"
-    end
-  else
-    helper.print_network_help
-  end
-end
-
-desc "Ignore a SHA (from 'github network commits')"
-command :ignore do |sha|
-  commits = helper.resolve_commits(sha)
-  helper.ignore_shas(commits)             # add to .git/ignore-shas file
-end
 
 desc "Info about this project."
 command :info do
@@ -145,6 +43,10 @@ command :info do
 end
 
 desc "Track another user's repository."
+usage "github track remote [user]"
+usage "github track remote [user/repo]"
+usage "github track [user]"
+usage "github track [user/repo]"
 flags :private => "Use git@github.com: instead of git://github.com/."
 flags :ssh => 'Equivalent to --private'
 command :track do |remote, user|
@@ -179,7 +81,7 @@ command :fetch do |user, branch|
   user, branch = user.split("/", 2) if branch.nil?
   branch ||= 'master'
   GitHub.invoke(:track, user) unless helper.tracking?(user)
-  
+
   die "Unknown branch (#{branch}) specified" unless helper.remote_branch?(user, branch)
   die "Unable to switch branches, your current branch has uncommitted changes" if helper.branch_dirty?
 
@@ -190,6 +92,7 @@ command :fetch do |user, branch|
 end
 
 desc "Pull from a remote."
+usage "github pull [user] [branch]"
 flags :merge => "Automatically merge remote's changes into your master."
 command :pull do |user, branch|
   die "Specify a user to pull from" if user.nil?
@@ -211,7 +114,8 @@ command :pull do |user, branch|
   end
 end
 
-desc "Clone a repo."
+desc "Clone a repo. Uses ssh if current user is "
+usage "github clone [user] [repo] [dir]"
 flags :ssh => "Clone using the git@github.com style url."
 command :clone do |user, repo, dir|
   die "Specify a user to pull from" if user.nil?
@@ -220,7 +124,7 @@ command :clone do |user, repo, dir|
     (user, repo), dir = [user.split('/', 2), repo]
   end
 
-  if options[:ssh]
+  if options[:ssh] || current_user?(user)
     git_exec "clone git@github.com:#{user}/#{repo}.git" + (dir ? " #{dir}" : "")
   elsif repo
     git_exec "clone git://github.com/#{user}/#{repo}.git" + (dir ? " #{dir}" : "")
@@ -230,6 +134,7 @@ command :clone do |user, repo, dir|
 end
 
 desc "Generate the text for a pull request."
+usage "github pull-request [user] [branch]"
 command :'pull-request' do |user, branch|
   if helper.project
     die "Specify a user for the pull request" if user.nil?

data/github-gem.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "github"
-  s.version = "0.3.1"
+  s.version = "0.3.2"
 
   s.specification_version = 2 if s.respond_to? :specification_version=
 

data/lib/github/command.rb

@@ -33,25 +33,47 @@ module GitHub
       puts git(*command)
     end
 
-    def git(*command)
-      sh ['git', command].flatten.join(' ')
+    def git(command)
+      run :sh, command
     end
 
-    def git_exec(*command)
-      cmdstr = ['git', command].flatten.join(' ')
-      GitHub.debug "exec: #{cmdstr}"
-      exec cmdstr
+    def git_exec(command)
+      run :exec, command
+    end
+
+    def run(method, command)
+      if command.is_a? Array
+        command = [ 'git', command ].flatten
+        GitHub.learn command.join(' ')
+      else
+        command = 'git ' + command
+        GitHub.learn command
+      end
+
+      send method, *command
     end
 
     def sh(*command)
       Shell.new(*command).run
     end
-    
+
     def die(message)
       puts "=> #{message}"
       exit!
     end
 
+    def github_user
+      git("config --get github.user")
+    end
+
+    def shell_user
+      ENV['USER']
+    end
+
+    def current_user?(user)
+      user == github_user || user == shell_user
+    end
+
     class Shell < String
       attr_reader :error
       attr_reader :out
@@ -93,7 +115,7 @@ module GitHub
     end
 
     def command(*args)
-      git_exec *[ @name, args ]
+      git_exec [ @name, args ]
     end
   end
 end

data/lib/github/extensions.rb

@@ -26,3 +26,14 @@ class Object
     self
   end
 end
+
+# cute
+module Color
+  COLORS = { :clear => 0, :red => 31, :green => 32, :yellow => 33 }
+  def self.method_missing(color_name, *args)
+    color(color_name) + args.first + color(:clear)
+  end
+  def self.color(color)
+    "\e[#{COLORS[color.to_sym]}m"
+  end
+end

data/lib/github.rb

@@ -2,6 +2,7 @@ $:.unshift File.dirname(__FILE__)
 require 'github/extensions'
 require 'github/command'
 require 'github/helper'
+require 'fileutils'
 require 'rubygems'
 require 'open-uri'
 require 'json'
@@ -16,22 +17,24 @@ require 'yaml'
 #     whatever
 #   end
 #
-# We'll probably want to use the `choice` gem for concise, tasty DSL
-# arg parsing action.
-#
 
 module GitHub
   extend self
 
   BasePath = File.expand_path(File.dirname(__FILE__) + '/..')
 
-  def command(command, &block)
+  def command(command, options = {}, &block)
     debug "Registered `#{command}`"
     descriptions[command] = @next_description if @next_description
     @next_description = nil
     flag_descriptions[command].update @next_flags if @next_flags
+    usage_descriptions[command] = @next_usage if @next_usage
     @next_flags = nil
+    @next_usage = []
     commands[command.to_s] = Command.new(block)
+    Array(options[:alias] || options[:aliases]).each do |command_alias|
+      commands[command_alias.to_s] = commands[command.to_s]
+    end
   end
 
   def desc(str)
@@ -43,6 +46,11 @@ module GitHub
     @next_flags.update hash
   end
 
+  def usage(string)
+    @next_usage ||= []
+    @next_usage << string
+  end
+
   def helper(command, &block)
     debug "Helper'd `#{command}`"
     Helper.send :define_method, command, &block
@@ -51,9 +59,11 @@ module GitHub
   def activate(args)
     @@original_args = args.clone
     @options = parse_options(args)
-    @debug = @options[:debug]
-    load 'helpers.rb'
-    load 'commands.rb'
+    @debug = @options.delete(:debug)
+    @learn = @options.delete(:learn)
+    Dir[BasePath + '/commands/*.rb'].each do |command|
+      load command
+    end
     invoke(args.shift, *args)
   end
 
@@ -80,6 +90,10 @@ module GitHub
     @flagdescs ||= Hash.new { |h, k| h[k] = {} }
   end
 
+  def usage_descriptions
+    @usage_descriptions ||= Hash.new { |h, k| h[k] = [] }
+  end
+
   def options
     @options
   end
@@ -108,29 +122,47 @@ module GitHub
     end
   end
 
-  def load(file)
-    file[0] == ?/ ? path = file : path = BasePath + "/commands/#{file}"
-    data = File.read(path)
-    GitHub.module_eval data, path
-  end
-
   def debug(*messages)
     puts *messages.map { |m| "== #{m}" } if debug?
   end
 
+  def learn(message)
+    if learn?
+      puts "== " + Color.yellow(message)
+    else
+      debug(message)
+    end
+  end
+
+  def learn?
+    !!@learn
+  end
+
   def debug?
     !!@debug
   end
+
+  def load(file)
+    file[0] == ?/ ? path = file : path = BasePath + "/commands/#{file}"
+    data = File.read(path)
+    GitHub.module_eval data, path
+  end
 end
 
-GitHub.command :default do
+GitHub.command :default, :aliases => ['', '-h', 'help', '-help', '--help'] do
   puts "Usage: github command <space separated arguments>", ''
   puts "Available commands:", ''
   longest = GitHub.descriptions.map { |d,| d.to_s.size }.max
-  GitHub.descriptions.each do |command, desc|
+  GitHub.descriptions.sort {|a,b| a.to_s <=> b.to_s }.each do |command, desc|
     cmdstr = "%-#{longest}s" % command
     puts "  #{cmdstr} => #{desc}"
     flongest = GitHub.flag_descriptions[command].map { |d,| "--#{d}".size }.max
+    GitHub.usage_descriptions[command].each do |usage_descriptions|
+      usage_descriptions.each do |usage|
+        usage_str = "#{" " * longest}      %% %-#{flongest}s" % usage
+        puts usage_str
+      end
+    end
     GitHub.flag_descriptions[command].each do |flag, fdesc|
       flagstr = "#{" " * longest}  %-#{flongest}s" % "--#{flag}"
       puts "  #{flagstr}: #{fdesc}"
@@ -138,9 +170,3 @@ GitHub.command :default do
   end
   puts
 end
-
-GitHub.commands[''] = GitHub.commands['default']
-GitHub.commands['-h'] = GitHub.commands['default']
-GitHub.commands['--help'] = GitHub.commands['default']
-GitHub.commands['-help'] = GitHub.commands['default']
-GitHub.commands['help'] = GitHub.commands['default']

data/spec/github_spec.rb

@@ -62,4 +62,24 @@ describe "GitHub.parse_options" do
     GitHub.activate(['default', '--debug'])
     GitHub.should be_debug
   end
+
+  it "should allow for an alias on a commad" do
+    GitHub.command 'some-command', :aliases => 'an-alias' do
+    end
+    GitHub.commands['an-alias'].should_not be_nil
+    GitHub.commands['an-alias'].should_not == GitHub.commands['non-existant-command']
+    GitHub.commands['an-alias'].should == GitHub.commands['some-command']
+  end
+
+  it "should allow for an array of aliases on a commad" do
+    GitHub.command 'another-command', :aliases => ['some-alias-1', 'some-alias-2'] do
+    end
+    GitHub.commands['some-alias-1'].should_not be_nil
+    GitHub.commands['some-alias-1'].should_not == GitHub.commands['non-existant-command']
+    GitHub.commands['some-alias-1'].should_not be_nil
+    GitHub.commands['some-alias-1'].should_not == GitHub.commands['non-existant-command']
+    GitHub.commands['some-alias-1'].should == GitHub.commands['another-command']
+    GitHub.commands['some-alias-2'].should == GitHub.commands['another-command']
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: defunkt-github
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors: 
 - Chris Wanstrath, Kevin Ballard, Scott Chacon