gemwork 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b93c15236af6840a3554e1ca99867816511a425675fb062e0b70b681508c3cf
-  data.tar.gz: 54ba728610e27679caa6edbfd0fa3340edce68a1013af2dbfb274b0cbf049bb5
+  metadata.gz: e412d441f6bde6c0a2e3ba214d6204e17ca4f2e7eb5f796e06ce79f1ff545aa8
+  data.tar.gz: 0c6d4106c0e547e2dab91d7411674fdeb1d7ba3c054e7bcb055635a96b7adad8
 SHA512:
-  metadata.gz: b0256d6193fc521e0837892e3f9fc6d8343ebc04bfde9d1491eed97f07a68484850c817049a5c1a9dc5bcb5284dbd2775b3cb3e195a41c25d98929ca1041f941
-  data.tar.gz: ddb2effea533ccecb40e1be489ce561f6bb1b80525efa31cf13bdb673015c35cc87f9a005bc0ae995eac6e3178e16ad3eee49c3f16db07edb3c03db407ce8ea2
+  metadata.gz: 4cb7d423c31fa5bec5c06b4bc597d199f30e122b8e5ab9bdc1351c9b51f9e8e5223a00697cc9b9fa7be81a0533e2cce6e105d4b9b8995789dda7bd52dc0c0ce7
+  data.tar.gz: 29cae19621f25a53e03bb7d76495dfebaf5092ab00e5c9ac6d68b4b626b1b35d41f4a4e8ec65d64c6c9f9f2440d08c42b5be0f9c8154c365451cdba73f380f1d

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
+## [0.5.0] - 2024-3-22
+
+- Add examples for use in Rails projects. See the updated README.
+- Spruce up the rubocop config.
+  - Now includes all "Disabled"-by-default cops. Most stay disabled, but some are now enabled.
+  - No longer includes "Pending"-by-default cops. These are already automatically enabled by the `NewCops: enable` directive.
+  - Separate gem-specific from rails-specific cops configuration.
+  - Miscellaneous cleanup.
+
+## [0.4.2] - 2024-2-4
+
+- Add finer-grained control of Rake tasks loading/running. See the updated README.
+
 ## [0.4.0] - 2024-1-6
 
 - House cleaning for Ruby 3.3.

data/README.md

@@ -4,6 +4,8 @@
 
 Gemwork is an abstract framework used by [pdobb](https://github.com/pdobb)'s Ruby Gems.
 
+Support for Rails applications is also included, but not as the automatic default. See the "Rails" subheadings in the below sections.
+
 ## Installation
 
 Add this line to your `my_gem.gemspec` file:
@@ -32,14 +34,58 @@ Create file: `./rakelib/gemwork.rake`
 ```ruby
 # frozen_string_literal: true
 
+spec = Gem::Specification.find_by_name("gemwork")
+
 # Load additional tasks defined by Gemwork.
-Gem::Specification.find_by_name("gemwork").tap do |gemspec|
-  Rake.load_rakefile("#{gemspec.gem_dir}/lib/tasks/Rakefile")
+Dir.glob(
+  Pathname.new(spec.gem_dir).
+    join("lib", "tasks", "{util,rubocop,reek,test}.rake")) do |task|
+  load(task)
+end
+
+# Redefine the default `rake` task.
+Rake::Task["default"].clear
+task :default do
+  run_tasks(%i[
+    test
+    rubocop
+    reek
+  ])
 end
 ```
 
 Running `rake -T` after this will reveal the additional tasks defined by Gemwork just as if they were defined within your project.
 
+### Rails
+
+For a Rails project, you may need to conditionally run the above by returning early unless the current environment is development. Further, you may want to include other tasks, such as `test:system`.
+
+```ruby
+# frozen_string_literal: true
+
+return unless Rails.env.development?
+
+spec = Gem::Specification.find_by_name("gemwork")
+
+# Load additional tasks defined by Gemwork.
+Dir.glob(
+  Pathname.new(spec.gem_dir).
+    join("lib", "tasks", "{util,rubocop,reek,test}.rake")) do |task|
+  load(task)
+end
+
+# Redefine the default `rake` task.
+Rake::Task["default"].clear
+task :default do
+  run_tasks(%i[
+    test
+    rubocop
+    reek
+    test:system
+  ])
+end
+```
+
 ## Rubocop Integration
 ### Simple Usage
 
@@ -49,7 +95,22 @@ Add the following to the `.rubocop.yml` file in your gem:
 # .rubocop.yml
 
 inherit_gem:
-  gemwork: lib/rubocop/.rubocop.yml
+  gemwork: lib/rubocop/.rubocop-gems.yml
+```
+
+#### Rails
+
+Or, for a Rails project, add the following to the `.rubocop.yml` file in your project:
+
+```yaml
+# .rubocop.yml
+require:
+  - rubocop-rake
+  - rubocop-minitest
+  - rubocop-performance
+
+inherit_gem:
+  gemwork: lib/rubocop/.rubocop-rails.yml
 ```
 
 ### Advanced Usage
@@ -73,12 +134,51 @@ inherit_gem:
     - lib/rubocop/layout.yml
     - lib/rubocop/lint.yml
     - lib/rubocop/metrics.yml
+    - lib/rubocop/minitest.yml
     - lib/rubocop/naming.yml
+    - lib/rubocop/performance.yml
     - lib/rubocop/style.yml
+
+# Override values from gemwork's lib/rubocop/all_cops.yml config.
+AllCops:
+  TargetRubyVersion: 2.7
 ```
 
 See also: [RuboCop's Configuration Guide on Inheritance](https://github.com/rubocop/rubocop/blob/master/docs/modules/ROOT/pages/configuration.adoc#inheriting-configuration-from-a-dependency-gem).
 
+#### Rails
+
+```yaml
+# .rubocop.yml
+
+# Load Rubocop plugins.
+require:
+  - rubocop-capybara
+  - rubocop-performance
+  - rubocop-minitest
+  - rubocop-rails
+  - rubocop-rake
+
+# Load Cops configuration by Department.
+inherit_gem:
+  gemwork:
+    - lib/rubocop/all_cops.yml
+    - lib/rubocop/layout.yml
+    - lib/rubocop/lint.yml
+    - lib/rubocop/metrics.yml
+    - lib/rubocop/minitest.yml
+    - lib/rubocop/naming.yml
+    - lib/rubocop/performance.yml
+    - lib/rubocop/rails.yml
+    - lib/rubocop/style.yml
+
+# Override values from gemwork's lib/rubocop/all_cops.yml config.
+AllCops:
+  TargetRubyVersion: 3.3
+  Exclude:
+    - bin/bundle
+```
+
 ## Testing Support
 
 The following requires may be added to `./test/test_helper.rb` to simplify test configuration. These requires support the gem dependencies mentioned in the following section.
@@ -117,8 +217,18 @@ Gemwork depends on the following gems. None of these are actually used by Gemwor
 - [rubocop-minitest](https://github.com/rubocop/rubocop-minitest) -- Code style checking for Minitest files.
 - [rubocop-performance](https://github.com/rubocop/rubocop-performance/) -- An extension of RuboCop focused on code performance checks.
 - [rubocop-rake](https://github.com/rubocop/rubocop-rake) -- A RuboCop plugin for Rake.
+
+#### Documentation
 - [yard](https://github.com/lsegal/yard) -- YARD is a Ruby Documentation tool. The Y stands for "Yay!".
 
+### Rails
+
+For Rails projects, you may want to manually install additional gems as well:
+
+#### Linters
+- [rubocop-rails](https://github.com/rubocop/rubocop-rails) -- A RuboCop extension focused on enforcing Rails best practices and coding conventions.
+- [rubocop-capybara](https://github.com/rubocop/rubocop-capybara) -- Code style checking for Capybara files.
+
 ## Development
 
 Development of Gemwork often requires making updates to its code and then testing them in another child gem that uses Gemwork.
@@ -156,7 +266,9 @@ To release a new version of Gemwork to RubyGems:
 
 1. Update the version number in `version.rb`
 2. Update `CHANGELOG.md`
-3. Run `rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+3. Run `bundle` to update Gemfile.lock with the latest version info
+4. Commit the changes. e.g. `Bump to vX.Y.Z`
+5. Run `rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/gemwork/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gemwork
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/rubocop/.rubocop-gems.yml

@@ -0,0 +1,10 @@
+inherit_from:
+  - ./all_cops.yml
+  - ./gemspec.yml
+  - ./layout.yml
+  - ./lint.yml
+  - ./metrics.yml
+  - ./minitest.yml
+  - ./naming.yml
+  - ./performance.yml
+  - ./style.yml

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

@@ -0,0 +1,10 @@
+inherit_from:
+  - ./all_cops.yml
+  - ./layout.yml
+  - ./lint.yml
+  - ./metrics.yml
+  - ./minitest.yml
+  - ./naming.yml
+  - ./performance.yml
+  - ./rails.yml
+  - ./style.yml

data/lib/rubocop/.rubocop.yml

@@ -1,8 +1,2 @@
 inherit_from:
-  - ./all_cops.yml
-  - ./gemspec.yml
-  - ./layout.yml
-  - ./lint.yml
-  - ./metrics.yml
-  - ./naming.yml
-  - ./style.yml
+  - ./.rubocop-gems.yml

data/lib/rubocop/gemspec.yml

@@ -1,8 +1,5 @@
-Gemspec/DeprecatedAttributeAssignment:
-  Enabled: true
+Gemspec/DependencyVersion:
+  Enabled: false
 
 Gemspec/DevelopmentDependencies:
   EnforcedStyle: gemspec
-
-Gemspec/RequireMFA:
-  Enabled: true

data/lib/rubocop/layout.yml

@@ -1,9 +1,15 @@
+Layout/ClassStructure:
+  Enabled: false # Consider implementing on a per-project basis.
+
 Layout/DotPosition:
   EnforcedStyle: trailing
 
 Layout/EmptyLineAfterGuardClause:
   Enabled: true
 
+Layout/EmptyLineAfterMultilineCondition:
+  Enabled: false
+
 Layout/EndOfLine:
   EnforcedStyle: lf
 
@@ -13,12 +19,28 @@ Layout/FirstArgumentIndentation:
 Layout/FirstArrayElementIndentation:
   EnforcedStyle: consistent
 
+Layout/FirstArrayElementLineBreak:
+  Enabled: true
+
 Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
 
+Layout/FirstHashElementLineBreak:
+  Enabled: true
+
+Layout/FirstMethodArgumentLineBreak:
+  Enabled: true
+  AllowMultilineFinalElement: true
+
+Layout/FirstMethodParameterLineBreak:
+  Enabled: true
+
 Layout/FirstParameterIndentation:
   Enabled: false # Revisit if more settings become available.
 
+Layout/HeredocArgumentClosingParenthesis:
+  Enabled: true
+
 Layout/LineContinuationSpacing:
   EnforcedStyle: no_space
 
@@ -44,6 +66,18 @@ Layout/MultilineAssignmentLayout:
     # - kwbegin
     - module
 
+Layout/MultilineArrayLineBreaks:
+  Enabled: true
+
+Layout/MultilineHashKeyLineBreaks:
+  Enabled: true
+
+Layout/MultilineMethodArgumentLineBreaks:
+  Enabled: false
+
+Layout/MultilineMethodParameterLineBreaks:
+  Enabled: false
+
 Layout/MultilineMethodCallBraceLayout:
   EnforcedStyle: same_line
 
@@ -55,3 +89,9 @@ Layout/MultilineMethodDefinitionBraceLayout:
 
 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,8 +1,11 @@
-# Lint/AmbiguousOperator:
-#   Enabled: false # Conflicts with other rules.
+Lint/ConstantResolution:
+  Enabled: false
 
-# Lint/AmbiguousRegexpLiteral:
-#   Enabled: false # Conflicts with other rules.
+Lint/HeredocMethodCallPosition:
+  Enabled: true
+
+Lint/NumberConversion:
+  Enabled: false
 
 Lint/Void:
   CheckForMethodsWithNoSideEffects: true

data/lib/rubocop/minitest.yml

@@ -0,0 +1,5 @@
+Minitest/NoAssertions:
+  Enabled: false # Incompatible with Spec DSL.
+
+Minitest/NoTestCases:
+  Enabled: true

data/lib/rubocop/naming.yml

@@ -1,3 +1,6 @@
+Naming/InclusiveLanguage:
+  Enabled: true
+
 Naming/MethodParameterName:
   AllowedNames:
     - a

data/lib/rubocop/performance.yml

@@ -0,0 +1,17 @@
+Performance/ArraySemiInfiniteRangeSlice:
+  Enabled: true
+
+Performance/CaseWhenSplat:
+  Enabled: true
+
+Performance/ChainArrayAllocation:
+  Enabled: true
+
+Performance/IoReadlines:
+  Enabled: true
+
+Performance/OpenStruct:
+  Enabled: true
+
+Performance/SelectMap:
+  Enabled: true

data/lib/rubocop/rails.yml

@@ -0,0 +1,46 @@
+# While bulk changes can be useful, they shouldn't be required. Too much work
+# for little benefit.
+Rails/BulkChangeTable:
+  Enabled: false
+
+Rails/DefaultScope:
+  Enabled: true
+
+Rails/Delegate:
+  Enabled: false # We choose to never use `delegate`, instead.
+
+Rails/EnvironmentVariableAccess:
+  Enabled: true
+
+Rails/HasManyOrHasOneDependent:
+  Enabled: false # A :dependent option isn't always needed (e.g. Transactions).
+
+Rails/OrderById:
+  Enabled: true
+
+Rails/PluckId:
+  Enabled: true
+
+Rails/RequireDependency:
+  Enabled: true
+
+Rails/ReversibleMigrationMethodDefinition:
+  Enabled: true
+
+Rails/SaveBang:
+  Enabled: false
+
+Rails/SchemaComment:
+  Enabled: false
+
+Rails/SkipsModelValidations:
+  Enabled: false # Reconsider later.
+
+Rails/TableNameAssignment:
+  Enabled: true
+
+Rails/UniqBeforePluck:
+  EnforcedStyle: aggressive
+
+Rails/WhereExists:
+  EnforcedStyle: where

data/lib/rubocop/style.yml

@@ -1,6 +1,12 @@
 Style/Alias:
   EnforcedStyle: prefer_alias_method
 
+Style/ArrayFirstLast:
+  Enabled: false # Too many false positives.
+
+Style/AutoResourceCleanup:
+  Enabled: true
+
 Style/BlockDelimiters:
   EnforcedStyle: semantic
   AllowBracesOnProceduralOneLiners: true
@@ -37,6 +43,9 @@ Style/ClassAndModuleChildren:
   Exclude:
     - "test/**/*"
 
+Style/ClassMethodsDefinitions:
+  Enabled: true
+
 Style/CollectionMethods:
   Enabled: true
   PreferredMethods:
@@ -46,10 +55,19 @@ Style/CollectionMethods:
     detect: detect
     inject: inject
 
+Style/DateTime:
+  Enabled: true
+
+Style/DisableCopsWithinSourceCodeDirective:
+  Enabled: false
+
 Style/Documentation:
   Exclude:
     - "test/**/*"
 
+Style/DocumentationMethod:
+  Enabled: false
+
 Style/EmptyElse:
   Enabled: false # Including a comment in an empty else block shows intent.
 
@@ -63,12 +81,36 @@ Style/ExpandPathArguments:
 Style/FormatString:
   Enabled: false # % notation with an Array just reads better sometimes.
 
+Style/ImplicitRuntimeError:
+  Enabled: false
+
+Style/InlineComment:
+  Enabled: false
+
+Style/InvertibleUnlessCondition:
+  Enabled: true
+
+Style/IpAddresses:
+  Enabled: true
+
 Style/Lambda:
   EnforcedStyle: literal
 
 Style/LambdaCall:
   Enabled: false # Allow ServiceObject.(*). Only use on classes, not instances.
 
+Style/MethodCallWithArgsParentheses:
+  Enabled: false # Reconsider later.
+
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+Style/MissingElse:
+  Enabled: false
+
+Style/MultilineMethodSignature:
+  Enabled: false
+
 Style/NumericPredicate:
   AutoCorrect: true
 
@@ -76,6 +118,9 @@ Style/OpenStructUse:
   Exclude:
     - "test/**/*"
 
+Style/OptionHash:
+  Enabled: true
+
 Style/RegexpLiteral:
   EnforcedStyle: mixed
 
@@ -85,6 +130,18 @@ Style/RescueStandardError:
 Style/ReturnNil:
   Enabled: true
 
+Style/Send:
+  Enabled: true
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/StaticClass:
+  Enabled: true
+
+Style/StringHashKeys:
+  Enabled: false
+
 Style/StringMethods:
   Enabled: true
 
@@ -98,8 +155,20 @@ Style/StringLiterals:
 Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
 
+Style/TopLevelMethodDefinition:
+  Enabled: false
+
 Style/TrailingCommaInArrayLiteral:
   EnforcedStyleForMultiline: comma
 
+Style/TrailingCommaInBlockArgs:
+  Enabled: false
+
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: comma
+
+Style/UnlessLogicalOperators:
+  Enabled: true
+
+Style/YodaExpression:
+  Enabled: true

data/lib/tasks/{Rakefile → util.rake}

@@ -1,18 +1,5 @@
 # frozen_string_literal: true
 
-# FIXME: How to do relative path loading (from a child gem context)?
-spec = Gem::Specification.find_by_name("gemwork")
-Dir.glob("#{spec.gem_dir}/lib/tasks/*.rake").each { |r| load r }
-
-task :default do
-  run_tasks(%i[
-    test
-    rubocop
-    reek
-    yard
-  ])
-end
-
 def run_tasks(tasks)
   tasks.each_with_index do |name, index|
     annotate_run(name) do

metadata

@@ -1,23 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: gemwork
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Paul DobbinSchmaltz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-07 00:00:00.000000000 Z
+date: 2024-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-reporters
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: much-stub
+  name: irb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: reek
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-minitest
+  name: much-stub
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rake
+  name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: debug
+  name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -165,7 +165,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: irb
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -179,13 +179,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -209,18 +209,23 @@ files:
 - lib/gemwork/test/support/spec_dsl.rb
 - lib/gemwork/version.rb
 - lib/reek/.reek.yml
+- lib/rubocop/.rubocop-gems.yml
+- lib/rubocop/.rubocop-rails.yml
 - lib/rubocop/.rubocop.yml
 - lib/rubocop/all_cops.yml
 - lib/rubocop/gemspec.yml
 - lib/rubocop/layout.yml
 - lib/rubocop/lint.yml
 - lib/rubocop/metrics.yml
+- lib/rubocop/minitest.yml
 - lib/rubocop/naming.yml
+- lib/rubocop/performance.yml
+- lib/rubocop/rails.yml
 - lib/rubocop/style.yml
-- lib/tasks/Rakefile
 - lib/tasks/reek.rake
 - lib/tasks/rubocop.rake
 - lib/tasks/test.rake
+- lib/tasks/util.rake
 - lib/tasks/yard.rake
 homepage: https://github.com/pdobb/gemwork
 licenses:
@@ -246,7 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: Common gem framework code used by pdobb's Ruby Gems.