git-hub 0.1.2 → 0.1.3

data/HISTORY.md

@@ -1,3 +1,11 @@
+## 0.1.3 (2009-12-11)
+
+* Homebrew!
+* Fix inaccuracy in man page
+* Better help arrangement
+* Bugfix: Path problems in standalone.rb
+* Bugfix: Standalone not loaded by default
+
 ## 0.1.2 (2009-12-10)
 
 * Fixed README typos

data/README.md

@@ -44,6 +44,10 @@ Assuming `~/bin/` is in your `$PATH`, you're ready to roll:
     git version 1.6.4.2
     hub version 0.1.0
 
+### Homebrew
+
+  brew install hub
+
 ### RubyGems
 
 Though not recommended, `hub` can also be installed as a RubyGem:
@@ -58,8 +62,7 @@ You can also install from source:
 
     $ git clone git://github.com/defunkt/hub.git
     $ cd hub
-    $ rake standalone
-    $ cp hub /usr/local/bin/
+    $ rake install prefix=/usr/local
 
 
 Aliasing
@@ -123,6 +126,8 @@ superpowers:
 
     $ git help
     > (improved git help)
+    $ git help hub
+    > (hub man page)
 
 
 GitHub Login

data/Rakefile

@@ -18,13 +18,19 @@ desc "Build a gem"
 task :gem => [ :gemspec, :build ]
 
 desc "Build standalone script"
-task :standalone => [ :test, :load_hub ] do
+task :standalone => :load_hub do
+  require 'hub/standalone'
   Hub::Standalone.save('hub')
 end
 
 desc "Build hub manual"
-task 'man' do
-  sh "ron -br5 -m --organization=DEFUNKT --manual='Git Manual' man/*.ron"
+task :build_man do
+  sh "ron -br5 --organization=DEFUNKT --manual='Git Manual' man/*.ron"
+end
+
+desc "Show hub manual"
+task :man => :build_man do
+  exec "man man/hub.1"
 end
 
 task :load_hub do
@@ -71,6 +77,27 @@ rescue LoadError
   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
+end
+
+# Remove jewelers install task
+Rake.application.remove_task(:install)
+
+desc "Install standalone script and man pages"
+task :install => :standalone do
+  prefix = ENV['PREFIX'] || ENV['prefix'] || '/usr/local'
+
+  FileUtils.mkdir_p "#{prefix}/bin"
+  FileUtils.cp "hub", "#{prefix}/bin"
+
+  FileUtils.mkdir_p "#{prefix}/share/man/man1"
+  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}"
@@ -82,10 +109,13 @@ task :publish => [ :test, :gemspec, :build ] do
 end
 
 desc "Publish to GitHub Pages"
-task :pages => [ :check_dirty, :standalone ] do
+task :pages => [ :build_man, :check_dirty, :standalone ] do
+  cp "man/hub.1.html", "html"
   `git checkout gh-pages`
   `mv hub standalone`
   `git add standalone*`
+  `mv html hub.1.html`
+  `git add hub.1.html`
   `git commit -m "update standalone"`
   `git push origin gh-pages`
   `git checkout master`

data/lib/hub/commands.rb

@@ -162,35 +162,37 @@ usage: git [--version] [--exec-path[=GIT_EXEC_PATH]] [--html-path]
     [-p|--paginate|--no-pager] [--bare] [--git-dir=GIT_DIR]
     [--work-tree=GIT_WORK_TREE] [--help] COMMAND [ARGS]
 
-Creating a git repository:
-   clone      Clone a repository into a new directory
+Basic Commands:
    init       Create an empty git repository or reinitialize an existing one
-
-Working with content:
-   add        Add file contents to the index
-   branch     List, create, or delete branches
-   checkout   Checkout a branch or paths to the working tree
+   add        Add new or modified files to the staging area
+   rm         Remove files from the working directory and staging area
+   mv         Move or rename a file, a directory, or a symlink
+   status     Show the status of the working directory and staging area
    commit     Record changes to the repository
+
+History Commands:
+   log        Show the commit history log
    diff       Show changes between commits, commit and working tree, etc
-   log        Show commit logs
-   merge      Join two or more development histories together
-   mv         Move or rename a file, a directory, or a symlink
-   rm         Remove files from the working tree and from the index
-   status     Show the working tree status
-   show       Show various types of objects
-   tag        Create, list, delete or verify a tag object signed with GPG
+   show       Show information about commits, tags or files
+
+Branching Commands:
+   branch     List, create, or delete branches
+   checkout   Switch the active branch to another branch
+   merge      Join two or more development histories (branches) together
+   tag        Create, list, delete, sign or verify a tag object
 
-Over the network:
-   fetch      Download objects and refs from another repository
+Remote Commands:
+   clone      Clone a remote repository into a new directory
+   fetch      Download data, tags and branches from a remote repository
    pull       Fetch from and merge with another repository or a local branch
-   push       Update remote refs along with associated objects
-   remote     Manage a set of tracked repositories
+   push       Upload data, tags and branches to a remote repository
+   remote     View and manage a set of remote repositories
 
 Advanced commands:
+   reset      Reset your staging area or working directory to another point
+   rebase     Re-apply a series of patches in one branch onto another
    bisect     Find by binary search the change that introduced a bug
-   grep       Print lines matching a pattern
-   reset      Reset current HEAD to the specified state
-   rebase     Forward-port local commits to the updated upstream head
+   grep       Print files with lines matching a pattern in your codebase
 
 See 'git help COMMAND' for more information on a specific command.
 help

data/lib/hub/standalone.rb

@@ -2,7 +2,7 @@ module Hub
   module Standalone
     extend self
 
-    PREAMBLE = <<-premable
+    PREAMBLE = <<-preamble
 #!/usr/bin/env ruby
 #
 # This file, hub, is generated code.
@@ -14,10 +14,11 @@ module Hub
 # that build hub.
 #
 
-premable
+preamble
 
     POSTAMBLE = "Hub::Runner.execute(*ARGV)\n"
-    MANPAGE   = "__END__\n#{File.read('man/hub.1')}"
+    __DIR__   = File.dirname(__FILE__)
+    MANPAGE   = "__END__\n#{File.read(__DIR__ + '/../../man/hub.1')}"
 
     def save(filename, path = '.')
       target = File.join(File.expand_path(path), filename)

data/lib/hub/version.rb

@@ -1,3 +1,3 @@
 module Hub
-  Version = '0.1.2'
+  Version = '0.1.3'
 end

data/lib/hub.rb

@@ -2,4 +2,3 @@ require 'hub/version'
 require 'hub/args'
 require 'hub/commands'
 require 'hub/runner'
-require 'hub/standalone'

data/man/hub.1

@@ -16,11 +16,13 @@
 \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]
 .
+.br
+.
 .SH "DESCRIPTION"
 \fBhub\fR enhances various \fBgit\fR commands with GitHub remote expansion. The
 alias command displays information on configuring your environment:
@@ -39,10 +41,10 @@ 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 
-Clone repository "git://github.com/\fIUSER\fR/\fIREPOSITORY\fR.git" into \fIDIRECTORY\fR as with git\-clone(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".
+\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
+"git@github.com:\fIUSER\fR/\fIREPOSITORY\fR.git".
 .
 .TP
 \fBgit remote add\fR [\fB\-p\fR] \fIOPTIONS\fR \fIUSER\fR[\fB/\fR\fIREPOSITORY\fR]

data/man/hub.1.html

@@ -0,0 +1,157 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ron/v0.3'>
+  <title>hub(1) -- git + hub = github</title>
+  <style type='text/css'>
+    body {margin:0}
+    #man, #man code, #man pre, #man tt, #man kbd, #man samp {
+      font-family:consolas,monospace;
+      font-size:16px;
+      line-height:1.3;
+      color:#343331;
+      background:#fff; }
+    #man { max-width:89ex; text-align:justify; margin:0 25px 25px 25px }
+    #man h1, #man h2, #man h3 { color:#232221;clear:left }
+    #man h1 { font-size:28px; margin:15px 0 30px 0; text-align:center }
+    #man h2 { font-size:18px; margin-bottom:0; margin-top:10px; line-height:1.3; }
+    #man h3 { font-size:16px; margin:0 0 0 4ex; }
+    #man p, #man ul, #man ol, #man dl, #man pre { margin:0 0 18px 0; }
+    #man pre {
+      color:#333231;
+      background:#edeceb;
+      padding:5px 7px;
+      margin:0px 0 20px 0;
+      border-left:2ex solid #ddd}
+    #man pre + h2, #man pre + h3 {
+      margin-top:22px;
+    }
+    #man h2 + pre, #man h3 + pre {
+      margin-top:5px;
+    }
+    #man > p, #man > ul, #man > ol, #man > dl, #man > pre { margin-left:8ex; }
+    #man dt { margin:0; clear:left }
+    #man dt.flush { float:left; width:8ex }
+    #man dd { margin:0 0 0 9ex }
+    #man code, #man strong, #man b { font-weight:bold; color:#131211; }
+    #man pre code { font-weight:normal; color:#232221; background:inherit }
+    #man em, var, u {
+      font-style:normal; color:#333231; border-bottom:1px solid #999; }
+    #man h1.man-title { display:none; }
+    #man ol.man, #man ol.man li { margin:2px 0 10px 0; padding:0;
+      float:left; width:33%; list-style-type:none;
+      text-transform:uppercase; font-size:18px; color:#999;
+      letter-spacing:1px;}
+    #man ol.man { width:100%; }
+    #man ol.man li.tl { text-align:left }
+    #man ol.man li.tc { text-align:center;letter-spacing:4px }
+    #man ol.man li.tr { text-align:right }
+    #man ol.man a { color:#999 }
+    #man ol.man a:hover { color:#333231 }
+  </style>
+</head>
+<body>
+<div id='man'>
+
+<h1 class='man-title'>hub(1)</h1>
+
+<ol class='head man'>
+  <li class='tl'>hub(1)</li>
+  <li class='tc'>Git Manual</li>
+  <li class='tr'>hub(1)</li>
+</ol>
+
+<h2 id='NAME'>NAME</h2>
+<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></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>
+</p>
+
+<h2>DESCRIPTION</h2>
+
+<p><code>hub</code> enhances various <code>git</code> commands with GitHub remote expansion. The
+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>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>
+<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>
+<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
+<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>
+<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
+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".</p></dd>
+<dt><code>git help</code></dt>
+<dd><p>Display enhanced git-help(1).</p></dd>
+</dl>
+
+
+<h2>CONFIGURATION</h2>
+
+<p>Use git-config(1) to display the currently configured GitHub username:</p>
+
+<pre><code>$ git config --global github.user
+</code></pre>
+
+<p>Or, set the GitHub username with:</p>
+
+<pre><code>$ git config --global github.user &lt;username&gt;
+</code></pre>
+
+<p>See <a href="http://github.com/guides/local-github-config">http://github.com/guides/local-github-config</a> for more information.</p>
+
+<h2>BUGS</h2>
+
+<p><a href="http://github.com/defunkt/hub/issues">http://github.com/defunkt/hub/issues</a></p>
+
+<h2>AUTHOR</h2>
+
+<p>Chris Wanstrath :: chris@ozmm.org :: @defunkt</p>
+
+<h2>SEE ALSO</h2>
+
+<p>git(1), git-clone(1), git-remote(1), git-init(1),
+<a href="http://github.com">http://github.com</a>,
+<a href="http://github.com/defunkt/hub">http://github.com/defunkt/hub</a></p>
+
+<ol class='foot man'>
+  <li class='tl'>DEFUNKT</li>
+  <li class='tc'>December 2009</li>
+  <li class='tr'>hub(1)</li>
+</ol>
+
+</div>
+</body>
+</html>

data/man/hub.1.ron

@@ -7,8 +7,8 @@ hub(1) -- git + hub = github
 `hub alias` [`-s`] <SHELL>
 
 `git init -g` <OPTIONS>  
-`git clone` [`-p`] <OPTIONS> <USER>[/<REPOSITORY>] <DIRECTORY>  
-`git remote add` [`-p`] <OPTIONS> <USER>[/<REPOSITORY>]
+`git clone` [`-p`] <OPTIONS> [<USER>/]<REPOSITORY> <DIRECTORY>  
+`git remote add` [`-p`] <OPTIONS> <USER>[/<REPOSITORY>]  
 
 ## DESCRIPTION
 
@@ -28,11 +28,11 @@ After configuring the alias, the following commands have superpowers:
     "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 /<REPOSITORY> is omitted, the
-    basename of the current working directory is used. With `-p`, use private
-    remote "git@github.com:<USER>/<REPOSITORY>.git".
+    <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>]:
     Add remote "git://github.com/<USER>/<REPOSITORY>.git" as with

data/test/helper.rb

@@ -1,6 +1,7 @@
 require 'test/unit'
 $LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 require 'hub'
+require 'hub/standalone'
 
 class Test::Unit::TestCase
   # Shortcut for creating a `Hub` instance. Pass it what you would

data/test/hub_test.rb

@@ -101,7 +101,7 @@ class HubTest < Test::Unit::TestCase
   def test_help_hub
     help_manpage = hub("help hub")
     assert_includes "git + hub = github", help_manpage
-    assert_includes "Writes shell aliasing code for", help_manpage
+    assert_includes "Writes shell aliasing code", help_manpage
     assert_includes "Chris Wanstrath :: chris@ozmm.org", help_manpage
     assert_includes <<-config, help_manpage
 Use git-config(1) to display the currently configured GitHub username:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: git-hub
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Chris Wanstrath
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-10 00:00:00 -08:00
+date: 2009-12-11 00:00:00 -08:00
 default_executable: hub
 dependencies: []
 
@@ -37,6 +37,7 @@ files:
 - lib/hub/standalone.rb
 - lib/hub/version.rb
 - man/hub.1
+- man/hub.1.html
 - man/hub.1.ron
 - test/alias_test.rb
 - test/helper.rb