simplecov-rspec 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c140510851befaa363a4a01c35f0db12b18966dd7cb94312f4f32fe0d8772029
-  data.tar.gz: 399fb0c4494b9bbdbccd3e7c3e9b2be5a7856a4ef71b73e2712faff1b1dc6ea2
+  metadata.gz: f6700c02ee99fdfde4191bd23c07fe67cc573a53f088741a2c49d3d34c0a0633
+  data.tar.gz: c9a373acb23929feb2c5688e10c584ecd1c37780a6f20db90c18df6940d6b256
 SHA512:
-  metadata.gz: 402fb8ea61162c1efb934779af412e61836c872335f5c5a0264d0bd6b09be57c3ef0164210ae7336a3b9d21d4a8cbcd92c6e632653afe1fee018a9a5c95d7949
-  data.tar.gz: 27ef5ca48e03a7db7c2a57842f59c849aa3e210faa02bd0e749868147ed9e8dd4370efc9615083fbe5889b23cec905680dac4c7cec62dd950d3f417d9e4f06e0
+  metadata.gz: 6ccc7d29d68e55668534b2e2cba528c38244beaceb7e24f386a0401e9cd0d008f2a23361b79ec94b786b3fdefb84ef37d1e1a0c36e0f97a0e19fbbd0ce2af261
+  data.tar.gz: cf6c195cff9a812671d3e651f8c7dba561a4e76ade2a0313c166e1ee71362fe3df102c6759a705a70c7dca11b7cefdcf74297a9f78d11f280def0d0c83b2cf44

data/.commitlintrc.yml

@@ -0,0 +1,16 @@
+---
+extends: '@commitlint/config-conventional'
+
+rules:
+  # See: https://commitlint.js.org/reference/rules.html
+  #
+  # Rules are made up by a name and a configuration array. The configuration array contains:
+  #
+  # * Severity [0..2]: 0 disable rule, 1 warning if violated, or 2 error if violated
+  # * Applicability [always|never]: never inverts the rule
+  # * Value: value to use for this rule
+  #
+  # Run `npx commitlint --print-config` to see the current setting for all rules.
+  #
+  body-leading-blank:    [2, 'always']
+  footer-leading-blank:  [2, 'always']

data/.husky/commit-msg

@@ -0,0 +1 @@
+npx --no-install commitlint --edit "$1"

data/.rubocop.yml

@@ -1,38 +1,11 @@
-AllCops:
-  NewCops: enable
-  SuggestExtensions: false
-  DefaultFormatter: fuubar
-
-  # Output extra information for each offense to make it easier to diagnose:
-  DisplayCopNames: true
-  DisplayStyleGuide: true
-  ExtraDetails: true
+inherit_gem:
+  main_branch_shared_rubocop_config: config/rubocop.yml
 
+AllCops:
   # RuboCop enforces rules depending on the oldest version of Ruby which
   # your project supports:
   TargetRubyVersion: 3.1
 
-Gemspec/DevelopmentDependencies:
-  Enabled: false
-
-Layout/LineLength:
-  Max: 120
-
-# The DSL for RSpec and the gemspec file make it very hard to limit block length
-Metrics/BlockLength:
-  Exclude:
-    - '**/*_spec.rb'
-    - '*.gemspec'
-
-Metrics/ModuleLength:
-  CountAsOne: ['hash']
-
-Metrics/ClassLength:
-  CountAsOne: ['hash']
-
-Style/AsciiComments:
-  Enabled: false
-
 Style/StderrPuts:
   Enabled: false
 

data/CHANGELOG.md

@@ -4,6 +4,20 @@ Changes for each release are listed in this file.
 
 This project adheres to [Semantic Versioning](https://semver.org/) for its releases.
 
+## v0.4.0 (2024-10-10)
+
+[Full Changelog](https://github.com/main-branch/simplecov-rspec/compare/v0.3.2..v0.4.0)
+
+Changes since v0.3.2:
+
+* e06d866 build: update create_github_release dependency
+* b8aafa3 docs: add conventional commit badge to README
+* 596b217 build: remove semver pr label check
+* bed5192 build: enforce conventional commit message formatting
+* d036188 Clarify gem installation and configuration via env variables
+* 1d89785 Add TargetRubyVersion in .rubocop.yml
+* 2017a2f Use shared Rubocop config
+
 ## v0.3.2 (2024-09-17)
 
 [Full Changelog](https://github.com/main-branch/simplecov-rspec/compare/v0.3.1..v0.3.2)

data/README.md

@@ -6,6 +6,8 @@
 [![Build Status](https://github.com/main-branch/simplecov-rspec/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/main-branch/simplecov-rspec/actions/workflows/continuous_integration.yml)
 [![Maintainability](https://api.codeclimate.com/v1/badges/9a58b51d18910db724c7/maintainability)](https://codeclimate.com/github/main-branch/simplecov-rspec/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/9a58b51d18910db724c7/test_coverage)](https://codeclimate.com/github/main-branch/simplecov-rspec/test_coverage)
+[![Conventional
+Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
 [![Slack](https://img.shields.io/badge/slack-main--branch/simplecov--rspec-yellow.svg?logo=slack)](https://main-branch.slack.com/archives/C07MCM9J72B)
 
 `simplecov-rspec` is a Ruby gem that integrates SimpleCov with RSpec to ensure your
@@ -31,29 +33,41 @@ If configured to list the lines that were not covered by tests, RSpec will addit
 ```
 
 * [Installation](#installation)
-* [Getting Started](#getting-started)
-  * [Basic Setup](#basic-setup)
-  * [Configuration from Environment Variables](#configuration-from-environment-variables)
+* [Getting started](#getting-started)
+  * [Basic setup](#basic-setup)
+  * [Configuration from environment variables](#configuration-from-environment-variables)
 * [Development](#development)
 * [Contributing](#contributing)
+  * [Commit message guidelines](#commit-message-guidelines)
+  * [Pull request guidelines](#pull-request-guidelines)
 * [License](#license)
-* [Code of Conduct](#code-of-conduct)
+* [Code of conduct](#code-of-conduct)
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+To install the gem, add to the following line to your application's gemspec OR Gemfile:
 
-```bash
-bundle add simplecov-rspec
+gemspec:
+
+```ruby
+  spec.add_development_dependency "simplecov-rspec", '~> 0.1'
 ```
 
+Gemfile:
+
+```ruby
+gem "simplecov-rspec", "~> 0.1", groups: [:development, :test]
+```
+
+and then run `bundle install`
+
 If bundler is not being used to manage dependencies, install the gem by executing:
 
 ```bash
 gem install simplecov-rspec
 ```
 
-## Getting Started
+## Getting started
 
 To use `simplecov-rspec`, follow these steps:
 
@@ -76,7 +90,7 @@ This will configure RSpec to fail when test coverage falls below 100%.
 
 That is it!
 
-### Basic Setup
+### Basic setup
 
 To initialize simplecov-rspec with defaults, add the following to your `spec_helper.rb`:
 
@@ -117,11 +131,10 @@ This block is passed on to `SimpleCov::RSpec.start`. See [Configuring
 SimpleCov](https://github.com/simplecov-ruby/simplecov?tab=readme-ov-file#configuring-simplecov)
 for details.
 
-### Configuration from Environment Variables
-
-Environment variables can be used to set these options as follows:
+### Configuration from environment variables
 
-You can configure `simplecov-rspec` using the following environment variables:
+Environment variables can be used to configure `simplecov-rspec`. These environment
+variables take presidence over the values passed to `SimpleCov::RSpec.start`.
 
 * **`COVERAGE_THRESHOLD`**: Sets the minimum coverage threshold (0-100). Overrides
   `coverage_threshold`.
@@ -145,8 +158,8 @@ uncovered lines on different platforms than the one you run for local developmen
 If you want to contribute or experiment with the gem, follow these steps to set up
 your development environment:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake
-spec` to run the tests. You can also run `bin/console` for an interactive prompt that
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake`
+to run linting, tests, etc. just like the CI build. You can also run `bin/console` for an interactive prompt that
 will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To
@@ -163,12 +176,37 @@ welcoming space for collaboration, and contributors are expected to adhere to th
 [code of
 conduct](https://github.com/main-branch/simplecov-rspec/blob/main/CODE_OF_CONDUCT.md).
 
+### Commit message guidelines
+
+All commit messages must follow the [Conventional Commits
+standard](https://www.conventionalcommits.org/en/v1.0.0/). This helps us maintain a
+clear and structured commit history, automate versioning, and generate changelogs
+effectively.
+
+To ensure compliance, this project includes:
+
+* A git commit-msg hook that validates your commit messages before they are accepted.
+
+  To activate the hook, you must have node installed and run `npm install`.
+
+* A GitHub Actions workflow that will enforce the Conventional Commit standard as
+  part of the continuous integration pipeline.
+
+  Any commit message that does not conform to the Conventional Commits standard will
+  cause the workflow to fail and not allow the PR to be merged.
+
+### Pull request guidelines
+
+All pull requests must be merged using rebase merges. This ensures that commit
+messages from the feature branch are preserved in the release branch, keeping the
+history clean and meaningful.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT
 License](https://opensource.org/licenses/MIT).
 
-## Code of Conduct
+## Code of conduct
 
 Everyone interacting in the Simplecov::Rspec project's codebases, issue trackers,
 chat rooms and mailing lists is expected to follow the [code of

data/Rakefile

@@ -44,14 +44,9 @@ CLEAN << 'rspec-report.xml'
 
 require 'rubocop/rake_task'
 
-RuboCop::RakeTask.new do |t|
-  t.options = %w[
-    --format progress
-    --format json --out rubocop-report.json
-  ]
-end
+RuboCop::RakeTask.new
 
-CLEAN << 'rubocop-report.json'
+# YARD
 
 unless RUBY_PLATFORM == 'java'
   # yard:build

data/lib/simplecov-rspec/version.rb

@@ -3,6 +3,6 @@
 module Simplecov
   class Rspec
     # This gem's version
-    VERSION = '0.3.2'
+    VERSION = '0.4.0'
   end
 end

data/package.json

@@ -0,0 +1,11 @@
+{
+  "devDependencies": {
+    "@commitlint/cli": "^19.5.0",
+    "@commitlint/config-conventional": "^19.5.0",
+    "husky": "^9.1.0"
+  },
+  "scripts": {
+    "postinstall": "husky",
+    "prepare": "husky"
+  }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplecov-rspec
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - James Couball
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-17 00:00:00.000000000 Z
+date: 2024-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: fuubar
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: main_branch_shared_rubocop_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -194,6 +208,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".commitlintrc.yml"
+- ".husky/commit-msg"
 - ".markdownlint.yml"
 - ".rspec"
 - ".rubocop.yml"
@@ -205,6 +221,7 @@ files:
 - Rakefile
 - lib/simplecov-rspec.rb
 - lib/simplecov-rspec/version.rb
+- package.json
 homepage: https://github.com/main-branch/simplecov-rspec
 licenses:
 - MIT
@@ -212,8 +229,8 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/main-branch/simplecov-rspec
   source_code_uri: https://github.com/main-branch/simplecov-rspec
-  documentation_uri: https://rubydoc.info/gems/simplecov-rspec/0.3.2
-  changelog_uri: https://rubydoc.info/gems/simplecov-rspec/0.3.2/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/simplecov-rspec/0.4.0
+  changelog_uri: https://rubydoc.info/gems/simplecov-rspec/0.4.0/file/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []