scss-lint 0.32.0 → 0.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78eefba7814228e097ecd728f37ec53bd3a9c98b
-  data.tar.gz: 21356e0c75ed328ac007f0ae9841d0e30a434fbd
+  metadata.gz: e1109af5e1f6cd4016185ea4d079a4188774f2d3
+  data.tar.gz: 41389f3cfc6b63b002101e8608b4b2f5eda48ec6
 SHA512:
-  metadata.gz: 919f35cdcaa899ca549c87e549f653c89d0da5241bf45127d85ab89f9a76186df21432af47fc080827c7c9436aa915171aa70320faf859189d7ca051197d0c84
-  data.tar.gz: c29ec8826b699855207837b10ae2679707b599a5a1db8c06c5579f6631e989e385bf545453498f9ef37408602e11201ee6d3e9658f3998fa8b5557bf10b6c57d
+  metadata.gz: 9120548dc3302ae1c7922e4b46166d6fa9238f4bf755824abad0176dec920d4722c0b4b67042258c7f73ed99903785a4f8bde6e6471809093c74cf0a7f0fbfbb
+  data.tar.gz: 046761b2017cbb1f333e446cae0fda6fb52a5fd8055764e91797b3eccb9eddcf862a18597c7a24ebe5dcd2e6f76d40397b6144298bbcd78d5a4574c88fe774d3

data/config/default.yml

@@ -105,7 +105,7 @@ linters:
 
   SelectorFormat:
     enabled: true
-    convention: hyphenated_lowercase # or 'BEM', or 'snake_case', or 'camel_case', or a regex pattern
+    convention: hyphenated_lowercase # or 'BEM', or 'hyphenated_BEM', or 'snake_case', or 'camel_case', or a regex pattern
 
   Shorthand:
     enabled: true

data/lib/scss_lint.rb

@@ -11,7 +11,7 @@ require 'scss_lint/control_comment_processor'
 require 'scss_lint/version'
 require 'scss_lint/utils'
 
-# Preload Sass so we can monkey patch it
+# Load Sass classes and then monkey patch them
 require 'sass'
 require File.expand_path('scss_lint/sass/script', File.dirname(__FILE__))
 require File.expand_path('scss_lint/sass/tree', File.dirname(__FILE__))

data/lib/scss_lint/linter/space_after_comma.rb

@@ -66,6 +66,9 @@ 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|
+        # Sometimes the line we're looking at doesn't even contain a comma!
+        next unless engine.lines[arg.line - 1].include?(',')
+
         offset = find_comma_offset(arg)
 
         # Check for space or newline after comma (we allow arguments to be split

data/lib/scss_lint/rake_task.rb

@@ -2,40 +2,105 @@ require 'rake'
 require 'rake/tasklib'
 
 module SCSSLint
-  # Provide task for invoking scss-lint via Rake.
+  # Rake task for scss-lint CLI.
   #
   # @example
+  #   # Add the following to your Rakefile...
   #   require 'scss_lint/rake_task'
   #   SCSSLint::RakeTask.new
+  #
+  #   # ...and then execute from the command line:
+  #   rake scss_lint
+  #
+  # You can also specify the list of files as explicit task arguments:
+  #
+  # @example
+  #   # Add the following to your Rakefile...
+  #   require 'scss_lint/rake_task'
+  #   SCSSLint::RakeTask.new
+  #
+  #   # ...and then execute from the command line (single quotes prevent shell
+  #   # glob expansion and allow us to have a space after commas):
+  #   rake 'scss_lint[app/assets/**/*.scss, other_files/**/*.scss]'
   class RakeTask < Rake::TaskLib
-    # The name of the task (default 'scss-lint')
+    # Name of the task.
+    # @return [String]
     attr_accessor :name
 
-    def initialize(*args, &task_block)
-      @name = args.shift || :scss_lint
+    # Configuration file to use.
+    # @return [String]
+    attr_accessor :config
 
-      desc 'Run scss-lint' unless ::Rake.application.last_comment
+    # List of files to lint (can contain shell globs).
+    #
+    # Note that this will be ignored if you explicitly pass a list of files as
+    # task arguments via the command line or in the task definition.
+    # @return [Array<String>]
+    attr_accessor :files
 
-      task(name, *args) do |_, task_args|
-        if task_block
-          task_block.call(*[self, task_args].slice(0, task_block.arity))
-        end
-        run_task
-      end
+    # Create the task so it is accessible via +Rake::Task['scss_lint']+.
+    def initialize(name = :scss_lint)
+      @name = name
+      @files = ['.'] # Search for everything under current directory by default
+      @quiet = false
+
+      yield self if block_given?
+
+      define
     end
 
-    def run_task
-      # Lazy load so task doesn't impact load time of Rakefile
-      require 'scss_lint'
-      require 'scss_lint/cli'
-
-      CLI.new.run([])
-    rescue SystemExit => ex
-      if ex.status == CLI::EXIT_CODES[:data]
-        abort('scss-lint found lints')
-      elsif ex.status != 0
-        abort('scss-lint failed with an error')
+  private
+
+    def define
+      # Generate a default description if one hasn't been provided
+      desc default_description unless ::Rake.application.last_description
+
+      task(name, [:files]) do |_task, task_args|
+        # Lazy-load so task doesn't affect Rakefile load time
+        require 'scss_lint'
+        require 'scss_lint/cli'
+
+        run_cli(task_args)
       end
     end
+
+    def run_cli(task_args)
+      cli_args = ['--config', config] if config
+
+      result = SCSSLint::CLI.new.run(Array(cli_args) + files_to_lint(task_args))
+
+      message =
+        case result
+        when CLI::EXIT_CODES[:error], CLI::EXIT_CODES[:warning]
+          'scss-lint found one or more lints'
+        when CLI::EXIT_CODES[:ok]
+          'scss-lint found no lints'
+        else
+          'scss-lint failed with an error'
+        end
+
+      puts message
+      exit result unless result == 0
+    end
+
+    def files_to_lint(task_args)
+      # Note: we're abusing Rake's argument handling a bit here. We call the
+      # first argument `files` but it's actually only the first file--we pull
+      # the rest out of the `extras` from the task arguments. This is so we
+      # can specify an arbitrary list of files separated by commas on the
+      # command line or in a custom task definition.
+      explicit_files = Array(task_args[:files]) + Array(task_args.extras)
+
+      explicit_files.any? ? explicit_files : files
+    end
+
+    # Friendly description that shows the full command that will be executed.
+    def default_description
+      description = 'Run `scss-lint'
+      description += " --config #{config}" if config
+      description += " #{files.join(' ')}" if files.any?
+      description += ' [files...]`'
+      description
+    end
   end
 end

data/lib/scss_lint/selector_visitor.rb

@@ -15,7 +15,9 @@ module SCSSLint
     end
 
     def visit_members(sequence)
-      sequence.members.each do |member|
+      sequence.members
+              .reject { |member| member.is_a?(String) } # Skip newlines in multi-line comma seqs
+              .each do |member|
         visit_selector(member)
       end
     end

data/lib/scss_lint/version.rb

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

data/spec/scss_lint/linter/selector_format_spec.rb

@@ -535,4 +535,98 @@ describe SCSSLint::Linter::SelectorFormat do
       it { should report_lint }
     end
   end
+
+  context 'when the hyphenated_BEM convention is specified' do
+    let(:linter_config) { { 'convention' => 'hyphenated_BEM' } }
+
+    context 'when a name contains no underscores or hyphens' do
+      let(:css) { '.block {}' }
+
+      it { should_not report_lint }
+    end
+
+    context 'when a name contains single hyphen' do
+      let(:css) { '.b-block {}' }
+
+      it { should_not report_lint }
+    end
+
+    context 'when a name contains multiple hyphens' do
+      let(:css) { '.b-block-name {}' }
+
+      it { should_not report_lint }
+    end
+
+    context 'when a name contains multiple hyphens in a row' do
+      let(:css) { '.b-block--modifier {}' }
+
+      it { should_not report_lint }
+    end
+
+    context 'when a name contains a single underscore' do
+      let(:css) { '.block_modifier {}' }
+
+      it { should report_lint }
+    end
+
+    context 'when a block has name-value modifier' do
+      let(:css) { '.block--modifier-value {}' }
+
+      it { should_not report_lint }
+    end
+
+    context 'when a block has name-value modifier with lots of hyphens' do
+      let(:css) { '.b-block-name--modifier-name-here-value-name-here {}' }
+
+      it { should_not report_lint }
+    end
+
+    context 'when a name has double underscores' do
+      let(:css) { '.b-block__element {}' }
+
+      it { should_not report_lint }
+    end
+
+    context 'when element goes after block with modifier' do
+      let(:css) { '.block--modifier-value__element {}' }
+
+      it { should_not report_lint }
+    end
+
+    context 'when element has modifier' do
+      let(:css) { '.block__element--modifier-value {}' }
+
+      it { should_not report_lint }
+    end
+
+    context 'when element has hypenated modifier' do
+      let(:css) { '.block__element--modifier {}' }
+
+      it { should_not report_lint }
+    end
+
+    context 'when element has hypenated paired modifier' do
+      let(:css) { '.block__element--modifier-value {}' }
+
+      it { should_not report_lint }
+    end
+
+    context 'when a block contains an underscore' do
+      let(:css) { '.a_block__element--modifier {}' }
+
+      it { should report_lint }
+    end
+
+    context 'when an element contains an underscore' do
+      let(:css) { '.block__an_element--modifier {}' }
+
+      it { should report_lint }
+    end
+
+    context 'when a modifier contains an underscore' do
+      let(:css) { '.block__element--a_modifier {}' }
+
+      it { should report_lint }
+    end
+  end
 end

data/spec/scss_lint/linter/space_after_comma_spec.rb

@@ -312,4 +312,21 @@ describe SCSSLint::Linter::SpaceAfterComma do
       it { should_not report_lint }
     end
   end
+
+  context 'when declaring list variables' do
+    context 'and one argument does not have a trailing comma' do
+      let(:css) { <<-CSS }
+        $z-list: (
+          (
+            name1
+          ),
+          (
+            name2,
+          )
+        );
+      CSS
+
+      it { should_not report_lint }
+    end
+  end
 end

data/spec/scss_lint/rake_task_spec.rb

@@ -1,20 +1,43 @@
 require 'spec_helper'
 require 'scss_lint/rake_task'
+require 'tempfile'
 
 describe SCSSLint::RakeTask do
+  before(:all) do
+    SCSSLint::RakeTask.new
+  end
+
   before do
-    # Silence console output
-    STDOUT.stub(:write)
+    STDOUT.stub(:write) # Silence console output
+  end
+
+  let(:file) do
+    Tempfile.new(%w[scss-file .scss]).tap do |f|
+      f.write(scss)
+      f.close
+    end
   end
 
-  describe '#run' do
-    subject do
-      SCSSLint::RakeTask.new
-      Rake::Task['scss_lint']
+  def run_task
+    Rake::Task[:scss_lint].tap do |t|
+      t.reenable # Allows us to execute task multiple times
+      t.invoke(file.path)
     end
+  end
+
+  context 'when SCSS document is valid with no lints' do
+    let(:scss) { '' }
+
+    it 'does not call Kernel.exit' do
+      expect { run_task }.not_to raise_error
+    end
+  end
+
+  context 'when SCSS document is invalid' do
+    let(:scss) { '.class {' }
 
-    it 'returns a successful exit code' do
-      expect(subject.invoke.first.call).to be_truthy
+    it 'calls Kernel.exit with the status code' do
+      expect { run_task }.to raise_error SystemExit
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scss-lint
 version: !ruby/object:Gem::Version
-  version: 0.32.0
+  version: 0.33.0
 platform: ruby
 authors:
 - Causes Engineering
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-07 00:00:00.000000000 Z
+date: 2015-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -271,11 +271,9 @@ test_files:
 - spec/scss_lint/linter/property_spelling_spec.rb
 - spec/scss_lint/linter/qualifying_element_spec.rb
 - spec/scss_lint/linter/selector_depth_spec.rb
-- spec/scss_lint/linter/selector_format_spec.rb
 - spec/scss_lint/linter/shorthand_spec.rb
 - spec/scss_lint/linter/single_line_per_property_spec.rb
 - spec/scss_lint/linter/single_line_per_selector_spec.rb
-- spec/scss_lint/linter/space_after_comma_spec.rb
 - spec/scss_lint/linter/space_after_property_colon_spec.rb
 - spec/scss_lint/linter/space_after_property_name_spec.rb
 - spec/scss_lint/linter/space_between_parens_spec.rb
@@ -292,6 +290,8 @@ test_files:
 - spec/scss_lint/linter/empty_line_between_blocks_spec.rb
 - spec/scss_lint/linter/bang_format_spec.rb
 - spec/scss_lint/linter/space_before_brace_spec.rb
+- spec/scss_lint/linter/selector_format_spec.rb
+- spec/scss_lint/linter/space_after_comma_spec.rb
 - spec/scss_lint/linter_registry_spec.rb
 - spec/scss_lint/location_spec.rb
 - spec/scss_lint/reporter/config_reporter_spec.rb
@@ -301,10 +301,10 @@ test_files:
 - spec/scss_lint/reporter/xml_reporter_spec.rb
 - spec/scss_lint/reporter_spec.rb
 - spec/scss_lint/runner_spec.rb
-- spec/scss_lint/selector_visitor_spec.rb
 - spec/scss_lint/linter_spec.rb
-- spec/scss_lint/rake_task_spec.rb
 - spec/scss_lint/options_spec.rb
+- spec/scss_lint/rake_task_spec.rb
+- spec/scss_lint/selector_visitor_spec.rb
 - spec/support/isolated_environment.rb
 - spec/support/matchers/report_lint.rb
 - spec/spec_helper.rb