codeclimate-test-reporter 0.4.0 → 0.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c2f9c2cd5324d8649ca2a3d3a473525bedbe365c
+  data.tar.gz: 07804f41564354ff8d7123d6c3f6c2f3650b1c41
+SHA512:
+  metadata.gz: 3e8a40570da4dc86aafa4f1b6d6aab911e779f1d65ea6b61e91ff7b18f84f688c9ea8fbe5dec34bbda8d876b8e8c0d500d0180627851dcaf62546dd61f940b4f
+  data.tar.gz: a161bca31e7d2cd5355eefe921f4c4f01056a95268d9bc72b8108e48462c8527eb89f727a3ff5044103e51cef9a8ae3e3515723fce89ef71a78c190482f825f5

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+before_script:
+  - git config --global user.email "ci@codeclimate.com"
+  - git config --global user.name "Code Climate CI"
+rvm:
+  - 1.9.3
+  - 2.1.2
+  - jruby

data/README.md

@@ -46,6 +46,44 @@ end
 CodeClimate::TestReporter.start
 ```
 
+## Extending Simplecov with other formatters
+
+Since ruby-test-reporter 0.4.0 you can use `CodeClimate::TestReporter::Formatter` as a Simplecov formatter directly. Just add the formatter to your Simplecov formatter in addition to the rest of your configuration:
+
+```ruby
+require 'codeclimate-test-reporter'
+SimpleCov.start do
+  formatter SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    CodeClimate::TestReporter::Formatter
+  ]
+  ...
+end
+```
+
+## Using with [parallel_tests](https://github.com/grosser/parallel_tests)
+
+Note: This may work with other parallel test runners as long as they run on the same machine.
+
+Be sure you're using `simplecov` `>= 0.9.0`. 
+
+Add the following to your `test_helper.rb`/`spec_helper.rb` instead of what is normally required.
+
+```ruby
+require 'simplecov'
+require 'codeclimate-test-reporter'
+SimpleCov.add_filter 'vendor'
+SimpleCov.formatters = []
+SimpleCov.start CodeClimate::TestReporter.configuration.profile
+```
+
+Then after all your tests run, in a rake task or as a build step do:
+
+```
+require 'simplecov'
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter::Formatter.new.format(SimpleCov.result)
+```
 
 ## Help! Your gem is raising a ...
 

data/lib/code_climate/test_reporter.rb

@@ -6,7 +6,9 @@ module CodeClimate
         require "simplecov"
         ::SimpleCov.add_filter 'vendor'
         ::SimpleCov.formatter = Formatter
-        ::SimpleCov.start(configuration.profile)
+        ::SimpleCov.start(configuration.profile) do
+          skip_token CodeClimate::TestReporter.configuration.skip_token
+        end
       end
     end
 

data/lib/code_climate/test_reporter/ci.rb

@@ -2,56 +2,65 @@ module CodeClimate
   module TestReporter
     class Ci
 
-      def self.service_data
-        if ENV['TRAVIS']
+      def self.service_data(env = ENV)
+        if env['TRAVIS']
           {
             name:             "travis-ci",
-            branch:           ENV['TRAVIS_BRANCH'],
-            build_identifier: ENV['TRAVIS_JOB_ID'],
-            pull_request:     ENV['TRAVIS_PULL_REQUEST']
+            branch:           env['TRAVIS_BRANCH'],
+            build_identifier: env['TRAVIS_JOB_ID'],
+            pull_request:     env['TRAVIS_PULL_REQUEST']
           }
-        elsif ENV['CIRCLECI']
+        elsif env['CIRCLECI']
           {
             name:             "circlci",
-            build_identifier: ENV['CIRCLE_BUILD_NUM'],
-            branch:           ENV['CIRCLE_BRANCH'],
-            commit_sha:       ENV['CIRCLE_SHA1']
+            build_identifier: env['CIRCLE_BUILD_NUM'],
+            branch:           env['CIRCLE_BRANCH'],
+            commit_sha:       env['CIRCLE_SHA1']
           }
-        elsif ENV['SEMAPHORE']
+        elsif env['SEMAPHORE']
           {
             name:             "semaphore",
-            branch:           ENV['BRANCH_NAME'],
-            build_identifier: ENV['SEMAPHORE_BUILD_NUMBER']
+            branch:           env['BRANCH_NAME'],
+            build_identifier: env['SEMAPHORE_BUILD_NUMBER']
           }
-        elsif ENV['JENKINS_URL']
+        elsif env['JENKINS_URL']
           {
             name:             "jenkins",
-            build_identifier: ENV['BUILD_NUMBER'],
-            build_url:        ENV['BUILD_URL'],
-            branch:           ENV['GIT_BRANCH'],
-            commit_sha:       ENV['GIT_COMMIT']
+            build_identifier: env['BUILD_NUMBER'],
+            build_url:        env['BUILD_URL'],
+            branch:           env['GIT_BRANCH'],
+            commit_sha:       env['GIT_COMMIT']
           }
-        elsif ENV['TDDIUM']
+        elsif env['TDDIUM']
           {
             name:             "tddium",
-            build_identifier: ENV['TDDIUM_SESSION_ID'],
-            worker_id:        ENV['TDDIUM_TID']
+            build_identifier: env['TDDIUM_SESSION_ID'],
+            worker_id:        env['TDDIUM_TID']
           }
-        elsif ENV['WERCKER']
+        elsif env['WERCKER']
           {
             name:             "wercker",
-            build_identifier: ENV['WERCKER_BUILD_ID'],
-            build_url:        ENV['WERCKER_BUILD_URL'],
-            branch:           ENV['WERCKER_GIT_BRANCH'],
-            commit_sha:       ENV['WERCKER_GIT_COMMIT']
+            build_identifier: env['WERCKER_BUILD_ID'],
+            build_url:        env['WERCKER_BUILD_URL'],
+            branch:           env['WERCKER_GIT_BRANCH'],
+            commit_sha:       env['WERCKER_GIT_COMMIT']
           }
-        elsif ENV['CI_NAME'] =~ /codeship/i
+        elsif env['CI_NAME'] =~ /DRONE/i
+          {
+            name:             "drone",
+            build_identifier: env['CI_BUILD_NUMBER'],
+            build_url:        env['CI_BUILD_URL'],
+            branch:           env['CI_BRANCH'],
+            commit_sha:       env['CI_BUILD_NUMBER'],
+            pull_request:     env['CI_PULL_REQUEST']
+          }
+        elsif env['CI_NAME'] =~ /codeship/i
           {
             name:             "codeship",
-            build_identifier: ENV['CI_BUILD_NUMBER'],
-            build_url:        ENV['CI_BUILD_URL'],
-            branch:           ENV['CI_BRANCH'],
-            commit_sha:       ENV['CI_COMMIT_ID'],
+            build_identifier: env['CI_BUILD_NUMBER'],
+            build_url:        env['CI_BUILD_URL'],
+            branch:           env['CI_BRANCH'],
+            commit_sha:       env['CI_COMMIT_ID'],
           }
         else
           {}

data/lib/code_climate/test_reporter/configuration.rb

@@ -33,6 +33,10 @@ module CodeClimate
         @profile ||= "test_frameworks"
       end
 
+      def skip_token
+        @skip_token ||= "nocov"
+      end
+
       private
 
       def default_logger

data/lib/code_climate/test_reporter/formatter.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require "tmpdir"
 require "securerandom"
 require "json"
@@ -13,7 +15,7 @@ module CodeClimate
       def format(result)
         return true unless CodeClimate::TestReporter.run?
 
-        print "Coverage = #{round(result.covered_percent, 2)}%. "
+        print "Coverage = #{result.source_files.covered_percent.round(2)}%. "
 
         payload = to_payload(result)
         PayloadValidator.validate(payload)
@@ -63,8 +65,8 @@ module CodeClimate
           repo_token:       ENV["CODECLIMATE_REPO_TOKEN"],
           source_files:     source_files,
           run_at:           result.created_at.to_i,
-          covered_percent:  round(result.covered_percent, 2),
-          covered_strength: round(result.covered_strength, 2),
+          covered_percent:  result.source_files.covered_percent.round(2),
+          covered_strength: result.source_files.covered_strength.round(2),
           line_counts:      totals,
           partial:          partial?,
           git: Git.info,
@@ -80,10 +82,13 @@ module CodeClimate
       end
 
       def calculate_blob_id(path)
-        content = File.open(path, "rb") {|f| f.read }
-        header = "blob #{content.length}\0"
-        store = header + content
-        Digest::SHA1.hexdigest(store)
+        File.open(path, "rb") do |file|
+          header  = "blob #{file.size}\0"
+          content = file.read.force_encoding("iso-8859-1").encode("utf-8", replace: nil)
+          store   = header + content
+
+          return Digest::SHA1.hexdigest(store)
+        end
       end
 
       def short_filename(filename)

data/lib/code_climate/test_reporter/git.rb

@@ -12,16 +12,21 @@ module CodeClimate
         end
 
         def branch_from_git_or_ci
-          git_branch = branch_from_git
-          ci_branch = Ci.service_data[:branch]
-
-          if ci_branch.to_s.strip.size > 0
-            ci_branch.sub(/^origin\//, "")
-          elsif git_branch.to_s.strip.size > 0 && !git_branch.to_s.strip.start_with?("(")
-            git_branch.sub(/^origin\//, "")
-          else
-            "master"
-          end
+          clean_service_branch || clean_git_branch || "master"
+        end
+
+        def clean_service_branch
+          ci_branch = String(Ci.service_data[:branch])
+          clean = ci_branch.strip.sub(/^origin\//, "")
+
+          clean.size > 0 ? clean : nil
+        end
+
+        def clean_git_branch
+          git_branch = String(branch_from_git)
+          clean = git_branch.sub(/^origin\//, "") unless git_branch.start_with?("(")
+
+          clean.size > 0 ? clean : nil
         end
 
         private
@@ -32,9 +37,7 @@ module CodeClimate
         end
 
         def branch_from_git
-          branch = `git branch`.split("\n").delete_if { |i| i[0] != "*" }
-          branch = [branch].flatten.first
-          branch ? branch.gsub("* ","") : nil
+          `git rev-parse --abbrev-ref HEAD`.chomp
         end
       end
     end

data/lib/code_climate/test_reporter/version.rb

@@ -1,5 +1,5 @@
 module CodeClimate
   module TestReporter
-    VERSION = "0.4.0"
+    VERSION = "0.4.1"
   end
 end

data/spec/fixtures/encoding_test.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+class EncodingTest
+  def foo
+    "ä"
+  end
+end

data/spec/fixtures/encoding_test_iso.rb

@@ -0,0 +1,6 @@
+# encoding: iso-8859-1
+class EncodingTest
+  def foo
+    "�"
+  end
+end

data/spec/lib/ci_spec.rb

@@ -5,15 +5,11 @@ module CodeClimate::TestReporter
 
     describe '.service_data' do
       before :each do
-        ENV['SEMAPHORE'] = 'yes?'
-        ENV['BRANCH_NAME'] = 'master'
-        ENV['SEMAPHORE_BUILD_NUMBER'] = '1234'
-      end
-
-      after :each do
-        ENV.delete('SEMAPHORE')
-        ENV.delete('BRANCH_NAME')
-        ENV.delete('SEMAPHORE_BUILD_NUMBER')
+        @env = {
+          'SEMAPHORE' => 'yes?',
+          'BRANCH_NAME' => 'master',
+          'SEMAPHORE_BUILD_NUMBER' => '1234'
+        }
       end
 
       it 'returns a hash of CI environment info' do
@@ -23,9 +19,8 @@ module CodeClimate::TestReporter
           build_identifier: '1234'
         }
 
-        expect(Ci.service_data).to include expected_semaphore_hash
+        expect(Ci.service_data(@env)).to include expected_semaphore_hash
       end
     end
-
   end
 end

data/spec/lib/configuration_spec.rb

@@ -14,6 +14,7 @@ module CodeClimate::TestReporter
         expect(CodeClimate::TestReporter.configuration.logger.level).to eq Logger::INFO
         expect(CodeClimate::TestReporter.configuration.profile).to eq('test_frameworks')
         expect(CodeClimate::TestReporter.configuration.path_prefix).to be_nil
+        expect(CodeClimate::TestReporter.configuration.skip_token).to eq('nocov')
       end
     end
 

data/spec/lib/formatter_spec.rb

@@ -6,6 +6,12 @@ module CodeClimate::TestReporter
     let(:project_path) { "spec/tmp" }
     let(:project_file) { "fake_project.rb" }
     let(:formatter) { Formatter.new }
+    let(:source_files) {
+      double(
+        :covered_percent  => 24.3,
+        :covered_strength => 33.2,
+      )
+    }
     let(:files) {
       [
         double(
@@ -25,6 +31,7 @@ module CodeClimate::TestReporter
         :covered_percent  => 24.3,
         :covered_strength => 33.2,
         :files            => files,
+        :source_files     => source_files,
         :created_at       => Time.at(1379704336),
         :command_name     => "rspec"
       )
@@ -63,7 +70,6 @@ module CodeClimate::TestReporter
             "simplecov_root" => Dir.pwd,
             "gem_version" => VERSION
           },
-        "ci_service" => {}
       }
     }
 
@@ -99,34 +105,46 @@ module CodeClimate::TestReporter
 
       uncompressed = inflate(app.request_body)
 
-      expect(JSON.parse(uncompressed)).to eq(expected_request)
+      expected_request.merge!("ci_service" => Ci.service_data)
+      expected_json = JSON.parse(expected_request.to_json, symbolize_names: true)
+
+      expect(JSON.parse(uncompressed, symbolize_names: true)).to eq(expected_json)
       expect(app.http_user_agent).to include("v#{CodeClimate::TestReporter::VERSION}")
     end
-  end
 
-  describe '#short_filename' do
-    let(:formatter) { CodeClimate::TestReporter::Formatter.new }
-    it 'should return the filename of the file relative to the SimpleCov root' do
-      expect(formatter.short_filename('file1')).to eq('file1')
-      expect(formatter.short_filename("#{::SimpleCov.root}/file1")).to eq('file1')
-    end
+    describe '#short_filename' do
+      it 'should return the filename of the file relative to the SimpleCov root' do
+        expect(formatter.short_filename('file1')).to eq('file1')
+        expect(formatter.short_filename("#{::SimpleCov.root}/file1")).to eq('file1')
+      end
 
-    context "with path prefix" do
-      before do
-        CodeClimate::TestReporter.configure do |config|
-          config.path_prefix = 'custom'
+      context "with path prefix" do
+        before do
+          CodeClimate::TestReporter.configure do |config|
+            config.path_prefix = 'custom'
+          end
         end
-      end
 
-      after do
-        CodeClimate::TestReporter.configure do |config|
-          config.path_prefix = nil
+        after do
+          CodeClimate::TestReporter.configure do |config|
+            config.path_prefix = nil
+          end
+        end
+
+        it 'should include the path prefix if set' do
+          expect(formatter.short_filename('file1')).to eq('custom/file1')
+          expect(formatter.short_filename("#{::SimpleCov.root}/file1")).to eq('custom/file1')
         end
       end
+    end
+
+    describe "#calculate_blob_id" do
+      it "forces UTF-8 as encoding for the file content" do
+        blob_id = formatter.calculate_blob_id(File.expand_path("../../fixtures/encoding_test_iso.rb", __FILE__))
+        expect(blob_id).to_not be_nil
 
-      it 'should include the path prefix if set' do
-        expect(formatter.short_filename('file1')).to eq('custom/file1')
-        expect(formatter.short_filename("#{::SimpleCov.root}/file1")).to eq('custom/file1')
+        blob_id = formatter.calculate_blob_id(File.expand_path("../../fixtures/encoding_test.rb", __FILE__))
+        expect(blob_id).to_not be_nil
       end
     end
   end

data/spec/lib/git_spec.rb

@@ -24,7 +24,7 @@ module CodeClimate::TestReporter
       it 'returns the branch from git if there is no ci branch' do
         allow(Ci).to receive(:service_data).and_return({})
 
-        expect(Git.branch_from_git_or_ci).to eq Git.send(:branch_from_git)
+        expect(Git.branch_from_git_or_ci).to eq Git.clean_git_branch
       end
 
       it 'returns master otherwise' do

metadata

@@ -1,116 +1,103 @@
 --- !ruby/object:Gem::Specification
 name: codeclimate-test-reporter
 version: !ruby/object:Gem::Version
-  version: 0.4.0
-  prerelease: 
+  version: 0.4.1
 platform: ruby
 authors:
 - Bryan Helmkamp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-01 00:00:00.000000000 Z
+date: 2014-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.1
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.1
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: artifice
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Collects test coverage data from your Ruby test suite and sends it to
@@ -122,8 +109,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -141,6 +129,8 @@ files:
 - lib/code_climate/test_reporter/payload_validator.rb
 - lib/code_climate/test_reporter/version.rb
 - lib/codeclimate-test-reporter.rb
+- spec/fixtures/encoding_test.rb
+- spec/fixtures/encoding_test_iso.rb
 - spec/lib/ci_spec.rb
 - spec/lib/configuration_spec.rb
 - spec/lib/formatter_spec.rb
@@ -151,29 +141,30 @@ files:
 homepage: ''
 licenses:
 - MIT
+metadata: {}
 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: 
-rubygems_version: 1.8.23.2
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Uploads Ruby test coverage data to Code Climate.
 test_files:
+- spec/fixtures/encoding_test.rb
+- spec/fixtures/encoding_test_iso.rb
 - spec/lib/ci_spec.rb
 - spec/lib/configuration_spec.rb
 - spec/lib/formatter_spec.rb
@@ -181,4 +172,3 @@ test_files:
 - spec/lib/payload_validator_spec.rb
 - spec/lib/test_reporter_spec.rb
 - spec/spec_helper.rb
-has_rdoc: