git-hub 1.1.0 → 1.3.0

data/README.md

@@ -36,12 +36,16 @@ Install
 Assuming `~/bin/` is in your `$PATH`, you're ready to roll:
 
     $ hub version
-    git version 1.6.4.2
-    hub version 0.3.2
+    git version 1.7.0.4
+    hub version 1.1.0
 
 ### Homebrew
 
-    brew install hub
+    $ brew install hub
+    $ which hub
+    /usr/local/bin/hub
+    $ hub version
+    ...
 
 ### RubyGems
 
@@ -49,18 +53,20 @@ Though not recommended, `hub` can also be installed as a RubyGem:
 
     $ gem install git-hub
 
-(Yes, the gem name is `git-hub`.)
+Yes, the gem name is "git-hub".
 
-(It's not recommended because of the RubyGems startup time. See [this
-gist][speed] for information.)
+(It's not recommended for casual use because of the RubyGems startup
+time. See [this gist][speed] for information.)
 
 ### Standalone via RubyGems
 
-Yes, the gem name is still `git-hub`:
+Yes, the gem name is still "git-hub":
 
     $ gem install git-hub
     $ hub hub standalone > ~/bin/hub && chmod 755 ~/bin/hub
-    $ gem uninstall git-hub
+
+This installs a standalone version which doesn't require RubyGems to
+run.
 
 ### Source
 
@@ -74,7 +80,7 @@ You can also install from source:
 Aliasing
 --------
 
-hub works best when it wraps `git`. This is not dangerous - your
+`hub` works best when it wraps `git`. This is not dangerous - your
 normal git commands should all work. hub merely adds some sugar.
 
 Typing `hub alias <shell>` will display alias instructions for
@@ -153,18 +159,50 @@ login" below for details.
     $ git browse
     > open http://github.com/CURRENT_REPO
 
+    $ git browse -- issues
+    > open http://github.com/CURRENT_REPO/issues
+
     $ git browse schacon/ticgit
     > open http://github.com/schacon/ticgit
 
     $ git browse -p schacon/ticgit
-    > open http://github.com/schacon/ticgit
+    > open https://github.com/schacon/ticgit
 
     $ git browse resque
     > open http://github.com/YOUR_USER/resque
 
+    $ git browse resque network
+    > open http://github.com/YOUR_USER/resque/network
+
     $ git browse -p resque
     > open https://github.com:YOUR_USER/resque
 
+### git compare
+
+    $ git compare refactor
+    > open http://github.com/CURRENT_REPO/compare/refactor
+
+    $ git compare 1.0...1.1
+    > open http://github.com/CURRENT_REPO/compare/1.0...1.1
+
+    $ git compare -u fix
+    > (http://github.com/CURRENT_REPO/compare/fix)
+
+    $ git compare other-user patch
+    > open http://github.com/other-user/REPO/compare/patch
+
+### git submodule
+
+    $ hub submodule add wycats/bundler vendor/bundler
+    > git submodule add git://github.com/wycats/bundler.git vendor/bundler
+
+    $ hub submodule add -p wycats/bundler vendor/bundler
+    > git submodule add git@github.com:wycats/bundler.git vendor/bundler
+
+    $ hub submodule add -b ryppl ryppl/pip vendor/pip
+    > git submodule add -b ryppl git://github.com/ryppl/pip.git vendor/pip
+
+
 ### git help
 
     $ git help
@@ -195,13 +233,13 @@ Configuration
 -------------
 
 If you prefer `http://` clones to `git://` clones, you can set the
-`hub.http-clone` option using `git-config`.
+`hub.http-clone` option to true using `git-config`.
 
 For example:
 
     $ git clone defunkt/repl
     < git clone >
-    $ git config --global --add hub.http-clone yes
+    $ git config --global --bool hub.http-clone true
     $ git clone defunkt/repl
     < http clone >
 
@@ -234,6 +272,16 @@ Once you've made your great commits:
 4. Create an [Issue][1] with a link to your branch
 5. That's it!
 
+### Development Gems
+You will need the following gems (and their dependencies) to
+contribute to `hub`:
+
+* `rake` (`gem install rake`)
+* `kicker` (`gem install kicker`)
+* `turn` (`gem install turn`)
+* `mg` (`gem install mg`)
+* `ronn` (`gem install ronn`)
+* `webhelper` (`gem install webhelper`)
 
 Meta
 ----

data/Rakefile

@@ -1,37 +1,12 @@
 require 'rake/testtask'
 
-task :default => :test
-
-Rake::TestTask.new do |t|
-  t.libs << 'lib'
-  t.ruby_opts << '-rubygems'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-desc "Launch Kicker (like autotest)"
-task :kicker do
-  puts "Kicking... (ctrl+c to cancel)"
-  exec "kicker -e rake test lib"
-end
-
-desc "Build a gem"
-task :gem => [ :gemspec, :build ]
-
-desc "Build standalone script"
-task :standalone => :load_hub do
-  require 'hub/standalone'
-  Hub::Standalone.save('hub')
-end
+#
+# Helpers
+#
 
-desc "Build hub manual"
-task "man:build" do
-  sh "ron -br5 --organization=DEFUNKT --manual='Git Manual' man/*.ron"
-end
-
-desc "Show hub manual"
-task :man => "man:build" do
-  exec "man man/hub.1"
+def command?(command)
+  `type -t #{command}`
+  $?.success?
 end
 
 task :load_hub do
@@ -39,54 +14,77 @@ task :load_hub do
   require 'hub'
 end
 
-begin
-  require 'jeweler'
-  $LOAD_PATH.unshift 'lib'
-  require 'hub'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "git-hub"
-    gemspec.summary = gemspec.description = "hub introduces git to GitHub"
-    gemspec.homepage = "http://github.com/defunkt/hub"
-    gemspec.version = Hub::Version
-    gemspec.authors = ["Chris Wanstrath"]
-    gemspec.email = "chris@ozmm.org"
-    gemspec.executables = ["hub"]
-    gemspec.post_install_message = <<-message
+task :check_dirty do
+  if !`git status`.include?('nothing to commit')
+    abort "dirty index - not publishing!"
+  end
+end
 
-------------------------------------------------------------
 
-                  You there! Wait, I say!
-                  =======================
+#
+# Tests
+#
 
-       If you are a heavy user of `git` on the command
-       line  you  may  want  to  install `hub` the old
-       fashioned way.  Faster  startup  time,  you see.
+task :default => :test
 
-       Check  out  the  installation  instructions  at
-       http://github.com/defunkt/hub#readme  under the
-       "Standalone" section.
+if command? :turn
+  desc "Run tests"
+  task :test do
+    suffix = "-n #{ENV['TEST']}" if ENV['TEST']
+    sh "turn test/*.rb #{suffix}"
+  end
+else
+  Rake::TestTask.new do |t|
+    t.libs << 'lib'
+    t.ruby_opts << '-rubygems'
+    t.pattern = 'test/**/*_test.rb'
+    t.verbose = false
+  end
+end
+
+if command? :kicker
+  desc "Launch Kicker (like autotest)"
+  task :kicker do
+    puts "Kicking... (ctrl+c to cancel)"
+    exec "kicker -e rake test lib"
+  end
+end
 
-       Cheers,
-       defunkt
 
-------------------------------------------------------------
+#
+# Ron
+#
 
-message
+if command? :ronn
+  desc "Show the manual"
+  task :man => "man:build" do
+    exec "man man/hub.1"
+  end
+
+  desc "Build the manual"
+  task "man:build" do
+    sh "ronn -br5 --organization=DEFUNKT --manual='Git Manual' man/*.ronn"
   end
-rescue LoadError
-  puts "Jeweler not available."
-  puts "Install it with: gem install jeweler"
 end
 
 
-Rake::TaskManager.class_eval do
-  def remove_task(task_name)
-    @tasks.delete(task_name.to_s)
-  end
+#
+# Gems
+#
+
+desc "Build standalone script"
+task :standalone => :load_hub do
+  require 'hub/standalone'
+  Hub::Standalone.save('hub')
 end
 
-# Remove jewelers install task
-Rake.application.remove_task(:install)
+begin
+  require 'mg'
+  MG.new('git-hub.gemspec')
+rescue LoadError
+  warn "mg not available."
+  warn "Install it with: gem install mg"
+end
 
 desc "Install standalone script and man pages"
 task :install => :standalone do
@@ -99,13 +97,14 @@ task :install => :standalone do
   FileUtils.cp "man/hub.1", "#{prefix}/share/man/man1"
 end
 
-desc "Push a new version to Gemcutter"
-task :publish => [ :test, :gemspec, :build ] do
-  system "git tag v#{Hub::Version}"
-  system "git push origin v#{Hub::Version}"
-  system "git push origin master"
-  system "gem push pkg/git-hub-#{Hub::Version}.gem"
-  system "git clean -fd"
+desc "Push a new version."
+task :publish => "gem:publish" do
+  require 'hub/version'
+  sh "git tag v#{Hub::Version}"
+  sh "git push origin v#{Hub::Version}"
+  sh "git push origin master"
+  sh "gem push pkg/git-hub-#{Hub::Version}.gem"
+  sh "git clean -fd"
   exec "rake pages"
 end
 
@@ -122,9 +121,3 @@ task :pages => [ "man:build", :check_dirty, :standalone ] do
   sh "git checkout master"
   puts :done
 end
-
-task :check_dirty do
-  if !`git status`.include?('nothing to commit')
-    abort "dirty index - not publishing!"
-  end
-end

data/lib/hub/commands.rb

@@ -1,4 +1,7 @@
 module Hub
+  # See context.rb
+  module Context; end
+
   # The Commands module houses the git commands that hub
   # lovingly wraps. If a method exists here, it is expected to have a
   # corresponding git command which either gets run before or after
@@ -31,25 +34,11 @@ module Hub
     instance_methods.each { |m| undef_method(m) unless m =~ /(^__|send|to\?$)/ }
     extend self
 
-    # Templates and useful information.
-    USER       = `git config --global github.user`.chomp
-    TOKEN      = `git config --global github.token`.chomp
-    ORIGIN     = `git config remote.origin.url`.chomp
-    HTTP_CLONE = `git config --global hub.http-clone`.chomp == 'yes'
-    PUBLIC     = (HTTP_CLONE ? 'http' : 'git') + '://github.com/%s/%s.git'
-    PRIVATE    = 'git@github.com:%s/%s.git'
-    LGHCONF    = "http://github.com/guides/local-github-config"
-    API_REPO   = 'http://github.com/api/v2/yaml/repos/show/%s/%s'
-    API_FORK   = 'http://github.com/api/v2/yaml/repos/fork/%s/%s'
-
-    # Set the repo name based on the current origin or, as a fallback,
-    # the cwd.
-    if ORIGIN =~ %r{\bgithub\.com[:/](.+)/(.+).git$}
-      OWNER, REPO = $1, $2
-    else
-      REPO = File.basename(Dir.pwd)
-      OWNER = ''
-    end
+    # Provides `github_url` and various inspection methods
+    extend Context
+
+    API_REPO = 'http://github.com/api/v2/yaml/repos/show/%s/%s'
+    API_FORK = 'http://github.com/api/v2/yaml/repos/fork/%s/%s'
 
     # $ hub clone rtomayko/tilt
     # > git clone git://github.com/rtomayko/tilt.
@@ -76,15 +65,10 @@ module Hub
         if arg =~ %r{.+?://|.+?@} || File.directory?(arg)
           # Bail out early for URLs and local paths.
           break
-        elsif arg.scan('/').size == 1 && !arg.include?(':')
+        elsif arg.scan('/').size <= 1 && !arg.include?(':')
           # $ hub clone rtomayko/tilt
-          url = ssh ? PRIVATE : PUBLIC
-          args[args.index(arg)] = url % arg.split('/')
-          break
-        elsif arg !~ /:|\//
           # $ hub clone tilt
-          url = ssh ? PRIVATE : PUBLIC
-          args[args.index(arg)] = url % [ github_user, arg ]
+          args[args.index(arg)] = github_url(:repo => arg, :private => ssh)
           break
         end
       end
@@ -95,10 +79,24 @@ module Hub
     #
     # $ hub submodule add -p wycats/bundler vendor/bundler
     # > git submodule add git@github.com:wycats/bundler.git vendor/bundler
+    #
+    # $ hub submodule add -b ryppl ryppl/pip vendor/bundler
+    # > git submodule add -b ryppl git://github.com/ryppl/pip.git vendor/pip
     def submodule(args)
       return unless index = args.index('add')
       args.delete_at index
+
+      branch = args.index('-b') || args.index('--branch')
+      if branch
+        args.delete_at branch
+        branch_name = args.delete_at branch
+      end
+
       clone(args)
+
+      if branch_name
+        args.insert branch, '-b', branch_name
+      end
       args.insert index, 'add'
     end
 
@@ -111,18 +109,17 @@ module Hub
     # $ hub remote add origin
     # > git remote add origin git://github.com/YOUR_LOGIN/THIS_REPO.git
     def remote(args)
-      return if args[1] != 'add' or args.last =~ %r{.+?://|.+?@}
+      return if args[1] != 'add' || args.last =~ %r{.+?://|.+?@|^[./]}
 
       ssh = args.delete('-p')
-      url = ssh ? PRIVATE : PUBLIC
 
       # user/repo
       args.last =~ /\b(.+?)(?:\/(.+))?$/
-      user, repo = $1, $2 || REPO
+      user, repo = $1, $2
 
       if args.words[2] == 'origin' && args.words[3].nil?
-        # Origin special case.
-        user = github_user
+        # Origin special case triggers default user/repo
+        user = repo = nil
       elsif args.words[-2] == args.words[1]
         # rtomayko/tilt => rtomayko
         # Make sure you dance around flags.
@@ -135,7 +132,7 @@ module Hub
         args.replace args[0...-1]
       end
 
-      args << url % [ user, repo ]
+      args << github_url(:user => user, :repo => repo, :private => ssh)
     end
 
     # $ hub init -g
@@ -145,7 +142,7 @@ module Hub
       if args.delete('-g')
         # Can't do anything if we don't have a USER set.
 
-        url = PRIVATE % [ github_user, REPO ]
+        url = github_url(:private => true)
         args.after "git remote add origin #{url}"
       end
     end
@@ -157,9 +154,9 @@ module Hub
       require 'net/http'
 
       # can't do anything without token and original owner name
-      if github_user && github_token && !OWNER.empty?
+      if github_user && github_token && repo_owner
         if own_repo_exists?
-          puts "#{github_user}/#{REPO} already exists on GitHub"
+          puts "#{github_user}/#{repo_name} already exists on GitHub"
         else
           fork_repo
         end
@@ -167,7 +164,7 @@ module Hub
         if args.include?('--no-remote')
           exit
         else
-          url = PRIVATE % [ github_user, REPO ]
+          url = github_url(:private => true)
           args.replace %W"remote add -f #{github_user} #{url}"
           args.after { puts "new remote: #{github_user}" }
         end
@@ -196,6 +193,9 @@ module Hub
     # $ hub browse
     # > open http://github.com/CURRENT_REPO
     #
+    # $ hub browse -- issues
+    # > open http://github.com/CURRENT_REPO/issues
+    #
     # $ hub browse pjhyett/github-services
     # > open http://github.com/pjhyett/github-services
     #
@@ -205,31 +205,75 @@ module Hub
     # $ hub browse github-services
     # > open http://github.com/YOUR_LOGIN/github-services
     #
+    # $ hub browse github-services wiki
+    # > open http://wiki.github.com/YOUR_LOGIN/github-services
+    #
     # $ hub browse -p github-fi
     # > open https://github.com/YOUR_LOGIN/github-fi
     def browse(args)
       args.shift
-      protocol = args.delete('-p') ? 'https' : 'http'
-      dest = args.pop
+      browse_command(args) do
+        user = repo = nil
+        dest = args.shift
+        dest = nil if dest == '--'
 
-      if dest
-        if dest.include? '/'
+        if dest
           # $ hub browse pjhyett/github-services
-          user, repo = dest.split('/')
-        else
           # $ hub browse github-services
-          user, repo = github_user, dest
+          repo = dest
+        elsif repo_user
+          # $ hub browse
+          user = repo_user
+        else
+          abort "Usage: hub browse [<USER>/]<REPOSITORY>"
         end
-      elsif !OWNER.empty?
-        # $ hub browse
-        user, repo = OWNER, REPO
-      else
-        warn "Usage: hub browse [<USER>/]<REPOSITORY>"
-        exit(1)
+
+        params = { :user => user, :repo => repo }
+
+        # $ hub browse -- wiki
+        case subpage = args.shift
+        when 'wiki'
+          params[:web] = 'wiki'
+        when 'commits'
+          branch = (!dest && tracked_branch) || 'master'
+          params[:web] = "/commits/#{branch}"
+        when 'tree', NilClass
+          branch = !dest && tracked_branch
+          params[:web] = "/tree/#{branch}" if branch && branch != 'master'
+        else
+          params[:web] = "/#{subpage}"
+        end
+
+        params
       end
+    end
 
-      args.executable = ENV['BROWSER'] || 'open'
-      args.push "#{protocol}://github.com/#{user}/#{repo}"
+    # $ hub compare 1.0...fix
+    # > open http://github.com/CURRENT_REPO/compare/1.0...fix
+    # $ hub compare refactor
+    # > open http://github.com/CURRENT_REPO/compare/refactor
+    # $ hub compare myfork feature
+    # > open http://github.com/myfork/REPO/compare/feature
+    # $ hub compare -p myfork topsecret
+    # > open https://github.com/myfork/REPO/compare/topsecret
+    # $ hub compare -u 1.0...2.0
+    # prints "http://github.com/CURRENT_REPO/compare/1.0...2.0"
+    def compare(args)
+      args.shift
+      browse_command(args) do
+        if args.empty?
+          branch = tracked_branch
+          if branch && branch != 'master'
+            range, user = branch, repo_user
+          else
+            abort "Usage: hub compare [USER] [<START>...]<END>"
+          end
+        else
+          range = args.pop
+          user = args.pop || repo_user
+        end
+        { :user => user, :web => "/compare/#{range}" }
+      end
     end
 
     # $ hub hub standalone
@@ -367,28 +411,51 @@ help
     # from the command line.
     #
 
-    # Either returns the GitHub user as set by git-config(1) or aborts
-    # with an error message.
-    def github_user
-      if USER.empty?
-        abort "** No GitHub user set. See #{LGHCONF}"
-      else
-        USER
-      end
+    # Checks whether a command exists on this system in the $PATH.
+    #
+    # name - The String name of the command to check for.
+    #
+    # Returns a Boolean.
+    def command?(name)
+      `type -t #{command}`
+      $?.success?
     end
 
-    def github_token
-      if TOKEN.empty?
-        abort "** No GitHub token set. See #{LGHCONF}"
+    # Detects commands to launch the user's browser, checking $BROWSER
+    # first then falling back to a few common launchers. Aborts with
+    # an error if it can't find anything appropriate.
+    #
+    # Returns a launch command.
+    def browser_launcher
+      if ENV['BROWSER']
+        ENV['BROWSER']
+      elsif RUBY_PLATFORM.include?('darwin')
+        "open"
+      elsif command?("xdg-open")
+        "xdg-open"
+      elsif command?("cygstart")
+        "cygstart"
       else
-        TOKEN
+        abort "Please set $BROWSER to a web launcher to use this command."
       end
     end
 
+    # Handles common functionality of browser commands like `browse`
+    # and `compare`. Yields a block that returns params for `github_url`.
+    def browse_command(args)
+      url_only = args.delete('-u')
+      secure = args.delete('-p')
+      params = yield
+
+      args.executable = url_only ? 'echo' : browser_launcher
+      args.push github_url({:web => true, :private => secure}.update(params))
+    end
+
+
     # Returns the terminal-formatted manpage, ready to be printed to
     # the screen.
     def hub_manpage
-      return "** Can't find groff(1)" unless groff?
+      return "** Can't find groff(1)" unless command?('groff')
 
       require 'open3'
       out = nil
@@ -400,12 +467,6 @@ help
       out
     end
 
-    # Returns true if groff is installed and in our path, false if
-    # not.
-    def groff?
-      system("which groff")
-    end
-
     # The groff command complete with crazy arguments we need to run
     # in order to turn our raw roff (manpage markup) into something
     # readable on the terminal.
@@ -474,7 +535,7 @@ help
     #
     # Returns a Boolean.
     def own_repo_exists?
-      url = API_REPO % [USER, REPO]
+      url = API_REPO % [github_user, repo_name]
       Net::HTTPSuccess === Net::HTTP.get_response(URI(url))
     end
 
@@ -482,8 +543,8 @@ help
     #
     # Returns nothing.
     def fork_repo
-      url = API_FORK % [OWNER, REPO]
-      Net::HTTP.post_form(URI(url), 'login' => USER, 'token' => TOKEN)
+      url = API_FORK % [repo_owner, repo_name]
+      Net::HTTP.post_form(URI(url), 'login' => github_user, 'token' => github_token)
     end
   end
 end