hub 1.6.0

data/lib/hub/context.rb

@@ -0,0 +1,159 @@
+module Hub
+  # Provides methods for inspecting the environment, such as GitHub user/token
+  # settings, repository info, and similar.
+  module Context
+    private
+
+    # 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|
+      if remote
+        urls = GIT_CONFIG["config --get-all remote.#{remote}.url"].to_s.split("\n")
+
+        if urls.find { |u| u =~ %r{\bgithub\.com[:/](.+)/(.+).git$} } 
+          cache[remote] = { :user => $1, :repo => $2 }
+        else
+          cache[remote] = { }
+        end
+      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] || current_dirname
+    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 = ENV['GITHUB_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 = ENV['GITHUB_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 remotes
+      list = GIT_CONFIG['remote'].to_s.split("\n")
+      main = list.delete('origin') and list.unshift(main)
+      list
+    end
+
+    def remotes_group(name)
+      GIT_CONFIG["config remotes.#{name}"]
+    end
+
+    def current_remote
+      return if remotes.empty?
+
+      if current_branch
+        remote_for(current_branch)
+      else
+        default_remote
+      end
+    end
+
+    def default_remote
+      remotes.first
+    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 git_alias_for(name)
+      GIT_CONFIG["config alias.#{name}"]
+    end
+
+    # Core.repositoryformatversion should exist for all git
+    # repositories, and be blank for all non-git repositories. If
+    # there's a better config setting to check here, this can be
+    # changed without breaking anything.
+    def is_repo?
+      GIT_CONFIG['config core.repositoryformatversion']
+    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]
+        scheme = secure ? 'https:' : 'http:'
+        path = options[:web] == true ? '' : options[:web].to_s
+        if repo =~ /\.wiki$/
+          repo = repo.sub(/\.wiki$/, '')
+          unless '/wiki' == path
+            path = '/wiki%s' % if path =~ %r{^/commits/} then '/_history'
+              else path.sub(/\w+/, '_\0')
+              end
+          end
+        end
+        '%s//github.com/%s/%s%s' % [scheme, user, repo, path]
+      else
+        if secure
+          url = 'git@github.com:%s/%s.git'
+        elsif http_clone?
+          url = 'http://github.com/%s/%s.git'
+        else
+          url = 'git://github.com/%s/%s.git'
+        end
+
+        url % [user, repo]
+      end
+    end
+
+    DIRNAME = File.basename(Dir.pwd)
+
+    def current_dirname
+      DIRNAME
+    end
+  end
+end

data/lib/hub/runner.rb

@@ -0,0 +1,71 @@
+module Hub
+  # The Hub runner expects to be initialized with `ARGV` and primarily
+  # exists to run a git command.
+  #
+  # The actual functionality, that is, the code it runs when it needs to
+  # augment a git command, is kept in the `Hub::Commands` module.
+  class Runner
+    attr_reader :args
+    
+    def initialize(*args)
+      @args = Args.new(args)
+      Commands.run(@args)
+    end
+
+    # Shortcut
+    def self.execute(*args)
+      new(*args).execute
+    end
+
+    # A string representation of the command that would run.
+    def command
+      if args.skip?
+        ''
+      else
+        commands.join('; ')
+      end
+    end
+
+    # An array of all commands as strings.
+    def commands
+      args.commands.map do |cmd|
+        if cmd.respond_to?(:join)
+          # a simplified `Shellwords.join` but it's OK since this is only used to inspect
+          cmd.map { |c| (c.index(' ') || c.empty?) ? "'#{c}'" : c }.join(' ')
+        else
+          cmd.to_s
+        end
+      end
+    end
+
+    # Runs the target git command with an optional callback. Replaces
+    # the current process. 
+    # 
+    # If `args` is empty, this will skip calling the git command. This
+    # allows commands to print an error message and cancel their own
+    # execution if they don't make sense.
+    def execute
+      unless args.skip?
+        if args.chained?
+          execute_command_chain
+        else
+          exec(*args.to_exec)
+        end
+      end
+    end
+
+    # Runs multiple commands in succession; exits at first failure.
+    def execute_command_chain
+      commands = args.commands
+      commands.each_with_index do |cmd, i|
+        if cmd.respond_to?(:call) then cmd.call
+        elsif i == commands.length - 1
+          # last command in chain
+          exec(*cmd)
+        else
+          exit($?.exitstatus) unless system(*cmd)
+        end
+      end
+    end
+  end
+end

data/lib/hub/standalone.rb

@@ -0,0 +1,52 @@
+module Hub
+  module Standalone
+    extend self
+
+    PREAMBLE = <<-preamble
+#!/usr/bin/env ruby
+#
+# This file, hub, is generated code.
+# Please DO NOT EDIT or send patches for it.
+#
+# Please take a look at the source from
+# http://github.com/defunkt/hub
+# and submit patches against the individual files
+# that build hub.
+#
+
+preamble
+
+    POSTAMBLE = "Hub::Runner.execute(*ARGV)\n"
+    __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)
+      File.open(target, 'w') do |f|
+        f.puts build
+        f.chmod 0755
+      end
+    end
+
+    def build
+      root = File.dirname(__FILE__)
+
+      standalone = ''
+      standalone << PREAMBLE
+
+      Dir["#{root}/*.rb"].each do |file|
+        # skip standalone.rb
+        next if file == __FILE__
+
+        File.readlines(file).each do |line|
+          next if line =~ /^\s*#/
+          standalone << line
+        end
+      end
+
+      standalone << POSTAMBLE
+      standalone << MANPAGE
+      standalone
+    end
+  end
+end

data/lib/hub/version.rb

@@ -0,0 +1,3 @@
+module Hub
+  Version = VERSION = '1.6.0'
+end

data/man/hub.1

@@ -0,0 +1,356 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "HUB" "1" "December 2010" "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 create\fR [\fB\-p\fR] [\fB\-d <DESCRIPTION>\fR] [\fB\-h <HOMEPAGE>\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]
+.
+.br
+\fBgit remote set\-url\fR [\fB\-p\fR] \fIOPTIONS\fR \fIREMOTE\-NAME\fR \fIUSER\fR[/\fIREPOSITORY\fR]
+.
+.br
+\fBgit fetch\fR \fIUSER\-1\fR,[\fIUSER\-2\fR,\.\.\.]
+.
+.br
+\fBgit cherry\-pick\fR \fIGITHUB\-REF\fR
+.
+.br
+\fBgit am\fR \fIGITHUB\-URL\fR
+.
+.br
+\fBgit push\fR \fIREMOTE\-1\fR,\fIREMOTE\-2\fR,\.\.\.,\fIREMOTE\-N\fR \fIREF\fR
+.
+.br
+\fBgit browse\fR [\fB\-u\fR] [[\fIUSER\fR\fB/\fR]\fIREPOSITORY\fR] [SUBPAGE]
+.
+.br
+\fBgit compare\fR [\fB\-u\fR] [\fIUSER\fR] [\fISTART\fR\.\.\.]\fIEND\fR
+.
+.br
+\fBgit submodule add\fR [\fB\-p\fR] \fIOPTIONS\fR [\fIUSER\fR/]\fIREPOSITORY\fR \fIDIRECTORY\fR
+.
+.br
+\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:
+.
+.IP "\(bu" 4
+\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
+\fBeval $(hub alias \-s bash)\fR
+.
+.IP "\(bu" 4
+\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\.
+.
+.IP "\(bu" 4
+\fBgit create\fR [\fB\-p\fR] [\fB\-d <DESCRIPTION>\fR] [\fB\-h <HOMEPAGE>\fR]:
+.
+.br
+Create a new public github repository from the current git repository 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\. With \fB\-p\fR, create a private repository\. \fB\-d\fR and \fB\-h\fR set the repository\'s description and homepage, respectively\.
+.
+.IP "\(bu" 4
+\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"\.
+.
+.IP "\(bu" 4
+\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\.
+.
+.IP "\(bu" 4
+\fBgit remote set\-url\fR [\fB\-p\fR] \fIOPTIONS\fR \fIREMOTE\-NAME\fR \fIUSER\fR[/\fIREPOSITORY\fR]
+.
+.br
+Sets the url of remote \fIREMOTE\-NAME\fR using the same rules as \fBgit remote add\fR\.
+.
+.IP "\(bu" 4
+\fBgit fetch\fR \fIUSER\-1\fR,[\fIUSER\-2\fR,\.\.\.]: Adds missing remote(s) with \fBgit remote add\fR prior to fetching\. New remotes are only added if they correspond to valid forks on GitHub\.
+.
+.IP "\(bu" 4
+\fBgit cherry\-pick\fR \fIGITHUB\-REF\fR: Cherry\-pick a commit from a fork using either full URL to the commit or GitHub\-flavored Markdown notation, which is \fBuser@sha\fR\. If the remote doesn\'t yet exist, it will be added\. A \fBgit fetch <user>\fR is issued prior to the cherry\-pick attempt\.
+.
+.IP "\(bu" 4
+\fBgit am\fR \fIGITHUB\-URL\fR: Downloads the patch file for the pull request or commit at the URL and applies that patch from disk with \fBgit am\fR\. Similar to \fBcherry\-pick\fR, but doesn\'t add new remotes\.
+.
+.IP "\(bu" 4
+\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\.
+.
+.IP "\(bu" 4
+\fBgit browse\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\. If the repository isn\'t specified, \fBbrowse\fR opens 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")\.
+.
+.IP "\(bu" 4
+\fBgit compare\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")\.
+.
+.IP "\(bu" 4
+\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"\.
+.
+.IP "\(bu" 4
+\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)\.
+.
+.IP "\(bu" 4
+\fBgit help\fR: Display enhanced git\-help(1)\.
+.
+.IP "" 0
+.
+.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 and token with:
+.
+.IP "" 4
+.
+.nf
+
+$ git config \-\-global github\.user <username>
+$ git config \-\-global github\.token <token>
+.
+.fi
+.
+.IP "" 0
+.
+.P
+See \fIhttp://github\.com/guides/local\-github\-config\fR for more information\.
+.
+.P
+You can also tell \fBhub\fR to use \fBhttp://\fR rather than \fBgit://\fR when cloning:
+.
+.IP "" 4
+.
+.nf
+
+$ git config \-\-global \-\-bool hub\.http\-clone true
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Want to use environment variables instead of a local gitconfig for authentication?
+.
+.IP "\(bu" 4
+\fBGITHUB_USER\fR \- If set, this will be used instead of the \fBgithub\.user\fR config
+.
+.IP "\(bu" 4
+\fBGITHUB_TOKEN\fR \- If set, this will be used instead of the \fBgithub\.token\fR
+.
+.IP "" 0
+.
+.SH "EXAMPLES"
+.
+.SS "git clone"
+.
+.nf
+
+$ 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 git@github\.com:YOUR_USER/resque\.git
+.
+.fi
+.
+.SS "git remote add"
+.
+.nf
+
+$ 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
+.
+.fi
+.
+.SS "git fetch"
+.
+.nf
+
+$ git fetch mislav
+> git remote add mislav git://github\.com/mislav/REPO\.git
+> git fetch mislav
+
+$ git fetch mislav,xoebus
+> git remote add mislav \.\.\.
+> git remote add xoebus \.\.\.
+> git fetch \-\-multiple mislav xoebus
+.
+.fi
+.
+.SS "git cherry\-pick"
+.
+.nf
+
+$ git cherry\-pick http://github\.com/mislav/REPO/commit/SHA
+> git remote add \-f mislav git://github\.com/mislav/REPO\.git
+> git cherry\-pick SHA
+
+$ git cherry\-pick mislav@SHA
+> git remote add \-f mislav git://github\.com/mislav/CURRENT_REPO\.git
+> git cherry\-pick SHA
+
+$ git cherry\-pick mislav@SHA
+> git fetch mislav
+> git cherry\-pick SHA
+.
+.fi
+.
+.SS "git am"
+.
+.nf
+
+$ git am https://github\.com/defunkt/hub/pull/55
+> curl https://github\.com/defunkt/hub/pull/55\.patch \-o /tmp/55\.patch
+> git am /tmp/55\.patch
+
+$ git am \-\-ignore\-whitespace https://github\.com/davidbalbert/hub/commit/fdb9921
+> curl https://github\.com/davidbalbert/hub/commit/fdb9921\.patch \-o /tmp/fdb9921\.patch
+> git am \-\-ignore\-whitespace /tmp/fdb9921\.patch
+.
+.fi
+.
+.SS "git fork"
+.
+.nf
+
+$ git fork
+\.\.\. hardcore forking action \.\.\.
+> git remote add YOUR_USER git@github\.com:YOUR_USER/CURRENT_REPO\.git
+.
+.fi
+.
+.SS "git init"
+.
+.nf
+
+$ git init \-g
+> git init
+> git remote add origin git@github\.com:YOUR_USER/REPO\.git
+.
+.fi
+.
+.SS "git create"
+.
+.nf
+
+$ git create
+\.\.\. hardcore creating action \.\.\.
+> git remote add origin git@github\.com:YOUR_USER/CURRENT_REPO\.git
+.
+.fi
+.
+.SS "git push"
+.
+.nf
+
+$ git push origin,staging,qa bert_timeout
+> git push origin bert_timeout
+> git push staging bert_timeout
+> git push qa bert_timeout
+.
+.fi
+.
+.SS "git browse"
+.
+.nf
+
+$ git browse
+> open https://github\.com/YOUR_USER/CURRENT_REPO
+
+$ git browse \-\- issues
+> open https://github\.com/YOUR_USER/CURRENT_REPO/issues
+
+$ git browse schacon/ticgit
+> open https://github\.com/schacon/ticgit
+
+$ git browse resque
+> open https://github\.com/YOUR_USER/resque
+
+$ git browse resque network
+> open https://github\.com/YOUR_USER/resque/network
+.
+.fi
+.
+.SS "git compare"
+.
+.nf
+
+$ git compare refactor
+> open https://github\.com/CURRENT_REPO/compare/refactor
+
+$ git compare 1\.0\.\.\.1\.1
+> open https://github\.com/CURRENT_REPO/compare/1\.0\.\.\.1\.1
+
+$ git compare \-u fix
+> (https://github\.com/CURRENT_REPO/compare/fix)
+
+$ git compare other\-user patch
+> open https://github\.com/other\-user/REPO/compare/patch
+.
+.fi
+.
+.SS "git help"
+.
+.nf
+
+$ git help
+> (improved git help)
+$ git help hub
+> (hub man page)
+.
+.fi
+.
+.SH "BUGS"
+\fIhttp://github\.com/defunkt/hub/issues\fR
+.
+.SH "AUTHORS"
+\fIhttps://github\.com/defunkt/hub/contributors\fR
+.
+.SH "SEE ALSO"
+git(1), git\-clone(1), git\-remote(1), git\-init(1), \fIhttp://github\.com\fR, \fIhttp://github\.com/defunkt/hub\fR