erb-linter 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7852edfabee0e8808f79b8722b4256a3ddb37cd0d4dcd5581ebd4c505eeb7aca
-  data.tar.gz: 7988dbbceb52230a05fbb67a6ab638b37ea5eb068b1d6963b5fe278e66abdf66
+  metadata.gz: 44674209663a884ffa87821eea1396fdcfa779c67b7c1480c625b04111ffc645
+  data.tar.gz: f450b5dd3c9321c7f8854dcf68bb6dc38cf348b1cfab3c62b91fb73a6ebf5608
 SHA512:
-  metadata.gz: 39f296bfb232df44446f560f44e27ff8c67a4f9302fd64eb3f73005a35bf60de786c55d59a520e84fa08ac5c241ea5534b26d16ddcfba5d00847e34542651b70
-  data.tar.gz: f02389ff2ab6cfd34ff41596c26f93be8e8d2bec559a50c0978282e2de47997fae104ec59b498128ae27423531325d5e2750ccf0ae8ce92b01573dbd06b1e628
+  metadata.gz: 8a37692b76c98aa006fab462b58936a6b00cf4902a3badaf328406622267414abdd32a88c871bf742f10ce6a93793cf39b2239a9bfb55745a2c11a06edbcfc36
+  data.tar.gz: e14e4343a76cf0964e95ad73406a4e271be504ff1319096445778de58ddc2fa777e3638856650135ec6332f5b022d25382621f01d091009b6f7279fe4b0c0c4a

data/.github/workflows/test.yml

@@ -0,0 +1,26 @@
+on:
+  - push
+  - pull_request
+
+name: test
+
+jobs:
+  test:
+    name: "ruby ${{ matrix.ruby }}"
+
+    strategy:
+      matrix:
+        os: [ 'ubuntu-latest' ]
+        ruby: [ "3.0", "2.7", "2.6", "2.5" ]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Setup project
+        run: bin/setup
+      - name: Run test
+        run: bin/rake

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock

data/README.md

@@ -2,7 +2,9 @@
 
 <a href="https://nebulab.it?utm_source=github&utm_medium=badge"><img src="https://img.shields.io/static/v1?label=Nebulab&message=Open+Source&color=%235dbefd&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABwAAAAcCAYAAAByDd+UAAAACXBIWXMAABYlAAAWJQFJUiTwAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAMQSURBVHgBrZZNTxNRFIbfczsgIMQiLBCRFDaGhUr9A9iiIa5EEneIwE/AlRsNv8KlIKwFl35RTUBX8rFBdiVKAgqmXSCY0M71nJl+zJTOdKh9k6Yzc8/cZ86555x7CQE0mji5hSyGlQoNaOgIPwrnhtIArWszu4EQFudjdR8rzUV+gw8/ZMZB9IwvIwimJJGafhmjWZwFOJ7QkYzWCwTdj+qUDJGKz8Rou3RAlT4YS+hHWW2u/QdM1MNzrI6+zwyXDrg8FANStIDaSXOIJ5whLgAljOIZiglRK6U4vDfz4S2ElGGJWsEaQkCTUbhtNbV+lb+xgFY2Bs9ET0h/GzBxlfAkqnCUKY5xKfVLbsi1/R126lcF6WgCYp2ES42EBp6tvQFY+alLTUlrUxizJEVNWiVwBkVagGg7oe+CDclLYOfrgMdfTBz8PfWa1lkzbsDEsH/5FyF9YUK0zQ1xwpoZtsm9pwxMRLyA9wyi0A2Jcjl1NNqeeEFEimxYPkmWd014ikIDnDTeBb53DOweaRxnvWGyhnmYfPZWGt487sNi6lsK67/lZ1oZGOtUaD3nhtU7etXXfe0VzrzCBgLKCR68rNDX6oaJlvd0xXnklbSfgSTL/QghXF8EP980cVKyVL/Ys9UDVFJa8Tdt+1lYmcmJM3Vd4UEvWeslRf32h9ubrVRl77gBrCto85OfUU+LXTMGx+JuN2Hoin3/Zkfjj6ObBAknV+KG4jpc9BqXMEpiCMz6Z9ZQ12kvJZxb6co4Zr1W83esY8F2OYsIe+eEyfTiVXczCl7uM2wliHfMEJaRc3Wa++mLUotrF4EW7h6f94Dvh6aVFM60Fy8Xkya+BfBOjh5yUWhqY0vmKi9q1GnVxZ7sHKIWSs7FQ71yUagkRTTCfymnVY1gsgHHC5z8hbUjaz0Fr8ZanXhX0pPOw5SrV8wNGjNscMrTKpXKaj05f9twVYHnMZGPHEuwTwEBNi+3NGiNt6GRcsfEIAfhp2cAV3cQLtXoOz7q8+ZJRLx3kmxn4dy7aas1SrfiBpKraV/9A+PSJLDAXLUvAAAAAElFTkSuQmCC"></a>
 
-It's all to easy to introduce errors inside ERB files, unclosed tags, wrong attribute names, bad indentation.
+[![test](https://github.com/nebulab/erb-linter/actions/workflows/test.yml/badge.svg)](https://github.com/nebulab/erb-linter/actions/workflows/test.yml)
+
+It's all too easy to introduce errors inside ERB files, unclosed tags, wrong attribute names, bad indentation.
 
 ERB::Linter can check for those errors by turning your ERB tags into HTML-ish tags and run a proper HTML linter on the result:
 
@@ -45,13 +47,9 @@ Add this line to your application's Gemfile:
 gem 'erb-linter'
 ```
 
-And then execute:
-
-    $ bundle install
+And add `linthtml` to yarn:
 
-Or install it yourself as:
-
-    $ gem install erb-linter
+    $ yarn add --dev @linthtml/linthtml
 
 ## Usage
 
@@ -81,7 +79,9 @@ ERB::Linter::Task.new do |task|
 end
 ```
 
-Add a `linthtml` configuration:
+### Example linthtml configuration
+
+And then add a `linthtml` configuration like this:
 
 `.linthtmlrc.js`
 

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/lib/erb/linter.rb

@@ -3,7 +3,7 @@
 require "erb"
 
 module ERB::Linter
-  VERSION = "0.0.1"
+  VERSION = "0.2.0"
 
   class Error < StandardError; end
 

data/lib/erb/linter/converter.rb

@@ -2,43 +2,82 @@
 
 require "cgi"
 require "ripper"
+require 'securerandom'
+require 'strscan'
 
 module ERB::Linter::Converter
   extend self
 
-  # Credit to the Deface gem
+  # https://stackoverflow.com/a/317081
+  ATTR_NAME = %r{[^\r\n\t\f\v= '"<>]*[^\r\n\t\f\v= '"<>/]} # not ending with a slash
+  UNQUOTED_VALUE = ATTR_NAME
+  UNQUOTED_ATTR = %r{#{ATTR_NAME}=#{UNQUOTED_VALUE}}
+  SINGLE_QUOTE_ATTR = %r{(?:#{ATTR_NAME}='[^']*')}
+  DOUBLE_QUOTE_ATTR = %r{(?:#{ATTR_NAME}="[^"]*")}
+
+  ERB_TAG = %r{<%.*?%>}
+  HTML_ATTR = %r{\s+#{SINGLE_QUOTE_ATTR}|\s+#{DOUBLE_QUOTE_ATTR}|\s+#{UNQUOTED_ATTR}|\s+#{ATTR_NAME}}
+  HTML_TAG = %r{(<\w+)((?:#{HTML_ATTR})*)(\s*)(/>|>)}m
+
+  # (credit goes to the Deface gem for the original implementation)
   def erb2html(source)
     source = +source
 
-    # all opening html tags that contain <% %> blocks
-    source.scan(/<\w+[^<>]+(?:<%.*?%>[^<>]*)+/m).each do |line|
-      # regexs to catch <% %> inside attributes id="<% something %>" - with double, single or no quotes
-      erb_attrs_regexs = [
-        /([\w-]+)(\s?=\s?)(")([^"]*<%.*?%>[^"]*)/m,
-        /([\w-]+)(\s?=\s?)(')([^']*<%.*?%>[^']*)'/m,
-        /([\w-]+)(\s?=\s?)()(<%.*?%>)(?:\s|>|\z)/m,
-      ]
-
-      # rubocop:disable Linter/ShadowingOuterLocalVariable
-      replace_line = erb_attrs_regexs.inject(line.clone) do |replace_line, regex|
-        replace_line = line.scan(regex).inject(replace_line) do |replace_line, match|
-          replace_line.sub("#{match[0]}#{match[1]}#{match[2]}#{match[3]}#{match[2]}") { "data-erb-#{match[0]}=\"#{CGI.escapeHTML(match[3])}\"" }
-        end
+    # encode all erb tags so that the HTML looks valid
+    erb_tags = {}
+    source.gsub!(ERB_TAG) do |tag|
+      uid = ["ERB_", SecureRandom.uuid].join.delete('-')
+      erb_tags[uid] = tag
+      uid
+    end
 
-        replace_line
-      end
-      # rubocop:enable Linter/ShadowingOuterLocalVariable
+    erb_tags_matcher = Regexp.union(erb_tags.keys)
+
+    # transform/escape all the erb-attributes first
+    source.gsub!(HTML_TAG).each do |match|
+      line = Regexp.last_match.to_a[1..-1]
+      tag = [line[0], line[2]+line[3]]
+
+      # scan each attribute into an array
+      attr_scanner = StringScanner.new(line[1])
+      attributes = []
+      attributes << (attr_scanner.scan(HTML_ATTR) or raise "Can't scan: #{attr_scanner.string}") until attr_scanner.eos?
+      # attributes.compact!
 
       i = -1
+      attributes.map! do |attribute|
+        if attribute.match?(erb_tags_matcher)
+          space, attribute = attribute.scan(/\A(\s+)(.*)\z/m).flatten
+          attribute.gsub!(erb_tags_matcher, erb_tags)
+
+          attribute =
+            case attribute
+            when /\A#{ERB_TAG}\z/
+              %{data-erb-#{i += 1}="#{CGI.escapeHTML(attribute)}"}
+            when /\A#{ATTR_NAME}=/
+              name, value = attribute.split("=", 2)
+              quote = '"'
+              if value.match(/\A['"]/)
+                quote = value[0]
+                value = value[1...-1]
+              end
+              %{data-erb-#{name}=#{quote}#{CGI.escapeHTML(value)}#{quote}}
+            else
+              raise "Don't know how to process attribute: #{attribute.inspect}"
+            end
 
-      # catch all <% %> inside tags id <p <%= test %>> , not inside attrs
-      replace_line.scan(/(<%.*?%>)/m).each do |match|
-        replace_line.sub!(match[0], " data-erb-#{i += 1}=\"#{CGI.escapeHTML(match[0])}\"")
+          "#{space}#{attribute}"
+        else
+          attribute
+        end
       end
 
-      source.sub!(line, replace_line)
+      [tag[0], *attributes, tag[1]].join
     end
 
+    # restore the encoded erb tags
+    source.gsub!(erb_tags_matcher, erb_tags)
+
     # replaces all <% %> not inside opening html tags
     replacements = [
       { %r{<%\s*end\s*-?%>} => "</erb>" },

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erb-linter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Elia Schito
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-31 00:00:00.000000000 Z
+date: 2021-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -31,13 +31,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
+- bin/rake
 - bin/setup
 - erb-linter.gemspec
 - lib/erb/linter.rb

data/Gemfile.lock

@@ -1,22 +0,0 @@
-PATH
-  remote: .
-  specs:
-    erb-linter (0.0.1)
-      rake
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    minitest (5.14.4)
-    rake (13.0.3)
-
-PLATFORMS
-  x86_64-darwin-20
-
-DEPENDENCIES
-  erb-linter!
-  minitest (~> 5.0)
-  rake (~> 13.0)
-
-BUNDLED WITH
-   2.2.3