gemwork 0.7.19 → 0.7.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbc5491e286cd012bfc6af3218a975ab71c2fdf9c5d48e1cc11629e7f0df3fd7
-  data.tar.gz: 5221fbf8bcb678c7415c52b07eb52772ef9c147e745709007ca46448ccc8b864
+  metadata.gz: 9b5a2126cb36e2888966c286fb921ba2ce7d58c219846e0f7110f0fb19147463
+  data.tar.gz: 450f4d526499f10d177576e83217f58190b6866576623b09a97089c82f906fb1
 SHA512:
-  metadata.gz: 64e5a84ea52820dab69533c4572cc0c8d862708ab3595a6d5e718e7d8033ff7cee6e3e133e58750872ce05fce09c7dc1d3a72389994fea4d7fd5fd684330972d
-  data.tar.gz: ddd21dc01acd9d609846c55b894c0c237026159b93dbc1f15e040493f143d9d0a45d911d63bb11fc31f0f9a3320ffa6b2eaac0394ecf8ef90fbe5ef58bf9fd6a
+  metadata.gz: bd056e7cb7a911da9a56fbbc2cc7327a79f2210c9f63dfaede37072d718761560b1b17ac5517651630a15b060ac7365de47a60493c6b90ad5aea4768d574a325
+  data.tar.gz: 29face0701ef9cccc049958853e8bcf6be4f744845be33227c05975f46d7ee15207f45422105dfb75270f10f72efd1d99199e863e57cd072988bdd818fa828d2

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.7.21] - 2025-10-12
+
+- Exclude BaseControllers from Rails/ApplicationController
+- Remove `EnabledByDefault` from all_cops-rails.yml
+
+## [0.7.20] - 2025-10-11
+
+- Mass-Update Rubocop styles to match latest conventions from my professional projects
+
 ## [0.7.19] - 2025-7-5
 
 - Update Rubocop styles re: multi-line method definitions/calls.
@@ -35,6 +44,7 @@
 - Fix `brakeman` task to not report on filtered warnings (i.e. ignored warnings)
 
 ## [0.7.11] - 2025-2-15
+
 (0.7.10 yanked)
 
 - Minimize `rake brakeman` output when no warnings; return failure otherwise

data/lib/gemwork/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module Gemwork
-  VERSION = "0.7.19"
+  VERSION = "0.7.22"
+  public_constant :VERSION
 end

data/lib/rubocop/.rubocop-rails.yml

@@ -8,6 +8,7 @@ inherit_from:
   - ./metrics-rails.yml
   - ./minitest.yml
   - ./naming.yml
+  - ./naming-rails.yml
   - ./performance.yml
   - ./rails.yml
   - ./style.yml

data/lib/rubocop/all_cops-rails.yml

@@ -1,7 +1,6 @@
 AllCops:
   ActiveSupportExtensionsEnabled: true
   DisplayStyleGuide: true
-  EnabledByDefault: true
   ExtraDetails: true
   NewCops: enable
   UseCache: true

data/lib/rubocop/all_cops.yml

@@ -1,6 +1,5 @@
 AllCops:
   DisplayStyleGuide: true
-  EnabledByDefault: true
   ExtraDetails: true
   NewCops: enable
   UseCache: true

data/lib/rubocop/bundler.yml

@@ -1,7 +1,12 @@
 Bundler/GemComment:
+  # When limiting a gem version or restricing to a GitHub commit-ish, it's
+  # helpful to say why (inline) so deciding on upgradability later is easier.
   OnlyFor:
     - restrictive_version_specifiers
     - github
 
 Bundler/GemVersion:
+  # Don't require specifying a gem version. Prefer to optimize for
+  # upgradeability, so we don't become stale.
+  # Don't forbid specifying a gem version, either, as it's sometimes necessary.
   Enabled: false

data/lib/rubocop/layout-rails.yml

@@ -1,4 +1,76 @@
+Layout/ClassStructure:
+  # Establish a convention for code order within classes.
+  Enabled: true
+  AutoCorrect: false
+  Categories:
+    module_inclusion:
+      - extend
+      - include
+      - prepend
+    callbacks:
+      - before_validation
+      - after_validation
+      - before_save
+      - around_save
+      - before_create
+      - around_create
+      - after_create
+      - before_update
+      - around_update
+      - after_update
+      - after_save
+      - before_destroy
+      - around_destroy
+      - after_destroy
+      - after_commit
+      - after_rollback
+      - after_initialize
+      - after_find
+    public_attribute_macros:
+      - attr_accessor
+      - attr_reader
+      - attr_writer
+      - serialize
+    associations:
+      - belongs_to
+      - has_one
+      - has_many
+      - has_and_belongs_to_many
+      - accepts_nested_attributes_for
+    validations:
+      - validates
+      - validates_associated
+      - validates_with
+      - validates_each
+    scopes:
+      - scope
+    concerning_blocks:
+      - concerning
+  ExpectedOrder:
+    - constants
+    - module_inclusion
+    - callbacks
+    - associations
+    - validations
+    - public_delegate
+    - scopes
+    - public_class_methods
+    # - public_attribute_macros
+    - initializer
+    - public_methods
+    - protected_attribute_macros
+    - protected_methods
+    - private_attribute_macros
+    - private_delegate
+    - private_methods
+    - concerning_blocks
+
 Layout/FirstMethodArgumentLineBreak:
+  # Require line break before the first argument in a multi-line method call.
+  # Example:
+  #   my_method(
+  #     a: 1,
+  #     # ...
   Enabled: true
   AllowMultilineFinalElement: true
   AllowedMethods:
@@ -6,11 +78,19 @@ Layout/FirstMethodArgumentLineBreak:
     - safe_join
 
 Layout/LineLength:
+  # Max 80 chars. See: https://rubystyle.guide/#max-line-length
   Exclude:
     - Gemfile
     - config/environments/*.rb
+    - config/routes.rb
     - db/seeds.rb
 
 Layout/MultilineArrayLineBreaks:
+  # Require each item in a multi-line Array to start on a separate line.
+  # Example:
+  #   [
+  #     # ...
+  #     c
+  #   ]
   Exclude:
     - db/seeds.rb

data/lib/rubocop/layout.yml

@@ -1,67 +1,132 @@
 Layout/ClassStructure:
-  Enabled: false # Consider implementing on a per-project basis.
+  # Establish a convention for code order within classes.
+  Enabled: true
+  AutoCorrect: false
+  Categories:
+    module_inclusion:
+      - extend
+      - include
+      - prepend
+    concerning_blocks:
+      - concerning
+  ExpectedOrder:
+    - constants
+    - module_inclusion
+    - public_delegate
+    - public_class_methods
+    # - public_attribute_macros
+    - initializer
+    - public_methods
+    - protected_attribute_macros
+    - protected_methods
+    - private_attribute_macros
+    - private_methods
+    - concerning_blocks
 
 Layout/DotPosition:
+  # Prefer leading dots for multi-line method chaining. This improves
+  # grep-ability of calls to a specific method as it removes variability.
+  #   # Good
+  #   my_method
+  #     .my_other_method # 👀 Can still reliably grep on `.my_other_method`
   EnforcedStyle: leading
 
-Layout/EmptyLineAfterGuardClause:
-  Enabled: true
-
-Layout/EmptyLineAfterMultilineCondition:
-  Enabled: false
-
 Layout/EndOfLine:
+  # Require unix-style line endings.
   EnforcedStyle: lf
 
-Layout/FirstArgumentIndentation:
-  EnforcedStyle: consistent_relative_to_receiver
-
 Layout/FirstArrayElementIndentation:
+  # Treat Arrays in multi-line method calls the same as multi-line Arrays.
+  #   and_in_a_method_call([
+  #     :no_difference
+  #   ])
   EnforcedStyle: consistent
 
 Layout/FirstArrayElementLineBreak:
+  # Example:
+  #   [
+  #     :a, # ...
   Enabled: true
 
 Layout/FirstHashElementIndentation:
+  # Treat Hash in method call the same as multi-line Arrays.
+  # Example:
+  #   hash = {
+  #     key: :value
+  #   }
+  #   and_in_a_method_call({
+  #     no: :difference
+  #   })
   EnforcedStyle: consistent
 
 Layout/FirstHashElementLineBreak:
+  # Example:
+  #   {
+  #     a: 1, # ...
   Enabled: true
 
 Layout/FirstMethodArgumentLineBreak:
+  # Require line break before the first argument in a multi-line method call.
+  # Example:
+  #   my_method(
+  #     a: 1,
+  #     # ...
   Enabled: true
+  # Example:
+  #   my_method(a: 1, {
+  #     b: 2,
+  #     # ...
+  #   })
   AllowMultilineFinalElement: true
 
 Layout/FirstMethodParameterLineBreak:
+  # Require a line break before the first parameter in a multi-line method
+  # parameter definition.
+  # Example:
+  #   my_method(
+  #     foo,
+  #     # ...
+  #   )
   Enabled: true
+  # Example:
+  #   my_method(foo, bar = {
+  #     a: 1,
+  #     # ...
+  #   })
+  AllowMultilineFinalElement: true
 
 Layout/FirstParameterIndentation:
   # The first parameter should always be indented one step more than the
   # preceding line. e.g.
   #   def my_method(
-  #     my_arg1 # <- 👀EnforcedStyleForMultiline
+  #     my_arg1
   #   )
   Enabled: true
 
 Layout/HeredocArgumentClosingParenthesis:
+  # Require closing parentheses to be after opening of HEREDOC tags.
+  # Example:
+  #   foo(<<-SQL.squish)
+  #     bar
+  #   SQL
   Enabled: true
 
 Layout/LineContinuationSpacing:
+  # Don't allow spaces between preceding text and the line continuation
+  # character (`\`).
+  # Example:
+  #   "a"\
+  #   "b"
   EnforcedStyle: no_space
 
-Layout/LineEndStringConcatenationIndentation:
-  EnforcedStyle: aligned
-
 Layout/LineLength:
+  # Max 80 chars. See: https://rubystyle.guide/#max-line-length
   Max: 80
   Exclude:
     - "*.gemspec"
   AllowedPatterns:
-    # Deeply namespaced classes
-    - !ruby/regexp /\A *# [a-zA-z:]+\z/
-    # YARD doc `@example` output.
-    - !ruby/regexp /\A *#   \# => /
-    - !ruby/regexp /\A *#   =/
+    # Exempt showing example output in comments (e.g. in YARD docs).
+    - !ruby/regexp /\A *#.*# => /
 
 Layout/MultilineAssignmentLayout:
   Enabled: true
@@ -74,18 +139,27 @@ Layout/MultilineAssignmentLayout:
     - module
 
 Layout/MultilineArrayLineBreaks:
+  # Require each item in a multi-line Array to start on a separate line.
+  # Example:
+  #   [
+  #     # ...
+  #     c
+  #   ]
   Enabled: true
 
 Layout/MultilineHashKeyLineBreaks:
+  # Require each key in a multi-line Hash to start on a separate line.
+  # Example:
+  #   {
+  #     # ...
+  #     c: 3
+  #   }
   Enabled: true
 
-Layout/MultilineMethodArgumentLineBreaks:
-  Enabled: false
-
-Layout/MultilineMethodCallBraceLayout:
-  EnforcedStyle: symmetrical
-
 Layout/MultilineMethodCallIndentation:
+  # Example:
+  #   while my_object
+  #           .my_method
   EnforcedStyle: indented_relative_to_receiver
 
 Layout/MultilineMethodDefinitionBraceLayout:
@@ -94,17 +168,5 @@ Layout/MultilineMethodDefinitionBraceLayout:
   #   def my_method(
   #     my_arg1,
   #     my_arg2,
-  #   ) # <- 👀
+  #   )
   EnforcedStyle: new_line
-
-Layout/MultilineMethodParameterLineBreaks:
-  Enabled: false
-
-Layout/MultilineOperationIndentation:
-  Enabled: false # Waiting for e.g. `indented_relative_to_receiver`.
-
-Layout/RedundantLineBreak:
-  Enabled: false
-
-Layout/SingleLineBlockChain:
-  Enabled: false

data/lib/rubocop/lint.yml

@@ -1,12 +1,7 @@
-Lint/ConstantResolution:
-  Enabled: false
-
 Lint/HeredocMethodCallPosition:
+  # Prefer to locate method calls on the end of the opening heredoc statement.
   Enabled: true
 
-Lint/NumberConversion:
-  Enabled: false
-
 Lint/UselessAccessModifier:
   ContextCreatingMethods:
     - concerning

data/lib/rubocop/metrics-rails.yml

@@ -4,13 +4,21 @@ Metrics/AbcSize:
 
 Metrics/BlockLength:
   Exclude:
+    - config/initializers/*.rb
     - config/environments/*.rb
     - config/routes.rb
     - db/migrate/*.rb
     - db/seeds.rb
+    - lib/tasks/**/*.rake
     - test/**/*
 
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - db/migrate/*.rb
+
 Metrics/MethodLength:
+  # Ignore common sources of false positives. Especially when using multi-line
+  # Arrays, Hashes, heredocs, and/or method calls.
   AllowedMethods:
     - create
     - update

data/lib/rubocop/metrics.yml

@@ -1,20 +1,26 @@
 Metrics/BlockLength:
+  # Ignore common sources of false positives.
   AllowedMethods:
     - ips # Benchmarking
     - new
   Exclude:
-    - "test/**/*"
+    - rakelib/**
+    - test/**/*.rb
 
 Metrics/ClassLength:
+  # Ignore common sources of false positives. Especially when using multi-line
+  # Arrays, Hashes, heredocs, and/or method calls.
   CountAsOne:
     - array
     - hash
     - heredoc
     - method_call
   Exclude:
-    - "test/**/*"
+    - test/**/*.rb
 
 Metrics/MethodLength:
+  # Ignore common sources of false positives. Especially when using multi-line
+  # Arrays, Hashes, heredocs, and/or method calls.
   CountAsOne:
     - array
     - hash
@@ -22,6 +28,8 @@ Metrics/MethodLength:
     - method_call
 
 Metrics/ModuleLength:
+  # Ignore common sources of false positives. Especially when using multi-line
+  # Arrays, Hashes, heredocs, and/or method calls.
   CountAsOne:
     - array
     - hash

data/lib/rubocop/minitest.yml

@@ -1,5 +1,128 @@
+Minitest/AssertEmpty:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false
+
+Minitest/AssertEmptyLiteral:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false
+
+Minitest/AssertEqual:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false
+
+Minitest/AssertInDelta:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false
+
+Minitest/AssertIncludes:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false
+
+Minitest/AssertInstanceOf:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false
+
+Minitest/AssertKindOf:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false
+
+Minitest/AssertMatch:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false
+
+Minitest/AssertOperator:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false
+
+Minitest/AssertPathExists:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false
+
+Minitest/AssertPredicate:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false
+
+Minitest/AssertRaisesCompoundBody:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false
+
+Minitest/AssertRespondTo:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false
+
+Minitest/AssertTruthy:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false
+
+Minitest/AssertWithExpectedArgument:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false
+
+Minitest/EmptyLineBeforeAssertionMethods:
+  # Let the context determine the best way to tell the story.
+  Enabled: false
+
+Minitest/LiteralAsActualArgument:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false
+
+Minitest/MultipleAssertions:
+  # Test examples with many assertions can be trusted to be written as such for
+  # a reason. This is not a common habit for this team.
+  Enabled: false
+
 Minitest/NoAssertions:
-  Enabled: false # Incompatible with Spec DSL.
+  # Incompatible with Spec DSL, which uses expectations instead of assertions.
+  Enabled: false
 
 Minitest/NoTestCases:
+  # Don't check in a test file if it has no test cases.
   Enabled: true
+
+Minitest/RefuteEmpty:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false
+
+Minitest/RefuteEqual:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false
+
+Minitest/RefuteFalse:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false
+
+Minitest/RefuteInDelta:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false
+
+Minitest/RefuteIncludes:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false
+
+Minitest/RefuteInstanceOf:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false
+
+Minitest/RefuteKindOf:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false
+
+Minitest/RefuteMatch:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false
+
+Minitest/RefuteOperator:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false
+
+Minitest/RefutePathExists:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false
+
+Minitest/RefutePredicate:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false
+
+Minitest/UnspecifiedException:
+  # Irrelevant. Use expectations, not assertions.
+  Enabled: false

data/lib/rubocop/naming-rails.yml

@@ -0,0 +1,22 @@
+Naming/BlockParameterName:
+  MinNameLength: 2
+  AllowedNames:
+    - f # FormBuilder
+    - o # Option (for `with_options` blocks)
+    - t # Task
+  ForbiddenNames:
+    - i # Index
+    - x # ? (Too arbitrary)
+
+Naming/MethodParameterName:
+  AllowedNames:
+    - as # Partials
+    - db # Database
+    - f # Form builders
+    - id # Identification
+    # Sorting:
+    - a
+    - b
+    # Mailers:
+    - cc
+    - to

data/lib/rubocop/naming.yml

@@ -1,11 +1,19 @@
-Naming/InclusiveLanguage:
-  Enabled: true
+Naming/BlockParameterName:
+  MinNameLength: 2
+  AllowedNames:
+    - o # Option (for `with_options` blocks)
+    - t # Task
+  ForbiddenNames:
+    - i # Index
+    - x # ? (Too arbitrary)
 
 Naming/MethodParameterName:
   AllowedNames:
+    - id # Identification
+    # Sorting:
     - a
     - b
-    - id
 
 Naming/RescuedExceptionsVariableName:
+  # `ex` is short and simple while also being more grep'able than `e`.
   PreferredName: ex

data/lib/rubocop/performance.yml

@@ -1,17 +1,29 @@
 Performance/ArraySemiInfiniteRangeSlice:
-  Enabled: false # Too many false positives with Strings.
+  # Too many false positives with Strings. (String#take doesn't exist.)
+  Enabled: false
 
 Performance/CaseWhenSplat:
+  # Can save performance / memory allocation when splatting conditions in `case`
+  # statements.
   Enabled: true
 
 Performance/ChainArrayAllocation:
+  # Prevent allocating new arrays when in-place modification is possible.
   Enabled: true
 
 Performance/IoReadlines:
+  # Prevent use of `readline` for IO when `each_line` is available (which is far
+  # more memory efficient).
   Enabled: true
 
 Performance/OpenStruct:
+  # Prefer Struct, when possible. Instantiation of an OpenStruct invalidates
+  # Ruby global method cache as it causes dynamic method definition during
+  # program runtime. This could have an effect on performance, especially in
+  # case of single-threaded applications with multiple OpenStruct
+  # instantiations.
   Enabled: true
 
 Performance/SelectMap:
+  # Prefer single-iteration to multiple interations, where possible.
   Enabled: true

data/lib/rubocop/rails.yml

@@ -1,57 +1,109 @@
-# While bulk changes can be useful, they shouldn't be required. Too much work
-# for little benefit.
 Rails/ActionOrder:
+  # Prefer Controller actions to be ordered in this way:
   ExpectedOrder: [index, show, new, create, edit, update, destroy]
 
-Rails/AttributeDefaultBlockValue:
-  Enabled: true
+Rails/ApplicationController:
+  # BaseControllers may rightfully need to inherit from ActionController::Base.
+  Exclude:
+    - app/controllers/**/base_controller.rb
+
+Rails/ApplicationJob:
+  Exclude:
+    - test/**/* # Allow for defining ActiveJob::Base test doubles.
+
+Rails/AssertNot:
+  # Prefer expectations over assertions.
+  Enabled: false
 
 Rails/BulkChangeTable:
+  # Prefer ease of programming to optimizing schema migrations performance.
   Enabled: false
 
 Rails/DefaultScope:
+  # Never use `default_scope`, it only leads to pain.
   Enabled: true
 
 Rails/Delegate:
-  Enabled: false # We choose to never use `delegate`, instead.
+  # Prefer endless methods over `delegate` for:
+  # - Much better "grep-ability"
+  # - In-editor "symbol" lookup
+  # - More straight forward implementation
+  # - Better performance
+  Enabled: false
 
 Rails/EnvironmentVariableAccess:
+  # Accessing ENV variable within the application code can lead to runtime
+  # errors due to misconfiguration. Prefer discovering these at boot time,
+  # instead, by loading environment variables as part of app initialization
+  # (by copying them into the application's configuration or secrets).
   Enabled: true
 
-Rails/HasManyOrHasOneDependent:
-  Enabled: false # A :dependent option isn't always needed (e.g. Transactions).
-
 Rails/OrderById:
+  # IDs are not guaranteed to be in any particular order, despite often
+  # (incidentally) being chronological. Prefer using a timestamp column to order
+  # chronologically.
   Enabled: true
 
-Rails/Output:
-  Enabled: false
-
 Rails/PluckId:
+  # Prefer `MyRecord.ids` to `MyRecord.pluck(:id)`.
   Enabled: true
 
+Rails/RefuteMethods:
+  # Irrelevant since we prefer expectations over assertions.
+  Enabled: false
+
 Rails/RequireDependency:
+  # The Zeitwerk code loader makes the need for `require_dependency` obsolete.
   Enabled: true
 
 Rails/ReversibleMigrationMethodDefinition:
+  # Ensure all schema migrations are reversible.
   Enabled: true
 
 Rails/SaveBang:
-  Enabled: false
-
-Rails/SchemaComment:
-  Enabled: false
+  # Defend against hidden, unhandled ActiveRecord update failures in the test suite.
+  Enabled: true
+  AllowedReceivers:
+    - where
+  Include:
+    - test/**/*
 
 Rails/SkipsModelValidations:
+  # Intended to prevent skipping validation on methods that may not seem like
+  # they would, such as `increment`, `update_all`, `update_columns`, etc.
+  # But, the context is what matters here, so this can't be decided up front.
   Enabled: false
 
 Rails/TableNameAssignment:
+  # MyRecord.table_name= should only be used for very good reasons. Override as
+  # needed.
   Enabled: true
 
 Rails/UniqBeforePluck:
+  # Prefer using `distinct` before `pluck` instead of `uniq` after `pluck`, as
+  # the former is executed by the database and is, therefore, more efficient.
   EnforcedStyle: aggressive
 
+Rails/UnknownEnv:
+  # Consider changing this to an empty Array to prevent use of
+  # `Rails.env.<environment>?` entirely, in favor of `App::Env.<environment>?`.
+  Environments:
+    - development
+    - devprod
+    - production
+    - staging
+    - test
+
+Rails/UnusedIgnoredColumns:
+  # Suggests you remove a column that does not exist in the schema from
+  # `ignored_columns`. Not sure we use this, but can't hurt to have this enabled
+  # if we do start using it.
+  Enabled: true
+
 Rails/WhereExists:
+  # Prefer using scopes to filer conditions (`where(...).exists?`) over
+  # `exists?(<condition>)`. The latter was all that was possible in older
+  # versions of Rails.
   EnforcedStyle: where
   Exclude:
     - test/**/*

data/lib/rubocop/style-rails.yml

@@ -1,4 +1,6 @@
 Style/Documentation:
+  # Require documentation for classes and non-namespace modules. This helps
+  # orient devs to the purpose of each model/service in the system.
   Exclude:
     - app/controllers/**/*
     - app/helpers/**/*
@@ -9,10 +11,14 @@ Style/Documentation:
     - test/**/*
 
 Style/FrozenStringLiteralComment:
+  # Require `frozen_string_literal` magic comment at top of Ruby files.
   Exclude:
     - config.ru
     - bin/*
 
+Style/IpAddresses:
+  Enabled: true
+
 Style/MultilineBlockChain:
   Exclude:
     - db/seeds.rb

data/lib/rubocop/style.yml

@@ -1,20 +1,31 @@
 Style/Alias:
-  EnforcedStyle: prefer_alias_method
+  # https://rubystyle.guide/#alias-method-lexically
+  EnforcedStyle: prefer_alias
 
 Style/ArrayFirstLast:
-  Enabled: false # Too many false positives.
-
-Style/AsciiComments:
+  # Too many false positives.
   Enabled: false
 
 Style/AutoResourceCleanup:
+  # Require blocks for auto-cleanup resources when available. e.g.
+  # `File.open("my_file") { |file| ... }` over `file = File.open("my_file")`.
   Enabled: true
 
 Style/BlockDelimiters:
+  # Prefer `do...end` vs `{...}` based on semantic meaning.
+  # - Use `{...}` for functional blocks (where we may care about the return
+  #   value).
+  # - Use `do...end` for procedural blocks (where we don't care about the return
+  #   value).
   EnforcedStyle: semantic
+  # But always prefer `{...}` for one-liners, even if it's a procedural block.
   AllowBracesOnProceduralOneLiners: true
+  # 👀 `tap` is an exception to the rule. Even though we don't care about the
+  # return value of the block, we do care about the return value of the method
+  # (for chaining).
   FunctionalMethods:
-    # Minitest Spec DSL. (Rubocop defaults.)
+    # Rubocop defaults
+    # Minitest Spec DSL:
     - let
     - let!
     - subject
@@ -28,7 +39,10 @@ Style/BlockDelimiters:
     # - tap (Already listed above.)
     - tap_on_call
     - with
+    # Custom additions
+    - catch # Doesn't work... Rubocop allows either style for catch blocks.
   ProceduralMethods: # Defining this just to remove `tap` from the list.
+    # Rubocop defaults
     - benchmark
     - bm
     - bmbm
@@ -37,19 +51,15 @@ Style/BlockDelimiters:
     - measure
     - new
     - realtime
-    # - tap (Remove from Rubocop defaults.)
+    # - tap # Remove from Rubocop defaults, so we can treat `tap` as functional.
     - with_object
 
 Style/ClassAndModuleChildren:
-  AutoCorrect: true
+  # Combine constant definitions as much as possible. e.g. `class Foo::Bar`.
   EnforcedStyle: compact
-  Exclude:
-    - "test/**/*"
-
-Style/ClassMethodsDefinitions:
-  Enabled: true
 
 Style/CollectionMethods:
+  # Enforce the use of consistent method names from the Enumerable module.
   Enabled: true
   PreferredMethods:
     collect: map
@@ -59,142 +69,163 @@ Style/CollectionMethods:
     inject: inject
 
 Style/ConstantVisibility:
-  Enabled: false
+  # Protect the public API by requiring constants visibility.
+  Enabled: true
+
+Style/ClassMethodsDefinitions:
+  # Prefer to define class methods like: `def self.<class_method_name>`.
+  Enabled: true
 
 Style/Copyright:
+  # Don't require a copyright notice in every source file.
   Enabled: false
 
 Style/DateTime:
+  # Prefer using `Time` over `DateTime`.
   Enabled: true
 
-Style/DisableCopsWithinSourceCodeDirective:
-  Enabled: false
-
 Style/Documentation:
+  # Require documentation for classes and non-namespace modules. This helps
+  # orient devs to the purpose of each model/service in the system.
   Exclude:
-    - "test/**/*"
-
-Style/DocumentationMethod:
-  Enabled: false
+    - test/**/*
 
 Style/EmptyElse:
-  Enabled: false # Including a comment in an empty else block shows intent.
-
-Style/EmptyMethod:
-  EnforcedStyle: expanded
+  # Require an explanatory comment if we're otherwise wanting to utilize an
+  # empty `else` block.
+  AllowComments: true
 
 Style/ExpandPathArguments:
   Exclude:
     - "*.gemspec"
 
 Style/FormatString:
-  Enabled: false # % notation with an Array just reads better sometimes.
+  # Prefer "%{my_value}" % { my_value: "..." }
+  # Over:
+  # - format("%{my_value}", my_value: "...")
+  # - sprintf("%{my_value}", my_value: "...")
+  EnforcedStyle: percent
+
+Style/FormatStringToken:
+  # Prefer "%{my_template_value}" # <- Same style as is used in YAML
+  # Over:
+  # - "%<my_template_value>"
+  # - "%s"
+  EnforcedStyle: template
 
 Style/GuardClause:
+  # If > 1 conditional exists, don't require the 2nd+ to be a guard clause.
+  # Better to keep the symmetric logic flow.
   AllowConsecutiveConditionals: true
 
-Style/HashAsLastArrayItem:
-  Exclude:
-    - test/**/*
+Style/HashSyntax:
+  # Use Ruby 3.1+'s Hash punning syntax whenever possible. e.g.
+  #   # Good
+  #   { foo:, bar:, baz: other }
+  #   my_method(foo:, bar:, baz: other)
+  #
+  #   # Bad
+  #   { foo: foo, bar: bar, baz: other }
+  #   my_method(foo: foo, bar: bar, baz: other)
+  EnforcedShorthandSyntax: always
 
 Style/ImplicitRuntimeError:
-  Enabled: false
-
-Style/InlineComment:
-  Enabled: false
-
-Style/InvertibleUnlessCondition:
+  # Raising `RuntimeError` is not illuminating. Prefer specifying either a
+  # StandardError or a custom-defined `Error` class.
   Enabled: true
 
-Style/IpAddresses:
+Style/InvertibleUnlessCondition:
+  # Prefer positive logic over negative logic in conditionals.
   Enabled: true
 
 Style/Lambda:
+  # Always prefer `-> {}` for lambdas, whether for single or multi-line use.
+  #   # Good
+  #   ->(x) { x }
+  #   ->(x) {
+  #     x
+  #   }
   EnforcedStyle: literal
 
 Style/LambdaCall:
-  Enabled: false # Allow ServiceObject.(*). Only use on classes, not instances.
+  # Allow `MyObject.(...)` in place of `MyObjecet.call(...)`.
+  Enabled: false
 
 Style/MethodCallWithArgsParentheses:
+  # Omitting parentheses:
+  # - Can result in ambiguous code, and
+  # - Often results in incidental change as code is updated/augmented/refactored
+  # Avoid these issues entirely by just always using parentheses, except for in
+  # common, idiomatic places like macros (such as `belongs_to`).
   Enabled: true
   AllowedMethods:
     - add_dependency
     - add_development_dependency
-  AllowParenthesesInChaining: true
-  AllowParenthesesInCamelCaseMethod: true
-  AllowParenthesesInStringInterpolation: true
+  # AllowParenthesesInChaining: true
+  # AllowParenthesesInCamelCaseMethod: true
+  # AllowParenthesesInStringInterpolation: true
 
 Style/MethodCalledOnDoEndBlock:
+  # It's easy to miss method calls tacked on to the end of a block. Plus, if
+  # this is needed then the block is probably a functional block, in which case
+  # we prefer curly brackets anyway.
   Enabled: true
 
-Style/MissingElse:
-  Enabled: false
-
-Style/MultilineMethodSignature:
-  Enabled: false
-
-Style/NumericPredicate:
-  AutoCorrect: true
-
-Style/OpenStructUse:
-  Exclude:
-    - "test/**/*"
-
 Style/OptionHash:
+  # Prefer keyword arguments over options hashes whenever possible.
   Enabled: true
 
 Style/RegexpLiteral:
   EnforcedStyle: mixed
 
-Style/RequireOrder:
-  Enabled: false
-
 Style/RescueStandardError:
+  # Prefer `rescue => ex` over `rescue StandardError => ex`.
   EnforcedStyle: implicit
 
 Style/ReturnNil:
+  # Enforce consistency in choosing `return if ...` vs `return nil if ...`.
+  # Prefer the former (implicit) style.
   Enabled: true
 
 Style/Send:
+  # Require either `public_send` (for calling public methods) or `__send__` (for
+  # calling private methods) over just `send`.
   Enabled: true
 
-Style/SingleLineBlockParams:
-  Enabled: false
-
 Style/StaticClass:
+  # Prefer `module` over `class` whenever object instantiation isn't needed.
   Enabled: true
 
-Style/StringHashKeys:
-  Enabled: false
-
-Style/StringMethods:
-  Enabled: true
-
-Style/SingleLineMethods:
-  Exclude:
-    - "test/**/*"
-
 Style/StringLiterals:
+  # Double quotes minimize incidental change when interpolation becomes needed.
   EnforcedStyle: double_quotes
 
 Style/StringLiteralsInInterpolation:
+  # Double quotes minimize incidental change when interpolation becomes needed.
   EnforcedStyle: double_quotes
 
+Style/StringMethods:
+  # Prefer String#to_sym over String#intern. (Can add other such preferences
+  # too, if desired.)
+  Enabled: true
+
 Style/SymbolProc:
+  # Don't force symbol proc when the method has other arguments.
+  #   # Good
+  #   my_object.my_method(&:upcase)
+  #   my_object.my_method(param1, &:upcase)
+  #   my_object.my_method(param1) { |my_value| my_value.upcase } # <- 👀
   AllowMethodsWithArguments: true
 
-Style/TopLevelMethodDefinition:
-  Enabled: false
-
 Style/TrailingCommaInArguments:
-  # Requires a comma after the last argument, but only for parenthesized method
+  # Require a comma after the last argument, but only for parenthesized method
   # calls where each argument is on its own line. e.g.
   #   def my_method(
   #     my_arg1,
-  #     my_arg2, # <- 👀 Comma required.
+  #     my_arg2, # <- 👀 Comma required
   #   )
   #   def my_method(
-  #     my_arg1, my_arg2 # <- 👀 No comma required.
+  #     my_arg1, my_arg2 # <- 👀 No comma required
   #   )
   #
   #   NOTE: Prefer `comma` over `consistent` b/c `consistent`:
@@ -214,15 +245,17 @@ Style/TrailingCommaInArguments:
   EnforcedStyleForMultiline: comma
 
 Style/TrailingCommaInArrayLiteral:
+  # Require a comma after the last item in an array, but only when each item is
+  # on its own line.
   EnforcedStyleForMultiline: comma
 
-Style/TrailingCommaInBlockArgs:
-  Enabled: false
-
 Style/TrailingCommaInHashLiteral:
+  # Require a comma after the last item in a hash, but only when each item is on
+  # its own line.
   EnforcedStyleForMultiline: comma
 
 Style/UnlessLogicalOperators:
+  # Prevent tricky logic in `unless` conditions.
   Enabled: true
 
 Style/YodaExpression:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gemwork
 version: !ruby/object:Gem::Version
-  version: 0.7.19
+  version: 0.7.22
 platform: ruby
 authors:
 - Paul DobbinSchmaltz
@@ -226,6 +226,7 @@ files:
 - lib/rubocop/metrics-rails.yml
 - lib/rubocop/metrics.yml
 - lib/rubocop/minitest.yml
+- lib/rubocop/naming-rails.yml
 - lib/rubocop/naming.yml
 - lib/rubocop/performance.yml
 - lib/rubocop/rails.yml
@@ -263,7 +264,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Common gem framework code used by pdobb's Ruby Gems.
 test_files: []