zaphod 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8b985fa07e31d0a2e442bfb3f0af08f485c16b71
+  data.tar.gz: 4bc888ba21ba077563bda11553ea603386c03724
+SHA512:
+  metadata.gz: 765fa47d7730e1890073fd6e0927d49b01a986c1e16750a1d36df8fc62e7c12a4dcc60a0890a10d4572b7283d41ac0c08bfbae96ca714b5f783d0ada78053e97
+  data.tar.gz: 969ec8dbfd997dec29bbea65b362448bca2603db4597d29e41ae476ae09492240afbce44af73200e97705a29c701de6ad0b709cea36c5bb13f1aab9833229d1a

data/.bundle/config

@@ -0,0 +1 @@
+--- {}

data/.gitignore

@@ -0,0 +1,11 @@
+TAGS
+tmp/*
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+lib/bundler/man
+pkg
+rdoc
+spec/reports

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.ruby-version

@@ -0,0 +1 @@
+2.1.0

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,86 @@
+PATH
+  remote: .
+  specs:
+    zaphod (1.0.0)
+      grit (~> 2.5)
+      simplecov (~> 0.8)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    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)
+      formatador (>= 0.2.4)
+      listen (~> 2.1)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-bundler (2.0.0)
+      bundler (~> 1.0)
+      guard (~> 2.2)
+    guard-rspec (4.2.4)
+      guard (~> 2.1)
+      rspec (>= 2.14, < 4.0)
+    guard-shell (0.6.1)
+      guard (>= 1.1.0)
+    listen (2.4.0)
+      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)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.1)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.3)
+      ffi (>= 0.5.0)
+    rb-readline (0.5.1)
+    rr (1.1.2)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.4.7)
+    thor (0.18.1)
+    timers (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  guard (~> 2.3)
+  guard-bundler
+  guard-rspec (~> 4.2)
+  guard-shell
+  pry
+  rake (~> 10.1)
+  rb-fsevent
+  rb-readline
+  rr (~> 1.1)
+  rspec (~> 2.14)
+  zaphod!

data/Guardfile

@@ -0,0 +1,20 @@
+# -*- mode: ruby -*-
+# More info at https://github.com/guard/guard#readme
+
+guard :bundler do
+  watch 'matron.gemspec'
+  watch 'Gemfile'
+end
+
+guard 'rspec', :cmd => "bundle exec rspec --color --format documentation" do
+  watch( %r{^spec/.+_spec\.rb$} )
+  watch( %r{^lib/(.+)\.rb$} )   { |m| "spec/#{m[1]}_spec.rb" }
+  watch( 'spec/spec_helper.rb' )  { "spec" }
+end
+
+guard 'shell' do
+  watch( %r{^lib/.+\.rb$} ) {
+    `ctags -R -e lib`
+    `emacsclient --eval "(visit-tags-table tags-file-name)"`
+  }
+end

data/LICENSE

@@ -0,0 +1,198 @@
+Eclipse Public License - v 1.0
+
+THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
+LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM
+CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
+
+1. DEFINITIONS
+
+"Contribution" means:
+
+a) in the case of the initial Contributor, the initial code and documentation
+   distributed under this Agreement, and
+b) in the case of each subsequent Contributor:
+    i) changes to the Program, and
+   ii) additions to the Program;
+
+   where such changes and/or additions to the Program originate from and are
+   distributed by that particular Contributor. A Contribution 'originates' from
+   a Contributor if it was added to the Program by such Contributor itself or
+   anyone acting on such Contributor's behalf. Contributions do not include
+   additions to the Program which: (i) are separate modules of software
+   distributed in conjunction with the Program under their own license
+   agreement, and (ii) are not derivative works of the Program.
+
+"Contributor" means any person or entity that distributes the Program.
+
+"Licensed Patents" mean patent claims licensable by a Contributor which are
+necessarily infringed by the use or sale of its Contribution alone or when
+combined with the Program.
+
+"Program" means the Contributions distributed in accordance with this Agreement.
+
+"Recipient" means anyone who receives the Program under this Agreement,
+including all Contributors.
+
+2. GRANT OF RIGHTS
+  a) Subject to the terms of this Agreement, each Contributor hereby grants
+     Recipient a non-exclusive, worldwide, royalty-free copyright license to
+     reproduce, prepare derivative works of, publicly display, publicly perform,
+     distribute and sublicense the Contribution of such Contributor, if any, and
+     such derivative works, in source code and object code form.
+  b) Subject to the terms of this Agreement, each Contributor hereby grants
+     Recipient a non-exclusive, worldwide, royalty-free patent license under
+     Licensed Patents to make, use, sell, offer to sell, import and otherwise
+     transfer the Contribution of such Contributor, if any, in source code and
+     object code form. This patent license shall apply to the combination of the
+     Contribution and the Program if, at the time the Contribution is added by
+     the Contributor, such addition of the Contribution causes such combination
+     to be covered by the Licensed Patents. The patent license shall not apply
+     to any other combinations which include the Contribution. No hardware per
+     se is licensed hereunder.
+  c) Recipient understands that although each Contributor grants the licenses to
+     its Contributions set forth herein, no assurances are provided by any
+     Contributor that the Program does not infringe the patent or other
+     intellectual property rights of any other entity. Each Contributor
+     disclaims any liability to Recipient for claims brought by any other entity
+     based on infringement of intellectual property rights or otherwise. As a
+     condition to exercising the rights and licenses granted hereunder, each
+     Recipient hereby assumes sole responsibility to secure any other
+     intellectual property rights needed, if any. For example, if a third party
+     patent license is required to allow Recipient to distribute the Program, it
+     is Recipient's responsibility to acquire that license before distributing
+     the Program.
+  d) Each Contributor represents that to its knowledge it has sufficient
+     copyright rights in its Contribution, if any, to grant the copyright
+     license set forth in this Agreement.
+
+3. REQUIREMENTS
+
+A Contributor may choose to distribute the Program in object code form under its
+own license agreement, provided that:
+
+  a) it complies with the terms and conditions of this Agreement; and
+  b) its license agreement:
+      i) effectively disclaims on behalf of all Contributors all warranties and
+         conditions, express and implied, including warranties or conditions of
+         title and non-infringement, and implied warranties or conditions of
+         merchantability and fitness for a particular purpose;
+     ii) effectively excludes on behalf of all Contributors all liability for
+         damages, including direct, indirect, special, incidental and
+         consequential damages, such as lost profits;
+    iii) states that any provisions which differ from this Agreement are offered
+         by that Contributor alone and not by any other party; and
+     iv) states that source code for the Program is available from such
+         Contributor, and informs licensees how to obtain it in a reasonable
+         manner on or through a medium customarily used for software exchange.
+
+When the Program is made available in source code form:
+
+  a) it must be made available under this Agreement; and
+  b) a copy of this Agreement must be included with each copy of the Program.
+     Contributors may not remove or alter any copyright notices contained within
+     the Program.
+
+Each Contributor must identify itself as the originator of its Contribution, if
+any, in a manner that reasonably allows subsequent Recipients to identify the
+originator of the Contribution.
+
+4. COMMERCIAL DISTRIBUTION
+
+Commercial distributors of software may accept certain responsibilities with
+respect to end users, business partners and the like. While this license is
+intended to facilitate the commercial use of the Program, the Contributor who
+includes the Program in a commercial product offering should do so in a manner
+which does not create potential liability for other Contributors. Therefore, if
+a Contributor includes the Program in a commercial product offering, such
+Contributor ("Commercial Contributor") hereby agrees to defend and indemnify
+every other Contributor ("Indemnified Contributor") against any losses, damages
+and costs (collectively "Losses") arising from claims, lawsuits and other legal
+actions brought by a third party against the Indemnified Contributor to the
+extent caused by the acts or omissions of such Commercial Contributor in
+connection with its distribution of the Program in a commercial product
+offering. The obligations in this section do not apply to any claims or Losses
+relating to any actual or alleged intellectual property infringement. In order
+to qualify, an Indemnified Contributor must: a) promptly notify the Commercial
+Contributor in writing of such claim, and b) allow the Commercial Contributor to
+control, and cooperate with the Commercial Contributor in, the defense and any
+related settlement negotiations. The Indemnified Contributor may participate in
+any such claim at its own expense.
+
+For example, a Contributor might include the Program in a commercial product
+offering, Product X. That Contributor is then a Commercial Contributor. If that
+Commercial Contributor then makes performance claims, or offers warranties
+related to Product X, those performance claims and warranties are such
+Commercial Contributor's responsibility alone. Under this section, the
+Commercial Contributor would have to defend claims against the other
+Contributors related to those performance claims and warranties, and if a court
+requires any other Contributor to pay any damages as a result, the Commercial
+Contributor must pay those damages.
+
+5. NO WARRANTY
+
+EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
+IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each
+Recipient is solely responsible for determining the appropriateness of using and
+distributing the Program and assumes all risks associated with its exercise of
+rights under this Agreement , including but not limited to the risks and costs
+of program errors, compliance with applicable laws, damage to or loss of data,
+programs or equipment, and unavailability or interruption of operations.
+
+6. DISCLAIMER OF LIABILITY
+
+EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY
+CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST
+PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS
+GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+7. GENERAL
+
+If any provision of this Agreement is invalid or unenforceable under applicable
+law, it shall not affect the validity or enforceability of the remainder of the
+terms of this Agreement, and without further action by the parties hereto, such
+provision shall be reformed to the minimum extent necessary to make such
+provision valid and enforceable.
+
+If Recipient institutes patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Program itself
+(excluding combinations of the Program with other software or hardware)
+infringes such Recipient's patent(s), then such Recipient's rights granted under
+Section 2(b) shall terminate as of the date such litigation is filed.
+
+All Recipient's rights under this Agreement shall terminate if it fails to
+comply with any of the material terms or conditions of this Agreement and does
+not cure such failure in a reasonable period of time after becoming aware of
+such noncompliance. If all Recipient's rights under this Agreement terminate,
+Recipient agrees to cease use and distribution of the Program as soon as
+reasonably practicable. However, Recipient's obligations under this Agreement
+and any licenses granted by Recipient relating to the Program shall continue and
+survive.
+
+Everyone is permitted to copy and distribute copies of this Agreement, but in
+order to avoid inconsistency the Agreement is copyrighted and may only be
+modified in the following manner. The Agreement Steward reserves the right to
+publish new versions (including revisions) of this Agreement from time to time.
+No one other than the Agreement Steward has the right to modify this Agreement.
+The Eclipse Foundation is the initial Agreement Steward. The Eclipse Foundation
+may assign the responsibility to serve as the Agreement Steward to a suitable
+separate entity. Each new version of the Agreement will be given a
+distinguishing version number. The Program (including Contributions) may always
+be distributed subject to the version of the Agreement under which it was
+received. In addition, after a new version of the Agreement is published,
+Contributor may elect to distribute the Program (including its Contributions)
+under the new version. Except as expressly stated in Sections 2(a) and 2(b)
+above, Recipient receives no rights or licenses to the intellectual property of
+any Contributor under this Agreement, whether expressly, by implication,
+estoppel or otherwise. All rights in the Program not expressly granted under
+this Agreement are reserved.
+
+This Agreement is governed by the laws of the State of New York and the
+intellectual property laws of the United States of America. No party to this
+Agreement will bring a legal action under this Agreement more than one year
+after the cause of action arose. Each party waives its rights to a jury trial in
+any resulting litigation.

data/README.org

@@ -0,0 +1,59 @@
+* Zaphod
+
+“I can understand that.  I wouldn't trust myself further than I could spit a rat.”
+
+** You Will Not Commit Untested Code!
+
+Catch, and publicly embarrass, untested commits into git.
+
+** Installation
+
+*** Simple Installation
+
+#+BEGIN_SRC ruby
+  require "zaphod"
+  Zaphod.setup
+#+END_SRC
+
+*** Setup your own SimpleCov Formatters
+
+#+BEGIN_SRC ruby
+  require "zaphod"
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,  # Optional, I suppose
+    SimpleCov::Formatter::ZaphodFormatter
+  ]
+
+  SimpleCov.start
+#+END_SRC
+
+** Configuration
+
+#+BEGIN_SRC ruby
+     require "pony"
+
+     Zaphod.setup do |configuration|
+       configuration.on_failure do
+         Pony.mail(
+           to: 'you@example.com',
+           subject: "Someone is trying to commit untested code!"
+           )
+         raise SystemExit.new( -1 )
+       end
+     end
+#+END_SRC
+
+#+BEGIN_SRC ruby
+    SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+      SimpleCov::Formatter::HTMLFormatter,
+      SimpleCov::Formatter::ZaphodFormatter
+    ]
+
+    Zaphod.configure do |configuration|
+      configuration.on_failure do
+        $stderr.puts "What would your mother think?"
+      end
+    end
+    SimpleCov.start
+#+END_SRC

data/Rakefile

@@ -0,0 +1,9 @@
+require "rake"
+require "rdoc/task"
+
+begin
+  require 'bundler/setup'
+  Bundler::GemHelper.install_tasks
+rescue LoadError
+  puts "Bundler not available. Install it with: gem install bundler"
+end

data/lib/simplecov/formatter/zaphod_formatter.rb

@@ -0,0 +1,40 @@
+require "zaphod/change_set"
+
+module SimpleCov
+  module Formatter
+    # Send a set of File:Line tuples to a Zaphod class that intersects
+    # it with a set from the last git commit. Blow up and send an
+    # email if the intersection reveals lines in the current commit
+    # that are uncovered.
+    #
+    # Aborting with a non-zero exit code should propagate properly
+    # through SimpleCov.
+    #
+    class ZaphodFormatter
+      attr_accessor :source_control
+
+      def initialize()
+        @source_control = Zaphod::SourceControl.git Dir.pwd
+      end
+
+      def format( result )
+        uncovered_codeset = uncovered result
+        changed_codeset   = source_control.changes
+
+        diff = uncovered_codeset.intersection( changed_codeset )
+        unless diff.empty?
+          Zaphod.configuration.on_failure.call diff
+        end
+      end
+
+      def uncovered( result )
+        Zaphod::ChangeSet.new result.files.map { |source_file|
+          Zaphod::CodeChange.new(
+            source_file.filename,
+            source_file.missed_lines.map( &:src )
+            )
+        }
+      end
+    end
+  end
+end

data/lib/zaphod/change_set.rb

@@ -0,0 +1,14 @@
+require "forwardable"
+require "set"
+
+module Zaphod
+  class ChangeSet
+    extend Forwardable
+    attr_reader :changes
+    def_delegators :@changes, :empty?, :each, :map, :first, :length, :intersection
+
+    def initialize( changes )
+      @changes = Set.new changes
+    end
+  end
+end

data/lib/zaphod/code_change.rb

@@ -0,0 +1,23 @@
+module Zaphod
+  class CodeChange
+    attr_reader :path, :source
+    def initialize( path, source_lines=[] )
+      @path   = File.expand_path path
+      @source = source_lines
+    end
+
+    def eql?( other )
+      return false if source.empty?
+      path.eql?( other.path ) &&
+        !(source & other.source ).empty?
+    end
+
+    def hash()
+      [path, source].hash
+    end
+
+    def inspect()
+      "<#{self.class.name} #{path}>\n" + source.join( "\n" )
+    end
+  end
+end

data/lib/zaphod/configuration.rb

@@ -0,0 +1,15 @@
+module Zaphod
+  class Configuration
+    def initialize()
+      self.on_failure { raise SystemExit.new( -1 ) }
+    end
+
+    def on_failure( &block )
+      if block_given?
+        @on_failure_action = block
+      else
+        @on_failure_action
+      end
+    end
+  end
+end

data/lib/zaphod/git.rb

@@ -0,0 +1,38 @@
+require 'grit'
+
+module Zaphod
+  class Git
+    attr_reader :repo
+    attr_accessor :diff_against
+
+    def self.from_path( path )
+      new Grit::Repo.new( path )
+    end
+
+    def initialize( repository, diff_against="HEAD" )
+      @repo = repository
+      @diff_against = diff_against
+    end
+
+    def diff()
+      diffs = repo.git.diff_index( { p: true }, diff_against ).
+        split( /^diff --git .* b(.*)$/ )
+
+      as_hash diffs
+    end
+
+    protected
+
+    def as_hash( diff )
+      diffs = diff.drop_while( &:empty? )
+      relativize_paths Hash[*diffs]
+    end
+
+    def relativize_paths( patch_map )
+      patch_map.dup.each_with_object( map = {}) do |pair, h|
+        h[".#{pair.first}"] = pair.last
+      end
+      map
+    end
+  end
+end

data/lib/zaphod/source_control.rb

@@ -0,0 +1,31 @@
+require "zaphod/git"
+
+module Zaphod
+  class SourceControl
+    attr_reader :repo
+
+    def self.git( path )
+      new Git.from_path( path )
+    end
+
+    def initialize( repository )
+      @repo = repository
+    end
+
+    def changes()
+      ChangeSet.new repo.diff.map { |path, diff|
+        CodeChange.new File.expand_path( path ), additions_from( diff.lines )
+      }
+    end
+
+    def additions_from( lines )
+      lines.
+        select { |l| addition? l }.
+        map    { |l| l.gsub( /^[+]/, "" ) }
+    end
+
+    def addition?( line )
+      line =~ /^[+][^+]/
+    end
+  end
+end

data/lib/zaphod/spike.rb

@@ -0,0 +1,7 @@
+module Zaphod
+  class Spike
+    def initialize()
+      @var = "foo"
+    end
+  end
+end

data/lib/zaphod/version.rb

@@ -0,0 +1,3 @@
+module Zaphod
+  VERSION = "1.0.0"
+end

data/lib/zaphod.rb

@@ -0,0 +1,26 @@
+require "simplecov"
+require 'simplecov/formatter/zaphod_formatter'
+require 'zaphod/code_change'
+require 'zaphod/source_control'
+require 'zaphod/configuration'
+
+module Zaphod
+  def self.configuration()
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure()
+    yield configuration
+  end
+
+  def self.setup()
+    require "simplecov"
+    yield configuration if block_given?
+
+    SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+      SimpleCov::Formatter::HTMLFormatter,
+      SimpleCov::Formatter::ZaphodFormatter
+    ]
+    SimpleCov.start
+  end
+end

data/spec/do_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'zaphod/spike'
+
+describe "converage" do
+  it "tests something" do
+    (1 + 1).should == 2
+  end
+end