scss_lint 0.46.0 → 0.47.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c199f69c02fbbb36ce36e564adaa78528fd5b49
-  data.tar.gz: 7372af4e048f1935dc730dfffacf89bcc4a1faed
+  metadata.gz: 220e8895bebf7c06f86e7fd713590d1a000f39a5
+  data.tar.gz: 2ba553b10d57c144b4d70872969be373973f0d77
 SHA512:
-  metadata.gz: dad57b1b932447052533abef8b58f2bd0288badf398b2eb946ed7bcfa8dc225e2615e7b90fce017092d5647c1057600b1e7edde12f5fd50781c358530b84e88e
-  data.tar.gz: 3581b2b0fb3d039346241eec26c889083fca38b0d3f1021052e94107bc0b766e636dd370af2c0e9c92fad70a9df7a5e3494c6f50f4d00005427ceb3b22fab54d
+  metadata.gz: 9f1c249c6885cedd4d7f33355e4b97206b0f2e84296d0cdd588016a3598d32af9f68920db045b85c8824c6ef1790297701c6430795f892f292291f591e88ebfa
+  data.tar.gz: f8f7e66b89debe64c3ae32d69212e1f9513e32dad3288ef69c203be65b130d65a2238d884708fda84c5571107c6ccb44233c2eaca9051147607753182f89d067

data/lib/scss_lint/cli.rb

@@ -18,6 +18,7 @@ module SCSSLint
       config:         78, # Configuration error
       no_files:       80, # No files matched by specified glob patterns
       plugin:         82, # Plugin loading error
+      preprocessor:   84, # Preprocessor error
     }.freeze
 
     # Create a CLI that outputs to the specified logger.
@@ -106,6 +107,9 @@ module SCSSLint
       when NoSuchLinter
         log.error exception.message
         halt :usage
+      when SCSSLint::Exceptions::PreprocessorError
+        log.error exception.message
+        halt :preprocessor
       else
         config_file = relevant_configuration_file(options) if options
 

data/lib/scss_lint/engine.rb

@@ -1,5 +1,7 @@
 require 'sass'
 
+require 'open3'
+
 module SCSSLint
   class FileEncodingError < StandardError; end
 
@@ -15,13 +17,14 @@ module SCSSLint
     #
     # @param options [Hash]
     # @option options [String] :file The file to load
+    # @option options [String] :path The path of the file to load
     # @option options [String] :code The code to parse
+    # @option options [String] :preprocess_command A preprocessing command
+    # @option options [List<String>] :preprocess_files A list of files that should be preprocessed
     def initialize(options = {})
-      if options[:path]
-        build_from_file(options)
-      elsif options[:code]
-        build_from_string(options[:code])
-      end
+      @preprocess_command = options[:preprocess_command]
+      @preprocess_files = options[:preprocess_files]
+      build(options)
 
       # Need to force encoding to avoid Windows-related bugs.
       # Need to encode with universal newline to avoid other Windows-related bugs.
@@ -45,6 +48,14 @@ module SCSSLint
 
   private
 
+    def build(options)
+      if options[:path]
+        build_from_file(options)
+      elsif options[:code]
+        build_from_string(options[:code])
+      end
+    end
+
     # @param options [Hash]
     # @option file [IO] if provided, us this as the file object
     # @option path [String] path of file, loading from this if `file` object not
@@ -52,18 +63,30 @@ module SCSSLint
     def build_from_file(options)
       @filename = options[:path]
       @contents = options[:file] ? options[:file].read : File.read(@filename)
+      preprocess_contents
       @engine = Sass::Engine.new(@contents, ENGINE_OPTIONS.merge(filename: @filename))
     end
 
     # @param scss [String]
     def build_from_string(scss)
-      @engine = Sass::Engine.new(scss, ENGINE_OPTIONS)
       @contents = scss
+      preprocess_contents
+      @engine = Sass::Engine.new(@contents, ENGINE_OPTIONS)
     end
 
     def find_any_control_commands
       @any_control_commands =
         @lines.any? { |line| line['scss-lint:disable'] || line['scss-line:enable'] }
     end
+
+    def preprocess_contents # rubocop:disable CyclomaticComplexity
+      return unless @preprocess_command
+      # Never preprocess :code scss if @preprocess_files is specified.
+      return if @preprocess_files && @filename.nil?
+      return if @preprocess_files &&
+                @preprocess_files.none? { |pattern| File.fnmatch(pattern, @filename) }
+      @contents, status = Open3.capture2(@preprocess_command, stdin_data: @contents)
+      raise SCSSLint::Exceptions::PreprocessorError if status != 0
+    end
   end
 end

data/lib/scss_lint/exceptions.rb

@@ -17,4 +17,7 @@ module SCSSLint::Exceptions
 
   # Raised when a linter gem plugin is required but not installed.
   class PluginGemLoadError < StandardError; end
+
+  # Raised when the preprocessor tool exits with a non-zero code.
+  class PreprocessorError < StandardError; end
 end

data/lib/scss_lint/linter/private_naming_convention.rb

@@ -105,10 +105,7 @@ module SCSSLint
         return true # We found a match, so we are done
       end
 
-      # We are at the top of the branch and don't want to check the root branch,
-      # since that is handled elsewhere, which means that we did not find a
-      # match.
-      return false unless node_to_look_in.node_parent.node_parent
+      return false unless node_to_look_in.node_parent
 
       # We did not find a match yet, and haven't reached the top of the branch,
       # so recurse.
@@ -122,6 +119,7 @@ module SCSSLint
     end
 
     def before?(node, before_location)
+      return true unless node.source_range
       location = location_from_range(node.source_range)
       return true if location.line < before_location.line
       if location.line == before_location.line &&

data/lib/scss_lint/reporter/tap_reporter.rb

@@ -97,7 +97,7 @@ not ok #{test_number} - #{test_line_description}
     file: #{lint.filename}
     line: #{lint.location.line}
     column: #{lint.location.column}
-  ---
+  ...
       EOS
     end
 

data/lib/scss_lint/runner.rb

@@ -25,8 +25,10 @@ module SCSSLint
     # @param file [Hash]
     # @option file [String] File object
     # @option path [String] path to File (determines which Linter config to apply)
-    def find_lints(file)
-      engine = Engine.new(file)
+    def find_lints(file) # rubocop:disable AbcSize
+      options = file.merge(preprocess_command: @config.options['preprocess_command'],
+                           preprocess_files: @config.options['preprocess_files'])
+      engine = Engine.new(options)
 
       @linters.each do |linter|
         begin

data/lib/scss_lint/version.rb

@@ -2,5 +2,5 @@
 
 # Defines the gem version.
 module SCSSLint
-  VERSION = '0.46.0'.freeze
+  VERSION = '0.47.0'.freeze
 end

data/spec/scss_lint/linter/private_naming_convention_spec.rb

@@ -60,6 +60,52 @@ describe SCSSLint::Linter::PrivateNamingConvention do
       it { should_not report_lint }
     end
 
+    context 'is defined and used in the same file that starts with an @import' do
+      let(:scss) { <<-SCSS }
+        @import 'bar';
+
+        $_foo: red;
+
+        p {
+          color: $_foo;
+        }
+      SCSS
+
+      it { should_not report_lint }
+    end
+
+    context 'is defined and used in a for loop when the file begins with a comment' do
+      let(:scss) { <<-SCSS }
+        // A comment
+        @function _foo() {
+          @return red;
+        }
+
+        @for $i from 0 through 1 {
+          .foo {
+            color: _foo();
+          }
+        }
+      SCSS
+
+      it { should_not report_lint }
+    end
+
+    context 'is defined and used in the same file when the file begins with a comment' do
+      let(:scss) { <<-SCSS }
+        // A comment
+        @function _foo() {
+          @return red;
+        }
+
+        .foo {
+          color: _foo();
+        }
+      SCSS
+
+      it { should_not report_lint }
+    end
+
     context 'is defined within a selector and not used' do
       let(:scss) { <<-SCSS }
         p {

data/spec/scss_lint/preprocess_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe SCSSLint::Engine do
+  let(:engine) { described_class.new(options) }
+  let(:command) { 'my-command' }
+  let(:scss) { <<-SCSS }
+    ---
+    ---
+    $red: #f00;
+  SCSS
+  let(:processed) { <<-SCSS }
+    $red: #f00;
+  SCSS
+
+  context 'preprocess_command is specified' do
+    let(:options) { { code: scss, preprocess_command: command } }
+
+    it 'preprocesses, and Sass is able to parse' do
+      open3 = class_double('Open3').as_stubbed_const
+      open3.should_receive(:capture2).with(command, stdin_data: scss).and_return([processed, 0])
+
+      variable = engine.tree.children[0]
+      expect(variable).to be_instance_of(Sass::Tree::VariableNode)
+      expect(variable.name).to eq('red')
+    end
+  end
+
+  context 'preprocessor fails' do
+    let(:options) { { code: scss, preprocess_command: command } }
+
+    it 'preprocesses, and Sass is able to parse' do
+      open3 = class_double('Open3').as_stubbed_const
+      open3.should_receive(:capture2).with(command, stdin_data: scss).and_return([processed, 1])
+
+      expect { engine }.to raise_error(SCSSLint::Exceptions::PreprocessorError)
+    end
+  end
+
+  context 'both preprocess_command and preprocess_files are specified' do
+    let(:path) { 'foo/a.scss' }
+
+    context 'file should be preprocessed' do
+      let(:options) do
+        { path: path,
+          preprocess_command: command,
+          preprocess_files: ['foo/*.scss'] }
+      end
+
+      it 'preprocesses, and Sass is able to parse' do
+        open3 = class_double('Open3').as_stubbed_const
+        open3.should_receive(:capture2).with(command, stdin_data: scss).and_return([processed, 0])
+        File.should_receive(:read).with(path).and_return(scss)
+
+        variable = engine.tree.children[0]
+        expect(variable).to be_instance_of(Sass::Tree::VariableNode)
+        expect(variable.name).to eq('red')
+      end
+    end
+
+    context 'file should not be preprocessed' do
+      let(:options) do
+        { path: path,
+          preprocess_command: command,
+          preprocess_files: ['bar/*.scss'] }
+      end
+
+      it 'does not preprocess, and Sass throws' do
+        File.should_receive(:read).with(path).and_return(scss)
+        expect { engine }.to raise_error(Sass::SyntaxError)
+      end
+    end
+
+    context 'code should never be preprocessed' do
+      let(:options) do
+        { code: scss,
+          preprocess_command: command,
+          preprocess_files: ['foo/*.scss'] }
+      end
+
+      it 'does not preprocess, and Sass throws' do
+        expect { engine }.to raise_error(Sass::SyntaxError)
+      end
+    end
+  end
+end

data/spec/scss_lint/reporter/tap_reporter_spec.rb

@@ -70,7 +70,7 @@ not ok 2 - not-ok1.scss:123:10 SCSSLint::Linter::PrivateNamingConvention
     file: not-ok1.scss
     line: 123
     column: 10
-  ---
+  ...
 not ok 3 - not-ok2.scss:20:2 SCSSLint::Linter::PrivateNamingConvention
   ---
   message: Description of lint 2
@@ -79,7 +79,7 @@ not ok 3 - not-ok2.scss:20:2 SCSSLint::Linter::PrivateNamingConvention
     file: not-ok2.scss
     line: 20
     column: 2
-  ---
+  ...
 not ok 4 - not-ok2.scss:21:3 SCSSLint::Linter::PrivateNamingConvention
   ---
   message: Description of lint 3
@@ -88,7 +88,7 @@ not ok 4 - not-ok2.scss:21:3 SCSSLint::Linter::PrivateNamingConvention
     file: not-ok2.scss
     line: 21
     column: 3
-  ---
+  ...
 ok 5 - ok2.scss
         EOS
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scss_lint
 version: !ruby/object:Gem::Version
-  version: 0.46.0
+  version: 0.47.0
 platform: ruby
 authors:
 - Brigade Engineering
@@ -245,6 +245,7 @@ files:
 - spec/scss_lint/plugins/linter_dir_spec.rb
 - spec/scss_lint/plugins/linter_gem_spec.rb
 - spec/scss_lint/plugins_spec.rb
+- spec/scss_lint/preprocess_spec.rb
 - spec/scss_lint/rake_task_spec.rb
 - spec/scss_lint/report_lint_spec.rb
 - spec/scss_lint/reporter/clean_files_reporter_spec.rb
@@ -358,6 +359,7 @@ test_files:
 - spec/scss_lint/plugins/linter_dir_spec.rb
 - spec/scss_lint/plugins/linter_gem_spec.rb
 - spec/scss_lint/plugins_spec.rb
+- spec/scss_lint/preprocess_spec.rb
 - spec/scss_lint/rake_task_spec.rb
 - spec/scss_lint/report_lint_spec.rb
 - spec/scss_lint/reporter/clean_files_reporter_spec.rb