rubocop-erb 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df7883aaaa8cb83f5661b9edfcf74f12b6dc84bb89d135c518e7f78c6dee9068
-  data.tar.gz: 5f8686b18e1f199663fdf3b8efa455e765e2d5f6800a6e4d8366610212eb25a4
+  metadata.gz: 742cdbab5d75368c8a97e45b610809a11ee36a806b7a6eea84e85b9f5810cd9e
+  data.tar.gz: 10da21545ab9f73ada119f5cb2a54dda6e297bbc5660325fa098aa0e92c83787
 SHA512:
-  metadata.gz: 915462fa70d43cf062f9970c8ad0fa85f2f4249f26a0618204f8e5ff472e63ac934732c40ab87ddf5a49ceebf1b70b91b55a7cacf1aed0413370cede971eedaa
-  data.tar.gz: c669c6a2849482d58abe45de7012b324cfe8b68cefc7b551e64013d135013ac579017f40c4ef0d865c947b9f8cb91d96c04c63426bd1e83b500cf4bc942d8c91
+  metadata.gz: 585098a85e2b0d6c4b3cd286014a2f2e1578e6744241f3cc3f098f2533f6346268c3e207937f359385b882db3ec4e189d8d680b787d28839c98c72881dbb617d
+  data.tar.gz: 21cdb3c2918b0d01eee173e24dafbedde1340459e7c884ca7e62e3688e85b53faf576ac883753774738b9b9f7cc62c2901c21150af092b02a1e44492e0a90ab5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-erb (0.2.3)
+    rubocop-erb (0.3.0)
       better_html
       rubocop (~> 1.45)
 
@@ -20,7 +20,7 @@ GEM
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
-    better_html (2.0.1)
+    better_html (2.0.2)
       actionview (>= 6.0)
       activesupport (>= 6.0)
       ast (~> 2.0)
@@ -35,21 +35,23 @@ GEM
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
-    loofah (2.19.1)
+    loofah (2.21.3)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
+      nokogiri (>= 1.12.0)
     minitest (5.17.0)
-    nokogiri (1.14.2-x86_64-linux)
+    nokogiri (1.15.3-x86_64-linux)
       racc (~> 1.4)
     parallel (1.22.1)
     parser (3.2.0.0)
       ast (~> 2.4.1)
-    racc (1.6.2)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
+    racc (1.7.1)
+    rails-dom-testing (2.1.1)
+      activesupport (>= 5.0.0)
+      minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.5.0)
-      loofah (~> 2.19, >= 2.19.1)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.6.2)

data/README.md

@@ -33,7 +33,7 @@ Now you can use RuboCop also for ERB templates.
 ```
 $ bundle exec rubocop spec/fixtures/dummy.erb
 Inspecting 1 file
-E
+C
 
 Offenses:
 
@@ -46,14 +46,27 @@ spec/fixtures/dummy.erb:4:9: C: [Correctable] Style/ZeroLengthPredicate: Use !em
 spec/fixtures/dummy.erb:5:4: C: [Correctable] Style/NegatedIf: Favor unless over if for negative conditions.
 <% a if !b %>
    ^^^^^^^
-spec/fixtures/dummy.erb:7:11: E: Lint/Syntax: unexpected token $end
-(Using Ruby 2.6 parser; configure using TargetRubyVersion parameter, under AllCops)
+spec/fixtures/dummy.erb:7:7: C: [Correctable] Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.
 <% if "a" %>
+      ^^^
 
+1 file inspected, 4 offenses detected, 4 offenses autocorrectable
+```
+
+## Workaround
+
+As a known issue, there seems to be a problem with .rubocop_todo.yml overriding config/default.yml provided by rubocop-erb, so we recommend adding a workaround to your .rubocop.yml as shown below:
 
-1 file inspected, 4 offenses detected, 3 offenses autocorrectable
+```yaml
+inherit_from: .rubocop_todo.yml
+
+inherit_mode:
+  merge:
+    - Exclude
 ```
 
+See [#15](https://github.com/r7kamura/rubocop-erb/issues/15) for more details.
+
 ## Related projects
 
 - https://github.com/r7kamura/rubocop-haml

data/config/default.yml

@@ -75,6 +75,10 @@ Layout/IndentationWidth:
   Exclude:
     - '**/*.erb'
 
+Layout/LeadingEmptyLine:
+  Exclude:
+    - '**/*.erb'
+
 Layout/LineEndStringConcatenationIndentation:
   Exclude:
     - '**/*.erb'

data/lib/rubocop/erb/ruby_extractor.rb

@@ -44,8 +44,9 @@ module RuboCop
 
       # @return [Array<BetterHtml::AST::Node>]
       def erbs
-        root.descendants(:erb).reject do |erb|
-          erb.children.first&.type == :indicator && erb.children.first&.to_a&.first == '#'
+        root.descendants(:erb).reject do |node|
+          erb_node = ErbNode.new(node)
+          erb_node.comment? || erb_node.escape?
         end
       end
 
@@ -97,6 +98,37 @@ module RuboCop
       def template_source
         @processed_source.raw_source
       end
+
+      class ErbNode
+        # @param [BetterHtml::AST::Node] node
+        def initialize(node)
+          @node = node
+        end
+
+        # @return [Boolean]
+        def comment?
+          indicator == '#'
+        end
+
+        # @return [Boolean]
+        def escape?
+          indicator == '%'
+        end
+
+        private
+
+        # @return [BetterHtml::AST::Node, nil]
+        def first_child
+          @node.children.first
+        end
+
+        # @return [String, nil]
+        def indicator
+          return unless first_child&.type == :indicator
+
+          first_child&.to_a&.first
+        end
+      end
     end
   end
 end

data/lib/rubocop/erb/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Erb
-    VERSION = '0.2.3'
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-erb
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-16 00:00:00.000000000 Z
+date: 2023-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: better_html