simplecov-single_file_reporter 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+coverage
+spec/fixtures/*/coverage

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - ree
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+gemspec
+
+gem "bump", :github => "grosser/bump", :branch => "anylib"
+gem "rake"
+gem "rspec", "~>2"
+gem "test-unit"
+gem "minitest"

data/Gemfile.lock

@@ -0,0 +1,44 @@
+GIT
+  remote: git://github.com/grosser/bump.git
+  revision: fc5cc418963e0a1257bb6d12dd44382abea05dd7
+  branch: anylib
+  specs:
+    bump (0.3.8)
+
+PATH
+  remote: .
+  specs:
+    simplecov-single_file_reporter (0.0.1)
+      simplecov
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    minitest (4.2.0)
+    multi_json (1.5.0)
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    test-unit (2.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bump!
+  minitest
+  rake
+  rspec (~> 2)
+  simplecov-single_file_reporter!
+  test-unit

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "bump/tasks"
+
+task :default do
+  sh "rspec spec/"
+end

data/Readme.md

@@ -0,0 +1,58 @@
+print coverage for 1 test/spec file
+
+Install
+=======
+
+    gem install simplecov-single_file_reporter
+
+Usage
+=====
+
+### Simple setup
+
+Print coverage percent when you run a single file
+
+```Ruby
+require "simplecov/single_file_reporter"
+SimpleCov.start
+SimpleCov::SingleFileReporter.print
+```
+
+```Bash
+ruby test/a_test.rb
+1 tests, 1 assertions
+lib/a.rb coverage: 80.0
+```
+
+### Customizing file-finding rules
+
+SingleFileReporter needs to find the file that is tested.
+```
+test/test_xxx.rb -> lib/xxx.rb or app/xxx.rb
+```
+
+If it's something common, make a pull request.<br/>
+If your app has special rules you can add them:
+
+```Ruby
+class MyReporter < SimpleCov::SingleFileReporter
+  remove :file_under_test
+  def self.file_under_test(test_file)
+    super(test_file) || test_file.split("test/").last.sub("foo", "bar").sub("_test.rb", ".rb")
+  end
+end
+
+SimpleCov.start
+MyReporter.print
+```
+
+Authors
+======
+
+### [Contributors](https://github.com/grosser/simplecov-single_file_reporter/contributors)
+ - [Eirik Dentz Sinclair](https://github.com/edsinclair)
+
+[Michael Grosser](http://grosser.it)<br/>
+michael@grosser.it<br/>
+License: MIT<br/>
+[![Build Status](https://travis-ci.org/grosser/simplecov-single_file_reporter.png)](https://travis-ci.org/grosser/simplecov-single_file_reporter)

data/lib/simplecov/single_file_reporter.rb

@@ -0,0 +1,86 @@
+require "simplecov"
+
+class SimpleCov::SingleFileReporter
+  VERSION = "0.0.1"
+
+  ANSI_COLOR_CODE = {
+    :red    => "\e[31m",
+    :green  => "\e[32m",
+    :yellow => "\e[33m"
+  }
+
+  ANSI_COLOR_CODE_TERMINATOR = "\e[0m"
+
+  class << self
+    def print
+      return unless test_file = (called_with_single_test || called_with_single_spec)
+      SimpleCov.at_exit do
+        SimpleCov.result.format! # keep generating default report so people can see why the coverage is not 100%
+        puts coverage_for(test_file)
+      end
+    end
+
+    def coverage_for(test_file)
+      if file = file_under_test(test_file)
+        if percent = covered_percent(file)
+          message(file, percent)
+        else
+          "Could not find coverage for file #{file} in Simplecov report"
+        end
+      else
+        "Could not find tested file for #{test_file}"
+      end
+    end
+
+    def covered_percent(file)
+      data = SimpleCov.result.files.detect { |f| f.filename =~ /#{Regexp.escape file}$/ }
+      data.covered_percent.round(2) if data
+    end
+
+    private
+
+    def called_with_single_test
+      ARGV.empty? && File.exist?($0) && $0
+    end
+
+    def called_with_single_spec
+      $0 =~ %r{/r?spec$} && ARGV.size == 1 && File.exist?(ARGV[0]) && ARGV[0]
+    end
+
+    # TODO: Make this work for models, helpers, lib, etc
+    def file_under_test(test_file)
+      file = test_file.split(%r{(test|spec)/}).last.
+        sub(%r{^functional/}, "controllers/").
+        sub(%r{^unit/}, "").
+        sub(%r{^lib/}, "").
+        sub(%r{_(test|spec)\.rb}, ".rb").
+        sub(%r{(^|/)test_([^/]+\.rb)}, "\\1\\2")
+
+      possibilities = ["app", "lib"].map { |f| "#{f}/#{file}" }
+      possibilities.detect { |f| File.exist?(f) }
+    end
+
+    def color?
+      STDOUT.tty?
+    end
+
+    def message(file, percent)
+      message = "#{file} coverage: #{percent}"
+      if color?
+        "#{ANSI_COLOR_CODE.fetch(color(percent))}#{message}#{ANSI_COLOR_CODE_TERMINATOR}"
+      else
+        message
+      end
+    end
+
+    def color(percent)
+      if percent == 100.0
+        :green
+      elsif percent > 90
+        :yellow
+      else
+        :red
+      end
+    end
+  end
+end

data/simplecov-single_file_reporter.gemspec

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+name = "simplecov-single_file_reporter"
+require name.sub("-", "/")
+
+Gem::Specification.new name, SimpleCov::SingleFileReporter::VERSION do |s|
+  s.summary = "print coverage per test file"
+  s.authors = ["Michael Grosser"]
+  s.email = "michael@grosser.it"
+  s.homepage = "http://github.com/grosser/#{name}"
+  s.files = `git ls-files`.split("\n")
+  s.license = "MIT"
+  s.add_runtime_dependency "simplecov"
+end

data/spec/fixtures/minitest-project/Rakefile

@@ -0,0 +1,2 @@
+require "rake/testtask"
+Rake::TestTask.new(:default)

data/spec/fixtures/minitest-project/lib/a.rb

@@ -0,0 +1,9 @@
+def a
+  1
+  2
+  3
+end
+
+1
+2
+3

data/spec/fixtures/minitest-project/test/test_a.rb

@@ -0,0 +1,13 @@
+require "minitest/autorun"
+require File.expand_path("../../../setup_simple_print.rb", __FILE__)
+
+# Load file under test
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "a"
+
+class ATest < MiniTest::Unit::TestCase
+  def test_a
+    assert true
+  end
+end
+

data/spec/fixtures/rspec-project/Rakefile

@@ -0,0 +1,2 @@
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:default)

data/spec/fixtures/rspec-project/lib/a.rb

@@ -0,0 +1,9 @@
+def a
+  1
+  2
+  3
+end
+
+1
+2
+3

data/spec/fixtures/rspec-project/spec/a_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path("../../../setup_simple_print.rb", __FILE__)
+
+# Load file under test
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "a"
+
+describe "A" do
+  it "is true" do
+    true.should == true
+  end
+end
+

data/spec/fixtures/rspec-project/spec/b_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path("../../../setup_simple_print.rb", __FILE__)
+
+# Load file under test
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "a"
+
+describe "B" do
+  it "is true" do
+    true.should == true
+  end
+end
+

data/spec/fixtures/setup_simple_print.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift File.expand_path("../../../../lib", __FILE__)
+require 'simplecov/single_file_reporter'
+SimpleCov.root(File.expand_path("../../", __FILE__))
+SimpleCov.start
+SimpleCov::SingleFileReporter.print

data/spec/fixtures/test-unit-project/Rakefile

@@ -0,0 +1,2 @@
+require "rake/testtask"
+Rake::TestTask.new(:default)

data/spec/fixtures/test-unit-project/lib/a.rb

@@ -0,0 +1,9 @@
+def a
+  1
+  2
+  3
+end
+
+1
+2
+3

data/spec/fixtures/test-unit-project/test/test_a.rb

@@ -0,0 +1,13 @@
+require "test/unit"
+require File.expand_path("../../../setup_simple_print.rb", __FILE__)
+
+# Load file under test
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "a"
+
+class ATest < Test::Unit::TestCase
+  def test_a
+    assert true
+  end
+end
+

data/spec/simplecov/single_file_reporter_spec.rb

@@ -0,0 +1,150 @@
+require "spec_helper"
+
+describe SimpleCov::SingleFileReporter do
+  def self.in_folder(folder)
+    around do |example|
+      Dir.chdir fixtures.join(folder) do
+        example.call
+      end
+    end
+  end
+
+  def self.it_shows_correct_coverage_reports(options={})
+    it "shows percentage after single file is run" do
+      result = run(options[:run] || "ruby test/test_a.rb")
+      result.should include("Coverage report generated")
+      result.should include(options[:result_run] || "1 tests, 1 assertions")
+      result.should include("lib/a.rb coverage: 80.0")
+    end
+
+    it "does not show percentage for rake" do
+      result = run("rake")
+      result.should include("Coverage report generated")
+      result.should include(options[:result_rake] || "1 tests, 1 assertions")
+      result.should_not include("lib/a.rb coverage")
+    end
+  end
+
+  let(:fixtures){ Bundler.root.join("spec", "fixtures") }
+
+  it "has a VERSION" do
+    SimpleCov::SingleFileReporter::VERSION.should =~ /^[\.\da-z]+$/
+  end
+
+  describe ".color" do
+    [[100, :green], [99, :yellow], [91, :yellow], [90, :red], [0, :red]].each do |percent, color|
+      it "shows #{color} for #{percent}" do
+        call(:color, percent).should == color
+      end
+    end
+  end
+
+  describe ".message" do
+    it "is plain for none-tty" do
+      STDOUT.stub(:tty?).and_return(false)
+      call(:message, "xxx.rb", 10).should == "xxx.rb coverage: 10"
+    end
+
+    it "is colored for tty" do
+      STDOUT.stub(:tty?).and_return(true)
+      call(:message, "xxx.rb", 10).should == "\e[31mxxx.rb coverage: 10\e[0m"
+    end
+  end
+
+  describe ".file_under_test" do
+    around do |example|
+      tmp = fixtures.join("tmp")
+      `rm -rf #{tmp}`
+      `mkdir -p #{tmp}`
+      begin
+        Dir.chdir tmp do
+          example.call
+        end
+      ensure
+        `rm -rf #{tmp}`
+      end
+    end
+
+    it "does not find unfindable" do
+      touch "lib/xxx.rb"
+      call(:file_under_test, "yyy.rb").should == nil
+    end
+
+    it "finds files in lib via _test.rb" do
+      test_find "test/xxx_test.rb", "lib/xxx.rb"
+    end
+
+    it "finds files in lib via test_*.rb" do
+      test_find "test/test_xxx.rb", "lib/xxx.rb"
+    end
+
+    it "finds files in app" do
+      test_find "test/xxx_test.rb", "app/xxx.rb"
+    end
+
+    it "finds nested files" do
+      test_find "test/foo/bar/xxx_test.rb", "lib/foo/bar/xxx.rb"
+    end
+
+    it "finds functional as app/controllers" do
+      test_find "test/functional/xxx_controller_test.rb", "app/controllers/xxx_controller.rb"
+    end
+
+    it "finds test/unit/xxx as app/xxx" do
+      test_find "test/unit/xxx_test.rb", "app/xxx.rb"
+    end
+
+    it "finds test/unit/xxx as lib/xxx" do
+      test_find "test/unit/xxx_test.rb", "lib/xxx.rb"
+    end
+
+    it "finds test/unit/lib/xxx as lib/xxx" do
+      test_find "test/unit/lib/xxx_test.rb", "lib/xxx.rb"
+    end
+
+    it "finds spec" do
+      test_find "spec/xxx_spec.rb", "lib/xxx.rb"
+    end
+  end
+
+  context "in a test-unit project" do
+    in_folder "test-unit-project"
+    it_shows_correct_coverage_reports
+  end
+
+  context "in a minitest project" do
+    in_folder "minitest-project"
+    it_shows_correct_coverage_reports
+  end
+
+  context "in a rspec project" do
+    in_folder "rspec-project"
+    it_shows_correct_coverage_reports(
+      :run => "rspec spec/a_spec.rb",
+      :result_rake => "2 examples, 0 failures",
+      :result_run => "1 example, 0 failures",
+    )
+  end
+
+  private
+
+  def run(command)
+    result = `#{command} 2>&1`
+  ensure
+    raise "FAILED: #{result}" unless $?.success?
+  end
+
+  def call(name, *args)
+    SimpleCov::SingleFileReporter.send(name, *args)
+  end
+
+  def touch(file)
+    run "mkdir -p #{File.dirname(file)} && touch #{file}"
+  end
+
+  def test_find(test, file)
+    touch file
+    touch test
+    call(:file_under_test, test).should == file
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "simplecov/single_file_reporter"

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: simplecov-single_file_reporter
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :runtime
+description: 
+email: michael@grosser.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- Readme.md
+- lib/simplecov/single_file_reporter.rb
+- simplecov-single_file_reporter.gemspec
+- spec/fixtures/minitest-project/Rakefile
+- spec/fixtures/minitest-project/lib/a.rb
+- spec/fixtures/minitest-project/test/test_a.rb
+- spec/fixtures/rspec-project/Rakefile
+- spec/fixtures/rspec-project/lib/a.rb
+- spec/fixtures/rspec-project/spec/a_spec.rb
+- spec/fixtures/rspec-project/spec/b_spec.rb
+- spec/fixtures/setup_simple_print.rb
+- spec/fixtures/test-unit-project/Rakefile
+- spec/fixtures/test-unit-project/lib/a.rb
+- spec/fixtures/test-unit-project/test/test_a.rb
+- spec/simplecov/single_file_reporter_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/grosser/simplecov-single_file_reporter
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 756792922926595275
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 756792922926595275
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: print coverage per test file
+test_files: []