git-hub 1.0.3 → 1.1.0

data/HISTORY.md

@@ -1,3 +1,7 @@
+## 1.1.0 (2010-04-07)
+
+* `hub fork` command - Thanks Mislav!
+
 ## 1.0.3 (2010-03-10)
 
 * Bugfix: `hub remote` for repos with -, /, etc

data/README.md

@@ -125,6 +125,16 @@ superpowers:
     $ git remote add origin
     > git remote add origin git://github.com/YOUR_USER/CURRENT_REPO.git
 
+### git fork
+
+    $ git fork
+    ... hardcore forking action ...
+    > git remote add -f YOUR_USER git@github.com:YOUR_USER/CURRENT_REPO.git
+
+Forks the original repo on GitHub and adds the new remote under your
+username. It requires your GitHub token to be present; see "GitHub
+login" below for details.
+
 ### git init
 
     $ git init -g
@@ -177,7 +187,8 @@ If you see nothing, you need to set the config setting:
 
     $ git config --global github.user YOUR_USER
 
-See <http://github.com/guides/local-github-config> for more information.
+For commands that require write access to GitHub (such as `fork`), you'll want to
+setup "github.token" as well. See [local GitHub config guide][2] for more information.
 
 
 Configuration
@@ -243,3 +254,4 @@ Chris Wanstrath :: chris@ozmm.org :: @defunkt
 [0]: http://help.github.com/forking/
 [1]: http://github.com/defunkt/hub/issues
 [speed]: http://gist.github.com/284823
+[2]: http://github.com/guides/local-github-config

data/Rakefile

@@ -4,6 +4,7 @@ task :default => :test
 
 Rake::TestTask.new do |t|
   t.libs << 'lib'
+  t.ruby_opts << '-rubygems'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = false
 end

data/lib/hub/commands.rb

@@ -33,11 +33,14 @@ module Hub
 
     # 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.
@@ -112,7 +115,7 @@ module Hub
 
       ssh = args.delete('-p')
       url = ssh ? PRIVATE : PUBLIC
-      
+
       # user/repo
       args.last =~ /\b(.+?)(?:\/(.+))?$/
       user, repo = $1, $2 || REPO
@@ -147,6 +150,30 @@ module Hub
       end
     end
 
+    # $ hub fork
+    # ... hardcore forking action ...
+    # > git remote add -f YOUR_USER git@github.com:YOUR_USER/CURRENT_REPO.git
+    def fork(args)
+      require 'net/http'
+
+      # can't do anything without token and original owner name
+      if github_user && github_token && !OWNER.empty?
+        if own_repo_exists?
+          puts "#{github_user}/#{REPO} already exists on GitHub"
+        else
+          fork_repo
+        end
+
+        if args.include?('--no-remote')
+          exit
+        else
+          url = PRIVATE % [ github_user, REPO ]
+          args.replace %W"remote add -f #{github_user} #{url}"
+          args.after { puts "new remote: #{github_user}" }
+        end
+      end
+    end
+
     # $ hub push origin,staging cool-feature
     # > git push origin cool-feature
     # > git push staging cool-feature
@@ -350,6 +377,14 @@ help
       end
     end
 
+    def github_token
+      if TOKEN.empty?
+        abort "** No GitHub token set. See #{LGHCONF}"
+      else
+        TOKEN
+      end
+    end
+
     # Returns the terminal-formatted manpage, ready to be printed to
     # the screen.
     def hub_manpage
@@ -433,5 +468,22 @@ help
         write.close
       end
     end
+
+    # Determines whether the current user (you) has a fork of the
+    # current repo on GitHub.
+    #
+    # Returns a Boolean.
+    def own_repo_exists?
+      url = API_REPO % [USER, REPO]
+      Net::HTTPSuccess === Net::HTTP.get_response(URI(url))
+    end
+
+    # Forks the current repo using the GitHub API.
+    #
+    # Returns nothing.
+    def fork_repo
+      url = API_FORK % [OWNER, REPO]
+      Net::HTTP.post_form(URI(url), 'login' => USER, 'token' => TOKEN)
+    end
   end
 end

data/lib/hub/version.rb

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

data/man/hub.1

@@ -1,30 +1,31 @@
 .\" generated with Ron/v0.3
 .\" http://github.com/rtomayko/ron/
 .
-.TH "HUB" "1" "March 2010" "DEFUNKT" "Git Manual"
+.TH "HUB" "1" "April 2010" "DEFUNKT" "Git Manual"
 .
 .SH "NAME"
 \fBhub\fR \-\- git + hub = github
 .
 .SH "SYNOPSIS"
-\fBhub\fR \fICOMMAND\fR \fIOPTIONS\fR 
+\fBhub\fR \fICOMMAND\fR \fIOPTIONS\fR \fBhub alias\fR [\fB-s\fR] \fISHELL\fR
 .
-.br
-\fBhub alias\fR [\fB-s\fR] \fISHELL\fR 
+.P
+\fBgit init -g\fR \fIOPTIONS\fR
 .
 .br
+\fBgit clone\fR [\fB-p\fR] \fIOPTIONS\fR [\fIUSER\fR/]\fIREPOSITORY\fR \fIDIRECTORY\fR
 .
-.P
-\fBgit init -g\fR \fIOPTIONS\fR 
+.br
+\fBgit remote add\fR [\fB-p\fR] \fIOPTIONS\fR \fIUSER\fR[/\fIREPOSITORY\fR]
 .
 .br
-\fBgit clone\fR [\fB-p\fR] \fIOPTIONS\fR [\fIUSER\fR/]\fIREPOSITORY\fR \fIDIRECTORY\fR 
+\fBgit push\fR \fIREMOTE\-1\fR,\fIREMOTE\-2\fR,...,\fIREMOTE\-N\fR \fIREF\fR
 .
 .br
-\fBgit remote add\fR [\fB-p\fR] \fIOPTIONS\fR \fIUSER\fR[/\fIREPOSITORY\fR] 
+\fBgit fork\fR
 .
 .br
-\fBgit browse\fR [\fB-p\fR] [\fIUSER\fR/]\fIREPOSITORY\fR 
+\fBgit browse\fR [\fB-p\fR] [\fIUSER\fR/]\fIREPOSITORY\fR
 .
 .br
 \fBgit submodule add\fR [\fB-p\fR] \fIOPTIONS\fR [\fIUSER\fR/]\fIREPOSITORY\fR \fIDIRECTORY\fR
@@ -34,53 +35,93 @@
 alias command displays information on configuring your environment:
 .
 .TP
-\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: \fBeval $(hub alias -s bash)\fR 
+\fBhub alias\fR [\fB-s\fR] \fISHELL\fR:
 .
-.P
-After configuring the alias, the following commands have superpowers:
+.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
 .
 .TP
-\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.
+\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.
+
 .
 .TP
-\fBgit clone\fR [\fB-p\fR] \fIOPTIONS\fR [\fIUSER\fR\fB/\fR]\fIREPOSITORY\fR \fIDIRECTORY\fR 
+\fBgit clone\fR [\fB-p\fR] \fIOPTIONS\fR [\fIUSER\fR\fB/\fR]\fIREPOSITORY\fR \fIDIRECTORY\fR:
+.
+.br
 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
 "git@github.com:\fIUSER\fR/\fIREPOSITORY\fR.git".
+
 .
 .TP
-\fBgit remote add\fR [\fB-p\fR] \fIOPTIONS\fR \fIUSER\fR[\fB/\fR\fIREPOSITORY\fR]
+\fBgit remote add\fR [\fB-p\fR] \fIOPTIONS\fR \fIUSER\fR[\fB/\fR\fIREPOSITORY\fR]:
+.
+.br
 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
 "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 
+\fBgit push\fR \fIREMOTE\-1\fR,\fIREMOTE\-2\fR,...,\fIREMOTE\-N\fR \fIREF\fR:
+.
+.br
 Push \fIREF\fR to each of \fIREMOTE\-1\fR through \fIREMOTE\-N\fR by executing
 multiple \fBgit push\fR commands.
+
 .
 .TP
-\fBgit browse\fR [\fB-p\fR] [[\fIUSER\fR\fB/\fR]\fIREPOSITORY\fR]
+\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
 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
 page with https. If the repository isn't specified, \fBbrowse\fR opens
 the page of the repository found in the current directory.
+
 .
 .TP
-\fBgit submodule add\fR [\fB-p\fR] \fIOPTIONS\fR [\fIUSER\fR/]\fIREPOSITORY\fR \fIDIRECTORY\fR 
+\fBgit submodule add\fR [\fB-p\fR] \fIOPTIONS\fR [\fIUSER\fR/]\fIREPOSITORY\fR \fIDIRECTORY\fR:
+.
+.br
 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
 "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).
+
 .
 .TP
-\fBgit help\fR
+\fBgit help\fR:
+.
+.br
 Display enhanced git\-help(1).
+
 .
 .SH "CONFIGURATION"
 Use git\-config(1) to display the currently configured GitHub username:
@@ -96,13 +137,14 @@ Use git\-config(1) to display the currently configured GitHub username:
 .IP "" 0
 .
 .P
-Or, set the GitHub username with:
+Or, set the GitHub username and token with:
 .
 .IP "" 4
 .
 .nf
 
-\fB$ git config --global github.user <username> \fR
+\fB$ git config --global github.user <username>
+$ git config --global github.token <token> \fR
 .
 .fi
 .
@@ -161,6 +203,16 @@ $ git remote add origin
 .
 .fi
 .
+.SS "git fork"
+.
+.nf
+
+\fB$ git fork
+... hardcore forking action ...
+> git remote add YOUR_USER git@github.com:YOUR_USER/CURRENT_REPO.git \fR
+.
+.fi
+.
 .SS "git init"
 .
 .nf

data/man/hub.1.html

@@ -66,14 +66,15 @@
 <p><code>hub</code> -- git + hub = github</p>
 <h2>SYNOPSIS</h2>
 
-<p><code>hub</code> <var>COMMAND</var> <var>OPTIONS</var> <br>
-<code>hub alias</code> [<code>-s</code>] <var>SHELL</var> <br>
-</p>
-
-<p><code>git init -g</code> <var>OPTIONS</var> <br>
-<code>git clone</code> [<code>-p</code>] <var>OPTIONS</var> [<var>USER</var>/]<var>REPOSITORY</var> <var>DIRECTORY</var> <br>
-<code>git remote add</code> [<code>-p</code>] <var>OPTIONS</var> <var>USER</var>[/<var>REPOSITORY</var>] <br>
-<code>git browse</code> [<code>-p</code>] [<var>USER</var>/]<var>REPOSITORY</var> <br>
+<p><code>hub</code> <var>COMMAND</var> <var>OPTIONS</var>
+<code>hub alias</code> [<code>-s</code>] <var>SHELL</var></p>
+
+<p><code>git init -g</code> <var>OPTIONS</var><br>
+<code>git clone</code> [<code>-p</code>] <var>OPTIONS</var> [<var>USER</var>/]<var>REPOSITORY</var> <var>DIRECTORY</var><br>
+<code>git remote add</code> [<code>-p</code>] <var>OPTIONS</var> <var>USER</var>[/<var>REPOSITORY</var>]<br>
+<code>git push</code> <var>REMOTE-1</var>,<var>REMOTE-2</var>,...,<var>REMOTE-N</var> <var>REF</var><br>
+<code>git fork</code><br>
+<code>git browse</code> [<code>-p</code>] [<var>USER</var>/]<var>REPOSITORY</var><br>
 <code>git submodule add</code> [<code>-p</code>] <var>OPTIONS</var> [<var>USER</var>/]<var>REPOSITORY</var> <var>DIRECTORY</var></p>
 
 <h2>DESCRIPTION</h2>
@@ -83,59 +84,67 @@ alias command displays information on configuring your environment:</p>
 
 <dl>
 <dt>
-<code>hub alias</code> [<code>-s</code>] <var>SHELL</var>
-</dt>
-<dd>Writes shell aliasing code for <var>SHELL</var> (<code>bash</code>, <code>sh</code>, <code>zsh</code>,
+<code>hub alias</code> [<code>-s</code>] <var>SHELL</var>:<br>
+Writes shell aliasing code for <var>SHELL</var> (<code>bash</code>, <code>sh</code>, <code>zsh</code>,
 <code>csh</code>) to standard output. With the <code>-s</code> option, the output of
-this command can be evaluated directly within the shell:
-<code>eval $(hub alias -s bash)</code>
-</dd>
-</dl>
-
-
-<p>After configuring the alias, the following commands have superpowers:</p>
-
-<dl>
+this command can be evaluated directly within the shell</dt>
+<dd><p><code>eval $(hub alias -s bash)</code></p></dd>
 <dt>
-<code>git init</code> <code>-g</code> <var>OPTIONS</var>
-</dt>
-<dd><p>Create a git repository as with git-init(1) and add remote <code>origin</code> at
-"git@github.com:<var>USER</var>/<var>REPOSITORY</var>.git"; <var>USER</var> is your GitHub username and
-<var>REPOSITORY</var> is the current working directory's basename.</p></dd>
+<code>git init</code> <code>-g</code> <var>OPTIONS</var>:<br>
+ Create a git repository as with git-init(1) and add remote <code>origin</code> at
+ "git@github.com:<var>USER</var>/<var>REPOSITORY</var>.git"; <var>USER</var> is your GitHub username and
+ <var>REPOSITORY</var> is the current working directory's basename.</dt>
+<dd><p></p></dd>
 <dt>
-<code>git clone</code> [<code>-p</code>] <var>OPTIONS</var> [<var>USER</var><code>/</code>]<var>REPOSITORY</var> <var>DIRECTORY</var>
-</dt>
-<dd><p>Clone repository "git://github.com/<var>USER</var>/<var>REPOSITORY</var>.git" into
+<code>git clone</code> [<code>-p</code>] <var>OPTIONS</var> [<var>USER</var><code>/</code>]<var>REPOSITORY</var> <var>DIRECTORY</var>:<br>
+Clone repository "git://github.com/<var>USER</var>/<var>REPOSITORY</var>.git" into
 <var>DIRECTORY</var> as with git-clone(1). When <var>USER</var>/ is omitted, assumes
 your GitHub login. With <code>-p</code>, use private remote
-"git@github.com:<var>USER</var>/<var>REPOSITORY</var>.git".</p></dd>
+"git@github.com:<var>USER</var>/<var>REPOSITORY</var>.git".</dt>
+<dd><p></p></dd>
 <dt>
-<code>git remote add</code> [<code>-p</code>] <var>OPTIONS</var> <var>USER</var>[<code>/</code><var>REPOSITORY</var>]</dt>
-<dd><p>Add remote "git://github.com/<var>USER</var>/<var>REPOSITORY</var>.git" as with
+<code>git remote add</code> [<code>-p</code>] <var>OPTIONS</var> <var>USER</var>[<code>/</code><var>REPOSITORY</var>]:<br>
+Add remote "git://github.com/<var>USER</var>/<var>REPOSITORY</var>.git" as with
 git-remote(1). When /<var>REPOSITORY</var> is omitted, the basename of the
 current working directory is used. With <code>-p</code>, use private remote
 "git@github.com:<var>USER</var>/<var>REPOSITORY</var>.git". If <var>USER</var> is "origin"
-then uses your GitHub login.</p></dd>
+then uses your GitHub login.</dt>
+<dd><p></p></dd>
+<dt>
+<code>git push</code> <var>REMOTE-1</var>,<var>REMOTE-2</var>,...,<var>REMOTE-N</var> <var>REF</var>:<br>
+Push <var>REF</var> to each of <var>REMOTE-1</var> through <var>REMOTE-N</var> by executing
+multiple <code>git push</code> commands.</dt>
+<dd><p></p></dd>
 <dt>
-<code>git push</code> <var>REMOTE-1</var>,<var>REMOTE-2</var>,...,<var>REMOTE-N</var> <var>REF</var>
-</dt>
-<dd><p>Push <var>REF</var> to each of <var>REMOTE-1</var> through <var>REMOTE-N</var> by executing
-multiple <code>git push</code> commands.</p></dd>
+<code>git fork</code>:<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.</dt>
+<dd><p></p></dd>
 <dt>
-<code>git browse</code> [<code>-p</code>] [[<var>USER</var><code>/</code>]<var>REPOSITORY</var>]</dt>
-<dd><p>Open repository's GitHub page in the system's default web browser
+<code>git browse</code> [<code>-p</code>] [[<var>USER</var><code>/</code>]<var>REPOSITORY</var>]:<br>
+Open repository's GitHub page in the system's default web browser
 using <code>open(1)</code> or the <code>BROWSER</code> env variable. Use <code>-p</code> to open a
 page with https. If the repository isn't specified, <code>browse</code> opens
-the page of the repository found in the current directory.</p></dd>
+the page of the repository found in the current directory.</dt>
+<dd><p></p></dd>
 <dt>
-<code>git submodule add</code> [<code>-p</code>] <var>OPTIONS</var> [<var>USER</var>/]<var>REPOSITORY</var> <var>DIRECTORY</var>
-</dt>
-<dd><p>Submodule repository "git://github.com/<var>USER</var>/<var>REPOSITORY</var>.git" into
+<code>git submodule add</code> [<code>-p</code>] <var>OPTIONS</var> [<var>USER</var>/]<var>REPOSITORY</var> <var>DIRECTORY</var>:<br>
+Submodule repository "git://github.com/<var>USER</var>/<var>REPOSITORY</var>.git" into
 <var>DIRECTORY</var> as with git-submodule(1). When <var>USER</var>/ is omitted, assumes
 your GitHub login. With <code>-p</code>, use private remote
-"git@github.com:<var>USER</var>/<var>REPOSITORY</var>.git".</p></dd>
-<dt><code>git help</code></dt>
-<dd><p>Display enhanced git-help(1).</p></dd>
+"git@github.com:<var>USER</var>/<var>REPOSITORY</var>.git".</dt>
+<dd><p></p></dd>
+<dt>
+<code>git fork</code> [<code>--no-remote</code>]:<br>
+Forks the original project (as specified in "origin" remote) on GitHub
+and adds a new remote named <var>USER</var> referencing the newly created repo.
+Requires <code>github.token</code> to be set (see CONFIGURATION).</dt>
+<dd><p></p></dd>
+<dt>
+<code>git help</code>:<br>
+Display enhanced git-help(1).</dt>
+<dd><p></p></dd>
 </dl>
 
 
@@ -146,9 +155,10 @@ your GitHub login. With <code>-p</code>, use private remote
 <pre><code>$ git config --global github.user
 </code></pre>
 
-<p>Or, set the GitHub username with:</p>
+<p>Or, set the GitHub username and token with:</p>
 
 <pre><code>$ git config --global github.user &lt;username&gt;
+$ git config --global github.token &lt;token&gt;
 </code></pre>
 
 <p>See <a href="http://github.com/guides/local-github-config">http://github.com/guides/local-github-config</a> for more
@@ -189,6 +199,13 @@ $ git remote add origin
 &gt; git remote add origin git://github.com/YOUR_USER/CURRENT_REPO.git
 </code></pre>
 
+<h3>git fork</h3>
+
+<pre><code>$ git fork
+... hardcore forking action ...
+&gt; git remote add YOUR_USER git@github.com:YOUR_USER/CURRENT_REPO.git
+</code></pre>
+
 <h3>git init</h3>
 
 <pre><code>$ git init -g
@@ -243,7 +260,7 @@ $ git help hub
 
 <ol class='foot man'>
   <li class='tl'>DEFUNKT</li>
-  <li class='tc'>March 2010</li>
+  <li class='tc'>April 2010</li>
   <li class='tr'>hub(1)</li>
 </ol>
 

data/man/hub.1.ron

@@ -3,63 +3,73 @@ hub(1) -- git + hub = github
 
 ## SYNOPSIS
 
-`hub` <COMMAND> <OPTIONS>   
-`hub alias` [`-s`] <SHELL>   
+`hub` <COMMAND> <OPTIONS>
+`hub alias` [`-s`] <SHELL>
 
-`git init -g` <OPTIONS>   
-`git clone` [`-p`] <OPTIONS> [<USER>/]<REPOSITORY> <DIRECTORY>   
-`git remote add` [`-p`] <OPTIONS> <USER>[/<REPOSITORY>]   
-`git browse` [`-p`] [<USER>/]<REPOSITORY>   
-`git submodule add` [`-p`] <OPTIONS> [<USER>/]<REPOSITORY> <DIRECTORY>
+`git init -g` <OPTIONS>  
+`git clone` [`-p`] <OPTIONS> [<USER>/]<REPOSITORY> <DIRECTORY>  
+`git remote add` [`-p`] <OPTIONS> <USER>[/<REPOSITORY>]  
+`git push` <REMOTE-1>,<REMOTE-2>,...,<REMOTE-N> <REF>  
+`git fork`  
+`git browse` [`-p`] [<USER>/]<REPOSITORY>  
+`git submodule add` [`-p`] <OPTIONS> [<USER>/]<REPOSITORY> <DIRECTORY>  
 
 ## DESCRIPTION
 
 `hub` enhances various `git` commands with GitHub remote expansion. The
 alias command displays information on configuring your environment:
 
-  * `hub alias` [`-s`] <SHELL>:
+  * `hub alias` [`-s`] <SHELL>:  
     Writes shell aliasing code for <SHELL> (`bash`, `sh`, `zsh`,
     `csh`) to standard output. With the `-s` option, the output of
     this command can be evaluated directly within the shell:
     `eval $(hub alias -s bash)`
 
-After configuring the alias, the following commands have superpowers:
-
-  * `git init` `-g` <OPTIONS>:
+ * `git init` `-g` <OPTIONS>:  
     Create a git repository as with git-init(1) and add remote `origin` at
     "git@github.com:<USER>/<REPOSITORY>.git"; <USER> is your GitHub username and
     <REPOSITORY> is the current working directory's basename.
 
-  * `git clone` [`-p`] <OPTIONS> [<USER>`/`]<REPOSITORY> <DIRECTORY>:
+  * `git clone` [`-p`] <OPTIONS> [<USER>`/`]<REPOSITORY> <DIRECTORY>:  
     Clone repository "git://github.com/<USER>/<REPOSITORY>.git" into
     <DIRECTORY> as with git-clone(1). When <USER>/ is omitted, assumes
     your GitHub login. With `-p`, use private remote
     "git@github.com:<USER>/<REPOSITORY>.git".
 
-  * `git remote add` [`-p`] <OPTIONS> <USER>[`/`<REPOSITORY>]:
+  * `git remote add` [`-p`] <OPTIONS> <USER>[`/`<REPOSITORY>]:  
     Add remote "git://github.com/<USER>/<REPOSITORY>.git" as with
     git-remote(1). When /<REPOSITORY> is omitted, the basename of the
     current working directory is used. With `-p`, use private remote
     "git@github.com:<USER>/<REPOSITORY>.git". If <USER> is "origin"
     then uses your GitHub login.
 
-  * `git push` <REMOTE-1>,<REMOTE-2>,...,<REMOTE-N> <REF>:
+  * `git push` <REMOTE-1>,<REMOTE-2>,...,<REMOTE-N> <REF>:  
     Push <REF> to each of <REMOTE-1> through <REMOTE-N> by executing
     multiple `git push` commands.
 
-  * `git browse` [`-p`] [[<USER>`/`]<REPOSITORY>]:
+  * `git fork`:  
+    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.
+
+  * `git browse` [`-p`] [[<USER>`/`]<REPOSITORY>]:  
     Open repository's GitHub page in the system's default web browser
     using `open(1)` or the `BROWSER` env variable. Use `-p` to open a
     page with https. If the repository isn't specified, `browse` opens
     the page of the repository found in the current directory.
 
-  * `git submodule add` [`-p`] <OPTIONS> [<USER>/]<REPOSITORY> <DIRECTORY>:
+  * `git submodule add` [`-p`] <OPTIONS> [<USER>/]<REPOSITORY> <DIRECTORY>:  
     Submodule repository "git://github.com/<USER>/<REPOSITORY>.git" into
     <DIRECTORY> as with git-submodule(1). When <USER>/ is omitted, assumes
     your GitHub login. With `-p`, use private remote
     "git@github.com:<USER>/<REPOSITORY>.git".
 
-  * `git help`:
+  * `git fork` [`--no-remote`]:  
+    Forks the original project (as specified in "origin" remote) on GitHub
+    and adds a new remote named <USER> referencing the newly created repo.
+    Requires `github.token` to be set (see CONFIGURATION).
+
+  * `git help`:  
     Display enhanced git-help(1).
 
 ## CONFIGURATION
@@ -68,9 +78,10 @@ Use git-config(1) to display the currently configured GitHub username:
 
     $ git config --global github.user
 
-Or, set the GitHub username with:
+Or, set the GitHub username and token with:
 
     $ git config --global github.user <username>
+    $ git config --global github.token <token>
 
 See <http://github.com/guides/local-github-config> for more
 information.
@@ -107,6 +118,12 @@ cloning:
     $ git remote add origin
     > git remote add origin git://github.com/YOUR_USER/CURRENT_REPO.git
 
+### git fork
+
+    $ git fork
+    ... hardcore forking action ...
+    > git remote add YOUR_USER git@github.com:YOUR_USER/CURRENT_REPO.git
+
 ### git init
 
     $ git init -g

data/test/helper.rb

@@ -1,4 +1,10 @@
 require 'test/unit'
+
+begin
+  require 'redgreen'
+rescue LoadError
+end
+
 $LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'hub'
 require 'hub/standalone'
@@ -26,16 +32,22 @@ class Test::Unit::TestCase
   # If a block is given it will be run in the child process before
   # execution begins. You can use this to monkeypatch or fudge the
   # environment before running hub.
-  def hub(args)
+  def hub(args, input = nil)
     parent_read, child_write = IO.pipe
+    child_read, parent_write = IO.pipe if input
 
     fork do
       yield if block_given?
+      $stdin.reopen(child_read) if input
       $stdout.reopen(child_write)
       $stderr.reopen(child_write)
       Hub(args).execute
     end
-
+    
+    if input
+      parent_write.write input
+      parent_write.close
+    end
     child_write.close
     parent_read.read
   end

data/test/hub_test.rb

@@ -1,10 +1,14 @@
 $LOAD_PATH.unshift File.dirname(__FILE__)
 require 'helper'
+require 'webmock/test_unit'
 
 class HubTest < Test::Unit::TestCase
+  include WebMock
+
   def setup
     Hub::Commands::REPO.replace("hub")
     Hub::Commands::USER.replace("tpw")
+    Hub::Commands::TOKEN.replace("abc123")
     Hub::Commands::OWNER.replace("defunkt")
   end
 
@@ -197,6 +201,37 @@ class HubTest < Test::Unit::TestCase
     assert_equal "git push staging cool-feature; git push qa cool-feature", h.after
   end
 
+  def test_fork
+    stub_request(:get, "github.com/api/v2/yaml/repos/show/tpw/hub").
+      to_return(:status => 404)
+    stub_request(:post, "github.com/api/v2/yaml/repos/fork/defunkt/hub").with { |req|
+      params = Hash[*req.body.split(/[&=]/)]
+      params == { 'login'=>'tpw', 'token'=>'abc123' }
+    }
+
+    expected = "remote add -f tpw git@github.com:tpw/hub.git\n"
+    expected << "new remote: tpw\n"
+    assert_equal expected, hub("fork") { ENV['GIT'] = 'echo' }
+  end
+
+  def test_fork_no_remote
+    stub_request(:get, "github.com/api/v2/yaml/repos/show/tpw/hub").
+      to_return(:status => 404)
+    stub_request(:post, "github.com/api/v2/yaml/repos/fork/defunkt/hub")
+
+    assert_equal "", hub("fork --no-remote") { ENV['GIT'] = 'echo' }
+  end
+
+  def test_fork_already_exists
+    stub_request(:get, "github.com/api/v2/yaml/repos/show/tpw/hub").
+      to_return(:status => 200)
+
+    expected = "tpw/hub already exists on GitHub\n"
+    expected << "remote add -f tpw git@github.com:tpw/hub.git\n"
+    expected << "new remote: tpw\n"
+    assert_equal expected, hub("fork") { ENV['GIT'] = 'echo' }
+  end
+
   def test_version
     out = hub('--version')
     assert_includes "git version", out
@@ -244,7 +279,8 @@ config
   end
 
   def test_hub_open_private
-    assert_command "browse -p bmizerany/sinatra", "open https://github.com/bmizerany/sinatra"
+    assert_command "browse -p bmizerany/sinatra",
+      "open https://github.com/bmizerany/sinatra"
   end
 
   def test_hub_open_self

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: git-hub
 version: !ruby/object:Gem::Version 
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors: 
 - Chris Wanstrath
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-10 00:00:00 -08:00
+date: 2010-04-07 00:00:00 -07:00
 default_executable: hub
 dependencies: []