rubocop-codeur 0.9.8 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58d07f56b8ed8f7b452e8a4f2de6cdcadf776c9b7e373d484f5c062eb668aadf
-  data.tar.gz: 1cebddf8c9999223dc1bd8c321c187dbc4c2ac84edb3983fee57657679328ed4
+  metadata.gz: 8f452c207831ca634126fc8d3ad07c9ca7b447de663c32013888e3c12645eccb
+  data.tar.gz: '081d625b417da87f75198f8b8eb8a3e731463c5f86a56614f75930621692b6c8'
 SHA512:
-  metadata.gz: 6e2608b680c0bee94bb6f79be92571dc1e8583d18a92d7a00cc8b8228e6efc4b3838f31c1e20c7bd90b53f3db9b60141d9cf88af544757e4561eb5c5045a41fe
-  data.tar.gz: 4a1c085bc5b091b3358b732dc8976d176a076e3bb5151828f3ee7020f0e7c898993d99725b46be8b0ba15677fd5ad45a4c4cbe13dd55289f29cea39a0cb97af1
+  metadata.gz: 68ac91889acf07df18f4a60b6573f63ae2ae08ec04b2b2663889e71eea76a9ec24e341a37b8c93b7d14e92a54f321f838a7cd22f59fe554ea7d4c10d03fc53da
+  data.tar.gz: b8c3ef74fd37b41bfc4fde75d451c66f615f33f77e52fcffb988d7c4b400fb8029efce5f96582f7898c5312715dce42329350313422e07e3156a445bf69b0f0c

data/default.yml

@@ -1,5 +1,7 @@
 require:
   - rubocop-capybara
+
+plugins:
   - rubocop-codeur
   - rubocop-minitest
   - rubocop-performance
@@ -7,16 +9,16 @@ require:
 
 AllCops:
   Exclude:
-    - 'db/schema.rb'
-    - 'db/*_schema.rb'
-    - 'node_modules/**/*'
-    - 'public/**/*'
-    - 'tmp/**/*'
-    - 'vendor/**/*'
-    - 'bin/*'
-    - 'test/dummy/db/schema.rb'
-    - 'test/dummy/db/*_schema.rb'
-    - 'test/dummy/tmp/**/*'
+    - "db/schema.rb"
+    - "db/*_schema.rb"
+    - "node_modules/**/*"
+    - "public/**/*"
+    - "tmp/**/*"
+    - "vendor/**/*"
+    - "bin/*"
+    - "test/dummy/db/schema.rb"
+    - "test/dummy/db/*_schema.rb"
+    - "test/dummy/tmp/**/*"
   TargetRubyVersion: 3.1
   TargetRailsVersion: 7
   NewCops: enable
@@ -177,7 +179,7 @@ Layout/LineLength:
   Max: 200
   AutoCorrect: false
   Exclude:
-    - 'db/migrate/*'
+    - "db/migrate/*"
 
 Layout/MultilineMethodCallIndentation:
   Enabled: true
@@ -191,7 +193,7 @@ Layout/ParameterAlignment:
 Lint/DuplicateMethods:
   Enabled: true
   Exclude:
-    - 'db/migrate/*'
+    - "db/migrate/*"
 
 Lint/MissingSuper:
   Enabled: false
@@ -206,21 +208,21 @@ Metrics/AbcSize:
   Enabled: true
   Max: 65
   Exclude:
-    - 'db/migrate/*'
+    - "db/migrate/*"
 
 Metrics/BlockLength:
   Enabled: true
   Max: 60
   Exclude:
-    - 'config/routes.rb'
-    - 'lib/tasks/**/*'
-    - 'app/states/*'
+    - "config/routes.rb"
+    - "lib/tasks/**/*"
+    - "app/states/*"
 
 Metrics/ClassLength:
   Enabled: true
   Max: 300
   Exclude:
-    - 'app/models/**/*'
+    - "app/models/**/*"
 
 Metrics/CyclomaticComplexity:
   Enabled: true
@@ -230,7 +232,7 @@ Metrics/MethodLength:
   Enabled: true
   Max: 60
   Exclude:
-    - 'db/migrate/*'
+    - "db/migrate/*"
 
 Metrics/ModuleLength:
   Enabled: true
@@ -266,7 +268,7 @@ Rails/BulkChangeTable:
 Rails/CreateTableWithTimestamps:
   Enabled: true
   Exclude:
-    - 'db/migrate/{2012,2013,2014,2015,2016,2017,2018}*.rb'
+    - "db/migrate/{2012,2013,2014,2015,2016,2017,2018}*.rb"
 
 Rails/EnvironmentVariableAccess:
   Enabled: true
@@ -282,7 +284,7 @@ Rails/I18nLocaleTexts:
 Rails/NotNullColumn:
   Enabled: true
   Exclude:
-    - 'db/migrate/201*.rb'
+    - "db/migrate/201*.rb"
 
 Rails/ReflectionClassName:
   Enabled: false
@@ -290,7 +292,7 @@ Rails/ReflectionClassName:
 Rails/ReversibleMigration:
   Enabled: true
   Exclude:
-    - 'db/migrate/{2012,2013,2014,2015,2016,2017,2018}*.rb'
+    - "db/migrate/{2012,2013,2014,2015,2016,2017,2018}*.rb"
 
 Rails/SaveBang:
   Enabled: false
@@ -298,13 +300,13 @@ Rails/SaveBang:
 Rails/SkipsModelValidations:
   Enabled: false
   Exclude:
-    - 'lib/tasks/**/*'
-    - 'db/migrate/*.rb'
+    - "lib/tasks/**/*"
+    - "db/migrate/*.rb"
 
 Rails/ThreeStateBooleanColumn:
   Enabled: true
   Exclude:
-    - 'db/migrate/201*.rb'
+    - "db/migrate/201*.rb"
 
 Rails/TimeZone:
   Enabled: true
@@ -380,8 +382,8 @@ Style/SymbolArray:
 Style/FormatStringToken:
   Enabled: true
   Exclude:
-    - 'config/routes.rb'
-    - 'config/routes/*'
+    - "config/routes.rb"
+    - "config/routes/*"
 
 Style/FrozenStringLiteralComment:
   SafeAutoCorrect: true

data/lib/rubocop/codeur/plugin.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+
+module RuboCop
+  module Codeur
+    # This class represents a RuboCop Codeur plugin.
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-codeur',
+          version: VERSION,
+          homepage: 'https://github.com/codeur/rubocop-codeur',
+          description: 'A collection of RuboCop cops to check design patterns.'
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        project_root = Pathname.new(__dir__).join('../../..')
+
+        LintRoller::Rules.new(type: :path, config_format: :rubocop, value: project_root.join('config', 'default.yml'))
+      end
+    end
+  end
+end

data/lib/rubocop/codeur/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Codeur
-    VERSION = '0.9.8'
+    VERSION = '0.10.0'
   end
 end

data/lib/rubocop/codeur.rb

@@ -1,17 +1,7 @@
 # frozen_string_literal: true
 
-require 'rubocop/codeur/version'
-require 'yaml'
-
 module RuboCop
   # RuboCop Codeur project namespace
   module Codeur
-    class Error < StandardError; end
-
-    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
-    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
-    CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
-
-    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
   end
 end

data/lib/rubocop/cop/codeur/rails_app_patterns.rb

@@ -44,10 +44,10 @@ module RuboCop
           return if pattern.nil?
 
           if pattern_forbidden?(pattern)
-            msg = format(MSG_FORBIDDEN, pattern: pattern)
+            msg = format(MSG_FORBIDDEN, pattern:)
           elsif pattern_not_allowed?(pattern)
             msg = format(MSG_NOT_ALLOWED,
-                         pattern: pattern,
+                         pattern:,
                          allowed_patterns: allowed_patterns.map { |p| "`#{p}`" }.join(', '))
           end
 

data/lib/rubocop-codeur.rb

@@ -4,8 +4,5 @@ require 'rubocop'
 
 require_relative 'rubocop/codeur'
 require_relative 'rubocop/codeur/version'
-require_relative 'rubocop/codeur/inject'
-
-RuboCop::Codeur::Inject.defaults!
-
+require_relative 'rubocop/codeur/plugin'
 require_relative 'rubocop/cop/codeur_cops'

metadata

@@ -1,97 +1,105 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-codeur
 version: !ruby/object:Gem::Version
-  version: 0.9.8
+  version: 0.10.0
 platform: ruby
 authors:
 - Codeur
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-17 00:00:00.000000000 Z
+date: 2025-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: lint_roller
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.25'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.25'
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.72.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.72.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rubocop-capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.17'
+        version: '2.21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.17'
+        version: '2.21'
 - !ruby/object:Gem::Dependency
   name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '0.37'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '0.37'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.9.2
+        version: '1.24'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.9.2
+        version: '1.24'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.9.1
+        version: 2.30.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.9.1
+        version: 2.30.0
 description: Shared rubocop config gem for every Ruby projects at Codeur SARL
 email:
 - dev@codeur.com
@@ -103,28 +111,22 @@ files:
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
-- README.md
 - Rakefile
-- bin/console
-- bin/rake
-- bin/setup
 - config/default.yml
 - default.yml
 - lib/rubocop-codeur.rb
 - lib/rubocop/codeur.rb
-- lib/rubocop/codeur/inject.rb
+- lib/rubocop/codeur/plugin.rb
 - lib/rubocop/codeur/version.rb
 - lib/rubocop/cop/codeur/rails_app_patterns.rb
 - lib/rubocop/cop/codeur/rails_avoid_instance_methods_in_helpers.rb
 - lib/rubocop/cop/codeur_cops.rb
-- rubocop-codeur.gemspec
 homepage: https://github.com/codeur/rubocop-codeur
 licenses:
 - MIT
-metadata: {}
+metadata:
+  default_lint_roller_plugin: RuboCop::Codeur::Plugin
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -140,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Codeur rubocop config gem

data/Gemfile

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-git_source(:github) { |repo| "https://github.com/#{repo}.git" }
-
-# Specify your gem's dependencies in rubocop-codeur.gemspec
-gemspec
-
-gem 'minitest', '~> 5.16'
-gem 'rake', '~> 13.0'
-gem 'simplecov', require: false

data/Gemfile.lock

@@ -1,96 +0,0 @@
-PATH
-  remote: .
-  specs:
-    rubocop-codeur (0.9.8)
-      rubocop (~> 1.25)
-      rubocop-capybara (~> 2.17)
-      rubocop-minitest (~> 0.20)
-      rubocop-performance (~> 1.9, >= 1.9.2)
-      rubocop-rails (~> 2.9, >= 2.9.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (7.1.3.4)
-      base64
-      bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      connection_pool (>= 2.2.5)
-      drb
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
-    ast (2.4.2)
-    base64 (0.2.0)
-    bigdecimal (3.1.8)
-    concurrent-ruby (1.3.3)
-    connection_pool (2.4.1)
-    docile (1.4.0)
-    drb (2.2.1)
-    i18n (1.14.5)
-      concurrent-ruby (~> 1.0)
-    json (2.7.2)
-    language_server-protocol (3.17.0.3)
-    minitest (5.23.1)
-    mutex_m (0.2.0)
-    parallel (1.25.1)
-    parser (3.3.3.0)
-      ast (~> 2.4.1)
-      racc
-    racc (1.8.0)
-    rack (3.1.3)
-    rainbow (3.1.1)
-    rake (13.2.1)
-    regexp_parser (2.9.2)
-    rexml (3.3.0)
-      strscan
-    rubocop (1.64.1)
-      json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
-      parallel (~> 1.10)
-      parser (>= 3.3.0.2)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.3)
-      parser (>= 3.3.1.0)
-    rubocop-capybara (2.21.0)
-      rubocop (~> 1.41)
-    rubocop-minitest (0.35.0)
-      rubocop (>= 1.61, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-performance (1.21.1)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rails (2.25.0)
-      activesupport (>= 4.2.0)
-      rack (>= 1.1)
-      rubocop (>= 1.33.0, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-    ruby-progressbar (1.13.0)
-    simplecov (0.22.0)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.4)
-    strscan (3.1.0)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.5.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  minitest (~> 5.16)
-  rake (~> 13.0)
-  rubocop-codeur!
-  simplecov
-
-BUNDLED WITH
-   2.3.26

data/README.md

@@ -1,84 +0,0 @@
-# RuboCop Codeur
-Shared rubocop config gem for every Ruby projects at Codeur SARL
-
-## Installation
-Add this lines to your application's Gemfile:
-```ruby
-group :development do
-  gem 'rubocop-codeur'
-end
-```
-
-Or, for a Ruby library, add this to your gemspec:
-```ruby
-spec.add_development_dependency 'rubocop-codeur'
-```
-## Usage
-Create a `.rubocop.yml` with the following directives:
-```yml
-inherit_gem:
-  rubocop-codeur:
-    - default.yml
-```
-
-Then run:
-`bundle exec rubocop`
-
-You don't  need to include rubocop directly in your application's dependencies.
-`rubocop-codeur` will include `rubocop`, `rubocop-minitest`, `rubocop-performance`,
-and `rubocop-rails` dependencies.
-
-It might be necessary to override style rules set in this gem for some projects
-or to add specific ones. Rule inheritance provided by RuboCop works like the
-following:
-`inherit_gem → inherit_from → local rules`
-
-For example:
-```yml
-inherit_gem:
-  rubocop-codeur:
-    - default.yml
-
-inherit_from: .some_rubocop_config_file.yml
-
-AllCops:
-  Exclude:
-    - path/to/exluded/file.rb
-```
-
-Note that those overriding should be avoided as much as possible.
-
-## Testing
-
-Run:
-```bash
-bin/rake test
-```
-or simply:
-```bash
-bin/rake
-```
-
-## Release
-Before all, configure your credentials for RubyGems :
-
- 1. Login to RubyGems
- 2. Create a token which have rights to push gems (https://rubygems.org/profile/api_keys)
- 3. Add it to your config:
-   ```
-   echo ":rubygems_api_key: YOUR_API_KEY" >> ~/.gem/credentials
-   ```
-
-You just have to run default command:
-```
-rake release
-```
-
-Else, to publish a new version of this gem, you'll need to build it with
-`gem build rubocop-codeur.gemspec` and then push it manually:
-```
-gem push rubocop-codeur-X.X.X.gem
-```
-
-## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). Copyright 2021 Codeur SARL.

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'rubocop/codeur'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/rake

@@ -1,29 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-#
-# This file was generated by Bundler.
-#
-# The application 'rake' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
-                                           Pathname.new(__FILE__).realpath)
-
-bundle_binstub = File.expand_path('bundle', __dir__)
-
-if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
-    load(bundle_binstub)
-  else
-    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
-Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
-  end
-end
-
-require 'rubygems'
-require 'bundler/setup'
-
-load Gem.bin_path('rake', 'rake')

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/rubocop/codeur/inject.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-# The original code is from https://github.com/rubocop/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
-# See https://github.com/rubocop/rubocop-rspec/blob/master/MIT-LICENSE.md
-module RuboCop
-  module Codeur
-    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
-    # bit of our configuration.
-    module Inject
-      def self.defaults!
-        path = CONFIG_DEFAULT.to_s
-        hash = ConfigLoader.send(:load_yaml_configuration, path)
-        config = Config.new(hash, path).tap(&:make_excludes_absolute)
-        puts "configuration from #{path}" if ConfigLoader.debug?
-        config = ConfigLoader.merge_with_default(config, path)
-        ConfigLoader.instance_variable_set(:@default_configuration, config)
-      end
-    end
-  end
-end

data/rubocop-codeur.gemspec

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/rubocop/codeur/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'rubocop-codeur'
-  spec.version       = RuboCop::Codeur::VERSION
-  spec.authors       = ['Codeur']
-  spec.email         = ['dev@codeur.com']
-
-  spec.summary       = 'Codeur rubocop config gem'
-  spec.description   = 'Shared rubocop config gem for every Ruby projects at Codeur SARL'
-  spec.homepage      = 'https://github.com/codeur/rubocop-codeur'
-  spec.license       = 'MIT'
-  spec.required_ruby_version = '>= 3.1'
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-
-  spec.add_dependency 'rubocop', '~> 1.25'
-  spec.add_dependency 'rubocop-capybara', '~> 2.17'
-  spec.add_dependency 'rubocop-minitest', '~> 0.20'
-  spec.add_dependency 'rubocop-performance', '~> 1.9', '>= 1.9.2'
-  spec.add_dependency 'rubocop-rails', '~> 2.9', '>= 2.9.1'
-end