scss-lint 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ba79ac6014b4db405c0954003c2ec1ac2753419
-  data.tar.gz: 3a6d1cf5b8453c4766d6f95d9ff1df3e8267515c
+  metadata.gz: 851fc6dcdb6402f514538367d2a2e10afa223a23
+  data.tar.gz: f9c630b4c98aaf277a4277abb003144ba65e5bd8
 SHA512:
-  metadata.gz: 0971a5a157de5fd32506a46d2935dfa07a476d648580bdb4e72edbe435fc47754903a2356dde7c8ffa2f8825d11a631e07fa50bc954a99bafc6ef7ef2187d61e
-  data.tar.gz: 3b463780c5fdcef0d2e06fe17bd2dd1739ebbc7bf8c0f473acc0e18023633e69e7de37762c5efc1819a6c62f8372569c56612ba255dedc88c3cdc1ec0093c873
+  metadata.gz: 9016d101642210006cda461af3c990c6c0bb04e254ff49dd50e19ee3a04dbc87db450b8d687ae47972015bdc564cb3d2bd93aea9131065a79665777e016eff45
+  data.tar.gz: 3c9cffd85b8d147e1bcf4c7617a2cda7ea8cf81e50ff33a059b1ad0ca0634835c200802ade936fefdf6c89a283d37bc35fa41a719078fdbba4cb4147dbf15e13

data/lib/scss_lint.rb

@@ -1,6 +1,6 @@
 require 'scss_lint/constants'
-require 'scss_lint/cli'
 require 'scss_lint/config'
+require 'scss_lint/cli'
 require 'scss_lint/engine'
 require 'scss_lint/lint'
 require 'scss_lint/linter_registry'

data/lib/scss_lint/cli.rb

@@ -9,18 +9,19 @@ module SCSSLint
 
     # Subset of semantic exit codes conforming to `sysexits` documentation.
     EXIT_CODES = {
-      ok: 0,
-      usage: 64,      # Command line usage error
-      data: 65,       # User input was incorrect (i.e. contains lints)
-      no_input: 66,   # Input file did not exist or was not readable
-      software: 70,   # Internal software error
-      config: 78,     # Configuration error
+      ok:        0,
+      usage:     64, # Command line usage error
+      data:      65, # User input was incorrect (i.e. contains lints)
+      no_input:  66, # Input file did not exist or was not readable
+      software:  70, # Internal software error
+      config:    78, # Configuration error
     }
 
+    # @param args [Array]
     def initialize(args = [])
-      @args = args
+      @args    = args
       @options = {}
-      @config = Config.default
+      @config  = Config.default
     end
 
     def parse_arguments
@@ -35,12 +36,13 @@ module SCSSLint
 
       begin
         setup_configuration
-      rescue NoSuchLinter => ex
+      rescue InvalidConfiguration, NoSuchLinter => ex
         puts ex.message
         halt :config
       end
     end
 
+    # @return [OptionParser]
     def options_parser
       @options_parser ||= OptionParser.new do |opts|
         opts.banner = "Usage: #{opts.program_name} [options] [scss-files]"
@@ -90,6 +92,9 @@ module SCSSLint
       runner.run(files_to_lint)
       report_lints(runner.lints)
       halt :data if runner.lints.any?
+    rescue InvalidConfiguration => ex
+      puts ex
+      halt :config
     rescue NoFilesError, Errno::ENOENT => ex
       puts ex.message
       halt :no_input
@@ -114,6 +119,8 @@ module SCSSLint
       merge_command_line_flags_with_config(@config)
     end
 
+    # @param config [Config]
+    # @return [Config]
     def merge_command_line_flags_with_config(config)
       if @options[:excluded_files]
         @options[:excluded_files].each do |file|
@@ -150,6 +157,7 @@ module SCSSLint
       end
     end
 
+    # @param list [Array]
     def extract_files_from(list)
       files = []
       list.each do |file|
@@ -161,12 +169,15 @@ module SCSSLint
     end
 
     VALID_EXTENSIONS = %w[.css .scss]
+    # @param file [String]
+    # @return [Boolean]
     def scssish_file?(file)
       return false unless FileTest.file?(file)
 
       VALID_EXTENSIONS.include?(File.extname(file))
     end
 
+    # @param lints [Array<Lint>]
     def report_lints(lints)
       sorted_lints = lints.sort_by { |l| [l.filename, l.line] }
       reporter = @options.fetch(:reporter, Reporter::DefaultReporter)
@@ -175,6 +186,7 @@ module SCSSLint
       print output if output
     end
 
+    # @param format [String]
     def set_output_format(format)
       @options[:reporter] = SCSSLint::Reporter.const_get(format + 'Reporter')
     rescue NameError
@@ -196,18 +208,23 @@ module SCSSLint
       halt
     end
 
+    # @param help_message [String]
+    # @param err [Exception]
     def print_help(help_message, err = nil)
       puts err, '' if err
       puts help_message
       halt(err ? :usage : :ok)
     end
 
+    # @param program_name [String]
+    # @param version [String]
     def print_version(program_name, version)
       puts "#{program_name} #{version}"
       halt
     end
 
     # Used for ease-of testing
+    # @param exit_status [Symbol]
     def halt(exit_status = :ok)
       exit(EXIT_CODES[exit_status])
     end

data/lib/scss_lint/config.rb

@@ -2,6 +2,9 @@ require 'pathname'
 require 'yaml'
 
 module SCSSLint
+  # Raised when the configuration file is invalid for some reason.
+  class InvalidConfiguration < StandardError; end
+
   # Loads and manages application configuration.
   class Config
     FILE_NAME = '.scss-lint.yml'
@@ -61,12 +64,16 @@ module SCSSLint
       def load_options_hash_from_file(file)
         file_contents = load_file_contents(file)
 
-        options =
-          if yaml = YAML.load(file_contents)
-            yaml.to_hash
-          else
-            {}
-          end
+        begin
+          options =
+            if yaml = YAML.load(file_contents)
+              yaml.to_hash
+            else
+              {}
+            end
+        rescue => ex
+          raise InvalidConfiguration, "Invalid configuration: #{ex.message}"
+        end
 
         options = convert_single_options_to_arrays(options)
         options = extend_inherited_configs(options, file)

data/lib/scss_lint/lint.rb

@@ -3,13 +3,18 @@ module SCSSLint
   class Lint
     attr_reader :filename, :line, :description, :severity
 
+    # @param filename [String]
+    # @param line [Integer]
+    # @param description [String]
+    # @param severity [Symbol]
     def initialize(filename, line, description, severity = :warning)
-      @filename = filename
-      @line = line
+      @filename    = filename
+      @line        = line
       @description = description
-      @severity = severity
+      @severity    = severity
     end
 
+    # @return [Boolean]
     def error?
       severity == :error
     end

data/lib/scss_lint/linter.rb

@@ -10,6 +10,8 @@ module SCSSLint
       @lints = []
     end
 
+    # @param engine [Engine]
+    # @param config [Config]
     def run(engine, config)
       @config = config
       @engine = engine
@@ -17,11 +19,15 @@ module SCSSLint
     end
 
     # Define if you want a default message for your linter
+    # @return [String, nil]
     def description
       nil
     end
 
     # Helper for creating lint from a parse tree node
+    #
+    # @param node_or_line [Sass::Script::Tree::Node, Sass::Engine::Line]
+    # @param message [String, nil]
     def add_lint(node_or_line, message = nil)
       line = node_or_line.respond_to?(:line) ? node_or_line.line : node_or_line
 
@@ -30,9 +36,11 @@ module SCSSLint
                          message || description)
     end
 
-    # Returns the character at the given [Sass::Source::Position]
+    # @param source_position [Sass::Source::Position]
+    # @param offset [Integer]
+    # @return [String] the character at the given [Sass::Source::Position]
     def character_at(source_position, offset = 0)
-      actual_line = source_position.line - 1
+      actual_line   = source_position.line - 1
       actual_offset = source_position.offset + offset - 1
 
       # Return a newline if offset points at the very end of the line
@@ -42,11 +50,19 @@ module SCSSLint
     end
 
     # Extracts the original source code given a range.
+    #
+    # @param source_range [Sass::Source::Range]
+    # @return [String] the original source code
     def source_from_range(source_range)
       current_line = source_range.start_pos.line - 1
-      last_line = source_range.end_pos.line - 1
+      last_line    = source_range.end_pos.line - 1
+      start_pos    = source_range.start_pos.offset - 1
 
-      source = engine.lines[current_line][(source_range.start_pos.offset - 1)..-1]
+      if current_line == last_line
+        source = engine.lines[current_line][start_pos..(source_range.end_pos.offset - 1)]
+      else
+        source = engine.lines[current_line][start_pos..-1]
+      end
 
       current_line += 1
       while current_line < last_line
@@ -64,19 +80,10 @@ module SCSSLint
       source
     end
 
-    # Monkey-patched implementation that adds support for traversing
-    # Sass::Script::Nodes (original implementation only supports
-    # Sass::Tree::Nodes).
-    def self.node_name(node)
-      case node
-      when Sass::Script::Tree::Node, Sass::Script::Value::Base
-        "script_#{node.class.name.gsub(/.*::(.*?)$/, '\\1').downcase}"
-      else
-        super
-      end
-    end
-
     # Modified so we can also visit selectors in linters
+    #
+    # @param node [Sass::Tree::Node, Sass::Script::Tree::Node,
+    #   Sass::Script::Value::Base]
     def visit(node)
       # Visit the selector of a rule if parsed rules are available
       if node.is_a?(Sass::Tree::RuleNode) && node.parsed_rules
@@ -87,6 +94,9 @@ module SCSSLint
     end
 
     # Redefine so we can set the `node_parent` of each node
+    #
+    # @param parent [Sass::Tree::Node, Sass::Script::Tree::Node,
+    #   Sass::Script::Value::Base]
     def visit_children(parent)
       parent.children.each do |child|
         child.node_parent = parent

data/lib/scss_lint/linter/property_sort_order.rb

@@ -13,7 +13,7 @@ module SCSSLint
       sortable_prop_names = sortable_props.map { |child| child.name.join }
 
       sorted_prop_names = sortable_prop_names.map do |name|
-        /^(?<vendor>-\w+-)?(?<property>.+)/ =~ name
+        /^(?<vendor>-\w+(-osx)?-)?(?<property>.+)/ =~ name
         { name: name, vendor: vendor, property: property }
       end.sort { |a, b| compare_properties(a, b) }
          .map { |fields| fields[:name] }

data/lib/scss_lint/linter/space_after_comma.rb

@@ -66,20 +66,33 @@ module SCSSLint
     def check_commas_after_args(args, arg_type)
       # For each arg except the last, check the character following the comma
       args[0..-2].each do |arg|
-        # Find the first comma following the arg
-        offset = 1
-        offset += 1 while character_at(arg.source_range.end_pos, offset - 1) != ','
+        offset = 0
+
+        # Find the comma following this argument.
+        # The Sass parser is unpredictable in where it marks the end of the
+        # source range. Thus we need to start at the indicated range, and check
+        # left and right of that range, gradually moving further outward until
+        # we find the comma.
+        if character_at(arg.source_range.end_pos, offset) != ','
+          loop do
+            offset += 1
+            break if character_at(arg.source_range.end_pos, offset) == ','
+            offset = -offset
+            break if character_at(arg.source_range.end_pos, offset) == ','
+            offset = -offset
+          end
+        end
 
         # Check for space or newline after arg (we allow arguments to be split
         # up over multiple lines).
         spaces = 0
-        while character_at(arg.source_range.end_pos, offset) =~ / |\n/
+        while character_at(arg.source_range.end_pos, offset + 1) =~ / |\n/
           spaces += 1
           offset += 1
         end
 
         if spaces != EXPECTED_SPACES_AFTER_COMMA
-          add_lint arg, 'Commas in %s should be followed by a single space' % arg_type
+          add_lint arg, "Commas in #{arg_type} should be followed by a single space"
         end
       end
     end

data/lib/scss_lint/linter/string_quotes.rb

@@ -8,12 +8,12 @@ module SCSSLint
     end
 
     def visit_import(node)
-      # @import source range conveniently includes only the quoted string
+      # `@import` source range conveniently includes only the quoted string
       check_quotes(node, source_from_range(node.source_range))
     end
 
     def visit_charset(node)
-      # @charset source range includes entire declaration, so exclude '@charset' prefix
+      # `@charset` source range includes entire declaration, so exclude that prefix
       source = source_from_range(node.source_range)[('@charset'.length)..-1]
 
       check_quotes(node, source)

data/lib/scss_lint/linter/zero_unit.rb

@@ -10,7 +10,7 @@ module SCSSLint
     end
 
     def visit_script_number(node)
-      if node.value == 0 && !node.unitless?
+      if node.value == 0 && zero_with_units?(source_from_range(node.source_range))
         add_lint(node, MESSAGE_FORMAT % node.original_string)
       end
     end
@@ -18,5 +18,9 @@ module SCSSLint
   private
 
     MESSAGE_FORMAT = '`%s` should be written without units as `0`'
+
+    def zero_with_units?(string)
+      string =~ /^0[a-z]+/
+    end
   end
 end

data/lib/scss_lint/runner.rb

@@ -7,12 +7,14 @@ module SCSSLint
   class Runner
     attr_reader :lints
 
+    # @param config [Config]
     def initialize(config)
-      @config = config
-      @lints = []
+      @config  = config
+      @lints   = []
       @linters = LinterRegistry.linters.map(&:new)
     end
 
+    # @param files [Array]
     def run(files)
       raise NoFilesError, 'No SCSS files specified' if files.empty?
 
@@ -27,6 +29,7 @@ module SCSSLint
 
   private
 
+    # @param file [String]
     def find_lints(file)
       engine = Engine.new(file)
       config = @config.preferred ? @config : Config.for_file(file)

data/lib/scss_lint/sass/script.rb

@@ -1,7 +1,7 @@
-module Sass::Script
-  # Ignore documentation lints as these aren't original implementations.
-  # rubocop:disable Documentation
+# Ignore documentation lints as these aren't original implementations.
+# rubocop:disable Documentation
 
+module Sass::Script
   # Redefine some of the lexer helpers in order to store the original string
   # with the created object so that the original string can be inspected rather
   # than a typically normalized version.
@@ -43,6 +43,38 @@ module Sass::Script
     end
   end
 
+  # Since the Sass library is already loaded at this point.
+  # Define the `node_name` and `visit_method` class methods for each Sass Script
+  # parse tree node type so that our custom visitor can seamless traverse the
+  # tree.
+  #
+  # This would be easier if we could just define an `inherited` callback, but
+  # that won't work since the Sass library will have already been loaded before
+  # this code gets loaded, so the `inherited` callback won't be fired.
+  #
+  # Thus we are left to manually define the methods for each type explicitly.
+  {
+    'Value' => %w[ArgList Bool Color List Map Null Number String],
+    'Tree'  => %w[Funcall Interpolation ListLiteral Literal MapLiteral
+                  Operation StringInterpolation UnaryOperation Variable],
+  }.each do |namespace, types|
+    types.each do |type|
+      node_name = type.downcase
+
+      eval <<-DECL
+        class #{namespace}::#{type}
+          def self.node_name
+            :script_#{node_name}
+          end
+
+          def self.visit_method
+            :visit_script_#{node_name}
+          end
+        end
+      DECL
+    end
+  end
+
   class Value::Base
     attr_accessor :node_parent
 

data/lib/scss_lint/version.rb

@@ -1,4 +1,4 @@
 # Defines the gem version.
 module SCSSLint
-  VERSION = '0.18.0'
+  VERSION = '0.19.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scss-lint
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Causes Engineering
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-07 00:00:00.000000000 Z
+date: 2014-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -29,16 +29,16 @@ dependencies:
   name: sass
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.3.0.rc.1
+        version: 3.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.3.0.rc.1
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +67,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 2.14.1
-description: Configurable tool to help write clean and consistent SCSS
+description: Configurable tool for writing clean and consistent SCSS
 email:
 - eng@causes.com
 - shane@causes.com