mad_rubocop 4.1.0.rc1 → 4.2.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28dc9f6db299ddf145dbae3fd33c608bc2cf688ee455c8797d36995d5e442ab5
-  data.tar.gz: dda48438a54bf5130230577610f390d9c50ba6167b14dd259eab18b0216ddc46
+  metadata.gz: 930cb2fd32ca469737626bc9a0887cc7bc360132a6f02fe64e7e1aea98385385
+  data.tar.gz: 6f128330fb5aec401bb769c396a96e649b33a4a131ca9b55111e83c66d24f019
 SHA512:
-  metadata.gz: 4df46cfc93ff45027a592247a2739abb951126f5718bd62541b9870d0509dc5f2b800085142e0179b24ccb926b3fb45d29bd8fbbebf799afca6d0dada9898024
-  data.tar.gz: 30b0408a04722857631927af7555a244870842fea74e3a0e170d9129cd7027a1d62e0be28dc5cf1820781870bbd1da2a08f379210bceb61cf7483d178e3d5fe5
+  metadata.gz: e28373a1d905f847cf3a621ea2531b91bd8f334cc3dbfd22844d8516d1148c8631635961ffb961661b0fb02ca844924c31562c7fa178a8e7255f0b590e679882
+  data.tar.gz: a6ac66cfa032a3ffa71bc401831895e0534fededd581278808101a532f387189629a13edf859303d64c06ced496e56e18be38ae8b1797603d386389240336d53

data/.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+
+jobs:
+  spec:
+    name: spec (${{ matrix.ruby }})
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.experimental || false }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - "3.1"
+          - "3.4"
+          - "jruby-9.4"
+          - "jruby-10.0"
+        include:
+          # Bleeding-edge runtime: exercised, but allowed to fail so a
+          # not-yet-released or in-flight toolchain never blocks a PR.
+          - ruby: "4.0"
+            experimental: true
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run specs
+        run: bundle exec rake spec

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--format documentation

data/.rubocop.yml

@@ -1,4 +1,4 @@
-require:
+plugins:
   - rubocop-rails
   - rubocop-performance
 

data/.ruby-version

@@ -1 +1 @@
-3.1.1
+3.4.8

data/README.md

@@ -1,8 +1,18 @@
-[![Dependency Status](https://gemnasium.com/mxenabled/mad_rubocop.svg)](https://gemnasium.com/mxenabled/mad_rubocop)
-
 # MadRubocop
 
-Custom RuboCop yml files to modify the cops enforced by RuboCop.
+[![CI](https://github.com/mxenabled/mad_rubocop/actions/workflows/ci.yml/badge.svg)](https://github.com/mxenabled/mad_rubocop/actions/workflows/ci.yml)
+
+Custom RuboCop yml files to modify the cops enforced by RuboCop, shared across projects.
+
+Built on RuboCop `~> 1.88`, rubocop-rails `~> 2.35`, and rubocop-performance `~> 1.26`. Requires Ruby `>= 3.1`.
+
+## What's in the box
+
+This gem ships configuration only — no Ruby code. Consumers inherit three files:
+
+- `.rubocop.yml` — the entry point. Loads the `rubocop-rails` and `rubocop-performance` plugins, inherits the two files below, and sets `AllCops` defaults (`NewCops: disable`, so cops added in a RuboCop upgrade stay off until explicitly enabled here).
+- `lib/disabled_cops.yml` — cops turned off, either as permanent house style or because the codebase isn't ready for them.
+- `lib/modified_cops.yml` — cops kept on but configured to a non-default style (e.g. `hash_rockets`, `double_quotes`, outdented access modifiers).
 
 ## Installation
 
@@ -27,15 +37,28 @@ inherit_gem:
   mad_rubocop: .rubocop.yml
 ```
 
-NOTE: The `Exlude` setting on cops that only ignore certain files or directories cannot be set by MadRubocop.
+NOTE: The `Exclude` setting on cops that only ignore certain files or directories cannot be set by MadRubocop.
 
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.
 
+Run the test suite with `bundle exec rake spec`. The specs validate the shipped configuration against the installed RuboCop — they confirm the config loads, the rubocop-rails and rubocop-performance plugins are present, and every referenced cop still exists (catching cops that a RuboCop upgrade renames or removes).
+
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Upgrading RuboCop
+
+Keeping the pinned RuboCop (and its plugins) current is the main maintenance task. The workflow:
+
+1. Bump the version constraints for `rubocop`, `rubocop-rails`, and/or `rubocop-performance` in `mad_rubocop.gemspec`.
+2. Run `bundle update rubocop rubocop-rails rubocop-performance`.
+3. Run `bundle exec rake spec`. The suite fails if the config references a cop that the new RuboCop **renamed or removed** — the failure message names the offending cop.
+4. For each failure, update the cop name in `lib/disabled_cops.yml` / `lib/modified_cops.yml` (or drop it if the cop no longer exists).
+5. Because `NewCops` is disabled, cops **added** in the upgrade are off by default. Review `rubocop --show-cops` (or the release notes) and add any you want to disable/configure.
+6. Bump `MadRubocop::VERSION` in `version.rb`, note the change, and release.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/mxenabled/mad_rubocop.

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/disabled_cops.yml

@@ -113,7 +113,7 @@ Naming/HeredocDelimiterCase:
   Enabled: false
 Naming/MemoizedInstanceVariableName:
   Enabled: false
-Naming/PredicateName:
+Naming/PredicatePrefix:
   Enabled: false
 Naming/MethodParameterName:
   Enabled: false

data/lib/mad_rubocop/version.rb

@@ -1,3 +1,3 @@
 module MadRubocop
-  VERSION = "4.1.0.rc1"
+  VERSION = "4.2.0.pre1"
 end

data/mad_rubocop.gemspec

@@ -20,11 +20,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.7.0'
+  spec.required_ruby_version = ">= 3.1"
 
-  spec.add_dependency "rubocop", "~> 1.75"
-  spec.add_dependency "rubocop-performance", "~> 1.25"
-  spec.add_dependency "rubocop-rails", "~> 2.31"
+  spec.add_dependency "rubocop", "~> 1.88.0"
+  spec.add_dependency "rubocop-performance", "~> 1.26.1"
+  spec.add_dependency "rubocop-rails", "~> 2.35.5"
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mad_rubocop
 version: !ruby/object:Gem::Version
-  version: 4.1.0.rc1
+  version: 4.2.0.pre1
 platform: ruby
 authors:
 - Zach Toolson
@@ -15,42 +15,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.75'
+        version: 1.88.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.75'
+        version: 1.88.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.25'
+        version: 1.26.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.25'
+        version: 1.26.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.31'
+        version: 2.35.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.31'
+        version: 2.35.5
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -79,6 +79,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Wrapper for MX specific RuboCop settings for managing custom settings
   across many projects.
 email:
@@ -88,7 +102,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
 - Gemfile
@@ -112,14 +128,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Wrapper for MX specific RuboCop settings. https://twitter.com/madrubocop
 test_files: []