git-hub 0.1.1 → 0.1.2

data/.gitignore

@@ -1,4 +1,2 @@
-pkg/
 *.swp
 *~
-*.gemspec

data/HISTORY.md

@@ -0,0 +1,14 @@
+## 0.1.2 (2009-12-10)
+
+* Fixed README typos
+* Better standalone install line
+* Added man page
+* Added `hub help hub`
+
+## 0.1.1 (2009-12-08)
+
+* Fixed gem problems
+
+## 0.1.0 (2009-12-08)
+
+* First release

data/README.md

@@ -25,7 +25,7 @@ Wrapping `git`:
     Receiving objects: 100% (4005/4005), 785.82 KiB | 129 KiB/s, done.
     Resolving deltas: 100% (2505/2505), done.
 
-hub requires you have `git` installed and in your path. It also
+hub requires you have `git` installed and in your `$PATH`. It also
 requires Ruby 1.8.6+ or Ruby 1.9.1+. No other libraries necessary.
 
 
@@ -36,17 +36,17 @@ Install
 
 `hub` is most easily installed as a standalone script:
 
-    curl http://defunkt.github.com/hub/standalone > ~/bin/hub && chmod 0755 !$
+    curl -s http://defunkt.github.com/hub/standalone > ~/bin/hub && chmod 755 !#:4
 
-Assuming `~/bin/` is in your path, you're ready to roll:
+Assuming `~/bin/` is in your `$PATH`, you're ready to roll:
 
     $ hub version
     git version 1.6.4.2
     hub version 0.1.0
 
-### Rubygems
+### RubyGems
 
-Though not recommended, `hub` can also be installed as a Rubygem:
+Though not recommended, `hub` can also be installed as a RubyGem:
 
     $ gem install git-hub -s http://gemcutter.org/
 
@@ -110,7 +110,7 @@ superpowers:
     $ git remote add rtomayko
     > git remote add rtomayko git://github.com/rtomayko/CURRENT_REPO.git
 
-    $ git remote add -p pjhyett
+    $ git remote add -p rtomayko
     > git remote add rtomayko git@github.com:rtomayko/CURRENT_REPO.git
 
 ### git init

data/Rakefile

@@ -11,7 +11,7 @@ end
 desc "Launch Kicker (like autotest)"
 task :kicker do
   puts "Kicking... (ctrl+c to cancel)"
-  exec "kicker -e rake test bin"
+  exec "kicker -e rake test lib"
 end
 
 desc "Build a gem"
@@ -22,6 +22,11 @@ task :standalone => [ :test, :load_hub ] do
   Hub::Standalone.save('hub')
 end
 
+desc "Build hub manual"
+task 'man' do
+  sh "ron -br5 -m --organization=DEFUNKT --manual='Git Manual' man/*.ron"
+end
+
 task :load_hub do
   $LOAD_PATH.unshift 'lib'
   require 'hub'

data/lib/hub/commands.rb

@@ -145,9 +145,13 @@ module Hub
     # $ hub help
     # (print improved help text)
     def help(args)
-      return if args.size > 1
-      puts improved_help_text
-      exit
+      if args[1] == 'hub'
+        puts hub_manpage
+        exit
+      elsif args.size == 1
+        puts improved_help_text
+        exit
+      end
     end
 
     # The text print when `hub help` is run, kept in its own method
@@ -198,6 +202,8 @@ 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}"
@@ -206,6 +212,49 @@ help
       end
     end
 
+    # Returns the terminal-formatted manpage, ready to be printed to
+    # the screen.
+    def hub_manpage
+      return "** Can't find groff(1)" unless groff?
+
+      require 'open3'
+      out = nil
+      Open3.popen3(groff_command) do |stdin, stdout, _|
+        stdin.puts hub_raw_manpage
+        stdin.close
+        out = stdout.read.strip
+      end
+      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.
+    def groff_command
+      "groff -Wall -mtty-char -mandoc -Tascii"
+    end
+
+    # Returns the raw hub manpage. If we're not running in standalone
+    # mode, it's a file sitting at the root under the `man`
+    # directory.
+    #
+    # If we are running in standalone mode the manpage will be
+    # included after the __END__ of the file so we can grab it using
+    # DATA.
+    def hub_raw_manpage
+      if File.exists? file = File.dirname(__FILE__) + '/../../man/hub.1'
+        File.read(file)
+      else
+        DATA.read
+      end
+    end
+
     # All calls to `puts` in after hooks or commands are paged,
     # git-style.
     def puts(*args)
@@ -231,7 +280,7 @@ help
         # Wait until we have input before we start the pager
         Kernel.select [STDIN]
 
-        pager = ENV['PAGER'] || 'less'
+        pager = ENV['PAGER'] || 'less -isr'
         exec pager rescue exec "/bin/sh", "-c", pager
       else
         # Child process

data/lib/hub/standalone.rb

@@ -16,7 +16,8 @@ module Hub
 
 premable
 
-    POSTAMBLE = "Hub::Runner.execute(*ARGV)"
+    POSTAMBLE = "Hub::Runner.execute(*ARGV)\n"
+    MANPAGE   = "__END__\n#{File.read('man/hub.1')}"
 
     def save(filename, path = '.')
       target = File.join(File.expand_path(path), filename)
@@ -43,6 +44,7 @@ premable
       end
 
       standalone << POSTAMBLE
+      standalone << MANPAGE
       standalone
     end
   end

data/lib/hub/version.rb

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

data/man/hub.1

@@ -0,0 +1,94 @@
+.\" generated with Ron/v0.3
+.\" http://github.com/rtomayko/ron/
+.
+.TH "HUB" "1" "December 2009" "DEFUNKT" "Git Manual"
+.
+.SH "NAME"
+\fBhub\fR \-\- git + hub = github
+.
+.SH "SYNOPSIS"
+\fBhub\fR \fICOMMAND\fR \fIOPTIONS\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
+.
+.br
+\fBgit remote add\fR [\fB\-p\fR] \fIOPTIONS\fR \fIUSER\fR[/\fIREPOSITORY\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 
+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 
+.
+.P
+After configuring the alias, the following commands have superpowers:
+.
+.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.
+.
+.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".
+.
+.TP
+\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
+"git@github.com:\fIUSER\fR/\fIREPOSITORY\fR.git".
+.
+.TP
+\fBgit help\fR
+Display enhanced git\-help(1).
+.
+.SH "CONFIGURATION"
+Use git\-config(1) to display the currently configured GitHub username:
+.
+.IP "" 4
+.
+.nf
+
+$ git config \-\-global github.user 
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Or, set the GitHub username with:
+.
+.IP "" 4
+.
+.nf
+
+$ git config \-\-global github.user <username> 
+.
+.fi
+.
+.IP "" 0
+.
+.P
+See \fIhttp://github.com/guides/local\-github\-config\fR for more information.
+.
+.SH "BUGS"
+\fIhttp://github.com/defunkt/hub/issues\fR
+.
+.SH "AUTHOR"
+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

data/man/hub.1.ron

@@ -0,0 +1,70 @@
+hub(1) -- git + hub = github
+============================
+
+## SYNOPSIS
+
+`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>]
+
+## DESCRIPTION
+
+`hub` enhances various `git` commands with GitHub remote expansion. The
+alias command displays information on configuring your environment:
+
+  * `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>:
+    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>:
+    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".
+
+  * `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".
+
+  * `git help`:
+    Display enhanced git-help(1).
+
+## CONFIGURATION
+
+Use git-config(1) to display the currently configured GitHub username:
+
+    $ git config --global github.user
+
+Or, set the GitHub username with:
+
+    $ git config --global github.user <username>
+
+See <http://github.com/guides/local-github-config> for more information.
+
+## BUGS
+
+<http://github.com/defunkt/hub/issues>
+
+## AUTHOR
+
+Chris Wanstrath :: chris@ozmm.org :: @defunkt
+
+## SEE ALSO
+
+git(1), git-clone(1), git-remote(1), git-init(1),
+<http://github.com>,
+<http://github.com/defunkt/hub>

data/test/hub_test.rb

@@ -97,4 +97,23 @@ class HubTest < Test::Unit::TestCase
   def test_help_by_default
     assert_equal Hub::Commands.improved_help_text, hub("")
   end
+
+  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 "Chris Wanstrath :: chris@ozmm.org", help_manpage
+    assert_includes <<-config, help_manpage
+Use git-config(1) to display the currently configured GitHub username:
+config
+  end
+
+  def test_help_hub_no_groff
+    help_manpage = hub("help hub") do
+      Hub::Commands.class_eval do
+        def groff?; false end
+      end
+    end
+    assert_equal "** Can't find groff(1)\n", help_manpage
+  end
 end

data/test/standalone_test.rb

@@ -25,11 +25,14 @@ class StandaloneTest < Test::Unit::TestCase
     assert_includes "Commands", standalone
     assert_includes ".execute(*ARGV)", standalone
     assert_not_includes "module Standalone", standalone
+
+    standalone =~ /__END__\s*(.+)/m
+    assert_equal File.read('man/hub.1'), $1
   end
 
   def test_standalone_save
     Hub::Standalone.save("hub")
-    assert_equal Hub::Standalone.build + "\n", File.read('./hub')
+    assert_equal Hub::Standalone.build, File.read('./hub')
   end
 
   def test_standalone_save_permission_denied

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: git-hub
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Chris Wanstrath
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-08 00:00:00 -08:00
+date: 2009-12-10 00:00:00 -08:00
 default_executable: hub
 dependencies: []
 
@@ -25,6 +25,7 @@ extra_rdoc_files:
 files: 
 - .gitignore
 - .kick
+- HISTORY.md
 - LICENSE
 - README.md
 - Rakefile
@@ -35,6 +36,8 @@ files:
 - lib/hub/runner.rb
 - lib/hub/standalone.rb
 - lib/hub/version.rb
+- man/hub.1
+- man/hub.1.ron
 - test/alias_test.rb
 - test/helper.rb
 - test/hub_test.rb