haml_lint 0.36.0 → 0.40.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d2be98b8d977ca5ccbcb29baf2f0fd8d1b527d44b3a9929a55c538df46d5a82
-  data.tar.gz: 7b5a39a010d171a7487b90c4cf1be92ed9d62f6dc2c223fe5e81bb2e75652be8
+  metadata.gz: 1655e5263c92bb0a391c1e56aea103792409f17a72deafb16818844fd5f6d7c8
+  data.tar.gz: 65d4539637d4caf656940041040ad33227a0d89eb923207fb5fedafcf357f0bd
 SHA512:
-  metadata.gz: 16061fce86f6da8868f2f78b19b92e8184efb80e6f73fd2b0101359466c2123abea947e7cb3b1729b005ef6144ddac5604e7ac28a4646b04c3d213c6ceaf052f
-  data.tar.gz: a355b4893f8a7ada12d66ab61b25150a032b2cdfb5f69a9f3dfbf71f2b338bd946ed164e6b614a2dc6e647be5785d3268353f82a30f31b9efa5d4d4c90b6b356
+  metadata.gz: 1f08f1952a5a9ab8adc6b5c6730ec0a441ccdc10ac1a59922f77bc54c74fc95db3b49e732400aef960c4bae7581950fb21874e78d3b516e22d5cc61dc914da72
+  data.tar.gz: 91af5862db990bc021c1088b0de462f5f3a84ad7509cc62498ee4ac70a11f05b423d7778deead53da353253f38d76d5c84cde5417d1da3ac43bccc23f16a4753

data/config/default.yml

@@ -93,6 +93,7 @@ linters:
       - Lint/Void
       - Layout/AlignHash # renamed to Layout/HashAlignment in rubocop 0.77
       - Layout/AlignParameters # renamed to Layout/ParameterAlignment in rubocop 0.77
+      - Layout/ArgumentAlignment
       - Layout/CaseIndentation
       - Layout/ElseAlignment
       - Layout/EndOfLine

data/lib/haml_lint/cli.rb

@@ -94,7 +94,7 @@ module HamlLint
     # @return [HamlLint::Reporter]
     def reporter_from_options(options)
       if options[:auto_gen_config]
-        HamlLint::Reporter::DisabledConfigReporter.new(log, limit: options[:auto_gen_exclude_limit] || 15) # rubocop:disable Layout/LineLength
+        HamlLint::Reporter::DisabledConfigReporter.new(log, limit: options[:auto_gen_exclude_limit] || 15)
       else
         options.fetch(:reporter, HamlLint::Reporter::DefaultReporter).new(log)
       end

data/lib/haml_lint/configuration.rb

@@ -97,7 +97,7 @@ module HamlLint
     def validate
       ensure_exclude_option_array_exists
       ensure_linter_section_exists
-      ensure_linter_include_exclude_arrays_exist
+      ensure_linter_include_exclude_arrays_valid
       ensure_linter_severity_valid
     end
 
@@ -113,11 +113,11 @@ module HamlLint
 
     # Ensure `include` and `exclude` options for linters are arrays
     # (since users can specify a single string glob pattern for convenience)
-    def ensure_linter_include_exclude_arrays_exist
+    def ensure_linter_include_exclude_arrays_valid
       @hash['linters'].each_key do |linter_name|
         %w[include exclude].each do |option|
           linter_config = @hash['linters'][linter_name]
-          linter_config[option] = Array(linter_config[option])
+          linter_config[option] = Array(linter_config[option]) if linter_config[option]
         end
       end
     end

data/lib/haml_lint/linter/rubocop.rb

@@ -27,6 +27,14 @@ module HamlLint
       find_lints(extracted_source.source, extracted_source.source_map)
     end
 
+    # A single CLI instance is shared between files to avoid RuboCop
+    # having to repeatedly reload .rubocop.yml.
+    def self.rubocop_cli
+      # The ivar is stored on the class singleton rather than the Linter instance
+      # because it can't be Marshal.dump'd (as used by Parallel.map)
+      @rubocop_cli ||= ::RuboCop::CLI.new
+    end
+
     private
 
     # Executes RuboCop against the given Ruby code and records the offenses as
@@ -36,8 +44,6 @@ module HamlLint
     # @param source_map [Hash] map of Ruby code line numbers to original line
     #   numbers in the template
     def find_lints(ruby, source_map)
-      rubocop = ::RuboCop::CLI.new
-
       filename =
         if document.file
           "#{document.file}.rb"
@@ -46,7 +52,7 @@ module HamlLint
         end
 
       with_ruby_from_stdin(ruby) do
-        extract_lints_from_offenses(lint_file(rubocop, filename), source_map)
+        extract_lints_from_offenses(lint_file(self.class.rubocop_cli, filename), source_map)
       end
     end
 

data/lib/haml_lint/linter/space_before_script.rb

@@ -9,7 +9,7 @@ module HamlLint
 
     ALLOWED_SEPARATORS = [' ', '#'].freeze
 
-    def visit_tag(node) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    def visit_tag(node) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       # If this tag has inline script
       return unless node.contains_script?
 

data/lib/haml_lint/linter/space_inside_hash_attributes.rb

@@ -9,15 +9,15 @@ module HamlLint
     STYLE = {
       'no_space' => {
         start_regex: /\A\{[^ ]/,
-        end_regex: /[^ ]\}\z/,
+        end_regex: /(?:^\s*\}|[^ ]\})\z/,
         start_message: 'Hash attribute should start with no space after the opening brace',
-        end_message: 'Hash attribute should end with no space before the closing brace'
+        end_message: 'Hash attribute should end with no space before the closing brace or be on its own line'
       },
       'space' => {
-        start_regex: /\A\{ [^ ]/,
-        end_regex: /[^ ] \}\z/,
+        start_regex: /\A\{(?: [^ ]|$)/,
+        end_regex: /(?:^\s*\}|[^ ] \})\z/,
         start_message: 'Hash attribute should start with one space after the opening brace',
-        end_message: 'Hash attribute should end with one space before the closing brace'
+        end_message: 'Hash attribute should end with one space before the closing brace or be on its own line'
       }
     }.freeze
 

data/lib/haml_lint/linter_selector.rb

@@ -64,7 +64,7 @@ module HamlLint
     def run_linter_on_file?(config, linter, file)
       linter_config = config.for_linter(linter)
 
-      if linter_config['include'].any? &&
+      if linter_config['include'] &&
          !HamlLint::Utils.any_glob_matches?(linter_config['include'], file)
         return false
       end

data/lib/haml_lint/options.rb

@@ -38,7 +38,7 @@ module HamlLint
       end
 
       parser.on('--auto-gen-exclude-limit limit', Integer,
-                'Number of failures to allow in the TODO list before the entire rule is excluded') do |limit| # rubocop:disable Layout/LineLength
+                'Number of failures to allow in the TODO list before the entire rule is excluded') do |limit|
         @options[:auto_gen_exclude_limit] = limit
       end
 
@@ -62,7 +62,7 @@ module HamlLint
       parser.on('-r', '--reporter reporter', String,
                 'Specify which reporter you want to use to generate the output. One of:',
                 *reporters.map { |name| "  - #{name}" }) do |reporter|
-        @options[:reporter] = load_reporter_class(reporter.capitalize)
+        @options[:reporter] = load_reporter_class(reporter.split('-').map(&:capitalize).join)
       end
 
       parser.on('--fail-fast', 'Fail after the first file with lint at or above the fail level') do

data/lib/haml_lint/reporter/offense_count_reporter.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: false
+
+module HamlLint
+  # Outputs the a list of lints with a count of how many of each were found.
+  # Ordered by descending count
+  class Reporter::OffenseCountReporter < Reporter
+    def display_report(report)
+      lints = report.lints
+      total_count = lints.count
+      return if total_count.zero?
+
+      lints.group_by { |l| lint_type_group(l) }
+           .map { |linter, lints_for_this_linter| [linter, lints_for_this_linter.size] }.to_h
+           .sort_by { |_linter, lint_count| -lint_count }
+           .each do |linter, lint_count|
+        log.log "#{lint_count.to_s.ljust(total_count.to_s.length + 2)} #{linter}"
+      end
+
+      log.log '--'
+      log.log "#{total_count}  Total"
+    end
+
+    private
+
+    def lint_type_group(lint)
+      "#{lint.linter.name}#{offense_type(lint)}"
+    end
+
+    def offense_type(lint)
+      ": #{lint.message.to_s.split(':')[0]}" if lint.linter.name == 'RuboCop'
+    end
+  end
+end

data/lib/haml_lint/reporter.rb

@@ -32,7 +32,13 @@ module HamlLint
     #
     # @return [String]
     def self.cli_name
-      name.split('::').last.sub(/Reporter$/, '').downcase
+      name
+        .split('::')
+        .last
+        .sub(/Reporter$/, '')
+        .gsub(/([A-Z]+)([A-Z][a-z])/, '\1-\2')
+        .gsub(/([a-z\d])([A-Z])/, '\1-\2')
+        .downcase
     end
 
     # Creates the reporter that will display the given report.

data/lib/haml_lint/tree/script_node.rb

@@ -9,7 +9,13 @@ module HamlLint::Tree
     #
     # @return [ParsedRuby] syntax tree in the form returned by Parser gem
     def parsed_script
-      HamlLint::ParsedRuby.new(HamlLint::RubyParser.new.parse(script))
+      statement =
+        if children.empty?
+          script
+        else
+          "#{script}#{@value[:keyword] == 'case' ? ';when 0;end' : ';end'}"
+        end
+      HamlLint::ParsedRuby.new(HamlLint::RubyParser.new.parse(statement))
     end
 
     # Returns the source for the script following the `-` marker.

data/lib/haml_lint/tree/silent_script_node.rb

@@ -8,7 +8,22 @@ module HamlLint::Tree
     #
     # @return [ParsedRuby] syntax tree in the form returned by Parser gem
     def parsed_script
-      HamlLint::ParsedRuby.new(HamlLint::RubyParser.new.parse(script))
+      statement =
+        case keyword = @value[:keyword]
+        when 'else', 'elsif'
+          'if 0;' + script + ';end'
+        when 'when'
+          'case;' + script + ';end'
+        when 'rescue', 'ensure'
+          'begin;' + script + ';end'
+        else
+          if children.empty?
+            script
+          else
+            "#{script}#{keyword == 'case' ? ';when 0;end' : ';end'}"
+          end
+        end
+      HamlLint::ParsedRuby.new(HamlLint::RubyParser.new.parse(statement))
     end
 
     # Returns the source for the script following the `-` marker.

data/lib/haml_lint/utils.rb

@@ -52,7 +52,7 @@ module HamlLint
     #   the text.
     # @yieldparam interpolated_code [String] code that was interpolated
     # @yieldparam line [Integer] line number code appears on in text
-    def extract_interpolated_values(text) # rubocop:disable Metrics/AbcSize
+    def extract_interpolated_values(text)
       dumped_text = text.dump
       newline_positions = extract_substring_positions(dumped_text, '\\\n')
 

data/lib/haml_lint/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: haml_lint
 version: !ruby/object:Gem::Version
-  version: 0.36.0
+  version: 0.40.1
 platform: ruby
 authors:
 - Shane da Silva
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-01 00:00:00.000000000 Z
+date: 2022-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -158,6 +158,7 @@ files:
 - lib/haml_lint/reporter/hash_reporter.rb
 - lib/haml_lint/reporter/hooks.rb
 - lib/haml_lint/reporter/json_reporter.rb
+- lib/haml_lint/reporter/offense_count_reporter.rb
 - lib/haml_lint/reporter/progress_reporter.rb
 - lib/haml_lint/reporter/utils.rb
 - lib/haml_lint/ruby_extractor.rb
@@ -200,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.1
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: HAML lint tool