reviewr 0.1.3 → 0.2.0

data/Manifest.txt

@@ -9,8 +9,11 @@ lib/reviewr/git.rb
 lib/reviewr/mailer.rb
 lib/reviewr/project.rb
 lib/reviewr/version.rb
+lib/reviewr/cli/accept.rb
+lib/reviewr/cli/command.rb
 lib/reviewr/cli/help.rb
 lib/reviewr/cli/main.rb
 lib/reviewr/cli/request.rb
+lib/reviewr/templates/accept_email.erb
 lib/reviewr/templates/commit_msg.erb
 lib/reviewr/templates/request_email.erb

data/README.md

@@ -6,7 +6,28 @@ git and github.com for version control.
 # Installation
     gem install reviewr
 
-# Requesting a code review
+# Usage
+
+Reviewr is designed to simplify code reviews for projects that revolve
+around a single 'master' repository with multiple contributors (i.e. a
+project that is hosted on github). It does this by providing a default
+work-flow that all developers can use.
+
+The general work-flow (at the moment) is:
+
+1. The coder issues a code review request through the 'request'
+command.
+2. The reviewer(s) review the code and comment on it through github
+3. If the code is good enough to merge it can be pulled into the
+master branch through the 'accept' command
+
+While this documentation is up to date (as of version 0.2.0) I am
+still experimenting with an ideal work-flow for these type of code
+reviews, so this code is subject to heavy change. If you have any
+suggestions send me an email or comment in the issue tracker as I
+would love further opinions.
+
+## Requesting a code review
     reviewr request <email>
 This will result in the following actions:
 
@@ -15,41 +36,37 @@ This will result in the following actions:
 * Push the code review branch to the remote repository
 * Send an email to <email> requesting a code review of the branch
   The email will include a link to Github's compare view for the
-  changes 
+  changes
 
-## Limitations
+## Accepting changes from a code review
+    reviewr accept <branch_name>
+This will result in the following actions:
 
-* Email can only be sent from a Gmail (or Google Apps for my domain)
-  address
+* Create a branch for the reviewed code
+* Rebase the reviewed code on the current branch
+* Merge in the commits
+* Push the merged branch
+* Delete the code review branch from the remote repo
+* Send an email to the requester of the review saying the changes have been
+  merged
 
-# TODO
+# Contributing
+
+## Reporting Bugs
 
-## Finish out the basic workflow
+Bugs are being managed using Github's issue tracking
 
-General workflow goes something like this:
+http://github.com/rhburrows/reviewr/issues
 
-Code, code, code. Decide changes are ready for review and run `reviewr
-request email@site.com`. This causes reviewr to:
+## Contributing Code
 
-* create a new branch with the name `review_0f38ef31` where `0f38ef31`
-is the SHA of the current commit
-* Add a commit to the branch with metadata about the request
-(requester name/email etc). 
-* push the branch to the origin repository
-* generate a github review url from the current head to the pushed
-review branch
-* Send an email to `email@site.com` with a nice message and the url
+Just fork the project on github and submit a pull request
 
-The reviewer then looks over the code on github and comments as
-necessary. If the code is acceptable the reviewer runs `reviewr accept
-review_0f38ef31`. reviewr will then:
+http://github.com/rhburrows/reviewr
+
+# TODO
 
-* fetch the review branch
-* attempt to merge the reviewed branch into the master
-* if it fails an error will be raised and execution will stop
-* if is succeeds the merged master will be pushed
-* the remote review branch will be deleted.
-* an email will be sent to the review requester saying the code was accepted
+## Add a reject code review command
 
 If the code the reviewer is checking is not acceptable, upon finishing
 comments on github the reviewer can run `reviewr reject
@@ -58,3 +75,9 @@ review_0f38ef31`. reviewr will:
 * Re-generate the github url for comparing to the current master
 * Send an email to the requester of the review saying the code has
 been rejected and to please see the comments on the linked page
+
+# Limitations
+
+* Email can only be sent from a Gmail (or Google Apps for my domain)
+  address
+* Only tested with git 1.7.0

data/lib/reviewr/cli.rb

@@ -1,6 +1,8 @@
 require 'reviewr/cli/main'
+require 'reviewr/cli/command'
 require 'reviewr/cli/help'
 require 'reviewr/cli/request'
+require 'reviewr/cli/accept'
 
 module Reviewr
   module CLI

data/lib/reviewr/cli/accept.rb

@@ -0,0 +1,33 @@
+module Reviewr
+  module CLI
+    class Accept < Command
+      def execute
+        merge_branch = project.current_branch
+
+        project.review_branch = arguments.first
+        prompt_for_user
+        project.fetch_review_branch
+        project.fetch_master
+        project.create_review_branch("origin/#{arguments.first}")
+
+        unless project.rebase_review
+          output.print "Branch '#{arguments.first}' won't merge cleanly"
+        else
+          # This must be run while on the review branch
+          project.to = project.requester_email
+
+          project.change_branch(merge_branch)
+          project.merge_commits
+          project.push_branch(merge_branch)
+          project.delete_remote_review_branch
+
+          Mailer.new(project).send(email_body)
+        end
+      end
+
+      def email_body
+        read_template('accept_email.erb')
+      end
+    end
+  end
+end

data/lib/reviewr/cli/command.rb

@@ -0,0 +1,55 @@
+module Reviewr
+  module CLI
+    class Command
+      attr_reader :project
+      attr_accessor :input, :output, :arguments
+
+      def initialize(project, input = STDIN, output = STDOUT)
+        @project = project
+        @input, @output = input, output
+      end
+
+      def call
+        execute
+      end
+
+      def prompt_for_user
+        output.print("Email (default #{project.user_email}): ")
+        email = input.gets.chomp
+        project.user_email = email unless email.empty?
+
+        output.print("Email password: ")
+        no_echo(input) do
+          project.email_password = input.gets.chomp
+        end
+        output.print("\n")
+
+        output.print("Remote repository (default origin): ")
+        repo = input.gets.chomp
+        project.remote_repo = repo unless repo.empty?
+      end
+
+      def read_template(name)
+        @templates ||= {}
+        @templates[name] ||= ERB.new(File.read(File.join(File.dirname(__FILE__),
+                                                         '..',
+                                                         'templates',
+                                                         name)))
+        @templates[name].result(binding)
+      end
+
+      private
+
+      def no_echo(input)
+        oldt = Termios.tcgetattr(input)
+        newt = oldt.dup
+        newt.lflag &= ~Termios::ECHO
+        Termios.tcsetattr(input, Termios::TCSANOW, newt)
+
+        yield
+
+        Termios.tcsetattr(input, Termios::TCSANOW, oldt)
+      end
+    end
+  end
+end

data/lib/reviewr/cli/help.rb

@@ -1,12 +1,8 @@
 module Reviewr
   module CLI
-    class Help
-      def call(command)
-        if command.nil?
-          usage
-        else
-          request_help
-        end
+    class Help < Command
+      def execute
+        usage
       end
 
       def usage

data/lib/reviewr/cli/main.rb

@@ -3,54 +3,33 @@ require 'termios'
 module Reviewr
   module CLI
     class Main
-      attr_reader :command
-      attr_accessor :project
+      attr_reader :command, :c
+      attr_accessor :arguments
 
       def initialize(args, input = STDIN, output = STDOUT)
         @command = args.shift
-        @project = Project.new(args.shift)
+        @arguments = args
         @input, @output = input, output
       end
 
       def run
-        case command
-        when "request"
-          prompt_for_user(@input, @output)
-          Request.new(project).call
-        else
-          #FIXME
-          Help.new.call(project.to)
-        end
+        build_command.call
       end
 
-      def prompt_for_user(input = STDIN, output = STDOUT)
-        output.print("Email (default #{project.user_email}): ")
-        email = input.gets.chomp
-        project.user_email = email unless email.empty?
-
-        output.print("Email password: ")
-        no_echo(input) do
-          project.email_password = input.gets.chomp
+      def build_command
+        unless @c
+          case command
+          when "request"
+            @c = Request.new(Project.new, @input, @output)
+          when "accept"
+            @c = Accept.new(Project.new, @input, @output)
+          else
+            @c = Help.new(Project.new, @input, @output)
+          end
+
+          @c.arguments = arguments
         end
-        output.print("\n")
-
-        output.print("Remote repository (default origin): ")
-        repo = input.gets.chomp
-        project.remote_repo = repo unless repo.empty?
-      end
-
-      private
-
-      #TODO, should this be somewhere better?
-      def no_echo(input)
-        oldt = Termios.tcgetattr(input)
-        newt = oldt.dup
-        newt.lflag &= ~Termios::ECHO
-        Termios.tcsetattr(input, Termios::TCSANOW, newt)
-
-        yield
-
-        Termios.tcsetattr(input, Termios::TCSANOW, oldt)
+        @c
       end
     end
   end

data/lib/reviewr/cli/request.rb

@@ -3,16 +3,12 @@ require 'forwardable'
 
 module Reviewr
   module CLI
-    class Request
-      attr_reader :project
-
-      def initialize(project)
-        @project = project
-      end
-
-      def call
+    class Request < Command
+      def execute
+        project.to = arguments.first
+        prompt_for_user
         original_branch = project.current_branch
-        project.create_review_branch
+        project.create_review_branch(original_branch)
         project.create_review_commit(commit_msg)
         project.push_review_branch
         Mailer.new(project).send(email_body)
@@ -31,17 +27,6 @@ module Reviewr
       def email_body
         read_template('request_email.erb')
       end
-
-      private
-
-      def read_template(name)
-        @templates ||= {}
-        @templates[name] ||= ERB.new(File.read(File.join(File.dirname(__FILE__),
-                                                         '..',
-                                                         'templates',
-                                                         name)))
-        @templates[name].result(binding)
-      end
     end
   end
 end

data/lib/reviewr/git.rb

@@ -20,8 +20,17 @@ module Reviewr
       execute('git show --pretty=format:"%H" HEAD').split("\n")[0]
     end
 
-    def create_branch(branch_name)
-      execute("git checkout -b #{branch_name}")
+    def rebase(base, branch)
+      conflict = execute("git rebase #{base} #{branch}").to_s.
+        include?("CONFLICT")
+      if conflict
+        execute('git rebase --abort')
+      end
+      !conflict
+    end
+
+    def create_branch(branch_name, base)
+      execute("git branch #{branch_name} #{base}")
     end
 
     def commit(msg)
@@ -37,6 +46,10 @@ module Reviewr
       execute("git checkout #{branch_name}")
     end
 
+    def fetch(branch_name)
+      execute("git fetch #{remote_repo} #{branch_name}")
+    end
+
     def user_email
       email = execute('git config user.email')
       email && email.chomp
@@ -56,6 +69,18 @@ module Reviewr
       r && r.split(/\s+/)[0]
     end
 
+    def cherry(from, to)
+      execute("git cherry #{from} #{to}")
+    end
+
+    def cherry_pick(commit)
+      execute("git cherry-pick -s #{commit}")
+    end
+
+    def log(n)
+      execute("git log -n #{n}")
+    end
+
     def execute(cmd)
       `#{cmd}`
     end

data/lib/reviewr/project.rb

@@ -4,19 +4,32 @@ module Reviewr
   class Project
     extend Forwardable
 
-    attr_reader :to, :git, :email_server
-    attr_accessor :email_password
-    attr_writer :user_email
+    attr_reader :git, :email_server
+    attr_accessor :email_password, :to
+    attr_writer :user_email, :review_branch
 
     def_delegators :git, :push_branch, :origin_location, :remote_repo,
                    :remote_repo=, :current_branch, :change_branch
 
-    def initialize(to, git = Git.instance)
-      @to, @git = to, git
+    def initialize(git = Git.instance)
+      @git = git
     end
 
-    def create_review_branch
-      git.create_branch(review_branch)
+    def create_review_branch(base = 'master')
+      git.create_branch(review_branch, base)
+      git.change_branch(review_branch)
+    end
+
+    def rebase_review
+      git.rebase(current_branch, review_branch)
+    end
+
+    def fetch_review_branch
+      git.fetch(review_branch)
+    end
+
+    def fetch_master
+      git.fetch('master')
     end
 
     def create_review_commit(msg)
@@ -46,5 +59,23 @@ module Reviewr
     def email_server
       @email_server ||= user_email.split('@')[1]
     end
+
+    def merge_commits
+      git.cherry(current_branch, review_branch).split(/\n/).each do |line|
+        git.cherry_pick(line.split(/\s/)[1])
+      end
+    end
+
+    def delete_remote_review_branch
+      git.push_branch(":#{review_branch}")
+    end
+
+    def requester_email
+      msg = git.log(1)
+      if msg
+        m = msg.match(/requested_by: ([^\s]+)/)
+        m && m[1]
+      end
+    end
   end
 end

data/lib/reviewr/templates/accept_email.erb

@@ -0,0 +1,6 @@
+Hi,
+
+I have reviewed your changes for branch <%= project.review_branch %> and decided to
+merge them in.
+
+Thanks!

data/lib/reviewr/version.rb

@@ -1,3 +1,3 @@
 module Reviewr
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 3
-  version: 0.1.3
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Ryan Burrows
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-13 00:00:00 -07:00
+date: 2010-04-28 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -85,9 +85,12 @@ files:
 - lib/reviewr/mailer.rb
 - lib/reviewr/project.rb
 - lib/reviewr/version.rb
+- lib/reviewr/cli/accept.rb
+- lib/reviewr/cli/command.rb
 - lib/reviewr/cli/help.rb
 - lib/reviewr/cli/main.rb
 - lib/reviewr/cli/request.rb
+- lib/reviewr/templates/accept_email.erb
 - lib/reviewr/templates/commit_msg.erb
 - lib/reviewr/templates/request_email.erb
 has_rdoc: true