codeclimate · illia2222 · Sep 28, 2016 · Sep 28, 2016 · Sep 28, 2016 · Sep 28, 2016
diff --git a/.gitignore b/.gitignore
@@ -5,6 +5,7 @@
 .yardoc
 *.DS_Store
 Gemfile.lock
+Gemfile.ruby-19.lock
 InstalledFiles
 _yardoc
 coverage

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,122 @@
+# Change log
+
+## master (unreleased)
+
+### New features
+
+### Bug fixes
+
+### Changes
+
+### v1.0.9 (2018-10-08)
+
+* Add deprecation notice to post-install gem message.
+
+### v1.0.8 (2017-03-20)
+
+### Bug fixes
+
+* Lock simplecov to `<= 0.13`, so we can safely use an internal-to-simplecov
+  method.
+  ([@bliof](https://github.com/codeclimate/ruby-test-reporter/pull/181))
+
+  Note: you may need to run `bundle update codeclimate-test-reporter simplecov`
+  to resolve your bundle.
+
+### v1.0.7 (2017-03-08)
+
+### Bug fixes
+
+* Continue improving our support for sending payloads in contexts where git is
+  not available.
+  ([@sullerandras](https://github.com/codeclimate/ruby-test-reporter/pull/177))
+
+### v1.0.6 (2017-02-22)
+
+### Bug fixes
+
+* Allow Codeship users to send a test coverage report without mounting their
+  `.git` directory within the docker container where they run their tests
+  _without_ manually exposing an environment variable. Instead, use an
+  environment variable already exposed by the CI environment.
+  ([@c-knowles](https://github.com/codeclimate/ruby-test-reporter/pull/172))
+
+### v1.0.5 (2017-01-19)
+
+### Bug fixes
+
+* Allow Codeship users to send a test coverage report without mounting their
+  `.git` directory within the docker container where they run their tests.
+  ([@antoniobg](https://github.com/codeclimate/ruby-test-reporter/pull/168))
+
+### v1.0.4 (2016-12-29)
+
+### New features
+
+* Accept path to coverage results as optional first argument ([@jreinert](https://github.com/codeclimate/ruby-test-reporter/pull/158))
+
+### Bug fixes
+
+* Handle multi-command resultsets ([@pbrisbin](https://github.com/codeclimate/ruby-test-reporter/pull/163))
+
+## v1.0.3 (2016-11-09)
+
+### Bug fixes
+
+* Improve strategy for Ruby 1.9.3 compatibility testing
+
+## v1.0.2 (2016-11-08)
+
+### Bug fixes
+
+* Fixed crashing error when the path to a file in the coverage report
+  contains a parenthesis.
+
+## v1.0.1 (2016-11-06)
+
+### Bug fixes
+
+* Made sure the gem can be built while running Ruby 1.9.3
+
+## v1.0.0 (2016-11-03)
+
+### Changes
+
+* Previously, this gem extended `Simplecov` with a custom formatter which posted
+  results to Code Climate. Now, you are responsible for executing `Simplecov`
+  yourself.
+
+  * If you already have the following in your test/test_helper.rb
+    (or spec_helper.rb, cucumber env.rb, etc)
+
+    ```ruby
+    require 'codeclimate-test-reporter'
+    CodeClimate::TestReporter.start
+    ```
+
+    then you should replace it with
+
+    ```ruby
+    require 'simplecov'
+    SimpleCov.start
+    ```
+
+* Previously, the `codeclimate-test-reporter` automatically uploaded results at
+  the end of your test suite.  Now, you are responsible for running
+  `codeclimate-test-reporter` as a separate step in your build.
+* Previously, this gem added some exclusion rules tuned according to feedback
+  from its users, and now these no longer happen automatically. *If you are
+  experiencing a discrepancy in test coverage % after switching to the new gem
+  version, it may be due to missing exclusions. Filtering `vendor`, `spec`, or
+  `test` directories may fix this issue.*
+* Previously, during the execution of multiple test suites, this gem would send
+  results from the first suite completed. You are now expected to run an
+  executable packaged with this gem as a separate build step, which means that
+  whatever results are there (likely the results from the last suite) will be
+  posted to Code Climate.
+
+## v0.6.0 (2016-06-27)
+
+### New features
+
+* Support `ENV["SSL_CERT_PATH"]` for custom SSL certificates
diff --git a/Gemfile b/Gemfile
@@ -1,12 +1,3 @@
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in codeclimate-test-reporter.gemspec
 gemspec
-
-platform :ruby_19 do
-  gem "pry-debugger", group: :development
-end
-
-platform :ruby_21 do
-  gem "pry-byebug", group: :development
-end
diff --git a/Gemfile.ruby-19 b/Gemfile.ruby-19
@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gem "addressable", "< 2.5"
+gem "json", "~> 1.8", "< 2"
+gem "rake", "< 12.3.0"
+gem "webmock", "< 2.3.1"
+
+gemspec
diff --git a/README.md b/README.md
@@ -1,38 +1,67 @@
-# codeclimate-test-reporter
+# codeclimate-test-reporter - [DEPRECATED]
+
+These configuration instructions refer to a language-specific test reporter who is now deprecated in favor of our new unified test reporter client. The [new test reporter](https://docs.codeclimate.com/v1.0/docs/configuring-test-coverage) is faster, distributed as a static binary, has support for parallelized CI builds, and will receive ongoing support by the team here. The existing test reporters for Ruby, Python, PHP, and Javascript are now deprecated.
 
 [![Code Climate](https://codeclimate.com/github/codeclimate/ruby-test-reporter/badges/gpa.svg)](https://codeclimate.com/github/codeclimate/ruby-test-reporter)
 
-Posts SimpleCov test coverage data from your Ruby test suite to Code Climate's hosted, automated code review service.
+Posts SimpleCov test coverage data from your Ruby test suite to Code Climate's
+hosted, automated code review service.
 
 Code Climate - [https://codeclimate.com](https://codeclimate.com)
 
 ## Installation
 
-This gem requires a user, but not necessarily a paid account, on Code Climate, so if you don't have one the
-first step is to signup at: [https://codeclimate.com](https://codeclimate.com). Then:
+This gem requires a user, but not necessarily a paid account, on Code Climate,
+so if you don't have one the first step is to signup at:
+[https://codeclimate.com](https://codeclimate.com). Then follow the
+instructions on our [documentation site](https://docs.codeclimate.com/docs/test-coverage-ruby).
 
-1. Add this to your Gemfile:
+Please contact hello@codeclimate.com if you need any assistance setting this up.
 
-        gem "codeclimate-test-reporter", group: :test
+## Usage
 
-1. Start SimpleCov as you normally would (more information here: https://github.com/colszowka/simplecov)
+```console
+bundle exec rspec && CODECLIMATE_REPO_TOKEN=my_token bundle exec codeclimate-test-reporter
+```
 
-1. Set the `CODECLIMATE_REPO_TOKEN` environment variable (provided after you add your repo to your Code Climate account by clicking on "Setup Test Coverage" on the right hand side of your feed)
+**Optional**: configure `CODECLIMATE_API_HOST` to point to a self-hosted version of Code Climate.
 
-1. Run the `codeclimate-test-reporter` executable at the end of your test suite
+## Troubleshooting / FYIs
 
-Please contact hello@codeclimate.com if you need any assistance setting this up.
+Across the many different testing frameworks, setups, and environments, there
+are lots of variables at play. If you're having any trouble with your test
+coverage reporting or the results are confusing, please see our full
+documentation here: https://docs.codeclimate.com/docs/setting-up-test-coverage
 
-## Troubleshooting / FYIs
+## Upgrading from pre-1.0 Versions
 
-Across the many different testing frameworks, setups, and environments, there are lots of variables at play. If you're having any trouble with your test coverage reporting or the results are confusing, please see our full documentation here: https://docs.codeclimate.com/docs/setting-up-test-coverage
+Version `1.0` of this gem introduced new, breaking changes to the way the
+test reporter is meant to be executed. The following list summarizes the major
+differences:
+
+See [the changelog entry for v1.0.0](CHANGELOG.md#v100-2016-11-03) for details.
 
 ## Contributions
 
 Patches, bug fixes, feature requests, and pull requests are welcome on the
-GitHub page for this project: [https://github.com/codeclimate/ruby-test-reporter](https://github.com/codeclimate/ruby-test-reporter)
+GitHub page for this project:
+[https://github.com/codeclimate/ruby-test-reporter](https://github.com/codeclimate/ruby-test-reporter)
+
+When making a pull request, please update the [changelog](CHANGELOG.md).
+
+This gem is maintained by Code Climate (hello@codeclimate.com).
+
+### Release Process
 
-This gem is maintained by Bryan Helmkamp (bryan@codeclimate.com).
+* Update the changelog to mark the unreleased changes as part of the new release.
+* Update the version.rb with the new version number
+* Make a pull request with those changes
+* Merge those changes to master
+* Check out and pull down the latest master locally
+* `rake release` which will
+  * tag the latest commit based on version.rb
+  * push to github
+  * push to rubygems
 
 ## Copyright
 

diff --git a/bin/ci b/bin/ci
@@ -0,0 +1,15 @@
+#!/bin/bash --login
+
+set -e
+
+rvm use 1.9.3
+ruby -v
+bundle install --gemfile Gemfile.ruby-19
+bundle exec rake
+
+rvm use 2.2.2
+ruby -v
+bundle install
+bundle exec rake
+
+CODECLIMATE_REPO_TOKEN=c4881e09870b0fac1291c93339b36ffe36210a2645c1ad25e52d8fda3943fb4d bundle exec codeclimate-test-reporter
diff --git a/bin/codeclimate-test-reporter b/bin/codeclimate-test-reporter
@@ -2,23 +2,20 @@
 
 require "codeclimate-test-reporter"
 
-COVERAGE_FILE = "coverage/.resultset.json".freeze
+repo_token = ENV["CODECLIMATE_REPO_TOKEN"]
+if repo_token.nil? || repo_token.empty?
+  STDERR.puts "Cannot post results: environment variable CODECLIMATE_REPO_TOKEN must be set."
+  exit
+end
+
+COVERAGE_FILE = ARGV.first || "coverage/.resultset.json"
 
-if (repo_token = ENV["CODECLIMATE_REPO_TOKEN"]) && !repo_token.empty?
-  if File.exist?(COVERAGE_FILE)
-    begin
-      results = JSON.parse(File.read(COVERAGE_FILE))
-    rescue JSON::ParserError => e
-      $stderr.puts "Error encountered while parsing #{COVERAGE_FILE}: #{e}"
-      exit(1)
-    end
+abort "Coverage results not found" unless File.exist?(COVERAGE_FILE)
 
-    CodeClimate::TestReporter.run(results)
-  else
-    $stderr.puts "Coverage results not found"
-    exit(1)
-  end
-else
-  $stderr.puts "Cannot post results: environment variable CODECLIMATE_REPO_TOKEN must be set."
-  exit(0)
+begin
+  results = JSON.parse(File.read(COVERAGE_FILE))
+rescue JSON::ParserError => e
+  abort "Error encountered while parsing #{COVERAGE_FILE}: #{e}"
 end
+
+CodeClimate::TestReporter.run(results)
diff --git a/circle.yml b/circle.yml
@@ -1,12 +1,10 @@
-machine:
-  ruby:
-    version: 2.2.2
 dependencies:
   pre:
     - git config --global user.email "ci@codeclimate.com"
     - git config --global user.name "Code Climate CI"
+  override:
+    - echo "skip"
 
 test:
   override:
-    - bundle exec rake
-    - bundle exec bin/codeclimate-test-reporter
+    - bin/ci
diff --git a/codeclimate-test-reporter.gemspec b/codeclimate-test-reporter.gemspec
@@ -3,22 +3,32 @@ require "./lib/code_climate/test_reporter/version"
 Gem::Specification.new do |spec|
   spec.name = "codeclimate-test-reporter"
   spec.version = CodeClimate::TestReporter::VERSION
-  spec.authors = ["Bryan Helmkamp"]
-  spec.email = ["bryan@brynary.com"]
+  spec.authors = ["Bryan Helmkamp", "Code Climate"]
+  spec.email = ["bryan@brynary.com", "hello@codeclimate.com"]
   spec.description = "Collects test coverage data from your Ruby test suite and sends it to Code Climate's hosted, automated code review service. Based on SimpleCov."
   spec.summary = "Uploads Ruby test coverage data to Code Climate."
   spec.homepage = "https://github.com/codeclimate/ruby-test-reporter"
   spec.license = "MIT"
 
   spec.files = `git ls-files bin lib config LICENSE.txt README.md`.split($/)
-  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }.reject { |f| f == "ci" }
 
   spec.required_ruby_version = ">= 1.9"
+  spec.add_runtime_dependency "simplecov", "<= 0.13"
 
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "pry"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "webmock"
-  spec.add_development_dependency "pry"
+
+  spec.post_install_message = %q(
+  Code Climate's codeclimate-test-reporter gem has been deprecated in favor of
+  our language-agnostic unified test reporter. The new test reporter is faster,
+  distributed as a static binary so dependency conflicts never occur, and
+  supports parallelized CI builds & multi-language CI configurations.
+
+  Please visit https://docs.codeclimate.com/v1.0/docs/configuring-test-coverage
+  for help setting up your CI process with our new test reporter.
+  )
 end
diff --git a/lib/code_climate/test_reporter.rb b/lib/code_climate/test_reporter.rb
@@ -3,8 +3,8 @@ module TestReporter
     WARNING_MESSAGE = <<-EOS.freeze
       This usage of the Code Climate Test Reporter is now deprecated. Since version
       1.0, we now require you to run `SimpleCov` in your test/spec helper, and then
-      run the provided `codeclimate-ruby` binary separately to report your results
-      to Code Climate.
+      run the provided `codeclimate-test-reporter` binary separately to report your
+      results to Code Climate.
 
       More information here: https://github.com/codeclimate/ruby-test-reporter/blob/master/README.md
     EOS