haml_lint 0.21.0 → 0.22.0

data/lib/haml_lint/runner.rb

@@ -10,22 +10,47 @@ module HamlLint
     # @option options :excluded_files [Array<String>]
     # @option options :included_linters [Array<String>]
     # @option options :excluded_linters [Array<String>]
+    # @option options :fail_fast [true, false] flag for failing after first failure
+    # @option options :fail_level
+    # @option options :reporter [HamlLint::Reporter]
     # @return [HamlLint::Report] a summary of all lints found
     def run(options = {})
-      config = load_applicable_config(options)
-      files = extract_applicable_files(config, options)
+      @config = load_applicable_config(options)
+      @files = extract_applicable_files(config, options)
+      @linter_selector = HamlLint::LinterSelector.new(config, options)
+      @fail_fast = options.fetch(:fail_fast, false)
 
-      linter_selector = HamlLint::LinterSelector.new(config, options)
-
-      lints = files.map do |file|
-        collect_lints(file, linter_selector, config)
-      end.flatten
-
-      HamlLint::Report.new(lints, files)
+      report(options)
     end
 
     private
 
+    # The {HamlLint::Configuration} that should be used for this run.
+    #
+    # @return [HamlLint::Configuration]
+    attr_reader :config
+
+    # A flag for whether to fail after the first failure.
+    #
+    # @return [true, false]
+    attr_reader :fail_fast
+
+    # !@method fail_fast?
+    #   Checks whether to fail after the first failure.
+    #
+    #   @return [true, false]
+    alias fail_fast? fail_fast
+
+    # The list of files to lint during this run.
+    #
+    # @return [Array<String>]
+    attr_reader :files
+
+    # The selector for which linters to run during this run.
+    #
+    # @return [HamlLint::LinterSelector]
+    attr_reader :linter_selector
+
     # Returns the {HamlLint::Configuration} that should be used given the
     # specified options.
     #
@@ -51,7 +76,8 @@ module HamlLint
       begin
         document = HamlLint::Document.new(File.read(file), file: file, config: config)
       rescue HamlLint::Exceptions::ParseError => ex
-        return [HamlLint::Lint.new(nil, file, ex.line, ex.to_s, :error)]
+        return [HamlLint::Lint.new(HamlLint::Linter::Syntax.new(config), file,
+                                   ex.line, ex.to_s, :error)]
       end
 
       linter_selector.linters_for_file(file).map do |linter|
@@ -72,5 +98,39 @@ module HamlLint
 
       HamlLint::FileFinder.new(config).find(included_patterns, excluded_patterns)
     end
+
+    # Process the files and add them to the given report.
+    #
+    # @param report [HamlLint::Report]
+    # @return [void]
+    def process_files(report)
+      files.each do |file|
+        process_file(file, report)
+        break if report.failed? && fail_fast?
+      end
+    end
+
+    # Process a file and add it to the given report.
+    #
+    # @param file [String] the name of the file to process
+    # @param report [HamlLint::Report]
+    # @return [void]
+    def process_file(file, report)
+      lints = collect_lints(file, linter_selector, config)
+      lints.each { |lint| report.add_lint(lint) }
+      report.finish_file(file, lints)
+    end
+
+    # Generates a report based on the given options.
+    #
+    # @param options [Hash]
+    # @option options :reporter [HamlLint::Reporter] the reporter to report with
+    # @return [HamlLint::Report]
+    def report(options)
+      report = HamlLint::Report.new(reporter: options[:reporter])
+      report.start(@files)
+      process_files(report)
+      report
+    end
   end
 end

data/lib/haml_lint/severity.rb

@@ -0,0 +1,95 @@
+require 'delegate'
+
+module HamlLint
+  # Models the severity of a lint
+  class Severity < SimpleDelegator
+    include Comparable
+
+    SEVERITY_ERROR = :error
+    SEVERITY_WARNING = :warning
+
+    COLORS = { error: :red, warning: :yellow }.freeze
+    MARKS = { error: 'E', warning: 'W' }.freeze
+    NAMES = [SEVERITY_WARNING, SEVERITY_ERROR].freeze
+
+    # Creates a new severity for a lint
+    #
+    # @example
+    #   HamlLint::Severity.new(:warning)
+    #
+    # @api public
+    # @param name [Symbol] the name of the severity level
+    def initialize(name)
+      name = name.name if name.is_a?(Severity)
+      name ||= :warning
+      fail Exceptions::UnknownSeverity, "Unknown severity: #{name}" unless NAMES.include?(name)
+      super
+    end
+
+    # The color of the mark in reporters.
+    #
+    # @return [Symbol]
+    def color
+      COLORS[__getobj__]
+    end
+
+    # Checks whether the severity is an error
+    #
+    # @example
+    #   HamlLint::Severity.new(:error).error? #=> true
+    #
+    # @api public
+    # @return [Boolean]
+    def error?
+      __getobj__ == :error
+    end
+
+    # The level of severity for the lint
+    #
+    # @api public
+    # @return [Integer]
+    def level
+      NAMES.index(__getobj__) + 1
+    end
+
+    # The symbol to use in a {HamlLint::Reporter::ProgressReporter}.
+    #
+    # @returns [String]
+    def mark
+      MARKS[__getobj__]
+    end
+
+    # The colorized symbol to use in a reporter.
+    #
+    # @returns [String]
+    def mark_with_color
+      Rainbow.global.wrap(mark).public_send(color)
+    end
+
+    # The name of the severity.
+    #
+    # @returns [Symbol]
+    def name
+      __getobj__
+    end
+
+    # Checks whether the severity is a warning
+    #
+    # @example
+    #   HamlLint::Severity.new(:warning).warning? #=> true
+    #
+    # @api public
+    # @return [Boolean]
+    def warning?
+      __getobj__ == :warning
+    end
+
+    # Compares the severity to another severity or a symbol
+    #
+    # @return [Integer]
+    def <=>(other)
+      other = Severity.new(other) unless other.respond_to?(:level)
+      level <=> other.level
+    end
+  end
+end

data/lib/haml_lint/tree/haml_comment_node.rb

@@ -1,6 +1,14 @@
+require 'haml_lint/directive'
+
 module HamlLint::Tree
   # Represents a HAML comment node.
   class HamlCommentNode < Node
+    def directives
+      directives = super
+      directives << contained_directives
+      directives.flatten
+    end
+
     # Returns the full text content of this comment, including newlines if a
     # single comment spans multiple lines.
     #
@@ -14,5 +22,15 @@ module HamlLint::Tree
              .gsub(/^  /, '')
              .rstrip
     end
+
+    private
+
+    def contained_directives
+      text
+        .split("\n")
+        .each_with_index
+        .map { |source, offset| HamlLint::Directive.from_line(source, line + offset) }
+        .reject { |directive| directive.is_a?(HamlLint::Directive::Null) }
+    end
   end
 end

data/lib/haml_lint/tree/node.rb

@@ -1,3 +1,5 @@
+require 'haml_lint/comment_configuration'
+
 module HamlLint::Tree
   # Decorator class that provides a convenient set of helpers for HAML's
   # {Haml::Parser::ParseNode} struct.
@@ -9,6 +11,8 @@ module HamlLint::Tree
   #
   # @abstract
   class Node
+    include Enumerable
+
     attr_accessor :children, :parent
     attr_reader :line, :type
 
@@ -23,24 +27,42 @@ module HamlLint::Tree
       @type = parse_node.type
     end
 
-    # Returns the first node found under the subtree which matches the given
-    # block.
+    # Holds any configuration that is created from Haml comments.
     #
-    # Returns nil if no node matching the given block was found.
+    # @return [HamlLint::CommentConfiguration]
+    def comment_configuration
+      @comment_configuration ||= HamlLint::CommentConfiguration.new(self)
+    end
+
+    # Checks whether a visitor is disabled due to comment configuration.
     #
-    # @yieldparam [HamlLint::Tree::Node] node
-    # @yieldreturn [Boolean] whether the node matches
-    # @return [HamlLint::Tree::Node,nil]
-    def find(&block)
-      return self if yield(self)
+    # @param [HamlLint::HamlVisitor]
+    # @return [true, false]
+    def disabled?(visitor)
+      visitor.is_a?(HamlLint::Linter) &&
+        comment_configuration.disabled?(visitor.name)
+    end
 
-      children.each do |child|
-        if result = child.find(&block)
-          return result
-        end
+    # Implements the Enumerable interface to walk through an entire tree.
+    #
+    # @return [Enumerator, HamlLint::Tree::Node]
+    def each
+      return to_enum(__callee__) unless block_given?
+
+      node = self
+      loop do
+        yield node
+        break unless (node = node.next_node)
       end
+    end
 
-      nil # Otherwise no matching node was found
+    # The comment directives to apply to the node.
+    #
+    # @return [Array<HamlLint::Directive>]
+    def directives
+      directives = []
+      directives << predecessor.directives if predecessor
+      directives.flatten
     end
 
     # Source code of all lines this node spans (excluding children).
@@ -63,6 +85,13 @@ module HamlLint::Tree
       "#<#{self.class.name}>"
     end
 
+    # The previous node to be traversed in the tree.
+    #
+    # @return [HamlLint::Tree::Node, nil]
+    def predecessor
+      siblings.previous(self) || parent
+    end
+
     # Returns the node that follows this node, whether it be a sibling or an
     # ancestor's child, but not a child of this node.
     #
@@ -72,9 +101,7 @@ module HamlLint::Tree
     #
     # @return [HamlLint::Tree::Node,nil]
     def successor
-      siblings = parent ? parent.children : [self]
-
-      next_sibling = siblings[siblings.index(self) + 1] if siblings.count > 1
+      next_sibling = siblings.next(self)
       return next_sibling if next_sibling
 
       parent.successor if parent
@@ -89,11 +116,84 @@ module HamlLint::Tree
       children.first || successor
     end
 
+    # The sibling nodes that come after this node in the tree.
+    #
+    # @return [Array<HamlLint::Tree::Node>]
+    def subsequents
+      siblings.subsequents(self)
+    end
+
     # Returns the text content of this node.
     #
     # @return [String]
     def text
       @value[:text].to_s
     end
+
+    private
+
+    # The siblings of this node within the tree.
+    #
+    # @api private
+    # @return [Array<HamlLint::Tree::Node>]
+    def siblings
+      @siblings ||= Siblings.new(parent ? parent.children : [self])
+    end
+
+    # Finds the node's siblings within the tree and makes them queryable.
+    class Siblings < SimpleDelegator
+      # Finds the next sibling in the tree for a given node.
+      #
+      # @param node [HamlLint::Tree::Node]
+      # @return [HamlLint::Tree::Node, nil]
+      def next(node)
+        subsequents(node).first
+      end
+
+      # Finds the previous sibling in the tree for a given node.
+      #
+      # @param node [HamlLint::Tree::Node]
+      # @return [HamlLint::Tree::Node, nil]
+      def previous(node)
+        priors(node).last
+      end
+
+      # Finds all sibling notes that appear before a node in the tree.
+      #
+      # @param node [HamlLint::Tree::Node]
+      # @return [Array<HamlLint::Tree::Node>]
+      def priors(node)
+        position = position(node)
+        if position.zero?
+          []
+        else
+          siblings[0..(position - 1)]
+        end
+      end
+
+      # Finds all sibling notes that appear after a node in the tree.
+      #
+      # @param node [HamlLint::Tree::Node]
+      # @return [Array<HamlLint::Tree::Node>]
+      def subsequents(node)
+        siblings[(position(node) + 1)..-1]
+      end
+
+      private
+
+      # The set of siblings within the tree.
+      #
+      # @api private
+      # @return [Array<HamlLint::Tree::Node>]
+      alias siblings __getobj__
+
+      # Finds the position of a node within a set of siblings.
+      #
+      # @api private
+      # @return [Integer, nil]
+      def position(node)
+        siblings.index(node)
+      end
+    end
   end
 end

data/lib/haml_lint/tree/null_node.rb

@@ -0,0 +1,15 @@
+module HamlLint::Tree
+  # A null object version of a node that can be used as a safe default.
+  class NullNode < Node
+    # Instantiates a new {HamlLint::Tree::NullNode}, ignoring all input.
+    def initialize(*_args); end
+
+    # Overrides the disabled check to always say the linter is enabled.
+    #
+    # @param _linter [HamlLint::Linter] the linter to check
+    # @return [false]
+    def disabled?(_linter)
+      false
+    end
+  end
+end

data/lib/haml_lint/tree/root_node.rb

@@ -1,5 +1,21 @@
+require 'haml_lint/tree/null_node'
+
 module HamlLint::Tree
   # Represents the root node of a HAML document that contains all other nodes.
   class RootNode < Node
+    # The name fo the file parsed to build this tree.
+    #
+    # @return [String] a file name
+    def file
+      @document.file
+    end
+
+    # Gets the node of the syntax tree for a given line number.
+    #
+    # @param line [Integer] the line number of the node
+    # @return [HamlLint::Node]
+    def node_for_line(line)
+      find(HamlLint::Tree::NullNode) { |node| node.line == line }
+    end
   end
 end

data/lib/haml_lint/tree/script_node.rb

@@ -1,6 +1,15 @@
+require 'haml_lint/parsed_ruby'
+
 module HamlLint::Tree
   # Represents a node which produces output based on Ruby code.
   class ScriptNode < Node
+    # The Ruby script contents parsed into a syntax tree.
+    #
+    # @return [ParsedRuby] syntax tree in the form returned by Parser gem
+    def parsed_script
+      HamlLint::ParsedRuby.new(HamlLint::RubyParser.new.parse(script))
+    end
+
     # Returns the source for the script following the `-` marker.
     #
     # @return [String]

data/lib/haml_lint/tree/silent_script_node.rb

@@ -2,6 +2,13 @@ module HamlLint::Tree
   # Represents a HAML silent script node (`- some_expression`) which executes
   # code without producing output.
   class SilentScriptNode < Node
+    # The Ruby script contents parsed into a syntax tree.
+    #
+    # @return [ParsedRuby] syntax tree in the form returned by Parser gem
+    def parsed_script
+      HamlLint::ParsedRuby.new(HamlLint::RubyParser.new.parse(script))
+    end
+
     # Returns the source for the script following the `-` marker.
     #
     # @return [String]

data/lib/haml_lint/tree/tag_node.rb

@@ -148,6 +148,13 @@ module HamlLint::Tree
       dynamic_attributes_source[:html][/\A\((.*)\)\z/, 1] if html_attributes?
     end
 
+    # ID of the HTML tag.
+    #
+    # @return [String]
+    def tag_id
+      @value[:attributes]['id']
+    end
+
     # Name of the HTML tag.
     #
     # @return [String]
@@ -173,6 +180,20 @@ module HamlLint::Tree
       @value[:object_ref][/\A\[(.*)\]\z/, 1] if object_reference?
     end
 
+    # The attributes given to the tag parsed into a Ruby syntax tree.
+    #
+    # @return [ParsedRuby] syntax tree in the form returned by Parser gem
+    def parsed_attributes
+      HamlLint::ParsedRuby.new(HamlLint::RubyParser.new.parse(hash_attributes_source || ''))
+    end
+
+    # The Ruby script contents of a tag parsed into a syntax tree.
+    #
+    # @return [ParsedRuby] syntax tree in the form returned by Parser gem
+    def parsed_script
+      HamlLint::ParsedRuby.new(HamlLint::RubyParser.new.parse(script || ''))
+    end
+
     # Whether this node had a `<` after it signifying that outer whitespace
     # should be removed.
     #
@@ -184,9 +205,11 @@ module HamlLint::Tree
     # Whether this node had a `>` after it signifying that outer whitespace
     # should be removed.
     #
+    # rubocop:disable Style/DoubleNegation
+    #
     # @return [true,false]
     def remove_outer_whitespace?
-      @value[:nuke_outer_whitespace]
+      !!@value[:nuke_outer_whitespace]
     end
 
     # Returns the script source that will be evaluated to produce this tag's
@@ -199,10 +222,6 @@ module HamlLint::Tree
 
     private
 
-    def parsed_attributes
-      HamlLint::RubyParser.new.parse(hash_attributes_source)
-    end
-
     def existing_attributes
       parsed_attributes.children.collect do |parsed_attribute|
         parsed_attribute.children.first.to_a.first

data/lib/haml_lint/version.rb

@@ -2,5 +2,5 @@
 
 # Defines the gem version.
 module HamlLint
-  VERSION = '0.21.0'.freeze
+  VERSION = '0.22.0'.freeze
 end

data/lib/haml_lint.rb

@@ -19,6 +19,7 @@ require 'haml_lint/file_finder'
 require 'haml_lint/runner'
 require 'haml_lint/utils'
 require 'haml_lint/version'
+require 'haml_lint/severity'
 
 # Load all parse tree node classes
 require 'haml_lint/tree/node'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haml_lint
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Brigade Engineering
@@ -9,22 +9,42 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-13 00:00:00.000000000 Z
+date: 2017-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -85,16 +105,22 @@ files:
 - bin/haml-lint
 - config/default.yml
 - lib/haml_lint.rb
+- lib/haml_lint/adapter.rb
+- lib/haml_lint/adapter/haml_4.rb
+- lib/haml_lint/adapter/haml_5.rb
 - lib/haml_lint/cli.rb
+- lib/haml_lint/comment_configuration.rb
 - lib/haml_lint/configuration.rb
 - lib/haml_lint/configuration_loader.rb
 - lib/haml_lint/constants.rb
+- lib/haml_lint/directive.rb
 - lib/haml_lint/document.rb
 - lib/haml_lint/exceptions.rb
 - lib/haml_lint/file_finder.rb
 - lib/haml_lint/haml_visitor.rb
 - lib/haml_lint/lint.rb
 - lib/haml_lint/linter.rb
+- lib/haml_lint/linter/alignment_tabs.rb
 - lib/haml_lint/linter/alt_text.rb
 - lib/haml_lint/linter/class_attribute_with_static_value.rb
 - lib/haml_lint/linter/classes_before_ids.rb
@@ -104,17 +130,21 @@ files:
 - lib/haml_lint/linter/empty_script.rb
 - lib/haml_lint/linter/final_newline.rb
 - lib/haml_lint/linter/html_attributes.rb
+- lib/haml_lint/linter/id_names.rb
 - lib/haml_lint/linter/implicit_div.rb
 - lib/haml_lint/linter/indentation.rb
+- lib/haml_lint/linter/instance_variables.rb
 - lib/haml_lint/linter/leading_comment_space.rb
 - lib/haml_lint/linter/line_length.rb
 - lib/haml_lint/linter/multiline_pipe.rb
 - lib/haml_lint/linter/multiline_script.rb
 - lib/haml_lint/linter/object_reference_attributes.rb
+- lib/haml_lint/linter/repeated_id.rb
 - lib/haml_lint/linter/rubocop.rb
 - lib/haml_lint/linter/ruby_comments.rb
 - lib/haml_lint/linter/space_before_script.rb
 - lib/haml_lint/linter/space_inside_hash_attributes.rb
+- lib/haml_lint/linter/syntax.rb
 - lib/haml_lint/linter/tag_name.rb
 - lib/haml_lint/linter/trailing_whitespace.rb
 - lib/haml_lint/linter/unnecessary_interpolation.rb
@@ -124,20 +154,27 @@ files:
 - lib/haml_lint/logger.rb
 - lib/haml_lint/node_transformer.rb
 - lib/haml_lint/options.rb
+- lib/haml_lint/parsed_ruby.rb
 - lib/haml_lint/rake_task.rb
 - lib/haml_lint/report.rb
 - lib/haml_lint/reporter.rb
 - lib/haml_lint/reporter/checkstyle_reporter.rb
 - lib/haml_lint/reporter/default_reporter.rb
+- lib/haml_lint/reporter/hash_reporter.rb
+- lib/haml_lint/reporter/hooks.rb
 - lib/haml_lint/reporter/json_reporter.rb
+- lib/haml_lint/reporter/progress_reporter.rb
+- lib/haml_lint/reporter/utils.rb
 - lib/haml_lint/ruby_extractor.rb
 - lib/haml_lint/ruby_parser.rb
 - lib/haml_lint/runner.rb
+- lib/haml_lint/severity.rb
 - lib/haml_lint/tree/comment_node.rb
 - lib/haml_lint/tree/doctype_node.rb
 - lib/haml_lint/tree/filter_node.rb
 - lib/haml_lint/tree/haml_comment_node.rb
 - lib/haml_lint/tree/node.rb
+- lib/haml_lint/tree/null_node.rb
 - lib/haml_lint/tree/plain_node.rb
 - lib/haml_lint/tree/root_node.rb
 - lib/haml_lint/tree/script_node.rb