haml_lint 0.15.2 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 80e71cdb5e58b93dd53b7e4fe3eef1bba2002af5
-  data.tar.gz: a724e0a1cb1748cce64d430cd4ba34e82fc904ec
+  metadata.gz: 4dc951907854f1ef5fe256a2868825b5ce382501
+  data.tar.gz: 1ee304256e171748b98bab3fb375fca6549f2b16
 SHA512:
-  metadata.gz: 202ce87309496ebb5372e607f734348e9532a1c83cde72ada2b88fe2e6a5b5d4d26459b181de83e838bd35685dd12b36bf0b7b25405351811f734a809f78d6c8
-  data.tar.gz: f82080cf1c10090eee512efd10ef85eac22e751d49d488e9f94d889eed191c1203b85bd00411c1cb3b77a1076a93908ce18078213f9906427e1a2f51d8212ac2
+  metadata.gz: 08fa8027ec5658c01c88b999202da378051c6fc421be0e5dd5226d7a6cbb23ad27cd0f0db334dfe329ccb2a20261abb1141e34f4b03935f48ebc3a436791e694
+  data.tar.gz: 094fcc02c2900bbacb8c740b5862c103e1e32c68d9dbf5e304500af5d9cbce5c9cdf32bd69f2373208ea6fdbe4185f497883760913120549d0cfbef124d596b5

data/lib/haml_lint/configuration.rb

@@ -32,7 +32,6 @@ module HamlLint
     def ==(other)
       super || @hash == other.hash
     end
-    alias_method :eql?, :==
 
     # Returns a non-modifiable configuration for the specified linter.
     #

data/lib/haml_lint/configuration_loader.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'yaml'
 
 module HamlLint
   # Manages configuration file loading.
   class ConfigurationLoader
-    DEFAULT_CONFIG_PATH = File.join(HamlLint::HOME, 'config', 'default.yml')
-    CONFIG_FILE_NAME = '.haml-lint.yml'
+    DEFAULT_CONFIG_PATH = File.join(HamlLint::HOME, 'config', 'default.yml').freeze
+    CONFIG_FILE_NAME = '.haml-lint.yml'.freeze
 
     class << self
       # Load configuration file given the current working directory the

data/lib/haml_lint/constants.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 # Global application constants.
 module HamlLint
-  HOME = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
-  APP_NAME = 'haml-lint'
+  HOME = File.expand_path(File.join(File.dirname(__FILE__), '..', '..')).freeze
+  APP_NAME = 'haml-lint'.freeze
 
-  REPO_URL = 'https://github.com/brigade/haml-lint'
-  BUG_REPORT_URL = "#{REPO_URL}/issues"
+  REPO_URL = 'https://github.com/brigade/haml-lint'.freeze
+  BUG_REPORT_URL = "#{REPO_URL}/issues".freeze
 end

data/lib/haml_lint/document.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module HamlLint
   # Represents a parsed Haml document and its associated metadata.
   class Document
     # File name given to source code parsed from just a string.
-    STRING_SOURCE = '(string)'
+    STRING_SOURCE = '(string)'.freeze
 
     # @return [HamlLint::Configuration] Configuration used to parse template
     attr_reader :config

data/lib/haml_lint/file_finder.rb

@@ -6,7 +6,7 @@ module HamlLint
   class FileFinder
     # List of extensions of files to include under a directory when a directory
     # is specified instead of a file.
-    VALID_EXTENSIONS = %w[.haml]
+    VALID_EXTENSIONS = %w[.haml].freeze
 
     # Create a file finder using the specified configuration.
     #

data/lib/haml_lint/linter/class_attribute_with_static_value.rb

@@ -12,8 +12,7 @@ module HamlLint
   class Linter::ClassAttributeWithStaticValue < Linter
     include LinterRegistry
 
-    STATIC_TYPES = [:str, :sym]
-    STATIC_CLASSES = [String, Symbol]
+    STATIC_TYPES = [:str, :sym].freeze
 
     def visit_tag(node)
       return unless contains_class_attribute?(node.dynamic_attributes_sources)
@@ -26,11 +25,8 @@ module HamlLint
 
     def contains_class_attribute?(attributes_sources)
       attributes_sources.each do |code|
-        begin
-          ast_root = parse_ruby(code.start_with?('{') ? code : "{#{code}}")
-        rescue ::Parser::SyntaxError
-          next # RuboCop linter will report syntax errors
-        end
+        ast_root = parse_ruby(code.start_with?('{') ? code : "{#{code}}")
+        next unless ast_root # RuboCop linter will report syntax errors
 
         ast_root.children.each do |pair|
           return true if static_class_attribute_value?(pair)
@@ -45,7 +41,7 @@ module HamlLint
 
       STATIC_TYPES.include?(key.type) &&
         key.children.first.to_sym == :class &&
-        STATIC_CLASSES.include?(value.children.first.class)
+        STATIC_TYPES.include?(value.type)
     end
   end
 end

data/lib/haml_lint/linter/classes_before_ids.rb

@@ -7,7 +7,7 @@ module HamlLint
     TYPES_BY_PREFIX = {
       '.' => :class,
       '#' => :id,
-    }
+    }.freeze
 
     def visit_tag(node)
       # Convert ".class#id" into [.class, #id] (preserving order)

data/lib/haml_lint/linter/final_newline.rb

@@ -12,9 +12,9 @@ module HamlLint
       if config['present']
         record_lint(dummy_node,
                     'Files should end with a trailing newline') unless ends_with_newline
-      else
+      elsif ends_with_newline
         record_lint(dummy_node,
-                    'Files should not end with a trailing newline') if ends_with_newline
+                    'Files should not end with a trailing newline')
       end
     end
   end

data/lib/haml_lint/linter/indentation.rb

@@ -7,7 +7,7 @@ module HamlLint
     INDENT_REGEX = {
       space: /^[ ]*(?!\t)/,
       tab: /^\t*(?![ ])/,
-    }
+    }.freeze
 
     def visit_root(_node)
       regex = INDENT_REGEX[config['character'].to_sym]

data/lib/haml_lint/linter/leading_comment_space.rb

@@ -6,7 +6,7 @@ module HamlLint
     def visit_haml_comment(node)
       # Skip if the node spans multiple lines starting on the second line,
       # or starts with a space
-      return if node.text.match(/\A(\s*|\s+\S.*)$/)
+      return if node.text =~ /\A(\s*|\s+\S.*)$/
 
       record_lint(node, 'Comment should have a space after the `#`')
     end

data/lib/haml_lint/linter/line_length.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module HamlLint
   # Checks for lines longer than a maximum number of columns.
   class Linter::LineLength < Linter
     include LinterRegistry
 
-    MSG = 'Line is too long. [%d/%d]'
+    MSG = 'Line is too long. [%d/%d]'.freeze
 
     def visit_root(_node)
       max_length = config['max']

data/lib/haml_lint/linter/multiline_pipe.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module HamlLint
   # Checks for uses of the multiline pipe character.
   class Linter::MultilinePipe < Linter
     include LinterRegistry
 
     MESSAGE = "Don't use the `|` character to split up lines. " \
-              'Wrap on commas or extract code into helper.'
+              'Wrap on commas or extract code into helper.'.freeze
 
     def visit_tag(node)
       check(node)

data/lib/haml_lint/linter/multiline_script.rb

@@ -32,6 +32,19 @@ module HamlLint
     private
 
     def check(node)
+      # Condition occurs when scripts do not contain nested content, e.g.
+      #
+      #   - if condition ||      <-- no children; its sibling is a continuation
+      #   -    other_condition
+      #
+      # ...whereas when it contains nested content it's not a multiline script:
+      #
+      #   - begin                <-- has children
+      #     some_helper
+      #   - rescue
+      #     An error occurred
+      return unless node.children.empty?
+
       operator = node.script[/\s+(\S+)\z/, 1]
       if SPLIT_OPERATORS.include?(operator)
         record_lint(node,

data/lib/haml_lint/linter/space_before_script.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module HamlLint
   # Checks for Ruby script in HAML templates with no space after the `=`/`-`.
   class Linter::SpaceBeforeScript < Linter
     include LinterRegistry
 
-    MESSAGE_FORMAT = 'The %s symbol should have one space separating it from code'
+    MESSAGE_FORMAT = 'The %s symbol should have one space separating it from code'.freeze
 
     def visit_tag(node) # rubocop:disable Metrics/CyclomaticComplexity
       # If this tag has inline script

data/lib/haml_lint/linter/space_inside_hash_attributes.rb

@@ -17,7 +17,7 @@ module HamlLint
         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'
       }
-    }
+    }.freeze
 
     def visit_tag(node)
       return unless node.hash_attributes?

data/lib/haml_lint/linter/tag_name.rb

@@ -5,7 +5,7 @@ module HamlLint
 
     def visit_tag(node)
       tag = node.tag_name
-      return unless tag.match(/[A-Z]/)
+      return unless tag =~ /[A-Z]/
 
       record_lint(node, "`#{tag}` should be written in lowercase as `#{tag.downcase}`")
     end

data/lib/haml_lint/linter/unnecessary_string_output.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module HamlLint
   # Checks for unnecessary outputting of strings in Ruby script tags.
   #
@@ -9,7 +11,7 @@ module HamlLint
   class Linter::UnnecessaryStringOutput < Linter
     include LinterRegistry
 
-    MESSAGE = '`= "..."` should be rewritten as `...`'
+    MESSAGE = '`= "..."` should be rewritten as `...`'.freeze
 
     def visit_tag(node)
       if tag_has_inline_script?(node) && inline_content_is_string?(node)

data/lib/haml_lint/linter_selector.rb

@@ -29,13 +29,13 @@ module HamlLint
     # @param options [Hash]
     # @return [Array<HamlLint::Linter>]
     def extract_enabled_linters(config, options)
-      included_linters = LinterRegistry
-        .extract_linters_from(options.fetch(:included_linters, []))
+      included_linters =
+        LinterRegistry.extract_linters_from(options.fetch(:included_linters, []))
 
       included_linters = LinterRegistry.linters if included_linters.empty?
 
-      excluded_linters = LinterRegistry
-        .extract_linters_from(options.fetch(:excluded_linters, []))
+      excluded_linters =
+        LinterRegistry.extract_linters_from(options.fetch(:excluded_linters, []))
 
       # After filtering out explicitly included/excluded linters, only include
       # linters which are enabled in the configuration

data/lib/haml_lint/ruby_extractor.rb

@@ -22,7 +22,7 @@ module HamlLint
   # The translation won't be perfect, and won't make any real sense, but the
   # relationship between variable declarations/uses and the flow control graph
   # will remain intact.
-  class RubyExtractor
+  class RubyExtractor # rubocop:disable Metrics/ClassLength
     include HamlVisitor
 
     # Stores the extracted source and a map of lines of generated source to the
@@ -47,6 +47,7 @@ module HamlLint
       @source_map = {}
       @line_count = 0
       @indent_level = 0
+      @output_count = 0
 
       yield # Collect lines of code from children
     end
@@ -55,7 +56,7 @@ module HamlLint
       # Don't output the text, as we don't want to have to deal with any RuboCop
       # cops regarding StringQuotes or AsciiComments, and it's not important to
       # overall document anyway.
-      add_line('puts', node)
+      add_dummy_puts(node)
     end
 
     def visit_tag(node)
@@ -78,7 +79,7 @@ module HamlLint
 
       # We add a dummy puts statement to represent the tag name being output.
       # This prevents some erroneous RuboCop warnings.
-      add_line("puts # #{node.tag_name}", node)
+      add_dummy_puts(node, node.tag_name)
 
       code = node.script.strip
       add_line(code, node) unless code.empty?
@@ -86,7 +87,7 @@ module HamlLint
 
     def after_visit_tag(node)
       # We add a dummy puts statement for closing tag.
-      add_line("puts # #{node.tag_name}/", node)
+      add_dummy_puts(node, "#{node.tag_name}/")
     end
 
     def visit_script(node)
@@ -111,13 +112,13 @@ module HamlLint
       visit_script(node, &block)
     end
 
-    def visit_filter(node)
+    def visit_filter(node) # rubocop:disable Metrics/AbcSize
       if node.filter_type == 'ruby'
         node.text.split("\n").each_with_index do |line, index|
           add_line(line, node.line + index + 1)
         end
       else
-        add_line('puts', node)
+        add_dummy_puts(node, ":#{node.filter_type}")
         HamlLint::Utils.extract_interpolated_values(node.text) do |interpolated_code, line|
           add_line(interpolated_code, node.line + line)
         end
@@ -139,6 +140,14 @@ module HamlLint
       end
     end
 
+    # Adds a dummy method call with a unique name so we don't get
+    # Style/IdenticalConditionalBranches RuboCop warnings
+    def add_dummy_puts(node, annotation = nil)
+      annotation = " # #{annotation}" if annotation
+      add_line("_haml_lint_puts_#{@output_count}#{annotation}", node)
+      @output_count += 1
+    end
+
     def add_line(code, node_or_line)
       return if code.empty?
 
@@ -172,20 +181,21 @@ module HamlLint
       text =~ /\bdo\s*(\|\s*[^\|]*\s*\|)?(\s*#.*)?\z/
     end
 
-    START_BLOCK_KEYWORDS = %w[if unless case begin for until while]
+    START_BLOCK_KEYWORDS = %w[if unless case begin for until while].freeze
     def start_block_keyword?(text)
       START_BLOCK_KEYWORDS.include?(block_keyword(text))
     end
 
-    MID_BLOCK_KEYWORDS = %w[else elsif when rescue ensure]
+    MID_BLOCK_KEYWORDS = %w[else elsif when rescue ensure].freeze
     def mid_block_keyword?(text)
       MID_BLOCK_KEYWORDS.include?(block_keyword(text))
     end
 
+    LOOP_KEYWORDS = %w[for until while].freeze
     def block_keyword(text)
       # Need to handle 'for'/'while' since regex stolen from HAML parser doesn't
       if keyword = text[/\A\s*([^\s]+)\s+/, 1]
-        return keyword if %w[for until while].include?(keyword)
+        return keyword if LOOP_KEYWORDS.include?(keyword)
       end
 
       return unless keyword = text.scan(Haml::Parser::BLOCK_KEYWORD_REGEX)[0]

data/lib/haml_lint/ruby_parser.rb

@@ -1,16 +1,18 @@
-require 'astrolabe/builder'
+require 'rubocop'
+require 'rubocop/ast_node/builder'
 require 'parser/current'
 
 module HamlLint
   # Parser for the Ruby language.
   #
   # This provides a convenient wrapper around the `parser` gem and the
-  # `astrolabe` integration to go with it. It is intended to be used for linter
+  # Astrolabe integration (now built-in to RuboCop, so no longer called
+  # Astrolabe) to go with it. It is intended to be used for linter
   # checks that require deep inspection of Ruby code.
   class RubyParser
     # Creates a reusable parser.
     def initialize
-      @builder = ::Astrolabe::Builder.new
+      @builder = ::RuboCop::Node::Builder.new
       @parser = ::Parser::CurrentRuby.new(@builder)
     end
 

data/lib/haml_lint/tree/node.rb

@@ -28,9 +28,11 @@ module HamlLint::Tree
     #
     # Returns nil if no node matching the given block was found.
     #
+    # @yieldparam [HamlLint::Tree::Node] node
+    # @yieldreturn [Boolean] whether the node matches
     # @return [HamlLint::Tree::Node,nil]
     def find(&block)
-      return self if block.call(self)
+      return self if yield(self)
 
       children.each do |child|
         if result = child.find(&block)
@@ -53,8 +55,8 @@ module HamlLint::Tree
         end
 
       @document.source_lines[@line - 1...next_node_line]
-               .join("\n")
-               .gsub(/^\s*\z/m, '') # Remove blank lines at the end
+        .join("\n")
+        .gsub(/^\s*\z/m, '') # Remove blank lines at the end
     end
 
     def inspect

data/lib/haml_lint/tree/tag_node.rb

@@ -87,8 +87,8 @@ module HamlLint::Tree
     def attributes_source
       @attr_source ||=
         begin
-          _explicit_tag, static_attrs, rest = source_code
-            .scan(/\A\s*(%[-:\w]+)?([-:\w\.\#]*)(.*)/m)[0]
+          _explicit_tag, static_attrs, rest =
+            source_code.scan(/\A\s*(%[-:\w]+)?([-:\w\.\#]*)(.*)/m)[0]
 
           attr_types = {
             '{' => [:hash, %w[{ }]],

data/lib/haml_lint/utils.rb

@@ -105,9 +105,9 @@ module HamlLint
     #   inclusion
     # @yieldreturn [Boolean] whether to include the item
     # @return [Integer]
-    def count_consecutive(items, offset = 0, &block)
+    def count_consecutive(items, offset = 0)
       count = 1
-      count += 1 while (offset + count < items.count) && block.call(items[offset + count])
+      count += 1 while (offset + count < items.count) && yield(items[offset + count])
       count
     end
 

data/lib/haml_lint/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 # Defines the gem version.
 module HamlLint
-  VERSION = '0.15.2'
+  VERSION = '0.16.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haml_lint
 version: !ruby/object:Gem::Version
-  version: 0.15.2
+  version: 0.16.0
 platform: ruby
 authors:
 - Brigade Engineering
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-08 00:00:00.000000000 Z
+date: 2016-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -25,20 +25,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.25.0
+        version: 0.36.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.25.0
+        version: 0.36.0
 - !ruby/object:Gem::Dependency
   name: sysexits
   requirement: !ruby/object:Gem::Requirement
@@ -171,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: HAML lint tool