lint_trap 0.0.11 → 0.0.13

data/lib/lint_trap/linter/csslint.rb

@@ -9,9 +9,13 @@ module LintTrap
         super(Language::CSS)
       end
 
+      def version
+        '0.10.0'
+      end
+
     private
 
-      def flags
+      def flags(_container, options)
         [
           '--format=compact'
         ].tap do |flags|
@@ -19,7 +23,7 @@ module LintTrap
         end
       end
 
-      def parser(stdout)
+      def parser(stdout, container)
         LintTrap::Parser::CSSLint.new(stdout, container)
       end
     end

data/lib/lint_trap/linter/golint.rb

@@ -9,13 +9,17 @@ module LintTrap
         super(Language::Go)
       end
 
+      def version
+        LintTrap::VERSION
+      end
+
     private
 
-      def flags
+      def flags(_container, _options)
         []
       end
 
-      def parser(stdout)
+      def parser(stdout, container)
         LintTrap::Parser::VimQuickfix.new(stdout, container)
       end
     end

data/lib/lint_trap/linter/jshint.rb

@@ -10,11 +10,15 @@ module LintTrap
         super(Language::JavaScript)
       end
 
+      def version
+        '2.5.11'
+      end
+
     private
 
-      def flags
+      def flags(container, options)
         [
-          '--reporter', config_path(FORMATTER)
+          '--reporter', container.config_path(FORMATTER)
         ].tap do |flags|
           flags.concat(['--config', options[:config]]) if options[:config]
         end

data/lib/lint_trap/linter/jsonlint.rb

@@ -8,13 +8,17 @@ module LintTrap
         super(Language::JSON)
       end
 
+      def version
+        '0.0.4'
+      end
+
     private
 
-      def command_name
+      def command_name(_container)
         'durable-json-lint'
       end
 
-      def flags
+      def flags(_container, _options)
         ['--format', '{{file}}:{{line}}:{{column}}:::error:{{{description}}}']
       end
     end

data/lib/lint_trap/linter/pylint.rb

@@ -8,9 +8,13 @@ module LintTrap
         super(Language::Python)
       end
 
+      def version
+        '1.3.1-3'
+      end
+
     private
 
-      def flags
+      def flags(_container, options)
         [
           '-r', 'no',
           '--msg-template', '"{abspath}:{line}:{column}::{symbol}:{category}:{msg}"'

data/lib/lint_trap/linter/rubocop.rb

@@ -10,11 +10,15 @@ module LintTrap
         super(Language::Ruby)
       end
 
+      def version
+        '0.31.0'
+      end
+
     private
 
-      def flags
+      def flags(container, options)
         [
-          '--require', config_path(FORMATTER),
+          '--require', container.config_path(FORMATTER),
           '--format', 'LintTrap::Rubocop::Formatter',
           '--no-color'
         ].tap do |flags|

data/lib/lint_trap/linter/scsslint.rb

@@ -10,11 +10,15 @@ module LintTrap
         super(Language::SCSS)
       end
 
-      def command_name
-        config_path(COMMAND)
+      def version
+        '0.38.0'
       end
 
-      def flags
+      def command_name(container)
+        container.config_path(COMMAND)
+      end
+
+      def flags(_container, options)
         [
           '--format=LintTrap'
         ].tap do |flags|

data/lib/lint_trap/linter/unknown.rb

@@ -14,6 +14,10 @@ module LintTrap
         super(Language::Unknown)
       end
 
+      def version
+        LintTrap::VERSION
+      end
+
       def known?
         false
       end

data/lib/lint_trap/linter.rb

@@ -26,6 +26,10 @@ module LintTrap
         linters[name]
       end
 
+      def all
+        linters.values
+      end
+
     protected
 
       attr_reader :linters

data/lib/lint_trap/parser/base.rb

@@ -7,7 +7,7 @@ module LintTrap
       end
 
       def parse
-        raise NotImplementedError, "Subclass #{self.class.name} must implement parse."
+        raise NotImplementedError, "Must implement parse."
       end
 
     protected

data/lib/lint_trap/parser/line.rb

@@ -5,12 +5,17 @@ module LintTrap
     # Handles parsing line by line with regex
     class Line < Base
       def parse
-        io.each_line do |line|
-          puts line if ENV['DEBUG_LINTING']
-          next unless (violation = parse_line(line))
+        output = ''
 
-          yield violation
+        io.each_line do |line|
+          if (violation = parse_line(line))
+            yield violation
+          else
+            output << line
+          end
         end
+
+        output
       end
 
     private
@@ -18,7 +23,8 @@ module LintTrap
       def parse_line(line)
         return unless (match = line.match(violation_regex))
 
-        violation = violation_fields.each_with_object({}) do |field, violation|
+        violation = {}
+        violation_fields.each do |field|
           violation[field.to_sym] = if match.names.include?(field) && !match[field].empty?
             match[field]
           else
@@ -34,7 +40,7 @@ module LintTrap
       end
 
       def violation_regex
-        raise NotImplementedError, "Subclass #{self.class.name} must implement violation_regex."
+        raise NotImplementedError, "Must implement violation_regex."
       end
 
       def standardize(violation)

data/lib/lint_trap/version.rb

@@ -1,3 +1,3 @@
 module LintTrap
-  VERSION = '0.0.11'
+  VERSION = '0.0.13'
 end

data/lint_trap.gemspec

@@ -4,25 +4,26 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'lint_trap/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "lint_trap"
+  spec.name          = 'lint_trap'
   spec.version       = LintTrap::VERSION
-  spec.authors       = ["Allen Madsen"]
-  spec.email         = ["blatyo@gmail.com"]
-  spec.summary       = %q{Parses the output of various linters.}
-  spec.description   = %q{Parses the output of various linters.}
-  spec.homepage      = "https://github.com/lintci/lint_trap"
-  spec.license       = "MIT"
+  spec.authors       = ['Allen Madsen']
+  spec.email         = ['blatyo@gmail.com']
+  spec.summary       = 'Parses the output of various linters.'
+  spec.description   = 'Parses the output of various linters.'
+  spec.homepage      = 'https://github.com/lintci/lint_trap'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables   = spec.files.grep(%r{^bin/}){|f| File.basename(f)}
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'github-linguist', '~> 4.2'
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "rspec-its"
-  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'simplecov'
 end

data/spec/command_spec.rb

@@ -3,22 +3,25 @@ require 'spec_helper'
 describe LintTrap::Command do
   let(:file){fixture_path('lint.txt')}
   let(:command){described_class.new('cat', %w(-b), [file])}
-  let(:container){LintTrap::Container::Docker.new('lintci/spin_cycle', fixture_path)}
+  let(:container){LintTrap::Container::Docker.new('lintci/rubocop', fixture_path)}
 
   describe '#run' do
     it 'generates the expected output' do
-      command.run(container) do |io|
+      success = command.run(container) do |io|
         expect(io.read).to eq("     1\tlint\n")
       end
+
+      expect(success).to be_truthy
     end
   end
 
   describe '#command/#to_s' do
     it 'generates a wrapped executable command' do
       expect(command.to_s(container)).to eq(
-        "docker run --privileged=false -v #{LintTrap::Container::Base::LOCAL_CONFIG_PATH}:/opt/lint_trap/config "\
-        "-v #{fixture_path}:/home/spin_cycle --workdir=/home/spin_cycle --user=spin_cycle lintci/spin_cycle "\
-        'cat -b /home/spin_cycle/lint.txt'
+        'docker run --net="none" --privileged=false '\
+        "-v #{LintTrap::Container::Base::LOCAL_CONFIG_PATH}:/config "\
+        "-v #{fixture_path}:/src --workdir=/src --user=lint_trap lintci/rubocop "\
+        'cat -b /src/lint.txt'
       )
     end
   end

data/spec/container/base_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe LintTrap::Container::Base do
+  subject(:container) do
+    Class.new(described_class).new('lintci/rubocop', '/src')
+  end
+
+  describe '#pull' do
+    it 'raises an error if not overriden' do
+      expect{container.pull}.to raise_error(NotImplementedError, 'Must implement pull.')
+    end
+  end
+
+  describe '#wrap' do
+    it 'raises an error if not overriden' do
+      expect{container.wrap('ls')}.to raise_error(NotImplementedError, 'Must implement wrap.')
+    end
+  end
+
+  describe '#config_path' do
+    it 'raises an error if not overriden' do
+      expect{container.config_path('/config')}.to raise_error(NotImplementedError, 'Must implement config_path.')
+    end
+  end
+
+  describe '#file_path' do
+    it 'raises an error if not overriden' do
+      expect{container.file_path('/src')}.to raise_error(NotImplementedError, 'Must implement file_path.')
+    end
+  end
+end

data/spec/container/docker_spec.rb

@@ -1,15 +1,35 @@
 require 'spec_helper'
 
 describe LintTrap::Container::Docker do
-  subject(:container){described_class.new('lintci/spin_cycle:latest', '/local/path')}
+  let(:image){LintTrap::Linter::RuboCop.new.image_version}
+  subject(:container){described_class.new(image, '/local/path')}
+
+  describe '#pull' do
+    context 'when image exists' do
+      it 'completes successfully' do
+        expect(container.pull).to be_truthy
+      end
+    end
+
+    context 'when image does not exist' do
+      subject(:container){described_class.new('lintci/missing', '/local/path')}
+
+      it 'raises an error' do
+        expect{container.pull}.to raise_error(
+          LintTrap::Container::Base::ImagePullError,
+          /An error occurred while running `docker pull lintci\/missing`. The output was:\n/
+        )
+      end
+    end
+  end
 
   describe '#wrap' do
     it 'wraps the command passed in with a call to docker' do
       expect(container.wrap('ls')).to eq(
-        'docker run --privileged=false '\
-        "-v #{described_class::LOCAL_CONFIG_PATH}:/opt/lint_trap/config "\
-        '-v /local/path:/home/spin_cycle '\
-        '--workdir=/home/spin_cycle --user=spin_cycle lintci/spin_cycle:latest ls'
+        'docker run --net="none" --privileged=false '\
+        "-v #{described_class::LOCAL_CONFIG_PATH}:/config "\
+        '-v /local/path:/src '\
+        "--workdir=/src --user=lint_trap #{image} ls"
       )
     end
   end
@@ -22,13 +42,13 @@ describe LintTrap::Container::Docker do
 
   describe '#container_path' do
     it 'returns the absolute path of the file in the container' do
-      expect(container.container_path('/local/path/bad.file')).to eq('/home/spin_cycle/bad.file')
+      expect(container.container_path('/local/path/bad.file')).to eq('/src/bad.file')
     end
   end
 
   describe '#local_path' do
     it 'returns the absolute path of the file outside the container' do
-      expect(container.local_path('/home/spin_cycle/bad.file')).to eq('/local/path/bad.file')
+      expect(container.local_path('/src/bad.file')).to eq('/local/path/bad.file')
     end
   end
 end

data/spec/execution_error_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe LintTrap::ExecutionError do
+  let(:command){'ls'}
+  let(:output){"Ain't got no time for that"}
+  subject(:error){described_class.new(command, output)}
+
+  its(:message){is_expected.to eq("An error occurred while running `#{command}`. The output was:\n#{output}")}
+  its(:command){is_expected.to eq(command)}
+  its(:output){is_expected.to eq(output)}
+end

data/spec/integration/base_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe LintTrap::Linter::Base do
+  let(:image){LintTrap::Linter::RuboCop.new.image_version}
+  let(:container){LintTrap::Container::Docker.new(image, fixture_path)}
+  let(:options){{}}
+  subject(:linter) do
+    ErrorLinter = Class.new(described_class) do
+      def command_name(_container)
+        'ls'
+      end
+
+      def flags(_container, _options)
+        []
+      end
+    end.new
+  end
+
+  describe '#lint' do
+    context 'when linting fails' do
+      let(:file){fixture_path('this-does-not-exist.rb')}
+
+      it 'raises an error with console output' do
+        expect{|b| linter.lint([file], container, options, &b)}.to raise_error(
+          LintTrap::Linter::LintError,
+          start_with(
+            'An error occurred while running `docker run'
+          )
+        )
+      end
+    end
+  end
+end

data/spec/integration/checkstyle_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe LintTrap::Linter::CheckStyle do
-  let(:container){LintTrap::Container::Docker.new('lintci/spin_cycle:latest', fixture_path)}
+  let(:container){LintTrap::Container::Docker.new(linter.image_version, fixture_path)}
   let(:options){{}}
   subject(:linter){described_class.new}
 

data/spec/integration/coffeelint_spec.rb

@@ -1,25 +1,31 @@
 require 'spec_helper'
 
 describe LintTrap::Linter::CoffeeLint do
-  let(:container){LintTrap::Container::Docker.new('lintci/spin_cycle:latest', fixture_path)}
+  let(:container){LintTrap::Container::Docker.new(linter.image_version, fixture_path)}
   let(:options){{}}
   subject(:linter){described_class.new}
 
+  describe '#version' do
+    subject(:dockerfile){Dockerfile.new(linter.name)}
+
+    it 'matches the linters version' do
+      expect(dockerfile.include_env?('COFFEELINT_VERSION', linter.version)).to be_truthy
+    end
+  end
+
   describe '#lint' do
     context 'when linting a bad file' do
       let(:file){fixture_path('bad.coffee')}
 
       it 'generates lint' do
         expect{|b| linter.lint([file], container, options, &b)}.to yield_successive_args(
-          {
-            file: file,
-            line: '1',
-            column: nil,
-            length: nil,
-            rule: 'camel_case_classes',
-            severity: 'error',
-            message: 'Class names should be camel cased'
-          }
+          file: file,
+          line: '1',
+          column: nil,
+          length: nil,
+          rule: 'camel_case_classes',
+          severity: 'error',
+          message: 'Class name should be UpperCamelCased'
         )
       end
     end

data/spec/integration/cppcheck_spec.rb

@@ -1,10 +1,18 @@
 require 'spec_helper'
 
 describe LintTrap::Linter::CPPCheck do
-  let(:container){LintTrap::Container::Docker.new('lintci/spin_cycle:latest', fixture_path)}
+  let(:container){LintTrap::Container::Docker.new(linter.image_version, fixture_path)}
   let(:options){{}}
   subject(:linter){described_class.new}
 
+  describe '#version' do
+    subject(:dockerfile){Dockerfile.new(linter.name)}
+
+    it 'matches the linters version' do
+      expect(dockerfile.include_env?('CPPCHECK_VERSION', linter.version)).to be_truthy
+    end
+  end
+
   describe '#lint' do
     context 'when linting a bad file' do
       let(:file){fixture_path('bad.cpp')}

data/spec/integration/csslint_spec.rb

@@ -1,25 +1,31 @@
 require 'spec_helper'
 
 describe LintTrap::Linter::CSSLint do
-  let(:container){LintTrap::Container::Docker.new('lintci/spin_cycle:latest', fixture_path)}
+  let(:container){LintTrap::Container::Docker.new(linter.image_version, fixture_path)}
   let(:options){{}}
   subject(:linter){described_class.new}
 
+  describe '#version' do
+    subject(:dockerfile){Dockerfile.new(linter.name)}
+
+    it 'matches the linters version' do
+      expect(dockerfile.include_env?('CSSLINT_VERSION', linter.version)).to be_truthy
+    end
+  end
+
   describe '#lint' do
     context 'when linting a bad file' do
       let(:file){fixture_path('bad.css')}
 
       it 'generates lint' do
         expect{|b| linter.lint([file], container, options, &b)}.to yield_successive_args(
-          {
-            file: file,
-            line: '2',
-            column: '5',
-            length: nil,
-            rule: nil,
-            severity: 'Warning',
-            message: 'Using width with border can sometimes make elements larger than you expect.'
-          }
+          file: file,
+          line: '2',
+          column: '5',
+          length: nil,
+          rule: nil,
+          severity: 'Warning',
+          message: 'Using width with border can sometimes make elements larger than you expect.'
         )
       end
     end

data/spec/integration/golint_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe LintTrap::Linter::GoLint do
-  let(:container){LintTrap::Container::Docker.new('lintci/spin_cycle:latest', fixture_path)}
+  let(:container){LintTrap::Container::Docker.new(linter.image_version, fixture_path)}
   let(:options){{}}
   subject(:linter){described_class.new}
 
@@ -11,15 +11,13 @@ describe LintTrap::Linter::GoLint do
 
       it 'generates lint' do
         expect{|b| linter.lint([file], container, options, &b)}.to yield_successive_args(
-          {
-            file: file,
-            line: '5',
-            column: '1',
-            length: nil,
-            rule: nil,
-            severity: nil,
-            message: 'exported function Main should have comment or be unexported'
-          }
+          file: file,
+          line: '5',
+          column: '1',
+          length: nil,
+          rule: nil,
+          severity: nil,
+          message: 'exported function Main should have comment or be unexported'
         )
       end
     end

data/spec/integration/jshint_spec.rb

@@ -1,10 +1,18 @@
 require 'spec_helper'
 
 describe LintTrap::Linter::JSHint do
-  let(:container){LintTrap::Container::Docker.new('lintci/spin_cycle:latest', fixture_path)}
+  let(:container){LintTrap::Container::Docker.new(linter.image_version, fixture_path)}
   let(:options){{}}
   subject(:linter){described_class.new}
 
+  describe '#version' do
+    subject(:dockerfile){Dockerfile.new(linter.name)}
+
+    it 'matches the linters version' do
+      expect(dockerfile.include_env?('JSHINT_VERSION', linter.version)).to be_truthy
+    end
+  end
+
   describe '#lint' do
     context 'when linting a bad file' do
       let(:file){fixture_path('bad.js')}

data/spec/integration/jsonlint_spec.rb

@@ -1,10 +1,18 @@
 require 'spec_helper'
 
 describe LintTrap::Linter::JSONLint do
-  let(:container){LintTrap::Container::Docker.new('lintci/spin_cycle:latest', fixture_path)}
+  let(:container){LintTrap::Container::Docker.new(linter.image_version, fixture_path)}
   let(:options){{}}
   subject(:linter){described_class.new}
 
+  describe '#version' do
+    subject(:dockerfile){Dockerfile.new(linter.name)}
+
+    it 'matches the linters version' do
+      expect(dockerfile.include_env?('JSONLINT_VERSION', linter.version)).to be_truthy
+    end
+  end
+
   describe '#lint' do
     context 'when linting a bad file' do
       let(:file){fixture_path('bad.json')}

data/spec/integration/pylint_spec.rb

@@ -1,10 +1,18 @@
 require 'spec_helper'
 
 describe LintTrap::Linter::PyLint do
-  let(:container){LintTrap::Container::Docker.new('lintci/spin_cycle:latest', fixture_path)}
+  let(:container){LintTrap::Container::Docker.new(linter.image_version, fixture_path)}
   let(:options){{}}
   subject(:linter){described_class.new}
 
+  describe '#version' do
+    subject(:dockerfile){Dockerfile.new(linter.name)}
+
+    it 'matches the linters version' do
+      expect(dockerfile.include_env?('PYLINT_VERSION', linter.version)).to be_truthy
+    end
+  end
+
   describe '#lint' do
     context 'when linting a bad file' do
       let(:file){fixture_path('bad.py')}

data/spec/integration/rubocop_spec.rb

@@ -1,10 +1,18 @@
 require 'spec_helper'
 
 describe LintTrap::Linter::RuboCop do
-  let(:container){LintTrap::Container::Docker.new('lintci/spin_cycle:latest', fixture_path)}
+  let(:container){LintTrap::Container::Docker.new(linter.image_version, fixture_path)}
   let(:options){{}}
   subject(:linter){described_class.new}
 
+  describe '#version' do
+    subject(:dockerfile){Dockerfile.new(linter.name)}
+
+    it 'matches the linters version' do
+      expect(dockerfile.include_env?('RUBOCOP_VERSION', linter.version)).to be_truthy
+    end
+  end
+
   describe '#lint' do
     context 'when linting a bad file' do
       let(:file){fixture_path('bad.rb')}