rubocop-dbl 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8558583841f690643ee75e260ac5de01bf09326f20608c4005ec4ed285ef1b23
-  data.tar.gz: 9fb41eca523ec7a0afe85d5c9ecf4b4a95390004dbc7188da76a24a55b5e6344
+  metadata.gz: f8fe3d4a4f7e6815e04cb657a97fbac59d0a376bec3b02f3935f5932f42f6b38
+  data.tar.gz: 2cfc77717d8b79375e569d0dce3743505eebde4ef449bdc42ec1e2309111c0e4
 SHA512:
-  metadata.gz: 5249980d5ca07dee5e08b47ecf003d7a22c9c816c468d9571db7d77094b529fbb65fef426dcafb89ada6c2625bdd55e010c7f911fd4eaea4a7df8a03a4ee6c60
-  data.tar.gz: e91569daf478e8a1351d107836af01f79e65e2c3fc48a94db41c16efe4f9e4f7f17638da2f289e33c5228678a62f159519d425125a3b5c8a18e6a5e77ed1861e
+  metadata.gz: 684c2c5dc56489b9c645c0806169a1b0721c8734fe092748f5b3a68e4a340d08004e544dd34fdeaf4b8fedf6a47d06235b87f29fca160646c7c499d47a610fea
+  data.tar.gz: 13db56ad3a82a228a1ac8e7024975552df2942b8721fdd0a7087f626483189d5a639bf90f04ec1ee6d6ae89c909c911c8faf3d919276b1c50774ddea001ffc4d

data/README.md

@@ -6,70 +6,56 @@ RuboCop configuration for our Ruby on Rails projects.
 
 [Official RoR RuboCop Configuration](https://github.com/rails/rails/blob/master/.rubocop.yml).
 
-Releases are published to [GitHub's Package Service](https://github.com/dbl-works/rubocop-dbl/packages/550489).
-
+Releases are published to [RubyGems](https://rubygems.org/gems/rubocop-dbl).
 
 ## Installation
 
-Install from command line:
-
-```shell
-gem install rubocop-dbl --version "0.2.0" --source "https://rubygems.pkg.github.com/dbl-works"
-```
-
-install via Gemfile:
-
-DO NOT DO THIS:
 ```ruby
 group :development, :test do
-  gem "rubocop-dbl", "~> 0.2.0", source: "https://rubygems.pkg.github.com/dbl-works"
+  gem 'rubocop-dbl'
 end
 ```
 
-INSTEAD:
+## Setup
 
-```ruby
-# Gemfile
-group :development, :test do
-  gem 'rubocop-dbl', git: 'git@github.com:dbl-works/rubocop-dbl', branch: :main
-end
-```
-WHY: we cannot install a public (!!) package from GitHub packages without a PAT (personal access token), see this [thread](https://github.community/t/download-from-github-package-registry-without-authentication/14407).
-E.g. CircleCI does not allow reading a ENV var within the ci.yml, hence it is impossible to configure bundle to have auth for GitHub packages (this might work using GitHub actions).
+run
 
+```shell
+rails generate rubocop_dbl:install
+```
 
-## Usage
+or manually Aad this line to your application's `.rubocop.yml`:
 
-Add this line to your application's `.rubocop.yml`:
+When using Rails:
 
 ```yml
+require:
+  - rubocop-rails
+
 inherit_gem:
   rubocop-dbl:
     - config/dbl.yml
+    - config/cops/rails.yml
 ```
 
-Or just run:
+When not using Rails:
 
-```shell
-rails generate rubocop_dbl:install
+```yml
+inherit_gem:
+  rubocop-dbl:
+    - config/dbl.yml
 ```
 
-
-
 ## Configuration
 
-
 ### TargetRubyVersion
 
 We only support the latest 2 versions of ruby, which is currently >= 2.7.
 We only support the latest 2 versions of rails, which is currently >= 6.0.
 See [test.yml](.github/workflows/test.yml) for details.
 
-
 If you'd like to change `TargetRubyVersion`, see [Customization](#customization).
 
-
-
 ## Customization
 
 If you'd like to customize the rubocop setting on your project, you can override it.
@@ -88,42 +74,16 @@ AllCops:
 ```
 
 ## Build & install gem locally
-```shell
-gem build rubocop-dbl.gemspec
-gem install rubocop-dbl-0.1.0.gem
-irb
-```
-
-## Publish as package on GitHub packages
-* create a valid PAT (personal access token) for your GitHub user with full access to packages (read & write) and private repos (read), read the [docs](https://docs.github.com/en/free-pro-team@latest/packages/guides/configuring-rubygems-for-use-with-github-packages) for more details
-* add following information to `~/.gemrc`:
-
-```
----
-:github: YOUR_PAT
-:backtrace: false
-:bulk_threshold: 1000
-:sources:
-- https://rubygems.org/
-- https://rubygems.pkg.github.com
-:update_sources: true
-:verbose: true
-:concurrent_downloads: 8
-gem: "--document=yri"
-
-```
-
-* build the latest version of the gem locally with
 
 ```shell
 gem build rubocop-dbl.gemspec
+gem install rubocop-dbl-0.1.0.gem
 ```
-take note of the most current version of the gem, which will be printed to console.
 
-* publish the gem as follows
+## Publish on RubyGems
 
 ```shell
-gem push --key github --host https://"$YOUR_GITHUB_USER_NAME":"$YOUR_PAT"@rubygems.pkg.github.com/dbl-works rubocop-dbl-"$CURRENT_GEM_VERSION".gem
+bin/release
 ```
 
-replacing `YOUR_GITHUB_USER_NAME`, `YOUR_PAT`, `CURRENT_GEM_VERSION` with the appropriate values.
+will guide you through the process.

data/config/cops/metrics.yml

@@ -17,3 +17,10 @@ Metrics/BlockLength:
     - context
     - feature
     - scenario
+
+Metrics/MethodLength:
+  Max: 30
+  CountAsOne:
+    - array
+    - heredoc
+    - method_call

data/config/dbl.yml

@@ -1,7 +1,6 @@
 require:
   - rubocop-packaging
   - rubocop-performance
-  - rubocop-rails
   - rubocop-rspec
   - rubocop-sorbet
 
@@ -12,7 +11,6 @@ inherit_from:
   - cops/metrics.yml
   - cops/naming.yml
   - cops/performance.yml
-  - cops/rails.yml
   - cops/rspec.yml
   - cops/style.yml
   - cops/types.yml
@@ -22,7 +20,7 @@ inherit_from:
 # see: https://docs.rubocop.org/rubocop/usage/caching.html
 AllCops:
   UseCache: true
-  TargetRubyVersion: 2.7.2
+  TargetRubyVersion: 3.1.4
   NewCops: enable
   Exclude:
     - '**/tmp/**/*'

data/lib/generators/rubocop_dbl/install_generator.rb

@@ -1,13 +1,12 @@
 # typed: false
 
 require 'rails/generators/base'
-require 'active_support/core_ext/string'
 require 'railties'
 
 module RubocopDbl
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      desc 'Creates a .rubocop.yml config file that inherits from the official Ruby on Rails .rubocop.yml.'
+      desc 'Creates a .rubocop.yml config file that inherits from the various rubocop gems (Rails optional).'
 
       def create_config_file
         file_method = config_file_exists? ? :prepend : :create
@@ -25,11 +24,24 @@ module RubocopDbl
       end
 
       def config_file_content
-        <<~HEREDOC
-          inherit_gem:
-            rubocop-dbl:
+        if defined?(Rails)
+          <<~HEREDOC
+            require:
+              - rubocop-rails
+
+            inherit_gem:
+              rubocop-dbl:
+                - config/dbl.yml
+                - config/cops/rails.yml
+          HEREDOC
+        else
+          <<~HEREDOC
+
+            inherit_gem:
+              rubocop-dbl:
               - config/dbl.yml
-        HEREDOC
+          HEREDOC
+        end
       end
     end
   end

data/lib/rubocop_dbl/version.rb

@@ -1,5 +1,5 @@
 # typed: false
 
 module RubocopDbl
-  VERSION = '1.1.0'.freeze
+  VERSION = '2.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-dbl
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - 'Team DBL :rocket:'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-04 00:00:00.000000000 Z
+date: 2023-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -141,14 +127,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: RuboCop configuration for our Ruby on Rails projects