erb-linter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7852edfabee0e8808f79b8722b4256a3ddb37cd0d4dcd5581ebd4c505eeb7aca
+  data.tar.gz: 7988dbbceb52230a05fbb67a6ab638b37ea5eb068b1d6963b5fe278e66abdf66
+SHA512:
+  metadata.gz: 39f296bfb232df44446f560f44e27ff8c67a4f9302fd64eb3f73005a35bf60de786c55d59a520e84fa08ac5c241ea5534b26d16ddcfba5d00847e34542651b70
+  data.tar.gz: f02389ff2ab6cfd34ff41596c26f93be8e8d2bec559a50c0978282e2de47997fae104ec59b498128ae27423531325d5e2750ccf0ae8ce92b01573dbd06b1e628

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in erb-linter.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,22 @@
+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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Nebulab srls
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,171 @@
+# ERB::Linter
+
+<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.
+
+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:
+
+*original ERB*
+
+```erb
+<div>
+  <% if @foo == :bar %>
+    <%= image_tag(item[:value], alt: item[:value]) %>
+  <% elsif @type == :other %>
+    <span><%= item[:value] %></span>
+  <% else %>
+    <% raise "unknown type" %>
+  <% end %>
+</div>
+```
+
+*generated HTML, for linter consumption*
+
+```html
+<div>
+  <erb silent erb-code=" if @foo == :bar ">
+    <erb loud erb-code=" image_tag(item[:value], alt: item[:value]) "></erb>
+  </erb>
+  <erb silent erb-code=" elsif @type == :other ">
+    <span><erb loud erb-code=" item[:value] "></erb></span>
+  </erb>
+  <erb silent erb-code=" else ">
+    <erb silent erb-code=" raise &quot;unknown type&quot; "></erb>
+  </erb>
+</div>
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'erb-linter'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install erb-linter
+
+## Usage
+
+### From the command line
+
+```bash
+ruby -rbundler/setup -rerb/linter -e "exit ERB::Linter::Checker.check_files('app/views/**/*.html.erb')"
+```
+
+### As a Rake task
+
+Add a task to your Rakefile:
+
+```ruby
+ERB::Linter::Task.new do |task|
+  # Change the task name.
+  # Default: :erb_linter
+  # task.name = 'linter:html'
+
+  # Use a different glob for listing ERB files.
+  # Default: '**/*.erb'
+  # task.glob = 'app/components/**/*.html.erb'
+
+  # Use a different temp dir for storing the HTML version of your ERB files.
+  # Default: Dir.tmpdir
+  # task.tmpdir = Rails.root.join('tmp')
+end
+```
+
+Add a `linthtml` configuration:
+
+`.linthtmlrc.js`
+
+```js
+module.exports = {
+  maxerr: false,
+  "raw-ignore-regex": false,
+  "attr-bans": [
+    "align",
+    "background",
+    "bgcolor",
+    "border",
+    "frameborder",
+    "longdesc",
+    "marginwidth",
+    "marginheight",
+    "scrolling",
+    "style",
+    "width",
+  ],
+  "indent-delta": false,
+  "indent-style": "spaces",
+  "indent-width": 2,
+  "indent-width-cont": false,
+  "spec-char-escape": true,
+  "text-ignore-regex": false,
+  "tag-bans": ["style", "b"],
+  "tag-close": true,
+  "tag-name-lowercase": true,
+  "tag-name-match": true,
+  "tag-self-close": false,
+  "doctype-first": false,
+  "doctype-html5": false,
+  "attr-name-style": "dash",
+  "attr-name-ignore-regex": false,
+  "attr-no-dup": true,
+  "attr-no-unsafe-char": true,
+  "attr-order": false,
+  "attr-quote-style": "double",
+  "attr-req-value": false,
+  "attr-new-line": false,
+  "attr-validate": true,
+  "id-no-dup": true,
+  "id-class-no-ad": false,
+  "id-class-style": false, // "lowercase", "underscore", "dash", "camel", "bem"
+  "class-no-dup": true,
+  "class-style": false,
+  "id-class-ignore-regex": false,
+  "img-req-alt": true,
+  "img-req-src": true,
+  "html-valid-content-model": true,
+  "head-valid-content-model": true,
+  "href-style": false,
+  "link-req-noopener": true,
+  "label-req-for": false,
+  "line-end-style": "lf",
+  "line-no-trailing-whitespace": true,
+  "line-max-len": false,
+  "line-max-len-ignore-regex": false,
+  "head-req-title": true,
+  "title-no-dup": true,
+  "title-max-len": 60,
+  "html-req-lang": false,
+  "lang-style": "case",
+  "fig-req-figcaption": false,
+  "focusable-tabindex-style": false,
+  "input-radio-req-name": true,
+  "input-req-label": false,
+  "table-req-caption": false,
+  "table-req-header": false,
+  "tag-req-attr": false,
+};
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nebulab/erb-linter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "erb/linter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/erb-linter.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "lib/erb/linter"
+
+Gem::Specification.new do |spec|
+  spec.name          = "erb-linter"
+  spec.version       = ERB::Linter::VERSION
+  spec.authors       = ["Elia Schito"]
+  spec.email         = ["elia@schito.me"]
+
+  spec.summary       = "Check your ERB files for closing tags, indentation, bad attributes etc."
+  spec.homepage      = "https://github.com/nebulab/erb-linter#readme"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/nebulab/erb-linter"
+  spec.metadata["changelog_uri"] = "https://github.com/nebulab/erb-linter/releases"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  files = Dir.chdir(File.expand_path(__dir__)) { `git ls-files -z`.split("\x0") }
+
+  spec.files         = files.reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rake"
+end

data/lib/erb/linter.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "erb"
+
+module ERB::Linter
+  VERSION = "0.0.1"
+
+  class Error < StandardError; end
+
+  autoload :Task, "erb/linter/task"
+  autoload :Converter, "erb/linter/converter"
+  autoload :Checker, "erb/linter/checker"
+end

data/lib/erb/linter/checker.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "tempfile"
+
+module ERB::Linter::Checker
+  extend self
+
+  def check_files(glob = "**/*.erb", tmpdir: Dir.tmpdir, root: Dir.pwd)
+    Dir.chdir root do
+      print "Checking linthtml version... "
+      unless system("yarn -s linthtml -v")
+        raise ERB::Linter::Error, "please install linthtml in yarn with `yarn add --dev @linthtml/linthtml`"
+      end
+
+      root = File.expand_path(root)
+      tmpdir = File.expand_path(File.join(tmpdir, "erb-linter"))
+      FileUtils.rm_rf tmpdir
+
+      paths_to_check = []
+
+      paths = Dir[glob]
+
+      paths.sort.map do |path|
+        puts "Checking #{path}..."
+        Thread.new(path) do |erb_path|
+          html_path = File.expand_path("#{tmpdir}/#{erb_path}")
+          paths_to_check << html_path
+          FileUtils.mkdir_p File.dirname(html_path)
+          File.write html_path, ERB::Linter::Converter.erb2html(File.read(erb_path))
+        end
+      end.each(&:join)
+
+      system "yarn", "-s", "linthtml", *paths_to_check
+    end
+  end
+end

data/lib/erb/linter/converter.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "cgi"
+require "ripper"
+
+module ERB::Linter::Converter
+  extend self
+
+  # Credit to the Deface gem
+  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
+
+        replace_line
+      end
+      # rubocop:enable Linter/ShadowingOuterLocalVariable
+
+      i = -1
+
+      # 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])}\"")
+      end
+
+      source.sub!(line, replace_line)
+    end
+
+    # replaces all <% %> not inside opening html tags
+    replacements = [
+      { %r{<%\s*end\s*-?%>} => "</erb>" },
+      { %r{(^\s*)<%(\s*(?:else|elsif\b.*)\s*)-?%>} => "\\1</erb>\n\\1<erb silent erb-code-start\\2erb-code-end>" },
+      { "<%=" => "<erb loud erb-code-start" },
+      { "<%" => "<erb silent erb-code-start" },
+      { "-%>" => "erb-code-end>" },
+      { "%>" => "erb-code-end>" },
+    ]
+
+    replacements.each{ |h| h.each { |replace, with| source.gsub! replace, with } }
+
+    source.scan(/(erb-code-start)((?:(?!erb-code-end)[\s\S])*)(erb-code-end)/).each do |match|
+      source.sub!("#{match[0]}#{match[1]}#{match[2]}") do |_m|
+        code = match[1]
+
+        # is nil when the parsing is broken, meaning it's an open expression
+        if Ripper.sexp(code).nil?
+          "erb-code=\"#{CGI.escapeHTML(code.gsub("\n", "&#10;"))}\""
+        else
+          "erb-code=\"#{CGI.escapeHTML(code.gsub("\n", "&#10;"))}\"></erb"
+        end
+      end
+    end
+
+    source
+  end
+end

data/lib/erb/linter/task.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "tempfile"
+
+class ERB::Linter::Task < Rake::TaskLib
+  attr_accessor :name, :glob, :root, :tmpdir
+
+  def initialize(*args, &block)
+    @name = args.shift || :erb_linter
+    @glob = "**/*.erb"
+    @root = Dir.pwd
+    @tmpdir = Dir.tmpdir
+
+    yield self
+
+    desc 'Check ERB files for HTML correcteness'
+    task(name, *args) do |_, task_args|
+      run
+    end
+  end
+
+  private
+
+  def run
+    success = ERB::Linter::Checker.check_files(glob, root: root, tmpdir: tmpdir)
+
+    exit(success)
+  rescue ERB::Linter::Error => error
+    abort error.message
+  end
+end

data/lib/erb/linter/version.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'erb/linter'

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: erb-linter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Elia Schito
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- elia@schito.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- erb-linter.gemspec
+- lib/erb/linter.rb
+- lib/erb/linter/checker.rb
+- lib/erb/linter/converter.rb
+- lib/erb/linter/task.rb
+- lib/erb/linter/version.rb
+homepage: https://github.com/nebulab/erb-linter#readme
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nebulab/erb-linter#readme
+  source_code_uri: https://github.com/nebulab/erb-linter
+  changelog_uri: https://github.com/nebulab/erb-linter/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Check your ERB files for closing tags, indentation, bad attributes etc.
+test_files: []