zaphod 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9716d2d2bc5d2523195132e42ef2cfe697956449
-  data.tar.gz: 02e7e816192a3437b1a2c6b946ed6a97780bf018
+  metadata.gz: eb48ef706b22fe9a2b035380caf5f5e075a6044b
+  data.tar.gz: 53636ac34dabeba5d5e9216ce93158c824f7a566
 SHA512:
-  metadata.gz: c96b73e834d184a91993a6f95f7a74bb101d7bc2763f1f4a99bcbbf1bf670fbcc8f34172b6fc06ff31365f2223fc6f3f62b750778ee7b91650921d7da95cb15d
-  data.tar.gz: 7a4d12e3294f2e00b87ab66545f7e6ca9ffbd6ff2d29c10099c2bb5d460f27e28f2a71b2e973f8dd40ad4bafb281f09dd03ee34949705dd92d5fb844e4b07032
+  metadata.gz: 4648fbe942eb86ca77f630f6a9c31fd170a075a03105a0d134d407e629c009e905f0e120ef71de259d7f45f09ac5399bd2a521dd10ca5f644f10ffbf025df283
+  data.tar.gz: 27cb0eb96188fc4af4e0fa78e0fb44bb21d88d5850d73bc87ca584a8bf7b6848f8240579174fa462b79c4b6f8b76f181c1ad83ffe52c4c57f25051f311e2d289

data/.gitignore

@@ -11,3 +11,4 @@ rdoc
 spec/reports
 .bundle
 .ruby-version
+log/*

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    zaphod (1.0.1)
-      grit (~> 2.5)
+    zaphod (1.1.0)
+      git (~> 1.2.6)
       simplecov (~> 0.8)
 
 GEM
@@ -15,11 +15,8 @@ GEM
     docile (1.1.2)
     ffi (1.9.3)
     formatador (0.2.4)
-    grit (2.5.0)
-      diff-lcs (~> 1.1)
-      mime-types (~> 1.15)
-      posix-spawn (~> 0.3.6)
-    guard (2.3.0)
+    git (1.2.6)
+    guard (2.4.0)
       formatador (>= 0.2.4)
       listen (~> 2.1)
       lumberjack (~> 1.0)
@@ -33,16 +30,14 @@ GEM
       rspec (>= 2.14, < 4.0)
     guard-shell (0.6.1)
       guard (>= 1.1.0)
-    listen (2.4.0)
+    listen (2.4.1)
       celluloid (>= 0.15.2)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9)
     lumberjack (1.0.4)
     method_source (0.8.2)
-    mime-types (1.25.1)
     multi_json (1.8.4)
-    posix-spawn (0.3.8)
-    pry (0.9.12.4)
+    pry (0.9.12.6)
       coderay (~> 1.0)
       method_source (~> 0.8)
       slop (~> 3.4)
@@ -73,7 +68,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  guard (~> 2.3)
+  guard (~> 2.4)
   guard-bundler
   guard-rspec (~> 4.2)
   guard-shell

data/README.org

@@ -6,6 +6,11 @@
 
 Catch, and publicly embarrass, untested commits into git.
 
+Zaphod is a formatter for SimpleCov that compares the current git changes 
+with the uncovered source reported by SimpleCov.  If any source code appears
+both in the uncovered code and git changes, Zaphod will call an #on_failure
+hook.  By default, this exits and fails the build.
+
 ** Installation
 
 *** Simple Installation
@@ -15,6 +20,11 @@ Catch, and publicly embarrass, untested commits into git.
   Zaphod.setup
 #+END_SRC
 
+This will set up the Zaphod formatter and start SimpleCov.
+
+Be certain that SimpleCov is started before any of your project's source is loaded.
+
+
 *** Setup your own SimpleCov Formatters
 
 #+BEGIN_SRC ruby
@@ -34,12 +44,14 @@ Catch, and publicly embarrass, untested commits into git.
      require "pony"
 
      Zaphod.setup do |configuration|
-       configuration.on_failure do
+       # Action to take if uncovered changes are found:
+       configuration.on_failure do |uncovered_changes|
          Pony.mail(
            to: 'your-team@example.com',
-           subject: "Someone is trying to commit untested code!"
+           subject: "Someone is trying to commit untested code!",
+           body: uncovered_changes.to_s
            )
-         raise SystemExit.new( -1 )
+         exit -1 # Abort the build with a failing exit code
        end
      end
 #+END_SRC
@@ -51,9 +63,16 @@ Catch, and publicly embarrass, untested commits into git.
     ]
 
     Zaphod.configure do |configuration|
-      configuration.on_failure do
+      configuration.on_failure do |uncovered_changes|
         $stderr.puts "What would your mother think?"
+        exit -1
       end
     end
     SimpleCov.start
 #+END_SRC
+
+** Dependencies
+
+ - Grit
+ - SimpleCov
+

data/lib/simplecov/formatter/zaphod_formatter.rb

@@ -25,11 +25,13 @@ module SimpleCov
         if $DEBUG || ENV["DEBUG"]
           require "pp"
           pp(
-            "--- UNCOVERED ---", uncovered_codeset,
-            "---  CHANGED  ---", changed_codeset,
-            "---    DIFF   ---", diff
+            "---  UNCOVERED   ---", uncovered_codeset,
+            "---   CHANGED    ---", changed_codeset,
+            "--- INTERSECTION ---"
             )
+          puts diff.to_s, "FAIL?: #{! diff.empty?}"
         end
+
         unless diff.empty?
           Zaphod.configuration.on_failure.call diff
         end

data/lib/zaphod/change_set.rb

@@ -4,11 +4,11 @@ require "set"
 module Zaphod
   class ChangeSet
     extend Forwardable
-    attr_reader :changes
+    attr_reader :changes, :user
     def_delegators :@changes, :empty?, :each, :map, :first, :length, :include?, :add, :any?
 
-    def initialize( changes=[] )
-      @changes = Set.new changes
+    def initialize( changes=[], user="unknown" )
+      @changes, @user = Set.new( changes ), user
     end
 
     def intersection( other )
@@ -20,5 +20,9 @@ module Zaphod
     def ==( other )
       changes == other.changes
     end
+
+    def to_s()
+      ["## #{user}", changes.map( &:to_s )].join "\n"
+    end
   end
 end

data/lib/zaphod/code_change.rb

@@ -21,5 +21,9 @@ module Zaphod
         source.map( &:inspect ).join( ",\n" ) +
         "])"
     end
+
+    def to_s()
+      ["### #{path}", source.join].join "\n"
+    end
   end
 end

data/lib/zaphod/git.rb

@@ -1,4 +1,5 @@
-require 'grit'
+require "git"
+require "logger"
 
 module Zaphod
   class Git
@@ -6,7 +7,7 @@ module Zaphod
     attr_accessor :diff_against
 
     def self.from_path( path )
-      new Grit::Repo.new( path )
+      new ::Git.open( path, log: Logger.new( "log/zaphod-git.log" ) )
     end
 
     def initialize( repository, diff_against="HEAD" )
@@ -15,22 +16,33 @@ module Zaphod
     end
 
     def diff()
-      diffs = repo.git.diff_index( { p: true }, diff_against ).
-        split( /^diff --git .* b(.*)$/ )
-
+      path  = repo.dir.path
+      diffs = repo.diff( diff_against, path )
       as_hash diffs
     end
 
+    def user()
+      config = repo.config
+      [config["user.name"], config["user.email"]].join " "
+    end
+
     protected
 
-    def as_hash( diff )
-      diffs = diff.drop_while( &:empty? )
-      relativize_paths Hash[*diffs]
+    def as_hash( diffs )
+      pairs  = diffs.flat_map { |diff_file|
+        [diff_file.path, additions( diff_file.patch )]
+      }
+      relativize_paths Hash[*pairs]
+    end
+
+    def additions( patch )
+      patch.lines.select { |l| l =~ /^[+][^+]/ }.
+        map { |l| l.gsub( /^[+]/, "" ) }
     end
 
     def relativize_paths( patch_map )
-      patch_map.dup.each_with_object( map = {} ) do |pair, h|
-        h[".#{pair.first}"] = pair.last
+      patch_map.each_with_object( map = {} ) do |pair, h|
+        h["./#{pair.first}"] = pair.last
       end
       map
     end

data/lib/zaphod/source_control.rb

@@ -13,19 +13,10 @@ module Zaphod
     end
 
     def changes()
-      ChangeSet.new repo.diff.map { |path, diff|
-        CodeChange.new File.expand_path( path ), additions_from( diff.lines )
+      cc = repo.diff.map { |path, diff|
+        CodeChange.new File.expand_path( path ), diff
       }
-    end
-
-    def additions_from( lines )
-      lines.
-        select { |l| addition? l }.
-        map    { |l| l.gsub( /^[+]/, "" ) }
-    end
-
-    def addition?( line )
-      line =~ /^[+][^+]/
+      ChangeSet.new cc, repo.user
     end
   end
 end

data/lib/zaphod/spike.rb

@@ -3,5 +3,11 @@ module Zaphod
     def initialize()
       @var = "foo"
     end
+
+
+    def untested_change!()
+      puts "untested!"
+    end
+
   end
 end

data/lib/zaphod/version.rb

@@ -1,3 +1,3 @@
 module Zaphod
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/spec/simplecov/formatter/zaphod_formatter_spec.rb

@@ -33,9 +33,14 @@ describe SimpleCov::Formatter::ZaphodFormatter do
       end
 
       before :each do
+        @original_failure = Zaphod.configuration.on_failure
         stub( source_control ).changes { source_changes }
       end
 
+      after :each do
+        Zaphod.configuration.on_failure &@original_failure
+      end
+
       it "runs the configured on_failure action, passing uncovered changes" do
         failed = false
         Zaphod.configure do |config|

data/spec/spec_helper.rb

@@ -1,7 +1,11 @@
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
-
 require 'zaphod'
-Zaphod.setup
+Zaphod.setup do |config|
+  config.on_failure do
+    puts "Untested CHANGES!"
+    exit -1
+  end
+end
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true

data/spec/zaphod/change_set_spec.rb

@@ -20,6 +20,10 @@ module Zaphod
       it "rejects duplicates" do
         expect( described_class.new( changes ) ).to have( 1 ).item
       end
+
+      it "accepts a user string" do
+        described_class.new changes, "bob foo"
+      end
     end
 
     describe "iteration" do
@@ -84,5 +88,18 @@ module Zaphod
         end
       end
     end
+
+    describe "#to_s" do
+      subject( :set ) do
+        described_class.new([
+            CodeChange.new( "/dev/null", ["baz"] ),
+            CodeChange.new( "./lib/zaphod/spike.rb", ["foo"] )
+          ])
+      end
+
+      it do
+        expect( set.to_s ).to eq( ["## unknown", set.changes.map( &:to_s )].join( "\n" ) )
+      end
+    end
   end
 end

data/spec/zaphod/code_change_spec.rb

@@ -98,5 +98,26 @@ module Zaphod
       end
     end
 
+    describe "#to_s" do
+      subject( :change ) do
+        CodeChange.new(
+          "/app/controllers/tags_controller.rb", [
+            "\n",
+            "  def uncovered_method\n",
+            "    puts \"ha HA! I'm a cheater!\"\n",
+            "  end\n"
+          ])
+      end
+
+      it do
+        expect( change.to_s ).to eq( <<EOS )
+### /app/controllers/tags_controller.rb
+
+  def uncovered_method
+    puts "ha HA! I'm a cheater!"
+  end
+EOS
+      end
+    end
   end
 end

data/spec/zaphod/git_spec.rb

@@ -2,15 +2,21 @@ require 'spec_helper'
 require 'zaphod/git'
 
 describe Zaphod::Git do
-  let( :git  ) { stub!.diff_index { DIFF }.subject }
-  let( :grit ) { stub!.git { git }.subject }
+  let( :path ) { "." }
+  let( :repo ) do
+    gitrb = Object.new
+    stub( gitrb ) do |allow|
+      allow.dir.stub!.path       { path }
+      allow.diff( "HEAD", path ) { DIFF }
+    end
+    gitrb
+  end
 
-  subject { described_class.new grit }
+  subject { described_class.new repo }
 
   describe "to get current changes in the git repository" do
-    it "calls :diff_index on the Grit git object" do
-      mock( git ).diff_index({ p: true }, "HEAD") { DIFF }
-
+    it "calls #diff on the Git repository object" do
+      mock( repo ).diff( "HEAD", "." ) { DIFF }
       subject.diff
     end
 
@@ -20,9 +26,41 @@ describe Zaphod::Git do
         "./spec/zaphod/source_control_spec.rb"
         )
     end
+
+    it "includes only the additions from the patch" do
+      additions = DIFF.first.patch.lines.select { |l| l =~ /^[+][^+]/ }
+      expect( subject.diff["./spec/spec_helper.rb"].size ).
+        to eq( additions.size )
+    end
+
+    it "strips the '+'" do
+      subject.diff.each do |path, additions|
+        expect( additions.all? { |l| ! l.start_with?( "+" ) } ).to be_true
+      end
+    end
+  end
+
+  describe "#user" do
+    it "retrieves the user info from the git config" do
+      mock( repo ).config { Hash.new }
+      subject.user
+    end
+
+    it "returns the concatenation of the user name and email" do
+      stub( repo ).config do
+        {
+          "user.name" => "Bob Shlob",
+          "user.email" => "bob@mailinator.com"
+        }
+      end
+
+      expect( subject.user ).to eq( "Bob Shlob bob@mailinator.com" )
+    end
   end
 
-  DIFF = <<-EOS
+  DiffFile = Struct.new :path, :patch
+  DIFF = [
+    DiffFile.new( "spec/spec_helper.rb", <<-EOS ),
 diff --git /dev/null b/spec/spec_helper.rb
 --- /dev/null
 +++ b/spec/spec_helper.rb
@@ -55,6 +93,8 @@ diff --git /dev/null b/spec/spec_helper.rb
 +  #     --seed 1234
 +  config.order = 'random'
 +end
+EOS
+    DiffFile.new( "spec/zaphod/source_control_spec.rb", <<-EOS ),
 diff --git a/spec/zaphod/source_control_spec.rbf b/spec/zaphod/source_control_spec.rb
 index 73d4e77..8ef378d 100644
 --- a/spec/zaphod/source_control_spec.rb
@@ -80,5 +120,6 @@ index 73d4e77..8ef378d 100644
 +    let( :repository )   { stub git: git_native }
 
      let( :git )          { described_class.new repository }
-  EOS
+EOS
+  ]
 end

data/spec/zaphod/source_control_spec.rb

@@ -8,18 +8,25 @@ describe Zaphod::SourceControl do
 
   describe "#initialize" do
     it "accepts a repository" do
-      described_class.new Grit::Repo.new REPO_PATH
+      described_class.new Git.open( REPO_PATH )
     end
   end
 
   describe "#changes" do
     let( :patch_map ) do
       {
-        "./spec/spec_helper.rb" => "+ require 'rspec'\n",
-        "./spec/zaphod/source_control_spec.rb" => "+ require 'spec_helper'\n"
+        "./spec/spec_helper.rb" => "require 'rspec'\n",
+        "./spec/zaphod/source_control_spec.rb" => "require 'spec_helper'\n"
       }
     end
-    let( :repository )   { stub!.diff { patch_map }.subject }
+    let( :repository ) do
+      repo = Object.new
+      stub( repo ) do |allow|
+        allow.diff { patch_map }
+        allow.user { "bob smith smith@mailinator.com" }
+      end
+      repo
+    end
 
     subject { described_class.new repository }
 
@@ -38,12 +45,12 @@ describe Zaphod::SourceControl do
 
     it "passes the additions to each code set" do
       subject.changes.first.source.length.should eq(
-        patch_map["./spec/spec_helper.rb"].lines.select { |l| l =~ /^[+][^+]/ }.to_a.size
+        patch_map["./spec/spec_helper.rb"].length
         )
     end
 
-    it "strips the plusses off the lines" do
-      subject.changes.first.source.first.should_not start_with( "+" )
+    it "provides the change set with the name of the alleged slacker" do
+      expect( subject.changes.user ).to eq( "bob smith smith@mailinator.com" )
     end
   end
 end

data/zaphod.gemspec

@@ -19,14 +19,14 @@ Gem::Specification.new do |spec|
   spec.extra_rdoc_files = %w[README.org]
   spec.rdoc_options     = ["--charset=UTF-8"]
 
-  spec.add_dependency "grit",      "~> 2.5"
+  spec.add_dependency "git",       "~> 1.2.6"
   spec.add_dependency "simplecov", "~> 0.8"
 
   spec.add_development_dependency "rake",  "~> 10.1"
   spec.add_development_dependency "rr",    "~> 1.1"
   spec.add_development_dependency "rspec", "~> 2.14"
   spec.add_development_dependency "pry"
-  spec.add_development_dependency "guard", "~> 2.3"
+  spec.add_development_dependency "guard", "~> 2.4"
   spec.add_development_dependency "guard-rspec", "~> 4.2"
   spec.add_development_dependency "guard-bundler"
   spec.add_development_dependency "guard-shell"

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: zaphod
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Toby Tripp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-05 00:00:00.000000000 Z
+date: 2014-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: grit
+  name: git
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: 1.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: 1.2.6
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement