riquedafreak-github 0.1.3

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,54 @@
+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 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
+- kballard

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,123 @@
+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 "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)
+  
+  # check to see if the branch even exists on the remote user
+  die "Unknown branch (#{branch}) specified" if !helper.heads?(user, branch)
+  
+  # if the merge option was specified then don't switch to a new branch
+  if !options[:merge]
+    puts "Switching to #{user}/#{branch}"
+
+    if helper.heads?(".", "#{user}/#{branch}")
+      # if the remote branch is already locally tracked then switch to it
+      die "Unable to checkout branch (#{branch})" if git("checkout #{user}/#{branch}").error?
+    else
+      # if the remote branch is not already locally tracked, then fetch it 
+      git_exec "fetch #{user} +#{branch}:#{user}/#{branch}"
+      die "Unable to checkout branch (#{branch})" if git("checkout #{user}/#{branch}").error?
+      return
+    end
+  else
+    puts "Merging from contents of #{user}/#{branch}"
+  end
+  
+  # get the contents of the branch, merging it with whatever is in the local branch
+  git_exec "pull #{user} #{branch}"
+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,139 @@
+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 :heads do |user|
+  results = `git ls-remote -h #{user}  2> /dev/null`
+  results = `git rev-parse --symbolic-full-name --branches 2> /dev/null | grep refs/heads/#{user}` if $?.exitstatus != 0
+  
+  results.split(/\n/).inject({}) do |memo, line|
+    hash, head = line.split(/\t/, 2)
+    head = line.scan(/refs\/heads\/(.+)$/)[0][0]
+    memo[head] = hash
+    memo
+  end
+end
+
+helper :heads? do |user, branch|
+  heads(user).key?(branch)
+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/lib/github/command.rb

@@ -0,0 +1,82 @@
+if RUBY_PLATFORM =~ /mswin|mingw/
+  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)
+      cmdstr = ['git', command].flatten.join(' ')
+      GitHub.debug "exec: #{cmdstr}"
+      `#{cmdstr}`
+    end
+
+    def sh(*command)
+      return 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 = `#{command} 2>&1`
+        replace @error = $?.exitstatus.to_s if $?.exitstatus != 0
+        replace @out = out if out.any?
+        return self
+      end
+
+      def command
+        @command.join(' ')
+      end
+
+      def error?
+        !!@error
+      end
+      
+      def out?
+        !!@out
+      end
+    end
+  end
+end

data/lib/github/extensions.rb

@@ -0,0 +1,28 @@
+# define #try
+class Object
+  def try
+    self
+  end
+end
+
+class NilClass
+  klass = Class.new
+  klass.class_eval do
+    instance_methods.each { |meth| undef_method meth.to_sym unless meth =~ /^__(id|send)__$/ }
+    def method_missing(*args)
+      self
+    end
+  end
+  NilProxy = klass.new
+  def try
+    NilProxy
+  end
+end
+
+# define #tap
+class Object
+  def tap(&block)
+    block.call(self)
+    self
+  end
+end

data/lib/github/helper.rb

@@ -0,0 +1,4 @@
+module GitHub
+  class Helper
+  end
+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

data/spec/command_spec.rb

@@ -0,0 +1,66 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe GitHub::Command do
+  before(:each) do
+    @command = GitHub::Command.new(proc { |x| puts x })
+  end
+
+  it "should return a GitHub::Helper" do
+    @command.helper.should be_instance_of(GitHub::Helper)
+  end
+
+  it "should call successfully" do
+    @command.should_receive(:puts).with("test").once
+    @command.call("test")
+  end
+
+  it "should return options" do
+    GitHub.should_receive(:options).with().once.and_return({:ssh => true})
+    @command.options.should == {:ssh => true}
+  end
+
+  it "should successfully call out to the shell" do
+    unguard(Kernel, :fork)
+    unguard(Kernel, :exec)
+    hi = @command.sh("echo hi")
+    hi.should == "hi"
+    hi.out?.should be(true)
+    hi.error?.should be(false)
+    hi.command.should == "echo hi"
+    bye = @command.sh("echo bye >&2")
+    bye.should == "bye"
+    bye.out?.should be(false)
+    bye.error?.should be(true)
+    bye.command.should == "echo bye >&2"
+  end
+
+  it "should return the results of a git operation" do
+    GitHub::Command::Shell.should_receive(:new).with("git rev-parse master").once.and_return do |*cmds|
+      s = mock("GitHub::Commands::Shell")
+      s.should_receive(:run).once.and_return("sha1")
+      s
+    end
+    @command.git("rev-parse master").should == "sha1"
+  end
+
+  it "should print the results of a git operation" do
+    @command.should_receive(:puts).with("sha1").once
+    GitHub::Command::Shell.should_receive(:new).with("git rev-parse master").once.and_return do |*cmds|
+      s = mock("GitHub::Commands::Shell")
+      s.should_receive(:run).once.and_return("sha1")
+      s
+    end
+    @command.pgit("rev-parse master")
+  end
+
+  it "should exec a git command" do
+    @command.should_receive(:exec).with("git rev-parse master").once
+    @command.git_exec "rev-parse master"
+  end
+
+  it "should die" do
+    @command.should_receive(:puts).once.with("=> message")
+    @command.should_receive(:exit!).once
+    @command.die "message"
+  end
+end

data/spec/extensions_spec.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+describe "When calling #try" do
+  specify "objects should return themselves" do
+    obj = 1; obj.try.should equal(obj)
+    obj = "foo"; obj.try.should equal(obj)
+    obj = { :foo => "bar" }; obj.try.should equal(obj)
+  end
+
+  specify "objects should behave as if #try wasn't called" do
+    "foo".try.size.should == 3
+    { :foo => :bar }.try.fetch(:foo).should == :bar
+    [1, 2, 3].try.map { |x| x + 1 }.should == [2, 3, 4]
+  end
+
+  specify "nil should return the singleton NilClass::NilProxy" do
+    nil.try.should equal(NilClass::NilProxy)
+  end
+
+  specify "nil should ignore any calls made past #try" do
+    nil.try.size.should equal(NilClass::NilProxy)
+    nil.try.sdlfj.should equal(NilClass::NilProxy)
+    nil.try.one.two.three.should equal(NilClass::NilProxy)
+  end
+
+  specify "classes should respond just like objects" do
+    String.try.should equal(String)
+  end
+end
+
+describe "When calling #tap" do
+  specify "objects should behave like Ruby 1.9's #tap" do
+    obj = "foo"
+    obj.tap { |obj| obj.size.should == 3 }.should equal(obj)
+  end
+end