git-hub 1.1.0 → 1.3.0

data/lib/hub/context.rb

@@ -0,0 +1,112 @@
+module Hub
+  # Provides methods for inspecting the environment, such as GitHub user/token
+  # settings, repository info, and similar.
+  module Context
+    # Caches output when shelling out to git
+    GIT_CONFIG = Hash.new do |cache, cmd|
+      result = %x{git #{cmd}}.chomp
+      cache[cmd] = $?.success? && !result.empty? ? result : nil
+    end
+
+    # Parses URLs for git remotes and stores info
+    REMOTES = Hash.new do |cache, remote|
+      url = GIT_CONFIG["config remote.#{remote}.url"]
+
+      if url && url.to_s =~ %r{\bgithub\.com[:/](.+)/(.+).git$}
+        cache[remote] = { :user => $1, :repo => $2 }
+      else
+        cache[remote] = { }
+      end
+    end
+
+    LGHCONF = "http://github.com/guides/local-github-config"
+
+    def repo_owner
+      REMOTES[default_remote][:user]
+    end
+
+    def repo_user
+      REMOTES[current_remote][:user]
+    end
+
+    def repo_name
+      REMOTES[default_remote][:repo] || File.basename(Dir.pwd)
+    end
+
+    # Either returns the GitHub user as set by git-config(1) or aborts
+    # with an error message.
+    def github_user(fatal = true)
+      if user = GIT_CONFIG['config github.user']
+        user
+      elsif fatal
+        abort("** No GitHub user set. See #{LGHCONF}")
+      end
+    end
+
+    def github_token(fatal = true)
+      if token = GIT_CONFIG['config github.token']
+        token
+      elsif fatal
+        abort("** No GitHub token set. See #{LGHCONF}")
+      end
+    end
+
+    def current_branch
+      GIT_CONFIG['symbolic-ref -q HEAD']
+    end
+
+    def tracked_branch
+      branch = current_branch && tracked_for(current_branch)
+      normalize_branch(branch) if branch
+    end
+
+    def current_remote
+      (current_branch && remote_for(current_branch)) || default_remote
+    end
+
+    def default_remote
+      'origin'
+    end
+
+    def normalize_branch(branch)
+      branch.sub('refs/heads/', '')
+    end
+
+    def remote_for(branch)
+      GIT_CONFIG['config branch.%s.remote' % normalize_branch(branch)]
+    end
+
+    def tracked_for(branch)
+      GIT_CONFIG['config branch.%s.merge' % normalize_branch(branch)]
+    end
+
+    def http_clone?
+      GIT_CONFIG['config --bool hub.http-clone'] == 'true'
+    end
+
+    def github_url(options = {})
+      repo = options[:repo]
+      user, repo = repo.split('/') if repo && repo.index('/')
+      user ||= options[:user] || github_user
+      repo ||= repo_name
+      secure = options[:private]
+
+      if options[:web] == 'wiki'
+        scheme = secure ? 'https:' : 'http:'
+        '%s//wiki.github.com/%s/%s/' % [scheme, user, repo]
+      elsif options[:web]
+        scheme = secure ? 'https:' : 'http:'
+        path = options[:web] == true ? '' : options[:web].to_s
+        '%s//github.com/%s/%s%s' % [scheme, user, repo, path]
+      else
+        if secure
+          'git@github.com:%s/%s.git'
+        elsif http_clone?
+          'http://github.com/%s/%s.git'
+        else
+          'git://github.com/%s/%s.git'
+        end % [user, repo]
+      end
+    end
+  end
+end

data/lib/hub/version.rb

@@ -1,3 +1,3 @@
 module Hub
-  Version = '1.1.0'
+  Version = VERSION = '1.3.0'
 end

data/lib/hub.rb

@@ -1,4 +1,5 @@
 require 'hub/version'
 require 'hub/args'
+require 'hub/context'
 require 'hub/commands'
 require 'hub/runner'

data/man/hub.1

@@ -1,5 +1,5 @@
-.\" generated with Ron/v0.3
-.\" http://github.com/rtomayko/ron/
+.\" generated with Ronn/v0.5
+.\" http://github.com/rtomayko/ronn/
 .
 .TH "HUB" "1" "April 2010" "DEFUNKT" "Git Manual"
 .
@@ -7,121 +7,101 @@
 \fBhub\fR \-\- git + hub = github
 .
 .SH "SYNOPSIS"
-\fBhub\fR \fICOMMAND\fR \fIOPTIONS\fR \fBhub alias\fR [\fB-s\fR] \fISHELL\fR
+\fBhub\fR \fICOMMAND\fR \fIOPTIONS\fR
+.
+.br
+\fBhub alias\fR [\fB\-s\fR] \fISHELL\fR
 .
 .P
-\fBgit init -g\fR \fIOPTIONS\fR
+\fBgit init \-g\fR \fIOPTIONS\fR
 .
 .br
-\fBgit clone\fR [\fB-p\fR] \fIOPTIONS\fR [\fIUSER\fR/]\fIREPOSITORY\fR \fIDIRECTORY\fR
+\fBgit clone\fR [\fB\-p\fR] \fIOPTIONS\fR [\fIUSER\fR/]\fIREPOSITORY\fR \fIDIRECTORY\fR
 .
 .br
-\fBgit remote add\fR [\fB-p\fR] \fIOPTIONS\fR \fIUSER\fR[/\fIREPOSITORY\fR]
+\fBgit remote add\fR [\fB\-p\fR] \fIOPTIONS\fR \fIUSER\fR[/\fIREPOSITORY\fR]
 .
 .br
 \fBgit push\fR \fIREMOTE\-1\fR,\fIREMOTE\-2\fR,...,\fIREMOTE\-N\fR \fIREF\fR
 .
 .br
-\fBgit fork\fR
+\fBgit browse\fR [\fB\-p\fR] [\fB\-u\fR] [[\fIUSER\fR\fB/\fR]\fIREPOSITORY\fR] [SUBPAGE]
+.
+.br
+\fBgit compare\fR [\fB\-p\fR] [\fB\-u\fR] [\fIUSER\fR] [\fISTART\fR...]\fIEND\fR
 .
 .br
-\fBgit browse\fR [\fB-p\fR] [\fIUSER\fR/]\fIREPOSITORY\fR
+\fBgit submodule add\fR [\fB\-p\fR] \fIOPTIONS\fR [\fIUSER\fR/]\fIREPOSITORY\fR \fIDIRECTORY\fR
 .
 .br
-\fBgit submodule add\fR [\fB-p\fR] \fIOPTIONS\fR [\fIUSER\fR/]\fIREPOSITORY\fR \fIDIRECTORY\fR
+\fBgit fork\fR [\fB\-\-no\-remote\fR]
 .
 .SH "DESCRIPTION"
 \fBhub\fR enhances various \fBgit\fR commands with GitHub remote expansion. The
 alias command displays information on configuring your environment:
 .
 .TP
-\fBhub alias\fR [\fB-s\fR] \fISHELL\fR:
+\fBhub alias\fR [\fB\-s\fR] \fISHELL\fR
+Writes shell aliasing code for \fISHELL\fR (\fBbash\fR, \fBsh\fR, \fBzsh\fR, \fBcsh\fR) to standard output. With the \fB\-s\fR option, the output of
+this command can be evaluated directly within the shell:
 .
 .br
-Writes shell aliasing code for \fISHELL\fR (\fBbash\fR, \fBsh\fR, \fBzsh\fR, \fBcsh\fR) to standard output. With the \fB-s\fR option, the output of
-this command can be evaluated directly within the shell
-\fBeval $(hub alias -s bash)\fR
+\fBeval $(hub alias \-s bash)\fR
 .
 .TP
-\fBgit init\fR \fB-g\fR \fIOPTIONS\fR:
-.
-.br
- Create a git repository as with git\-init(1) and add remote \fBorigin\fR at
- "git@github.com:\fIUSER\fR/\fIREPOSITORY\fR.git"; \fIUSER\fR is your GitHub username and
- \fIREPOSITORY\fR is the current working directory's basename.
-
+\fBgit init\fR \fB\-g\fR \fIOPTIONS\fR
+Create a git repository as with git\-init(1) and add remote \fBorigin\fR at
+"git@github.com:\fIUSER\fR/\fIREPOSITORY\fR.git"; \fIUSER\fR is your GitHub username and \fIREPOSITORY\fR is the current working directory's basename.
 .
 .TP
-\fBgit clone\fR [\fB-p\fR] \fIOPTIONS\fR [\fIUSER\fR\fB/\fR]\fIREPOSITORY\fR \fIDIRECTORY\fR:
-.
-.br
+\fBgit clone\fR [\fB\-p\fR] \fIOPTIONS\fR [\fIUSER\fR\fB/\fR]\fIREPOSITORY\fR \fIDIRECTORY\fR
 Clone repository "git://github.com/\fIUSER\fR/\fIREPOSITORY\fR.git" into \fIDIRECTORY\fR as with git\-clone(1). When \fIUSER\fR/ is omitted, assumes
-your GitHub login. With \fB-p\fR, use private remote
+your GitHub login. With \fB\-p\fR, use private remote
 "git@github.com:\fIUSER\fR/\fIREPOSITORY\fR.git".
-
 .
 .TP
-\fBgit remote add\fR [\fB-p\fR] \fIOPTIONS\fR \fIUSER\fR[\fB/\fR\fIREPOSITORY\fR]:
-.
-.br
+\fBgit remote add\fR [\fB\-p\fR] \fIOPTIONS\fR \fIUSER\fR[\fB/\fR\fIREPOSITORY\fR]
 Add remote "git://github.com/\fIUSER\fR/\fIREPOSITORY\fR.git" as with
 git\-remote(1). When /\fIREPOSITORY\fR is omitted, the basename of the
-current working directory is used. With \fB-p\fR, use private remote
+current working directory is used. With \fB\-p\fR, use private remote
 "git@github.com:\fIUSER\fR/\fIREPOSITORY\fR.git". If \fIUSER\fR is "origin"
 then uses your GitHub login.
-
 .
 .TP
-\fBgit push\fR \fIREMOTE\-1\fR,\fIREMOTE\-2\fR,...,\fIREMOTE\-N\fR \fIREF\fR:
-.
-.br
+\fBgit push\fR \fIREMOTE\-1\fR,\fIREMOTE\-2\fR,...,\fIREMOTE\-N\fR \fIREF\fR
 Push \fIREF\fR to each of \fIREMOTE\-1\fR through \fIREMOTE\-N\fR by executing
 multiple \fBgit push\fR commands.
-
-.
-.TP
-\fBgit fork\fR:
-.
-.br
-Forks the original repo on GitHub and adds the new remote under your
-username. It requires your GitHub login and token to be present. See
-CONFIGURATION below.
-
 .
 .TP
-\fBgit browse\fR [\fB-p\fR] [[\fIUSER\fR\fB/\fR]\fIREPOSITORY\fR]:
-.
-.br
+\fBgit browse\fR [\fB\-p\fR] [\fB\-u\fR] [[\fIUSER\fR\fB/\fR]\fIREPOSITORY\fR] [SUBPAGE]
 Open repository's GitHub page in the system's default web browser
-using \fBopen(1)\fR or the \fBBROWSER\fR env variable. Use \fB-p\fR to open a
+using \fBopen(1)\fR or the \fBBROWSER\fR env variable. Use \fB\-p\fR to open a
 page with https. If the repository isn't specified, \fBbrowse\fR opens
-the page of the repository found in the current directory.
-
+the page of the repository found in the current directory. If SUBPAGE
+is specified, the browser will open on the specified subpage: one of
+"wiki", "commits", "issues" or other (the default is "tree").
 .
 .TP
-\fBgit submodule add\fR [\fB-p\fR] \fIOPTIONS\fR [\fIUSER\fR/]\fIREPOSITORY\fR \fIDIRECTORY\fR:
+\fBgit compare\fR [\fB\-p\fR] [\fB\-u\fR] [\fIUSER\fR] [\fISTART\fR...]\fIEND\fR
+Open a GitHub compare view page in the system's default web browser. \fISTART\fR to \fIEND\fR are branch names, tag names, or commit SHA1s specifying
+the range of history to compare. If \fISTART\fR is omitted, GitHub will
+compare against the base branch (the default is "master").
 .
-.br
+.TP
+\fBgit submodule add\fR [\fB\-p\fR] \fIOPTIONS\fR [\fIUSER\fR/]\fIREPOSITORY\fR \fIDIRECTORY\fR
 Submodule repository "git://github.com/\fIUSER\fR/\fIREPOSITORY\fR.git" into \fIDIRECTORY\fR as with git\-submodule(1). When \fIUSER\fR/ is omitted, assumes
-your GitHub login. With \fB-p\fR, use private remote
+your GitHub login. With \fB\-p\fR, use private remote
 "git@github.com:\fIUSER\fR/\fIREPOSITORY\fR.git".
-
 .
 .TP
-\fBgit fork\fR [\fB--no-remote\fR]:
-.
-.br
-Forks the original project (as specified in "origin" remote) on GitHub
-and adds a new remote named \fIUSER\fR referencing the newly created repo.
-Requires \fBgithub.token\fR to be set (see CONFIGURATION).
-
+\fBgit fork\fR [\fB\-\-no\-remote\fR]
+Forks the original project (referenced by "origin" remote) on GitHub and
+adds a new remote for it under your username. Requires \fBgithub.token\fR to
+be set (see CONFIGURATION).
 .
 .TP
-\fBgit help\fR:
-.
-.br
+\fBgit help\fR
 Display enhanced git\-help(1).
-
 .
 .SH "CONFIGURATION"
 Use git\-config(1) to display the currently configured GitHub username:
@@ -130,7 +110,7 @@ Use git\-config(1) to display the currently configured GitHub username:
 .
 .nf
 
-\fB$ git config --global github.user \fR
+$ git config \-\-global github.user
 .
 .fi
 .
@@ -143,8 +123,8 @@ Or, set the GitHub username and token with:
 .
 .nf
 
-\fB$ git config --global github.user <username>
-$ git config --global github.token <token> \fR
+$ git config \-\-global github.user <username>
+$ git config \-\-global github.token <token>
 .
 .fi
 .
@@ -162,7 +142,7 @@ cloning:
 .
 .nf
 
-\fB$ git config --global --add hub.http-clone yes \fR
+$ git config \-\-global \-\-bool hub.http\-clone true
 .
 .fi
 .
@@ -174,17 +154,17 @@ cloning:
 .
 .nf
 
-\fB$ git clone schacon/ticgit
-> git clone git://github.com/schacon/ticgit.git 
-$ git clone -p schacon/ticgit
+$ git clone schacon/ticgit
+> git clone git://github.com/schacon/ticgit.git
+
+$ git clone \-p schacon/ticgit
 > git clone git@github.com:schacon/ticgit.git
 
 $ git clone resque
 > git clone git://github.com/YOUR_USER/resque.git
 
-$ git clone -p resque
+$ git clone \-p resque
 > git clone git@github.com:YOUR_USER/resque.git
-\fR
 .
 .fi
 .
@@ -192,14 +172,14 @@ $ git clone -p resque
 .
 .nf
 
-\fB$ git remote add rtomayko
-> git remote add rtomayko git://github.com/rtomayko/CURRENT_REPO.git 
-$ git remote add -p rtomayko
+$ git remote add rtomayko
+> git remote add rtomayko git://github.com/rtomayko/CURRENT_REPO.git
+
+$ git remote add \-p rtomayko
 > git remote add rtomayko git@github.com:rtomayko/CURRENT_REPO.git
 
 $ git remote add origin
 > git remote add origin git://github.com/YOUR_USER/CURRENT_REPO.git
-\fR
 .
 .fi
 .
@@ -207,9 +187,9 @@ $ git remote add origin
 .
 .nf
 
-\fB$ git fork
+$ git fork
 ... hardcore forking action ...
-> git remote add YOUR_USER git@github.com:YOUR_USER/CURRENT_REPO.git \fR
+> git remote add YOUR_USER git@github.com:YOUR_USER/CURRENT_REPO.git
 .
 .fi
 .
@@ -217,9 +197,9 @@ $ git remote add origin
 .
 .nf
 
-\fB$ git init -g
+$ git init \-g
 > git init
-> git remote add origin git@github.com:YOUR_USER/REPO.git \fR
+> git remote add origin git@github.com:YOUR_USER/REPO.git
 .
 .fi
 .
@@ -227,10 +207,10 @@ $ git remote add origin
 .
 .nf
 
-\fB$ git push origin,staging,qa bert_timeout
+$ git push origin,staging,qa bert_timeout
 > git push origin bert_timeout
 > git push staging bert_timeout
-> git push qa bert_timeout \fR
+> git push qa bert_timeout
 .
 .fi
 .
@@ -238,17 +218,44 @@ $ git remote add origin
 .
 .nf
 
-\fB$ git browse schacon/ticgit
-> open http://github.com/schacon/ticgit 
-$ git browse -p schacon/ticgit
+$ 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 https://github.com/schacon/ticgit
+
 $ git browse resque
 > open http://github.com/YOUR_USER/resque
 
-$ git browse -p resque
-> open https://github.com:YOUR_USER/resque
-\fR
+$ git browse resque network
+> open http://github.com/YOUR_USER/resque/network
+
+$ git browse \-p resque
+> open https://github.com/YOUR_USER/resque
+.
+.fi
+.
+.SS "git compare"
+.
+.nf
+
+$ 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
 .
 .fi
 .
@@ -256,10 +263,10 @@ $ git browse -p resque
 .
 .nf
 
-\fB$ git help
+$ git help
 > (improved git help)
 $ git help hub
-> (hub man page) \fR
+> (hub man page)
 .
 .fi
 .
@@ -270,4 +277,4 @@ $ git help hub
 Chris Wanstrath :: chris@ozmm.org :: @defunkt
 .
 .SH "SEE ALSO"
-git(1), git\-clone(1), git\-remote(1), git\-init(1),\fIhttp://github.com\fR, \fIhttp://github.com/defunkt/hub\fR
+git(1), git\-clone(1), git\-remote(1), git\-init(1), \fIhttp://github.com\fR, \fIhttp://github.com/defunkt/hub\fR