scss_lint 0.39.0 → 0.40.0

data/lib/scss_lint/plugins.rb

@@ -0,0 +1,33 @@
+require_relative 'plugins/linter_gem'
+require_relative 'plugins/linter_dir'
+
+module SCSSLint
+  # Loads external linter plugins.
+  class Plugins
+    def initialize(config)
+      @config = config
+    end
+
+    def load
+      all.map(&:load)
+    end
+
+  private
+
+    def all
+      [plugin_gems, plugin_directories].flatten
+    end
+
+    def plugin_gems
+      Array(@config['plugin_gems']).map do |gem_name|
+        LinterGem.new(gem_name)
+      end
+    end
+
+    def plugin_directories
+      Array(@config['plugin_directories']).map do |directory|
+        LinterDir.new(directory)
+      end
+    end
+  end
+end

data/lib/scss_lint/plugins/linter_dir.rb

@@ -0,0 +1,24 @@
+module SCSSLint
+  class Plugins
+    # Load ruby files from linter plugin directories.
+    class LinterDir
+      attr_reader :config
+
+      def initialize(dir)
+        @dir = dir
+        @config = SCSSLint::Config.new({}) # Will always be empty
+      end
+
+      def load
+        ruby_files.each { |file| require file }
+        self
+      end
+
+    private
+
+      def ruby_files
+        Dir.glob(File.expand_path(File.join(@dir, '**', '*.rb')))
+      end
+    end
+  end
+end

data/lib/scss_lint/plugins/linter_gem.rb

@@ -0,0 +1,51 @@
+module SCSSLint
+  class Plugins
+    # Load linter plugin gems
+    class LinterGem
+      attr_reader :config
+
+      def initialize(name)
+        @name = name
+      end
+
+      def load
+        require @name
+        @config = plugin_config
+        self
+      rescue Gem::LoadError, LoadError
+        raise SCSSLint::Exceptions::PluginGemLoadError,
+              "Unable to load linter plugin gem '#{@name}'. Try running " \
+              "`gem install #{@name}`, or adding it to your Gemfile and " \
+              'running `bundle install`. See the `plugin_gems` section of ' \
+              'your .scss-lint.yml file to add/remove gem plugins.'
+      end
+
+    private
+
+      # Returns the {SCSSLint::Config} for this plugin.
+      #
+      # This is intended to be merged with the configuration that loaded this
+      # plugin.
+      #
+      # @return [SCSSLint::Config]
+      def plugin_config
+        file = plugin_config_file
+
+        if File.exist?(file)
+          Config.load(file, merge_with_default: false)
+        else
+          Config.new({})
+        end
+      end
+
+      # Path of the configuration file to attempt to load for this plugin.
+      #
+      # @return [String]
+      def plugin_config_file
+        gem_specification = Gem::Specification.find_by_name(@name)
+
+        File.join(gem_specification.gem_dir, Config::FILE_NAME)
+      end
+    end
+  end
+end

data/lib/scss_lint/version.rb

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

data/spec/scss_lint/config_spec.rb

@@ -143,6 +143,70 @@ describe SCSSLint::Config do
           .should eq('enabled' => true)
       end
     end
+
+    context 'when configuration loads a plugin configuration' do
+      let!(:plugins_manager) { SCSSLint::Plugins.new(double) }
+
+      before do
+        SCSSLint::Plugins.stub(:new).and_return(plugins_manager)
+
+        plugins_manager.stub(:load).and_return([
+          double(config: SCSSLint::Config.new(
+            'linters' => {
+              'FakeConfigLinter' => plugin_linter_config,
+            }
+          ))
+        ])
+      end
+
+      context 'and the plugin configuration does not set the value' do
+        let(:plugin_linter_config) { {} }
+
+        context 'and the local configuration sets the value' do
+          let(:config_file) { <<-FILE }
+          linters:
+            FakeConfigLinter:
+              list: [4, 5, 6]
+          FILE
+
+          it 'uses the local configuration value' do
+            subject.options['linters']['FakeConfigLinter']['list'].should == [4, 5, 6]
+          end
+        end
+
+        context 'and the local configuration does not set the value' do
+          let(:config_file) { '' }
+
+          it 'uses the default configuration value' do
+            subject.options['linters']['FakeConfigLinter']['list'].should == [1, 2, 3]
+          end
+        end
+      end
+
+      context 'and the plugin configuration sets the value' do
+        let(:plugin_linter_config) { { 'list' => [2, 3, 4] } }
+
+        context 'and the local configuration sets the value' do
+          let(:config_file) { <<-FILE }
+          linters:
+            FakeConfigLinter:
+              list: [4, 5, 6]
+          FILE
+
+          it 'uses the local configuration value' do
+            subject.options['linters']['FakeConfigLinter']['list'].should == [4, 5, 6]
+          end
+        end
+
+        context 'and the local configuration does not set the value' do
+          let(:config_file) { '' }
+
+          it 'uses the plugin configuration value' do
+            subject.options['linters']['FakeConfigLinter']['list'].should == [2, 3, 4]
+          end
+        end
+      end
+    end
   end
 
   describe '#linter_options' do

data/spec/scss_lint/fixtures/plugins/linter_plugin.rb

@@ -0,0 +1,7 @@
+module SCSSLint
+  class Linter
+    class LinterPlugin < Linter
+      include LinterRegistry
+    end
+  end
+end

data/spec/scss_lint/linter/color_variable_spec.rb

@@ -152,4 +152,16 @@ describe SCSSLint::Linter::ColorVariable do
 
     it { should_not report_lint }
   end
+
+  context 'when a variable is interpolated in a multiline comment' do
+    let(:scss) { <<-SCSS }
+      $a: 0;
+
+      /*!
+       * test \#{a}
+       */
+    SCSS
+
+    it { should_not report_lint }
+  end
 end

data/spec/scss_lint/linter/else_placement_spec.rb

@@ -75,6 +75,40 @@ describe SCSSLint::Linter::ElsePlacement do
     it { should_not report_lint }
   end
 
+  context 'when @else nested in an @if is on new line' do
+    let(:scss) { <<-SCSS }
+      @if $condition {
+        @if $condition2 {
+          $var: 2;
+        }
+        @else {
+          $var: 0;
+        }
+      } @else {
+        $var: 1;
+      }
+    SCSS
+
+    it { should report_lint line: 5 }
+  end
+
+  context 'when @else nested in an @else is on new line' do
+    let(:scss) { <<-SCSS }
+      @if $condition {
+        $var: 1;
+      } @else {
+        @if $condition2 {
+          $var: 2;
+        }
+        @else {
+          $var: 0;
+        }
+      }
+    SCSS
+
+    it { should report_lint line: 7 }
+  end
+
   context 'when placement of @else on a new line is preferred' do
     let(:linter_config) { { 'style' => 'new_line' } }
 

data/spec/scss_lint/linter/extend_directive_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe SCSSLint::Linter::ExtendDirective do
+  context 'when extending with a class' do
+    let(:scss) { <<-SCSS }
+      p {
+        @extend .error;
+      }
+    SCSS
+
+    it { should report_lint line: 2 }
+  end
+
+  context 'when extending with a type' do
+    let(:scss) { <<-SCSS }
+      p {
+        @extend span;
+      }
+    SCSS
+
+    it { should report_lint line: 2 }
+  end
+
+  context 'when extending with an id' do
+    let(:scss) { <<-SCSS }
+      p {
+        @extend #some-identifer;
+      }
+    SCSS
+
+    it { should report_lint line: 2 }
+  end
+
+  context 'when extending with a placeholder' do
+    let(:scss) { <<-SCSS }
+      p {
+        @extend %placeholder;
+      }
+    SCSS
+
+    it { should report_lint line: 2 }
+  end
+
+  context 'when extending with a selector whose prefix is not a placeholder' do
+    let(:scss) { <<-SCSS }
+      p {
+        @extend .blah-\#{$dynamically_generated_name};
+      }
+    SCSS
+
+    it { should report_lint line: 2 }
+  end
+
+  context 'when extending with a selector whose prefix is dynamic' do
+    let(:scss) { <<-SCSS }
+      p {
+        @extend \#{$dynamically_generated_placeholder_name};
+      }
+    SCSS
+
+    it { should report_lint line: 2 }
+  end
+
+  context 'when not using extend' do
+    let(:scss) { <<-SCSS }
+      p {
+        @include mixin;
+      }
+    SCSS
+
+    it { should_not report_lint }
+  end
+end

data/spec/scss_lint/linter/nesting_depth_spec.rb

@@ -111,4 +111,76 @@ describe SCSSLint::Linter::NestingDepth do
       it { should_not report_lint }
     end
   end
+
+  context 'nesting parent selectors' do
+    let(:scss) { <<-SCSS }
+      .one {
+        .two {
+          .three {
+            &:hover,
+            &-suffix {
+              .five {
+                background: #f00;
+              }
+            }
+          }
+
+          .another-three { }
+        }
+      }
+    SCSS
+
+    context 'when parent selectors are ignored' do
+      let(:linter_config) { { 'ignore_parent_selectors' => true } }
+
+      context 'and max depth is set to 2' do
+        let(:linter_config) { super().merge('max_depth' => 2) }
+
+        it { should report_lint line: 3 }
+        it { should report_lint line: 12 }
+        it { should_not report_lint line: 4 }
+        it { should_not report_lint line: 6 }
+      end
+
+      context 'and max depth is set to 3' do
+        let(:linter_config) { super().merge('max_depth' => 3) }
+
+        it { should_not report_lint line: 4 }
+        it { should_not report_lint line: 5 }
+        it { should report_lint line: 6 }
+      end
+
+      context 'and max depth is set to 4' do
+        let(:linter_config) { super().merge('max_depth' => 4) }
+
+        it { should_not report_lint }
+      end
+    end
+
+    context 'when not ignoring parent selectors' do
+      let(:linter_config) { { 'ignore_parent_selectors' => false } }
+
+      context 'and max depth is set to 2' do
+        let(:linter_config) { super().merge('max_depth' => 2) }
+
+        it { should report_lint line: 3 }
+        it { should report_lint line: 12 }
+        it { should_not report_lint line: 4 }
+        it { should_not report_lint line: 6 }
+      end
+
+      context 'and max depth is set to 3' do
+        let(:linter_config) { super().merge('max_depth' => 3) }
+
+        it { should report_lint line: 4 }
+        it { should_not report_lint line: 12 }
+      end
+
+      context 'and max depth is set to 4' do
+        let(:linter_config) { super().merge('max_depth' => 4) }
+
+        it { should report_lint line: 6 }
+      end
+    end
+  end
 end

data/spec/scss_lint/linter/property_sort_order_spec.rb

@@ -316,6 +316,38 @@ describe SCSSLint::Linter::PropertySortOrder do
         it { should report_lint }
       end
     end
+
+    context 'and there are properties not specified in the explicit ordering at the end' do
+      let(:linter_config) do
+        super().merge('order' => %w[position top bottom padding width background])
+      end
+
+      let(:scss) { <<-SCSS }
+        p {
+          position: absolute;
+          top: 0;
+          bottom: 0;
+          padding: 20px;
+          width: $drawer-narrow-width;
+          background: $drawer-bg-color;
+          overflow-y: auto;
+          box-sizing: border-box;
+          transition: left .25s ease-out;
+        }
+      SCSS
+
+      context 'and the ignore_unspecified option is enabled' do
+        let(:linter_config) { super().merge('ignore_unspecified' => true) }
+
+        it { should_not report_lint }
+      end
+
+      context 'and the ignore_unspecified option is disabled' do
+        let(:linter_config) { super().merge('ignore_unspecified' => false) }
+
+        it { should_not report_lint }
+      end
+    end
   end
 
   context 'when sort order is set to a preset order' do