defunkt-github 0.1.2 → 0.1.3

data/Manifest

@@ -1,17 +1,17 @@
 bin/github
 commands/commands.rb
 commands/helpers.rb
+lib/github/extensions.rb
 lib/github/command.rb
 lib/github/helper.rb
 lib/github.rb
 LICENSE
+Manifest
 README
 spec/command_spec.rb
-spec/helpers/owner_spec.rb
-spec/helpers/project_spec.rb
-spec/helpers/public_url_for_spec.rb
-spec/helpers/repo_for_spec.rb
-spec/helpers/user_and_repo_from_spec.rb
-spec/helpers/user_for_spec.rb
+spec/extensions_spec.rb
+spec/github_spec.rb
+spec/helper_spec.rb
 spec/spec_helper.rb
-Manifest
+spec/ui_spec.rb
+spec/windoze_spec.rb

data/README

@@ -9,7 +9,7 @@ Catch us in the #github room on freenode if you want to get involved.  Or just f
 Getting started
 ===========
 
-  $ gem install github
+  $ gem install defunkt-github -s http://gems.github.com
 
 Run it:
 
@@ -51,3 +51,4 @@ Contributors
 - defunkt
 - maddox
 - halorgium
+- kballard

data/commands/commands.rb

@@ -1,54 +1,108 @@
-GitHub.register :helper do |name, comma_args|
-  comma_args ||= ''
-  puts helper.send(name, comma_args.split(/,/))
+desc "Open this repo's master branch in a web browser."
+command :home do |user|
+  if helper.project
+    helper.open helper.homepage_for(user || helper.owner, 'master')
+  end
 end
 
-GitHub.describe :home => "Open this repo's master branch in a web browser."
-GitHub.register :home do
+desc "Open this repo in a web browser."
+command :browse do |user, branch|
   if helper.project
-    exec "#{helper.open} #{helper.homepage_for(helper.owner, 'master')}"
+    # if one arg given, treat it as a branch name
+    # unless it maches user/branch, then split it
+    # if two args given, treat as user branch
+    # if no args given, use defaults
+    user, branch = user.split("/", 2) if branch.nil? unless user.nil?
+    branch = user and user = nil if branch.nil?
+    user ||= helper.branch_user
+    branch ||= helper.branch_name
+    helper.open helper.homepage_for(user, branch)
   end
 end
 
-GitHub.describe :browse => "Open this repo in a web browser."
-GitHub.register :browse do
+desc "Open the network page for this repo in a web browser."
+command :network do |user|
   if helper.project
-    exec "#{helper.open} #{helper.homepage_for(helper.branch_user, helper.branch_name)}"
+    user ||= helper.owner
+    helper.open helper.network_page_for(user)
   end
 end
 
-GitHub.describe :info => "Info about this project."
-GitHub.register :info do
+desc "Info about this project."
+command :info do
   puts "== Info for #{helper.project}"
   puts "You are #{helper.owner}"
-  puts "Currently tracking: "
-  helper.tracking.each do |(name,user_or_url)|
+  puts "Currently tracking:"
+  helper.tracking.sort { |(a,),(b,)| a == :origin ? -1 : b == :origin ? 1 : a.to_s <=> b.to_s }.each do |(name,user_or_url)|
     puts " - #{user_or_url} (as #{name})"
   end
 end
 
-GitHub.describe :track => "Track another user's repository."
-GitHub.register :track do |user|
+desc "Track another user's repository."
+flags :private => "Use git@github.com: instead of git://github.com/."
+flags :ssh => 'Equivalent to --private'
+command :track do |remote, user|
+  # track remote user
+  # track remote user/repo
+  # track user
+  # track user/repo
+  user, remote = remote, nil if user.nil?
   die "Specify a user to track" if user.nil?
+  user, repo = user.split("/", 2)
   die "Already tracking #{user}" if helper.tracking?(user)
+  repo = @helper.project if repo.nil?
+  repo.chomp!(".git")
+  remote ||= user
 
-  git "remote add #{user} #{helper.public_url_for(user)}"
+  if options[:private] || options[:ssh]
+    git "remote add #{remote} #{helper.private_url_for_user_and_repo(user, repo)}"
+  else
+    git "remote add #{remote} #{helper.public_url_for_user_and_repo(user, repo)}"
+  end
 end
 
-GitHub.describe :pull => "Pull from a remote.  Pass --merge to automatically merge remote's changes into your master."
-GitHub.register :pull do |user, branch|
+desc "Pull from a remote."
+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?
-  GitHub.invoke(:track, user) unless helper.tracking?(user)
+  user, branch = user.split("/", 2) if branch.nil?
   branch ||= 'master'
-
-  puts "Switching to #{user}/#{branch}"
-  git "checkout #{user}/#{branch}" if git("checkout -b #{user}/#{branch}").error? 
+  GitHub.invoke(:track, user) unless helper.tracking?(user)
   
   if options[:merge]
-    git "pull #{user} #{branch}"
-    git "checkout master"
-    git_exec "merge #{user}/#{branch}"
+    git_exec "pull #{user} #{branch}"
   else
+    puts "Switching to #{user}/#{branch}"
+    git "checkout #{user}/#{branch}" if git("checkout -b #{user}/#{branch}").error?
     git_exec "pull #{user} #{branch}"
   end
 end
+
+desc "Clone a repo."
+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?
+  if user.include? ?/
+    die "Expected user/repo dir, given extra argument" if dir
+    (user, repo), dir = [user.split('/', 2), repo]
+  end
+  die "Specify a repo to pull from" if repo.nil?
+
+  if options[:ssh]
+    git_exec "clone git@github.com:#{user}/#{repo}.git" + (dir ? " #{dir}" : "")
+  else
+    git_exec "clone git://github.com/#{user}/#{repo}.git" + (dir ? " #{dir}" : "")
+  end
+end
+
+desc "Generate the text for a pull request."
+command :'pull-request' do |user, branch|
+  if helper.project
+    die "Specify a user for the pull request" if user.nil?
+    user, branch = user.split('/', 2) if branch.nil?
+    branch ||= 'master'
+    GitHub.invoke(:track, user) unless helper.tracking?(user)
+
+    git_exec "request-pull #{user}/#{branch} origin"
+  end
+end

data/commands/helpers.rb

@@ -1,58 +1,69 @@
-GitHub.helper :user_and_repo_from do |url|
+helper :user_and_repo_from do |url|
   case url
-  when %r|^git://github\.com/(.*)$|: $1.split('/')
-  when %r|^git@github\.com:(.*)$|: $1.split('/')
+  when %r|^git://github\.com/([^/]+/[^/]+)$|: $1.split('/')
+  when %r|^(?:ssh://)?(?:git@)?github\.com:([^/]+/[^/]+)$|: $1.split('/')
   end
 end
 
-GitHub.helper :user_and_repo_for do |remote|
+helper :user_and_repo_for do |remote|
   user_and_repo_from(url_for(remote))
 end
 
-GitHub.helper :user_for do |remote|
-  user_and_repo_for(remote).first
+helper :user_for do |remote|
+  user_and_repo_for(remote).try.first
 end
 
-GitHub.helper :repo_for do |remote|
-  user_and_repo_for(remote).last
+helper :repo_for do |remote|
+  user_and_repo_for(remote).try.last
 end
 
-GitHub.helper :project do
-  repo_for(:origin).chomp('.git')
+helper :project do
+  repo = repo_for(:origin)
+  if repo.nil?
+    if url_for(:origin) == ""
+      STDERR.puts "Error: missing remote 'origin'"
+    else
+      STDERR.puts "Error: remote 'origin' is not a github URL"
+    end
+    exit 1
+  end
+  repo.chomp('.git')
 end
 
-GitHub.helper :url_for do |remote|
+helper :url_for do |remote|
   `git config --get remote.#{remote}.url`.chomp
 end
 
-GitHub.helper :remotes do
+helper :remotes do
   regexp = '^remote\.(.+)\.url$'
-  `git config --get-regexp '#{regexp}'`.split(/\n/).map do |line|
+  `git config --get-regexp '#{regexp}'`.split(/\n/).inject({}) do |memo, line|
     name_string, url = line.split(/ /, 2)
     m, name = *name_string.match(/#{regexp}/)
-    [name, url]
+    memo[name.to_sym] = url
+    memo
   end
 end
 
-GitHub.helper :tracking do
-  remotes.map do |(name, url)|
+helper :tracking do
+  remotes.inject({}) do |memo, (name, url)|
     if ur = user_and_repo_from(url)
-      [name, ur.first]
+      memo[name] = ur.first
     else
-      [name, url]
+      memo[name] = url
     end
+    memo
   end
 end
 
-GitHub.helper :tracking? do |user|
-  tracking.include?(user)
+helper :tracking? do |user|
+  tracking.values.include?(user)
 end
 
-GitHub.helper :owner do
+helper :owner do
   user_for(:origin)
 end
 
-GitHub.helper :user_and_branch do
+helper :user_and_branch do
   raw_branch = `git rev-parse --symbolic-full-name HEAD`.chomp.sub(/^refs\/heads\//, '')
   user, branch = raw_branch.split(/\//, 2)
   if branch
@@ -62,23 +73,51 @@ GitHub.helper :user_and_branch do
   end
 end
 
-GitHub.helper :branch_user do
+helper :branch_user do
   user_and_branch.first
 end
 
-GitHub.helper :branch_name do
+helper :branch_name do
   user_and_branch.last
 end
 
-GitHub.helper :public_url_for do |user|
-  "git://github.com/#{user}/#{project}.git"
+helper :public_url_for_user_and_repo do |user, repo|
+  "git://github.com/#{user}/#{repo}.git"
+end
+
+helper :private_url_for_user_and_repo do |user, repo|
+  "git@github.com:#{user}/#{repo}.git"
+end
+
+helper :public_url_for do |user|
+  public_url_for_user_and_repo user, project
 end
 
-GitHub.helper :homepage_for do |user, branch|
+helper :private_url_for do |user|
+  private_url_for_user_and_repo user, project
+end
+
+helper :homepage_for do |user, branch|
   "https://github.com/#{user}/#{project}/tree/#{branch}"
 end
 
-GitHub.helper :open do
-  WINDOZE ? 'start' : 'open'
+helper :network_page_for do |user|
+  "https://github.com/#{user}/#{project}/network"
+end
+
+helper :has_launchy? do |blk|
+  begin
+    gem 'launchy'
+    require 'launchy'
+    blk.call
+  rescue Gem::LoadError
+    STDERR.puts "Sorry, you need to install launchy: `gem install launchy`"
+  end
 end
-    
+
+helper :open do |url|
+  has_launchy? proc {
+    Launchy::Browser.new.visit url
+  }
+end
+

data/lib/github/command.rb

@@ -1,6 +1,4 @@
-Windoze = RUBY_PLATFORM =~ /mswin|mingw/
-
-if Windoze
+if RUBY_PLATFORM =~ /mswin|mingw/
   begin
     require 'win32/open3'
   rescue LoadError
@@ -40,7 +38,9 @@ module GitHub
     end
 
     def git_exec(*command)
-      exec ['git', command].flatten.join(' ')
+      cmdstr = ['git', command].flatten.join(' ')
+      GitHub.debug "exec: #{cmdstr}"
+      exec cmdstr
     end
 
     def sh(*command)

data/lib/github/extensions.rb

@@ -0,0 +1,28 @@
+# define #try
+class Object
+  def try
+    self
+  end
+end
+
+class NilClass
+  klass = Class.new
+  klass.class_eval do
+    instance_methods.each { |meth| undef_method meth.to_sym unless meth =~ /^__(id|send)__$/ }
+    def method_missing(*args)
+      self
+    end
+  end
+  NilProxy = klass.new
+  def try
+    NilProxy
+  end
+end
+
+# define #tap
+class Object
+  def tap(&block)
+    block.call(self)
+    self
+  end
+end

data/lib/github.rb

@@ -1,13 +1,15 @@
 $:.unshift File.dirname(__FILE__)
+require 'github/extensions'
 require 'github/command'
 require 'github/helper'
+require 'rubygems'
 
 ##
 # Starting simple.
 #
 # $ github <command> <args>
 #
-#   GitHub.register <command> do |*args|
+#   GitHub.command <command> do |*args|
 #     whatever 
 #   end
 #
@@ -20,13 +22,22 @@ module GitHub
 
   BasePath = File.expand_path(File.dirname(__FILE__) + '/..')
 
-  def register(command, &block)
+  def command(command, &block)
     debug "Registered `#{command}`"
+    descriptions[command] = @next_description if @next_description
+    @next_description = nil
+    flag_descriptions[command].update @next_flags if @next_flags
+    @next_flags = nil
     commands[command.to_s] = Command.new(block)
   end
 
-  def describe(hash)
-    descriptions.update hash
+  def desc(str)
+    @next_description = str
+  end
+
+  def flags(hash)
+    @next_flags ||= {}
+    @next_flags.update hash
   end
 
   def helper(command, &block)
@@ -36,6 +47,7 @@ module GitHub
 
   def activate(args)
     @options = parse_options(args)
+    @debug = @options[:debug]
     load 'helpers.rb'
     load 'commands.rb'
     invoke(args.shift, *args)
@@ -55,27 +67,38 @@ module GitHub
     @descriptions ||= {}
   end
 
+  def flag_descriptions
+    @flagdescs ||= Hash.new { |h, k| h[k] = {} }
+  end
+
   def options
     @options
   end
 
   def parse_options(args)
-    @debug = args.delete('--debug')
-    args.inject({}) do |memo, arg|
-      if arg =~ /^--([^=]+)=(.+)/
-        args.delete(arg)
+    idx = 0
+    args.clone.inject({}) do |memo, arg|
+      case arg
+      when /^--(.+?)=(.*)/
+        args.delete_at(idx)
         memo.merge($1.to_sym => $2)
-      elsif arg =~ /^--(.+)/
-        args.delete(arg)
+      when /^--(.+)/
+        args.delete_at(idx)
         memo.merge($1.to_sym => true)
+      when "--"
+        args.delete_at(idx)
+        return memo
       else
+        idx += 1
         memo
       end
     end
   end
 
   def load(file)
-    file[0] == ?/ ? super : super(BasePath + "/commands/#{file}")
+    file[0] == ?/ ? path = file : path = BasePath + "/commands/#{file}"
+    data = File.read(path)
+    GitHub.module_eval data, path
   end
 
   def debug(*messages)
@@ -87,13 +110,18 @@ module GitHub
   end
 end
 
-GitHub.register :default do
+GitHub.command :default 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|
-    command = "%-#{longest}s" % command
-    puts "  #{command} => #{desc}"
+    cmdstr = "%-#{longest}s" % command
+    puts "  #{cmdstr} => #{desc}"
+    flongest = GitHub.flag_descriptions[command].map { |d,| "--#{d}".size }.max
+    GitHub.flag_descriptions[command].each do |flag, fdesc|
+      flagstr = "#{" " * longest}  %-#{flongest}s" % "--#{flag}"
+      puts "  #{flagstr}: #{fdesc}"
+    end
   end
   puts
 end

data/spec/command_spec.rb

@@ -0,0 +1,66 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe GitHub::Command do
+  before(:each) do
+    @command = GitHub::Command.new(proc { |x| puts x })
+  end
+
+  it "should return a GitHub::Helper" do
+    @command.helper.should be_instance_of(GitHub::Helper)
+  end
+
+  it "should call successfully" do
+    @command.should_receive(:puts).with("test").once
+    @command.call("test")
+  end
+
+  it "should return options" do
+    GitHub.should_receive(:options).with().once.and_return({:ssh => true})
+    @command.options.should == {:ssh => true}
+  end
+
+  it "should successfully call out to the shell" do
+    unguard(Kernel, :fork)
+    unguard(Kernel, :exec)
+    hi = @command.sh("echo hi")
+    hi.should == "hi"
+    hi.out?.should be(true)
+    hi.error?.should be(false)
+    hi.command.should == "echo hi"
+    bye = @command.sh("echo bye >&2")
+    bye.should == "bye"
+    bye.out?.should be(false)
+    bye.error?.should be(true)
+    bye.command.should == "echo bye >&2"
+  end
+
+  it "should return the results of a git operation" do
+    GitHub::Command::Shell.should_receive(:new).with("git rev-parse master").once.and_return do |*cmds|
+      s = mock("GitHub::Commands::Shell")
+      s.should_receive(:run).once.and_return("sha1")
+      s
+    end
+    @command.git("rev-parse master").should == "sha1"
+  end
+
+  it "should print the results of a git operation" do
+    @command.should_receive(:puts).with("sha1").once
+    GitHub::Command::Shell.should_receive(:new).with("git rev-parse master").once.and_return do |*cmds|
+      s = mock("GitHub::Commands::Shell")
+      s.should_receive(:run).once.and_return("sha1")
+      s
+    end
+    @command.pgit("rev-parse master")
+  end
+
+  it "should exec a git command" do
+    @command.should_receive(:exec).with("git rev-parse master").once
+    @command.git_exec "rev-parse master"
+  end
+
+  it "should die" do
+    @command.should_receive(:puts).once.with("=> message")
+    @command.should_receive(:exit!).once
+    @command.die "message"
+  end
+end

data/spec/extensions_spec.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+describe "When calling #try" do
+  specify "objects should return themselves" do
+    obj = 1; obj.try.should equal(obj)
+    obj = "foo"; obj.try.should equal(obj)
+    obj = { :foo => "bar" }; obj.try.should equal(obj)
+  end
+
+  specify "objects should behave as if #try wasn't called" do
+    "foo".try.size.should == 3
+    { :foo => :bar }.try.fetch(:foo).should == :bar
+    [1, 2, 3].try.map { |x| x + 1 }.should == [2, 3, 4]
+  end
+
+  specify "nil should return the singleton NilClass::NilProxy" do
+    nil.try.should equal(NilClass::NilProxy)
+  end
+
+  specify "nil should ignore any calls made past #try" do
+    nil.try.size.should equal(NilClass::NilProxy)
+    nil.try.sdlfj.should equal(NilClass::NilProxy)
+    nil.try.one.two.three.should equal(NilClass::NilProxy)
+  end
+
+  specify "classes should respond just like objects" do
+    String.try.should equal(String)
+  end
+end
+
+describe "When calling #tap" do
+  specify "objects should behave like Ruby 1.9's #tap" do
+    obj = "foo"
+    obj.tap { |obj| obj.size.should == 3 }.should equal(obj)
+  end
+end

data/spec/github_spec.rb

@@ -0,0 +1,65 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "GitHub.parse_options" do
+  it "should parse --bare options" do
+    args = ["--bare", "--test"]
+    GitHub.parse_options(args).should == {:bare => true, :test => true}
+    args.should == []
+  end
+
+  it "should parse options intermixed with non-options" do
+    args = ["text", "--bare", "more text", "--option", "--foo"]
+    GitHub.parse_options(args).should == {:bare => true, :option => true, :foo => true}
+    args.should == ["text", "more text"]
+  end
+
+  it "should parse --foo=bar style options" do
+    args = ["--foo=bar", "--bare"]
+    GitHub.parse_options(args).should == {:bare => true, :foo => "bar"}
+    args.should == []
+  end
+
+  it "should stop parsing options at --" do
+    args = ["text", "--bare", "--", "--foo"]
+    GitHub.parse_options(args).should == {:bare => true}
+    args.should == ["text", "--foo"]
+  end
+
+  it "should handle duplicate options" do
+    args = ["text", "--foo=bar", "--bare", "--foo=baz"]
+    GitHub.parse_options(args).should == {:foo => "baz", :bare => true}
+    args.should == ["text"]
+  end
+
+  it "should handle duplicate --bare options surrounding --" do
+    args = ["text", "--bare", "--", "--bare"]
+    GitHub.parse_options(args).should == {:bare => true}
+    args.should == ["text", "--bare"]
+  end
+
+  it "should handle no options" do
+    args = ["text", "more text"]
+    GitHub.parse_options(args).should == {}
+    args.should == ["text", "more text"]
+  end
+
+  it "should handle no args" do
+    args = []
+    GitHub.parse_options(args).should == {}
+    args.should == []
+  end
+
+  it "should not set up debugging when --debug not passed" do
+    GitHub.stub!(:load)
+    GitHub.stub!(:invoke)
+    GitHub.activate(['default'])
+    GitHub.should_not be_debug
+  end
+
+  it "should set up debugging when passed --debug" do
+    GitHub.stub!(:load)
+    GitHub.stub!(:invoke)
+    GitHub.activate(['default', '--debug'])
+    GitHub.should be_debug
+  end
+end