inspected_by 0.0.2

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle
+/coverage
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/log/*.log
+/tmp
+*.gem
+.DS_Store
+.coco
+.rbenv*

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    inspected_by (0.0.1)
+      grit
+      simple_uuid
+      sinatra
+      sinatra-partial
+      slim
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.0.7)
+    diff-lcs (1.1.3)
+    grit (2.5.0)
+      diff-lcs (~> 1.1)
+      mime-types (~> 1.15)
+      posix-spawn (~> 0.3.6)
+    method_source (0.8)
+    mime-types (1.19)
+    posix-spawn (0.3.6)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    rack (1.4.1)
+    rack-protection (1.2.0)
+      rack
+    rake (0.9.2.2)
+    simple_uuid (0.2.0)
+    sinatra (1.3.3)
+      rack (~> 1.3, >= 1.3.6)
+      rack-protection (~> 1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    sinatra-partial (0.3.2)
+      sinatra
+    slim (1.3.3)
+      temple (~> 0.5.5)
+      tilt (~> 1.3.3)
+    slop (3.3.3)
+    temple (0.5.5)
+    tilt (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  inspected_by!
+  pry
+  rake

data/README.md

@@ -0,0 +1,46 @@
+# Inspected By
+
+This is a Sinatra-based experiment for Inspected By.
+
+The Junto will attempt to make it entirely Git-centric without need of a database.
+
+## Learn
+
+Inspected By uses the [git-notes](http://www.kernel.org/pub/software/scm/git/docs/git-notes.html) feature of Git.
+
+Here are some resources to get up to speed:
+
+* [Note to Self](http://git-scm.com/2010/08/25/notes.html)
+* [Git Notes & GitHub](https://vimeo.com/34273537)
+* [Git Notes Display](https://github.com/blog/707-git-notes-display)
+* [Git Tip of the Week: Git Notes](http://alblue.bandlem.com/2011/11/git-tip-of-week-git-notes.html)
+* [git-notes Manual Page](http://www.kernel.org/pub/software/scm/git/docs/git-notes.html)
+
+## Development
+
+### Dependencies
+
+* Ruby
+* Bundler
+
+### Getting started
+
+```sh
+git clone git@github.com:highgroove/inspected-by.git
+cd inspected-by
+bundle install
+```
+
+### Starting up
+
+```sh
+bin/inspected_by --server [PORT] [--repo /Path/to/repo]
+```
+
+Visit http://localhost:4000
+
+### Console
+
+```sh
+irb -r ./lib/inspected_by.rb
+```

data/Rakefile

@@ -0,0 +1,7 @@
+task default: :test
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs += %w(lib test .)
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end

data/bin/inspected_by

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w(..  lib))
+
+require 'optparse'
+require 'inspected_by'
+
+options = {
+  port: 4000
+}
+
+option_parser = OptionParser.new do |opts|
+  opts.on('--repo PATH', 'Repository path') do |repo_path|
+    ENV['INSPECTED_BY_REPO_PATH'] = repo_path
+  end
+
+  opts.on('--server [PORT]', 'Start web server (default port 4000)') do |port|
+    options[:server] = true
+    options[:port] = port unless port.nil?
+  end
+end
+
+option_parser.parse!
+
+InspectedBy::Server.run!(port: options[:port]) if options[:server]

data/inspected_by.gemspec

@@ -0,0 +1,45 @@
+$LOAD_PATH.unshift 'lib'
+require 'inspected_by/version'
+
+Gem::Specification.new do |s|
+  s.name = 'inspected_by'
+  s.version = InspectedBy::VERSION.dup
+  s.summary = 'Code reviews using Git'
+  s.description = 'InspectedBy is a code review tool based on Git'
+  s.homepage = 'http://inspected.by'
+  s.email = 'hello@inspected.by'
+  s.authors = ['Zac Stewart', 'Brandon Beacher']
+
+  s.require_paths = ['lib']
+  s.executables = ['inspected_by']
+
+  s.add_runtime_dependency 'grit'
+  s.add_runtime_dependency 'simple_uuid'
+  s.add_runtime_dependency 'slim'
+  s.add_runtime_dependency 'sinatra'
+  s.add_runtime_dependency 'sinatra-partial'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'pry'
+
+  s.files = %w(
+    .gitignore
+    Gemfile
+    Gemfile.lock
+    README.md
+    Rakefile
+    bin/inspected_by
+    inspected_by.gemspec
+    lib/inspected_by.rb
+    lib/inspected_by/core.rb
+    lib/inspected_by/server.rb
+    lib/inspected_by/server/views/branches.slim
+    lib/inspected_by/server/views/commit.slim
+    lib/inspected_by/server/views/commits.slim
+    lib/inspected_by/server/views/layout.slim
+    lib/inspected_by/server/views/note.slim
+    lib/inspected_by/version.rb
+    test/helper.rb
+    test/inspection_test.rb
+  )
+end

data/lib/inspected_by.rb

@@ -0,0 +1,14 @@
+$:.unshift File.dirname(__FILE__)
+
+# default to current dir for repo
+ENV['INSPECTED_BY_REPO_PATH'] ||= File.expand_path('.')
+
+require 'rubygems'
+
+# internals
+require 'inspected_by/version'
+require 'inspected_by/core'
+require 'inspected_by/server'
+
+module InspectedBy
+end

data/lib/inspected_by/core.rb

@@ -0,0 +1,109 @@
+# stdlib
+require 'json'
+
+# 3rd party
+require 'grit'
+require 'simple_uuid'
+
+module InspectedBy
+  REPO = Grit::Repo.new(ENV['INSPECTED_BY_REPO_PATH'])
+
+  class Decorator
+    def initialize(object)
+      @object = object
+    end
+
+    def self.decorates(klass)
+      define_method(klass) { @object }
+    end
+
+    def self.decorate(objects)
+      objects.map(&method(:new))
+    end
+
+    def self.method_missing(method, *args, &block)
+      @object.send method, *args, &block
+    end
+
+    def method_missing(method, *args, &block)
+      @object.send method, *args, &block
+    end
+  end
+
+  class DiffDecorator < Decorator
+    decorates :diff
+
+    def lines
+      lines = diff.diff.split("\n").drop(2)
+      LineDecorator.decorate(lines)
+    end
+  end
+
+  class LineDecorator < Decorator
+    decorates :line
+
+    def type
+      case line
+      when /^@@.*@@$/
+        'context'
+      when /^\+/
+        'add'
+      when /^-/
+        'remove'
+      end
+    end
+
+    def to_s
+      line.force_encoding('UTF-8')
+    end
+  end
+
+  class Inspection
+    attr_reader :comment, :inspected_at, :inspector_email, :inspector_name, :guid, :sha
+
+    def initialize(repo, params)
+      @repo            = repo
+      @comment         = params['comment']
+      @inspected_at    = params['inspected_at']
+      @inspector_email = params['inspector_email']
+      @inspector_name  = params['inspector_name']
+      @guid            = params['guid']
+      @sha             = params['sha']
+    end
+
+    def self.find_all(repo, sha)
+      repo.git.notes({raise: true, ref: 'inspected-by'}, ['show', sha]).
+        split("\n").
+        map {|note| Inspection.new(repo, JSON.parse(note)) }
+    rescue Grit::Git::CommandFailed => e
+      if /No note found for object/ === e.message
+        []
+      else
+        raise e
+      end
+    end
+
+    def append
+      @repo.git.notes({raise: true, ref: 'inspected-by'},
+        ['append', "--message=#{shell_escaped_message}", @sha])
+    end
+
+  private
+
+    def shell_escaped_message
+      @repo.git.shell_escape(message)
+    end
+
+    def message
+      JSON.generate(
+        'inspected_by'    => true,
+        'inspected_at'    => Time.now.utc,
+        'inspector_email' => @repo.config['user.email'],
+        'inspector_name'  => @repo.config['user.name'],
+        'guid'            => @guid || SimpleUUID::UUID.new.to_guid,
+        'inspected_sha'   => @sha,
+        'comment'         => @comment
+      )
+    end
+  end
+end

data/lib/inspected_by/server.rb

@@ -0,0 +1,47 @@
+require 'sinatra/base'
+require 'sinatra/partial'
+require 'slim'
+
+module InspectedBy
+  class Server < Sinatra::Base
+    dir = File.dirname(File.expand_path(__FILE__))
+    set :views, File.join(dir, %w(server views))
+
+    register Sinatra::Partial
+    set :partial_template_engine, :slim
+
+    def repo
+      @_repo ||= REPO
+    end
+
+    get '/' do
+      redirect to('/branches/master/commits')
+    end
+
+    get '/branches' do
+      @branches = repo.branches
+      slim :branches
+    end
+
+    get '/branches/:branch/commits' do
+      @commits = repo.commits(params[:branch])
+      slim :commits
+    end
+
+    get '/branches/:branch/commits/:sha' do
+      @commit = repo.commit(params[:sha])
+      @notes = Inspection.find_all(repo, @commit.sha)
+      @diffs = DiffDecorator.decorate(@commit.diffs)
+      slim :commit
+    end
+
+    post '/branches/:branch/commits/:sha/notes' do
+      inspection = Inspection.new(repo, params[:inspection])
+      inspection.append
+
+      redirect "/branches/#{params[:branch]}/commits/#{params[:sha]}"
+    end
+
+    run! if app_file == $0
+  end
+end

data/lib/inspected_by/server/views/branches.slim

@@ -0,0 +1,6 @@
+h1 Branches
+ul
+  - @branches.each do |branch|
+    li
+      h2
+        a(href="/branches/#{branch.name}/commits")= branch.name

data/lib/inspected_by/server/views/commit.slim

@@ -0,0 +1,31 @@
+h2
+  a(href="/branches") Branches
+  |  / 
+  a(href="/branches/#{params[:branch]}/commits")= params[:branch]
+header
+  h1= @commit.sha
+  h2 #{@commit.date} by #{@commit.author}
+
+section.message
+  p= @commit.message
+
+section.diffs
+  h3 Diffs
+  ul
+    - @diffs.each do |diff|
+      li
+        #{diff.a_path} → #{diff.b_path}
+        pre.diff
+          - diff.lines.each do |line|
+            .line(class=line.type)= line
+
+section.commit_notes
+  h3 Notes
+  == partial :note, collection: @notes
+
+  form action="/branches/#{params[:branch]}/commits/#{@commit.sha}/notes" method="post"
+    input type="hidden" name="inspection[sha]" value=params[:sha]
+    p
+      textarea name="inspection[comment]" cols="40" rows="5"
+    p
+      input type="submit"

data/lib/inspected_by/server/views/commits.slim

@@ -0,0 +1,11 @@
+h2
+  a(href="/branches") Branches
+  |  / 
+  span= params[:branch]
+h1 Commits
+ul
+  - @commits.each do |commit|
+    li
+      h2 #{commit.date} by #{commit.author}
+      a(href="/branches/#{params[:branch]}/commits/#{commit.sha}")= commit.sha
+      blockquote= commit.message

data/lib/inspected_by/server/views/layout.slim

@@ -0,0 +1,9 @@
+html
+  head
+    title Inspected By
+    style
+      | .diff .add { color: green; }
+      | .diff .remove { color: red; }
+      | .diff .context { color: blue; }
+  body
+    == yield

data/lib/inspected_by/server/views/note.slim

@@ -0,0 +1,6 @@
+article
+  header
+    datetime= note.inspected_at
+    '  by
+    em= note.inspector_name
+  = note.comment

data/lib/inspected_by/version.rb

@@ -0,0 +1,3 @@
+module InspectedBy
+  VERSION = '0.0.2'.freeze
+end

data/test/helper.rb

@@ -0,0 +1,25 @@
+require 'test/unit'
+require 'fileutils'
+require 'pry'
+require File.join(File.dirname(__FILE__), *%w(.. lib inspected_by))
+include InspectedBy
+
+class GitFactory
+  def self.repo(&block)
+    Dir.chdir(Dir.mktmpdir('inspected_by')) do |path|
+      repo = Grit::Repo.init(path, template: File.join(*%w('test data repo_template')))
+      block.call(repo)
+    end
+  end
+
+  def self.commit_with_no_inspections(&block)
+    repo do |repo|
+      file = File.new('README', 'w')
+      file.write('INSPECTED BY TEST REPO')
+      file.close
+      repo.add('README')
+      repo.commit_index('Add project name to repo')
+      block.call(repo, repo.commits.first)
+    end
+  end
+end

data/test/inspection_test.rb

@@ -0,0 +1,31 @@
+require 'helper'
+
+class InspectionTest < Test::Unit::TestCase
+  def setup
+  end
+
+  def teardown
+  end
+
+  def test_find_all_on_commit_with_no_notes
+    GitFactory.commit_with_no_inspections do |repo, commit|
+      inspections = Inspection.find_all(repo, commit.sha)
+      assert_equal inspections, []
+    end
+  end
+
+  def test_appending_a_note_to_a_commit
+    comment = 'You should add more information'
+    GitFactory.commit_with_no_inspections do |repo, commit|
+      Inspection.new(repo,
+        'sha'             => commit.sha,
+        'comment'         => comment).append
+      assert Inspection.find_all(repo, commit.sha).length > 0
+
+      inspection = Inspection.find_all(repo, commit.sha).first
+      assert_equal inspection.comment, comment
+      assert_equal inspection.inspector_email, repo.config['user.email']
+      assert_equal inspection.inspector_name, repo.config['user.name']
+    end
+  end
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: inspected_by
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Zac Stewart
+- Brandon Beacher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simple_uuid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra-partial
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: InspectedBy is a code review tool based on Git
+email: hello@inspected.by
+executables:
+- inspected_by
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/inspected_by
+- inspected_by.gemspec
+- lib/inspected_by.rb
+- lib/inspected_by/core.rb
+- lib/inspected_by/server.rb
+- lib/inspected_by/server/views/branches.slim
+- lib/inspected_by/server/views/commit.slim
+- lib/inspected_by/server/views/commits.slim
+- lib/inspected_by/server/views/layout.slim
+- lib/inspected_by/server/views/note.slim
+- lib/inspected_by/version.rb
+- test/helper.rb
+- test/inspection_test.rb
+homepage: http://inspected.by
+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: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Code reviews using Git
+test_files: []
+has_rdoc: