haml_lint 0.14.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 350f098b45d24d55363ac279caf35694dfbdcfda
-  data.tar.gz: 76c0227e9aeb398ac1397003f9c1bc943c99cf02
+  metadata.gz: fa23a0a6cf7859c1d52147bb83dffea555ca12ef
+  data.tar.gz: f68ba67d32f4d76cb0632b69ff10e3d801f4e0e8
 SHA512:
-  metadata.gz: 4c9fd9c3c414411cd8a40d0334ca2f716259874a765f3c3ebf0ba3b8513c1993fb3147706986a1b6f234713a1e22be660e6d16081514cea582e68a4aade5dda9
-  data.tar.gz: 32549d3f2c75d75451637be9dcd46b27ceb76db5e0255365ff9cc0a2ffc89e6dccfd2f424501fc6fb07bcb1277bc14fb35fecc5011c3d907ffde3e3bee7cabf9
+  metadata.gz: adbaa7dba069ef58a9522a8b5ad7ce39f21aa54a9aa3fe132799f6f2fee929f7510df2029bb6e55d2a4776a8fb1e091c5896ece3a3b1b73ffcc897df44b15c64
+  data.tar.gz: 8e8246c549c8322a202885179c301f98e5e818aefdb2badc9c0fa83ee4974366d88dee6da61f2a0df571df05829950be26e8ada196e00c4f3ad90ce024235655

data/config/default.yml

@@ -27,6 +27,10 @@ linters:
   EmptyScript:
     enabled: true
 
+  FinalNewline:
+    enabled: true
+    present: true
+
   HtmlAttributes:
     enabled: true
 
@@ -79,6 +83,10 @@ linters:
     enabled: true
     style: space
 
+  Indentation:
+    enabled: true
+    character: space # or tab
+
   TagName:
     enabled: true
 

data/lib/haml_lint/cli.rb

@@ -5,7 +5,7 @@ require 'sysexits'
 
 module HamlLint
   # Command line application interface.
-  class CLI
+  class CLI # rubocop:disable Metrics/ClassLength
     # Create a CLI that outputs to the specified logger.
     #
     # @param logger [HamlLint::Logger]
@@ -38,8 +38,8 @@ module HamlLint
       if options[:help]
         print_help(options)
         Sysexits::EX_OK
-      elsif options[:version]
-        print_version
+      elsif options[:version] || options[:verbose_version]
+        print_version(options)
         Sysexits::EX_OK
       elsif options[:show_linters]
         print_available_linters
@@ -123,17 +123,34 @@ module HamlLint
     end
 
     # Outputs the application name and version.
-    def print_version
+    def print_version(options)
       log.log "#{HamlLint::APP_NAME} #{HamlLint::VERSION}"
+
+      if options[:verbose_version]
+        log.log "haml #{Gem.loaded_specs['haml'].version}"
+        log.log "rubocop #{Gem.loaded_specs['rubocop'].version}"
+        log.log RUBY_DESCRIPTION
+      end
     end
 
     # Outputs the backtrace of an exception with instructions on how to report
     # the issue.
-    def print_unexpected_exception(ex)
+    def print_unexpected_exception(ex) # rubocop:disable Metrics/AbcSize
       log.bold_error ex.message
       log.error ex.backtrace.join("\n")
       log.warning 'Report this bug at ', false
       log.info HamlLint::BUG_REPORT_URL
+      log.newline
+      log.success 'To help fix this issue, please include:'
+      log.log '- The above stack trace'
+      log.log '- Haml-Lint version: ', false
+      log.info HamlLint::VERSION
+      log.log '- Haml version: ', false
+      log.info Gem.loaded_specs['haml'].version
+      log.log '- RuboCop version: ', false
+      log.info Gem.loaded_specs['rubocop'].version
+      log.log '- Ruby version: ', false
+      log.info RUBY_VERSION
     end
   end
 end

data/lib/haml_lint/document.rb

@@ -35,12 +35,15 @@ module HamlLint
     private
 
     # @param source [String] Haml code to parse
-    # @raise [Haml::Parser::Error] if there was a problem parsing the document
+    # @raise [HamlLint::Exceptions::ParseError] if there was a problem parsing
     def process_source(source)
       @source = strip_frontmatter(source)
       @source_lines = @source.split("\n")
 
       @tree = process_tree(Haml::Parser.new(@source, Haml::Options.new).parse)
+    rescue Haml::Error => ex
+      error = HamlLint::Exceptions::ParseError.new(ex.message, ex.line)
+      raise error
     end
 
     # Processes the {Haml::Parser::ParseNode} tree and returns a tree composed

data/lib/haml_lint/exceptions.rb

@@ -9,6 +9,9 @@ module HamlLint::Exceptions
   # Raised when an invalid file path is specified
   class InvalidFilePath < StandardError; end
 
+  # Raised when a problem occurs parsing a HAML document.
+  class ParseError < ::Haml::SyntaxError; end
+
   # Raised when attempting to execute `Runner` with options that would result in
   # no linters being enabled.
   class NoLintersError < StandardError; end

data/lib/haml_lint/linter/final_newline.rb

@@ -0,0 +1,21 @@
+module HamlLint
+  # Checks for final newlines at the end of a file.
+  class Linter::FinalNewline < Linter
+    include LinterRegistry
+
+    def visit_root(_node)
+      return if document.source.empty?
+
+      dummy_node = Struct.new(:line).new(document.source_lines.count)
+      ends_with_newline = document.source.end_with?("\n")
+
+      if config['present']
+        record_lint(dummy_node,
+                    'Files should end with a trailing newline') unless ends_with_newline
+      else
+        record_lint(dummy_node,
+                    'Files should not end with a trailing newline') if ends_with_newline
+      end
+    end
+  end
+end

data/lib/haml_lint/linter/indentation.rb

@@ -0,0 +1,23 @@
+module HamlLint
+  # Checks the character used for indentation.
+  class Linter::Indentation < Linter
+    include LinterRegistry
+
+    # Allowed leading indentation for each character type.
+    INDENT_REGEX = {
+      space: /^[ ]*(?!\t)/,
+      tab: /^\t*(?![ ])/,
+    }
+
+    def visit_root(_node)
+      regex = INDENT_REGEX[config['character'].to_sym]
+      dummy_node = Struct.new(:line)
+
+      document.source_lines.each_with_index do |line, index|
+        next if line =~ regex
+
+        record_lint dummy_node.new(index + 1), 'Line contains tabs in indentation'
+      end
+    end
+  end
+end

data/lib/haml_lint/linter/unnecessary_string_output.rb

@@ -30,7 +30,7 @@ module HamlLint
     private
 
     def outputs_string_literal?(script_node)
-      tree = parse_ruby(script_node.script)
+      return unless tree = parse_ruby(script_node.script)
       [:str, :dstr].include?(tree.type) &&
         !starts_with_reserved_character?(tree.children.first)
     rescue ::Parser::SyntaxError # rubocop:disable Lint/HandleExceptions

data/lib/haml_lint/logger.rb

@@ -22,7 +22,6 @@ module HamlLint
     #
     # @param output [String] the output to send
     # @param newline [true,false] whether to append a newline
-    # @return [nil]
     def log(output, newline = true)
       @out.print(output)
       @out.print("\n") if newline
@@ -32,7 +31,6 @@ module HamlLint
     # If output destination is not a TTY, behaves the same as {#log}.
     #
     # @param args [Array<String>]
-    # @return [nil]
     def bold(*args)
       color('1', *args)
     end
@@ -41,7 +39,6 @@ module HamlLint
     # If output destination is not a TTY, behaves the same as {#log}.
     #
     # @param args [Array<String>]
-    # @return [nil]
     def error(*args)
       color(31, *args)
     end
@@ -50,7 +47,6 @@ module HamlLint
     # If output destination is not a TTY, behaves the same as {#log}.
     #
     # @param args [Array<String>]
-    # @return [nil]
     def bold_error(*args)
       color('1;31', *args)
     end
@@ -59,7 +55,6 @@ module HamlLint
     # If output destination is not a TTY, behaves the same as {#log}.
     #
     # @param args [Array<String>]
-    # @return [nil]
     def success(*args)
       color(32, *args)
     end
@@ -68,29 +63,23 @@ module HamlLint
     # If output destination is not a TTY, behaves the same as {#log}.
     #
     # @param args [Array<String>]
-    # @return [nil]
     def warning(*args)
       color(33, *args)
     end
 
-    # Print specified output in bold face in a color indicative of a warning.
-    # If output destination is not a TTY, behaves the same as {#log}.
-    #
-    # @param args [Array<String>]
-    # @return [nil]
-    def bold_warning(*args)
-      color('1;33', *args)
-    end
-
     # Print the specified output in a color indicating information.
     # If output destination is not a TTY, behaves the same as {#log}.
     #
     # @param args [Array<String>]
-    # @return [nil]
     def info(*args)
       color(36, *args)
     end
 
+    # Print a blank line.
+    def newline
+      log('')
+    end
+
     # Whether this logger is outputting to a TTY.
     #
     # @return [true,false]

data/lib/haml_lint/node_transformer.rb

@@ -14,15 +14,15 @@ module HamlLint
       @document = document
     end
 
-    # Transforms the given {Haml::Parser::ParseNode} into its corresponding
-    # {HamlLint::Tree::Node}.
+    # Converts the given HAML parse node into its corresponding HAML-Lint parse
+    # node.
+    #
+    # @param haml_node [Haml::Parser::ParseNode]
+    # @return [HamlLint::Tree::Node]
     def transform(haml_node)
       node_class = "#{HamlLint::Utils.camel_case(haml_node.type.to_s)}Node"
 
       HamlLint::Tree.const_get(node_class).new(@document, haml_node)
-    rescue NameError
-      # TODO: Wrap in parser error?
-      raise
     end
   end
 end

data/lib/haml_lint/options.rb

@@ -91,6 +91,10 @@ module HamlLint
       parser.on_tail('-v', '--version', 'Display version') do
         @options[:version] = true
       end
+
+      parser.on_tail('-V', '--verbose-version', 'Display verbose version information') do
+        @options[:verbose_version] = true
+      end
     end
   end
 end

data/lib/haml_lint/runner.rb

@@ -50,7 +50,7 @@ module HamlLint
     def collect_lints(file, linter_selector, config)
       begin
         document = HamlLint::Document.new(File.read(file), file: file, config: config)
-      rescue Haml::Error => ex
+      rescue HamlLint::Exceptions::ParseError => ex
         return [HamlLint::Lint.new(nil, file, ex.line, ex.to_s, :error)]
       end
 

data/lib/haml_lint/tree/tag_node.rb

@@ -142,9 +142,10 @@ module HamlLint::Tree
     # @example For `%tag.class(lang=en)`, this returns:
     #   "lang=en"
     #
-    # @return [String] source without the surrounding parentheses
+    # @return [String,nil] source without the surrounding parentheses, or `nil`
+    #   if it has not been defined
     def html_attributes_source
-      dynamic_attributes_source[:html] || ''
+      dynamic_attributes_source[:html][/\A\((.*)\)\z/, 1] if html_attributes?
     end
 
     # Name of the HTML tag.
@@ -169,7 +170,7 @@ module HamlLint::Tree
     # @return [String,nil] string source of object reference or `nil` if it has
     #   not been defined
     def object_reference_source
-      (@value[:object_ref] if object_reference?) || ''
+      @value[:object_ref][/\A\[(.*)\]\z/, 1] if object_reference?
     end
 
     # Whether this node had a `<` after it signifying that outer whitespace
@@ -185,7 +186,7 @@ module HamlLint::Tree
     #
     # @return [true,false]
     def remove_outer_whitespace?
-      @value[:nuke_inner_whitespace]
+      @value[:nuke_outer_whitespace]
     end
 
     # Returns the script source that will be evaluated to produce this tag's
@@ -196,16 +197,6 @@ module HamlLint::Tree
       (@value[:value] if @value[:parse]) || ''
     end
 
-    # Returns the static inner content for this tag.
-    #
-    # If this tag contains dynamic content of any kind, this will still return
-    # an empty string, and you'll have to use {#script} to obtain the source.
-    #
-    # @return [String]
-    def text
-      (@value[:value] if @value[:parse]) || ''
-    end
-
     private
 
     def parsed_attributes

data/lib/haml_lint/utils.rb

@@ -61,6 +61,9 @@ module HamlLint
     end
 
     # Converts a string containing underscores/hyphens/spaces into CamelCase.
+    #
+    # @param str [String]
+    # @return [String]
     def camel_case(str)
       str.split(/_|-| /).map { |part| part.sub(/^\w/) { |c| c.upcase } }.join
     end
@@ -110,6 +113,8 @@ module HamlLint
 
     # Calls a block of code with a modified set of environment variables,
     # restoring them once the code has executed.
+    #
+    # @param env [Hash] environment variables to set
     def with_environment(env)
       old_env = {}
       env.each do |var, value|

data/lib/haml_lint/version.rb

@@ -1,4 +1,4 @@
 # Defines the gem version.
 module HamlLint
-  VERSION = '0.14.1'
+  VERSION = '0.15.0'
 end

data/lib/haml_lint.rb

@@ -1,3 +1,6 @@
+# Need to load haml before we can reference some Haml modules in our code
+require 'haml'
+
 require 'haml_lint/constants'
 require 'haml_lint/exceptions'
 require 'haml_lint/configuration'
@@ -17,8 +20,6 @@ require 'haml_lint/runner'
 require 'haml_lint/utils'
 require 'haml_lint/version'
 
-require 'haml'
-
 # Load all parse tree node classes
 require 'haml_lint/tree/node'
 require 'haml_lint/node_transformer'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haml_lint
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.15.0
 platform: ruby
 authors:
 - Brigade Engineering
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-10 00:00:00.000000000 Z
+date: 2015-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -109,8 +109,10 @@ files:
 - lib/haml_lint/linter/consecutive_comments.rb
 - lib/haml_lint/linter/consecutive_silent_scripts.rb
 - 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/implicit_div.rb
+- lib/haml_lint/linter/indentation.rb
 - lib/haml_lint/linter/leading_comment_space.rb
 - lib/haml_lint/linter/line_length.rb
 - lib/haml_lint/linter/multiline_pipe.rb
@@ -174,3 +176,4 @@ signing_key:
 specification_version: 4
 summary: HAML lint tool
 test_files: []
+has_rdoc: