reviewr 0.0.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Ryan Burrows
+
+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.txt

@@ -0,0 +1,16 @@
+LICENSE
+README.md
+History.txt
+Manifest.txt
+bin/reviewr
+lib/reviewr.rb
+lib/reviewr/cli.rb
+lib/reviewr/git.rb
+lib/reviewr/mailer.rb
+lib/reviewr/project.rb
+lib/reviewr/version.rb
+lib/reviewr/cli/help.rb
+lib/reviewr/cli/main.rb
+lib/reviewr/cli/request.rb
+lib/reviewr/templates/commit_msg.erb
+lib/reviewr/templates/request_email.erb

data/README.md

@@ -0,0 +1,62 @@
+# Reviewr: Simple code review
+
+Reviewr is an application to simplify code review for projects using
+git and github.com for version control.
+
+# Installation
+    gem install reviewr
+
+# Requesting a code review
+    reviewr request <email>
+This will result in the following actions:
+
+* Create a code review branch
+* Create a commit with information about the code review request
+* Push the code review branch to the origin 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 
+
+## Limitations
+
+* Right now reviewr considers the origin/master the branch that the
+  reviewed code will be merged into when approved
+* Email can only be sent from a Gmail (or Google Apps for my domain)
+  address
+
+# TODO
+
+## Finish out the basic workflow
+
+General workflow goes something like this:
+
+Code, code, code. Decide changes are ready for review and run `reviewr
+request email@site.com`. This causes reviewr to:
+
+* 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
+
+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:
+
+* 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
+
+If the code the reviewer is checking is not acceptable, upon finishing
+comments on github the reviewer can run `reviewr reject
+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

data/bin/reviewr

@@ -0,0 +1,6 @@
+#!/usr/bin/ruby
+
+$LOAD_PATH << 'lib'
+require 'reviewr'
+
+Reviewr::CLI::Main.new(ARGV).run

data/lib/reviewr/cli/help.rb

@@ -0,0 +1,33 @@
+module Reviewr
+  module CLI
+    class Help
+      def call(command)
+        if command.nil?
+          usage
+        else
+          request_help
+        end
+      end
+
+      def usage
+        puts <<-HELP
+usage: reviewr COMMAND [ARGS]
+
+reviewr commands
+  request   Request a code review
+  help      Find out more about a specific command
+
+See 'reviewr help COMMAND' for more information on a specific command.
+        HELP
+      end
+
+      def request_help
+        puts <<-HELP
+usage: reviewr request <email>
+
+Request a code review from <email>.
+        HELP
+      end
+    end
+  end
+end

data/lib/reviewr/cli/main.rb

@@ -0,0 +1,53 @@
+require 'termios'
+require 'ruby-debug'
+
+module Reviewr
+  module CLI
+    class Main
+      attr_reader :command
+      attr_accessor :project
+
+      def initialize(args, input = STDIN, output = STDOUT)
+        @command = args.shift
+        @project = Project.new(args.shift)
+        @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
+      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
+        end
+      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)
+      end
+    end
+  end
+end

data/lib/reviewr/cli/request.rb

@@ -0,0 +1,45 @@
+require 'erb'
+require 'forwardable'
+
+module Reviewr
+  module CLI
+    class Request
+      attr_reader :project
+
+      def initialize(project)
+        @project = project
+      end
+
+      def call
+        project.create_review_branch
+        project.create_review_commit(commit_msg)
+        project.push_review_branch
+        Mailer.new(project).send(email_body)
+      end
+
+      def compare_url
+        repo = project.origin_location.split(':')[1].gsub(/.git$/, "/compare")
+        "http://github.com/#{repo}/#{project.master_sha}...#{project.review_sha}"
+      end
+
+      def commit_msg
+        read_template('commit_msg.erb')
+      end
+
+      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/cli.rb

@@ -0,0 +1,8 @@
+require 'reviewr/cli/main'
+require 'reviewr/cli/help'
+require 'reviewr/cli/request'
+
+module Reviewr
+  module CLI
+  end
+end

data/lib/reviewr/git.rb

@@ -0,0 +1,48 @@
+module Reviewr
+  class Git
+    class << self
+      def instance
+        @instance ||= Git.new
+      end
+
+      def instance=(instance)
+        @instance = instance
+      end
+    end
+
+    def last_commit
+      execute('git show --pretty=format:"%H" HEAD').split("\n")[0]
+    end
+
+    def create_branch(branch_name)
+      execute("git checkout -b #{branch_name}")
+    end
+
+    def commit(msg)
+      execute("git commit --allow-empty -m \"#{msg}\"")
+    end
+
+    def user_email
+      email = execute('git config user.email')
+      email && email.chomp
+    end
+
+    def push_branch(branch_name)
+      execute("git push origin #{branch_name}")
+    end
+
+    def origin_location
+      r = execute("git remote show origin")
+      r && r.match(/URL: (.+)$/)[1]
+    end
+
+    def origin_master_commit
+      r = execute("git ls-remote origin refs/heads/master")
+      r && r.split(/\s+/)[0]
+    end
+
+    def execute(cmd)
+      `#{cmd}`
+    end
+  end
+end

data/lib/reviewr/mailer.rb

@@ -0,0 +1,26 @@
+require 'pony'
+
+module Reviewr
+  class Mailer
+    def initialize(project)
+      @project = project
+    end
+
+    def send(body)
+      Pony.mail(:from => @project.user_email,
+                :to   => @project.to,
+                :body => body,
+                :subject => "Code review request from #{@project.user_email}",
+                :via  => :smtp,
+                :smtp => {
+                  :host     => 'smtp.gmail.com',
+                  :port     => '587',
+                  :user     => @project.user_email,
+                  :tls      => true,
+                  :password => @project.email_password,
+                  :auth     => :plain,
+                  :domain   => @project.email_server
+                })
+    end
+  end
+end

data/lib/reviewr/project.rb

@@ -0,0 +1,48 @@
+require 'forwardable'
+
+module Reviewr
+  class Project
+    extend Forwardable
+
+    attr_reader :to, :git, :email_server
+    attr_accessor :user_email, :email_password
+
+    def_delegators :git, :push_branch, :origin_location
+
+    def initialize(to, git = Git.instance)
+      @to, @git = to, git
+    end
+
+    def create_review_branch
+      git.create_branch(review_branch)
+    end
+
+    def create_review_commit(msg)
+      git.commit(msg)
+    end
+
+    def push_review_branch
+      git.push_branch(review_branch)
+    end
+
+    def review_sha
+      @review_sha ||= git.last_commit.slice(0, 8)
+    end
+
+    def master_sha
+      @master_sha ||= git.origin_master_commit.slice(0, 8)
+    end
+
+    def review_branch
+      @review_branch ||= "review_#{review_sha}"
+    end
+
+    def user_email
+      @user_email ||= git.user_email
+    end
+
+    def email_server
+      @email_server ||= user_email.split('@')[1]
+    end
+  end
+end

data/lib/reviewr/templates/commit_msg.erb

@@ -0,0 +1,4 @@
+Code Review Request
+===================
+requested_by: <%= project.user_email %>
+requested_from: <%= project.to %>

data/lib/reviewr/templates/request_email.erb

@@ -0,0 +1,12 @@
+Hi,
+
+Could you please code review and comment on the following changes:
+
+<%= compare_url %>
+
+If you find the changes acceptable please run:
+  reviewr accept <%= project.review_branch %>
+If you think more work needs to be done please run:
+  reviewr reject <%= project.review_branch %>
+
+Thanks!

data/lib/reviewr/version.rb

@@ -0,0 +1,3 @@
+module Reviewr
+  VERSION = "0.0.1"
+end

data/lib/reviewr.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+
+require 'reviewr/cli'
+require 'reviewr/git'
+require 'reviewr/mailer'
+require 'reviewr/project'
+require 'reviewr/version'
+
+module Reviewr
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: reviewr
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ryan Burrows
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-08 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: termios
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: pony
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: "    Reviewr makes git code reviews easy using Github to manage code and comments\n"
+email: rhburrows@gmail.com
+executables: 
+- reviewr
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README.md
+- History.txt
+- Manifest.txt
+- bin/reviewr
+- lib/reviewr.rb
+- lib/reviewr/cli.rb
+- lib/reviewr/git.rb
+- lib/reviewr/mailer.rb
+- lib/reviewr/project.rb
+- lib/reviewr/version.rb
+- lib/reviewr/cli/help.rb
+- lib/reviewr/cli/main.rb
+- lib/reviewr/cli/request.rb
+- lib/reviewr/templates/commit_msg.erb
+- lib/reviewr/templates/request_email.erb
+has_rdoc: true
+homepage: http://github.com/rhburrows/reviewr
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Easy git code reviews
+test_files: []
+