lint_trap 0.0.2 → 0.0.3

data/spec/integration/jshint_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe LintTrap::Linter::JSHint do
+  let(:container){LintTrap::Container::Fake.new}
+  subject(:linter){described_class.new(container: container)}
+
+  shared_examples '#lint' do
+    context 'when linting a bad file' do
+      let(:file){fixture_path('bad.js')}
+
+      it 'generates lint' do
+        expect{|b| linter.lint([file], &b)}.to yield_successive_args(
+          {
+            file: file,
+            line: '2',
+            column: '13',
+            length: nil,
+            rule: 'E031',
+            severity: 'error',
+            message: 'Bad assignment.'
+          }, {
+            file: file,
+            line: '2',
+            column: '13',
+            length: nil,
+            rule: 'W030',
+            severity: 'warning',
+            message:
+             'Expected an assignment or function call and instead saw an expression.'
+          }, {
+            file: file,
+            line: '2',
+            column: '14',
+            length: nil,
+            rule: 'W033',
+            severity: 'warning',
+            message: 'Missing semicolon.'
+          }, {
+            file: file,
+            line: '2',
+            column: '15',
+            length: nil,
+            rule: 'W030',
+            severity: 'warning',
+            message:
+             'Expected an assignment or function call and instead saw an expression.'
+          }
+        )
+      end
+    end
+
+    context 'when linting a good file' do
+      let(:file){fixture_path('good.js')}
+
+      it 'generates no lint' do
+        expect{|b| linter.lint([file], &b)}.to_not yield_control
+      end
+    end
+  end
+
+  context 'with docker container', if: !ENV['SKIP_DOCKER'] do
+    let(:container){LintTrap::Container::Docker.new('lintci/spin_cycle:latest', fixture_path)}
+
+    it_behaves_like '#lint'
+  end
+
+  context 'without a docker container', if: ENV['SKIP_DOCKER'] do
+    it_behaves_like '#lint'
+  end
+end

data/spec/integration/jsonlint_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe LintTrap::Linter::JSONLint do
+  let(:container){LintTrap::Container::Fake.new}
+  subject(:linter){described_class.new(container: container)}
+
+  shared_examples '#lint' do
+    context 'when linting a bad file' do
+      let(:file){fixture_path('bad.json')}
+
+      it 'generates lint' do
+        expect{|b| linter.lint([file], &b)}.to yield_successive_args(
+          {
+            file: file,
+            line: '2',
+            column: '2',
+            length: nil,
+            rule: nil,
+            severity: 'error',
+            message: 'Json strings must use double quotes'
+          }, {
+            file: file,
+            line: '3',
+            column: '2',
+            length: nil,
+            rule: nil,
+            severity: 'error',
+            message: 'Keys must be double quoted in Json. Did you mean "not"?'
+          }, {
+            file: file,
+            line: '3',
+            column: '7',
+            length: nil,
+            rule: nil,
+            severity: 'error',
+            message: 'Invalid Json number'
+          }
+        )
+      end
+    end
+
+    context 'when linting a good file' do
+      let(:file){fixture_path('good.json')}
+
+      it 'generates no lint' do
+        expect{|b| linter.lint([file], &b)}.to_not yield_control
+      end
+    end
+  end
+
+  context 'with docker container', if: !ENV['SKIP_DOCKER'] do
+    let(:container){LintTrap::Container::Docker.new('lintci/spin_cycle:latest', fixture_path)}
+
+    it_behaves_like '#lint'
+  end
+
+  context 'without a docker container', if: ENV['SKIP_DOCKER'] do
+    it_behaves_like '#lint'
+  end
+end

data/spec/integration/pylint_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe LintTrap::Linter::PyLint do
+  let(:container){LintTrap::Container::Fake.new}
+  subject(:linter){described_class.new(container: container)}
+
+  shared_examples '#lint' do
+    context 'when linting a bad file' do
+      let(:file){fixture_path('bad.py')}
+
+      it 'generates lint' do
+        expect{|b| linter.lint([file], &b)}.to yield_successive_args(
+          {
+            file: file,
+            line: '1',
+            column: '0',
+            length: nil,
+            rule: 'missing-docstring',
+            severity: 'convention',
+            message: 'Missing module docstring'
+          }, {
+            file: file,
+            line: '1',
+            column: '0',
+            length: nil,
+            rule: 'missing-docstring',
+            severity: 'convention',
+            message: 'Missing function docstring'}
+        )
+      end
+    end
+
+    context 'when linting a good file' do
+      let(:file){fixture_path('good.py')}
+
+      it 'generates no lint' do
+        expect{|b| linter.lint([file], &b)}.to_not yield_control
+      end
+    end
+  end
+
+  context 'with docker container', if: !ENV['SKIP_DOCKER'] do
+    let(:container){LintTrap::Container::Docker.new('lintci/spin_cycle:latest', fixture_path)}
+
+    it_behaves_like '#lint'
+  end
+
+  context 'without a docker container', if: ENV['SKIP_DOCKER'] do
+    it_behaves_like '#lint'
+  end
+end

data/spec/integration/rubocop_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe LintTrap::Linter::RuboCop do
+  let(:container){LintTrap::Container::Fake.new}
+  subject(:linter){described_class.new(container: container)}
+
+  shared_examples '#lint' do
+    context 'when linting a bad file' do
+      let(:file){fixture_path('bad.rb')}
+
+      it 'generates lint' do
+        expect{|b| linter.lint([file], &b)}.to yield_successive_args(
+          {
+            file: file,
+            line: '1',
+            column: '1',
+            length: '5',
+            rule: 'Style/Documentation',
+            severity: 'convention',
+            message: 'Missing top-level class documentation comment.'
+          }, {
+            file: file,
+            line: '2',
+            column: '7',
+            length: '4',
+            rule: 'Style/MethodName',
+            severity: 'convention',
+            message: 'Use snake_case for method names.'
+          }
+        )
+      end
+    end
+
+    context 'when linting a good file' do
+      let(:file){fixture_path('good.rb')}
+
+      it 'generates no lint' do
+        expect{|b| linter.lint([file], &b)}.to_not yield_control
+      end
+    end
+  end
+
+  context 'with docker container', if: !ENV['SKIP_DOCKER'] do
+    let(:container){LintTrap::Container::Docker.new('lintci/spin_cycle:latest', fixture_path)}
+
+    it_behaves_like '#lint'
+  end
+
+  context 'without a docker container', if: ENV['SKIP_DOCKER'] do
+    it_behaves_like '#lint'
+  end
+end

data/spec/integration/scsslint_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe LintTrap::Linter::SCSSLint do
+  let(:container){LintTrap::Container::Fake.new}
+  subject(:linter){described_class.new(container: container)}
+
+  shared_examples '#lint' do
+    context 'when linting a bad file' do
+      let(:file){fixture_path('bad.scss')}
+
+      it 'generates lint' do
+        expect{|b| linter.lint([file], &b)}.to yield_successive_args(
+          {
+            file: file,
+            line: '2',
+            column: '3',
+            length: '12',
+            rule: 'BorderZero',
+            severity: 'warning',
+            message: '`border: 0;` is preferred over `border: none;`'
+          }
+        )
+      end
+    end
+
+    context 'when linting a good file' do
+      let(:file){fixture_path('good.scss')}
+
+      it 'generates no lint' do
+        expect{|b| linter.lint([file], &b)}.to_not yield_control
+      end
+    end
+  end
+
+  context 'with docker container', if: !ENV['SKIP_DOCKER'] do
+    let(:container){LintTrap::Container::Docker.new('lintci/spin_cycle:latest', fixture_path)}
+
+    it_behaves_like '#lint'
+  end
+
+  context 'without a docker container', if: ENV['SKIP_DOCKER'] do
+    it_behaves_like '#lint'
+  end
+end

data/spec/language/coffeescript_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe LintTrap::Language::CoffeeScript do
+  subject(:language){described_class.new}
+
+  its(:name){is_expected.to eq('CoffeeScript')}
+  its(:linters){is_expected.to eq([LintTrap::Linter::CoffeeLint])}
+end

data/spec/language/cpp_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe LintTrap::Language::CPP do
+  subject(:language){described_class.new}
+
+  its(:name){is_expected.to eq('C++')}
+  its(:linters){is_expected.to eq([LintTrap::Linter::CPPCheck])}
+end

data/spec/language/css_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe LintTrap::Language::CSS do
+  subject(:language){described_class.new}
+
+  its(:name){is_expected.to eq('CSS')}
+  its(:linters){is_expected.to eq([LintTrap::Linter::CSSLint])}
+end

data/spec/language/go_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe LintTrap::Language::Go do
+  subject(:language){described_class.new}
+
+  its(:name){is_expected.to eq('Go')}
+  its(:linters){is_expected.to eq([LintTrap::Linter::GoLint])}
+end

data/spec/language/java_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe LintTrap::Language::Java do
+  subject(:language){described_class.new}
+
+  its(:name){is_expected.to eq('Java')}
+  its(:linters){is_expected.to eq([LintTrap::Linter::CheckStyle])}
+end

data/spec/language/javascript_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe LintTrap::Language::JavaScript do
+  subject(:language){described_class.new}
+
+  its(:name){is_expected.to eq('JavaScript')}
+  its(:linters){is_expected.to eq([LintTrap::Linter::JSHint])}
+end

data/spec/language/json_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe LintTrap::Language::JSON do
+  subject(:language){described_class.new}
+
+  its(:name){is_expected.to eq('JSON')}
+  its(:linters){is_expected.to eq([LintTrap::Linter::JSONLint])}
+end

data/spec/language/python_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe LintTrap::Language::Python do
+  subject(:language){described_class.new}
+
+  its(:name){is_expected.to eq('Python')}
+  its(:linters){is_expected.to eq([LintTrap::Linter::PyLint])}
+end

data/spec/language/ruby_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe LintTrap::Language::Ruby do
+  subject(:language){described_class.new}
+
+  its(:name){is_expected.to eq('Ruby')}
+  its(:linters){is_expected.to eq([LintTrap::Linter::RuboCop])}
+end

data/spec/language/scss_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe LintTrap::Language::SCSS do
+  subject(:language){described_class.new}
+
+  its(:name){is_expected.to eq('SCSS')}
+  its(:linters){is_expected.to eq([LintTrap::Linter::SCSSLint])}
+end

data/spec/language_spec.rb

@@ -0,0 +1,143 @@
+require 'spec_helper'
+
+describe LintTrap::Language do
+  describe '.detect' do
+    subject(:language){described_class.detect(file)}
+
+    context 'when given a CoffeeScript file' do
+      let(:file){fixture_path('good.coffee')}
+
+      it{is_expected.to eq(described_class::CoffeeScript)}
+    end
+
+    context 'when given a C++ file' do
+      let(:file){fixture_path('good.cpp')}
+
+      it{is_expected.to eq(described_class::CPP)}
+    end
+
+    context 'when given a CSS file' do
+      let(:file){fixture_path('good.css')}
+
+      it{is_expected.to eq(described_class::CSS)}
+    end
+
+    context 'when given a Go file' do
+      let(:file){fixture_path('good.go')}
+
+      it{is_expected.to eq(described_class::Go)}
+    end
+
+    context 'when given a Java file' do
+      let(:file){fixture_path('Good.java')}
+
+      it{is_expected.to eq(described_class::Java)}
+    end
+
+    context 'when given a JavaScript file' do
+      let(:file){fixture_path('good.js')}
+
+      it{is_expected.to eq(described_class::JavaScript)}
+    end
+
+    context 'when given a JSON file' do
+      let(:file){fixture_path('good.json')}
+
+      it{is_expected.to eq(described_class::JSON)}
+    end
+
+    context 'when given a Python file' do
+      let(:file){fixture_path('good.py')}
+
+      it{is_expected.to eq(described_class::Python)}
+    end
+
+    context 'when given a Ruby file' do
+      let(:file){fixture_path('good.rb')}
+
+      it{is_expected.to eq(described_class::Ruby)}
+    end
+
+    context 'when given a SCSS file' do
+      let(:file){fixture_path('good.scss')}
+
+      it{is_expected.to eq(described_class::SCSS)}
+    end
+
+    context 'when given an unknown language file' do
+      let(:file){fixture_path('lint.txt')}
+
+      it{is_expected.to eq(nil)}
+    end
+  end
+
+  describe '.find' do
+    subject(:language){described_class.find(language_name)}
+
+    context 'when given CoffeeScript' do
+      let(:language_name){'CoffeeScript'}
+
+      it{is_expected.to eq(described_class::CoffeeScript)}
+    end
+
+    context 'when given C++' do
+      let(:language_name){'C++'}
+
+      it{is_expected.to eq(described_class::CPP)}
+    end
+
+    context 'when given CSS' do
+      let(:language_name){'CSS'}
+
+      it{is_expected.to eq(described_class::CSS)}
+    end
+
+    context 'when given Go' do
+      let(:language_name){'Go'}
+
+      it{is_expected.to eq(described_class::Go)}
+    end
+
+    context 'when given Java' do
+      let(:language_name){'Java'}
+
+      it{is_expected.to eq(described_class::Java)}
+    end
+
+    context 'when given JavaScript' do
+      let(:language_name){'JavaScript'}
+
+      it{is_expected.to eq(described_class::JavaScript)}
+    end
+
+    context 'when given JSON' do
+      let(:language_name){'JSON'}
+
+      it{is_expected.to eq(described_class::JSON)}
+    end
+
+    context 'when given Python' do
+      let(:language_name){'Python'}
+
+      it{is_expected.to eq(described_class::Python)}
+    end
+
+    context 'when given Ruby' do
+      let(:language_name){'Ruby'}
+
+      it{is_expected.to eq(described_class::Ruby)}
+    end
+
+    context 'when given SCSS' do
+      let(:language_name){'SCSS'}
+
+      it{is_expected.to eq(described_class::SCSS)}
+    end
+
+    context 'when given an invalid language' do
+      let(:language_name){'invalid language'}
+
+      it{is_expected.to eq(nil)}
+    end
+  end
+end

data/spec/lint_trap_spec.rb

@@ -4,20 +4,4 @@ describe LintTrap do
   it 'has a version number' do
     expect(LintTrap::VERSION).not_to be nil
   end
-
-  describe '.parse' do
-    let(:io){StringIO.new("bad.rb:2:7:4:Style/MethodName:convention:Use snake_case for methods.\n")}
-
-    it 'yields the expected violations' do
-      expect{|b| LintTrap.parse('rubocop', io, &b)}.to yield_successive_args({
-        file: 'bad.rb',
-        line: '2',
-        column: '7',
-        length: '4',
-        rule: 'Style/MethodName',
-        severity: 'convention',
-        message: 'Use snake_case for methods.'
-      })
-    end
-  end
 end

data/spec/linter/checkstyle_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe LintTrap::Linter::CheckStyle do
+  let(:container){LintTrap::Container::Fake.new}
+  let(:config){nil}
+  let(:files){%w(Good.java bad.java)}
+  subject(:linter){described_class.new(container: container, config: config)}
+  let(:command){instance_double(LintTrap::Command)}
+
+  describe '#lint' do
+    context 'when config is provided' do
+      let(:config){'checks.xml'}
+
+      it 'runs the lint command with the correct arguments' do
+        expect(LintTrap::Command).to receive(:new).with(
+          'java',
+          [
+            '-jar', container.config_path(described_class::JAR),
+            '-c', config
+          ],
+          files
+        ).and_return(command)
+        expect(command).to receive(:run).with(container)
+
+        linter.lint(files)
+      end
+    end
+
+    context 'when config is not provided' do
+      it 'runs the lint command with the correct arguments' do
+        expect(LintTrap::Command).to receive(:new).with(
+          'java',
+          [
+            '-jar', container.config_path(described_class::JAR),
+            '-c', container.config_path(described_class::CHECKS_XML)
+          ],
+          files
+        ).and_return(command)
+        expect(command).to receive(:run).with(container)
+
+        linter.lint(files)
+      end
+    end
+  end
+end

data/spec/linter/coffeelint_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe LintTrap::Linter::CoffeeLint do
+  let(:container){LintTrap::Container::Fake.new}
+  let(:config){nil}
+  let(:files){%w(good.coffee bad.coffee)}
+  subject(:linter){described_class.new(container: container, config: config)}
+  let(:command){instance_double(LintTrap::Command)}
+
+  describe '#lint' do
+    context 'when config is provided' do
+      let(:config){'coffeelint.json'}
+
+      it 'runs the lint command with the correct arguments' do
+        expect(LintTrap::Command).to receive(:new).with(
+          'coffeelint',
+          [
+            "--reporter=#{container.config_path(described_class::REPORTER)}",
+            '--nocolor',
+            '--file=coffeelint.json'
+          ],
+          files
+        ).and_return(command)
+        expect(command).to receive(:run).with(container)
+
+        linter.lint(files)
+      end
+    end
+
+    context 'when config is not provided' do
+      it 'runs the lint command with the correct arguments' do
+        expect(LintTrap::Command).to receive(:new).with(
+          'coffeelint',
+          [
+            "--reporter=#{container.config_path(described_class::REPORTER)}",
+            '--nocolor'
+          ],
+          files
+        ).and_return(command)
+        expect(command).to receive(:run).with(container)
+
+        linter.lint(files)
+      end
+    end
+  end
+end

data/spec/linter/cppcheck_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe LintTrap::Linter::CPPCheck do
+  let(:container){LintTrap::Container::Fake.new}
+  let(:config){nil}
+  let(:files){%w(good.cpp bad.cpp)}
+  subject(:linter){described_class.new(container: container, config: config)}
+  let(:command){instance_double(LintTrap::Command)}
+
+  describe '#lint' do
+    it 'runs the lint command with the correct arguments' do
+      expect(LintTrap::Command).to receive(:new).with(
+        'cppcheck',
+        [
+          '--enable=all',
+          '--error-exitcode=1',
+          '--template="{file}:{line}:::{id}:{severity}:{message}"'
+        ],
+        files
+      ).and_return(command)
+      expect(command).to receive(:run).with(container)
+
+      linter.lint(files)
+    end
+  end
+end