haml_lint 0.30.0 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 206ee804d052b1d36416d62a9143b4cc61e5bbc52032e314ab4f8937842c67c7
-  data.tar.gz: d972e18ec4ca4646f31ec3b4f85450c8afeae2e3051cd5e9f87e65d68fda0cdb
+  metadata.gz: 91c74e1c2fec68c3fd3834999bde513ad3474b81aa946b26bb29d42098668b90
+  data.tar.gz: 1e31e1fb7535909de90039f71f6e4cf359905cf7691e0ae83eb30626f753a535
 SHA512:
-  metadata.gz: 79e24f904324a9fe229bbd71d0cf46e8547af267b9e397882021205147a98e12a1a0eee89cae304d25ccafcdf6470a639656bb3c9c8eeba0a94c6b77eb5f1d01
-  data.tar.gz: b395c2192c88a674f1abc75e88ce21e3c875278c251e0c64c85acb1cb6dac843b807c9fee0bd360735a87751dcaf74932f1e0a999ec7cc111e9c6b40655c0b9c
+  metadata.gz: d97ed27e7c49212447ed00b59560e8e0d87a324bdfe161eba058ba42092d1f07750f7c8984e09383635e2d4e2eecde6516869f175b93e78ae6a962af931e8a27
+  data.tar.gz: 4a9c449c5dffe879a9440e53fc80264b984a06cd3e565fc7dd9f4bd9553221df30a6ac576f98519a7d882992135bcbda7edf3a1e8b161b2c60150f7682e5603b

data/lib/haml_lint/spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'haml_lint/spec/normalize_indent'
+require 'haml_lint/spec/shared_linter_context'
+require 'haml_lint/spec/matchers/report_lint'

data/lib/haml_lint/spec/matchers/report_lint.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module HamlLint
+  module Spec::Matchers
+    # Matcher to assert linter reports and their details
+    module ReportLint
+      RSpec::Matchers.define :report_lint do |options|
+        options ||= {}
+        count = options[:count]
+        expected_line = options[:line]
+        expected_message = options[:message]
+        expected_severity = options[:severity]
+
+        match do |linter|
+          has_lints?(linter, expected_line, count, expected_message, expected_severity)
+        end
+
+        failure_message do |linter|
+          'expected that a lint would be reported' +
+            extended_expectations(expected_line, expected_message, expected_severity) +
+            case linter.lints.count
+            when 0
+              ''
+            when 1
+              messages = [', but']
+              messages << "reported message '#{linter.lints.first.message}'" if expected_message
+              if expected_line
+                messages << 'was' unless expected_message
+                messages << "on line #{linter.lints.first.line}"
+                messages << "with severity '#{linter.lints.first.severity}'" if expected_severity
+              end
+              messages.join ' '
+            else
+              lines = lint_lines(linter)
+              ", but lints were reported on lines #{lines[0...-1].join(', ')} and #{lines.last}"
+            end
+        end
+
+        failure_message_when_negated do |linter|
+          message = ['expected that a lint would not be reported, but reported ']
+
+          message <<
+            case linter.lints.count
+            when 1 then "1 lint:\n"
+            else "#{linter.lints.count} lints:\n"
+            end
+
+          linter.lints.each do |lint|
+            message << "  - Line #{lint.line}: #{lint.message}"
+          end
+
+          message.join
+        end
+
+        description do
+          'report a lint' +
+            extended_expectations(expected_line, expected_message, expected_severity)
+        end
+
+        def extended_expectations(expected_line, expected_message, expected_severity)
+          (expected_line ? " on line #{expected_line}" : '') +
+            (expected_message ? " with message '#{expected_message}'" : '') +
+            (expected_severity ? " with severity '#{expected_severity}'" : '')
+        end
+
+        def has_lints?(linter, expected_line, count, expected_message, expected_severity)
+          if expected_line
+            has_expected_line_lints?(linter,
+                                     expected_line,
+                                     count,
+                                     expected_message,
+                                     expected_severity)
+          elsif count
+            linter.lints.count == count
+          elsif expected_message
+            lint_messages_match?(linter, expected_message)
+          else
+            linter.lints.any?
+          end
+        end
+
+        def has_expected_line_lints?(linter,
+                                     expected_line,
+                                     count,
+                                     expected_message,
+                                     expected_severity)
+          if count
+            multiple_lints_match_line?(linter, expected_line, count)
+          elsif expected_message
+            lint_on_line_matches_message?(linter, expected_line, expected_message)
+          elsif expected_severity
+            lint_on_line_matches_severity?(linter, expected_line, expected_severity)
+          else
+            lint_lines(linter).include?(expected_line)
+          end
+        end
+
+        def multiple_lints_match_line?(linter, expected_line, count)
+          linter.lints.count == count &&
+            lint_lines(linter).all? { |line| line == expected_line }
+        end
+
+        def lint_on_line_matches_message?(linter, expected_line, expected_message)
+          linter
+            .lints
+            .any? { |lint| lint.line == expected_line && lint.message == expected_message }
+        end
+
+        def lint_on_line_matches_severity?(linter, expected_line, expected_severity)
+          linter
+            .lints
+            .any? { |lint| lint.line == expected_line && lint.severity == expected_severity }
+        end
+
+        def lint_messages_match?(linter, expected_message)
+          lint_messages(linter).all? { |message| message == expected_message }
+        end
+
+        def lint_lines(linter)
+          linter.lints.map(&:line)
+        end
+
+        def lint_messages(linter)
+          linter.lints.map(&:message)
+        end
+      end
+    end
+  end
+end

data/lib/haml_lint/spec/normalize_indent.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module HamlLint
+  module Spec
+    # Strips off excess leading indentation from each line so we can use Heredocs
+    # for writing code without having the leading indentation count.
+    module IndentNormalizer
+      def normalize_indent(code)
+        leading_indent = code[/^(\s*)/, 1]
+        code.lstrip.gsub(/\n#{leading_indent}/, "\n")
+      end
+    end
+  end
+end
+
+RSpec.configure do |_config|
+  include HamlLint::Spec::IndentNormalizer
+end

data/lib/haml_lint/spec/shared_linter_context.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Makes writing tests for linters a lot DRYer by taking any currently `haml`
+# variable defined via `let` and normalizing it and running the linter against
+# it, allowing specs to simply specify whether a lint was reported.
+
+module HamlLint
+  module Spec
+    module SharedLinterContext
+      RSpec.shared_context 'linter' do
+        let(:options) do
+          {
+            config: HamlLint::ConfigurationLoader.default_configuration,
+          }
+        end
+
+        let(:config) { options[:config].for_linter(described_class) }
+
+        let(:document) { HamlLint::Document.new(normalize_indent(haml), options) }
+
+        subject { described_class.new(config) }
+
+        before { subject.run(document) }
+      end
+    end
+  end
+end

data/lib/haml_lint/version.rb

@@ -2,5 +2,5 @@
 
 # Defines the gem version.
 module HamlLint
-  VERSION = '0.30.0'
+  VERSION = '0.31.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: haml_lint
 version: !ruby/object:Gem::Version
-  version: 0.30.0
+  version: 0.31.0
 platform: ruby
 authors:
 - Shane da Silva
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-03 00:00:00.000000000 Z
+date: 2019-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -170,6 +170,10 @@ files:
 - lib/haml_lint/ruby_parser.rb
 - lib/haml_lint/runner.rb
 - lib/haml_lint/severity.rb
+- lib/haml_lint/spec.rb
+- lib/haml_lint/spec/matchers/report_lint.rb
+- lib/haml_lint/spec/normalize_indent.rb
+- lib/haml_lint/spec/shared_linter_context.rb
 - lib/haml_lint/tree/comment_node.rb
 - lib/haml_lint/tree/doctype_node.rb
 - lib/haml_lint/tree/filter_node.rb