rubocop-bridgetown 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1c55c379762ea7310036dd92c1c6133257af4b161e3ad41d722e2acded33082
-  data.tar.gz: 464b333e864028797b1975bbc21edb685043faf6449536190f05f163910a1bf4
+  metadata.gz: 77d5770855e6106a4b722873f8e11e505997617642aa247f5e3629a9e55a66a5
+  data.tar.gz: 006da9d177a2812008ddaf7f50cd39beb42d21b301f98e9da11452e1bd575685
 SHA512:
-  metadata.gz: '094a43e9ab0e00667fe83e775bf9bc85a487df3308bcdc1692dbded1c3fe94599c9a278f0d6a283e4a4cc8da7db7af0fe2e1a688196b3816071b777330400ac9'
-  data.tar.gz: 2870d7b4a58f7ab628978dcc3ed4e4ecebb1f37ca0e003e670d69764fd61ba3161224234e9312c5c1527b20226723fee958fa65609c084b422aaecb86abf1186
+  metadata.gz: 9e9ce63f05136e486de72593361f48479e450ea3894608e2104b2f98d1092ee7c0927a8512034010d8f720ea07c735e0ada0eea7021767a6b254277144ac0656
+  data.tar.gz: 690b96fa2e93606e1c9b3ea9a7a2d0d17e79046782397f5947595909df80e6d3a5e447659a3dd2464a9a67cd14e0a196ee0a44b82a89bada119f984ae87317fa

data/.rubocop.yml

@@ -2,7 +2,7 @@ require:
   - rubocop-performance
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 3.1
   NewCops: enable
   SuggestExtensions: false
   Exclude:
@@ -26,6 +26,8 @@ Layout/HashAlignment:
   EnforcedHashRocketStyle: table
 Layout/IndentationWidth:
   Severity: error
+Layout/LeadingCommentSpace:
+  Enabled: false
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
 Layout/MultilineOperationIndentation:
@@ -73,12 +75,14 @@ Style/Lambda:
   EnforcedStyle: literal
 Style/LambdaCall:
   Enabled: false
+Style/MixinGrouping:
+  Enabled: false
 Style/ModuleFunction:
   Enabled: false
 Style/MultilineBlockChain:
   Enabled: false
 Style/MultilineTernaryOperator:
-  Severity: error
+  Enabled: false
 Style/ParallelAssignment:
   Enabled: false
 Style/PercentLiteralDelimiters:

data/README.md

@@ -40,6 +40,8 @@ inherit_gem:
 
 Running `bundle exec rubocop` will now automatically load the `rubocop-bridgetown` cops together with the standard cops.
 
+**Note:** if you want just the extra cops from this gem such as `Bridgetown/HTMLEscapedHeredoc` but wish to use your own configuration otherwise, you can omit the `inherit_gem` section entirely.
+
 You can also add a `rubocop` task to your `Rakefile`.
 
 ```ruby
@@ -72,8 +74,10 @@ You can override any settings inherited from the extension by configuring cops i
 
 Besides cops which are provided directly by RuboCop and `rubocop-performance`, there are a few additional cops provided by this plugin:
 
-* `Bridgetown/HTMLEscapedHeredoc`: this will monitor any heredocs in your code for potential XSS issues inside of any string interpolations. To avoid linting errors, you will need to wrap any interpolated code inside of one of the following method names: `html`, `html_map`, `html_attributes`, `text`, or `render`. These methods are provided by the [Streamlined](https://github.com/bridgetownrb/streamlined) gem, bundled in Bridgetown 1.4 by default (but you can use them in any Ruby application including Rails).
+* `Bridgetown/InsecureHeredoc`: this will monitor any heredocs in your code starting with `HTML` or `MARKDOWN` for potential XSS issues inside of any string interpolations. To avoid linting errors, you will need to wrap any interpolated code in the string with one of the following method names: `html`, `html_map`, `html_attributes`, `text`, or `render`. These methods are provided by the [Streamlined](https://github.com/bridgetownrb/streamlined) gem, bundled in Bridgetown 2.0 by default (but you can use them in any Ruby application including Rails).
 * `Bridgetown/NoPAllowed`: this encourages using your framework's logger rather than `p` to output debugging information.
 * `Bridgetown/NoPutsAllowed`: this encourages using your framework's logger rather than `puts` to output debugging information.
 
 You can disable any of these cops in specific parts of your codebase as needed, or by setting `Enabled: false` for any particular cop in your `.rubocop.yml`.
+
+Regarding recommended Streamlined syntax, you may want to exclude `Layout/SpaceBeforeFirstArg` and `Layout/SpaceBeforeBlockBraces` in the folders you write Streamlined components and helpers. This is so you can write `text->{ ... }`, `html->{ ... }`, etc. (Otherwise RuboCop will require you to write `text -> { ... }`, etc. which is more verbose.)

data/lib/rubocop/cop/bridgetown/{html_escaped_heredoc.rb → insecure_heredoc.rb}

@@ -3,14 +3,17 @@
 module RuboCop
   module Cop
     module Bridgetown
-      class HTMLEscapedHeredoc < Cop
+      class InsecureHeredoc < Base
         include Heredoc
 
-        MSG = "Insecure heredoc detected. Use `html`, `html_map`, `html_attributes`, `text`, or `render` inside interpolations."
+        MSG = "Insecure heredoc detected. Use `html`, `html_map`, `html_attributes`, `text`, " \
+              "or `render` inside interpolations."
 
         def on_heredoc(node)
           return unless node.source.match?(%r!(HTML|MARKDOWN)$!) &&
-            heredoc_body(node).match?(%r%[^\\]#\{(?!\s*?(html|html_map|html_attributes|text|render)[ \-\(])%)
+            heredoc_body(node).match?(
+              %r%[^\\]#\{(?!\s*?(html|html_map|html_attributes|text|render)[ \-\(])%
+            )
 
           add_offense(node, message: MSG)
         end

data/lib/rubocop/cop/bridgetown/no_p_allowed.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Bridgetown
-      class NoPAllowed < Cop
+      class NoPAllowed < Base
         MSG = "Avoid using `p` to print things. Use `Bridgetown.logger` instead."
 
         def_node_search :p_called?, "(send _ :p _)"

data/lib/rubocop/cop/bridgetown/no_puts_allowed.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Bridgetown
-      class NoPutsAllowed < Cop
+      class NoPutsAllowed < Base
         MSG = "Avoid using `puts` to print things. Use `Bridgetown.logger` instead."
 
         def_node_search :puts_called?, "(send nil? :puts _)"

data/lib/rubocop-bridgetown.rb

@@ -3,4 +3,4 @@
 require "rubocop"
 
 path_to_cops = File.join(File.expand_path("rubocop", __dir__), "cop", "**", "*.rb")
-Dir[path_to_cops].sort.each { |cop| require cop }
+Dir[path_to_cops].each { |cop| require cop }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-bridgetown
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-11 00:00:00.000000000 Z
+date: 2024-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -38,36 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.12'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
-description: A RuboCop extension to enforce common code style in Bridgetown projects
-  and beyond
+description: A RuboCop extension to enforce common code style in Bridgetown and beyond
 email:
 - maintainers@bridgetownrb.com
 executables: []
@@ -78,13 +49,14 @@ files:
 - LICENSE
 - README.md
 - lib/rubocop-bridgetown.rb
-- lib/rubocop/cop/bridgetown/html_escaped_heredoc.rb
+- lib/rubocop/cop/bridgetown/insecure_heredoc.rb
 - lib/rubocop/cop/bridgetown/no_p_allowed.rb
 - lib/rubocop/cop/bridgetown/no_puts_allowed.rb
 homepage: https://github.com/bridgetownrb/rubocop-bridgetown
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -93,14 +65,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Code style check for Bridgetown projects