jchris-github 0.1.4

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2008 Chris Wanstrath
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of 
+this software and associated documentation files (the "Software"), to deal in 
+the Software without restriction, including without limitation the rights to 
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 
+the Software, and to permit persons to whom the Software is furnished to do so, 
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all 
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest

@@ -0,0 +1,17 @@
+bin/github
+commands/commands.rb
+commands/helpers.rb
+lib/github/extensions.rb
+lib/github/command.rb
+lib/github/helper.rb
+lib/github.rb
+LICENSE
+Manifest
+README
+spec/command_spec.rb
+spec/extensions_spec.rb
+spec/github_spec.rb
+spec/helper_spec.rb
+spec/spec_helper.rb
+spec/ui_spec.rb
+spec/windoze_spec.rb

data/README

@@ -0,0 +1,89 @@
+The GitHub Gem
+=============
+
+This gem'll work hand-in-hand with GitHub's API to help you out.
+
+Catch us in the #github room on freenode if you want to get involved.  Or just fork and send a pull request.
+
+===========
+Getting started
+===========
+
+  $ gem install defunkt-github -s http://gems.github.com
+
+Run it:
+
+  $ github <command> <args>
+
+
+=============
+Pulling Upstream Changes
+=============
+
+Let's say you just forked `github-gem` on GitHub from defunkt.
+
+  $ git clone git://github.com/YOU/github-gem.git
+  $ cd github-gem
+  $ github pull defunkt
+
+This will setup a remote and branch for defunkt's repository at master. 
+In this case, a 'defunkt/master' branch.
+
+If defunkt makes some changes you want, simply `github pull defunkt`.  This will
+leave you in the 'defunkt/master' branch after pulling changes from defunkt's
+remote.  After confirming that defunkt's changes were what you wanted, run `git
+checkout master` and then `git merge defunkt/master` to merge defunkt's changes
+into your own master branch.  In summary:
+
+  $ github pull defunkt
+  $ git checkout master
+  $ git merge defunkt/master
+
+If you've already reviewed defunkt's changes and just want to merge them into your 
+master branch, use the `merge` flag:
+
+  $ github pull --merge defunkt
+
+
+==========
+Fetching and Evaluation Downstream Changes
+==========
+
+If you are the maintainer of a project, you will often need to fetch commits
+from other developers, evaluate and/or test them, then merge them into the
+project.
+
+Let's say you are 'defunkt' and 'mojombo' has forked your 'github-gem' repo,
+made some changes and issues you a pull request for his 'master' branch.
+
+From the root of the project, you can do:
+
+  $ github fetch mojombo master
+  
+This will leave you in the 'mojombo/master' branch after fetching his commits.
+Your local 'mojombo/master' branch is now at the exact same place as mojombo's 
+'master' branch. You can now run tests or evaluate the code for awesomeness.
+
+If mojombo's changes are good, you'll want to merge your 'master' (or another
+branch) into those changes so you can retest post-integration:
+
+  $ git merge master
+  
+Test/analyze again and if everything is ok:
+  
+  $ git checkout master
+  $ git merge mojombo/master
+  
+The latter command will be a fast-forward merge since you already did the
+real merge previously.
+
+
+==========
+Contributors
+==========
+
+- defunkt
+- maddox
+- halorgium
+- kballard
+- mojombo

data/bin/github

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../lib/github'
+
+GitHub.activate ARGV

data/commands/commands.rb

@@ -0,0 +1,119 @@
+desc "Open this repo's master branch in a web browser."
+command :home do |user|
+  if helper.project
+    helper.open helper.homepage_for(user || helper.owner, 'master')
+  end
+end
+
+desc "Open this repo in a web browser."
+command :browse do |user, branch|
+  if helper.project
+    # if one arg given, treat it as a branch name
+    # unless it maches user/branch, then split it
+    # if two args given, treat as user branch
+    # if no args given, use defaults
+    user, branch = user.split("/", 2) if branch.nil? unless user.nil?
+    branch = user and user = nil if branch.nil?
+    user ||= helper.branch_user
+    branch ||= helper.branch_name
+    helper.open helper.homepage_for(user, branch)
+  end
+end
+
+desc "Open the network page for this repo in a web browser."
+command :network do |user|
+  if helper.project
+    user ||= helper.owner
+    helper.open helper.network_page_for(user)
+  end
+end
+
+desc "Info about this project."
+command :info do
+  puts "== Info for #{helper.project}"
+  puts "You are #{helper.owner}"
+  puts "Currently tracking:"
+  helper.tracking.sort { |(a,),(b,)| a == :origin ? -1 : b == :origin ? 1 : a.to_s <=> b.to_s }.each do |(name,user_or_url)|
+    puts " - #{user_or_url} (as #{name})"
+  end
+end
+
+desc "Track another user's repository."
+flags :private => "Use git@github.com: instead of git://github.com/."
+flags :ssh => 'Equivalent to --private'
+command :track do |remote, user|
+  # track remote user
+  # track remote user/repo
+  # track user
+  # track user/repo
+  user, remote = remote, nil if user.nil?
+  die "Specify a user to track" if user.nil?
+  user, repo = user.split("/", 2)
+  die "Already tracking #{user}" if helper.tracking?(user)
+  repo = @helper.project if repo.nil?
+  repo.chomp!(".git")
+  remote ||= user
+
+  if options[:private] || options[:ssh]
+    git "remote add #{remote} #{helper.private_url_for_user_and_repo(user, repo)}"
+  else
+    git "remote add #{remote} #{helper.public_url_for_user_and_repo(user, repo)}"
+  end
+end
+
+desc "Fetch from a remote to a local branch."
+command :fetch do |user, branch|
+  die "Specify a user to pull from" if user.nil?
+  user, branch = user.split("/", 2) if branch.nil?
+  branch ||= 'master'
+  GitHub.invoke(:track, user) unless helper.tracking?(user)
+  
+  git "fetch #{user} #{branch}:refs/remotes/#{user}/#{branch}"
+  git_exec "checkout -b #{user}/#{branch} refs/remotes/#{user}/#{branch}"
+end
+
+desc "Pull from a remote."
+flags :merge => "Automatically merge remote's changes into your master."
+command :pull do |user, branch|
+  die "Specify a user to pull from" if user.nil?
+  user, branch = user.split("/", 2) if branch.nil?
+  branch ||= 'master'
+  GitHub.invoke(:track, user) unless helper.tracking?(user)
+  
+  if options[:merge]
+    git_exec "pull #{user} #{branch}"
+  else
+    puts "Switching to #{user}/#{branch}"
+    git "checkout #{user}/#{branch}" if git("checkout -b #{user}/#{branch}").error?
+    git_exec "pull #{user} #{branch}"
+  end
+end
+
+desc "Clone a repo."
+flags :ssh => "Clone using the git@github.com style url."
+command :clone do |user, repo, dir|
+  die "Specify a user to pull from" if user.nil?
+  if user.include? ?/
+    die "Expected user/repo dir, given extra argument" if dir
+    (user, repo), dir = [user.split('/', 2), repo]
+  end
+  die "Specify a repo to pull from" if repo.nil?
+
+  if options[:ssh]
+    git_exec "clone git@github.com:#{user}/#{repo}.git" + (dir ? " #{dir}" : "")
+  else
+    git_exec "clone git://github.com/#{user}/#{repo}.git" + (dir ? " #{dir}" : "")
+  end
+end
+
+desc "Generate the text for a pull request."
+command :'pull-request' do |user, branch|
+  if helper.project
+    die "Specify a user for the pull request" if user.nil?
+    user, branch = user.split('/', 2) if branch.nil?
+    branch ||= 'master'
+    GitHub.invoke(:track, user) unless helper.tracking?(user)
+
+    git_exec "request-pull #{user}/#{branch} origin"
+  end
+end

data/commands/helpers.rb

@@ -0,0 +1,123 @@
+helper :user_and_repo_from do |url|
+  case url
+  when %r|^git://github\.com/([^/]+/[^/]+)$|: $1.split('/')
+  when %r|^(?:ssh://)?(?:git@)?github\.com:([^/]+/[^/]+)$|: $1.split('/')
+  end
+end
+
+helper :user_and_repo_for do |remote|
+  user_and_repo_from(url_for(remote))
+end
+
+helper :user_for do |remote|
+  user_and_repo_for(remote).try.first
+end
+
+helper :repo_for do |remote|
+  user_and_repo_for(remote).try.last
+end
+
+helper :project do
+  repo = repo_for(:origin)
+  if repo.nil?
+    if url_for(:origin) == ""
+      STDERR.puts "Error: missing remote 'origin'"
+    else
+      STDERR.puts "Error: remote 'origin' is not a github URL"
+    end
+    exit 1
+  end
+  repo.chomp('.git')
+end
+
+helper :url_for do |remote|
+  `git config --get remote.#{remote}.url`.chomp
+end
+
+helper :remotes do
+  regexp = '^remote\.(.+)\.url$'
+  `git config --get-regexp '#{regexp}'`.split(/\n/).inject({}) do |memo, line|
+    name_string, url = line.split(/ /, 2)
+    m, name = *name_string.match(/#{regexp}/)
+    memo[name.to_sym] = url
+    memo
+  end
+end
+
+helper :tracking do
+  remotes.inject({}) do |memo, (name, url)|
+    if ur = user_and_repo_from(url)
+      memo[name] = ur.first
+    else
+      memo[name] = url
+    end
+    memo
+  end
+end
+
+helper :tracking? do |user|
+  tracking.values.include?(user)
+end
+
+helper :owner do
+  user_for(:origin)
+end
+
+helper :user_and_branch do
+  raw_branch = `git rev-parse --symbolic-full-name HEAD`.chomp.sub(/^refs\/heads\//, '')
+  user, branch = raw_branch.split(/\//, 2)
+  if branch
+    [user, branch]
+  else
+    [owner, user]
+  end
+end
+
+helper :branch_user do
+  user_and_branch.first
+end
+
+helper :branch_name do
+  user_and_branch.last
+end
+
+helper :public_url_for_user_and_repo do |user, repo|
+  "git://github.com/#{user}/#{repo}.git"
+end
+
+helper :private_url_for_user_and_repo do |user, repo|
+  "git@github.com:#{user}/#{repo}.git"
+end
+
+helper :public_url_for do |user|
+  public_url_for_user_and_repo user, project
+end
+
+helper :private_url_for do |user|
+  private_url_for_user_and_repo user, project
+end
+
+helper :homepage_for do |user, branch|
+  "https://github.com/#{user}/#{project}/tree/#{branch}"
+end
+
+helper :network_page_for do |user|
+  "https://github.com/#{user}/#{project}/network"
+end
+
+helper :has_launchy? do |blk|
+  begin
+    gem 'launchy'
+    require 'launchy'
+    blk.call
+  rescue Gem::LoadError
+    STDERR.puts "Sorry, you need to install launchy: `gem install launchy`"
+  end
+end
+
+helper :open do |url|
+  has_launchy? proc {
+    Launchy::Browser.new.visit url
+  }
+end
+

data/github-gem.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name = %q{github}
+  s.version = "0.1.4"
+
+  s.specification_version = 2 if s.respond_to? :specification_version=
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Wanstrath, Kevin Ballard"]
+  s.date = %q{2008-05-18}
+  s.default_executable = %q{github}
+  s.description = %q{The official `github` command line helper for simplifying your GitHub experience.}
+  s.email = %q{chris@ozmm.org}
+  s.executables = ["github"]
+  s.extra_rdoc_files = ["bin/github", "lib/github/extensions.rb", "lib/github/command.rb", "lib/github/helper.rb", "lib/github.rb", "LICENSE", "README"]
+  s.files = ["bin/github", "commands/commands.rb", "commands/helpers.rb", "lib/github/extensions.rb", "lib/github/command.rb", "lib/github/helper.rb", "lib/github.rb", "LICENSE", "Manifest", "README", "spec/command_spec.rb", "spec/extensions_spec.rb", "spec/github_spec.rb", "spec/helper_spec.rb", "spec/spec_helper.rb", "spec/ui_spec.rb", "spec/windoze_spec.rb", "github-gem.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Github", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{github}
+  s.rubygems_version = %q{1.1.1}
+  s.summary = %q{The official `github` command line helper for simplifying your GitHub experience.}
+
+  # s.add_dependency(%q<launchy>, [">= 0"])
+end

data/lib/github.rb

@@ -0,0 +1,127 @@
+$:.unshift File.dirname(__FILE__)
+require 'github/extensions'
+require 'github/command'
+require 'github/helper'
+require 'rubygems'
+
+##
+# Starting simple.
+#
+# $ github <command> <args>
+#
+#   GitHub.command <command> do |*args|
+#     whatever 
+#   end
+#
+# We'll probably want to use the `choice` gem for concise, tasty DSL
+# arg parsing action.
+#
+
+module GitHub
+  extend self
+
+  BasePath = File.expand_path(File.dirname(__FILE__) + '/..')
+
+  def command(command, &block)
+    debug "Registered `#{command}`"
+    descriptions[command] = @next_description if @next_description
+    @next_description = nil
+    flag_descriptions[command].update @next_flags if @next_flags
+    @next_flags = nil
+    commands[command.to_s] = Command.new(block)
+  end
+
+  def desc(str)
+    @next_description = str
+  end
+
+  def flags(hash)
+    @next_flags ||= {}
+    @next_flags.update hash
+  end
+
+  def helper(command, &block)
+    debug "Helper'd `#{command}`"
+    Helper.send :define_method, command, &block
+  end
+
+  def activate(args)
+    @options = parse_options(args)
+    @debug = @options[:debug]
+    load 'helpers.rb'
+    load 'commands.rb'
+    invoke(args.shift, *args)
+  end
+
+  def invoke(command, *args)
+    block = commands[command.to_s] || commands['default']
+    debug "Invoking `#{command}`"
+    block.call(*args)
+  end
+
+  def commands
+    @commands ||= {}
+  end
+
+  def descriptions
+    @descriptions ||= {}
+  end
+
+  def flag_descriptions
+    @flagdescs ||= Hash.new { |h, k| h[k] = {} }
+  end
+
+  def options
+    @options
+  end
+
+  def parse_options(args)
+    idx = 0
+    args.clone.inject({}) do |memo, arg|
+      case arg
+      when /^--(.+?)=(.*)/
+        args.delete_at(idx)
+        memo.merge($1.to_sym => $2)
+      when /^--(.+)/
+        args.delete_at(idx)
+        memo.merge($1.to_sym => true)
+      when "--"
+        args.delete_at(idx)
+        return memo
+      else
+        idx += 1
+        memo
+      end
+    end
+  end
+
+  def load(file)
+    file[0] == ?/ ? path = file : path = BasePath + "/commands/#{file}"
+    data = File.read(path)
+    GitHub.module_eval data, path
+  end
+
+  def debug(*messages)
+    puts *messages.map { |m| "== #{m}" } if debug?
+  end
+
+  def debug?
+    !!@debug
+  end
+end
+
+GitHub.command :default do
+  puts "Usage: github command <space separated arguments>", ''
+  puts "Available commands:", ''
+  longest = GitHub.descriptions.map { |d,| d.to_s.size }.max
+  GitHub.descriptions.each do |command, desc|
+    cmdstr = "%-#{longest}s" % command
+    puts "  #{cmdstr} => #{desc}"
+    flongest = GitHub.flag_descriptions[command].map { |d,| "--#{d}".size }.max
+    GitHub.flag_descriptions[command].each do |flag, fdesc|
+      flagstr = "#{" " * longest}  %-#{flongest}s" % "--#{flag}"
+      puts "  #{flagstr}: #{fdesc}"
+    end
+  end
+  puts
+end