rubocop-dbl 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33d84cbb963636c197eb383d365027dd6bef5f7f3fbc0ad8ba2bb0e3309b07a1
-  data.tar.gz: 4ddd2edba86d33828d36893e96e6d4a56eaff68aac4c855bca1be0dfa6546e4d
+  metadata.gz: 1b5856effa41bb2d7e4dde8aefb6f9944b84801e9683a8fd8383e446ae293a5a
+  data.tar.gz: cf576d04a8975fb239afcaf06d63a9138de9bf32916acb8bb9eb32be7d704e49
 SHA512:
-  metadata.gz: 6274efeff7d90d4c95687018d3789046c439c3ffed2bf589f1f87832358aa116bafb7c60778eebc09d749ee9a6c1426c00ccf686b7457d377ae8ff1653a56cbd
-  data.tar.gz: e93a63b62e52407033324b44ea29847dbb66b7eaae092ec5c982309abe640a95685c05677221ff2cc0dcf9df2a16937610c8c64e08b8ec9646f5b0abf8a2e8c9
+  metadata.gz: 44ae420c179b0be16109a50b0b45b5ea7c9561c10e5a7e3650628cc815613a65410329f621e47f57f94cb5dc8dd0cd03d3390a8a5ab97bd9a7ac40918f2afc73
+  data.tar.gz: 44d1c398449529e67d03c0fe1c9752a58207e84e91de19e8b5f561eb65d1da8876584a7551e2278aae8136a8d591c8810ae119f72c48469d685da5c1c4fdf16b

data/README.md

@@ -6,41 +6,25 @@ 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:
-
-```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).
+## Setup
 
+run
 
-## Usage
+```shell
+rails generate rubocop_dbl:install
+```
 
-Add this line to your application's `.rubocop.yml`:
+or manually Aad this line to your application's `.rubocop.yml`:
 
 ```yml
 inherit_gem:
@@ -48,28 +32,16 @@ inherit_gem:
     - config/dbl.yml
 ```
 
-Or just run:
-
-```shell
-rails generate rubocop_dbl:install
-```
-
-
-
 ## 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 +60,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/layout.yml

@@ -7,7 +7,6 @@
 # For example:
 #
 #     Layout/EndAlignment:
-#       Reference: 'https://github.com/dbl-works/rubocop-dbl/pull/35'
 #       Enabled: true
 #
 
@@ -15,14 +14,12 @@
 # assignments, where it should be aligned with the LHS.
 # @NOTE: changed EnforcedStyleAlignWith from "keyword" to "variable"
 Layout/EndAlignment:
-  Reference: 'we have no reference for this change'
   Enabled: true
   EnforcedStyleAlignWith: variable
   AutoCorrect: true
 
 # @NOTE: changed EnforcedStyle from "with_first_parameter" to "with_fixed_indentation"
 Layout/ParameterAlignment:
-  Reference: 'we have no reference for this change'
   EnforcedStyle: with_fixed_indentation
   SupportedStyles:
     - with_first_parameter

data/config/cops/lint.yml

@@ -7,7 +7,6 @@
 # For example:
 #
 #     Lint/AmbiguousOperator:
-#       Reference: 'https://github.com/dbl-works/rubocop-dbl/pull/36'
 #       Enabled: true
 #
 
@@ -15,33 +14,25 @@
 # @NOTE: the following cops are on "pending" by default
 #
 Lint/DuplicateBranch:
-  Reference: 'we have no reference for this change'
   Enabled: true
 
 Lint/DuplicateRegexpCharacterClassElement:
-  Reference: 'we have no reference for this change'
   Enabled: true
 
 Lint/EmptyBlock:
-  Reference: 'we have no reference for this change'
   Enabled: true
 
 Lint/EmptyClass:
-  Reference: 'we have no reference for this change'
   Enabled: true
 
 Lint/NoReturnInBeginEndBlocks:
-  Reference: 'we have no reference for this change'
   Enabled: true
 
 Lint/ToEnumArguments:
-  Reference: 'we have no reference for this change'
   Enabled: true
 
 Lint/UnexpectedBlockArity:
-  Reference: 'we have no reference for this change'
   Enabled: true
 
 Lint/UnmodifiedReduceAccumulator:
-  Reference: 'we have no reference for this change'
   Enabled: true

data/config/cops/metrics.yml

@@ -7,15 +7,20 @@
 # For example:
 #
 #     Metrics/BlockLength:
-#       Reference: 'https://github.com/dbl-works/rubocop-dbl/pull/37'
 #       Enabled: true
 #
 
 # @NOTE: IgnoredMethods by default only contains "refine"
 Metrics/BlockLength:
-  Reference: 'we have no reference for this change'
-  IgnoredMethods:
+  Exclude:
     - describe
     - context
     - feature
     - scenario
+
+Metrics/MethodLength:
+  Max: 30
+  CountAsOne:
+    - array
+    - heredoc
+    - method_call

data/config/cops/naming.yml

@@ -7,11 +7,10 @@
 # For example:
 #
 #     Naming/VariableNumber:
-#       Reference: 'https://github.com/dbl-works/rubocop-dbl/pull/38'
 #       Enabled: true
 #
 
 # @NOTE: changed EnforcedStyle from "normalcase" to "snake_case"
+# https://github.com/dbl-works/rubocop-dbl/pull/26
 Naming/VariableNumber:
-  Reference: 'https://github.com/dbl-works/rubocop-dbl/pull/26'
   EnforcedStyle: snake_case

data/config/cops/performance.yml

@@ -7,6 +7,5 @@
 # For example:
 #
 #     Performance/AncestorsInclude:
-#       Reference: 'https://github.com/dbl-works/rubocop-dbl/pull/31'
 #       Enabled: true
 #

data/config/cops/rails.yml

@@ -7,7 +7,6 @@
 # For example:
 #
 #     Rails/ActionFilter:
-#       Reference: 'https://github.com/dbl-works/rubocop-dbl/pull/33'
 #       Enabled: false
 #
 
@@ -21,12 +20,10 @@ Rails/UnknownEnv:
 
 # @NOTE: disabled
 Rails/HttpStatus:
-  Reference: 'We have no reference for this change'
   Enabled: false
 
 # @NOTE: disabled
 Rails/ApplicationController:
-  Reference: 'We have no reference for this change'
   Enabled: false
 
 
@@ -34,70 +31,53 @@ Rails/ApplicationController:
 # @NOTE: all the cops ahead are "pending" in the current default config
 #
 Rails/ActiveRecordCallbacksOrder:
-  Reference: 'We have no reference for this change'
   Enabled: true
 
 Rails/AfterCommitOverride:
-  Reference: 'We have no reference for this change'
   Enabled: true
 
 Rails/AttributeDefaultBlockValue:
-  Reference: 'We have no reference for this change'
   Enabled: true
 
 Rails/FindById:
-  Reference: 'We have no reference for this change'
   Enabled: true
 
 Rails/Inquiry:
-  Reference: 'We have no reference for this change'
   Enabled: true
 
 Rails/MailerName:
-  Reference: 'We have no reference for this change'
   Enabled: true
 
 Rails/MatchRoute:
-  Reference: 'We have no reference for this change'
   Enabled: true
 
 Rails/NegateInclude:
-  Reference: 'We have no reference for this change'
   Enabled: true
 
 Rails/Pluck:
-  Reference: 'We have no reference for this change'
   Enabled: true
 
 Rails/PluckInWhere:
-  Reference: 'We have no reference for this change'
   Enabled: true
 
 Rails/RenderInline:
-  Reference: 'We have no reference for this change'
   Enabled: true
 
 Rails/RenderPlainText:
-  Reference: 'We have no reference for this change'
   Enabled: true
 
 Rails/ShortI18n:
-  Reference: 'We have no reference for this change'
   Enabled: true
   EnforcedStyle: aggressive
 
 Rails/SquishedSQLHeredocs:
-  Reference: 'We have no reference for this change'
   Enabled: true
 
 Rails/WhereEquals:
-  Reference: 'We have no reference for this change'
   Enabled: true
 
 Rails/WhereExists:
-  Reference: 'We have no reference for this change'
   Enabled: true
 
 Rails/WhereNot:
-  Reference: 'We have no reference for this change'
   Enabled: true

data/config/cops/rspec.yml

@@ -7,14 +7,12 @@
 # For example:
 #
 #     RSpec/AlignLeftLetBrace:
-#       Reference: 'https://github.com/dbl-works/rubocop-dbl/pull/32'
 #       Enabled: true
 #
 
 
 # @NOTE: added: "if", "and"
 RSpec/ContextWording:
-  Reference: 'https://github.com/dbl-works/rubocop-dbl/pull/25'
   Prefixes:
     - when
     - with
@@ -25,18 +23,15 @@ RSpec/ContextWording:
 
 # @NOTE: by default, no methods are enabled
 RSpec/Capybara/FeatureMethods:
-  Reference: 'https://github.com/dbl-works/rubocop-dbl/pull/25'
   EnabledMethods:
     - feature
     - scenario
 
 # @NOTE: increased from 3 to 5
 RSpec/NestedGroups:
-  Reference: 'https://github.com/dbl-works/rubocop-dbl/pull/25'
   Max: 5
 
 
 # @NOTE: increased from 5 to 6
 RSpec/MultipleMemoizedHelpers:
-  Reference: 'https://github.com/dbl-works/rubocop-dbl/pull/25'
   Max: 6

data/config/cops/style.yml

@@ -7,23 +7,19 @@
 # For example:
 #
 #     Style/AndOr:
-#       Reference: 'https://github.com/dbl-works/rubocop-dbl/pull/34'
 #       Enabled: true
 #
 
 # @NOTE: changed from "always" to "never"
 Style/FrozenStringLiteralComment:
-  Reference: 'we have no reference for this change'
   EnforcedStyle: never
 
 # enforces to use 'name'.to_sym over 'name'.intern and so on
 Style/StringMethods:
-  Reference: 'we have no reference for this change'
   Enabled: true
 
 # @NOTE: changed from "compact" to "expanded"
 Style/EmptyMethod:
-  Reference: 'we have no reference for this change'
   EnforcedStyle: expanded
   SupportedStyles:
     - compact
@@ -31,66 +27,52 @@ Style/EmptyMethod:
 
 # @NOTE: allowed AllowMultipleReturnValues
 Style/RedundantReturn:
-  Reference: 'we have no reference for this change'
   Enabled: true
   AllowMultipleReturnValues: true
 
 # @NOTE: allowed AllowAsExpressionSeparator
 Style/Semicolon:
-  Reference: 'we have no reference for this change'
   Enabled: true
   AllowAsExpressionSeparator: true
 
 Style/CollectionMethods:
-  Reference: 'we have no reference for this change'
   Enabled: true
 
 Style/Documentation:
-  Reference: 'we have no reference for this change'
   Enabled: false
 
 # @NOTE: changed EnforcedStyleForMultiline from "no_comma" to "comma"
 Style/TrailingCommaInArguments:
-  Reference: 'https://github.com/dbl-works/rubocop-dbl/pull/27'
   EnforcedStyleForMultiline: comma
 
 # @NOTE: changed EnforcedStyleForMultiline from "no_comma" to "comma"
 Style/TrailingCommaInArrayLiteral:
-  Reference: 'https://github.com/dbl-works/rubocop-dbl/pull/24'
   EnforcedStyleForMultiline: comma
 
 # @NOTE: changed EnforcedStyleForMultiline from "no_comma" to "comma"
 Style/TrailingCommaInHashLiteral:
-  Reference: 'https://github.com/dbl-works/rubocop-dbl/pull/24'
   EnforcedStyleForMultiline: comma
 
 #
 # @NOTE: the following cops are "pending" by default
 #
 Style/ArgumentsForwarding:
-  Reference: 'we have no reference for this change'
   Enabled: false
 
 Style/CollectionCompact:
-  Reference: 'we have no reference for this change'
   Enabled: true
 
 Style/DocumentDynamicEvalDefinition:
-  Reference: 'we have no reference for this change'
   Enabled: true
 
 Style/NegatedIfElseCondition:
-  Reference: 'we have no reference for this change'
   Enabled: true
 
 Style/NilLambda:
-  Reference: 'we have no reference for this change'
   Enabled: true
 
 Style/RedundantArgument:
-  Reference: 'we have no reference for this change'
   Enabled: true
 
 Style/SwapValues:
-  Reference: 'we have no reference for this change'
   Enabled: true

data/config/cops/types.yml

@@ -7,7 +7,6 @@
 # For example:
 #
 #     Style/AndOr:
-#       Reference: 'https://github.com/dbl-works/rubocop-dbl/pull/34'
 #       Enabled: true
 #
 

data/lib/generators/rubocop_dbl/install_generator.rb

@@ -2,6 +2,7 @@
 
 require 'rails/generators/base'
 require 'active_support/core_ext/string'
+require 'railties'
 
 module RubocopDbl
   module Generators

data/lib/rubocop_dbl/version.rb

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

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-dbl
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - 'Team DBL :rocket:'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-30 00:00:00.000000000 Z
+date: 2023-06-26 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: railties
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -162,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.13
 signing_key:
 specification_version: 4
 summary: RuboCop configuration for our Ruby on Rails projects