haml_lint 0.23.2 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e1e7727e9ee3dadac7fe5fbc6ba6e4a42e482b5
-  data.tar.gz: 7176808267f479eeb56757133e8c0015c4841b77
+  metadata.gz: fe12a287eaf253fd83053061ac62a26b908918e6
+  data.tar.gz: cf8bae7a2e75dde6befbe09a9764fb223ea72583
 SHA512:
-  metadata.gz: c944db1432ca3b9133769fde9173b0dee6ec253f0ac1d16d5d194fce086bfce9952ae49603a196b3d9fc30dbd93572d067169490483ee01b14c36433cdb49c32
-  data.tar.gz: e533c56866c2ad9702be3461068cb2aab5fe73c1a39eaf059bfae0850628a1145c67e832eae29f663f6b336d96bff8851d0dcafd8feebb1972767af8c89c6e67
+  metadata.gz: 55334bc83c7c8f377c78b290db34ba08a2939bd9179e06541d27f3919118d3942500c85a5028ad2dde31a868ac82c4bd49b7ebf6492ec14400ae0f8b213e72d5
+  data.tar.gz: 84e178971e6068b40dd896f49efac863a244a8ed952b4d4d45d93872d6a2030a68134721c2cffbba94cffc5d3b11b88283b487c35a1d3907132eab86df44eb26

data/config/default.yml

@@ -47,6 +47,11 @@ linters:
   ImplicitDiv:
     enabled: true
 
+  Indentation:
+    enabled: true
+    character: space # or tab
+    width: 2 # ignored if character == tab
+
   InstanceVariables:
     enabled: true
     file_types: partials
@@ -108,10 +113,6 @@ linters:
     enabled: true
     style: space
 
-  Indentation:
-    enabled: true
-    character: space # or tab
-
   TagName:
     enabled: true
 

data/lib/haml_lint/cli.rb

@@ -83,12 +83,26 @@ module HamlLint
       end
     end
 
+    # Instantiates a new reporter based on the options.
+    #
+    # @param options [HamlLint::Configuration]
+    # @option options [true, nil] :auto_gen_config whether to use the config
+    #   generating reporter
+    # @option options [Class] :reporter the class of reporter to use
+    # @return [HamlLint::Reporter]
+    def reporter_from_options(options)
+      if options[:auto_gen_config]
+        HamlLint::Reporter::DisabledConfigReporter.new(log)
+      else
+        options.fetch(:reporter, HamlLint::Reporter::DefaultReporter).new(log)
+      end
+    end
+
     # Scans the files specified by the given options for lints.
     #
     # @return [Integer] exit status code
     def scan_for_lints(options)
-      reporter = options.fetch(:reporter,
-                               HamlLint::Reporter::DefaultReporter).new(log)
+      reporter = reporter_from_options(options)
       report = Runner.new.run(options.merge(reporter: reporter))
       report.display
       report.failed? ? Sysexits::EX_DATAERR : Sysexits::EX_OK

data/lib/haml_lint/configuration_loader.rb

@@ -6,6 +6,7 @@ require 'yaml'
 module HamlLint
   # Manages configuration file loading.
   class ConfigurationLoader
+    AUTO_GENERATED_FILE = '.haml-lint_todo.yml'.freeze
     DEFAULT_CONFIG_PATH = File.join(HamlLint::HOME, 'config', 'default.yml').freeze
     CONFIG_FILE_NAME = '.haml-lint.yml'.freeze
 
@@ -31,11 +32,14 @@ module HamlLint
       # Loads a configuration, ensuring it extends the default configuration.
       #
       # @param file [String]
+      # @param loaded_files [Array<String>] any previously loaded files in an
+      #   inheritance chain
       # @return [HamlLint::Configuration]
-      def load_file(file)
+      def load_file(file, loaded_files = [])
         config = load_from_file(file)
 
-        default_configuration.merge(config)
+        [default_configuration, resolve_inheritance(config, loaded_files), config]
+          .reduce { |acc, elem| acc.merge(elem) }
       rescue Psych::SyntaxError, Errno::ENOENT => error
         raise HamlLint::Exceptions::ConfigurationError,
               "Unable to load configuration from '#{file}': #{error}",
@@ -67,6 +71,11 @@ module HamlLint
             {}
           end
 
+        if hash.key?('inherit_from')
+          hash['inherits_from'] ||= []
+          hash['inherits_from'].concat(Array(hash.delete('inherit_from')))
+        end
+
         HamlLint::Configuration.new(hash)
       end
 
@@ -81,6 +90,33 @@ module HamlLint
                         .map { |path| path + CONFIG_FILE_NAME }
         files << Pathname.new(CONFIG_FILE_NAME)
       end
+
+      # Resolves an inherited file and loads it.
+      #
+      # @param file [String] the path to the file
+      # @param loaded_files [Array<String>] previously loaded files in the
+      #   inheritance chain
+      # @return [HamlLint::Configuration, nil]
+      def resolve(file, loaded_files)
+        return unless File.exist?(file)
+        return if loaded_files.include?(file)
+
+        loaded_files << file
+        load_file(file, loaded_files)
+      end
+
+      # Resolves the chain of `inherits_from` directives in a configuration.
+      #
+      # @param config [HamlLint::Configuration] the pre-existing configuration
+      # @param loaded_files [Array<String>] any previously loaded files in an
+      #   inheritance chain
+      # @return [HamlLint::Configuration]
+      def resolve_inheritance(config, loaded_files)
+        Array(config['inherits_from'])
+          .map { |config_file| resolve(config_file, loaded_files) }
+          .compact
+          .reduce { |acc, elem| acc.merge(elem) } || config
+      end
     end
   end
 end

data/lib/haml_lint/linter/indentation.rb

@@ -9,15 +9,51 @@ module HamlLint
       tab: /^\t*(?![ ])/,
     }.freeze
 
+    LEADING_SPACES_REGEX = /^( +)(?! )/
+
     def visit_root(root)
-      regex = INDENT_REGEX[config['character'].to_sym]
+      character = config['character'].to_sym
+      check_character(character, root)
+
+      width = config['width'].to_i
+      check_width(width, root) if character == :space && width > 0
+    end
+
+    private
+
+    # validate that indentation matches config characters (either spaces or tabs)
+    def check_character(character, root)
+      wrong_characters = character == :space ? 'tabs' : 'spaces'
+      regex = INDENT_REGEX[character]
       dummy_node = Struct.new(:line)
 
       document.source_lines.each_with_index do |line, index|
         next if line =~ regex
 
         unless root.node_for_line(index).disabled?(self)
-          record_lint dummy_node.new(index + 1), 'Line contains tabs in indentation'
+          record_lint dummy_node.new(index + 1), "Line contains #{wrong_characters} in indentation"
+        end
+      end
+    end
+
+    # validate that indentation matches config width (only for spaces)
+    def check_width(width, root)
+      dummy_node = Struct.new(:line)
+
+      root.children.each do |top_node|
+        # once we've found one line with leading space, there's no need to check any more lines
+        # `haml` will check indenting_at_start, deeper_indenting, inconsistent_indentation
+        break if top_node.children.find do |node|
+          line = node.source_code
+          leading_space = LEADING_SPACES_REGEX.match(line)
+
+          break unless leading_space && !node.disabled?(self)
+
+          if leading_space[1] != ' ' * width
+            record_lint dummy_node.new(node.line), "File does not use #{width}-space indentation"
+          end
+
+          break true
         end
       end
     end

data/lib/haml_lint/linter.rb

@@ -27,6 +27,16 @@ module HamlLint
       @lints = []
       visit(document.tree)
       @lints
+    rescue Parser::SyntaxError => ex
+      location = ex.diagnostic.location
+      @lints <<
+        HamlLint::Lint.new(
+          HamlLint::Linter::Syntax.new(config),
+          document.file,
+          location.line,
+          ex.to_s,
+          :error
+        )
     end
 
     # Returns the simple name for this linter.

data/lib/haml_lint/options.rb

@@ -21,7 +21,7 @@ module HamlLint
       end.parse!(args)
 
       # Any remaining arguments are assumed to be files
-      @options[:files] = args
+      @options[:files] = args.empty? ? ["."] : args
 
       @options
     rescue OptionParser::InvalidOption => ex
@@ -33,6 +33,10 @@ module HamlLint
     private
 
     def add_linter_options(parser)
+      parser.on('--auto-gen-config', 'Generate a configuration file acting as a TODO list') do
+        @options[:auto_gen_config] = true
+      end
+
       parser.on('-i', '--include-linter linter,...', Array,
                 'Specify which linters you want to run') do |linters|
         @options[:included_linters] = linters

data/lib/haml_lint/reporter/disabled_config_reporter.rb

@@ -0,0 +1,105 @@
+require 'haml_lint/reporter/progress_reporter'
+
+module HamlLint
+  # Outputs a YAML configuration file based on existing violations.
+  class Reporter::DisabledConfigReporter < Reporter::ProgressReporter
+    HEADING =
+      ['# This configuration was generated by',
+       '# `haml-lint --auto-gen-config`',
+       "# on #{Time.now} using Haml-Lint version #{HamlLint::VERSION}.",
+       '# The point is for the user to remove these configuration records',
+       '# one by one as the lints are removed from the code base.',
+       '# Note that changes in the inspected code, or installation of new',
+       '# versions of Haml-Lint, may require this file to be generated again.']
+      .join("\n")
+
+    # Disables this reporter on the CLI since it doesn't output anything.
+    #
+    # @return [false]
+    def self.available?
+      false
+    end
+
+    # Create the reporter that will display the report and write the config.
+    #
+    # @param _log [HamlLint::Logger]
+    def initialize(_log)
+      super
+      @linters_with_lints = Hash.new { |hash, key| hash[key] = [] }
+      @linters_lint_count = Hash.new(0)
+    end
+
+    # A hash of linters with the files that have that type of lint.
+    #
+    # @return [Hash<String, Integer] a Hash with linter name keys and lint
+    #   count values
+    attr_reader :linters_lint_count
+
+    # A hash of linters with the files that have that type of lint.
+    #
+    # @return [Hash<String, Array<String>>] a Hash with linter name keys and file
+    #   name list values
+    attr_reader :linters_with_lints
+
+    # Prints the standard progress reporter output and writes the new config file.
+    #
+    # @param report [HamlLint::Report]
+    # @return [void]
+    def display_report(report)
+      super
+
+      File.write(ConfigurationLoader::AUTO_GENERATED_FILE, config_file_contents)
+      log.log "Created #{ConfigurationLoader::AUTO_GENERATED_FILE}."
+      log.log "Run `haml-lint --config #{ConfigurationLoader::AUTO_GENERATED_FILE}`" \
+        ", or add `inherits_from: #{ConfigurationLoader::AUTO_GENERATED_FILE}` in a " \
+        '.haml-lint.yml file.'
+    end
+
+    # Prints the standard progress report marks and tracks files with lint.
+    #
+    # @param file [String]
+    # @param lints [Array<HamlLint::Lint>]
+    # @return [void]
+    def finished_file(file, lints)
+      super
+
+      if lints.any?
+        lints.each do |lint|
+          linters_with_lints[lint.linter.name] |= [lint.filename]
+          linters_lint_count[lint.linter.name] += 1
+        end
+      end
+    end
+
+    private
+
+    # The contents of the generated configuration file based on captured lint.
+    #
+    # @return [String] a Yaml-formatted configuration file's contents
+    def config_file_contents
+      output = []
+      output << HEADING
+      output << 'linters:' if linters_with_lints.any?
+      linters_with_lints.each do |linter, files|
+        output << generate_config_for_linter(linter, files)
+      end
+      output.join("\n\n")
+    end
+
+    # Constructs the configuration for excluding a linter in some files.
+    #
+    # @param linter [String] the name of the linter to exclude
+    # @param files [Array<String>] the files in which the linter is excluded
+    # @return [String] a Yaml-formatted configuration
+    def generate_config_for_linter(linter, files)
+      [].tap do |output|
+        output << "  # Offense count: #{linters_lint_count[linter]}"
+        output << "  #{linter}:"
+        output << '    exclude:'
+        files.each do |filename|
+          output << %{      - "#{filename}"}
+        end
+      end.join("\n")
+    end
+  end
+end

data/lib/haml_lint/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haml_lint
 version: !ruby/object:Gem::Version
-  version: 0.23.2
+  version: 0.24.0
 platform: ruby
 authors:
 - Brigade Engineering
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-15 00:00:00.000000000 Z
+date: 2017-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -160,6 +160,7 @@ files:
 - lib/haml_lint/reporter.rb
 - lib/haml_lint/reporter/checkstyle_reporter.rb
 - lib/haml_lint/reporter/default_reporter.rb
+- lib/haml_lint/reporter/disabled_config_reporter.rb
 - lib/haml_lint/reporter/hash_reporter.rb
 - lib/haml_lint/reporter/hooks.rb
 - lib/haml_lint/reporter/json_reporter.rb