slim_lint 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea825ed5f8f37b9f5c0f65af4cce47ee9289227c
-  data.tar.gz: 31f794679bd7928f0e7990e3802319e2aeaa1764
+  metadata.gz: 90417095e752ffc02b70c6cf2c7c578642a7aced
+  data.tar.gz: db37d397d726e455c2d98e565c1f0a4ba876c28f
 SHA512:
-  metadata.gz: 60c07b39dab5f98178fa7a01318e42c97e64676810309a03932b836fe1800bb9265203da373a601aa9882d53afc5b23d15c487efcab2d0a74871d7fcbe6f15b3
-  data.tar.gz: 8a65468ddb8de4b2834178f5e89ce90203281678d3d1cb2c0eeb42a22ffc6d6f10ef115ad65e7ab3d237043d2730f9ed4d5969add7f465becbd0ae99b485606a
+  metadata.gz: d08877671cd10ae219e055f65f16c9dc26800b4aac6fe0be74dcd669da2da0bcdf45ec7885b24c87333c7731fe1178a7c0c45259146ff7c285da6371b7da53da
+  data.tar.gz: 1afec4e606480b536283d722121dc662fc0d6b2da4cd5bfeb3c93e4853b113404459a6e012546cd0fb179f99888983fa7ce0880f5f02bfcb5944acb163817c19

data/config/default.yml

@@ -8,6 +8,16 @@
 skip_frontmatter: false
 
 linters:
+  CommentControlStatement:
+    enabled: true
+
+  ConsecutiveControlStatements:
+    enabled: true
+    max_consecutive: 2
+
+  EmptyControlStatment:
+    enabled: true
+
   ExplicitDiv:
     enabled: true
 
@@ -28,11 +38,15 @@ linters:
       - Style/BlockNesting
       - Style/FileName
       - Style/IfUnlessModifier
+      - Style/IndentationConsistency
       - Style/IndentationWidth
       - Style/Next
       - Style/TrailingBlankLines
       - Style/TrailingWhitespace
       - Style/WhileUntilModifier
 
+  TagCase:
+    enabled: true
+
   TrailingWhitespace:
     enabled: true

data/lib/slim_lint/exceptions.rb

@@ -1,4 +1,4 @@
-# Collection of exceptions that can be raised by the HAML Lint application.
+# Collection of exceptions that can be raised by the application.
 module SlimLint::Exceptions
   # Raised when a {Configuration} could not be loaded from a file.
   class ConfigurationError < StandardError; end

data/lib/slim_lint/lint.rb

@@ -1,5 +1,5 @@
 module SlimLint
-  # Contains information about a problem or issue with a HAML document.
+  # Contains information about a problem or issue with a Slim document.
   class Lint
     attr_reader :filename, :line, :linter, :message, :severity
 

data/lib/slim_lint/linter/comment_control_statement.rb

@@ -0,0 +1,17 @@
+module SlimLint
+  # Searches for control statements with only comments.
+  class Linter::CommentControlStatement < Linter
+    include LinterRegistry
+
+    on [:slim, :control] do |sexp|
+      _, _, code = sexp
+      next unless code =~ /\A\s*#/
+
+      comment = code[/\A\s*#(.*\z)/, 1]
+
+      report_lint(sexp,
+                  "Slim code comments (`/#{comment}`) are preferred over " \
+                  "control statement comments (`-# #{comment}`)")
+    end
+  end
+end

data/lib/slim_lint/linter/consecutive_control_statements.rb

@@ -0,0 +1,32 @@
+module SlimLint
+  # Searches for more than an allowed number of consecutive control code
+  # statements that could be condensed into a :ruby filter.
+  class Linter::ConsecutiveControlStatements < Linter
+    include LinterRegistry
+
+    on [:multi] do |sexp|
+      Utils.for_consecutive_items(sexp,
+                                  method(:code_sexp?),
+                                  config['max_consecutive'] + 1) do |group|
+        report_lint(group.first,
+                    "#{group.count} consecutive control statements can be " \
+                    'merged into a single `ruby:` filter')
+      end
+    end
+
+    private
+
+    # Returns whether the given Sexp is a :code abstraction.
+    #
+    # @param sexp [SlimLint::Sexp]
+    # @return [Boolean]
+    def code_sexp?(sexp)
+      # TODO: Switch this with a built-in method on the {Sexp} object itself
+      sexp.is_a?(Sexp) && sexp.match?([:slim, :control])
+    end
+
+    def newline_sexp?(sexp)
+      sexp.is_a?(Sexp) && sexp.first == :newline
+    end
+  end
+end

data/lib/slim_lint/linter/empty_control_statement.rb

@@ -0,0 +1,13 @@
+module SlimLint
+  # Searches for control statements with no code.
+  class Linter::EmptyControlStatement < Linter
+    include LinterRegistry
+
+    on [:slim, :control] do |sexp|
+      _, _, code = sexp
+      next unless code =~ /\A\s*\Z/
+
+      report_lint(sexp, 'Empty control statement can be removed')
+    end
+  end
+end

data/lib/slim_lint/linter/tag_case.rb

@@ -0,0 +1,13 @@
+module SlimLint
+  # Searches for tags with uppercase characters.
+  class Linter::TagCase < Linter
+    include LinterRegistry
+
+    on [:html, :tag] do |sexp|
+      _, _, name = sexp
+      next unless name =~ /[A-Z]/
+
+      report_lint(sexp, "Tag `#{name}` should be written as `#{name.downcase}`")
+    end
+  end
+end

data/lib/slim_lint/utils.rb

@@ -0,0 +1,49 @@
+module SlimLint
+  # Miscellaneus collection of helper functions.
+  module Utils
+    module_function
+
+    # Find all consecutive items satisfying the given block of a minimum size,
+    # yielding each group of consecutive items to the provided block.
+    #
+    # @param items [Array]
+    # @param satisfies [Proc] function that takes an item and returns true/false
+    # @param min_consecutive [Fixnum] minimum number of consecutive items before
+    #   yielding the group
+    # @yield Passes list of consecutive items all matching the criteria defined
+    #   by the `satisfies` {Proc} to the provided block
+    # @yieldparam group [Array] List of consecutive items
+    # @yieldreturn [Boolean] block should return whether item matches criteria
+    #   for inclusion
+    def for_consecutive_items(items, satisfies, min_consecutive = 2)
+      current_index = -1
+
+      while (current_index += 1) < items.count
+        next unless satisfies[items[current_index]]
+
+        count = count_consecutive(items, current_index, &satisfies)
+        next unless count >= min_consecutive
+
+        # Yield the chunk of consecutive items
+        yield items[current_index...(current_index + count)]
+
+        current_index += count # Skip this patch of consecutive items to find more
+      end
+    end
+
+    # Count the number of consecutive items satisfying the given {Proc}.
+    #
+    # @param items [Array]
+    # @param offset [Fixnum] index to start searching from
+    # @yield [item] Passes item to the provided block.
+    # @yieldparam item [Object] Item to evaluate as matching criteria for
+    #   inclusion
+    # @yieldreturn [Boolean] whether to include the item
+    # @return [Integer]
+    def count_consecutive(items, offset = 0, &block)
+      count = 1
+      count += 1 while (offset + count < items.count) && block.call(items[offset + count])
+      count
+    end
+  end
+end

data/lib/slim_lint/version.rb

@@ -1,4 +1,4 @@
 # Defines the gem version.
 module SlimLint
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/slim_lint.rb

@@ -5,6 +5,7 @@ require 'slim_lint/constants'
 require 'slim_lint/exceptions'
 require 'slim_lint/configuration'
 require 'slim_lint/configuration_loader'
+require 'slim_lint/utils'
 require 'slim_lint/sexp'
 require 'slim_lint/file_finder'
 require 'slim_lint/linter_registry'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slim_lint
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Shane da Silva
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-19 00:00:00.000000000 Z
+date: 2015-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slim
@@ -103,9 +103,13 @@ files:
 - lib/slim_lint/filters/sexp_converter.rb
 - lib/slim_lint/lint.rb
 - 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/empty_control_statement.rb
 - lib/slim_lint/linter/line_length.rb
 - lib/slim_lint/linter/redundant_div.rb
 - lib/slim_lint/linter/rubocop.rb
+- lib/slim_lint/linter/tag_case.rb
 - lib/slim_lint/linter/trailing_whitespace.rb
 - lib/slim_lint/linter_registry.rb
 - lib/slim_lint/logger.rb
@@ -121,6 +125,7 @@ files:
 - lib/slim_lint/runner.rb
 - lib/slim_lint/sexp.rb
 - lib/slim_lint/sexp_visitor.rb
+- lib/slim_lint/utils.rb
 - lib/slim_lint/version.rb
 homepage: https://github.com/sds/slim-lint
 licenses: