slim_lint_standard 0.0.0

data/lib/slim_lint/sexp_visitor.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+module SlimLint
+  # Provides an interface which when included allows a class to visit nodes in
+  # the Sexp of a Slim document.
+  module SexpVisitor
+    # Traverse the Sexp looking for matches with registered patterns, firing
+    # callbacks for all matches.
+    #
+    # @param sexp [SlimLint::Sexp]
+    def trigger_pattern_callbacks(sexp)
+      return if on_start(sexp) == :stop
+
+      traverse sexp
+    end
+
+    # Traverse the given Sexp, firing callbacks if they are defined.
+    #
+    # @param sexp [SlimLint::Sexp]
+    def traverse(sexp)
+      patterns.each do |pattern|
+        next unless sexp.match?(pattern.sexp)
+
+        result = method(pattern.callback_method_name).call(sexp)
+
+        # Returning :stop indicates we should stop searching this Sexp
+        # (i.e. stop descending this branch of depth-first search).
+        # The `return` here is very intentional.
+        return if result == :stop # rubocop:disable Lint/NonLocalExitFromIterator
+      end
+
+      # Continue traversing children by default (match blocks can return `:stop`
+      # to not continue).
+      traverse_children(sexp)
+    end
+
+    # Traverse the children of this {Sexp}.
+    #
+    # @param sexp [SlimLint::Sexp]
+    def traverse_children(sexp)
+      sexp.each do |nested_sexp|
+        traverse nested_sexp if nested_sexp.is_a?(Sexp)
+      end
+    end
+
+    # Returns the map of capture names to captured values.
+    #
+    # @return [Hash, CaptureMap]
+    def captures
+      self.class.captures || {}
+    end
+
+    # Returns the list of registered Sexp patterns.
+    #
+    # @return [Array<SlimLint::SexpVisitor::SexpPattern>]
+    def patterns
+      self.class.patterns || []
+    end
+
+    # Executed before searching for any pattern matches.
+    #
+    # @param sexp [SlimLint::Sexp] see {SexpVisitor::DSL.on_start}
+    # @return [Symbol] see {SexpVisitor::DSL.on_start}
+    def on_start(*)
+      # Overidden by DSL.on_start
+    end
+
+    # Mapping of Sexp pattern to callback method name.
+    #
+    # @attr_reader sexp [Array] S-expression pattern that when matched triggers the
+    #     callback
+    # @attr_reader callback_method_name [Symbol] name of the method to call when pattern is matched
+    SexpPattern = Struct.new(:sexp, :callback_method_name) do
+      def match?(expr)
+        expr.match?(sexp)
+      end
+    end
+    private_constant :SexpPattern
+
+    # Exposes a convenient Domain-specific Language (DSL) that makes declaring
+    # Sexp match patterns very easy.
+    #
+    # Include them with `extend SlimLint::SexpVisitor::DSL`
+    module DSL
+      # Registered patterns that this visitor will look for when traversing the
+      # {SlimLint::Sexp}.
+      attr_reader :patterns
+
+      # @return [Hash] map of capture names to captured values
+      attr_reader :captures
+
+      # DSL helper that defines a sexp pattern and block that will be executed if
+      # the given pattern is found.
+      #
+      # @param sexp_pattern [Sexp]
+      # @yield block to execute when the specified pattern is matched
+      # @yieldparam sexp [SlimLint::Sexp] Sexp that matched the pattern
+      # @yieldreturn [SlimLint::Sexp,Symbol,void]
+      #   If a Sexp is returned, indicates that traversal should jump directly
+      #   to that Sexp.
+      #   If `:stop` is returned, halts further traversal down this branch
+      #   (i.e. stops recursing, but traversal at higher levels will continue).
+      #   Otherwise traversal will continue as normal.
+      def on(sexp_pattern, &block)
+        # TODO: Index Sexps on creation so we can quickly jump to potential
+        # matches instead of checking array.
+        @patterns ||= []
+        @pattern_number ||= 1
+
+        # Use a monotonically increasing number to identify the method so that in
+        # debugging we can simply look at the nth defintion in the class.
+        unique_method_name = :"on_pattern_#{@pattern_number}"
+        define_method(unique_method_name, block)
+
+        @pattern_number += 1
+        @patterns << SexpPattern.new(sexp_pattern, unique_method_name)
+      end
+
+      # Define a block of code to run before checking for any pattern matches.
+      #
+      # @yield block to execute
+      # @yieldparam sexp [SlimLint::Sexp] the root Sexp
+      # @yieldreturn [Symbol] if `:stop`, indicates that no further processing
+      #   should occur
+      def on_start(&block)
+        define_method(:on_start, block)
+      end
+
+      # Represents a pattern that matches anything.
+      #
+      # @return [SlimLint::Matcher::Anything]
+      def anything
+        SlimLint::Matcher::Anything.new
+      end
+
+      # Represents a pattern that matches the specified matcher, storing the
+      # matched value in the captures list under the given name.
+      #
+      # @param capture_name [Symbol]
+      # @param matcher [Array, SlimLint::Matcher::Base]
+      # @return [SlimLint::Matcher::Capture]
+      def capture(capture_name, matcher)
+        @captures ||= SlimLint::CaptureMap.new
+
+        matcher = SexpPattern.new(matcher, nil) unless matcher.respond_to?(:match?)
+        @captures[capture_name] = SlimLint::Matcher::Capture.from_matcher(matcher)
+      end
+    end
+  end
+end

data/lib/slim_lint/source_location.rb

@@ -0,0 +1,45 @@
+module SlimLint
+  class SourceLocation
+    attr_accessor :start_line, :start_column, :last_line, :last_column, :line, :column, :length
+
+    def self.merge(start, finish, length:)
+      new(
+        start_line: start.start_line,
+        start_column: start.start_column,
+        last_line: finish.start_line,
+        last_column: finish.start_column,
+        length: length
+      )
+    end
+
+    def initialize(start_line: nil, start_column: nil, last_line: nil, last_column: nil, length: nil)
+      @start_line = @line = start_line
+      @start_column = @column = start_column
+      @last_line = last_line || @start_line
+      @last_column = last_column || @start_column
+      @length = length || (start_line == last_line ? last_column - start_column : nil)
+    end
+
+    def as_json
+      {
+        line: line,
+        column: column,
+        length: length,
+        start_line: start_line,
+        start_column: start_column,
+        last_line: last_line,
+        last_column: last_column
+      }.compact
+    end
+
+    def adjust(line: 0, column: 0)
+      self.class.new(
+        length: @length,
+        start_line: @start_line + line,
+        start_column: @start_column + column,
+        last_line: @last_line + line,
+        last_column: @last_column + column
+      )
+    end
+  end
+end

data/lib/slim_lint/utils.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module SlimLint
+  # Miscellaneus collection of helper functions.
+  module Utils
+    module_function
+
+    # Returns whether a glob pattern (or any of a list of patterns) matches the
+    # specified file.
+    #
+    # This is defined here so our file globbing options are consistent
+    # everywhere we perform globbing.
+    #
+    # @param glob [String, Array]
+    # @param file [String]
+    # @return [Boolean]
+    def any_glob_matches?(globs_or_glob, file)
+      path = File.expand_path(file)
+      flags = File::FNM_PATHNAME | File::FNM_DOTMATCH
+      Array(globs_or_glob).any? do |glob|
+        File.fnmatch?(File.expand_path(glob), path, flags)
+      end
+    end
+
+    # Find all consecutive items satisfying the given block of a minimum size,
+    # yielding each group of consecutive items to the provided block.
+    #
+    # @param items [Array]
+    # @param satisfies [Proc] function that takes an item and returns true/false
+    # @param min_consecutive [Fixnum] minimum number of consecutive items before
+    #   yielding the group
+    # @yield Passes list of consecutive items all matching the criteria defined
+    #   by the `satisfies` {Proc} to the provided block
+    # @yieldparam group [Array] List of consecutive items
+    # @yieldreturn [Boolean] block should return whether item matches criteria
+    #   for inclusion
+    def for_consecutive_items(items, satisfies, min_consecutive = 2)
+      current_index = -1
+
+      while (current_index += 1) < items.count
+        next unless satisfies[items[current_index]]
+
+        count = count_consecutive(items, current_index, &satisfies)
+        next unless count >= min_consecutive
+
+        # Yield the chunk of consecutive items
+        yield items[current_index...(current_index + count)]
+
+        current_index += count # Skip this patch of consecutive items to find more
+      end
+    end
+
+    # Count the number of consecutive items satisfying the given {Proc}.
+    #
+    # @param items [Array]
+    # @param offset [Fixnum] index to start searching from
+    # @yield [item] Passes item to the provided block.
+    # @yieldparam item [Object] Item to evaluate as matching criteria for
+    #   inclusion
+    # @yieldreturn [Boolean] whether to include the item
+    # @return [Integer]
+    def count_consecutive(items, offset = 0)
+      count = 1
+      count += 1 while (offset + count < items.count) && yield(items[offset + count])
+      count
+    end
+
+    # Calls a block of code with a modified set of environment variables,
+    # restoring them once the code has executed.
+    #
+    # @param env [Hash] environment variables to set
+    def with_environment(env)
+      old_env = {}
+      env.each do |var, value|
+        old_env[var] = ENV[var.to_s]
+        ENV[var.to_s] = value
+      end
+
+      yield
+    ensure
+      old_env.each { |var, value| ENV[var.to_s] = value }
+    end
+  end
+end

data/lib/slim_lint/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# Defines the gem version.
+module SlimLint
+  VERSION = "0.0.0"
+end

data/lib/slim_lint.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# Load all slim-lint-standard modules necessary to parse and lint a file.
+# Ordering here can be important depending on class references in each module.
+
+# Need to load slim before we can reference some classes or define filters
+require "slim"
+
+require "slim_lint/constants"
+require "slim_lint/exceptions"
+require "slim_lint/configuration"
+require "slim_lint/configuration_loader"
+require "slim_lint/utils"
+require "slim_lint/atom"
+require "slim_lint/sexp"
+require "slim_lint/file_finder"
+require "slim_lint/linter_registry"
+require "slim_lint/logger"
+require "slim_lint/version"
+require "slim_lint/filter"
+
+# Load all filters (required by SlimLint::Engine)
+Dir[File.expand_path("slim_lint/filters/*.rb", File.dirname(__FILE__))].sort.each do |file|
+  require file
+end
+
+require "slim_lint/parser"
+require "slim_lint/engine"
+require "slim_lint/document"
+require "slim_lint/capture_map"
+require "slim_lint/sexp_visitor"
+require "slim_lint/source_location"
+require "slim_lint/lint"
+require "slim_lint/ruby_parser"
+require "slim_lint/linter"
+require "slim_lint/reporter"
+require "slim_lint/report"
+require "slim_lint/linter_selector"
+require "slim_lint/runner"
+
+# Load all matchers
+require "slim_lint/matcher/base"
+Dir[File.expand_path("slim_lint/matcher/*.rb", File.dirname(__FILE__))].sort.each do |file|
+  require file
+end
+
+# Load all linters
+Dir[File.expand_path("slim_lint/linter/*.rb", File.dirname(__FILE__))].sort.each do |file|
+  require file
+end
+
+# Load all reporters
+Dir[File.expand_path("slim_lint/reporter/*.rb", File.dirname(__FILE__))].sort.each do |file|
+  require file
+end

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: slim_lint_standard
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Pieter van de Bruggen
+- Shane da Silva
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.78.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.78.0
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+description: Configurable tool for writing clean and consistent Slim templates
+email:
+- pvande@gmail.com
+- shane@dasilva.io
+executables:
+- slim-lint-standard
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- bin/slim-lint-standard
+- config/default.yml
+- lib/slim_lint.rb
+- lib/slim_lint/atom.rb
+- lib/slim_lint/capture_map.rb
+- lib/slim_lint/cli.rb
+- lib/slim_lint/configuration.rb
+- lib/slim_lint/configuration_loader.rb
+- lib/slim_lint/constants.rb
+- lib/slim_lint/document.rb
+- lib/slim_lint/engine.rb
+- lib/slim_lint/exceptions.rb
+- lib/slim_lint/file_finder.rb
+- lib/slim_lint/filter.rb
+- lib/slim_lint/filters/attribute_processor.rb
+- lib/slim_lint/filters/auto_indenter.rb
+- lib/slim_lint/filters/control_processor.rb
+- lib/slim_lint/filters/do_inserter.rb
+- lib/slim_lint/filters/end_inserter.rb
+- lib/slim_lint/filters/interpolation.rb
+- lib/slim_lint/filters/multi_flattener.rb
+- lib/slim_lint/filters/splat_processor.rb
+- lib/slim_lint/filters/static_merger.rb
+- lib/slim_lint/lint.rb
+- lib/slim_lint/linter.rb
+- lib/slim_lint/linter/avoid_multiline_expressions.rb
+- lib/slim_lint/linter/comment_control_statement.rb
+- lib/slim_lint/linter/consecutive_control_statements.rb
+- lib/slim_lint/linter/control_statement_spacing.rb
+- lib/slim_lint/linter/dynamic_output_spacing.rb
+- lib/slim_lint/linter/embedded_engines.rb
+- lib/slim_lint/linter/empty_control_statement.rb
+- lib/slim_lint/linter/empty_lines.rb
+- lib/slim_lint/linter/file_length.rb
+- lib/slim_lint/linter/line_length.rb
+- lib/slim_lint/linter/redundant_div.rb
+- lib/slim_lint/linter/rubocop.rb
+- lib/slim_lint/linter/standard.rb
+- lib/slim_lint/linter/tab.rb
+- lib/slim_lint/linter/tag_case.rb
+- lib/slim_lint/linter/trailing_blank_lines.rb
+- lib/slim_lint/linter/trailing_whitespace.rb
+- lib/slim_lint/linter_registry.rb
+- lib/slim_lint/linter_selector.rb
+- lib/slim_lint/logger.rb
+- lib/slim_lint/matcher/anything.rb
+- lib/slim_lint/matcher/base.rb
+- lib/slim_lint/matcher/capture.rb
+- lib/slim_lint/matcher/nothing.rb
+- lib/slim_lint/options.rb
+- lib/slim_lint/parser.rb
+- lib/slim_lint/rake_task.rb
+- lib/slim_lint/report.rb
+- lib/slim_lint/reporter.rb
+- lib/slim_lint/reporter/checkstyle_reporter.rb
+- lib/slim_lint/reporter/default_reporter.rb
+- lib/slim_lint/reporter/emacs_reporter.rb
+- lib/slim_lint/reporter/json_reporter.rb
+- lib/slim_lint/ruby_extract_engine.rb
+- lib/slim_lint/ruby_extractor.rb
+- lib/slim_lint/ruby_parser.rb
+- lib/slim_lint/runner.rb
+- lib/slim_lint/sexp.rb
+- lib/slim_lint/sexp_visitor.rb
+- lib/slim_lint/source_location.rb
+- lib/slim_lint/utils.rb
+- lib/slim_lint/version.rb
+homepage: https://github.com/pvande/slim-lint-standard
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Linter for Slim templates
+test_files: []