rubocop-bridgetown 0.3.2 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 672cf19d93df420e0b5d39013347e57bf618ee8b9eb6fa013b90f0dcfd3bd66a
-  data.tar.gz: 9ec8303b15642fe57854420562d7e5df529508fa24127b2a9a64863b85d813b0
+  metadata.gz: c1c55c379762ea7310036dd92c1c6133257af4b161e3ad41d722e2acded33082
+  data.tar.gz: 464b333e864028797b1975bbc21edb685043faf6449536190f05f163910a1bf4
 SHA512:
-  metadata.gz: 3af8850965db58dccaa35502531234da7ebca8f71a0c65feaae764102a43777885de64ede24eec274670f05592d8c5bba25b13d8b58ad574054de970e624a2a8
-  data.tar.gz: f324c2c2763e064ab1529842bfb7ae31b5dedbc38be2dae4624ea2518b5d9a56d45bd95c901116a03742cdad3bd0fb5aff05ea049a615659cbca7939b5e7cc16
+  metadata.gz: '094a43e9ab0e00667fe83e775bf9bc85a487df3308bcdc1692dbded1c3fe94599c9a278f0d6a283e4a4cc8da7db7af0fe2e1a688196b3816071b777330400ac9'
+  data.tar.gz: 2870d7b4a58f7ab628978dcc3ed4e4ecebb1f37ca0e003e670d69764fd61ba3161224234e9312c5c1527b20226723fee958fa65609c084b422aaecb86abf1186

data/README.md

@@ -1,10 +1,9 @@
-# RuboCop Bridgetown
+# RuboCop: Bridgetown
 
-A RuboCop extension to enforce a common code style in the Bridgetown ecosystem and beyond.
+A [RuboCop](https://rubocop.org/) extension to enforce a common code style in the Bridgetown ecosystem and beyond.
 
 ![Gem Version](https://img.shields.io/gem/v/rubocop-bridgetown.svg?label=Latest%20Release)
-![RuboCop Support](https://img.shields.io/badge/Rubocop%20Support-1.22.0-green.svg)
-
+![RuboCop Support](https://img.shields.io/badge/Rubocop%20Support-1.23.0-green.svg)
 
 ## Installation
 
@@ -13,13 +12,17 @@ Just add the `rubocop-bridgetown` gem to your Gemfile.
 ```ruby
 # Gemfile
 
-gem "rubocop-bridgetown", "~> 0.3"
+gem "rubocop-bridgetown", "~> 0.4"
 ```
+
+or if you're developing another gem:
+
 ```ruby
 # <plugin>.gemspec
 
-spec.add_development_dependency "rubocop-bridgetown", "~> 0.3"
+spec.add_development_dependency "rubocop-bridgetown", "~> 0.4"
 ```
+
 and run `bundle install`
 
 ## Usage
@@ -65,4 +68,12 @@ AllCops:
 
 ## Customization
 
-You can override any settings inherited from the extension by subsequently redefining the concerned parameters.
+You can override any settings inherited from the extension by configuring cops in your `.rubocop.yml`.
+
+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/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`.

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Bridgetown
+      class HTMLEscapedHeredoc < Cop
+        include Heredoc
+
+        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)[ \-\(])%)
+
+          add_offense(node, message: MSG)
+        end
+
+        private
+
+        def heredoc_body(node)
+          node.loc.heredoc_body.source
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-bridgetown
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.1
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-25 00:00:00.000000000 Z
+date: 2023-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -78,6 +78,7 @@ files:
 - LICENSE
 - README.md
 - lib/rubocop-bridgetown.rb
+- lib/rubocop/cop/bridgetown/html_escaped_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
@@ -99,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Code style check for Bridgetown projects