coveralls_reborn 0.27.0 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04c9754eac3145b40b91fb2fb3dad2c211543360c4b8de17b0c1d0fdf7d94959
-  data.tar.gz: 0fcf13baf4cb78142413a8635fde339b2983c17325f204f3ac7c9c70d8a833b3
+  metadata.gz: 75d7439f90a8c923d70f4f690b09a7501c630c6eba8edbbba76ab5ab5cec90c3
+  data.tar.gz: 6e2fc6ef8412e028c48e7c31bf471c5b2ff14bb85c123aa6f4a77e05db223c52
 SHA512:
-  metadata.gz: 821ea060f88505b7d27aaa80567d7fdb67322d22aa03e456bb2fe9555e371e0e304a2eb8564783e55794a40e8efa75a41af9d1990519e8ad5e40247b9e99f3b7
-  data.tar.gz: a9ca84cf0a99ee87681f7be22b4f1be7df4018835408ad0acc40be4f9a96381cb9bf220aaa4c7c807e8009085ee99c9e6b46791e919e8f3c49ff7d2c5a36087e
+  metadata.gz: ae858874883460776e458893e501a74498696ad3a58a8f1de9e059c484171bb2f4a97ec9a92810a66770ae3b6e254f1874738f5f76ec8a71ca045df4b14469a6
+  data.tar.gz: 189e3a525cd1c7670216edbc6a468814211c4ebab6320d065fbf520237d895b13a105864ef19f878f0d520e2fc9829b413c06ab2e6200b5f4b80c228f0d1e4d3

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.28.0 / 2023-07-22
+
+* [ENHANCEMENT] Reduce gem size
+
 ## 0.27.0 / 2023-02-14
 
 * [FEATURE] Add Buildkite CI support [#43](https://github.com/tagliala/coveralls-ruby-reborn/pull/43)

data/README.md

@@ -1,15 +1,166 @@
 # [Coveralls Reborn](https://coveralls.io) for Ruby [![Coverage Status](https://coveralls.io/repos/github/tagliala/coveralls-ruby-reborn/badge.svg?branch=main)](https://coveralls.io/github/tagliala/coveralls-ruby-reborn?branch=main) ![Build Status](https://github.com/tagliala/coveralls-ruby-reborn/actions/workflows/ruby.yml/badge.svg) [![Gem Version](https://badge.fury.io/rb/coveralls_reborn.svg)](https://badge.fury.io/rb/coveralls_reborn)
 
-### [Read the docs →](https://docs.coveralls.io/ruby-and-rails)
+[Coveralls.io](https://coveralls.io) was designed with Ruby projects in mind, so we've made it as
+easy as possible to get started using [Coveralls](https://coveralls.io) with Ruby and Rails project.
 
 An up-to-date fork of [lemurheavy/coveralls-ruby](https://github.com/lemurheavy/coveralls-ruby)
 
-Add to your `Gemfile`:
+### PREREQUISITES
 
-```rb
-gem 'coveralls_reborn', '~> 0.27.0', require: false
+- Using a supported repo host ([GitHub](https://github.com/) | [Gitlab](https://gitlab.com/) |
+  [Bitbucket](https://bitbucket.org/))
+- Building on a supported CI service (see
+  [supported CI services](https://docs.coveralls.io/ci-services) here)
+- Any Ruby project or test framework supported by
+  [SimpleCov](https://github.com/colszowka/simplecov) is supported by the
+  [coveralls-ruby-reborn](https://github.com/tagliala/coveralls-ruby-reborn) gem. This includes
+  all your favorites, like [RSpec](https://rspec.info/), Cucumber, and Test::Unit.
+
+*Please note that [SimpleCov](https://github.com/colszowka/simplecov) only supports Ruby 1.9 and later.*
+
+### INSTALLING THE GEM
+
+You shouldn't need more than a quick change to get your project on Coveralls. Just include
+[coveralls-ruby-reborn](https://github.com/tagliala/coveralls-ruby-reborn) in your project's
+Gemfile like so:
+
+```ruby
+# ./Gemfile
+
+gem 'coveralls_reborn', require: false
 ```
 
+While [SimpleCov](https://github.com/colszowka/simplecov) only supports Ruby 1.9+, using the
+Coveralls gem will not fail builds on earlier Rubies or other flavors of Ruby.
+
+### CONFIGURATION
+
+[coveralls-ruby-reborn](https://github.com/tagliala/coveralls-ruby-reborn) uses an optional
+`.coveralls.yml` file at the root level of your repository to configure options.
+
+The option `repo_token` (found on your repository's page on Coveralls) is used to specify which
+project on Coveralls your project maps to.
+
+Another important configuration option is `service_name`, which indicates your CI service and allows
+you to specify where Coveralls should look to find additional information about your builds. This
+can be any string, but using the appropriate string for your service may allow Coveralls to perform
+service-specific actions like fetching branch data and commenting on pull requests.
+
+**Example: A .coveralls.yml file configured for Travis Pro:**
+
+```yml
+service_name: travis-pro
+```
+
+**Example: Passing `repo_token` from the command line:**
+
+```console
+COVERALLS_REPO_TOKEN=asdfasdf bundle exec rspec spec
+```
+
+### TEST SUITE SETUP
+
+After configuration, the next step is to add
+[coveralls-ruby-reborn](https://github.com/tagliala/coveralls-ruby-reborn) to your test suite.
+
+For a Ruby app:
+
+```ruby
+# ./spec/spec_helper.rb
+# ./test/test_helper.rb
+# ..etc..
+
+require 'coveralls_reborn'
+Coveralls.wear!
+```
+
+For a Rails app:
+
+```ruby
+require 'coveralls_reborn'
+Coveralls.wear!('rails')
+```
+
+**Note:** The `Coveralls.wear!` must occur before any of your application code is required, so it
+should be at the **very top** of your `spec_helper.rb`, `test_helper.rb`, or `env.rb`, etc.
+
+And holy moly, you're done!
+
+Next time your project is built on CI, [SimpleCov](https://github.com/colszowka/simplecov) will dial
+up [Coveralls.io](https://coveralls.io) and send the hot details on your code coverage.
+
+### SIMPLECOV CUSTOMIZATION
+
+*"But wait!"* you're saying, *"I already use SimpleCov, and I have some custom settings! Are you
+really just overriding everything I've already set up?"*
+
+Good news, just use this gem's [SimpleCov](https://github.com/colszowka/simplecov) formatter
+directly:
+
+```ruby
+require 'simplecov'
+require 'coveralls_reborn'
+
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start do
+  add_filter 'app/secrets'
+end
+```
+
+Or alongside another formatter, like so:
+
+```ruby
+require 'simplecov'
+require 'coveralls_reborn'
+
+SimpleCov.formatters = [
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+```
+
+### MERGING MULTIPLE TEST SUITES
+
+If you're using more than one test suite and want the coverage results to be merged, use
+`Coveralls.wear_merged!` instead of `Coveralls.wear!`.
+
+Or, if you're using Coveralls alongside another [SimpleCov](https://github.com/colszowka/simplecov)
+formatter, simply omit the Coveralls formatter, then add the rake task `coveralls:push` to your
+`Rakefile` as a dependency to your testing task, like so:
+
+```ruby
+require 'coveralls_reborn/rake/task'
+Coveralls::RakeTask.new
+task :test_with_coveralls => [:spec, :features, 'coveralls:push']
+```
+
+This will prevent Coveralls from sending coverage data after each individual suite, instead waiting
+until [SimpleCov](https://github.com/colszowka/simplecov) has merged the results, which are then
+posted to [Coveralls.io](https://coveralls.io).
+
+Unless you've added `coveralls:push` to your default rake task, your build command will need to be
+updated on your CI to reflect this, for example:
+
+```console
+bundle exec rake :test_with_coveralls
+```
+
+*Read more about [SimpleCov's result merging](https://github.com/colszowka/simplecov#merging-results).*
+
+### MANUAL BUILDS VIA CLI
+
+[coveralls-ruby-reborn](https://github.com/tagliala/coveralls-ruby-reborn) also allows you to
+upload coverage data manually by running your test suite locally.
+
+To do this with [RSpec](https://rspec.info/), just type `bundle exec coveralls push` in your project
+directory.
+
+This will run [RSpec](https://rspec.info/) and upload the coverage data to
+[Coveralls.io](https://coveralls.io) as a one-off build, passing along any configuration options
+specified in `.coveralls.yml`.
+
+
 ### GitHub Actions
 
 Psst... you don't need this gem on GitHub Actions.

data/lib/coveralls/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Coveralls
-  VERSION = '0.27.0'
+  VERSION = '0.28.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coveralls_reborn
 version: !ruby/object:Gem::Version
-  version: 0.27.0
+  version: 0.28.0
 platform: ruby
 authors:
 - Nick Merwin
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-14 00:00:00.000000000 Z
+date: 2023-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -68,34 +68,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.32'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: simplecov-lcov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.8.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.8.0
 description: A Ruby implementation of the Coveralls API.
 email:
 - nick@lemurheavy.com
@@ -106,19 +78,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/dependabot.yml"
-- ".github/workflows/rubocop.yml"
-- ".github/workflows/ruby.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
 - bin/coveralls
-- coveralls-ruby.gemspec
 - lib/coveralls.rb
 - lib/coveralls/api.rb
 - lib/coveralls/command.rb
@@ -127,19 +90,6 @@ files:
 - lib/coveralls/rake/task.rb
 - lib/coveralls/simplecov.rb
 - lib/coveralls/version.rb
-- spec/coveralls/configuration_spec.rb
-- spec/coveralls/coveralls_spec.rb
-- spec/coveralls/fixtures/app/controllers/sample.rb
-- spec/coveralls/fixtures/app/models/airplane.rb
-- spec/coveralls/fixtures/app/models/dog.rb
-- spec/coveralls/fixtures/app/models/house.rb
-- spec/coveralls/fixtures/app/models/robot.rb
-- spec/coveralls/fixtures/app/models/user.rb
-- spec/coveralls/fixtures/app/vendor/vendored_gem.rb
-- spec/coveralls/fixtures/sample.rb
-- spec/coveralls/output_spec.rb
-- spec/coveralls/simple_cov/formatter_spec.rb
-- spec/spec_helper.rb
 homepage: https://coveralls.io
 licenses:
 - MIT
@@ -163,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: A Ruby implementation of the Coveralls API.

data/.github/dependabot.yml

@@ -1,8 +0,0 @@
-version: 2
-updates:
-- package-ecosystem: bundler
-  directory: "/"
-  schedule:
-    interval: daily
-    time: "04:00"
-  open-pull-requests-limit: 10

data/.github/workflows/rubocop.yml

@@ -1,29 +0,0 @@
-name: Rubocop
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
-
-jobs:
-  rubocop:
-    name: Rubocop
-    runs-on: ${{ matrix.os }}
-    env:
-      BUNDLE_JOBS: 4
-      BUNDLE_RETRY: 3
-    strategy:
-      matrix:
-        os: [ubuntu-latest]
-        ruby-version: ['3.2']
-
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true
-    - name: Ruby linter
-      run: bundle exec rubocop

data/.github/workflows/ruby.yml

@@ -1,53 +0,0 @@
-name: Ruby specs
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
-
-jobs:
-  test:
-    name: Tests
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version: ['2.6', '2.7', '3.0', '3.1', '3.2']
-        experimental: [false]
-
-        include:
-          - ruby-version: 'head'
-            experimental: true
-          - ruby-version: 'jruby-9.3'
-            experimental: true
-          - ruby-version: 'jruby-9.4'
-            experimental: true
-
-    continue-on-error: ${{ matrix.experimental }}
-
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true
-    - name: Run specs
-      run: JRUBY_OPTS="--dev --debug" bundle exec rake spec
-    - name: Coveralls Parallel
-      uses: coverallsapp/github-action@master
-      with:
-        github-token: ${{ secrets.github_token }}
-        flag-name: run-${{ matrix.ruby-version }}
-        parallel: true
-
-  coverage:
-    name: Coverage
-    needs: test
-    runs-on: ubuntu-latest
-    steps:
-    - name: Coveralls Finished
-      uses: coverallsapp/github-action@master
-      with:
-        github-token: ${{ secrets.github_token }}
-        parallel-finished: true

data/.gitignore

@@ -1,22 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-
-.DS_Store
-/vendor/
-
-.byebug_history

data/.rspec

@@ -1,2 +0,0 @@
---color
---warn

data/.rubocop.yml

@@ -1,63 +0,0 @@
-require:
-  - rubocop-performance
-  - rubocop-rake
-  - rubocop-rspec
-
-AllCops:
-  NewCops: enable
-  Exclude:
-    - 'spec/coveralls/fixtures/**/*'
-    - 'vendor/bundle/**/*'
-
-Layout/HashAlignment:
-  EnforcedColonStyle: table
-  EnforcedHashRocketStyle: table
-
-Layout/LineLength:
-  Enabled: false
-
-Metrics/AbcSize:
-  Max: 26.31
-  Exclude:
-    - 'lib/coveralls/configuration.rb'
-
-Metrics/CyclomaticComplexity:
-  Exclude:
-    - 'lib/coveralls/configuration.rb'
-
-Metrics/PerceivedComplexity:
-  Exclude:
-    - 'lib/coveralls/configuration.rb'
-
-Metrics/BlockLength:
-  Exclude:
-    - 'spec/**/*'
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/ModuleLength:
-  Exclude:
-    - 'lib/coveralls/configuration.rb'
-    - 'spec/**/*'
-
-RSpec/ExampleLength:
-  Max: 15
-
-RSpec/MultipleExpectations:
-  Enabled: false
-
-RSpec/MultipleMemoizedHelpers:
-  Enabled: false
-
-RSpec/NestedGroups:
-  Max: 4
-
-Style/Documentation:
-  Enabled: false
-
-Style/FetchEnvVar:
-  Enabled: false
-
-Style/IfUnlessModifier:
-  Enabled: false

data/Gemfile

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in coveralls-ruby.gemspec
-gemspec
-
-platforms :jruby do
-  gem 'jruby-openssl', '~> 0.14.0'
-end
-
-gem 'rake', '~> 13.0'
-gem 'rspec', '~> 3.12'
-gem 'rubocop', '~> 1.45'
-gem 'rubocop-performance', '~> 1.16'
-gem 'rubocop-rake', '~> 0.6.0'
-gem 'rubocop-rspec', '~> 2.18'
-gem 'truthy', '~> 1.0'
-gem 'vcr', '~> 6.1'
-gem 'webmock', '~> 3.18'

data/Rakefile

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-
-require 'rubygems'
-require 'rake'
-require 'rspec/core/rake_task'
-
-require 'rubocop/rake_task'
-
-RuboCop::RakeTask.new
-
-desc 'Run RSpec'
-RSpec::Core::RakeTask.new do |t|
-  t.verbose = false
-end
-
-task default: %i[rubocop spec]

data/coveralls-ruby.gemspec

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'coveralls/version'
-
-Gem::Specification.new do |gem|
-  gem.authors       = ['Nick Merwin', 'Wil Gieseler', 'Geremia Taglialatela']
-  gem.email         = ['nick@lemurheavy.com', 'supapuerco@gmail.com', 'tagliala.dev@gmail.com']
-  gem.description   = 'A Ruby implementation of the Coveralls API.'
-  gem.summary       = 'A Ruby implementation of the Coveralls API.'
-  gem.homepage      = 'https://coveralls.io'
-  gem.license       = 'MIT'
-
-  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
-  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
-  gem.name          = 'coveralls_reborn'
-  gem.require_paths = ['lib']
-  gem.version       = Coveralls::VERSION
-
-  gem.metadata['rubygems_mfa_required'] = 'true'
-
-  gem.metadata['bug_tracker_uri'] = 'https://github.com/tagliala/coveralls-ruby-reborn/issues'
-  gem.metadata['changelog_uri'] = 'https://github.com/tagliala/coveralls-ruby-reborn/blob/main/CHANGELOG.md'
-  gem.metadata['source_code_uri'] = 'https://github.com/tagliala/coveralls-ruby-reborn'
-
-  gem.required_ruby_version = '>= 2.6'
-
-  gem.add_dependency 'simplecov', '~> 0.22.0'
-  gem.add_dependency 'term-ansicolor', '~> 1.7'
-  gem.add_dependency 'thor', '~> 1.2'
-  gem.add_dependency 'tins', '~> 1.32'
-
-  gem.add_development_dependency 'bundler', '~> 2.0'
-  gem.add_development_dependency 'simplecov-lcov', '~> 0.8.0'
-end