git-review 0.5.1 → 0.6.1

data/lib/git-review.rb

@@ -1,11 +1,10 @@
-require 'json'
-require 'launchy'
+# Octokit is used to access GitHub's API.
 require 'octokit'
+# Launchy is used in 'browse' to open a browser.
+require 'launchy'
 
 class GitReview
 
-  REVIEW_CACHE_FILE = '.git/review_cache.json'
-
   ## COMMANDS ##
 
   # Default command to show a quick reference of available commands.
@@ -14,7 +13,7 @@ class GitReview
     puts 'Manage review workflow for projects hosted on GitHub (using pull requests).'
     puts ''
     puts 'Available commands:'
-    puts '   list [--reverse]          List all open requests.'
+    puts '   list [--reverse]          List all pending requests.'
     puts '   show <number> [--full]    Show details of a single request.'
     puts '   browse <number>           Open a browser window and review a specified request.'
     puts '   checkout <number>         Checkout a specified request\'s changes to your local repository.'
@@ -23,98 +22,89 @@ class GitReview
     puts '   create                    Create a new request.'
   end
 
-  # List all open requests.
+  # List all pending requests.
   def list
-    open_requests = get_pull_info
-    if open_requests.size == 0
-      puts "No open requests for '#{source_repo}/#{source_branch}'"
-      return
+    @pending_requests.reverse! if @args.shift == '--reverse'
+    output = @pending_requests.collect do |pending_request|
+      # Find only pending (= unmerged) requests and output summary. GitHub might
+      # still think of them as pending, as it doesn't know about local changes.
+      next if merged?(pending_request['head']['sha'])
+      line = format_text(pending_request['number'], 8)
+      date_string = Date.parse(pending_request['updated_at']).strftime('%d-%b-%y')
+      line += format_text(date_string, 11)
+      line += format_text(pending_request['comments'], 10)
+      line += format_text(pending_request['title'], 91)
+      line
     end
-    puts "Open requests for '#{source_repo}/#{source_branch}'"
-    puts 'ID     Date       Comments   Title'
-    open_requests.reverse! if @args.shift == '--reverse'
-    open_requests.each do |pull|
-      next unless not_merged?(pull['head']['sha'])
-      line = []
-      line << format_text(pull['number'], 6)
-      line << format_text(Date.parse(pull['created_at']).strftime('%d-%b-%y'), 10)
-      line << format_text(pull['comments'], 10)
-      line << format_text(pull['title'], 94)
-      puts line.join ' '
+    if output.compact.empty?
+      puts "No pending requests for '#{source}'"
+      return
     end
+    puts "Pending requests for '#{source}'"
+    puts 'ID      Date       Comments  Title'
+    puts output.compact
   end
 
   # Show details of a single request.
   def show
-    return unless review_exists?
-    option = @args.shift
-    puts "Number   : #{@review['number']}"
-    puts "Label    : #{@review['head']['label']}"
-    puts "Created  : #{@review['created_at']}"
-    puts "Votes    : #{@review['votes']}"
-    puts "Comments : #{@review['comments']}"
-    puts
-    puts "Title    : #{@review['title']}"
+    return unless request_exists?
+    option = @args.shift == '--full' ? '' : '--stat '
+    sha = @pending_request['head']['sha']
+    puts "Number   : #{@pending_request['number']}"
+    puts "Label    : #{@pending_request['head']['label']}"
+    puts "Created  : #{@pending_request['created_at']}"
+    puts "Votes    : #{@pending_request['votes']}"
+    puts "Comments : #{@pending_request['comments']}"
+    puts ''
+    puts "Title    : #{@pending_request['title']}"
     puts "Body     :"
-    puts
-    puts @review['body']
-    puts
+    puts ''
+    puts @pending_request['body']
+    puts ''
     puts '------------'
-    puts
-    if option == '--full'
-      exec "git diff --color=always HEAD...#{@review['head']['sha']}"
-    else
-      puts "cmd: git diff HEAD...#{@review['head']['sha']}"
-      puts git("diff --stat --color=always HEAD...#{@review['head']['sha']}")
-    end
+    puts ''
+    puts "cmd: git diff #{option}HEAD...#{sha}"
+    puts git("diff --color=always #{option}HEAD...#{sha}")
   end
 
   # Open a browser window and review a specified request.
   def browse
-    Launchy.open(@review['html_url']) if review_exists?
+    Launchy.open(@pending_request['html_url']) if request_exists?
   end
 
   # Checkout a specified request's changes to your local repository.
   def checkout
-    return unless review_exists?
-    git "co origin/#{@review['head']['ref']}"
+    git "co origin/#{@pending_request['head']['ref']}" if request_exists?
   end
 
   # Accept a specified request by merging it into master.
   def accept
-    return unless review_exists?
+    return unless request_exists?
     option = @args.shift
-    if @review['head']['repository']
-      o = @review['head']['repository']['owner']
-      r = @review['head']['repository']['name']
-    else # they deleted the source repo
-      o = @review['head']['user']['login']
-      purl = @review['patch_url']
-      puts "Sorry, #{o} deleted the source repository, git-review doesn't support this."
+    unless @pending_request['head']['repository']
+      # Someone deleted the source repo.
+      user = @pending_request['head']['user']['login']
+      url = @pending_request['patch_url']
+      puts "Sorry, #{user} deleted the source repository, git-review doesn't support this."
       puts "You can manually patch your repo by running:"
       puts
-      puts "  curl #{purl} | git am"
+      puts "  curl #{url} | git am"
       puts
       puts "Tell the contributor not to do this."
       return false
     end
-    s = @review['head']['sha']
-    message = "Accepting request ##{@review['number']} from #{o}/#{r}\n\n---\n\n"
-    message += @review['body'].gsub("'", '')
-    if option == '--log'
-      message += "\n\n---\n\nMerge Log:\n"
-      puts cmd = "git merge --no-ff --log -m '#{message}' #{s}"
-    else
-      puts cmd = "git merge --no-ff -m '#{message}' #{s}"
-    end
+    message = "Accepting request and merging into '#{target}':\n\n"
+    message += "#{@pending_request['title']}\n\n"
+    message += "#{@pending_request['body']}\n\n"
+    puts cmd = "git merge --no-ff #{option} -m '#{message}' #{@pending_request['head']['sha']}"
     exec(cmd)
   end
 
   # Decline and close a specified request.
   def decline
-    return unless review_exists?
-    Octokit.post("issues/close/#{source_repo}/#{@review['number']}")
-    puts "Successfully declined request." unless review_exists?(@review['number'])
+    return unless request_exists?
+    Octokit.post("issues/close/#{source_repo}/#{@pending_request['number']}")
+    puts "Successfully declined request." unless request_exists?(@pending_request['number'])
   end
 
   # Create a new request.
@@ -122,8 +112,8 @@ class GitReview
   def create
     # TODO: Create and push to a remote branch if necessary.
     # Gather information.
-    last_review_id = get_pull_info.collect{|review| review['number']}.sort.last.to_i
-    title = "[Review] Request from '#{github_login}' @ '#{source_repo}/#{source_branch}'"
+    last_request_id = @pending_requests.collect{|req| req['number'] }.sort.last.to_i
+    title = "[Review] Request from '#{github_login}' @ '#{source}'"
     # TODO: Insert commit messages (that are not yet in master) into body (since this will be displayed inside the mail that is sent out).
     body = "You are requested to review the following changes:"
     # Create the actual pull request.
@@ -131,8 +121,8 @@ class GitReview
     # Switch back to target_branch and check for success.
     git "co #{target_branch}"
     update
-    potential_new_review = get_pull_info.find{ |review| review['title'] == title}
-    puts 'Review request successfully created.' if potential_new_review['number'] > last_review_id
+    potential_new_request = @pending_requests.find{ |req| req['title'] == title }
+    puts 'Successfully created new request.' if potential_new_request['number'] > last_request_id
   end
 
   # Start a console session (used for debugging).
@@ -152,37 +142,46 @@ class GitReview
     command = args.shift
     @user, @repo = repo_info
     @args = args
-    configure
+    configure_github_access
     if command && self.respond_to?(command)
       update
       self.send command
     else
-      unless command.blank? or %w(-h --help).include?(command)
+      unless command.nil? or command.empty? or %w(-h --help).include?(command)
         puts "git-review: '#{command}' is not a valid command.\n\n"
       end
       help
     end
   end
 
-  # Get latest changes from GitHub.
-  def update
-    cache_pull_info
-    fetch_stale_forks
-  end
-
-  # Check existence of specified review and assign @review.
-  def review_exists?(review_id = nil)
-    # NOTE: If review_id is not set explicitly we might need to update to get the
+  # Check existence of specified request and assign @pending_request.
+  def request_exists?(request_id = nil)
+    # NOTE: If request_id is set explicitly we might need to update to get the
     # latest changes from GitHub, as this is called from within another method.
-    update if review_id.nil?
-    review_id ||= @args.shift.to_i
-    if review_id == 0
+    update unless request_id.nil?
+    request_id ||= @args.shift.to_i
+    if request_id == 0
       puts "Please specify a valid ID."
       return false
     end
-    @review = get_pull_info.find{ |review| review['number'] == review_id}
-    puts "Review '#{review_id}' does not exist." unless @review
-    not @review.nil?
+    @pending_request = @pending_requests.find{ |req| req['number'] == request_id }
+    puts "Request '#{request_id}' does not exist." unless @pending_request
+    not @pending_request.nil?
+  end
+
+  # Get latest changes from GitHub.
+  def update
+    @pending_requests = Octokit.pull_requests(source_repo)
+    repos = @pending_requests.collect do |req|
+      repo = req['head']['repository']
+      # Check if fork and commits still exist.
+      next if repo.nil? or not has_sha?(req['head']['sha'])
+      "#{repo['owner']}/#{repo['name']}"
+    end
+    host = URI.parse(github_endpoint).host
+    repos.uniq.compact.each do |repo|
+      git("fetch git@#{host}:#{repo}.git +refs/heads/*:refs/pr/#{repo}/*")
+    end
   end
 
   # System call to 'git'.
@@ -192,9 +191,9 @@ class GitReview
     s
   end
 
-  # Display helper to make output more beautiful.
+  # Display helper to make output more configurable.
   def format_text(info, size)
-    info.to_s.gsub("\n", ' ')[0, size].ljust(size)
+    info.to_s.gsub("\n", ' ')[0, size-1].ljust(size)
   end
 
   # Returns a string that specifies the source repo.
@@ -207,6 +206,11 @@ class GitReview
     git('branch', false).match(/\*(.*)/)[0][2..-1]
   end
 
+  # Returns a string consisting of source repo and branch.
+  def source
+    "#{source_repo}/#{source_branch}"
+  end
+
   # Returns a string that specifies the target repo.
   def target_repo
     # TODO: Enable possibility to manually override this and set arbitrary repositories.
@@ -219,131 +223,88 @@ class GitReview
     'master'
   end
 
-  def fetch_stale_forks
-    pulls = get_pull_info
-    repos = {}
-    pulls.each do |pull|
-      next if pull['head']['repository'].nil? # Fork has been deleted
-      o = pull['head']['repository']['owner']
-      r = pull['head']['repository']['name']
-      s = pull['head']['sha']
-      if !has_sha(s)
-        repo = "#{o}/#{r}"
-        repos[repo] = true
-      end
-    end
-    if github_credentials_provided?
-      endpoint = "git@github.com:"
-    else
-      endpoint = github_endpoint + "/"
-    end
-    repos.each do |repo, bool|
-      puts "fetching #{repo}"
-      git("fetch #{endpoint}#{repo}.git +refs/heads/*:refs/pr/#{repo}/*")
-    end
+  # Returns a string consisting of target repo and branch.
+  def target
+    "#{target_repo}/#{target_branch}"
   end
 
-  def has_sha(sha)
+  # Returns a boolean stating whether a specified commit exists.
+  # TODO: Check if this is still necessary, since we don't cache anymore.
+  def has_sha?(sha)
     git("show #{sha} 2>&1")
     $?.exitstatus == 0
   end
 
-  def not_merged?(sha)
-    commits = git("rev-list #{sha} ^HEAD 2>&1")
-    commits.split("\n").size > 0
+  # Returns a boolean stating whether a specified commit has already been merged.
+  def merged?(sha)
+    not git("rev-list #{sha} ^HEAD 2>&1").split("\n").size > 0
   end
 
-  # PRIVATE REPOSITORIES ACCESS
-
-  def configure
-    Octokit.configure do |config|
-      config.login = github_login
-      config.token = github_token
-      config.endpoint = github_endpoint
+  # Checks '~/.gitconfig' for credentials and
+  def configure_github_access
+    if (github_token.empty? or github_login.empty?)
+      puts 'Please update your git config and provide your GitHub user name and token.'
+      puts 'Some commands won\'t work properly without these credentials.'
+    else
+      Octokit.configure do |config|
+        config.login = github_login
+        config.token = github_token
+        config.endpoint = github_endpoint
+      end
     end
   end
 
+  # Get GitHub user name.
   def github_login
     git("config --get-all github.user")
   end
 
+  # Get GitHub token.
   def github_token
     git("config --get-all github.token")
   end
 
+  # Determine GitHub endpoint (defaults to 'https://github.com/').
   def github_endpoint
     host = git("config --get-all github.host")
-    if host.size > 0
-      host
-    else
-      'https://github.com'
-    end
-  end
-
-  # API/DATA HELPER FUNCTIONS #
-
-  def github_credentials_provided?
-    if github_token.empty? && github_login.empty?
-      return false
-    end
-    true
-  end
-
-  def get_pull_info
-    get_data(REVIEW_CACHE_FILE)['review']
-  end
-
-  def get_data(file)
-    JSON.parse(File.read(file))
-  end
-
-  def cache_pull_info
-    response = Octokit.pull_requests(source_repo)
-    save_data({'review' => response}, REVIEW_CACHE_FILE)
-  end
-
-  def save_data(data, file)
-    File.open(file, "w+") do |f|
-      f.puts data.to_json
-    end
-  end
-
-  def github_insteadof_matching(c, u)
-    first = c.collect {|k,v| [v, /url\.(.*github\.com.*)\.insteadof/.match(k)]}.
-              find {|v,m| u.index(v) and m != nil}
-    if first
-      return first[0], first[1][1]
-    end
-    return nil, nil
-  end
-
-  def github_user_and_proj(u)
-    # Trouble getting optional ".git" at end to work, so put that logic below
-    m = /github\.com.(.*?)\/(.*)/.match(u)
-    if m
-      return m[1], m[2].sub(/\.git\Z/, "")
-    end
-    return nil, nil
+    host.empty? ? 'https://github.com/' : host
   end
 
   def repo_info
-    c = {}
+    # Read config_hash from local git config.
+    config_hash = {}
     config = git('config --list')
     config.split("\n").each do |line|
-      k, v = line.split('=')
-      c[k] = v
+      key, value = line.split('=')
+      config_hash[key] = value
     end
-    u = c['remote.origin.url']
-
-    user, proj = github_user_and_proj(u)
-    if !(user and proj)
-      short, base = github_insteadof_matching(c, u)
+    # Extract user and project name from GitHub URL.
+    url = config_hash['remote.origin.url']
+    user, project = github_user_and_project(url)
+   # If there are no results yet, look for 'insteadof' substitutions in URL and try again.
+    unless (user and project)
+      short, base = github_insteadof_matching(config_hash, url)
       if short and base
-        u = u.sub(short, base)
-        user, proj = github_user_and_proj(u)
+        url = url.sub(short, base)
+        user, project = github_user_and_project(url)
       end
     end
-    [user, proj]
+    [user, project]
+  end
+
+  def github_insteadof_matching(config_hash, url)
+    first = config_hash.collect { |key,value|
+      [value, /url\.(.*github\.com.*)\.insteadof/.match(key)]
+    }.find { |value, match|
+      url.index(value) and match != nil
+    }
+    first ? [first[0], first[1][1]] : [nil, nil]
+  end
+
+  # Extract user and project name from GitHub URL.
+  def github_user_and_project(github_url)
+    matches = /github\.com.(.*?)\/(.*)/.match(github_url)
+    matches ? [matches[1], matches[2].sub(/\.git\z/, '')] : [nil, nil]
   end
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: git-review
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 5
   prerelease: 
   segments: 
   - 0
-  - 5
+  - 6
   - 1
-  version: 0.5.1
+  version: 0.6.1
 platform: ruby
 authors: 
 - Dominik Bamberger, Cristian Messel
@@ -15,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-14 00:00:00 +02:00
+date: 2011-07-18 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: json
+  name: launchy
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -32,24 +32,10 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: launchy
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: octokit
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -61,7 +47,7 @@ dependencies:
         - 1
         version: 0.5.1
   type: :runtime
-  version_requirements: *id003
+  version_requirements: *id002
 description: Manage review workflow for projects hosted on GitHub (using pull requests).
 email: bamberger.dominik@gmail.com
 executables: