drnic-github 0.3.9

data/History.txt

@@ -0,0 +1,9 @@
+== 0.1.4
+
+* Added usage notes to commands. [topfunky]
+* Added config option to set github.user and github.repo. [topfunky]
+* Uses current user to automatically use SSH when cloning own projects.
+
+== 0.1.3
+
+* Original version

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,25 @@
+History.txt
+LICENSE
+Manifest
+README
+Rakefile
+bin/gh
+bin/github
+github.gemspec
+lib/commands/commands.rb
+lib/commands/helpers.rb
+lib/commands/issues.rb
+lib/commands/network.rb
+lib/github.rb
+lib/github/command.rb
+lib/github/extensions.rb
+lib/github/helper.rb
+lib/github/ui.rb
+setup.rb
+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,199 @@
+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.
+
+  $ github clone YOU/github-gem
+  $ 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
+  $ github checkout master
+  $ github 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 Evaluating 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:
+
+  $ github merge master
+  
+Test/analyze again and if everything is ok:
+  
+  $ github checkout master
+  $ github merge mojombo/master
+  
+The latter command will be a fast-forward merge since you already did the
+real merge previously.
+
+==========
+Network Patch Queue
+==========
+
+The github gem can also show you all of the commits that exist on any fork of your
+project (your network) that you don't have in your branch yet.  In order to see
+the list of the projects that have commits you do not, you can run:
+
+  $ github network list
+
+Which will show you all the forks that have changes.  If you want to see what those
+changes are, you can run:
+
+  $ github network commits
+
+which will show you something like this:
+
+  9582b9 (jchris/gist)             kevin@sb.org          Add gist binary                        4 months ago
+  c1a6f9 (jchris/gist~1)           kevin@sb.org          Tweak Rakefile spec tasks to be a bi   4 months ago
+  d3c332 (jchris/gist~2)           kevin@sb.org          Pull out two helpers into the shared   4 months ago
+  8f65ab (jchris/gist~3)           kevin@sb.org          Extract command/helper spec assistan   4 months ago
+  389dbf (jchris/gist~4)           kevin@sb.org          Rename ui_spec to command_spec         4 months ago
+  670a1a (jchris/gist~5)           kevin@sb.org          Hoist the specs into a per-binary sp   4 months ago
+  6aa18e (jchris/gist~6)           kevin@sb.org          Hoist commands/helpers into a per-co   4 months ago
+  ee013a (luislavena/master)       luislavena@gmail.com  Replaced STDOUT by $stdout in specs.   2 weeks ago
+  d543c4 (luislavena/master~3)     luislavena@gmail.com  Exclude package folder.                8 weeks ago
+  a8c3eb (luislavena/master~5)     luislavena@gmail.com  Fixed specs for open under Windows.    5 months ago
+  33d003 (riquedafreak/master)     enrique.osuna@gmail.  Make sure it exists on the remote an   5 weeks ago
+  157155 (riquedafreak/master~1)   enrique.osuna@gmail.  Updated specs.                         5 weeks ago
+  f44e99 (riquedafreak/master~3)   enrique.osuna@gmail.  Only work with a clean branch.         3 months ago
+
+These are all the commits that you don't have in your current branch that have been
+pushed to other forks of your project.  If you want to incorporate them, you can use:
+
+  $ github cherry-pick ee013a
+
+for example to apply that single patch to your branch.  You can also merge a branch, 
+if you want all the changes introduced in another branch:
+
+  $ github merge jchris/gist
+
+The next time you run the 'github network commits' command, you won't see any of the 
+patches you have cherry-picked or merged (or rebased).  If you want to ignore a 
+commit, you can simply run:
+  
+  $ github ignore a8c3eb
+
+Then you won't ever see that commit again. Or, if you want to ignore a range of commits,
+you can use the normal Git revision selection shorthands - for example, if you want
+to ignore all 7 jchris/gist commits there, you can run:
+
+  $ github ignore ..jchris/gist
+
+You can also filter the output, if you want to see some subset.  You can filter by project,
+author and date range, or (one of the cooler things) you can filter by whether the patch
+applies cleanly to your branch head or not.  For instance, I can do this:
+
+  $ ./bin/github network commits --applies
+
+  ca15af (jchris/master~1)         jchris@grabb.it       fixed github gemspecs broken referen   8 weeks ago
+  ee013a (luislavena/master)       luislavena@gmail.com  Replaced STDOUT by $stdout in specs.   2 weeks ago
+  157155 (riquedafreak/master~1)   enrique.osuna@gmail.  Updated specs.                         5 weeks ago
+  f44e99 (riquedafreak/master~3)   enrique.osuna@gmail.  Only work with a clean branch.         3 months ago
+
+  $ ./bin/github network commits --applies --project=riq
+
+  157155 (riquedafreak/master~1)   enrique.osuna@gmail.  Updated specs.                         5 weeks ago
+  f44e99 (riquedafreak/master~3)   enrique.osuna@gmail.  Only work with a clean branch.         3 months ago
+
+Pretty freaking sweet.  Also, you can supply the --shas option to just get a list of 
+the shas instead of the pretty printout here, so you can pipe that into other 
+scripts (like 'github ignore' for instance).
+
+
+==========
+Issues
+==========
+
+If you'd like to see a summary of the open issues on your project:
+
+  $ github issues open
+
+  -----
+  Issue #135 (2 votes): Remove Node#collect_namespaces
+  *  URL: http://github.com/tenderlove/nokogiri/issues/#issue/135
+  *  Opened 3 days ago by tenderlove
+  *  Last updated about 1 hour ago
+  
+  I think we should remove Node#collect_namespaces.  Since namespace names are not unique, I don't know that this method is very useful.
+  -----
+  Issue #51 (0 votes): FFI: support varargs in error/exception callbacks
+  *  URL: http://github.com/tenderlove/nokogiri/issues/#issue/51
+  *  Opened 4 months ago by flavorjones
+  *  Last updated about 1 month ago
+  *  Labels: ffi, mdalessio
+  
+  we should open JIRA tickets for vararg support in FFI callbacks
+  
+  then we should format the libxml error messages properly in the error/exception callbacks
+  -----
+
+If you want to additionally filter by time:
+
+  $ github issues open --after=2009-09-14
+
+Or filter by label:
+
+  $ github issues open --label=ffi
+
+==========
+Contributors
+==========
+
+- defunkt
+- maddox
+- halorgium
+- kballard
+- mojombo
+- schacon
+

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'echoe'
+
+  Echoe.new('github', '0.3.9') do |p|
+    p.rubyforge_name = 'github'
+    p.summary      = "The official `github` command line helper for simplifying your GitHub experience."
+    p.description  = "The official `github` command line helper for simplifying your GitHub experience."
+    p.url          = "http://github.com/"
+    p.author       = ['Chris Wanstrath', 'Kevin Ballard', 'Scott Chacon']
+    p.email        = "chris@ozmm.org"
+    p.dependencies = ["text-format"]
+  end
+
+rescue LoadError => boom
+  puts "You are missing a dependency required for meta-operations on this gem."
+  puts "#{boom.to_s.capitalize}."
+end
+
+# add spec tasks, if you have rspec installed
+begin
+  require 'spec/rake/spectask'
+
+  Spec::Rake::SpecTask.new("spec") do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ['--color']
+  end
+
+  task :test do
+    Rake::Task['spec'].invoke
+  end
+
+  Spec::Rake::SpecTask.new("rcov_spec") do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ['--color']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', '^spec,/gems/']
+  end
+end

data/bin/gh

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+lib_dir = File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH.unshift lib_dir if File.directory?(lib_dir)
+
+require 'github'
+
+GitHub.activate ARGV

data/bin/github

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+lib_dir = File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH.unshift lib_dir if File.directory?(lib_dir)
+
+require 'github'
+
+GitHub.activate ARGV

data/github.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{drnic-github}
+  s.version = "0.3.9"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Wanstrath, Kevin Ballard, Scott Chacon"]
+  s.date = %q{2009-11-04}
+  s.description = %q{The official `github` command line helper for simplifying your GitHub experience.}
+  s.email = %q{chris@ozmm.org}
+  s.executables = ["gh", "github"]
+  s.extra_rdoc_files = ["LICENSE", "README", "bin/gh", "bin/github", "lib/commands/commands.rb", "lib/commands/helpers.rb", "lib/commands/issues.rb", "lib/commands/network.rb", "lib/github.rb", "lib/github/command.rb", "lib/github/extensions.rb", "lib/github/helper.rb", "lib/github/ui.rb"]
+  s.files = ["History.txt", "LICENSE", "Manifest", "README", "Rakefile", "bin/gh", "bin/github", "github.gemspec", "lib/commands/commands.rb", "lib/commands/helpers.rb", "lib/commands/issues.rb", "lib/commands/network.rb", "lib/github.rb", "lib/github/command.rb", "lib/github/extensions.rb", "lib/github/helper.rb", "lib/github/ui.rb", "setup.rb", "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"]
+  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.3.5}
+  s.summary = %q{The official `github` command line helper for simplifying your GitHub experience.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<text-format>, [">= 0"])
+    else
+      s.add_dependency(%q<text-format>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<text-format>, [">= 0"])
+  end
+end

data/lib/commands/commands.rb

@@ -0,0 +1,247 @@
+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 "Automatically set configuration info, or pass args to specify."
+usage "github config [my_username] [my_repo_name]"
+command :config do |user, repo|
+  user ||= ENV['USER']
+  repo ||= File.basename(FileUtils.pwd)
+  git "config --global github.user #{user}"
+  git "config github.repo #{repo}"
+  puts "Configured with github.user #{user}, github.repo #{repo}"
+end
+
+desc "Open this repo in a web browser."
+usage "github browse [user] [branch]"
+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 given user/project in a web browser'
+usage 'github open [user/project]'
+command :open do |arg|
+  helper.open "http://github.com/#{arg}"
+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 == helper.origin ? -1 : b == helper.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."
+usage "github track remote [user]"
+usage "github track remote [user/repo]"
+usage "github track [user]"
+usage "github track [user/repo]"
+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 all refs from a user"
+command :fetch_all do |user|
+  GitHub.invoke(:track, user) unless helper.tracking?(user)
+  git "fetch #{user}"
+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)
+
+  die "Unknown branch (#{branch}) specified" unless helper.remote_branch?(user, branch)
+  die "Unable to switch branches, your current branch has uncommitted changes" if helper.branch_dirty?
+
+  puts "Fetching #{user}/#{branch}"
+  git "fetch #{user} #{branch}:refs/remotes/#{user}/#{branch}"
+  git "update-ref refs/heads/#{user}/#{branch} refs/remotes/#{user}/#{branch}"
+  git_exec "checkout #{user}/#{branch}"
+end
+
+desc "Pull from a remote."
+usage "github pull [user] [branch]"
+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?
+
+  if !helper.network_members.include?(user)
+    git_exec "#{helper.argv.join(' ')}".strip
+    return
+  end
+
+  branch ||= 'master'
+  GitHub.invoke(:track, user) unless helper.tracking?(user)
+
+  die "Unable to switch branches, your current branch has uncommitted changes" if helper.branch_dirty?
+
+  if options[:merge]
+    git_exec "pull #{user} #{branch}"
+  else
+    puts "Switching to #{user}-#{branch}"
+    git "fetch #{user}"
+    git_exec "checkout -b #{user}/#{branch} #{user}/#{branch}"
+  end
+end
+
+desc "Clone a repo. Uses ssh if current user is "
+usage "github clone [user] [repo] [dir]"
+flags :ssh => "Clone using the git@github.com style url."
+flags :search => "Search for [user|repo] and clone selected repository"
+command :clone do |user, repo, dir|
+  die "Specify a user to pull from" if user.nil?
+  if options[:search]
+    query = [user, repo, dir].compact.join(" ")
+    data = JSON.parse(open("http://github.com/api/v1/json/search/#{URI.escape query}").read)
+    if (repos = data['repositories']) && !repos.nil? && repos.length > 0
+      repos = repos.map { |r| "#{r['username']}/#{r['name']}"}.sort.uniq
+      if user_repo = GitHub::UI.display_select_list(repos)
+        user, repo = user_repo.split('/', 2)
+      end
+    end
+    die "Perhaps try another search" unless user && repo
+  end
+
+  if user.include?('/') && !user.include?('@') && !user.include?(':')
+    die "Expected user/repo dir, given extra argument" if dir
+    (user, repo), dir = [user.split('/', 2), repo]
+  end
+
+  if repo
+    if options[:ssh] || current_user?(user)
+      git_exec "clone git@github.com:#{user}/#{repo}.git" + (dir ? " #{dir}" : "")
+    else
+      git_exec "clone git://github.com/#{user}/#{repo}.git" + (dir ? " #{dir}" : "")
+    end
+  else
+    git_exec "#{helper.argv.join(' ')}".strip
+  end
+end
+
+desc "Generate the text for a pull request."
+usage "github pull-request [user] [branch]"
+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} #{helper.origin}"
+  end
+end
+
+desc "Create a new, empty GitHub repository"
+usage "github create [repo]"
+flags :markdown => 'Create README.markdown'
+flags :mdown => 'Create README.mdown'
+flags :textile => 'Create README.textile'
+flags :rdoc => 'Create README.rdoc'
+flags :rst => 'Create README.rst'
+flags :private => 'Create private repository'
+command :create do |repo|
+  sh "curl -F 'repository[name]=#{repo}' -F 'repository[public]=#{!options[:private]}' -F 'login=#{github_user}' -F 'token=#{github_token}' http://github.com/repositories"
+  mkdir repo
+  cd repo
+  git "init"
+  extension = options.keys.first
+  touch extension ? "README.#{extension}" : "README"
+  git "add *"
+  git "commit -m 'First commit!'"
+  git "remote add origin git@github.com:#{github_user}/#{repo}.git"
+  git_exec "push origin master"
+end
+
+desc "Forks a GitHub repository"
+usage "github fork"
+usage "github fork [user]/[repo]"
+command :fork do |user, repo|
+  if repo.nil?
+    if user
+      user, repo = user.split('/')
+    else
+      unless helper.remotes.empty?
+        is_repo = true
+        user = helper.owner
+        repo = helper.project
+      else
+        die "Specify a user/project to fork, or run from within a repo"
+      end
+    end
+  end
+
+  sh "curl -F 'login=#{github_user}' -F 'token=#{github_token}' http://github.com/#{user}/#{repo}/fork"
+
+  url = "git@github.com:#{github_user}/#{repo}.git"
+  if is_repo
+    git "config remote.origin.url #{url}"
+    puts "#{user}/#{repo} forked"
+  else
+    puts "Giving GitHub a moment to create the fork..."
+    sleep 3
+    git_exec "clone #{url}"
+  end
+end
+
+desc "Create a new GitHub repository from the current local repository"
+flags :private => 'Create private repository'
+command 'create-from-local' do
+  cwd = sh "pwd"
+  repo = File.basename(cwd)
+  is_repo = !git("status").match(/fatal/)
+  raise "Not a git repository. Use gh create instead" unless is_repo
+  sh  "curl -F 'repository[name]=#{repo}' -F 'repository[public]=#{!options[:private].inspect} -F 'login=#{github_user}' -F 'token=#{github_token}' http://github.com/repositories"
+  git "remote add origin git@github.com:#{github_user}/#{repo}.git"
+  git_exec "push origin master"
+end
+
+desc "Search GitHub for the given repository name."
+usage "github search [query]"
+command :search do |query|
+  die "Usage: github search [query]" if query.nil?
+  data = JSON.parse(open("http://github.com/api/v1/json/search/#{URI.escape query}").read)
+  if (repos = data['repositories']) && !repos.nil? && repos.length > 0
+    puts repos.map { |r| "#{r['username']}/#{r['name']}"}.sort.uniq
+  else
+    puts "No results found"
+  end
+end