scss_lint 0.38.0

data/spec/scss_lint/location_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe SCSSLint::Location do
+  let(:engine) { described_class.new(css) }
+
+  describe '#<=>' do
+    let(:locations) do
+      [
+        SCSSLint::Location.new(2, 2, 2),
+        SCSSLint::Location.new(2, 2, 1),
+        SCSSLint::Location.new(2, 1, 2),
+        SCSSLint::Location.new(2, 1, 1),
+        SCSSLint::Location.new(1, 2, 2),
+        SCSSLint::Location.new(1, 2, 1),
+        SCSSLint::Location.new(1, 1, 2),
+        SCSSLint::Location.new(1, 1, 1)
+      ]
+    end
+
+    it 'allows locations to be sorted' do
+      locations.sort.should == [
+        SCSSLint::Location.new(1, 1, 1),
+        SCSSLint::Location.new(1, 1, 2),
+        SCSSLint::Location.new(1, 2, 1),
+        SCSSLint::Location.new(1, 2, 2),
+        SCSSLint::Location.new(2, 1, 1),
+        SCSSLint::Location.new(2, 1, 2),
+        SCSSLint::Location.new(2, 2, 1),
+        SCSSLint::Location.new(2, 2, 2)
+      ]
+    end
+
+    context 'when the same location is passed' do
+      let(:location) { SCSSLint::Location.new(1, 1, 1) }
+      let(:other_location) { SCSSLint::Location.new(1, 1, 1) }
+
+      it 'returns 0' do
+        (location <=> other_location).should == 0
+      end
+    end
+  end
+end

data/spec/scss_lint/options_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'scss_lint/options'
+
+describe SCSSLint::Options do
+  describe '#parse' do
+    subject { super().parse(args) }
+
+    context 'when no arguments are specified' do
+      let(:args) { [] }
+
+      it { should be_a Hash }
+
+      it 'defines no files to lint by default' do
+        subject[:files].should be_empty
+      end
+
+      it 'specifies the DefaultReporter by default' do
+        subject[:reporters].first.should include 'Default'
+      end
+
+      it 'outputs to STDOUT' do
+        subject[:reporters].first.should include :stdout
+      end
+    end
+
+    context 'when a non-existent flag is specified' do
+      let(:args) { ['--totally-made-up-flag'] }
+
+      it 'raises an error' do
+        expect { subject }.to raise_error SCSSLint::Exceptions::InvalidCLIOption
+      end
+    end
+  end
+end

data/spec/scss_lint/rake_task_spec.rb

@@ -0,0 +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
+    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
+
+  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 'calls Kernel.exit with the status code' do
+      expect { run_task }.to raise_error SystemExit
+    end
+  end
+end

data/spec/scss_lint/reporter/config_reporter_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe SCSSLint::Reporter::ConfigReporter do
+  subject { YAML.load(result) }
+  let(:result) { described_class.new(lints).report_lints }
+
+  describe '#report_lints' do
+    context 'when there are no lints' do
+      let(:lints) { [] }
+
+      it 'returns nil' do
+        result.should be_nil
+      end
+    end
+
+    context 'when there are lints' do
+      let(:linters) do
+        [SCSSLint::Linter::FinalNewline, SCSSLint::Linter::BorderZero,
+         SCSSLint::Linter::BorderZero, nil]
+      end
+      let(:lints) do
+        linters.each.map do |linter|
+          SCSSLint::Lint.new(linter ? linter.new : nil, '',
+                             SCSSLint::Location.new, '')
+        end
+      end
+
+      it 'adds one entry per linter' do
+        subject['linters'].size.should eq 2
+      end
+
+      it 'sorts linters by name' do
+        subject['linters'].map(&:first).should eq %w[BorderZero FinalNewline]
+      end
+
+      it 'disables all found linters' do
+        subject['linters']['BorderZero']['enabled'].should eq false
+        subject['linters']['FinalNewline']['enabled'].should eq false
+      end
+    end
+  end
+end

data/spec/scss_lint/reporter/default_reporter_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe SCSSLint::Reporter::DefaultReporter do
+  subject { SCSSLint::Reporter::DefaultReporter.new(lints) }
+
+  describe '#report_lints' do
+    context 'when there are no lints' do
+      let(:lints) { [] }
+
+      it 'returns nil' do
+        subject.report_lints.should be_nil
+      end
+    end
+
+    context 'when there are lints' do
+      let(:filenames)    { ['some-filename.scss', 'other-filename.scss'] }
+      let(:lines)        { [502, 724] }
+      let(:descriptions) { ['Description of lint 1', 'Description of lint 2'] }
+      let(:severities)   { [:warning] * 2 }
+      let(:lints) do
+        filenames.each_with_index.map do |filename, index|
+          location = SCSSLint::Location.new(lines[index])
+          SCSSLint::Lint.new(nil, filename, location, descriptions[index],
+                             severities[index])
+        end
+      end
+
+      it 'prints each lint on its own line' do
+        subject.report_lints.count("\n").should == 2
+      end
+
+      it 'prints a trailing newline' do
+        subject.report_lints[-1].should == "\n"
+      end
+
+      it 'prints the filename for each lint' do
+        filenames.each do |filename|
+          subject.report_lints.scan(/#{filename}/).count.should == 1
+        end
+      end
+
+      it 'prints the line number for each lint' do
+        lines.each do |line|
+          subject.report_lints.scan(/#{line}/).count.should == 1
+        end
+      end
+
+      it 'prints the description for each lint' do
+        descriptions.each do |description|
+          subject.report_lints.scan(/#{description}/).count.should == 1
+        end
+      end
+
+      context 'when lints are warnings' do
+        it 'prints the warning severity code on each line' do
+          subject.report_lints.split("\n").each do |line|
+            line.scan(/\[W\]/).count.should == 1
+          end
+        end
+      end
+
+      context 'when lints are errors' do
+        let(:severities) { [:error] * 2 }
+
+        it 'prints the error severity code on each line' do
+          subject.report_lints.split("\n").each do |line|
+            line.scan(/\[E\]/).count.should == 1
+          end
+        end
+      end
+    end
+  end
+end

data/spec/scss_lint/reporter/files_reporter_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe SCSSLint::Reporter::FilesReporter do
+  subject { described_class.new(lints) }
+
+  describe '#report_lints' do
+    context 'when there are no lints' do
+      let(:lints) { [] }
+
+      it 'returns nil' do
+        subject.report_lints.should be_nil
+      end
+    end
+
+    context 'when there are lints' do
+      let(:filenames)    { ['some-filename.scss', 'some-filename.scss', 'other-filename.scss'] }
+      let(:lints) do
+        filenames.map do |filename|
+          SCSSLint::Lint.new(nil, filename, SCSSLint::Location.new, '')
+        end
+      end
+
+      it 'prints each file on its own line' do
+        subject.report_lints.count("\n").should == 2
+      end
+
+      it 'prints a trailing newline' do
+        subject.report_lints[-1].should == "\n"
+      end
+
+      it 'prints the filename for each lint' do
+        filenames.each do |filename|
+          subject.report_lints.scan(/#{filename}/).count.should == 1
+        end
+      end
+    end
+  end
+end

data/spec/scss_lint/reporter/json_reporter_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+describe SCSSLint::Reporter::JSONReporter do
+  subject { SCSSLint::Reporter::JSONReporter.new(lints) }
+
+  describe '#report_lints' do
+    let(:json) { JSON.parse(subject.report_lints) }
+
+    shared_examples_for 'parsed JSON' do
+      it 'is a Hash' do
+        json.is_a?(Hash)
+      end
+    end
+
+    context 'when there are no lints' do
+      let(:lints) { [] }
+
+      it_should_behave_like 'parsed JSON'
+    end
+
+    context 'when there are lints' do
+      let(:filenames)    { ['f1.scss', 'f2.scss', 'f1.scss'] }
+      # Include invalid XML characters in the third description to validate
+      # that escaping happens for preventing broken XML output
+      let(:descriptions) { ['lint 1', 'lint 2', 'lint 3 " \' < & >'] }
+      let(:severities)   { [:warning] * 3 }
+
+      let(:locations)    do
+        [
+          SCSSLint::Location.new(5,  2, 3),
+          SCSSLint::Location.new(7,  6, 2),
+          SCSSLint::Location.new(9, 10, 1)
+        ]
+      end
+
+      let(:lints) do
+        filenames.each_with_index.map do |filename, index|
+          SCSSLint::Lint.new(nil, filename, locations[index],
+                             descriptions[index], severities[index])
+        end
+      end
+
+      it_should_behave_like 'parsed JSON'
+
+      it 'contains an <issue> node for each lint' do
+        json.values.inject(0) { |sum, issues| sum + issues.size }.should == 3
+      end
+
+      it 'contains a group of issues for each file' do
+        json.keys.should == filenames.uniq
+      end
+
+      it 'contains <issue> nodes grouped by <file>' do
+        json.values.map(&:size).should == [2, 1]
+      end
+
+      it 'marks each issue with a line number' do
+        json.values.flat_map { |issues| issues.map { |issue| issue['line'] } }
+          .should =~ locations.map(&:line)
+      end
+
+      it 'marks each issue with a column number' do
+        json.values.flat_map { |issues| issues.map { |issue| issue['column'] } }
+          .should =~ locations.map(&:column)
+      end
+
+      it 'marks each issue with a length' do
+        json.values.flat_map { |issues| issues.map { |issue| issue['length'] } }
+          .should =~ locations.map(&:length)
+      end
+
+      it 'marks each issue with a reason containing the lint description' do
+        json.values.flat_map { |issues| issues.map { |issue| issue['reason'] } }
+          .should =~ descriptions
+      end
+
+      context 'when lints are warnings' do
+        it 'marks each issue with a severity of "warning"' do
+          json.values.inject(0) do |sum, issues|
+            sum + issues.select { |i| i['severity'] == 'warning' }.size
+          end.should == 3
+        end
+      end
+
+      context 'when lints are errors' do
+        let(:severities) { [:error] * 3 }
+
+        it 'marks each issue with a severity of "error"' do
+          json.values.inject(0) do |sum, issues|
+            sum + issues.select { |i| i['severity'] == 'error' }.size
+          end.should == 3
+        end
+      end
+    end
+  end
+end

data/spec/scss_lint/reporter/xml_reporter_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+describe SCSSLint::Reporter::XMLReporter do
+  subject { SCSSLint::Reporter::XMLReporter.new(lints) }
+
+  describe '#report_lints' do
+    let(:xml) { Nokogiri::XML(subject.report_lints) }
+
+    shared_examples_for 'XML document' do
+      it 'has an encoding of UTF-8' do
+        xml.encoding.should == 'utf-8'
+      end
+
+      it 'has an XML version of 1.0' do
+        xml.version.should == '1.0'
+      end
+
+      it 'contains a <lint> root element' do
+        xml.root.name.should == 'lint'
+      end
+    end
+
+    context 'when there are no lints' do
+      let(:lints) { [] }
+
+      it_should_behave_like 'XML document'
+    end
+
+    context 'when there are lints' do
+      let(:filenames)    { ['f1.scss', 'f2.scss', 'f1.scss'] }
+      # Include invalid XML characters in the third description to validate
+      # that escaping happens for preventing broken XML output
+      let(:descriptions) { ['lint 1', 'lint 2', 'lint 3 " \' < & >'] }
+      let(:severities)   { [:warning] * 3 }
+
+      let(:locations)    do
+        [
+          SCSSLint::Location.new(5,  2, 3),
+          SCSSLint::Location.new(7,  6, 2),
+          SCSSLint::Location.new(9, 10, 1)
+        ]
+      end
+
+      let(:lints) do
+        filenames.each_with_index.map do |filename, index|
+          SCSSLint::Lint.new(nil, filename, locations[index],
+                             descriptions[index], severities[index])
+        end
+      end
+
+      it_should_behave_like 'XML document'
+
+      it 'contains an <issue> node for each lint' do
+        xml.xpath('//issue').count.should == 3
+      end
+
+      it 'contains a <file> node for each file' do
+        xml.xpath('//file').map { |node| node[:name] }
+          .should =~ filenames.uniq
+      end
+
+      it 'contains <issue> nodes grouped by <file>' do
+        xml.xpath('//file').map do |file_node|
+          file_node.xpath('./issue').count
+        end.should =~ [1, 2]
+      end
+
+      it 'marks each issue with a line number' do
+        xml.xpath('//issue[@line]').map { |node| node[:line] }
+          .should =~ locations.map { |location| location.line.to_s }
+      end
+
+      it 'marks each issue with a column number' do
+        xml.xpath('//issue[@column]').map { |node| node[:column] }
+          .should =~ locations.map { |location| location.column.to_s }
+      end
+
+      it 'marks each issue with a length' do
+        xml.xpath('//issue[@length]').map { |node| node[:length] }
+          .should =~ locations.map { |location| location.length.to_s }
+      end
+
+      it 'marks each issue with a reason containing the lint description' do
+        xml.xpath('//issue[@reason]').map { |node| node[:reason] }
+          .should =~ descriptions
+      end
+
+      context 'when lints are warnings' do
+        it 'marks each issue with a severity of "warning"' do
+          xml.xpath("//issue[@severity='warning']").count == 3
+        end
+      end
+
+      context 'when lints are errors' do
+        let(:severities) { [:error] * 3 }
+
+        it 'marks each issue with a severity of "error"' do
+          xml.xpath("//issue[@severity='error']").count == 3
+        end
+      end
+    end
+  end
+end