zaphod 1.0.0

data/spec/simplecov/formatter/zaphod_formatter_spec.rb

@@ -0,0 +1,73 @@
+require "spec_helper"
+
+require 'simplecov/formatter/zaphod_formatter'
+
+describe SimpleCov::Formatter::ZaphodFormatter do
+  let( :result ) do
+    SimpleCov::Result.new(
+      File.expand_path( "./lib/zaphod/spike.rb" ) => [1, 1, 1, 0, nil, nil, nil]
+      )
+  end
+
+  let!( :source_control ) { Object.new }
+
+  before :each do
+    stub( Zaphod::SourceControl ).git { source_control }
+    stub( source_control ).changes { Zaphod::ChangeSet.new([]) }
+  end
+
+  describe "#format( result )" do
+    it "gets the current changes from source control" do
+      mock( Zaphod::SourceControl ).git( Dir.pwd ) { source_control }
+      subject.format result
+    end
+
+    context "when the uncovered lines include the current changes" do
+      let( :source_changes ) do
+        Zaphod::ChangeSet.new([
+            Zaphod::CodeChange.new( "./lib/zaphod/spike.rb", ["      @var = \"foo\"\n"] )
+          ])
+      end
+
+      before :each do
+        stub( source_control ).changes { source_changes }
+      end
+
+      it "runs the configured on_failure action, passing uncovered changes" do
+        failed = false
+        Zaphod.configure do |config|
+          config.on_failure { |diff| failed = diff }
+        end
+
+        subject.format result
+
+        expect( failed ).to eq( source_changes.changes )
+      end
+    end
+
+    context "when the uncovered lines do not include the current changes" do
+      before :each do
+        stub( source_control ).changes { Hash.new }
+      end
+
+      it "proceeds normally" do
+        subject.format result
+      end
+    end
+  end
+
+  describe "#uncovered( result )" do
+    subject { described_class.new.uncovered result }
+
+    it { should_not be_empty }
+
+    it "includes a code set for the file in the result" do
+      subject.first.path.should eq File.expand_path("./lib/zaphod/spike.rb")
+    end
+
+    it "provides the uncovered source lines to the code set" do
+      code_change = subject.first
+      code_change.source.first.should =~ /@var/
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'zaphod'
+Zaphod.setup
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.mock_with :rr
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/zaphod/change_set_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+require 'zaphod/code_change'
+require 'zaphod/change_set'
+
+module Zaphod
+  describe ChangeSet do
+    let( :changes ) do
+      [
+        Zaphod::CodeChange.new( "/dev/null", ["stuff"] ),
+        Zaphod::CodeChange.new( "/dev/null", ["stuff"] ),
+      ]
+    end
+
+    describe "construction" do
+      it "accepts a list of CodeChanges" do
+        described_class.new changes
+      end
+
+      it "rejects duplicates" do
+        expect( described_class.new( changes ) ).to have( 1 ).item
+      end
+    end
+
+    describe "iteration" do
+      subject do
+        described_class.new changes
+      end
+
+      it "yields each change to a given block" do
+        subject.map { |c| c.class }.uniq.should == [Zaphod::CodeChange]
+      end
+
+      it "returns an iterator if no block is given" do
+        i = subject.map
+        i.should be_an_instance_of Enumerator
+      end
+    end
+
+    describe "#intersection" do
+      let( :set1 ) do
+        described_class.new([
+            CodeChange.new( "/dev/null", ["baz"] ),
+            CodeChange.new( "./lib/zaphod/spike.rb", ["+ foo"] )
+          ])
+      end
+      let( :set2 ) do
+        described_class.new([
+            CodeChange.new( "/dev/null", ["baz"] )
+          ])
+      end
+
+      it do
+        expect( set1.intersection( set2 ) ).
+          to eq( Set.new([ CodeChange.new( "/dev/null", ["baz"] ) ]) )
+      end
+    end
+  end
+end

data/spec/zaphod/code_change_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+require 'zaphod/code_change'
+module Zaphod
+  describe CodeChange do
+    describe "construction" do
+      it "accepts a list of source lines" do
+        source = ["require 'foo'", "puts 'bar'"]
+        set = Zaphod::CodeChange.new "./lib/zaphod/spike.rb", source
+        set.source.should == source
+      end
+
+      it "expands the given path" do
+        path = "./lib/zaphod/spike.rb"
+        expect( CodeChange.new( path ).path ).
+          to eq( File.expand_path( path ) )
+      end
+    end
+
+    describe "#eql?" do
+      context "when the paths and source are equal" do
+        let( :change1 ) { CodeChange.new ".lib/zaphod/spike.rb", ["foo"] }
+        let( :change2 ) { CodeChange.new ".lib/zaphod/spike.rb", ["foo"] }
+
+        it( "is true" ) { expect( change1 ).to eql( change2 ) }
+      end
+
+      context "when the source list is empty" do
+        let( :change1 ) { CodeChange.new ".lib/zaphod/spike.rb" }
+        let( :change2 ) { CodeChange.new ".lib/zaphod/spike.rb" }
+
+        it( "is not true" ) { expect( change1 ).to_not eql( change2 ) }
+      end
+
+      context "when the sources differ" do
+        let( :change1 ) { CodeChange.new ".lib/zaphod/spike.rb", ["bar"] }
+        let( :change3 ) { CodeChange.new ".lib/zaphod/spike.rb", ["foo"] }
+
+        it( "is not true" ) { expect( change1 ).to_not eql( change3 ) }
+      end
+
+      context "when the sources overlap" do
+        let( :change1 ) do
+          CodeChange.new "./lib/zaphod/spike.rb", [
+            "require 'foo'",
+            "Foo.bar!"
+          ]
+        end
+
+        let( :change2 ) do
+          CodeChange.new "./lib/zaphod/spike.rb", [
+            "require 'foo'",
+            "Foo.bar!",
+            "Bar.baz"
+          ]
+        end
+
+        it( "is true" ) { expect( change1 ).to eql( change2 ) }
+      end
+    end
+
+    describe "#hash" do
+      let( :change1 ) { CodeChange.new ".lib/zaphod/spike.rb" }
+      let( :change2 ) { CodeChange.new ".lib/zaphod/spike.rb" }
+      let( :change3 ) { CodeChange.new ".lib/zaphod/spike.rb", ["+foo"] }
+
+      it "is the same for two changes that are eql" do
+        expect( change1.hash ).to eq( change2.hash )
+      end
+
+      it "differs for two changes that have inequal sources" do
+        expect( change2.hash ).to_not eq( change3.hash )
+      end
+    end
+
+  end
+end

data/spec/zaphod/configuration_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+require "zaphod/configuration"
+
+describe Zaphod::Configuration do
+  subject( :config ) { described_class.new }
+
+  describe "#on_failure" do
+    it "stores a proc, if given" do
+      proc =  Proc.new { :foo }
+      config.on_failure( &proc )
+      expect( config.on_failure ).to eq( proc )
+    end
+
+    it "defaults to a SystemExit" do
+      expect do
+        config.on_failure.call
+      end.to raise_error( SystemExit )
+    end
+  end
+end

data/spec/zaphod/git_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+require 'zaphod/git'
+
+describe Zaphod::Git do
+  let( :git  ) { stub!.diff_index { DIFF }.subject }
+  let( :grit ) { stub!.git { git }.subject }
+
+  subject { described_class.new grit }
+
+  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 }
+
+      subject.diff
+    end
+
+    it "returns the patch split into a Hash of file => patch sets" do
+      subject.diff.keys.should include(
+        "./spec/spec_helper.rb",
+        "./spec/zaphod/source_control_spec.rb"
+        )
+    end
+  end
+
+  DIFF = <<-EOS
+diff --git /dev/null b/spec/spec_helper.rb
+--- /dev/null
++++ b/spec/spec_helper.rb
+@@ -1 +1,29 @@
++# This file was generated by the `rspec --init` command. Conventionally, all
++# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
++# Require this file using `require "spec_helper"` to ensure that it is only
++# loaded once.
++#
++# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
++
++require 'simplecov'
++require 'zaphod'
++
++SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
++  SimpleCov::Formatter::HTMLFormatter,
++  SimpleCov::Formatter::ZaphodFormatter
++]
++
++SimpleCov.start
++
++RSpec.configure do |config|
++  config.treat_symbols_as_metadata_keys_with_true_values = true
++  config.run_all_when_everything_filtered = true
++  config.filter_run :focus
++
++  # Run specs in random order to surface order dependencies. If you find an
++  # order dependency and want to debug it, you can fix the order by providing
++  # the seed, which is printed after each run.
++  #     --seed 1234
++  config.order = 'random'
++end
+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
++++ b/spec/zaphod/source_control_spec.rb
+@@ -6,6 +6,7 @@ describe Zaphod::Git do
+     File.expand_path( File.join __FILE__, "..", ".." )
+     )
+
++
+   describe "#initialize" do
+     it "accepts a repository" do
+       described_class.new Grit::Repo.new REPO_PATH
+@@ -13,10 +14,9 @@ describe Zaphod::Git do
+   end
+
+   describe "#changes", integrated: true do
+-    let( :first_commit ) { stub diffs: [last_diff] }
+-    let( :commits )      { [first_commit] }
+-    let( :repository )   { stub commits: commits }
+-    let( :last_diff )    { stub diff: DIFF, b_path: "spec/spec_helper.rb" }
++    let( :patch )        { DIFF }
++    let( :git_native )   { stub diff_index: patch }
++    let( :repository )   { stub git: git_native }
+
+     let( :git )          { described_class.new repository }
+  EOS
+end

data/spec/zaphod/source_control_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'pp'
+
+describe Zaphod::SourceControl do
+  REPO_PATH = File.dirname(
+    File.expand_path( File.join __FILE__, "..", ".." )
+    )
+
+  describe "#initialize" do
+    it "accepts a repository" do
+      described_class.new Grit::Repo.new 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"
+      }
+    end
+    let( :repository )   { stub!.diff { patch_map }.subject }
+
+    subject { described_class.new repository }
+
+    it do
+      subject.changes.should be_an_instance_of( Zaphod::ChangeSet )
+      subject.changes.should_not be_empty
+
+      subject.changes.each do |change|
+        File.exist?( change.path ).should be_true, change.path
+      end
+    end
+
+    it "generates a row for each file in the diff" do
+      subject.changes.length.should eq 2
+    end
+
+    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
+        )
+    end
+
+    it "strips the plusses off the lines" do
+      subject.changes.first.source.first.should_not start_with( "+" )
+    end
+  end
+end

data/spec/zaphod_spec.rb

@@ -0,0 +1,50 @@
+require "spec_helper"
+
+describe Zaphod do
+  describe ".configure" do
+    it "takes a block" do
+      Zaphod.configure { :foo }
+    end
+
+    it "yields a configuration object" do
+      Zaphod.configure do |config|
+        expect( config ).to be_an_instance_of( Zaphod::Configuration )
+      end
+    end
+
+    it "yields the same object on repeated calls" do
+      config = nil
+      Zaphod.configure { |c| config = c }
+      Zaphod.configure do |c|
+        expect( c ).to be( config )
+      end
+    end
+  end
+
+  describe ".setup" do
+    it "sets the SimpleCov formatter to include the Zaphod formatter" do
+      Zaphod.setup
+
+      expected_formatters = [
+        SimpleCov::Formatter::HTMLFormatter,
+        SimpleCov::Formatter::ZaphodFormatter
+      ]
+
+      expect( SimpleCov.formatter.new.formatters ).to eq( expected_formatters )
+    end
+
+    it "starts simplecov" do
+      mock( SimpleCov ).start
+
+      Zaphod.setup
+    end
+
+    it "accepts a configuration block" do
+      configuration = nil
+      Zaphod.setup do |config|
+        configuration = config
+      end
+      expect( configuration ).to be_an_instance_of( Zaphod::Configuration )
+    end
+  end
+end

data/zaphod.gemspec

@@ -0,0 +1,35 @@
+$:.push File.expand_path( "../lib", __FILE__ )
+require "zaphod/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "zaphod"
+  spec.version = Zaphod::VERSION
+
+  spec.authors  = ["Toby Tripp"]
+  spec.email    = %q{toby.tripp+gems@gmail.com}
+  spec.homepage = %q{http://github.com/tobytripp/zaphod}
+
+  spec.summary = %q{Catch untested commits and report them.}
+  spec.description = %q{}
+
+  spec.files            = `git ls-files`.split("\n")
+  spec.executables      = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  spec.require_paths    = ["lib"]
+
+  spec.extra_rdoc_files = %w[README.org]
+  spec.rdoc_options     = ["--charset=UTF-8"]
+
+  spec.add_dependency "grit",      "~> 2.5"
+  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-rspec", "~> 4.2"
+  spec.add_development_dependency "guard-bundler"
+  spec.add_development_dependency "guard-shell"
+  spec.add_development_dependency "rb-fsevent"
+  spec.add_development_dependency 'rb-readline'
+end