erb_lint 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8866aae317226178c623de53d4c5e0791643c894
+  data.tar.gz: fac55efcf4a15f251f537af97039b8669960c00b
+SHA512:
+  metadata.gz: b92425a8c4fbe2c65fde42a8dab091c841e2bc0f70b29833e49c06fc99acc85b42639dc9129f200b99195930e9f7fbb96d58fdcaaefb947cd40ad76008ffe765
+  data.tar.gz: aefbb18d6756d5e08045c4d5c8c0afb6ef8fb897f0b73c72fe905158b40d1cbc1114bfada2ec59029165b1a9d72930a172c17b6cfe059a11283bf8ec80e41bc9

data/lib/erb_lint/linter.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ERBLint
+  # Defines common functionality available to all linters.
+  class Linter
+    class << self
+      attr_accessor :simple_name
+
+      # When defining a Linter class, define its simple name as well. This
+      # assumes that the module hierarchy of every linter starts with
+      # `ERBLint::Linters::`, and removes this part of the class name.
+      #
+      # `ERBLint::Linters::Foo.simple_name`          #=> "Foo"
+      # `ERBLint::Linters::Compass::Bar.simple_name` #=> "Compass::Bar"
+      def inherited(linter)
+        name_parts = linter.name.split('::')
+        name = name_parts.length < 3 ? '' : name_parts[2..-1].join('::')
+        linter.simple_name = name
+      end
+    end
+
+    # Must be implemented by the concrete inheriting class.
+    def initialize(_config)
+      raise NotImplementedError, "must implement ##{__method__}"
+    end
+
+    def lint_file(file_content)
+      lines = file_content.scan(/[^\n]*\n|[^\n]+/)
+      lint_lines(lines)
+    end
+
+    protected
+
+    # The lint_lines method that contains the logic for the linter and returns a list of errors.
+    # Must be implemented by the concrete inheriting class.
+    def lint_lines(_lines)
+      raise NotImplementedError, "must implement ##{__method__}"
+    end
+  end
+end

data/lib/erb_lint/linter_registry.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ERBLint
+  # Stores all linters available to the application.
+  module LinterRegistry
+    CUSTOM_LINTERS_DIR = '.erb-linters'
+    @linters = []
+
+    class << self
+      attr_reader :linters
+
+      def included(linter_class)
+        @linters << linter_class
+      end
+
+      def load_custom_linters(directory = CUSTOM_LINTERS_DIR)
+        ruby_files = Dir.glob(File.expand_path(File.join(directory, '**', '*.rb')))
+        ruby_files.each { |file| require file }
+      end
+    end
+  end
+end

data/lib/erb_lint/linters/deprecated_classes.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+module ERBLint
+  module Linters
+    # Checks for deprecated classes in the start tags of HTML elements.
+    class DeprecatedClasses < Linter
+      include LinterRegistry
+
+      def initialize(config)
+        @deprecated_ruleset = []
+        config.fetch('rule_set', []).each do |rule|
+          suggestion = rule.fetch('suggestion', '')
+          rule.fetch('deprecated', []).each do |class_expr|
+            @deprecated_ruleset.push(
+              class_expr: class_expr,
+              suggestion: suggestion
+            )
+          end
+        end
+        @deprecated_ruleset.freeze
+
+        @addendum = config.fetch('addendum', '')
+      end
+
+      protected
+
+      def lint_lines(lines)
+        errors = []
+
+        lines.each_with_index do |line, index|
+          start_tags = StartTagHelper.start_tags(line)
+          start_tags.each do |start_tag|
+            start_tag.attributes.select(&:class?).each do |class_attr|
+              class_attr.value.split(' ').each do |class_name|
+                errors.push(*generate_errors(class_name, index + 1))
+              end
+            end
+          end
+        end
+        errors
+      end
+
+      private
+
+      def generate_errors(class_name, line_number)
+        violated_rules(class_name).map do |violated_rule|
+          suggestion = " #{violated_rule[:suggestion]}".rstrip
+          message = "Deprecated class `%s` detected matching the pattern `%s`.%s #{@addendum}".strip
+          {
+            line: line_number,
+            message: format(message, class_name, violated_rule[:class_expr], suggestion)
+          }
+        end
+      end
+
+      def violated_rules(class_name)
+        @deprecated_ruleset.select do |deprecated_rule|
+          /\A#{deprecated_rule[:class_expr]}\z/.match(class_name)
+        end
+      end
+    end
+
+    # Provides methods and classes for finding HTML start tags and their attributes.
+    module StartTagHelper
+      # These patterns cover a superset of the W3 HTML5 specification.
+      # Additional cases not included in the spec include those that are still rendered by some browsers.
+
+      # Attribute Patterns
+      # https://www.w3.org/TR/html5/syntax.html#syntax-attributes
+
+      # attribute names must be non empty and can't contain a certain set of special characters
+      ATTRIBUTE_NAME_PATTERN = %r{[^\s"'>\/=]+}
+
+      ATTRIBUTE_VALUE_PATTERN = %r{
+        "([^"]*)" |           # double-quoted value
+        '([^']*)' |           # single-quoted value
+        ([^\s"'=<>`]+)        # unquoted non-empty value without special characters
+      }x
+
+      # attributes can be empty or have an attribute value
+      ATTRIBUTE_PATTERN = %r{
+        #{ATTRIBUTE_NAME_PATTERN}        # attribute name
+        (
+          \s*=\s*                        # any whitespace around equals sign
+          (#{ATTRIBUTE_VALUE_PATTERN})   # attribute value
+        )?                               # attributes can be empty or have an assignemnt.
+      }x
+
+      # Start tag Patterns
+      # https://www.w3.org/TR/html5/syntax.html#syntax-start-tag
+
+      TAG_NAME_PATTERN = /[A-Za-z0-9]+/ # maybe add _ < ? etc later since it gets interpreted by some browsers
+
+      START_TAG_PATTERN = %r{
+        <(#{TAG_NAME_PATTERN})         # start of tag with tag name
+        (
+          (
+            \s+                        # required whitespace between tag name and first attribute and between attributes
+            #{ATTRIBUTE_PATTERN}       # attributes
+          )*
+        )?                             # having an attribute block is optional
+        \/?>                           # void or foreign elements can have a slash before tag close
+      }x
+
+      # Represents and provides an interface for a start tag found in the HTML.
+      class StartTag
+        attr_accessor :tag_name, :attributes
+
+        def initialize(tag_name, attributes)
+          @tag_name = tag_name
+          @attributes = attributes
+        end
+      end
+
+      # Represents and provides an interface for an attribute found in a start tag in the HTML.
+      class Attribute
+        ATTR_NAME_CLASS_PATTERN = /\Aclass\z/i # attribute names are case-insensitive
+        attr_accessor :attribute_name, :value
+
+        def initialize(attribute_name, value)
+          @attribute_name = attribute_name
+          @value = value
+        end
+
+        def class?
+          ATTR_NAME_CLASS_PATTERN.match(@attribute_name)
+        end
+      end
+
+      class << self
+        def start_tags(line)
+          # TODO: Implement String Scanner to track quotes before the start tag begins to ensure that it is
+          #       not enclosed inside of a string. Alternatively this problem would be solved by using
+          #       a 3rd party parser like Nokogiri::XML
+
+          start_tag_matching_groups = line.scan(/(#{START_TAG_PATTERN})/)
+          start_tag_matching_groups.map do |start_tag_matching_group|
+            tag_name = start_tag_matching_group[1]
+
+            # attributes_string can be nil if there is no space after the tag name (and therefore no attributes).
+            attributes_string = start_tag_matching_group[2] || ''
+
+            attribute_list = attributes(attributes_string)
+
+            StartTag.new(tag_name, attribute_list)
+          end
+        end
+
+        private
+
+        def attributes(attributes_string)
+          attributes_string.scan(/(#{ATTRIBUTE_PATTERN})/).map do |attribute_matching_group|
+            entire_string = attribute_matching_group[0]
+            value_with_equal_sign = attribute_matching_group[1] || '' # This can be nil if attribute is empty
+            name = entire_string.sub(value_with_equal_sign, '')
+
+            # The 3 captures [3..5] are the possibilities specified in ATTRIBUTE_VALUE_PATTERN
+            possible_value_formats = attribute_matching_group[3..5]
+            value = possible_value_formats.reduce { |a, e| a.nil? ? e : a }
+
+            Attribute.new(name, value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/erb_lint/linters/final_newline.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module ERBLint
+  module Linters
+    # Checks for final newlines at the end of a file.
+    class FinalNewline < Linter
+      include LinterRegistry
+
+      def initialize(config)
+        @new_lines_should_be_present = config['present'].nil? ? true : config['present']
+      end
+
+      protected
+
+      def lint_lines(lines)
+        errors = []
+        return errors if lines.empty?
+
+        ends_with_newline = lines.last.chars[-1] == "\n"
+
+        if @new_lines_should_be_present && !ends_with_newline
+          errors.push(
+            line: lines.length,
+            message: 'Missing a trailing newline at the end of the file.'
+          )
+        elsif !@new_lines_should_be_present && ends_with_newline
+          errors.push(
+            line: lines.length,
+            message: 'Remove the trailing newline at the end of the file.'
+          )
+        end
+        errors
+      end
+    end
+  end
+end

data/lib/erb_lint/runner.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module ERBLint
+  # Runs all enabled linters against an html.erb file.
+  class Runner
+    def initialize(config = {})
+      @config = default_config.merge(config || {})
+
+      LinterRegistry.load_custom_linters
+      @linters = LinterRegistry.linters.select { |linter_class| linter_enabled?(linter_class) }
+      @linters.map! do |linter_class|
+        linter_config = @config.dig('linters', linter_class.simple_name)
+        linter_class.new(linter_config)
+      end
+    end
+
+    def run(filename, file_content)
+      linters_for_file = @linters.select { |linter| !linter_excludes_file?(linter, filename) }
+      linters_for_file.map do |linter|
+        {
+          linter_name: linter.class.simple_name,
+          errors: linter.lint_file(file_content)
+        }
+      end
+    end
+
+    private
+
+    def linter_enabled?(linter_class)
+      linter_config = @config.dig('linters', linter_class.simple_name)
+      return false if linter_config.nil?
+      linter_config['enabled'] || false
+    end
+
+    def linter_excludes_file?(linter, filename)
+      excluded_filepaths = @config.dig('linters', linter.class.simple_name, 'exclude') || []
+      excluded_filepaths.each do |path|
+        return true if File.fnmatch?(path, filename)
+      end
+      false
+    end
+
+    def default_config
+      {
+        'linters' => {
+          'FinalNewline' => {
+            'enabled' => true
+          }
+        }
+      }
+    end
+  end
+end

data/lib/erb_lint.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'erb_lint/linter_registry'
+require 'erb_lint/linter'
+require 'erb_lint/runner'
+
+# Load linters
+Dir[File.expand_path('erb_lint/linters/**/*.rb', File.dirname(__FILE__))].each do |file|
+  require file
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: erb_lint
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Justin Chan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rubocop
+  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'
+description: ERB Linter tool.
+email:
+- justin.the.c@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/erb_lint.rb
+- lib/erb_lint/linter.rb
+- lib/erb_lint/linter_registry.rb
+- lib/erb_lint/linters/deprecated_classes.rb
+- lib/erb_lint/linters/final_newline.rb
+- lib/erb_lint/runner.rb
+homepage: https://github.com/justinthec/erb-lint
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.1
+signing_key: 
+specification_version: 4
+summary: ERB lint tool
+test_files: []