rubocop-cargosense 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c72056ae5e176a177af44006de8034c7559f7e7e90018d3282fdfb1f6c5430b9
-  data.tar.gz: 1ea28f20a44a78ab4730881c22f9ff756b86fd6f2577e224e9f4bb1f0bbdc522
+  metadata.gz: 7af7d9bbcbea87dc2e8bc382c2e467b59b98552d136555f2d40ff0cda74a8cb8
+  data.tar.gz: 89ccf5cf750d1ab78407beb04d1e412aeae906e95458fb7530ccd497ecc4788f
 SHA512:
-  metadata.gz: 314891ce08a392c02143cfd6969d52ee4090bc1fa0b3db6236bc27fd9320c2069b1c01b89143f3caea8b7d691e6c963ed31ae5b2ab7c89bde7a0afdcae1102db
-  data.tar.gz: 9b1fa52647312ef6400c305b0945385a4ac408f5c22ce71c4293cfdff2dd138cc9da31f879ab657eca3c10f4aab5fe6fea2ebee6d5f31f7d0a377e1118638281
+  metadata.gz: 8370ab0edbbeff9b14b39c6f407de7fd0ffd4c03ed8ae21a3d9bf551fd96f438802ade8bf85645090dee60c2296e558aec536029668a740c32e1374c3be3accc
+  data.tar.gz: 4520c0dbe66c693d73da876180c70c538b0e25008ef819659d3648d385353e5c4abfe91d61118b51a0acb0ea822ca7c00ef3ae673c1b1e45591845f9f52075f9

data/README.md

@@ -27,7 +27,7 @@ require:
 > [!TIP]
 > If rubocop-cargosense is your project's only RuboCop extension, you can simplify the above directive: `require: rubocop-cargosense`
 
-Or, inherit rubocop-cargosense's configuration using [RuboCop's `inherit_gem` directive](https://docs.rubocop.org/rubocop/configuration.html#inheriting-configuration-from-a-dependency-gem):
+Or, inherit rubocop-cargosense's default configuration using [RuboCop's `inherit_gem` directive](https://docs.rubocop.org/rubocop/configuration.html#inheriting-configuration-from-a-dependency-gem):
 
 ```yaml
 # .rubocop.yml
@@ -35,6 +35,19 @@ inherit_gem:
   rubocop-cargosense: config/default.yml
 ```
 
+You may also inherit individual configuration files from rubocop-cargosense:
+
+```yaml
+# .rubocop.yml
+inherit_gem:
+  rubocop-cargosense:
+    - config/rubocop-layout.yml
+    - config/rubocop-performance.yml
+```
+
+> [!WARNING]
+> While the above piecemeal usage is permissible, we recommend requiring the default configuration in its entirety.
+
 ## License
 
 rubocop-cargosense is freely available under the [MIT License](https://opensource.org/licenses/MIT).

data/config/default.yml

@@ -1,177 +1,19 @@
+inherit_from:
+  - ./rubocop.yml
+  - ./rubocop-capybara.yml
+  - ./rubocop-factory_bot.yml
+  - ./rubocop-performance.yml
+  - ./rubocop-rails.yml
+  - ./rubocop-rake.yml
+  - ./rubocop-rspec.yml
+
 inherit_mode:
   merge:
     - Exclude
     - Include
 
-require:
-  - rubocop-performance
-  - rubocop-rake
-
 AllCops:
   ActiveSupportExtensionsEnabled: true
   DisplayStyleGuide: true
   ExtraDetails: true
   NewCops: enable
-
-Layout/ClassStructure:
-  Enabled: true
-  ExpectedOrder:
-    - module_inclusion
-    - constants
-    - association
-    - public_attribute_macros
-    - public_delegate
-    - macros
-    - public_class_methods
-    - initializer
-    - public_methods
-    - protected_attribute_macros
-    - protected_methods
-    - private_attribute_macros
-    - private_delegate
-    - private_methods
-
-Layout/EmptyLineAfterMultilineCondition:
-  Enabled: true
-
-Layout/FirstHashElementIndentation:
-  EnforcedStyle: consistent
-
-Layout/HeredocArgumentClosingParenthesis:
-  Enabled: true
-
-Layout/MultilineArrayLineBreaks:
-  Enabled: true
-
-Layout/MultilineAssignmentLayout:
-  Enabled: true
-
-Layout/MultilineHashKeyLineBreaks:
-  Enabled: true
-
-Layout/MultilineMethodArgumentLineBreaks:
-  Enabled: true
-
-Layout/MultilineMethodCallIndentation:
-  EnforcedStyle: indented_relative_to_receiver
-
-Layout/MultilineMethodParameterLineBreaks:
-  Enabled: true
-
-Layout/MultilineOperationIndentation:
-  EnforcedStyle: indented
-
-Layout/ParameterAlignment:
-  EnforcedStyle: with_fixed_indentation
-
-Lint/HeredocMethodCallPosition:
-  Enabled: true
-
-Metrics/BlockLength:
-  CountAsOne:
-    - array
-    - hash
-    - heredoc
-    - method_call
-
-Metrics/ClassLength:
-  CountAsOne:
-    - array
-    - hash
-    - heredoc
-    - method_call
-
-Metrics/MethodLength:
-  CountAsOne:
-    - array
-    - hash
-    - heredoc
-    - method_call
-
-Metrics/ModuleLength:
-  CountAsOne:
-    - array
-    - hash
-    - heredoc
-    - method_call
-
-Metrics/ParameterLists:
-  CountKeywordArgs: false
-
-Naming/InclusiveLanguage:
-  Enabled: true
-
-Naming/VariableNumber:
-  Enabled: false
-
-Performance/ChainArrayAllocation:
-  Enabled: true
-
-Performance/IoReadlines:
-  Enabled: true
-
-Performance/OpenStruct:
-  Enabled: true
-
-Performance/SelectMap:
-  Enabled: true
-
-Style/ArrayCoercion:
-  Enabled: true
-
-Style/AutoResourceCleanup:
-  Enabled: true
-
-Style/ClassMethodsDefinitions:
-  Enabled: true
-
-Style/CollectionMethods:
-  Enabled: true
-
-Style/DateTime:
-  Enabled: true
-
-Style/Documentation:
-  Enabled: false
-
-Style/EmptyMethod:
-  EnforcedStyle: expanded
-
-Style/HashSyntax:
-  EnforcedShorthandSyntax: never
-
-Style/MethodCalledOnDoEndBlock:
-  Enabled: true
-
-Style/MultilineMethodSignature:
-  Enabled: true
-
-Style/OptionHash:
-  Enabled: true
-
-Style/ReturnNil:
-  Enabled: true
-
-Style/Send:
-  Enabled: true
-
-Style/StaticClass:
-  Enabled: true
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes
-
-Style/StringMethods:
-  Enabled: true
-
-Style/SymbolArray:
-  EnforcedStyle: brackets
-
-Style/WordArray:
-  EnforcedStyle: brackets
-
-Style/UnlessLogicalOperators:
-  Enabled: true

data/config/rubocop-capybara.yml

@@ -0,0 +1,8 @@
+# Code style checking for Capybara test files (RSpec, Cucumber, Minitest). A
+# plugin for the RuboCop code style enforcing & linting tool.
+#
+# @see https://rubygems.org/gems/rubocop-capybara
+# @see https://docs.rubocop.org/rubocop-capybara
+# @see https://github.com/rubocop/rubocop-capybara
+
+require: rubocop-capybara

data/config/rubocop-factory_bot.yml

@@ -0,0 +1,8 @@
+# Code style checking for factory_bot files. A plugin for the RuboCop code style
+# enforcing & linting tool.
+#
+# @see https://rubygems.org/gems/rubocop-factory_bot
+# @see https://docs.rubocop.org/rubocop-factory_bot
+# @see https://github.com/rubocop/rubocop-factory_bot
+
+require: rubocop-factory_bot

data/config/rubocop-layout.yml

@@ -0,0 +1,55 @@
+# Layout cops inspect your code for consistent use of indentation, alignment,
+# and white space.
+#
+# @see https://docs.rubocop.org/rubocop/cops_layout.html
+
+Layout/ClassStructure:
+  Enabled: true
+  ExpectedOrder:
+    - module_inclusion
+    - constants
+    - association
+    - public_attribute_macros
+    - public_delegate
+    - macros
+    - public_class_methods
+    - initializer
+    - public_methods
+    - protected_attribute_macros
+    - protected_methods
+    - private_attribute_macros
+    - private_delegate
+    - private_methods
+
+Layout/EmptyLineAfterMultilineCondition:
+  Enabled: true
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/HeredocArgumentClosingParenthesis:
+  Enabled: true
+
+Layout/MultilineArrayLineBreaks:
+  Enabled: true
+
+Layout/MultilineAssignmentLayout:
+  Enabled: true
+
+Layout/MultilineHashKeyLineBreaks:
+  Enabled: true
+
+Layout/MultilineMethodArgumentLineBreaks:
+  Enabled: true
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented_relative_to_receiver
+
+Layout/MultilineMethodParameterLineBreaks:
+  Enabled: true
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation

data/config/rubocop-lint.yml

@@ -0,0 +1,6 @@
+# Lint cops check for ambiguities and possible errors in your code.
+#
+# @see https://docs.rubocop.org/rubocop/cops_lint.html
+
+Lint/HeredocMethodCallPosition:
+  Enabled: true

data/config/rubocop-metrics.yml

@@ -0,0 +1,35 @@
+# Metrics cops deal with properties of the source code that can be measured,
+# such as class length, method length, etc.
+#
+# @see https://docs.rubocop.org/rubocop/cops_metrics.html
+
+Metrics/BlockLength:
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+    - method_call
+
+Metrics/ClassLength:
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+    - method_call
+
+Metrics/MethodLength:
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+    - method_call
+
+Metrics/ModuleLength:
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+    - method_call
+
+Metrics/ParameterLists:
+  CountKeywordArgs: false

data/config/rubocop-naming.yml

@@ -0,0 +1,10 @@
+# Naming cops check for naming issue of your code, such as method name, constant
+# name, file name, etc.
+#
+# @see https://docs.rubocop.org/rubocop/cops_naming.html
+
+Naming/InclusiveLanguage:
+  Enabled: true
+
+Naming/VariableNumber:
+  Enabled: false

data/config/rubocop-performance.yml

@@ -0,0 +1,20 @@
+# A collection of RuboCop cops to check for performance optimizations in Ruby
+# code.
+#
+# @see https://rubygems.org/gems/rubocop-performance
+# @see https://docs.rubocop.org/rubocop-performance
+# @see https://github.com/rubocop/rubocop-performance
+
+require: rubocop-performance
+
+Performance/ChainArrayAllocation:
+  Enabled: true
+
+Performance/IoReadlines:
+  Enabled: true
+
+Performance/OpenStruct:
+  Enabled: true
+
+Performance/SelectMap:
+  Enabled: true

data/config/rubocop-rails.yml

@@ -0,0 +1,34 @@
+# Automatic Rails code style checking tool. A RuboCop extension focused on
+# enforcing Rails best practices and coding conventions.
+#
+# @see https://rubygems.org/gems/rubocop-rails
+# @see https://docs.rubocop.org/rubocop-rails
+# @see https://github.com/rubocop/rubocop-rails
+
+require: rubocop-rails
+
+Rails/DefaultScope:
+  Enabled: true
+
+Rails/EnvironmentVariableAccess:
+  Enabled: true
+  AllowReads: true
+
+Rails/OrderById:
+  Enabled: true
+
+Rails/PluckId:
+  Enabled: true
+
+Rails/RequireDependency:
+  Enabled: true
+
+Rails/ReversibleMigrationMethodDefinition:
+  Enabled: true
+
+Rails/SaveBang:
+  Enabled: true
+  AllowImplicitReturn: false
+
+Rails/TableNameAssignment:
+  Enabled: true

data/config/rubocop-rake.yml

@@ -0,0 +1,6 @@
+# A RuboCop plugin for Rake.
+#
+# @see https://rubygems.org/gems/rubocop-rake
+# @see https://github.com/rubocop/rubocop-rake
+
+require: rubocop-rake

data/config/rubocop-rspec.yml

@@ -0,0 +1,21 @@
+# Code style checking for RSpec files. A plugin for the RuboCop code style
+# enforcing & linting tool.
+#
+# @see https://rubygems.org/gems/rubocop-rspec
+# @see https://docs.rubocop.org/rubocop-rspec
+# @see https://github.com/rubocop/rubocop-rspec
+
+require: rubocop-rspec
+
+RSpec/DescribedClassModuleWrapping:
+  Enabled: true
+
+RSpec/ExampleLength:
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+    - method_call
+
+RSpec/MessageExpectation:
+  Enabled: true

data/config/rubocop-style.yml

@@ -0,0 +1,64 @@
+# Style cops check for stylistic consistency of your code. Many of the them are
+# based on the Ruby Style Guide.
+#
+# @see https://docs.rubocop.org/rubocop/cops_style.html
+
+Style/ArrayCoercion:
+  Enabled: true
+
+Style/AutoResourceCleanup:
+  Enabled: true
+
+Style/ClassMethodsDefinitions:
+  Enabled: true
+
+Style/CollectionMethods:
+  Enabled: true
+
+Style/DateTime:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/HashSyntax:
+  EnforcedShorthandSyntax: never
+
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+Style/MultilineMethodSignature:
+  Enabled: true
+
+Style/OptionHash:
+  Enabled: true
+
+Style/ReturnNil:
+  Enabled: true
+
+Style/Send:
+  Enabled: true
+
+Style/StaticClass:
+  Enabled: true
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/StringMethods:
+  Enabled: true
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/WordArray:
+  EnforcedStyle: brackets
+
+Style/UnlessLogicalOperators:
+  Enabled: true

data/config/rubocop.yml

@@ -0,0 +1,13 @@
+# RuboCop is a Ruby code style checking and code formatting tool. It aims to
+# enforce the community-driven Ruby Style Guide.
+#
+# @see https://rubygems.org/gems/rubocop
+# @see https://docs.rubocop.org/rubocop
+# @see https://github.com/rubocop/rubocop
+
+inherit_from:
+  - ./rubocop-layout.yml
+  - ./rubocop-lint.yml
+  - ./rubocop-metrics.yml
+  - ./rubocop-naming.yml
+  - ./rubocop-style.yml

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-cargosense
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - CargoSense
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-22 00:00:00.000000000 Z
+date: 2024-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.59'
+- !ruby/object:Gem::Dependency
+  name: rubocop-capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.20'
+- !ruby/object:Gem::Dependency
+  name: rubocop-factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.25'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.25'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.23'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.26'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.26'
 description: Reusable RuboCop configuration for CargoSense's Ruby projects.
 email:
 - rubygems@cargosense.com
@@ -62,6 +118,18 @@ files:
 - LICENSE
 - README.md
 - config/default.yml
+- config/rubocop-capybara.yml
+- config/rubocop-factory_bot.yml
+- config/rubocop-layout.yml
+- config/rubocop-lint.yml
+- config/rubocop-metrics.yml
+- config/rubocop-naming.yml
+- config/rubocop-performance.yml
+- config/rubocop-rails.yml
+- config/rubocop-rake.yml
+- config/rubocop-rspec.yml
+- config/rubocop-style.yml
+- config/rubocop.yml
 - lib/rubocop-cargosense.rb
 - lib/rubocop/cargosense.rb
 - lib/rubocop/cargosense/inject.rb
@@ -70,8 +138,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/CargoSense/rubocop-cargosense/issues
+  changelog_uri: https://github.com/CargoSense/rubocop-cargosense//releases
   rubygems_mfa_required: 'true'
-  source_code_uri: https://github.com/CargoSense/rubocop-cargosense/tree/v0.1.0
+  source_code_uri: https://github.com/CargoSense/rubocop-cargosense/tree/v0.2.0
 post_install_message: 
 rdoc_options: []
 require_paths: