lint_trap 0.0.2 → 0.0.3

data/lib/lint_trap/{parsers/base_parser.rb → parser/base.rb}

@@ -1,19 +1,18 @@
 module LintTrap
-  module Parsers
-    class BaseParser
-      class << self
-        def parse(io)
-          new(io).parse(&Proc.new)
-        end
-      end
-
-      def initialize(io)
+  module Parser
+    class Base
+      def initialize(io, container)
         @io = io
+        @container = container
       end
 
       def parse
         raise NotImplementedError, "Subclass #{self.class.name} must implement parse."
       end
+
+    protected
+
+      attr_reader :container, :io
     end
   end
 end

data/lib/lint_trap/{parsers/csslint_parser.rb → parser/csslint.rb}

@@ -1,10 +1,9 @@
-require_relative 'line_parser'
+require_relative 'line'
 
 module LintTrap
-  module Parsers
-    # Handles parsing LintCI standard format
-    class CSSLintParser < LineParser
-
+  module Parser
+    # Handles parsing LintTrap standard format
+    class CSSLint < Line
     private
 
       def violation_regex

data/lib/lint_trap/{parsers/line_parser.rb → parser/line.rb}

@@ -1,11 +1,12 @@
-require_relative 'base_parser'
+require_relative 'base'
 
 module LintTrap
-  module Parsers
+  module Parser
     # Handles parsing line by line with regex
-    class LineParser < BaseParser
+    class Line < Base
       def parse
-        @io.each_line do |line|
+        io.each_line do |line|
+          puts line if ENV['DEBUG_LINTING']
           next unless (violation = parse_line(line))
 
           yield violation
@@ -17,13 +18,15 @@ module LintTrap
       def parse_line(line)
         return unless (match = line.match(violation_regex))
 
-        violation_fields.each_with_object({}) do |field, violation|
+        violation = violation_fields.each_with_object({}) do |field, violation|
           violation[field.to_sym] = if match.names.include?(field) && !match[field].empty?
             match[field]
           else
             nil
           end
         end
+
+        standardize(violation)
       end
 
       def violation_fields
@@ -33,6 +36,12 @@ module LintTrap
       def violation_regex
         raise NotImplementedError, "Subclass #{self.class.name} must implement violation_regex."
       end
+
+      def standardize(violation)
+        violation[:file] = container.local_path(violation[:file])
+
+        violation
+      end
     end
   end
 end

data/lib/lint_trap/parser/standard.rb

@@ -0,0 +1,22 @@
+require_relative 'line'
+
+module LintTrap
+  module Parser
+    # Handles parsing LintTrap standard format
+    class Standard < Line
+    private
+
+      def violation_regex
+        /
+          (?<file>[^:]+):
+          (?<line>\d*):
+          (?<column>\d*):
+          (?<length>\d*):
+          (?<rule>[^:]*):
+          (?<severity>[^:]*):
+          (?<message>.+)
+        /x
+      end
+    end
+  end
+end

data/lib/lint_trap/parser/vim_quickfix.rb

@@ -0,0 +1,19 @@
+require_relative 'line'
+
+module LintTrap
+  module Parser
+    # Handles parsing LintTrap standard format
+    class VimQuickfix < Line
+    private
+
+      def violation_regex
+        /
+          (?<file>[^:]+):
+          (?<line>\d*):
+          (?<column>\d*):\s*
+          (?<message>.+)
+        /x
+      end
+    end
+  end
+end

data/lib/lint_trap/version.rb

@@ -1,3 +1,3 @@
 module LintTrap
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/lint_trap.rb

@@ -1,14 +1,5 @@
-require 'lint_trap/version'
-require 'lint_trap/parser_factory'
-
-# Parses linter output from IO
-module LintTrap
-  class << self
-    def parse(linter, io, parser_name = nil)
-      parser = ParserFactory.parser_for(parser_name)
-      parser = ParserFactory.parser_for(linter) if parser_name.nil?
-
-      parser.parse(io, &Proc.new)
-    end
-  end
-end
+require_relative 'lint_trap/version'
+require_relative 'lint_trap/language'
+require_relative 'lint_trap/linter'
+require_relative 'lint_trap/container/docker'
+require_relative 'lint_trap/container/fake'

data/lint_trap.gemspec

@@ -18,8 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   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"
 end

data/spec/command_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe LintTrap::Command do
+  let(:file){'fake file.txt'}
+  let(:command){described_class.new('cat', %w(-b), [file])}
+  let(:container){LintTrap::Container::Fake.new}
+
+  describe '#run' do
+    let(:file){File.expand_path('../fixtures/lint.txt', __FILE__)}
+
+    it 'generates the expected output' do
+      command.run(container) do |io|
+        expect(io.read).to eq("     1\tlint\n")
+      end
+    end
+  end
+
+  describe '#command/#to_s' do
+    context 'with fake container' do
+      it 'generates a bare executable command' do
+        expect(command.to_s).to eq('cat -b fake\ file.txt 2>&1')
+      end
+    end
+
+    context 'with docker container' do
+      let(:file){fixture_path('lint.txt')}
+      let(:container){LintTrap::Container::Docker.new('lint/runner', fixture_path)}
+
+      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 lint/runner "\
+          'cat -b /home/spin_cycle/lint.txt 2>&1'
+        )
+      end
+    end
+  end
+end

data/spec/container/docker_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe LintTrap::Container::Docker do
+  subject(:container){described_class.new('lintci/spin_cycle:latest', '/local/path')}
+
+  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'
+      )
+    end
+  end
+
+  describe '#config_path' do
+    it 'returns the docker config_path' do
+      expect(container.config_path('')).to eq(described_class::CONFIG_PATH.to_s)
+    end
+  end
+
+  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')
+    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')
+    end
+  end
+end

data/spec/container/fake_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe LintTrap::Container::Fake do
+  subject(:container){described_class.new}
+
+  describe '#wrap' do
+    it 'returns the command passed in' do
+      expect(container.wrap('ls')).to eq('ls')
+    end
+  end
+
+  describe '#config_path' do
+    it 'returns the gems config_path' do
+      expect(container.config_path('')).to eq(described_class::LOCAL_CONFIG_PATH.to_s)
+    end
+  end
+
+  describe '#container_path' do
+    it 'returns the path passed in' do
+      expect(container.container_path('bad.file')).to eq('bad.file')
+    end
+  end
+
+  describe '#local_path' do
+    it 'returns the path passed in' do
+      expect(container.local_path('bad.file')).to eq('bad.file')
+    end
+  end
+end

data/spec/fixtures/Good.java

@@ -0,0 +1,6 @@
+/**
+ * Does absolutely nothing but pass lint checks.
+ */
+public class Good {
+
+}

data/spec/fixtures/bad.coffee

@@ -0,0 +1 @@
+class xMen

data/spec/fixtures/bad.cpp

@@ -0,0 +1,5 @@
+void f()
+{
+    char *p;
+    *p = 0;
+}

data/spec/fixtures/bad.css

@@ -0,0 +1,4 @@
+.mybox {
+    border: 1px solid black;
+    width: 100px;
+}

data/spec/fixtures/bad.go

@@ -0,0 +1,7 @@
+package main
+
+import "fmt"
+
+func Main() {
+    fmt.Println("hello world")
+}

data/spec/fixtures/bad.java

@@ -0,0 +1,3 @@
+public class bad {
+
+}

data/spec/fixtures/bad.js

@@ -0,0 +1,3 @@
+function example() {
+  example() = 1;
+}

data/spec/fixtures/bad.json

@@ -0,0 +1,4 @@
+{
+  'bad': 1,
+  not: /good/
+}

data/spec/fixtures/bad.py

@@ -0,0 +1,2 @@
+def read_game_progress():
+    return 0

data/spec/fixtures/bad.rb

@@ -0,0 +1,4 @@
+class Bob
+  def xMan
+  end
+end

data/spec/fixtures/bad.scss

@@ -0,0 +1,3 @@
+p {
+  border: none;
+}

data/spec/fixtures/good.coffee

@@ -0,0 +1 @@
+class XMen

data/spec/fixtures/good.cpp

@@ -0,0 +1,4 @@
+int main()
+{
+    return 0;
+}

data/spec/fixtures/good.css

@@ -0,0 +1,3 @@
+.mybox {
+    width: 100px;
+}

data/spec/fixtures/good.go

@@ -0,0 +1,7 @@
+package main
+
+import "fmt"
+
+func main() {
+    fmt.Println("hello world")
+}

data/spec/fixtures/good.js

@@ -0,0 +1,5 @@
+function main() {
+  if(true === 1) return '===';
+}
+
+main();

data/spec/fixtures/good.json

@@ -0,0 +1,4 @@
+{
+  "good": 1,
+  "not": "bad"
+}

data/spec/fixtures/good.py

@@ -0,0 +1,6 @@
+""" good.py """
+
+def read_game_progress():
+    """ read_game_progress """
+    level = 0
+    return level

data/spec/fixtures/good.rb

@@ -0,0 +1,5 @@
+# Bob is useless
+class Bob
+  def x_man
+  end
+end

data/spec/fixtures/good.scss

@@ -0,0 +1,3 @@
+p {
+  border: 0;
+}

data/spec/fixtures/lint.txt

@@ -0,0 +1 @@
+lint

data/spec/integration/checkstyle_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe LintTrap::Linter::CheckStyle 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.java')}
+
+      it 'generates lint' do
+        expect{|b| linter.lint([file], &b)}.to yield_successive_args(
+          {
+            file: file,
+            line: '1',
+            column: '0',
+            length: nil,
+            rule: 'com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck',
+            severity: 'error',
+            message: 'Missing a Javadoc comment.'
+          }, {
+            file: file,
+            line: '1',
+            column: '14',
+            length: nil,
+            rule: 'com.puppycrawl.tools.checkstyle.checks.naming.TypeNameCheck',
+            severity: 'error',
+            message: "Name 'bad' must match pattern '^[A-Z][a-zA-Z0-9]*$'."
+          }
+        )
+      end
+    end
+
+    context 'when linting a good file' do
+      let(:file){fixture_path('Good.java')}
+
+      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/coffeelint_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe LintTrap::Linter::CoffeeLint 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.coffee')}
+
+      it 'generates lint' do
+        expect{|b| linter.lint([file], &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'
+          }
+        )
+      end
+    end
+
+    context 'when linting a good file' do
+      let(:file){fixture_path('good.coffee')}
+
+      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/cppcheck_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe LintTrap::Linter::CPPCheck 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.cpp')}
+
+      it 'generates lint' do
+        expect{|b| linter.lint([file], &b)}.to yield_successive_args(
+          {
+            file: file,
+            line: '3',
+            column: nil,
+            length: nil,
+            rule: 'unassignedVariable',
+            severity: 'style',
+            message: "Variable 'p' is not assigned a value."
+          }, {
+            file: file,
+            line: '4',
+            column: nil,
+            length: nil,
+            rule: 'uninitvar',
+            severity: 'error',
+            message: 'Uninitialized variable: p'
+          }, {
+            file: file,
+            line: '1',
+            column: nil,
+            length: nil,
+            rule: 'unusedFunction',
+            severity: 'style',
+            message: "The function 'f' is never used."
+          }
+        )
+      end
+    end
+
+    context 'when linting a good file' do
+      let(:file){fixture_path('good.cpp')}
+
+      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/csslint_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe LintTrap::Linter::CSSLint 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.css')}
+
+      it 'generates lint' do
+        expect{|b| linter.lint([file], &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.'
+          }
+        )
+      end
+    end
+
+    context 'when linting a good file' do
+      let(:file){fixture_path('good.css')}
+
+      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/golint_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe LintTrap::Linter::GoLint 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.go')}
+
+      it 'generates lint' do
+        expect{|b| linter.lint([file], &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'
+          }
+        )
+      end
+    end
+
+    context 'when linting a good file' do
+      let(:file){fixture_path('good.go')}
+
+      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