git-review-notes 0.0.2

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+/tmp/*

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in git-review-branch.gemspec
+gemspec
+
+group :development do
+  gem 'libnotify'
+  gem 'rb-inotify'
+end

data/Guardfile

@@ -0,0 +1,7 @@
+guard 'cucumber', :cli => '--format pretty', :rvm => ['1.8.7', '1.9.3'] do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+\.rb$})          { 'features' }
+  watch(%r{\.rb$}) { 'features' }
+  watch(%r{bin/git-review-branch$}) { 'features' }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+end

data/README.md

@@ -0,0 +1,20 @@
+# git-review
+
+
+A git command to add notes with tag 'Reviewed-By: Reviewer \<reviewer@example.com\>'.
+
+## Setup
+
+    gem install git-review
+
+## Usage
+
+There is two way to use it. First is to mark all commits from current branch as
+reviewed.
+
+    git checkout branchname
+    git review
+
+Second way is to mark commits individually.
+
+    git review HEAD~1 62ffa0a5

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/git-review

@@ -0,0 +1,6 @@
+#! /usr/bin/env ruby
+
+require 'rubygems'
+require 'git_review/cli'
+
+ARGV.any? ? GitReview::CLI.start : GitReview::CLI.new.review

data/features/git-review.feature

@@ -0,0 +1,19 @@
+Feature: Adding 'Reviewed-By:' note for reviewed commits
+
+  To have some formal way to see that particular git commits was reviewed by a developer
+  we need some tool that allows us to easily add a git note for each reviewed commit.
+
+  Scenario: Review a branch
+    When I run `git checkout branch-for-review`
+    And I run `git log`
+    Then the output should not contain "Reviewed-By:"
+    When I run `git review`
+    Then the output should contain "Reviewed-By: Reviewer <reviewer@example.com>"
+    And the output should contain "2 commits are marked as reviewed by you."
+
+  Scenario: Mark already merged commits
+    When I run `git log`
+    Then the output should not contain "Reviewed-By:"
+    When I run `git review commits HEAD HEAD~1`
+    Then the output should contain "Reviewed-By: Reviewer <reviewer@example.com>"
+    And the output should contain "2 commits are marked as reviewed by you."

data/features/step_definitions/git-review_steps.rb

@@ -0,0 +1,7 @@
+Given /^I am on "([^\"]*)" branch$/ do |arg1|
+
+end
+
+When /^I issue "([^\"]*)"$/ do |arg1|
+  pending # express the regexp above with the code you wish you had
+end

data/features/support/env.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+require 'aruba/cucumber'

data/features/support/setup_sample_repository.rb

@@ -0,0 +1,35 @@
+require 'active_support/core_ext/kernel/reporting'
+
+Before do
+  setup_sample_repository
+end
+
+def setup_sample_repository
+  silence_stream(STDERR) do
+    silence_stream(STDOUT) do
+      system <<-SHELL
+    rm -rf tmp/aruba
+    mkdir tmp/aruba
+    cd tmp/aruba
+    git init
+    git config --add user.name Reviewer
+    git config --add user.email reviewer@example.com
+    touch README
+    git add README
+    git commit -m 'first commit.'
+    touch Gemfile
+    git add Gemfile
+    git commit -m 'second commit.'
+    git branch branch-for-review
+    git checkout branch-for-review
+    touch file1
+    git add file1
+    git commit -m 'commit 1 in branch-for-review.'
+    touch file2
+    git add file2
+    git commit -m 'commit 2 in branch-for-review.'
+    git checkout master
+  SHELL
+    end
+  end
+end

data/git-review.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "git_review/version"
+
+Gem::Specification.new do |s|
+  s.name        = "git-review-notes"
+  s.version     = GitReview::VERSION
+  s.authors     = ["Aleksei Gusev"]
+  s.email       = ["aleksei.gusev@gmail.com"]
+  s.homepage    = ""
+  s.summary     = "Adds git review command."
+  s.description = <<-DSC
+    git review will add note for each commit in current branch
+    with 'Reviewed-By: Reviewer <reviewer@example.com>.'
+
+    git review commits HEAD~1 648dbac marks individual commits as reviewed.
+  DSC
+
+  s.rubyforge_project = "git-review-notes"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency 'git'
+  s.add_runtime_dependency 'thor'
+  s.add_development_dependency "cucumber"
+  s.add_development_dependency "aruba", "= 0.4.6"
+  s.add_development_dependency "guard-cucumber"
+  s.add_development_dependency "active_support"
+end

data/lib/git_review/cli.rb

@@ -0,0 +1,56 @@
+require 'thor'
+require 'git_review'
+
+module GitReview
+  class CLI < Thor
+    desc "review", "Add note with Reviewed-By: for each commit in current branch."
+    def review
+      raise "Current branch is master. Exiting..." if git.current_branch == 'master'
+
+      current_branch_commits = git.log.between("master", git.current_branch)
+      add_reviewed_by(current_branch_commits)
+      push_refs_notes
+
+      system "git log master..#{git.current_branch}"
+      display_report(current_branch_commits)
+    end
+
+    desc "commits", "Add not with Reviewed-By: for specified commits separated by space."
+    def commits(*commits_shas)
+      commits = commits_shas.map {|sha| git.object(sha)}
+      add_reviewed_by(commits)
+      push_refs_notes
+
+      system "git log"
+      display_report(commits)
+    end
+
+
+    private
+
+    def add_reviewed_by(commits)
+      commits.each do |commit|
+        note = "".tap do |msg|
+          msg << 'Reviewed-By: '
+          msg << "#{git.config('user.name')} <#{git.config('user.email')}>"
+        end
+
+        git.lib.add_note(commit, note)
+      end
+    end
+
+    def push_refs_notes
+      system "git push origin refs/notes/*"
+    end
+
+    def display_report(commits)
+      puts
+      say "#{commits.size} commits are marked as reviewed by you.", :green
+    end
+
+    def git
+      # @git ||= Git.open(".", :log => Logger.new(STDOUT))
+      @git ||= Git.open(".")
+    end
+  end
+end

data/lib/git_review/git_ext.rb

@@ -0,0 +1,11 @@
+require 'git'
+
+module GitReview
+  module GitLibExt
+    def add_note(commit, note)
+      command('notes add -f', ["-m", note, commit.sha])
+    end
+  end
+end
+
+Git::Lib.send(:include, GitReview::GitLibExt)

data/lib/git_review/git_lib_fix_19.rb

@@ -0,0 +1,16 @@
+require 'git/lib'
+
+# https://github.com/schacon/ruby-git/pull/35
+class Git::Lib
+  def config_get(name)
+    do_get = lambda do |path|
+      command('config', ['--get', name])
+    end
+
+    if @git_dir
+      Dir.chdir(@git_dir, &do_get)
+    else
+      build_list.call
+    end
+  end
+end

data/lib/git_review/version.rb

@@ -0,0 +1,3 @@
+module GitReview
+  VERSION = "0.0.2"
+end

data/lib/git_review.rb

@@ -0,0 +1,6 @@
+require "git_review/version"
+require 'git_review/git_ext'
+require 'git_review/git_lib_fix_19'
+
+module GitReview
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: git-review-notes
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Aleksei Gusev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: &7424420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *7424420
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &7423740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *7423740
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &7422680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7422680
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: &7438920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.4.6
+  type: :development
+  prerelease: false
+  version_requirements: *7438920
+- !ruby/object:Gem::Dependency
+  name: guard-cucumber
+  requirement: &7435920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7435920
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: &7434960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7434960
+description: ! "    git review will add note for each commit in current branch\n    with
+  'Reviewed-By: Reviewer <reviewer@example.com>.'\n\n    git review commits HEAD~1
+  648dbac marks individual commits as reviewed.\n"
+email:
+- aleksei.gusev@gmail.com
+executables:
+- git-review
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- bin/git-review
+- features/git-review.feature
+- features/step_definitions/git-review_steps.rb
+- features/support/env.rb
+- features/support/setup_sample_repository.rb
+- git-review.gemspec
+- lib/git_review.rb
+- lib/git_review/cli.rb
+- lib/git_review/git_ext.rb
+- lib/git_review/git_lib_fix_19.rb
+- lib/git_review/version.rb
+- tmp/.gitkeep
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: git-review-notes
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Adds git review command.
+test_files: []