Rubocop config tweaks and code fixes

Author: denny

lib/generators/shiny/plugin/plugin_generator.rb

@@ -78,7 +78,8 @@ def wrap_in_modules( unwrapped_code )
         unwrapped_code = unwrapped_code.to_s.strip.gsub( /\s$\n/, '' )
         modules.reverse.reduce( unwrapped_code ) do |content, mod|
           str = +"module #{mod}\n"
-          str << content.lines.collect { |line| "  #{line}" }.join
+          str << content.lines.collect { |line| "  #{line}" }
+                        .join
           str << ( content.present? ? "\nend" : 'end' )
         end
       end

plugins/ShinyCMS/.rubocop.yml

@@ -17,25 +17,31 @@ AllCops:
   NewCops: enable
   Exclude:
     # Not Ruby files (skipping these makes Rubocop run faster)
-    - ../../app/assets/**/*  # main_app
-    - ../*/app/assets/**/*   # plugins
+    ## Main app
     - ../../bin/*
     - ../../coverage/**/*
     - ../../docs/**/*
     - ../../log/*
     - ../../node_modules/**/*
     - ../../public/**/*
-    - ../../themes/**/*
     - ../../tmp/**/*
     - ../../tools/*
+    ## Plugins and Themes
+    - ../*/app/assets/**/*
+    - ../*/bin/*
+    - ../*/vendor/**/*
+    - ../../themes/**/*
     # Code autogenerated by ActiveRecord spectacularly fails RuboCop
-    - ../../db/schema.rb
-    - ../../db/archived-migrations/*
-    - ../../db/migrate/*    # main_app
-    - ../*/db/migrate/*.rb  # plugins
+    - ../../db/**/*      # main_app
+    - ../*/db/migrate/*  # plugins
     # RuboCop also hates this autogenerated data file
     - db/demo_site_data.rb
 
+# Turning this off for now; ideally this Gemfile would be mostly empty anyway
+Bundler/GemVersion:
+  Exclude:
+    - ../../Gemfile
+
 # These are mostly expected to contain long blocks due to their DSLs
 Metrics/BlockLength:
   Exclude:
@@ -50,14 +56,18 @@ Metrics/BlockLength:
 # Spec files with I18n.t calls have long lines. I can live with that.
 Layout/LineLength:
   Exclude:
-    - ../../spec/**/*.rb  # main_app
-    - ../*/spec/**/*.rb   # plugins
+    - ../*/spec/**/*.rb
 
 # This config file is easier to understand laid out as it is, not as this cop wants it
 Layout/MultilineArrayLineBreaks:
   Exclude:
     - config/initializers/html_sanitizer.rb
 
+# This looks really inconsistent next to `expect().to`
+Layout/SingleLineBlockChain:
+  Exclude:
+    - ../*/spec/**/*
+
 # This method is not useless - it allows user registrations to be feature-flagged
 Lint/UselessMethodDefinition:
   Exclude:
@@ -118,7 +128,7 @@ Rails/ApplicationController:
   Exclude:
     - app/public/controllers/shinycms/admin/tools/base_controller.rb
 
-# Allow read access to ENV
+# Allow read access to ENV, for now (but better config handling is on the TODO list)
 Rails/EnvironmentVariableAccess:
   AllowReads: true
 
@@ -145,10 +155,6 @@ RSpec/BeforeAfterAll:
     - spec/models/shinycms/theme_spec.rb
     - spec/support/faker.rb
 
-# Currently inclined to keep this approach, for readability etc
-RSpec/DescribedClassModuleWrapping:
-  Enabled: false
-
 # This is ignoring config/initializers/inflections.rb (as about half of Rails does)
 RSpec/FilePath:
   Exclude:
@@ -157,6 +163,8 @@ RSpec/FilePath:
 # Disabling these two for now (but open to discussion/persuasion on their merits)
 RSpec/ExampleLength:
   Enabled: false
+
+# A test should test one thing; it may take more than one expectation to do so (thoroughly)
 RSpec/MultipleExpectations:
   Enabled: false
 
@@ -242,6 +250,6 @@ Style/MissingElse:
 Style/Copyright:
   Enabled: false
 
-# Not every method needs a comment explaining what it does
+# Most methods already have names that explain what they do, they don't need a comment as well
 Style/DocumentationMethod:
   Enabled: false

plugins/ShinyCMS/.rubocop_todo.yml

@@ -4,12 +4,16 @@
 #
 # ShinyCMS is free software; you can redistribute it and/or modify it under the terms of the GPL (version 2 or later)
 
-# File created with `rubocop --auto-gen-config` on 2021-04-08 using RuboCop version 1.12.1
+# File created with `rubocop --auto-gen-config` on 2021-05-07 using RuboCop version 1.14.0
 #
 # Entries in this file should be removed as the offenses are removed from the code.
 #
 # This file should be regenerated whenever Rubocop is updated.
 
+# Offense count: 27
+RSpec/DescribedClassModuleWrapping:
+  Enabled: false
+
 # Offense count: 22
 RSpec/AnyInstance:
   Exclude:
@@ -19,7 +23,7 @@ RSpec/AnyInstance:
     - '../ShinyForms/spec/requests/shiny_forms/forms_controller_spec.rb'
     - '../ShinyLists/spec/requests/shiny_lists/subscriptions_controller_spec.rb'
 
-# Offense count: 129
+# Offense count: 140
 # Configuration parameters: AssignmentOnly.
 RSpec/InstanceVariable:
   Exclude:

plugins/ShinyCMS/app/models/concerns/shinycms/plugins_components.rb

@@ -31,11 +31,13 @@ def models_with_sitemap_items
       end
 
       def models_that_are( method )
-        💎ify[ with_models.collect { |plugin| plugin.models_that_are method }.flatten.sort_by( &:name ) ]
+        💎ify[ with_models.collect { |plugin| plugin.models_that_are method }
+                         .flatten.sort_by( &:name ) ]
       end
 
       def models_that_include( concern )
-        💎ify[ with_models.collect { |plugin| plugin.models_that_include concern }.flatten.sort_by( &:name ) ]
+        💎ify[ with_models.collect { |plugin| plugin.models_that_include concern }
+                         .flatten.sort_by( &:name ) ]
       end
     end
   end

plugins/ShinyCMS/app/models/shinycms/plugin.rb

@@ -54,7 +54,8 @@ def models_that_are( method )
     end
 
     def models_that_include( concern )
-      base_model.descendants.select { |model| model.include?( concern ) }.sort_by( &:name )
+      base_model.descendants.select { |model| model.include?( concern ) }
+                .sort_by( &:name )
     end
 
     def view_path

plugins/ShinyCMS/app/public/models/concerns/shinycms/has_template.rb

@@ -32,7 +32,8 @@ def add_elements
 
       # Returns a hash of all the elements for this item, to feed to render as local params
       def elements_hash
-        elements.collect { |element| [ element.name.to_sym, ( element.image.presence || element.content ) ] }.to_h
+        elements.collect { |element| [ element.name.to_sym, ( element.image.presence || element.content ) ] }
+                .to_h
       end
     end