rubyist-github 0.1.2

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/command.rb
+lib/github/helper.rb
+lib/github.rb
+LICENSE
+README
+spec/command_spec.rb
+spec/helpers/owner_spec.rb
+spec/helpers/project_spec.rb
+spec/helpers/public_url_for_spec.rb
+spec/helpers/repo_for_spec.rb
+spec/helpers/user_and_repo_from_spec.rb
+spec/helpers/user_for_spec.rb
+spec/spec_helper.rb
+Manifest

data/README

@@ -0,0 +1,53 @@
+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 github
+
+Run it:
+
+  $ github <command> <args>
+
+
+=============
+Pulling 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
+
+==========
+Contributors
+==========
+
+- defunkt
+- maddox
+- halorgium

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,66 @@
+GitHub.register :helper do |name, comma_args|
+  comma_args ||= ''
+  puts helper.send(name, comma_args.split(/,/))
+end
+
+GitHub.describe :home => "Open this repo's master branch in a web browser."
+GitHub.register :home do
+  if helper.project
+    exec "#{helper.open} #{helper.homepage_for(helper.owner, 'master')}"
+  end
+end
+
+GitHub.describe :browse => "Open this repo in a web browser."
+GitHub.register :browse do
+  if helper.project
+    exec "#{helper.open} #{helper.homepage_for(helper.branch_user, helper.branch_name)}"
+  end
+end
+
+GitHub.describe :info => "Info about this project."
+GitHub.register :info do
+  puts "== Info for #{helper.project}"
+  puts "You are #{helper.owner}"
+  puts "Currently tracking: "
+  helper.tracking.each do |(name,user_or_url)|
+    puts " - #{user_or_url} (as #{name})"
+  end
+end
+
+GitHub.describe :track => "Track another user's repository."
+GitHub.register :track do |user|
+  die "Specify a user to track" if user.nil?
+  die "Already tracking #{user}" if helper.tracking?(user)
+
+  git "remote add #{user} #{helper.public_url_for(user)}"
+end
+
+GitHub.describe :pull => "Pull from a remote.  Pass --merge to automatically merge remote's changes into your master."
+GitHub.register :pull do |user, branch|
+  die "Specify a user to pull from" if user.nil?
+  GitHub.invoke(:track, user) unless helper.tracking?(user)
+  branch ||= 'master'
+
+  puts "Switching to #{user}/#{branch}"
+  git "checkout #{user}/#{branch}" if git("checkout -b #{user}/#{branch}").error? 
+  
+  if options[:merge]
+    git "pull #{user} #{branch}"
+    git "checkout master"
+    git_exec "merge #{user}/#{branch}"
+  else
+    git_exec "pull #{user} #{branch}"
+  end
+end
+
+GitHub.describe :clone => "Clone a repo.  Pass --ssh to clone from your own git@github.com schema."
+GitHub.register :clone do |user, repo|
+  user, repo = user.split('/') unless repo
+  die "Specify a repo to pull from" if repo.nil?
+
+  if options[:ssh]
+    git_exec "clone git@github.com:#{user}/#{repo}.git"
+  else
+    git_exec "clone git://github.com/#{user}/#{repo}.git"
+  end
+end

data/commands/helpers.rb

@@ -0,0 +1,94 @@
+GitHub.helper :user_and_repo_from do |url|
+  case url
+  when %r|^git://github\.com/([^/]+/[^/]+)$|: $1.split('/')
+  when %r|^(?:ssh://)?(?:git@)?github\.com:([^/]+/[^/]+)$|: $1.split('/')
+  else ['', '']
+  end
+end
+
+GitHub.helper :user_and_repo_for do |remote|
+  user_and_repo_from(url_for(remote))
+end
+
+GitHub.helper :user_for do |remote|
+  user_and_repo_for(remote).first
+end
+
+GitHub.helper :repo_for do |remote|
+  user_and_repo_for(remote).last
+end
+
+GitHub.helper :project do
+  repo = repo_for(:origin)
+  if repo == ""
+    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
+
+GitHub.helper :url_for do |remote|
+  `git config --get remote.#{remote}.url`.chomp
+end
+
+GitHub.helper :remotes do
+  regexp = '^remote\.(.+)\.url$'
+  `git config --get-regexp '#{regexp}'`.split(/\n/).map do |line|
+    name_string, url = line.split(/ /, 2)
+    m, name = *name_string.match(/#{regexp}/)
+    [name, url]
+  end
+end
+
+GitHub.helper :tracking do
+  remotes.map do |(name, url)|
+    if ur = user_and_repo_from(url)
+      [name, ur.first]
+    else
+      [name, url]
+    end
+  end
+end
+
+GitHub.helper :tracking? do |user|
+  tracking.include?(user)
+end
+
+GitHub.helper :owner do
+  user_for(:origin)
+end
+
+GitHub.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
+
+GitHub.helper :branch_user do
+  user_and_branch.first
+end
+
+GitHub.helper :branch_name do
+  user_and_branch.last
+end
+
+GitHub.helper :public_url_for do |user|
+  "git://github.com/#{user}/#{project}.git"
+end
+
+GitHub.helper :homepage_for do |user, branch|
+  "https://github.com/#{user}/#{project}/tree/#{branch}"
+end
+
+GitHub.helper :open do
+  Windoze ? 'start' : 'open'
+end
+    

data/github-gem.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name = %q{github}
+  s.version = "0.1.2"
+
+  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"]
+  s.date = %q{2008-05-06}
+  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/command.rb", "lib/github/helper.rb", "lib/github.rb", "LICENSE", "README"]
+  s.files = ["bin/github", "commands/commands.rb", "commands/helpers.rb", "lib/github/command.rb", "lib/github/helper.rb", "lib/github.rb", "LICENSE", "README", "spec/command_spec.rb", "spec/helpers/owner_spec.rb", "spec/helpers/project_spec.rb", "spec/helpers/public_url_for_spec.rb", "spec/helpers/repo_for_spec.rb", "spec/helpers/user_and_repo_from_spec.rb", "spec/helpers/user_for_spec.rb", "spec/spec_helper.rb", "Manifest", "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.}
+end

data/lib/github.rb

@@ -0,0 +1,99 @@
+$:.unshift File.dirname(__FILE__)
+require 'github/command'
+require 'github/helper'
+
+##
+# Starting simple.
+#
+# $ github <command> <args>
+#
+#   GitHub.register <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 register(command, &block)
+    debug "Registered `#{command}`"
+    commands[command.to_s] = Command.new(block)
+  end
+
+  def describe(hash)
+    descriptions.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)
+    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 options
+    @options
+  end
+
+  def parse_options(args)
+    @debug = args.delete('--debug')
+    args.inject({}) do |memo, arg|
+      if arg =~ /^--([^=]+)=(.+)/
+        args.delete(arg)
+        memo.merge($1.to_sym => $2)
+      elsif arg =~ /^--(.+)/
+        args.delete(arg)
+        memo.merge($1.to_sym => true)
+      else
+        memo
+      end
+    end
+  end
+
+  def load(file)
+    file[0] == ?/ ? super : super(BasePath + "/commands/#{file}")
+  end
+
+  def debug(*messages)
+    puts *messages.map { |m| "== #{m}" } if debug?
+  end
+
+  def debug?
+    !!@debug
+  end
+end
+
+GitHub.register :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|
+    command = "%-#{longest}s" % command
+    puts "  #{command} => #{desc}"
+  end
+  puts
+end

data/lib/github/command.rb

@@ -0,0 +1,87 @@
+Windoze = RUBY_PLATFORM =~ /mswin|mingw/
+
+if Windoze
+  begin
+    require 'win32/open3'
+  rescue LoadError
+    warn "You must 'gem install win32-open3' to use the github command on Windows"
+    exit 1
+  end
+else
+  require 'open3'
+end
+
+module GitHub
+  class Command
+    def initialize(block)
+      (class << self;self end).send :define_method, :command, &block
+    end
+
+    def call(*args)
+      arity = method(:command).arity
+      args << nil while args.size < arity
+      send :command, *args
+    end
+    
+    def helper
+      @helper ||= Helper.new
+    end
+
+    def options
+      GitHub.options
+    end
+
+    def pgit(*command)
+      puts git(*command)
+    end
+
+    def git(*command)
+      sh ['git', command].flatten.join(' ')
+    end
+
+    def git_exec(*command)
+      exec ['git', command].flatten.join(' ')
+    end
+
+    def sh(*command)
+      Shell.new(*command).run
+    end
+
+    def die(message)
+      puts "=> #{message}"
+      exit!
+    end
+
+    class Shell < String
+      def initialize(*command)
+        @command = command
+      end
+
+      def run
+        GitHub.debug "sh: #{command}"
+        _, out, err = Open3.popen3(*@command)
+
+        out = out.read.strip
+        err = err.read.strip
+
+        if out.any?
+          replace @out = out
+        elsif err.any?
+          replace @error = err
+        end
+      end
+
+      def command
+        @command.join(' ')
+      end
+
+      def error?
+        !!@error
+      end
+
+      def out?
+        !!@out
+      end
+    end
+  end
+end

data/lib/github/helper.rb

@@ -0,0 +1,4 @@
+module GitHub
+  class Helper
+  end
+end

data/spec/helpers/owner_spec.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "The owner helper" do
+  before(:each) do
+    @helper = GitHub::Helper.new
+  end
+
+  it "should return hacker" do
+    @helper.should_receive(:url_for).with(:origin).and_return("git://github.com/hacker/project.git")
+    @helper.owner.should == "hacker"
+  end
+end

data/spec/helpers/project_spec.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "The project helper" do
+  before(:each) do
+    @helper = GitHub::Helper.new
+  end
+
+  it "should return project-awesome" do
+    @helper.should_receive(:url_for).with(:origin).and_return("git://github.com/user/project-awesome.git")
+    @helper.project.should == "project-awesome"
+  end
+
+  it "should exit due to missing origin" do
+    @helper.should_receive(:url_for).twice.with(:origin).and_return("")
+    STDERR.should_receive(:puts).with("Error: missing remote 'origin'")
+    lambda { @helper.project }.should raise_error(SystemExit)
+  end
+
+  it "should exit due to non-github origin" do
+    @helper.should_receive(:url_for).twice.with(:origin).and_return("home:path/to/repo.git")
+    STDERR.should_receive(:puts).with("Error: remote 'origin' is not a github URL")
+    lambda { @helper.project }.should raise_error(SystemExit)
+  end
+end

data/spec/helpers/public_url_for_spec.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "The public_url_for helper" do
+  before(:each) do
+    @helper = GitHub::Helper.new
+  end
+
+  it "should return git://github.com/wycats/merb-core.git" do
+    @helper.should_receive(:url_for).with(:origin).and_return("git://github.com/user/merb-core.git")
+    @helper.public_url_for("wycats").should == "git://github.com/wycats/merb-core.git"
+  end
+end

data/spec/helpers/repo_for_spec.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "The repo_for helper" do
+  before(:each) do
+    @helper = GitHub::Helper.new
+  end
+
+  it "should return mephisto.git" do
+    @helper.should_receive(:url_for).with("mojombo").and_return("git@github.com:mojombo/mephisto.git")
+    @helper.repo_for("mojombo").should == "mephisto.git"
+  end
+end

data/spec/helpers/user_and_repo_from_spec.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "The user_and_repo_from helper" do
+  before(:each) do
+    @helper = GitHub::Helper.new
+  end
+
+  it "should parse a git:// url" do
+    @helper.user_and_repo_from("git://github.com/defunkt/github.git").should == ["defunkt", "github.git"]
+  end
+
+  it "should parse a ssh-based url" do
+    @helper.user_and_repo_from("git@github.com:mojombo/god.git").should == ["mojombo", "god.git"]
+  end
+
+  it "should parse a non-standard ssh-based url" do
+    @helper.user_and_repo_from("ssh://git@github.com:mojombo/god.git").should == ["mojombo", "god.git"]
+    @helper.user_and_repo_from("github.com:mojombo/god.git").should == ["mojombo", "god.git"]
+    @helper.user_and_repo_from("ssh://github.com:mojombo/god.git").should == ["mojombo", "god.git"]
+  end
+
+  it "should return nothing for other urls" do
+    @helper.user_and_repo_from("home:path/to/repo.git").should == ['', '']
+  end
+
+  it "should return nothing for invalid git:// urls" do
+    @helper.user_and_repo_from("git://github.com/foo").should == ['', '']
+  end
+
+  it "should return nothing for invalid ssh-based urls" do
+    @helper.user_and_repo_from("git@github.com:kballard").should == ['', '']
+    @helper.user_and_repo_from("git@github.com:kballard/test/repo.git").should == ['', '']
+    @helper.user_and_repo_from("ssh://git@github.com:kballard").should == ['', '']
+    @helper.user_and_repo_from("github.com:kballard").should == ['', '']
+    @helper.user_and_repo_from("ssh://github.com:kballard").should == ['', '']
+  end
+end

data/spec/helpers/user_for_spec.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "The user_for helper" do
+  before(:each) do
+    @helper = GitHub::Helper.new
+  end
+
+  it "should return defunkt" do
+    @helper.should_receive(:url_for).with("origin").and_return("git@github.com:defunkt/project.git")
+    @helper.user_for("origin").should == "defunkt"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'spec'
+
+require File.dirname(__FILE__) + '/../lib/github'
+
+module GitHub
+  load 'helpers.rb'
+  load 'commands.rb'
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: rubyist-github
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Chris Wanstrath
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-06 00:00:00 -07:00
+default_executable: github
+dependencies: []
+
+description: The official `github` command line helper for simplifying your GitHub experience.
+email: chris@ozmm.org
+executables: 
+- github
+extensions: []
+
+extra_rdoc_files: 
+- bin/github
+- lib/github/command.rb
+- lib/github/helper.rb
+- lib/github.rb
+- LICENSE
+- README
+files: 
+- bin/github
+- commands/commands.rb
+- commands/helpers.rb
+- lib/github/command.rb
+- lib/github/helper.rb
+- lib/github.rb
+- LICENSE
+- README
+- spec/command_spec.rb
+- spec/helpers/owner_spec.rb
+- spec/helpers/project_spec.rb
+- spec/helpers/public_url_for_spec.rb
+- spec/helpers/repo_for_spec.rb
+- spec/helpers/user_and_repo_from_spec.rb
+- spec/helpers/user_for_spec.rb
+- spec/spec_helper.rb
+- Manifest
+- github-gem.gemspec
+has_rdoc: true
+homepage: http://github.com/
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Github
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: github
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: The official `github` command line helper for simplifying your GitHub experience.
+test_files: []
+