gemwork 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38708064f9cfb725439f76ee56fd8499b011715d9f0b680ee348c23dccecc39b
-  data.tar.gz: 3c82b921d080cc8d132c178d0208ea41e8b350411db2dc78b7b91cda366640eb
+  metadata.gz: c91820eba811f86523e00689d992d8c1cc0e350590a523c2aa81e428b48ce71c
+  data.tar.gz: 9dc933263f0566026a1d619fa27e81fb63bd3226f16b497ac9b02af0f96bc420
 SHA512:
-  metadata.gz: fb3eb1f200f1f9c4c571533486f5bbd2b5c1cad01442e81a7b93e0d5731c7c1833907bd80802fdc96a66e0116f9f482a563d7a395e58fcd0bf3ddf54edaa6c8e
-  data.tar.gz: 6483af59bd3df0cc83bb5403329dfaa171cecb8ad5ec59d5323d1d6b7bf3511cec08196fd17d9d78c8e5b3a8ec7895121ef3b56b610779dadefe09f48bd337f7
+  metadata.gz: 5de44ccbd9ac0866f7e23d2b41113fbc64c8408004b83eb502ab98a05472d416dc3bdd111f5bb326be3a8fd03be8a70c1503a880c9e37e2fe6fdfbb1f0cc3f0a
+  data.tar.gz: 30f7ae391a501f736752981febc7b20af556dbee1f99f89103bacf173d130f0c8278ad2b8f8615bc770944bbf5d6d1baa703c0765f0546f14dff1c924f2abd23

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.6.0] - 2024-10-9
+
+- Update RuboCop Styles, especially for Rails projects
+- Add Rake tasks for: `eslint` and `prettier`
+
 ## [0.5.3] - 2024-9-1
 
 - Fix `MuchStub.unstub!` to actually run after ActiveSupport::TestCase test cases

data/README.md

@@ -58,7 +58,7 @@ Running `rake -T` after this will reveal the additional tasks defined by Gemwork
 
 ### 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`.
+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 `eslint`, `prettier`, and `test:system`.
 
 ```ruby
 # frozen_string_literal: true
@@ -70,7 +70,7 @@ 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}.rake")) do |task|
+    join("lib", "tasks", "{util,rubocop,reek,eslint,prettier}.rake")) do |task|
   load(task)
 end
 
@@ -81,12 +81,15 @@ task :default do
     test
     rubocop
     reek
+    eslint
+    prettier
     test:system
   ])
 end
 ```
 
-## Rubocop Integration
+## RuboCop Integration
+
 ### Simple Usage
 
 Add the following to the `.rubocop.yml` file in your gem:
@@ -120,7 +123,7 @@ The above (simple usage) will automatically includes all RuboCop configuration s
 ```yaml
 # .rubocop.yml
 
-# Load Rubocop plugins.
+# Load RuboCop plugins.
 require:
   - rubocop-rake
   - rubocop-minitest
@@ -151,7 +154,7 @@ See also: [RuboCop's Configuration Guide on Inheritance](https://github.com/rubo
 ```yaml
 # .rubocop.yml
 
-# Load Rubocop plugins.
+# Load RuboCop plugins.
 require:
   - rubocop-capybara
   - rubocop-minitest
@@ -179,11 +182,14 @@ AllCops:
     - bin/bundle
 ```
 
+## Reek
+
+The reek gem doesn't support config files integration. But recommended starting configs have been placed in [lib/reek/](https://github.com/pdobb/gemwork/blob/master/lib/reek). One for gems and one for Rails projects.
+
 ## 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.
 
-
 ```ruby
 # frozen_string_literal: true
 
@@ -201,24 +207,82 @@ require "gemwork/test/support/spec_dsl"
 # ...
 ```
 
+## Other Setup
+
+### Rails
+
+For a Rails app, additional configuration may be desired to improve linter support.
+
+#### eslint
+
+The below fixes eslint linting errors in Rails (7+, ...) projects.
+
+```json
+// .eslintrc.json
+
+{
+  "env": {
+    "browser": true,
+    "es2021": true
+  },
+  "extends": ["eslint:recommended", "plugin:prettier/recommended"],
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "overrides": [
+    {
+      "files": ["config/tailwind.config.js"],
+      "env": {
+        "node": true
+      },
+      "rules": {
+        "no-unused-vars": ["error", { "varsIgnorePattern": "defaultTheme" }]
+      }
+    }
+  ]
+}
+```
+
+#### prettier
+
+General config recommendations for prettier:
+
+```
+# .prettierignore
+
+vendor
+```
+
+```json
+// .prettierrc.json
+
+{
+  "semi": false
+}
+```
+
 ## Gem Dependencies
 
 Gemwork depends on the following gems. None of these are actually used by Gemwork, itself, but are included for use by child gems. This is meant to ease dependency management for child gems as these things evolve over time.
 
 #### Unit Testing
+
 - [minitest](https://github.com/minitest/minitest)
 - [minitest-reporters](https://github.com/minitest-reporters/minitest-reporters) -- Create customizable MiniTest output formats.
 - [much-stub](https://github.com/redding/much-stub) -- Stubbing API for replacing method calls on objects in test runs.
 - [simplecov](https://github.com/simplecov-ruby/simplecov) -- Code coverage for Ruby.
 
 #### Linters
+
 - [reek](https://github.com/troessner/reek) -- Code smell detector for Ruby.
-- [rubocop](https://github.com/rubocop/rubocop)  -- A Ruby static code analyzer and formatter, based on the community Ruby style guide.
+- [rubocop](https://github.com/rubocop/rubocop) -- A Ruby static code analyzer and formatter, based on the community Ruby style guide.
 - [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
@@ -226,6 +290,7 @@ Gemwork depends on the following gems. None of these are actually used by Gemwor
 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.
 
@@ -260,6 +325,25 @@ With the above, you can opt in to using a locally built and installed Gemwork ge
 REBUILD_GEMWORK=1 bin/setup
 ```
 
+### Testing
+
+To test this gem (gemwork):
+
+```bash
+rake
+```
+
+#### Linters
+
+```bash
+rubocop
+
+reek
+
+npx prettier . --check
+npx prettier . --write
+```
+
 ### Releases
 
 To release a new version of Gemwork to RubyGems:

data/lib/gemwork/version.rb

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

data/lib/reek/.reek-rails.yml

@@ -0,0 +1,51 @@
+detectors:
+  DuplicateMethodCall:
+    allow_calls:
+      - self.class
+  UncommunicativeVariableName:
+    accept:
+      - _
+  UnusedPrivateMethod:
+    enabled: false # Disabled by default.
+  UtilityFunction:
+    public_methods_only: true # Disabled by default.
+
+directories:
+  app/channels/application_cable:
+    IrresponsibleModule:
+      enabled: false
+  app/controllers:
+    IrresponsibleModule:
+      enabled: false
+  app/helpers:
+    IrresponsibleModule:
+      enabled: false
+    UtilityFunction:
+      enabled: false
+    LongParameterList:
+      enabled: false
+  app/jobs:
+    IrresponsibleModule:
+      enabled: false
+    UtilityFunction:
+      enabled: false
+  app/mailers:
+    IrresponsibleModule:
+      enabled: false
+  app/views: # If using View Models.
+    IrresponsibleModule:
+      enabled: false
+    TooManyMethods:
+      enabled: false
+    UtilityFunction:
+      enabled: false
+  test:
+    IrresponsibleModule:
+      enabled: false
+    UtilityFunction:
+      enabled: false
+
+exclude_paths:
+  - db/migrate/*
+  - test/**/*
+  - lib/templates/**/*

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

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

data/lib/rubocop/all_cops-rails.yml

@@ -0,0 +1,17 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  ExtraDetails: true
+  NewCops: enable
+  TargetRubyVersion: 3.3
+  UseCache: true
+  Exclude:
+    # Rubocop Defaults
+    - "node_modules/**/*"
+    - "tmp/**/*"
+    - "vendor/**/*"
+    - ".git/**/*"
+    # Custom additions
+    - bin/bundle
+    - db/schema.rb
+    - lib/templates/**/*

data/lib/rubocop/layout-rails.yml

@@ -0,0 +1,4 @@
+Layout/LineLength:
+  Exclude:
+    - Gemfile
+    - config/environments/*.rb

data/lib/rubocop/metrics-rails.yml

@@ -0,0 +1,14 @@
+Metrics/AbcSize:
+  Exclude:
+    - db/migrate/*.rb
+
+Metrics/MethodLength:
+  Exclude:
+    - db/migrate/*.rb
+
+Metrics/BlockLength:
+  Exclude:
+    - config/environments/*.rb
+    - config/routes.rb
+    - db/migrate/*.rb
+    - test/**/*

data/lib/rubocop/rails.yml

@@ -1,5 +1,8 @@
 # While bulk changes can be useful, they shouldn't be required. Too much work
 # for little benefit.
+Rails/ActionOrder:
+  ExpectedOrder: [index, show, new, create, edit, update, destroy]
+
 Rails/BulkChangeTable:
   Enabled: false
 
@@ -18,6 +21,10 @@ Rails/HasManyOrHasOneDependent:
 Rails/OrderById:
   Enabled: true
 
+Rails/Output:
+  Exclude:
+    - db/seeds.rb
+
 Rails/PluckId:
   Enabled: true
 
@@ -44,3 +51,5 @@ Rails/UniqBeforePluck:
 
 Rails/WhereExists:
   EnforcedStyle: where
+  Exclude:
+    - test/**/*

data/lib/rubocop/style-rails.yml

@@ -0,0 +1,14 @@
+Style/Documentation:
+  Exclude:
+    - app/controllers/**/*
+    - app/helpers/**/*
+    - app/jobs/**/*
+    - app/mailers/**/*
+    - app/models/concerns/**/*
+    - db/**/*
+    - test/**/*
+
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - config.ru
+    - bin/*

data/lib/rubocop/style.yml

@@ -81,6 +81,13 @@ Style/ExpandPathArguments:
 Style/FormatString:
   Enabled: false # % notation with an Array just reads better sometimes.
 
+Style/GuardClause:
+  AllowConsecutiveConditionals: true
+
+Style/HashAsLastArrayItem:
+  Exclude:
+    - test/**/*
+
 Style/ImplicitRuntimeError:
   Enabled: false
 
@@ -155,6 +162,9 @@ Style/StringLiterals:
 Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
 
+Style/SymbolProc:
+  AllowMethodsWithArguments: true
+
 Style/TopLevelMethodDefinition:
   Enabled: false
 

data/lib/tasks/eslint.rake

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+desc "Run eslint on app/javascript/**/*.js"
+task :eslint do
+  command = "npx eslint app/javascript/**/*.js"
+  success = system(command)
+
+  if success
+    puts "\e[32m0 errors, 0 warnings\e[0m"
+  else
+    exit 1
+  end
+end

data/lib/tasks/prettier.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+desc "Run prettier on **/*.{js,yml,md}"
+task :prettier do
+  sh("npx prettier . --check")
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gemwork
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Paul DobbinSchmaltz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-01 00:00:00.000000000 Z
+date: 2024-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -202,26 +202,35 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- lib/.DS_Store
 - lib/gemwork.rb
+- lib/gemwork/.DS_Store
 - lib/gemwork/test/support/much_stub.rb
 - lib/gemwork/test/support/reporters.rb
 - lib/gemwork/test/support/simplecov.rb
 - lib/gemwork/test/support/spec_dsl.rb
 - lib/gemwork/version.rb
+- lib/reek/.reek-rails.yml
 - lib/reek/.reek.yml
 - lib/rubocop/.rubocop-gems.yml
 - lib/rubocop/.rubocop-rails.yml
 - lib/rubocop/.rubocop.yml
+- lib/rubocop/all_cops-rails.yml
 - lib/rubocop/all_cops.yml
 - lib/rubocop/gemspec.yml
+- lib/rubocop/layout-rails.yml
 - lib/rubocop/layout.yml
 - lib/rubocop/lint.yml
+- lib/rubocop/metrics-rails.yml
 - lib/rubocop/metrics.yml
 - lib/rubocop/minitest.yml
 - lib/rubocop/naming.yml
 - lib/rubocop/performance.yml
 - lib/rubocop/rails.yml
+- lib/rubocop/style-rails.yml
 - lib/rubocop/style.yml
+- lib/tasks/eslint.rake
+- lib/tasks/prettier.rake
 - lib/tasks/reek.rake
 - lib/tasks/rubocop.rake
 - lib/tasks/test.rake
@@ -251,7 +260,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: Common gem framework code used by pdobb's Ruby Gems.