defunkt-github 0.1.4 → 0.2.1

data/README

@@ -17,7 +17,7 @@ Run it:
 
 
 =============
-Pulling Changes
+Pulling Upstream Changes
 =============
 
 Let's say you just forked `github-gem` on GitHub from defunkt.
@@ -44,6 +44,113 @@ 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.
+
+==========
+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:
+
+  $ git 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:
+
+  $ git 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).
+
+
 ==========
 Contributors
 ==========
@@ -52,3 +159,6 @@ Contributors
 - maddox
 - halorgium
 - kballard
+- mojombo
+- schacon
+

data/commands/commands.rb

@@ -20,14 +20,84 @@ command :browse do |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
+desc "Project network tools - sub-commands : web [user], list, fetch, commits"
+flags :after => "Only show commits after a certain date"
+flags :before => "Only show commits before a certain date"
+flags :shas => "Only show shas"
+flags :project => "Filter commits on a certain project"
+flags :author => "Filter commits on a email address of author"
+flags :applies => "Filter commits to patches that apply cleanly"
+flags :nocache => "Do not use the cached network data"
+flags :cache => "Use the network data even if it's expired"
+flags :sort => "How to sort : date(*), branch, author"
+flags :common => "Show common branch point"
+command :network do |command, user|
+  return if !helper.project
+  user ||= helper.owner
+
+  case command
+  when 'web'
     helper.open helper.network_page_for(user)
+  when 'list'
+    data = get_network_data(user, options)
+    data['users'].each do |hsh|
+      puts [ hsh['name'].ljust(20), hsh['heads'].map {|a| a['name']}.uniq.join(', ') ].join(' ')
+    end
+  when 'fetch'
+    # fetch each remote we don't have
+    data = get_network_data(user, options)
+    data['users'].each do |hsh|
+      u = hsh['name']
+      GitHub.invoke(:track, u) unless helper.tracking?(u)
+      puts "fetching #{u}"
+      GitHub.invoke(:fetch_all, u)
+    end
+  when 'commits'
+    # show commits we don't have yet
+    ids = []
+    data = get_network_data(user, options)
+    data['users'].each do |hsh|
+      u = hsh['name']
+      user_ids = hsh['heads'].map { |a| a['id'] }
+      user_ids.each do |id|
+        if !helper.has_commit?(id)
+          GitHub.invoke(:track, u) unless helper.tracking?(u)
+          puts "fetching #{u}"
+          GitHub.invoke(:fetch_all, u)
+        end
+      end
+      ids += user_ids
+    end
+    ids.uniq!
+    
+    # check that we have all these shas locally
+        
+    local_heads = helper.local_heads
+    local_heads_not = local_heads.map { |a| "^#{a}"}
+    looking_for = (ids - local_heads) + local_heads_not
+    commits = helper.get_commits(looking_for)
+        
+    cherry = []
+    ids.each do |id|
+      cherry += helper.get_cherry(id)
+    end
+    if cherry.size > 0
+      helper.print_network_cherry_help if !options[:shas]
+      helper.print_commits(cherry, commits, options)
+    else
+      puts "no unapplied commits"
+    end
+  else
+    helper.print_network_help
   end
 end
 
+desc "Ignore a SHA (from 'github network commits')"
+command :ignore do |sha|
+  commits = helper.resolve_commits(sha)
+  helper.ignore_shas(commits)             # add to .git/ignore-shas file
+end
+
 desc "Info about this project."
 command :info do
   puts "== Info for #{helper.project}"
@@ -61,6 +131,12 @@ command :track do |remote, user|
   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?
@@ -69,7 +145,7 @@ command :fetch do |user, branch|
   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}"
+  git_exec "checkout -b #{user}/#{branch} refs/remotes/#{user}/#{branch}" 
 end
 
 desc "Pull from a remote."

data/commands/helpers.rb

@@ -34,6 +34,106 @@ helper :url_for do |remote|
   `git config --get remote.#{remote}.url`.chomp
 end
 
+helper :local_heads do
+  `git show-ref --heads --hash`.split("\n")
+end
+
+helper :has_commit? do |sha|
+  `git show #{sha} >/dev/null 2>/dev/null`
+  $?.exitstatus == 0
+end
+
+helper :resolve_commits do |treeish|
+  if treeish
+    if treeish.match(/\.\./)
+      commits = `git rev-list #{treeish}`.split("\n")
+    else
+      commits = `git rev-parse #{treeish}`.split("\n")
+    end
+  else
+    # standard in
+    puts 'reading from stdin...'
+    commits = $stdin.read.split("\n") 
+  end
+  commits.select { |a| a.size == 40 } # only the shas, not the ^SHAs
+end
+
+helper :ignore_file_path do
+  dir = `git rev-parse --git-dir`.chomp
+  File.join(dir, 'ignore-shas')
+end
+
+helper :ignore_sha_array do
+  File.open( ignore_file_path ) { |yf| YAML::load( yf ) } rescue {}
+end
+
+helper :ignore_shas do |shas|
+  ignores = ignore_sha_array
+  shas.each do |sha|
+    puts 'ignoring ' + sha
+    ignores[sha] = true
+  end
+  File.open( ignore_file_path, 'w' ) do |out|
+    YAML.dump( ignores, out )
+  end
+end
+
+helper :get_commits do |rev_array|
+  list = rev_array.select { |a| has_commit?(a) }.join(' ')
+  `git log --pretty=format:"%H::%ae::%s::%ar::%ad" --no-merges #{list}`.split("\n").map { |a| a.split('::') }
+end
+
+helper :get_cherry do |branch|
+  `git cherry HEAD #{branch} | git name-rev --stdin`.split("\n").map { |a| a.split(' ') }
+end
+
+helper :get_common do |branch|
+  `git rev-list ..#{branch} --boundary | tail -1 | git name-rev --stdin`.split(' ')[1] rescue 'unknown'
+end
+
+helper :print_commits do |cherries, commits, options|
+  ignores = ignore_sha_array
+  our_commits = cherries.map { |item| c = commits.assoc(item[1]); [item, c] if c }
+  
+  case options[:sort]
+  when 'branch'
+    our_commits.sort! { |a, b| a[0][2] <=> b[0][2] }
+  when 'author'
+    our_commits.sort! { |a, b| a[1][1] <=> b[1][1] }
+  else
+    our_commits.sort! { |a, b| Date.parse(a[1][4]) <=> Date.parse(b[1][4]) }
+  end
+  
+  shown_commits = {}
+  before = Date.parse(options[:before]) if options[:before] rescue puts 'cant parse before date'
+  after = Date.parse(options[:after]) if options[:after] rescue puts 'cant parse after date'
+  our_commits.each do |cherry, commit|
+    status, sha, ref_name = cherry
+    next if shown_commits[sha] || ignores[sha]
+    next if options[:project] && !ref_name.match(Regexp.new(options[:project]))
+    ref_name = ref_name.gsub('remotes/', '')
+    if status == '+' && commit
+      next if options[:author] && !commit[1].match(Regexp.new(options[:author]))
+      next if options[:before] && before && (before < Date.parse(commit[4])) 
+      next if options[:after] && after && (after > Date.parse(commit[4])) 
+      next if options[:applies] && !applies_cleanly(sha)
+      if options[:shas]
+        puts sha
+      else
+        common = options[:common] ? get_common(sha) : ''
+        puts [sha[0,6], ref_name.ljust(25), commit[1][0,20].ljust(21), 
+            commit[2][0, 36].ljust(38), commit[3], common].join(" ")
+      end
+    end
+    shown_commits[sha] = true
+  end
+end
+
+helper :applies_cleanly do |sha|
+  `git diff ...#{sha} | git apply --check >/dev/null 2>/dev/null`
+  $?.exitstatus == 0
+end
+
 helper :remotes do
   regexp = '^remote\.(.+)\.url$'
   `git config --get-regexp '#{regexp}'`.split(/\n/).inject({}) do |memo, line|
@@ -105,6 +205,11 @@ helper :network_page_for do |user|
   "https://github.com/#{user}/#{project}/network"
 end
 
+helper :network_meta_for do |user|
+  "http://github.com/#{user}/#{project}/network_meta"
+end
+
+
 helper :has_launchy? do |blk|
   begin
     gem 'launchy'
@@ -121,3 +226,45 @@ helper :open do |url|
   }
 end
 
+helper :print_network_help do
+  puts "
+You have to provide a command :
+
+    web [user]     - opens your web browser to the network graph page for this
+                     project, or for the graph page for [user] if provided
+                 
+    list           - shows the projects in your network that have commits
+                     that you have not pulled in yet, and branch names 
+                     
+    fetch          - adds all projects in your network as remotes and fetches
+                     any objects from them that you don't have yet
+  
+    commits        - will show you a list of all commits in your network that
+                     you have not ignored or have not merged or cherry-picked.
+                     This will automatically fetch objects you don't have yet.
+                   
+      --project (user/branch)  - only show projects that match string
+      --author (email)         - only show projects that match string
+      --after (date)           - only show commits after date
+      --before (date)          - only show commits before date
+      --shas                   - only print shas (can pipe through 'github ignore')
+      --applies                - filter to patches that still apply cleanly
+      --sort                   - how to sort the commits (date, branch, author)
+"
+end
+
+helper :print_network_cherry_help do
+  puts "
+=========================================================================================
+These are all the commits that other people have pushed that you have not
+applied or ignored yet (see 'github ignore'). Some things you might want to do:
+
+* You can run 'github fetch user/branch' (sans '~N') to pull into a local branch for testing
+* You can run 'git cherry-pick [SHA]' to apply a single patch
+* You can run 'git merge user/branch' to merge a commit and all the '~N' variants.
+* You can ignore all of a projects commits with 'github ignore ..user/branch'
+=========================================================================================
+
+"
+end
+

data/github-gem.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name = %q{github}
+  s.version = "0.2.1"
+
+  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, Scott Chacon"]
+  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/command.rb

@@ -47,6 +47,45 @@ module GitHub
       Shell.new(*command).run
     end
 
+    def get_network_data(user, options)
+      if options[:cache] && has_cache?
+        return get_cache
+      end
+      if cache_expired? || options[:nocache] || !has_cache?
+        return cache_data(user)
+      else
+        return get_cache
+      end
+    end
+    
+    def network_cache_path
+      dir = `git rev-parse --git-dir`.chomp
+      File.join(dir, 'network-cache')
+    end
+    
+    def cache_data(user)
+      raw_data = open(helper.network_meta_for(user)).read
+      File.open( network_cache_path, 'w' ) do |out|
+        out.write(raw_data)
+      end
+      data = JSON.parse(raw_data)
+    end
+    
+    def cache_expired?
+      return true if !has_cache?
+      age = Time.now - File.stat(network_cache_path).mtime
+      return true if age > (60 * 60) # 1 hour
+      false
+    end
+    
+    def has_cache?
+      File.file?(network_cache_path)
+    end
+    
+    def get_cache
+      JSON.parse(File.read(network_cache_path))
+    end
+    
     def die(message)
       puts "=> #{message}"
       exit!
@@ -60,14 +99,14 @@ module GitHub
       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
+          self.replace @out = out
         elsif err.any?
-          replace @error = err
+          self.replace @error = err
         end
       end
 

data/lib/github.rb

@@ -3,6 +3,9 @@ require 'github/extensions'
 require 'github/command'
 require 'github/helper'
 require 'rubygems'
+require 'open-uri'
+require 'json'
+require 'yaml'
 
 ##
 # Starting simple.

data/spec/command_spec.rb

@@ -27,11 +27,16 @@ describe GitHub::Command do
     hi.out?.should be(true)
     hi.error?.should be(false)
     hi.command.should == "echo hi"
-    bye = @command.sh("echo bye >&2")
+    if RUBY_PLATFORM =~ /mingw|mswin/
+      command = "cmd /c echo bye >&2"
+    else
+      command = "echo bye >&2" 
+    end
+    bye = @command.sh(command)
     bye.should == "bye"
     bye.out?.should be(false)
     bye.error?.should be(true)
-    bye.command.should == "echo bye >&2"
+    bye.command.should == command
   end
 
   it "should return the results of a git operation" do

data/spec/helper_spec.rb

@@ -194,10 +194,17 @@ remote.nex3.url git://github.com/nex3/github-gem.git
     it "should launch the URL when Launchy is installed" do
       begin
         require 'launchy'
+
         @helper.should_receive(:gem).with('launchy')
-        # @helper.should_receive(:has_launchy?).and_return { |blk| blk.call }
-        Launchy::Browser.next_instance.should_receive(:visit).with("http://www.google.com")
-        @helper.open "http://www.google.com"
+        Launchy::Browser.next_instance.tap do |browser|
+          browser.should_receive(:my_os_family).any_number_of_times.and_return :windows # avoid forking
+          if RUBY_PLATFORM =~ /mingw|mswin/
+            browser.should_receive(:system).with("start http://www.google.com")
+          else
+            browser.should_receive(:system).with("/usr/bin/open http://www.google.com")
+          end
+          @helper.open "http://www.google.com"
+        end
       rescue LoadError
         fail "Launchy is required for this spec"
       end

data/spec/ui_spec.rb

@@ -49,14 +49,14 @@ describe "github" do
 
   # -- network --
   specify "network should open the network page for this repo" do
-    running :network do
+    running :network, 'web' do
       setup_url_for
       @helper.should_receive(:open).once.with("https://github.com/user/project/network")
     end
   end
 
   specify "network defunkt should open the network page for defunkt's fork" do
-    running :network, "defunkt" do
+    running :network, 'web', "defunkt" do
       setup_url_for
       @helper.should_receive(:open).once.with("https://github.com/defunkt/project/network")
     end
@@ -421,7 +421,7 @@ EOF
       if @stdout_mock.nil?
         output = ""
         @stdout_mock = DeferredMock.new(output)
-        STDOUT.should_receive(:write).any_number_of_times do |str|
+        $stdout.should_receive(:write).any_number_of_times do |str|
           output << str
         end
       end
@@ -432,7 +432,7 @@ EOF
       if @stderr_mock.nil?
         output = ""
         @stderr_mock = DeferredMock.new(output)
-        STDERR.should_receive(:write).any_number_of_times do |str|
+        $stderr.should_receive(:write).any_number_of_times do |str|
           output << str
         end
       end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
 name: defunkt-github
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.2.1
 platform: ruby
 authors: 
-- Chris Wanstrath, Kevin Ballard
+- Chris Wanstrath, Kevin Ballard, Scott Chacon
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -45,7 +45,7 @@ files:
 - spec/spec_helper.rb
 - spec/ui_spec.rb
 - spec/windoze_spec.rb
-- github.gemspec
+- github-gem.gemspec
 has_rdoc: true
 homepage: http://github.com/
 post_install_message: