lint_trap 0.0.15 → 0.0.16

data/lib/lint_trap/registry.rb

@@ -0,0 +1,29 @@
+module LintTrap
+  # Allow registration and discovery of plugins
+  class Registry
+    def initialize
+      @registry = {}
+    end
+
+    def default(thing_class)
+      @registry.default = thing_class.new
+    end
+
+    def register(thing_class)
+      thing = thing_class.new
+      registry[thing.name] = thing
+    end
+
+    def find(name)
+      registry[name]
+    end
+
+    def all
+      registry.values
+    end
+
+  protected
+
+    attr_reader :registry
+  end
+end

data/lib/lint_trap/version.rb

@@ -1,3 +1,4 @@
+# Gem to detect and lint files
 module LintTrap
-  VERSION = '0.0.15'
+  VERSION = '0.0.16'
 end

data/lib/lint_trap.rb

@@ -1,5 +1,6 @@
 require_relative 'lint_trap/version'
 require_relative 'lint_trap/language'
+require_relative 'lint_trap/parser'
 require_relative 'lint_trap/linter'
 require_relative 'lint_trap/container/docker'
 require_relative 'lint_trap/container/fake'

data/lint_trap.gemspec

@@ -14,8 +14,8 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}){|f| File.basename(f)}
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.executables   = spec.files.grep(/^bin\//){|f| File.basename(f)}
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'github-linguist', '~> 4.2'

data/spec/integration/base_spec.rb

@@ -13,6 +13,10 @@ describe LintTrap::Linter::Base do
       def flags(_container, _options)
         []
       end
+
+      def parser
+        LintTrap::Parser.find('Standard')
+      end
     end.new
   end
 
@@ -22,7 +26,7 @@ describe LintTrap::Linter::Base do
 
       it 'raises an error with console output' do
         expect{|b| linter.lint([file], container, options, &b)}.to raise_error(
-          LintTrap::Linter::LintError,
+          described_class::LintError,
           start_with(
             'An error occurred while running `docker run'
           )

data/spec/integration/checkstyle_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe LintTrap::Linter::CheckStyle do
   let(:container){LintTrap::Container::Docker.new(linter.image_version, fixture_path, remove_container: ENV['CI'].nil?)}
   let(:options){{}}
-  subject(:linter){described_class.new}
+  subject(:linter){LintTrap::Linter.find('CheckStyle')}
 
   describe '#lint' do
     context 'when linting a bad file' do

data/spec/integration/coffeelint_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe LintTrap::Linter::CoffeeLint do
   let(:container){LintTrap::Container::Docker.new(linter.image_version, fixture_path, remove_container: ENV['CI'].nil?)}
   let(:options){{}}
-  subject(:linter){described_class.new}
+  subject(:linter){LintTrap::Linter.find('CoffeeLint')}
 
   describe '#version' do
     subject(:dockerfile){Dockerfile.new(linter.name)}

data/spec/integration/cppcheck_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe LintTrap::Linter::CPPCheck do
   let(:container){LintTrap::Container::Docker.new(linter.image_version, fixture_path, remove_container: ENV['CI'].nil?)}
   let(:options){{}}
-  subject(:linter){described_class.new}
+  subject(:linter){LintTrap::Linter.find('CPPCheck')}
 
   describe '#version' do
     subject(:dockerfile){Dockerfile.new(linter.name)}

data/spec/integration/csslint_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe LintTrap::Linter::CSSLint do
   let(:container){LintTrap::Container::Docker.new(linter.image_version, fixture_path, remove_container: ENV['CI'].nil?)}
   let(:options){{}}
-  subject(:linter){described_class.new}
+  subject(:linter){LintTrap::Linter.find('CSSLint')}
 
   describe '#version' do
     subject(:dockerfile){Dockerfile.new(linter.name)}

data/spec/integration/golint_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe LintTrap::Linter::GoLint do
   let(:container){LintTrap::Container::Docker.new(linter.image_version, fixture_path, remove_container: ENV['CI'].nil?)}
   let(:options){{}}
-  subject(:linter){described_class.new}
+  subject(:linter){LintTrap::Linter.find('GoLint')}
 
   describe '#lint' do
     context 'when linting a bad file' do

data/spec/integration/jshint_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe LintTrap::Linter::JSHint do
   let(:container){LintTrap::Container::Docker.new(linter.image_version, fixture_path, remove_container: ENV['CI'].nil?)}
   let(:options){{}}
-  subject(:linter){described_class.new}
+  subject(:linter){LintTrap::Linter.find('JSHint')}
 
   describe '#version' do
     subject(:dockerfile){Dockerfile.new(linter.name)}

data/spec/integration/jsonlint_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe LintTrap::Linter::JSONLint do
   let(:container){LintTrap::Container::Docker.new(linter.image_version, fixture_path, remove_container: ENV['CI'].nil?)}
   let(:options){{}}
-  subject(:linter){described_class.new}
+  subject(:linter){LintTrap::Linter.find('JSONLint')}
 
   describe '#version' do
     subject(:dockerfile){Dockerfile.new(linter.name)}

data/spec/integration/pylint_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe LintTrap::Linter::PyLint do
   let(:container){LintTrap::Container::Docker.new(linter.image_version, fixture_path, remove_container: ENV['CI'].nil?)}
   let(:options){{}}
-  subject(:linter){described_class.new}
+  subject(:linter){LintTrap::Linter.find('PyLint')}
 
   describe '#version' do
     subject(:dockerfile){Dockerfile.new(linter.name)}

data/spec/integration/rubocop_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe LintTrap::Linter::RuboCop do
   let(:container){LintTrap::Container::Docker.new(linter.image_version, fixture_path, remove_container: ENV['CI'].nil?)}
   let(:options){{}}
-  subject(:linter){described_class.new}
+  subject(:linter){LintTrap::Linter.find('RuboCop')}
 
   describe '#version' do
     subject(:dockerfile){Dockerfile.new(linter.name)}

data/spec/integration/scsslint_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe LintTrap::Linter::SCSSLint do
   let(:container){LintTrap::Container::Docker.new(linter.image_version, fixture_path, remove_container: ENV['CI'].nil?)}
   let(:options){{}}
-  subject(:linter){described_class.new}
+  subject(:linter){LintTrap::Linter.find('SCSSLint')}
 
   describe '#version' do
     subject(:dockerfile){Dockerfile.new(linter.name)}

data/spec/language/coffeescript_spec.rb

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

data/spec/language/cpp_spec.rb

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

data/spec/language/css_spec.rb

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

data/spec/language/go_spec.rb

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

data/spec/language/java_spec.rb

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

data/spec/language/javascript_spec.rb

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

data/spec/language/json_spec.rb

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

data/spec/language/python_spec.rb

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

data/spec/language/ruby_spec.rb

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

data/spec/language/scss_spec.rb

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

data/spec/language/unknown_spec.rb

@@ -5,16 +5,6 @@ describe LintTrap::Language::Unknown do
 
   it_behaves_like 'language'
 
-  context 'when no name is passed' do
-    its(:name){is_expected.to eq('Unknown')}
-  end
-
-  context 'when a name is passed' do
-    subject(:language){described_class.new('Huh')}
-
-    its(:name){is_expected.to eq('Huh')}
-  end
-
+  its(:name){is_expected.to eq('Unknown')}
   its(:linters){is_expected.to eq([LintTrap::Linter::Unknown.new])}
-  it{is_expected.to_not be_known}
 end

data/spec/language_spec.rb

@@ -1,6 +1,25 @@
 require 'spec_helper'
 
 describe LintTrap::Language do
+  describe '.all' do
+    subject(:languages){described_class.all}
+
+    it do
+      is_expected.to match([
+        be_a(described_class::CoffeeScript),
+        be_a(described_class::CPP),
+        be_a(described_class::CSS),
+        be_a(described_class::Go),
+        be_a(described_class::Java),
+        be_a(described_class::JavaScript),
+        be_a(described_class::JSON),
+        be_a(described_class::Python),
+        be_a(described_class::Ruby),
+        be_a(described_class::SCSS)
+      ])
+    end
+  end
+
   describe '.detect' do
     subject(:language){described_class.detect(file)}
 
@@ -67,7 +86,7 @@ describe LintTrap::Language do
     context 'when given an unknown language file' do
       let(:file){fixture_path('lint.txt')}
 
-      it{is_expected.to eq(described_class::Unknown.new('Text'))}
+      it{is_expected.to eq(described_class::Unknown.new)}
     end
 
     context 'when given a known language file that is empty' do
@@ -144,7 +163,7 @@ describe LintTrap::Language do
     context 'when given an invalid language' do
       let(:language_name){'invalid language'}
 
-      it{is_expected.to eq(described_class::Unknown.new(language_name))}
+      it{is_expected.to eq(described_class::Unknown.new)}
     end
   end
 end

data/spec/linter/checkstyle_spec.rb

@@ -5,7 +5,7 @@ describe LintTrap::Linter::CheckStyle do
   let(:options){{}}
   let(:files){%w(Good.java bad.java)}
   let(:command){instance_double(LintTrap::Command)}
-  subject(:linter){described_class.new}
+  subject(:linter){LintTrap::Linter.find('CheckStyle')}
 
   it_behaves_like 'linter'
 

data/spec/linter/coffeelint_spec.rb

@@ -4,7 +4,7 @@ describe LintTrap::Linter::CoffeeLint do
   let(:container){LintTrap::Container::Fake.new}
   let(:options){{}}
   let(:files){%w(good.coffee bad.coffee)}
-  subject(:linter){described_class.new}
+  subject(:linter){LintTrap::Linter.find('CoffeeLint')}
   let(:command){instance_double(LintTrap::Command)}
 
   it_behaves_like 'linter'

data/spec/linter/cppcheck_spec.rb

@@ -4,7 +4,7 @@ describe LintTrap::Linter::CPPCheck do
   let(:container){LintTrap::Container::Fake.new}
   let(:options){{}}
   let(:files){%w(good.cpp bad.cpp)}
-  subject(:linter){described_class.new}
+  subject(:linter){LintTrap::Linter.find('CPPCheck')}
   let(:command){instance_double(LintTrap::Command)}
 
   it_behaves_like 'linter'

data/spec/linter/csslint_spec.rb

@@ -4,7 +4,7 @@ describe LintTrap::Linter::CSSLint do
   let(:container){LintTrap::Container::Fake.new}
   let(:options){{}}
   let(:files){%w(good.css bad.css)}
-  subject(:linter){described_class.new}
+  subject(:linter){LintTrap::Linter.find('CSSLint')}
   let(:command){instance_double(LintTrap::Command)}
 
   it_behaves_like 'linter'

data/spec/linter/golint_spec.rb

@@ -4,7 +4,7 @@ describe LintTrap::Linter::GoLint do
   let(:container){LintTrap::Container::Fake.new}
   let(:options){{}}
   let(:files){%w(good.go bad.go)}
-  subject(:linter){described_class.new}
+  subject(:linter){LintTrap::Linter.find('GoLint')}
   let(:command){instance_double(LintTrap::Command)}
 
   it_behaves_like 'linter'

data/spec/linter/jshint_spec.rb

@@ -4,7 +4,7 @@ describe LintTrap::Linter::JSHint do
   let(:container){LintTrap::Container::Fake.new}
   let(:options){{}}
   let(:files){%w(good.js bad.js)}
-  subject(:linter){described_class.new}
+  subject(:linter){LintTrap::Linter.find('JSHint')}
   let(:command){instance_double(LintTrap::Command)}
 
   it_behaves_like 'linter'

data/spec/linter/jsonlint_spec.rb

@@ -4,7 +4,7 @@ describe LintTrap::Linter::JSONLint do
   let(:container){LintTrap::Container::Fake.new}
   let(:options){{}}
   let(:files){%w(good.go bad.go)}
-  subject(:linter){described_class.new}
+  subject(:linter){LintTrap::Linter.find('JSONLint')}
   let(:command){instance_double(LintTrap::Command)}
 
   it_behaves_like 'linter'

data/spec/linter/pylint_spec.rb

@@ -4,7 +4,7 @@ describe LintTrap::Linter::PyLint do
   let(:container){LintTrap::Container::Fake.new}
   let(:options){{}}
   let(:files){%w(good.py bad.py)}
-  subject(:linter){described_class.new}
+  subject(:linter){LintTrap::Linter.find('PyLint')}
   let(:command){instance_double(LintTrap::Command)}
 
   it_behaves_like 'linter'

data/spec/linter/rubocop_spec.rb

@@ -4,7 +4,7 @@ describe LintTrap::Linter::RuboCop do
   let(:container){LintTrap::Container::Fake.new}
   let(:options){{}}
   let(:files){%w(good.rb bad.rb)}
-  subject(:linter){described_class.new}
+  subject(:linter){LintTrap::Linter.find('RuboCop')}
   let(:command){instance_double(LintTrap::Command)}
 
   it_behaves_like 'linter'

data/spec/linter/scsslint_spec.rb

@@ -4,7 +4,7 @@ describe LintTrap::Linter::SCSSLint do
   let(:container){LintTrap::Container::Fake.new}
   let(:options){{}}
   let(:files){%w(good.scss bad.scss)}
-  subject(:linter){described_class.new}
+  subject(:linter){LintTrap::Linter.find('SCSSLint')}
   let(:command){instance_double(LintTrap::Command)}
 
   it_behaves_like 'linter'

data/spec/linter/unknown_spec.rb

@@ -9,6 +9,7 @@ describe LintTrap::Linter::Unknown do
 
   it_behaves_like 'linter'
 
+  its(:name){is_expected.to eq('Unknown')}
   its(:languages){is_expected.to eq([LintTrap::Language::Unknown.new])}
   its(:version){is_expected.to eq(LintTrap::VERSION)}
   its(:image){is_expected.to eq('lintci/unknown')}

data/spec/linter_spec.rb

@@ -86,7 +86,7 @@ describe LintTrap::Linter do
     context 'when given an unknown linter' do
       let(:linter_name){'taco cheese'}
 
-      it{is_expected.to eq(described_class::Unknown.new(linter_name))}
+      it{is_expected.to eq(described_class::Unknown.new)}
     end
   end
 end

data/spec/parser/base_spec.rb

@@ -3,11 +3,12 @@ require 'spec_helper'
 describe LintTrap::Parser::Base do
   let(:image){LintTrap::Linter::RuboCop.new.image_version}
   let(:container){LintTrap::Container::Docker.new(image, fixture_path, remove_container: ENV['CI'].nil?)}
-  subject(:parser){Class.new(described_class).new(StringIO.new, container)}
+  let(:io){StringIO.new}
+  subject(:parser){Class.new(described_class).new}
 
   describe '#parse' do
     it 'raises an error if not overriden' do
-      expect{parser.parse}.to raise_error(NotImplementedError, 'Must implement parse.')
+      expect{parser.parse(io, container)}.to raise_error(NotImplementedError, 'Must implement parse.')
     end
   end
 end

data/spec/parser/csslint_spec.rb

@@ -7,11 +7,11 @@ describe LintTrap::Parser::CSSLint do
   end
   let(:io){StringIO.new(parser_output)}
   let(:container){LintTrap::Container::Fake.new}
-  subject(:parser){described_class.new(io, container)}
+  subject(:parser){described_class.new}
 
   describe '.parse' do
     it 'parses violations from io' do
-      expect{|b| @result = parser.parse(&b)}.to yield_successive_args(
+      expect{|b| @result = parser.parse(io, container, &b)}.to yield_successive_args(
         file: 'bad.css',
         line: '2',
         column: '5',

data/spec/parser/line_spec.rb

@@ -3,11 +3,12 @@ require 'spec_helper'
 describe LintTrap::Parser::Line do
   let(:image){LintTrap::Linter::RuboCop.new.image_version}
   let(:container){LintTrap::Container::Docker.new(image, fixture_path, remove_container: ENV['CI'].nil?)}
-  subject(:parser){Class.new(described_class).new(StringIO.new('violation'), container)}
+  let(:io){StringIO.new('violation')}
+  subject(:parser){Class.new(described_class).new}
 
   describe '#parse' do
     it 'raises an error if #violation_regex not overriden' do
-      expect{parser.parse}.to raise_error(NotImplementedError, 'Must implement violation_regex.')
+      expect{parser.parse(io, container)}.to raise_error(NotImplementedError, 'Must implement violation_regex.')
     end
   end
 end

data/spec/parser/standard_spec.rb

@@ -12,11 +12,11 @@ describe LintTrap::Parser::Standard do
   end
   let(:io){StringIO.new(parser_output)}
   let(:container){LintTrap::Container::Fake.new}
-  subject(:parser){described_class.new(io, container)}
+  subject(:parser){described_class.new}
 
   describe '.parse' do
     it 'parses violations from io' do
-      expect{|b| @result = parser.parse(&b)}.to yield_successive_args(
+      expect{|b| @result = parser.parse(io, container, &b)}.to yield_successive_args(
         {
           file: 'bad.java',
           line: '1',

data/spec/parser/vim_quickfix_spec.rb

@@ -6,11 +6,11 @@ describe LintTrap::Parser::VimQuickfix do
   end
   let(:io){StringIO.new(parser_output)}
   let(:container){LintTrap::Container::Fake.new}
-  subject(:parser){described_class.new(io, container)}
+  subject(:parser){described_class.new}
 
   describe '#parse' do
     it 'parses violations from io' do
-      expect{|b| @result = parser.parse(&b)}.to yield_successive_args(
+      expect{|b| @result = parser.parse(io, container, &b)}.to yield_successive_args(
         file: 'bad.go',
         line: '5',
         column: '1',

data/spec/registry_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe LintTrap::Registry do
+  let(:a) do
+    Class.new do
+      def name
+        'a'
+      end
+    end
+  end
+  let(:b) do
+    Class.new do
+      def name
+        'b'
+      end
+    end
+  end
+
+  subject(:registry){described_class.new}
+
+  before(:each) do
+    registry.register(a)
+    registry.register(b)
+    registry.default(b)
+  end
+
+  describe '#all' do
+    subject(:all){registry.all}
+
+    it{is_expected.to match([be_a(a), be_a(b)])}
+  end
+
+  describe '#find' do
+    context 'when searching for a' do
+      it 'finds an a' do
+        expect(registry.find('a')).to be_a(a)
+      end
+    end
+
+    context 'when searching for b' do
+      it 'finds a b' do
+        expect(registry.find('b')).to be_a(b)
+      end
+    end
+
+    context 'when searching for an unregistered value' do
+      it 'finds the default' do
+        expect(registry.find('c')).to be_a(b)
+      end
+    end
+  end
+end

data/spec/support/examples/linter.rb

@@ -4,7 +4,8 @@ shared_examples_for 'linter' do
   describe '#languages' do
     it 'returns a list of languages which reference this linter' do
       linter.languages.each do |language|
-        expect(language.linters).to include(linter), "expected #{language.name} to reference #{linter.name} as one of it's linters"
+        expect(language.linters).to include(linter),
+                                    "expected #{language.name} to reference #{linter.name} as one of it's linters"
       end
     end
   end