slim_lint 0.15.1 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 42d626c3288229b178231458cd5fc0343cad2d81
-  data.tar.gz: 911044ecc6d32a6c9a7dd8335fd5c7962726e6e1
+SHA256:
+  metadata.gz: 9a0a85688d4fd272c34d5a3f6a6f8e76fc92baa6612ecc6beabe5459b02a0ff1
+  data.tar.gz: ba9b1c8a6adc808311d0ae0cdfe67a260f1692ec7c6e0ac2476d19035b18e270
 SHA512:
-  metadata.gz: 2c66c59b890f5aa532fbbfd65874944640faddc140c61e310af6a8ba03f192839c1fab199a1260b6dd70108ebedea8bb83c0f53c3313cf4346cc484dcbd2c7cc
-  data.tar.gz: cd2332a3228a2a0e4f3b78d75c451ec98241d834d48f566c66b5690e75505ec96b606c2d5b432a64f1dcbf53bbd44029e136ccd033eb147d837837ae3f5da35a
+  metadata.gz: 72945205219ecb6bdf4ef8947bb84b7def1c4b549ac6e52d8ad3afc338f0061bfa90fe15d3b013dcde25990b0da270df449ef53fc1f6e61cfb76b871367388d3
+  data.tar.gz: 74513c279efc7056bdea21519d43ac9074f5599cdd72f6a9132ec71efd88ed64ac2b23684724ea598f8c0db493230ffa44529ccf39e579109701cebb4f8388b2

data/bin/slim-lint

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'slim_lint/cli'
 

data/config/default.yml

@@ -11,6 +11,9 @@ linters:
   CommentControlStatement:
     enabled: true
 
+  ControlStatementSpacing:
+    enabled: true
+
   ConsecutiveControlStatements:
     enabled: true
     max_consecutive: 2
@@ -28,6 +31,10 @@ linters:
     enabled: true
     max: 80
 
+  FileLength:
+    enabled: false
+    max: 300
+
   RuboCop:
     enabled: true
     # These cops are incredibly noisy since the Ruby we extract from Slim
@@ -58,6 +65,7 @@ linters:
       - Metrics/BlockNesting
       - Metrics/LineLength
       - Naming/FileName
+      - Style/EmptyLineAfterGuardClause
       - Style/FrozenStringLiteralComment
       - Style/IfUnlessModifier
       - Style/Next

data/lib/slim_lint/atom.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint
   # Represents an atomic, childless, literal value within an S-expression.
   #

data/lib/slim_lint/capture_map.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint
   # Holds the list of captures, providing a convenient interface for accessing
   # the values and unwrapping them on your behalf.

data/lib/slim_lint/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'slim_lint'
 require 'slim_lint/options'
 
@@ -54,23 +56,23 @@ module SlimLint
 
     # Outputs a message and returns an appropriate error code for the specified
     # exception.
-    def handle_exception(ex)
-      case ex
+    def handle_exception(exception)
+      case exception
       when SlimLint::Exceptions::ConfigurationError
-        log.error ex.message
+        log.error exception.message
         Sysexits::EX_CONFIG
       when SlimLint::Exceptions::InvalidCLIOption
-        log.error ex.message
+        log.error exception.message
         log.log "Run `#{APP_NAME}` --help for usage documentation"
         Sysexits::EX_USAGE
       when SlimLint::Exceptions::InvalidFilePath
-        log.error ex.message
+        log.error exception.message
         Sysexits::EX_NOINPUT
       when SlimLint::Exceptions::NoLintersError
-        log.error ex.message
+        log.error exception.message
         Sysexits::EX_NOINPUT
       else
-        print_unexpected_exception(ex)
+        print_unexpected_exception(exception)
         Sysexits::EX_SOFTWARE
       end
     end
@@ -135,9 +137,9 @@ module SlimLint
 
     # Outputs the backtrace of an exception with instructions on how to report
     # the issue.
-    def print_unexpected_exception(ex) # rubocop:disable Metrics/AbcSize
-      log.bold_error ex.message
-      log.error ex.backtrace.join("\n")
+    def print_unexpected_exception(exception) # rubocop:disable Metrics/AbcSize
+      log.bold_error exception.message
+      log.error exception.backtrace.join("\n")
       log.warning 'Report this bug at ', false
       log.info SlimLint::BUG_REPORT_URL
       log.newline

data/lib/slim_lint/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint
   # Stores runtime configuration for the application.
   #

data/lib/slim_lint/configuration_loader.rb

@@ -7,7 +7,7 @@ module SlimLint
   # Manages configuration file loading.
   class ConfigurationLoader
     DEFAULT_CONFIG_PATH = File.join(SlimLint::HOME, 'config', 'default.yml').freeze
-    CONFIG_FILE_NAME = '.slim-lint.yml'.freeze
+    CONFIG_FILE_NAME = '.slim-lint.yml'
 
     class << self
       # Load configuration file given the current working directory the
@@ -25,7 +25,7 @@ module SlimLint
 
       # Loads the built-in default configuration.
       def default_configuration
-        @default_config ||= load_from_file(DEFAULT_CONFIG_PATH)
+        @default_configuration ||= load_from_file(DEFAULT_CONFIG_PATH)
       end
 
       # Loads a configuration, ensuring it extends the default configuration.

data/lib/slim_lint/constants.rb

@@ -3,8 +3,8 @@
 # Global application constants.
 module SlimLint
   HOME = File.expand_path(File.join(File.dirname(__FILE__), '..', '..')).freeze
-  APP_NAME = 'slim-lint'.freeze
+  APP_NAME = 'slim-lint'
 
-  REPO_URL = 'https://github.com/sds/slim-lint'.freeze
-  BUG_REPORT_URL = "#{REPO_URL}/issues".freeze
+  REPO_URL = 'https://github.com/sds/slim-lint'
+  BUG_REPORT_URL = "#{REPO_URL}/issues"
 end

data/lib/slim_lint/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint
   # Temple engine used to generate a {Sexp} parse tree for use by linters.
   #

data/lib/slim_lint/exceptions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Collection of exceptions that can be raised by the application.
 module SlimLint::Exceptions
   # Raised when a {Configuration} could not be loaded from a file.

data/lib/slim_lint/file_finder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'find'
 
 module SlimLint
@@ -70,7 +72,7 @@ module SlimLint
     # @param path [String]
     # @return [String]
     def normalize_path(path)
-      File.expand_path(path.start_with?(".#{File::SEPARATOR}") ? path[2..-1] : path)
+      path.start_with?(".#{File::SEPARATOR}") ? path[2..-1] : path
     end
 
     # Whether the given file should be treated as a Slim file.

data/lib/slim_lint/filters/attribute_processor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint::Filters
   # A dumbed-down version of {Slim::CodeAttributes} which doesn't introduce any
   # temporary variables or other cruft.

data/lib/slim_lint/filters/control_processor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint::Filters
   # A dumbed-down version of {Slim::Controls} which doesn't introduce temporary
   # variables and other cruft (which in the context of extracting Ruby code,

data/lib/slim_lint/filters/inject_line_numbers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint::Filters
   # Traverses a Temple S-expression (that has already been converted to
   # {SlimLint::Sexp} instances) and annotates them with line numbers.

data/lib/slim_lint/filters/sexp_converter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint::Filters
   # Converts a Temple S-expression comprised of {Array}s into {SlimLint::Sexp}s.
   #

data/lib/slim_lint/filters/splat_processor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint::Filters
   # A dumbed-down version of {Slim::Splat::Filter} which doesn't introduced
   # temporary variables or other cruft.

data/lib/slim_lint/lint.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint
   # Contains information about a problem or issue with a Slim document.
   class Lint

data/lib/slim_lint/linter/comment_control_statement.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint
   # Searches for control statements with only comments.
   class Linter::CommentControlStatement < Linter

data/lib/slim_lint/linter/consecutive_control_statements.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint
   # Searches for more than an allowed number of consecutive control code
   # statements that could be condensed into a :ruby filter.

data/lib/slim_lint/linter/control_statement_spacing.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module SlimLint
+  # Checks for missing or superfluous spacing before and after control statements.
+  class Linter::ControlStatementSpacing < Linter
+    include LinterRegistry
+
+    MESSAGE = 'Please add a space before and after the `=`'
+
+    on [:html, :tag, anything, [],
+         [:slim, :output, anything, capture(:ruby, anything)]] do |sexp|
+
+      # Fetch original Slim code that contains an element with a control statement.
+      line = document.source_lines[sexp.line() - 1]
+
+      # Remove any Ruby code, because our regexp below must not match inside Ruby.
+      ruby = captures[:ruby]
+      line = line.sub(ruby, 'x')
+
+      next if line =~ /[^ ] ==? [^ ]/
+      report_lint(sexp, MESSAGE)
+    end
+  end
+end

data/lib/slim_lint/linter/empty_control_statement.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint
   # Searches for control statements with no code.
   class Linter::EmptyControlStatement < Linter

data/lib/slim_lint/linter/empty_lines.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint
   # This linter checks for two or more consecutive blank lines
   # and for the first blank line in file.

data/lib/slim_lint/linter/file_length.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module SlimLint
+  # Checks for file longer than a maximum number of lines.
+  class Linter::FileLength < Linter
+    include LinterRegistry
+
+    MSG = 'File is too long. [%d/%d]'
+
+    on_start do |_sexp|
+      max_length = config['max']
+      dummy_node = Struct.new(:line)
+
+      count = document.source_lines.size
+      if count > max_length
+        report_lint(dummy_node.new(1), format(MSG, count, max_length))
+      end
+    end
+  end
+end

data/lib/slim_lint/linter/line_length.rb

@@ -5,7 +5,7 @@ module SlimLint
   class Linter::LineLength < Linter
     include LinterRegistry
 
-    MSG = 'Line is too long. [%d/%d]'.freeze
+    MSG = 'Line is too long. [%d/%d]'
 
     on_start do |_sexp|
       max_length = config['max']

data/lib/slim_lint/linter/redundant_div.rb

@@ -6,7 +6,7 @@ module SlimLint
   class Linter::RedundantDiv < Linter
     include LinterRegistry
 
-    MESSAGE = '`div` is redundant when %s attribute shortcut is present'.freeze
+    MESSAGE = '`div` is redundant when %s attribute shortcut is present'
 
     on [:html, :tag, 'div',
          [:html, :attrs,

data/lib/slim_lint/linter/rubocop.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'slim_lint/ruby_extractor'
 require 'slim_lint/ruby_extract_engine'
 require 'rubocop'

data/lib/slim_lint/linter/tab.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module SlimLint
   # Searches for tab indentation
   class Linter::Tab < Linter
     include LinterRegistry
 
-    MSG = 'Tab detected'.freeze
+    MSG = 'Tab detected'
 
     on_start do |_sexp|
       dummy_node = Struct.new(:line)

data/lib/slim_lint/linter/tag_case.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint
   # Searches for tags with uppercase characters.
   class Linter::TagCase < Linter

data/lib/slim_lint/linter/trailing_blank_lines.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint
   # This linter looks for trailing blank lines and a final newline.
   class Linter::TrailingBlankLines < Linter

data/lib/slim_lint/linter/trailing_whitespace.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint
   # Checks for trailing whitespace.
   class Linter::TrailingWhitespace < Linter

data/lib/slim_lint/linter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint
   # Base implementation for all lint checks.
   #

data/lib/slim_lint/linter_registry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint
   class NoSuchLinter < StandardError; end
 

data/lib/slim_lint/linter_selector.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint
   # Chooses the appropriate linters to run given the specified configuration.
   class LinterSelector

data/lib/slim_lint/logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint
   # Encapsulates all communication to an output source.
   class Logger

data/lib/slim_lint/matcher/anything.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint::Matcher
   # Will match anything, acting as a wildcard.
   class Anything < Base

data/lib/slim_lint/matcher/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint::Matcher
   # Represents a Sexp pattern implementing complex matching logic.
   #

data/lib/slim_lint/matcher/capture.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint::Matcher
   # Wraps a matcher, taking on the behavior of the wrapped matcher but storing
   # the value that matched so it can be referred to later.

data/lib/slim_lint/matcher/nothing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint::Matcher
   # Does not match anything.
   #

data/lib/slim_lint/options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'optparse'
 
 module SlimLint

data/lib/slim_lint/rake_task.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake'
 require 'rake/tasklib'
 require 'slim_lint/constants'

data/lib/slim_lint/report.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint
   # Contains information about all lints detected during a scan.
   class Report

data/lib/slim_lint/reporter/checkstyle_reporter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rexml/document'
 
 module SlimLint

data/lib/slim_lint/reporter/default_reporter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint
   # Outputs lints in a simple format with the filename, line number, and lint
   # message.

data/lib/slim_lint/reporter/json_reporter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint
   # Outputs report as a JSON document.
   class Reporter::JsonReporter < Reporter

data/lib/slim_lint/reporter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint
   # Abstract lint reporter. Subclass and override {#display_report} to
   # implement a custom lint reporter.

data/lib/slim_lint/ruby_extract_engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint
   # Generates a {SlimLint::Sexp} suitable for consumption by the
   # {RubyExtractor}.

data/lib/slim_lint/ruby_extractor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint
   # Utility class for extracting Ruby script from a Slim template that can then
   # be linted with a Ruby linter (i.e. is "legal" Ruby).

data/lib/slim_lint/ruby_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubocop'
 require 'rubocop/ast/builder'
 require 'parser/current'

data/lib/slim_lint/runner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint
   # Responsible for running the applicable linters against the desired files.
   class Runner

data/lib/slim_lint/sexp.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint
   # Symbolic expression which represents tree-structured data.
   #
@@ -78,7 +80,7 @@ module SlimLint
     # @return [String]
     def display(depth = 1) # rubocop:disable Metrics/AbcSize
       indentation = ' ' * 2 * depth
-      output = '['
+      output = '['.dup
 
       each_with_index do |nested_sexp, index|
         output << "\n"

data/lib/slim_lint/sexp_visitor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint
   # Provides an interface which when included allows a class to visit nodes in
   # the Sexp of a Slim document.

data/lib/slim_lint/utils.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlimLint
   # Miscellaneus collection of helper functions.
   module Utils
@@ -13,8 +15,9 @@ module SlimLint
     # @param file [String]
     # @return [Boolean]
     def any_glob_matches?(globs_or_glob, file)
+      path = File.expand_path(file)
       Array(globs_or_glob).any? do |glob|
-        ::File.fnmatch?(glob, file,
+        ::File.fnmatch?(File.expand_path(glob), path,
                         ::File::FNM_PATHNAME | # Wildcards don't match path separators
                         ::File::FNM_DOTMATCH)  # `*` wildcard matches dotfiles
       end

data/lib/slim_lint/version.rb

@@ -2,5 +2,5 @@
 
 # Defines the gem version.
 module SlimLint
-  VERSION = '0.15.1'.freeze
+  VERSION = '0.16.0'
 end

data/lib/slim_lint.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Load all slim-lint modules necessary to parse and lint a file.
 # Ordering here can be important depending on class references in each module.
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slim_lint
 version: !ruby/object:Gem::Version
-  version: 0.15.1
+  version: 0.16.0
 platform: ruby
 authors:
 - Shane da Silva
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-21 00:00:00.000000000 Z
+date: 2018-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -48,16 +48,22 @@ dependencies:
   name: slim
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: sysexits
   requirement: !ruby/object:Gem::Requirement
@@ -131,8 +137,10 @@ files:
 - lib/slim_lint/linter.rb
 - lib/slim_lint/linter/comment_control_statement.rb
 - lib/slim_lint/linter/consecutive_control_statements.rb
+- lib/slim_lint/linter/control_statement_spacing.rb
 - lib/slim_lint/linter/empty_control_statement.rb
 - lib/slim_lint/linter/empty_lines.rb
+- lib/slim_lint/linter/file_length.rb
 - lib/slim_lint/linter/line_length.rb
 - lib/slim_lint/linter/redundant_div.rb
 - lib/slim_lint/linter/rubocop.rb
@@ -174,7 +182,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -182,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Slim template linting tool