simplecov-phabricator 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+/coverage
+/.bundle
+/.idea
+/.project
+/.rspec
+/pmip

data/Gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+
+group :test, :development do
+  gem 'rake'
+  gem 'minitest'
+  gem 'simplecov'
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    docile (1.1.0)
+    minitest (5.0.8)
+    multi_json (1.8.2)
+    rake (10.1.0)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest
+  rake
+  simplecov

data/README.rdoc

@@ -0,0 +1,20 @@
+= Simplecov Phabricator Formatter
+
+The target of this formatter is Phabricator compliant code coverage report. More details at: https://secure.phabricator.com/book/phabricator/article/arcanist_coverage/
+
+= Install
+
+gem install simplecov-phabricator
+
+= Usage
+
+Add the gem to the Gemfile preferably in the group test:
+
+  gem 'simplecov', require: false
+  gem 'simplecov-phabricator', require: false
+
+Enable formatter:
+  require 'simplecov'
+  require 'simplecov-phabricator'
+  SimpleCov.formatter = SimpleCov::Formatter::PhabricatorFormatter
+

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/test_*.rb"
+end
+
+task :default => :test

data/lib/simplecov-phabricator.rb

@@ -0,0 +1,60 @@
+require 'fileutils'
+require 'time'
+require 'pathname'
+require 'json'
+
+unless defined?(SimpleCov)
+  raise RuntimeError, "simplecov-phabricator is a formatter for simplecov. Please update your test helper and gemfile to require 'simplecov'!"
+end
+
+class SimpleCov::Formatter::PhabricatorFormatter
+  def format( result )
+    coverage_report = {}
+    result.files.each do |file|
+      file_path = rails_file_path(file.filename)
+      coverage_report[file_path] = format_file_coverage(file)
+    end
+    save_coverage_report(coverage_report)
+  end
+
+  def self.output_path
+    SimpleCov.coverage_path
+  end
+
+  def self.file_name
+    'phabricator-coverage.json'
+  end
+
+  private
+
+  def save_coverage_report(coverage)
+    output_filepath = File.join(SimpleCov::Formatter::PhabricatorFormatter.output_path,
+                                SimpleCov::Formatter::PhabricatorFormatter.file_name)
+
+    File.open( output_filepath, "w" ) do |file_result|
+      file_result.write coverage.to_json
+    end
+  end
+
+  def rails_file_path(filename)
+    if defined?(Rails)
+      Pathname.new(filename).relative_path_from(Rails.root).to_s
+    else
+      filename
+    end
+  end
+
+  def format_file_coverage(file)
+    file.lines.map do |file_line|
+      if file_line.covered?
+        'C' # C Covered. This line has test coverage.
+      elsif file_line.missed?
+        'U' # U Uncovered. This line is executable but has no test coverage.
+      elsif file_line.never? || file_line.skipped?
+        'N' # N Not executable. This is a comment or whitespace which should be ignored when computing test coverage.
+      else
+        ' '
+      end
+    end.join
+  end
+end

data/lib/simplecov-phabricator/version.rb

@@ -0,0 +1,8 @@
+module SimpleCov
+  module Formatter
+    class PhabricatorFormatter
+      VERSION = "0.0.1"
+      UPSTREAM_URL = "https://github.com/chetane/simplecov-phabricator"
+    end
+  end
+end

data/simplecov-phabricator.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "simplecov-phabricator/version"
+
+Gem::Specification.new do |s|
+  s.name        = "simplecov-phabricator"
+  s.version     = SimpleCov::Formatter::PhabricatorFormatter::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Omar Skalli"]
+  s.email       = ["chetane@gmail.com"]
+  s.homepage    = SimpleCov::Formatter::PhabricatorFormatter::UPSTREAM_URL
+  s.summary     = %q{A Simplecov Phabricator Formatter}
+  s.description = %q{A Simplevoc Formatter compatible with Phabricator's code review format.}
+  s.license = 'MIT'
+  s.extra_rdoc_files = [
+      "README.rdoc"
+    ]
+
+  s.rubyforge_project = "simplecov-phabricator"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/test/fixtures/some_class.rb

@@ -0,0 +1,13 @@
+class SomeClass
+  def method_1
+    1+1
+  end
+
+  def method_2 ( value )
+    value * value
+  end
+
+  def method_3
+    "über"
+  end
+end

data/test/test_simplecov-phabricator.rb

@@ -0,0 +1,42 @@
+require 'minitest'
+require 'minitest/autorun'
+require 'minitest/unit'
+require 'simplecov'
+
+require 'simplecov-phabricator'
+
+class TestSimpleCovFormatterPhabricatorFormatter < MiniTest::Test
+  def setup
+    @rcov_file = File.join( SimpleCov::Formatter::PhabricatorFormatter.output_path, SimpleCov::Formatter::PhabricatorFormatter.file_name)
+    File.delete( @rcov_file ) if File.exists?( @rcov_file )
+
+    @result = SimpleCov::Result.new(
+      {
+        File.expand_path( File.join( File.dirname( __FILE__ ), 'fixtures', 'some_class.rb' ) )  =>
+        [1,1,1,1,nil,1,0,1,1,nil,0,1,1]
+      }
+    )
+
+    # Set to default encoding
+    Encoding.default_internal = nil if defined?(Encoding)
+  end
+
+  def test_format
+    SimpleCov::Formatter::PhabricatorFormatter.new.format( @result )
+
+    assert File.exists?( @rcov_file )
+  end
+
+  def test_encoding
+    # This is done in many rails environments
+    Encoding.default_internal = 'UTF-8' if defined?(Encoding)
+
+    SimpleCov::Formatter::PhabricatorFormatter.new.format( @result )
+  end
+
+  def test_create_content
+    SimpleCov::Formatter::PhabricatorFormatter.new.format( @result )
+    content = File.open(@rcov_file, "r").read
+    assert_match(/{".+some_class\.rb":"CCCCNCUCCNUCC"}/, content)
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: simplecov-phabricator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Omar Skalli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-02 00:00:00.000000000 Z
+dependencies: []
+description: A Simplevoc Formatter compatible with Phabricator's code review format.
+email:
+- chetane@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- lib/simplecov-phabricator.rb
+- lib/simplecov-phabricator/version.rb
+- simplecov-phabricator.gemspec
+- test/fixtures/some_class.rb
+- test/test_simplecov-phabricator.rb
+homepage: https://github.com/chetane/simplecov-phabricator
+licenses:
+- MIT
+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: simplecov-phabricator
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A Simplecov Phabricator Formatter
+test_files:
+- test/fixtures/some_class.rb
+- test/test_simplecov-phabricator.rb