Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Get ready for initial release

  • Loading branch information...
commit fbc9ee4b1c31ee1ad5d37868957e6babd2810d69 1 parent c3191bf
Ryan Burrows authored
View
1  .gitignore
@@ -1 +1,2 @@
TAGS
+reviewr-*.gem
View
19 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.
View
16 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
View
37 README.md
@@ -1,5 +1,32 @@
+# Reviewr: Simple code review
-# Ideas
+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:
@@ -33,11 +60,3 @@ 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
-
-# Questions and problems
-
-* History of comments when be lost when commits are merged
-
-# Todo
-
-* Update this when complete to be a README not a ideas page
View
13 Rakefile
@@ -1,5 +1,8 @@
require 'rubygems'
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require 'reviewr/version'
+
begin
require 'cucumber'
require 'cucumber/rake/task'
@@ -26,3 +29,13 @@ rescue LoadError
abort 'Install rspec as a gem to run tests.'
end
end
+
+desc 'Build the reviewr gem'
+task :build do
+ system "gem build reviewr.gemspec"
+end
+
+desc 'Push a the gem to gemcutter'
+task :release => :build do
+ system "gem push reviewr-#{Reviewr::VERSION}"
+end
View
1  lib/reviewr.rb
@@ -4,6 +4,7 @@
require 'reviewr/git'
require 'reviewr/mailer'
require 'reviewr/project'
+require 'reviewr/version'
module Reviewr
end
View
3  lib/reviewr/version.rb
@@ -0,0 +1,3 @@
+module Reviewr
+ VERSION = "0.0.1"
+end
View
34 reviewr.gemspec
@@ -0,0 +1,34 @@
+# Thanks to Yehuda Katz for good gemspec info
+# http://yehudakatz.com/2010/04/02/using-gemspecs-as-intended/
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'reviewr/version'
+
+Gem::Specification.new do |s|
+ s.name = "reviewr"
+ s.version = Reviewr::VERSION
+ s.platform = Gem::Platform::RUBY
+ s.author = "Ryan Burrows"
+ s.email = "rhburrows@gmail.com"
+ s.homepage = "http://github.com/rhburrows/reviewr"
+ s.summary = "Easy git code reviews"
+ s.description = <<-DESC
+ Reviewr makes git code reviews easy using Github to manage code and comments
+ DESC
+
+ s.required_rubygems_version = ">= 1.3.6"
+
+ s.add_dependency "termios"
+ s.add_dependency "pony"
+
+ s.add_development_dependency "rspec"
+ s.add_development_dependency "cucumber"
+
+ s.files = File.readlines("Manifest.txt").inject([]) do |files, line|
+ files << line.chomp
+ end
+ s.executables = ['reviewr']
+ s.require_path = 'lib'
+end
Please sign in to comment.
Something went wrong with that request. Please try again.