scss-lint 0.30.0 → 0.31.0

data/lib/scss_lint/linter/selector_format.rb

@@ -29,10 +29,6 @@ module SCSSLint
       check(placeholder, 'placeholder') unless @ignored_types.include?('placeholder')
     end
 
-    def visit_pseudo(pseudo)
-      check(pseudo, 'pseudo') unless @ignored_types.include?('pseudo-selector')
-    end
-
   private
 
     def check(node, type)

data/lib/scss_lint/linter/single_line_per_property.rb

@@ -18,13 +18,7 @@ module SCSSLint
                  'on separate line from selector')
       end
 
-      # Compare each property against the next property to see if they are on
-      # the same line
-      properties[0..-2].zip(properties[1..-1]).each do |first, second|
-        next unless first.line == second.line
-
-        add_lint(second, "Property '#{second.name.join}' should be placed on own line")
-      end
+      check_adjacent_properties(properties)
     end
 
   private
@@ -49,5 +43,17 @@ module SCSSLint
     def first_property_not_on_own_line?(rule, properties)
       properties.any? && properties.first.line == rule.line
     end
+
+    # Compare each property against the next property to see if they are on
+    # the same line.
+    #
+    # @param properties [Array<Sass::Tree::PropNode>]
+    def check_adjacent_properties(properties)
+      properties[0..-2].zip(properties[1..-1]).each do |first, second|
+        next unless first.line == second.line
+
+        add_lint(second, "Property '#{second.name.join}' should be placed on own line")
+      end
+    end
   end
 end

data/lib/scss_lint/linter/single_line_per_selector.rb

@@ -8,19 +8,27 @@ module SCSSLint
     def visit_comma_sequence(node)
       return unless node.members.count > 1
 
-      if node.members[0].members[1] == "\n"
-        # Comma is on its own line
-        add_lint(node, MESSAGE)
-      end
+      check_comma_on_own_line(node)
 
       node.members[1..-1].each_with_index do |sequence, index|
-        if sequence.members[0] != "\n"
-          # Next sequence doesn't reside on its own line
-          add_lint(node.line + index, MESSAGE)
-        elsif sequence.members[1] == "\n"
-          # Comma is on its own line
-          add_lint(node.line + index, MESSAGE)
-        end
+        check_sequence_commas(node, sequence, index)
+      end
+    end
+
+  private
+
+    def check_comma_on_own_line(node)
+      return unless node.members[0].members[1] == "\n"
+      add_lint(node, MESSAGE)
+    end
+
+    def check_sequence_commas(node, sequence, index)
+      if sequence.members[0] != "\n"
+        # Next sequence doesn't reside on its own line
+        add_lint(node.line + index, MESSAGE)
+      elsif sequence.members[1] == "\n"
+        # Comma is on its own line
+        add_lint(node.line + index, MESSAGE)
       end
     end
   end

data/lib/scss_lint/linter/trailing_semicolon.rb

@@ -28,6 +28,8 @@ module SCSSLint
     end
 
     def visit_import(node)
+      # Ignore all but the last import for comma-separated @imports
+      return if source_from_range(node.source_range) =~ /,\s*$/
       check_semicolon(node)
     end
 
@@ -35,13 +37,13 @@ module SCSSLint
 
     def check_semicolon(node)
       if has_space_before_semicolon?(node)
-        line = node.source_range.start_pos.line
-        add_lint line, 'Declaration should be terminated by a semicolon'
-      elsif !ends_with_semicolon?(node)
         line = node.source_range.start_pos.line
         add_lint line,
                  'Declaration should not have a space before ' \
                  'the terminating semicolon'
+      elsif !ends_with_semicolon?(node)
+        line = node.source_range.start_pos.line
+        add_lint line, 'Declaration should be terminated by a semicolon'
       elsif ends_with_multiple_semicolons?(node)
         line = node.source_range.start_pos.line
         add_lint line, 'Declaration should be terminated by a single semicolon'

data/lib/scss_lint/linter/trailing_zero.rb

@@ -1,5 +1,5 @@
 module SCSSLint
-  # Checks for unnecessary leading zeros in numeric values with decimal points.
+  # Checks for unnecessary trailing zeros in numeric values with decimal points.
   class Linter::TrailingZero < Linter
     include LinterRegistry
 
@@ -9,7 +9,7 @@ module SCSSLint
       non_string_values = remove_quoted_strings(node.value).split
       non_string_values.each do |value|
         next unless number = value[FRACTIONAL_DIGIT_REGEX, 1]
-        check_number(node, number)
+        check_for_trailing_zeros(node, number)
       end
     end
 
@@ -17,14 +17,14 @@ module SCSSLint
       return unless number =
         source_from_range(node.source_range)[FRACTIONAL_DIGIT_REGEX, 1]
 
-      check_number(node, number)
+      check_for_trailing_zeros(node, number)
     end
 
   private
 
     FRACTIONAL_DIGIT_REGEX = /^-?(\d*\.\d+)/
 
-    def check_number(node, original_number)
+    def check_for_trailing_zeros(node, original_number)
       return unless match = /^(\d*\.\d*)0+$/.match(original_number)
 
       fixed_number = match[1]

data/lib/scss_lint/options.rb

@@ -0,0 +1,113 @@
+require 'optparse'
+
+module SCSSLint
+  # Handles option parsing for the command line application.
+  class Options
+    DEFAULT_REPORTER = [SCSSLint::Reporter::DefaultReporter, :stdout]
+
+    # Parses command line options into an options hash.
+    #
+    # @param args [Array<String>] arguments passed via the command line
+    # @return [Hash] parsed options
+    def parse(args)
+      @options = {
+        reporters: [DEFAULT_REPORTER],
+      }
+
+      OptionParser.new do |parser|
+        parser.banner = "Usage: #{parser.program_name} [options] [scss-files]"
+
+        add_display_options parser
+        add_linter_options parser
+        add_file_options parser
+        add_info_options parser
+      end.parse!(args)
+
+      # Any remaining arguments are assumed to be files
+      @options[:files] = args
+
+      @options
+    rescue OptionParser::InvalidOption => ex
+      raise SCSSLint::Exceptions::InvalidCLIOption,
+            ex.message,
+            ex.backtrace
+    end
+
+  private
+
+    def add_display_options(parser)
+      parser.on('-f', '--format Formatter', 'Specify how to display lints', String) do |format|
+        define_output_format(format)
+      end
+
+      parser.on('-r', '--require path', 'Require Ruby file', String) do |path|
+        @options[:required_paths] ||= []
+        @options[:required_paths] << path
+      end
+    end
+
+    # @param format [String]
+    def define_output_format(format)
+      unless @options[:reporters] == [DEFAULT_REPORTER] && format == 'Default'
+        @options[:reporters].reject! { |i| i == DEFAULT_REPORTER }
+        reporter = SCSSLint::Reporter.const_get(format + 'Reporter')
+        @options[:reporters] << [reporter, :stdout]
+      end
+    rescue NameError
+      raise SCSSLint::Exceptions::InvalidCLIOption,
+            "Invalid output format specified: #{format}"
+    end
+
+    def add_linter_options(parser)
+      parser.on('-i', '--include-linter linter,...', Array,
+                'Specify which linters you want to run') do |linters|
+        @options[:included_linters] = linters
+      end
+
+      parser.on('-x', '--exclude-linter linter,...', Array,
+                "Specify which linters you don't want to run") do |linters|
+        @options[:excluded_linters] = linters
+      end
+    end
+
+    def add_file_options(parser)
+      parser.on('-c', '--config config-file', String,
+                'Specify which configuration file you want to use') do |conf_file|
+        @options[:config_file] = conf_file
+      end
+
+      parser.on('-e', '--exclude file,...', Array,
+                'List of file names to exclude') do |files|
+        @options[:excluded_files] = files
+      end
+
+      parser.on('-o', '--out path', 'Write output to a file instead of STDOUT', String) do |path|
+        define_output_path(path)
+      end
+    end
+
+    # @param path [String]
+    def define_output_path(path)
+      last_reporter, _output = @options[:reporters].pop
+      @options[:reporters] << [last_reporter, path]
+    end
+
+    def add_info_options(parser)
+      parser.on_tail('--show-formatters', 'Shows available formatters') do
+        @options[:show_formatters] = true
+      end
+
+      parser.on_tail('--show-linters', 'Display available linters') do
+        @options[:show_linters] = true
+      end
+
+      parser.on_tail('-h', '--help', 'Display help documentation') do
+        @options[:help] = parser.help
+      end
+
+      parser.on_tail('-v', '--version', 'Display version') do
+        @options[:version] = true
+      end
+    end
+  end
+end

data/lib/scss_lint/reporter/default_reporter.rb

@@ -5,15 +5,23 @@ module SCSSLint
       return unless lints.any?
 
       lints.map do |lint|
-        type = lint.error? ? '[E]'.color(:red) : '[W]'.color(:yellow)
+        "#{location(lint)} #{type(lint)} #{message(lint)}"
+      end.join("\n") + "\n"
+    end
 
-        linter_name = "#{lint.linter.name}: ".color(:green) if lint.linter
-        message = "#{linter_name}#{lint.description}"
+  private
 
-        "#{lint.filename.color(:cyan)}:" <<
-          "#{lint.location.line}".color(:magenta) <<
-          " #{type} #{message}"
-      end.join("\n") + "\n"
+    def location(lint)
+      "#{lint.filename.color(:cyan)}:#{lint.location.line.to_s.color(:magenta)}"
+    end
+
+    def type(lint)
+      lint.error? ? '[E]'.color(:red) : '[W]'.color(:yellow)
+    end
+
+    def message(lint)
+      linter_name = "#{lint.linter.name}: ".color(:green) if lint.linter
+      "#{linter_name}#{lint.description}"
     end
   end
 end

data/lib/scss_lint/reporter/json_reporter.rb

@@ -7,17 +7,24 @@ module SCSSLint
       output = {}
       lints.group_by(&:filename).each do |filename, file_lints|
         output[filename] = file_lints.map do |lint|
-          issue = {}
-          issue['linter'] = lint.linter.name if lint.linter
-          issue['line'] = lint.location.line
-          issue['column'] = lint.location.column
-          issue['length'] = lint.location.length
-          issue['severity'] = lint.severity
-          issue['reason'] = lint.description
-          issue
+          issue_hash(lint)
         end
       end
       JSON.pretty_generate(output)
     end
+
+  private
+
+    def issue_hash(lint)
+      {
+        'line' => lint.location.line,
+        'column' => lint.location.column,
+        'length' => lint.location.length,
+        'severity' => lint.severity,
+        'reason' => lint.description,
+      }.tap do |hash|
+        hash['linter'] = lint.linter.name if lint.linter
+      end
+    end
   end
 end

data/lib/scss_lint/reporter/xml_reporter.rb

@@ -9,12 +9,7 @@ module SCSSLint
         output << "<file name=#{filename.encode(xml: :attr)}>"
 
         file_lints.each do |lint|
-          output << "<issue linter=\"#{lint.linter.name if lint.linter}\" " \
-                           "line=\"#{lint.location.line}\" " \
-                           "column=\"#{lint.location.column}\" " \
-                           "length=\"#{lint.location.length}\" " \
-                           "severity=\"#{lint.severity}\" " \
-                           "reason=#{lint.description.encode(xml: :attr)} />"
+          output << issue_tag(lint)
         end
 
         output << '</file>'
@@ -23,5 +18,16 @@ module SCSSLint
 
       output
     end
+
+  private
+
+    def issue_tag(lint)
+      "<issue linter=\"#{lint.linter.name if lint.linter}\" " \
+             "line=\"#{lint.location.line}\" " \
+             "column=\"#{lint.location.column}\" " \
+             "length=\"#{lint.location.length}\" " \
+             "severity=\"#{lint.severity}\" " \
+             "reason=#{lint.description.encode(xml: :attr)} />"
+    end
   end
 end

data/lib/scss_lint/runner.rb

@@ -35,11 +35,8 @@ module SCSSLint
       config ||= @config
 
       @linters.each do |linter|
-        next unless config.linter_enabled?(linter)
-        next if config.excluded_file_for_linter?(file, linter)
-
         begin
-          run_linter(linter, engine, config)
+          run_linter(linter, engine, config, file)
         rescue => error
           raise SCSSLint::Exceptions::LinterError,
                 "#{linter.class} raised unexpected error linting file #{file}: " \
@@ -55,7 +52,9 @@ module SCSSLint
     end
 
     # For stubbing in tests.
-    def run_linter(linter, engine, config)
+    def run_linter(linter, engine, config, file)
+      return unless config.linter_enabled?(linter)
+      return if config.excluded_file_for_linter?(file, linter)
       linter.run(engine, config.linter_options(linter))
     end
   end

data/lib/scss_lint/version.rb

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

data/spec/scss_lint/cli_spec.rb

@@ -27,246 +27,28 @@ describe SCSSLint::CLI do
                                          SCSSLint::Linter::FakeTestLinter2])
   end
 
-  describe '#parse_arguments' do
-    let(:files)   { ['file1.scss', 'file2.scss'] }
-    let(:flags) { [] }
-    subject       { SCSSLint::CLI.new(flags + files) }
-
-    def safe_parse
-      subject.parse_arguments
-    rescue SystemExit
-      # Keep running tests
-    end
-
-    context 'when the config_file flag is set' do
-      let(:config_file) { 'my-config-file.yml' }
-      let(:flags) { ['-c', config_file] }
-
-      it 'loads that config file' do
-        SCSSLint::Config.should_receive(:load).with(config_file)
-        safe_parse
-      end
-
-      context 'and the config file is invalid' do
-        before do
-          SCSSLint::Config.should_receive(:load)
-                          .with(config_file)
-                          .and_raise(SCSSLint::InvalidConfiguration)
-        end
-
-        it 'halts with a configuration error code' do
-          subject.should_receive(:halt).with(:config)
-          safe_parse
-        end
-      end
-    end
-
-    context 'when the excluded files flag is set' do
-      let(:flags) { ['-e', 'file1.scss,file3.scss'] }
-
-      it 'sets the :excluded_files option' do
-        safe_parse
-        subject.options[:excluded_files].should =~ ['file1.scss', 'file3.scss']
-      end
-    end
-
-    context 'when the include linters flag is set' do
-      let(:flags) { %w[-i FakeTestLinter2] }
-
-      it 'enables only the included linters' do
-        safe_parse
-        subject.config.enabled_linters.should == [SCSSLint::Linter::FakeTestLinter2]
-      end
-
-      context 'and the included linter does not exist' do
-        let(:flags) { %w[-i NonExistentLinter] }
-
-        it 'halts with a configuration error code' do
-          subject.should_receive(:halt).with(:config)
-          safe_parse
-        end
-      end
-    end
-
-    context 'when the exclude linters flag is set' do
-      let(:flags) { %w[-x FakeTestLinter1] }
-
-      it 'includes all linters except the excluded one' do
-        safe_parse
-        subject.config.enabled_linters.should == \
-          [SCSSLint::Linter::FakeTestLinter2]
-      end
-    end
-
-    context 'when the require flag is set' do
-      let(:flags) { %w[--require uri] }
-
-      it 'requires the specified file and constants are accessible' do
-        safe_parse
-        expect { subject.instance_eval %{ URI } }.to_not raise_error
-      end
-    end
-
-    context 'when neither format nor out flag is set' do
-      let(:flags) { %w[] }
-
-      it 'sets the default reporter to output to stdout' do
-        safe_parse
-        subject.options[:reporters].should \
-          include([SCSSLint::Reporter::DefaultReporter, :stdout])
-      end
-    end
-
-    context 'when the out flag is set' do
-      context 'and the path is valid' do
-        let(:flags) { %w[--out foo.txt] }
-
-        it 'sets the default :output to the given path' do
-          safe_parse
-          subject.options[:reporters].should \
-            include([SCSSLint::Reporter::DefaultReporter, 'foo.txt'])
-        end
-      end
-    end
-
-    context 'when the format flag is set' do
-      context 'and the format is valid' do
-        let(:flags) { %w[--format XML] }
-
-        it 'sets the :reporter option to the correct reporter' do
-          safe_parse
-          subject.options[:reporters].should \
-            include([SCSSLint::Reporter::XMLReporter, :stdout])
-        end
-      end
-
-      context 'and an out path is specified' do
-        let(:flags) { %w[--format XML --out foo.txt] }
-
-        it 'sets the specified reporter :output to the given path' do
-          safe_parse
-          subject.options[:reporters].should \
-            include([SCSSLint::Reporter::XMLReporter, 'foo.txt'])
-        end
-      end
-
-      context 'and the format is invalid' do
-        let(:flags) { %w[--format InvalidFormat] }
-
-        it 'sets the :reporter option to the correct reporter' do
-          subject.should_receive(:halt).with(:config)
-          safe_parse
-        end
-      end
-    end
-
-    context 'when the show formatters flag is set' do
-      let(:flags) { ['--show-formatters'] }
-
-      it 'prints the formatters' do
-        subject.should_receive(:print_formatters)
-        safe_parse
-      end
-    end
-
-    context 'when the show linters flag is set' do
-      let(:flags) { ['--show-linters'] }
-
-      it 'prints the linters' do
-        subject.should_receive(:print_linters)
-        safe_parse
-      end
-    end
-
-    context 'when the help flag is set' do
-      let(:flags) { ['-h'] }
-
-      it 'prints a help message' do
-        subject.should_receive(:print_help)
-        safe_parse
-      end
-    end
-
-    context 'when the version flag is set' do
-      let(:flags) { ['-v'] }
-
-      it 'prints the program version' do
-        subject.should_receive(:print_version)
-        safe_parse
-      end
-    end
-
-    context 'when an invalid option is specified' do
-      let(:flags) { ['--non-existant-option'] }
-
-      it 'prints a help message' do
-        subject.should_receive(:print_help)
-        safe_parse
-      end
-    end
-
-    context 'when no files are specified' do
-      let(:files) { [] }
-
-      it 'sets :files option to the empty list' do
-        safe_parse
-        subject.options[:files].should be_empty
-      end
-    end
-
-    context 'when files are specified' do
-      it 'sets :files option to the list of files' do
-        safe_parse
-        subject.options[:files].should =~ files
-      end
-    end
-  end
-
   describe '#run' do
-    let(:files)   { ['file1.scss', 'file2.scss'] }
-    let(:options) { {} }
-    subject       { SCSSLint::CLI.new(options) }
+    let(:files) { ['file1.scss', 'file2.scss'] }
+    let(:flags) { [] }
+    subject     { SCSSLint::CLI.new }
 
     before do
       subject.stub(:extract_files_from).and_return(files)
     end
 
     def safe_run
-      subject.run
+      subject.run(flags + files)
     rescue SystemExit
       # Keep running tests
     end
 
-    context 'when no files are specified' do
-      let(:files) { [] }
-
-      it 'exits with a no-input status code' do
-        subject.should_receive(:halt).with(:no_input)
-        safe_run
-      end
-    end
-
-    context 'when files are specified' do
-      it 'passes the set of files to the runner' do
-        SCSSLint::Runner.any_instance.should_receive(:run).with(files)
-        safe_run
-      end
-
-      it 'uses the default reporter' do
-        SCSSLint::Reporter::DefaultReporter.any_instance
-          .should_receive(:report_lints)
-        safe_run
-      end
-    end
-
     context 'when there are no lints' do
       before do
         SCSSLint::Runner.any_instance.stub(:lints).and_return([])
       end
 
-      it 'exits cleanly' do
-        subject.should_not_receive(:halt)
-        safe_run
+      it 'returns a successful exit code' do
+        safe_run.should == 0
       end
 
       it 'outputs nothing' do
@@ -288,9 +70,8 @@ describe SCSSLint::CLI do
         ])
       end
 
-      it 'exits cleanly' do
-        subject.should_receive(:halt).with(:warning)
-        safe_run
+      it 'returns a exit code indicating only warnings were reported' do
+        safe_run.should == 1
       end
 
       it 'outputs the warnings' do
@@ -313,8 +94,7 @@ describe SCSSLint::CLI do
       end
 
       it 'exits with an error status code' do
-        subject.should_receive(:halt).with(:error)
-        safe_run
+        safe_run.should == 2
       end
 
       it 'outputs the errors' do