lint_trap 0.0.15 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92fc111e75ab3a2cab86275cab5777e8c82f793f
-  data.tar.gz: 6096c4ee46e51450dc472c020f14ce8f8a005e50
+  metadata.gz: 5bc37f9f82c78cd395b59c6c0db07c517734a50f
+  data.tar.gz: d6f3c7092a1cf4118ee781126b7c4ccaddec4c5f
 SHA512:
-  metadata.gz: 78086d27a86e8adced7b07d6c8879ac649a44321835fce6a27c64b1caa1ddba5defae22bd5cf5a46ebce3d3d1016b0b42e27154f19cd04624a86137b5dab785b
-  data.tar.gz: 75c073bf67794d1eb036844a26fc19034ae58dfc370ea27d6e37ee6c03e0d5f7667c7619aa181bef6560e22d1c9400dadc27704f16e680d2f145cfb5474f415a
+  metadata.gz: 9587a9b916aaadb66a8e4e8144836d035fba86ba36c7aba527f3edbfd7c316f7079c8630b08c4b27d4056b5e9e994857a3bda47930d5d8a9b137589ecdf029ca
+  data.tar.gz: 6f1f42b7a96f2b26ca0f0f4fff5a796065439bb65117531d6ce63c4be3b709d9209498e0107f16c8d7517bb39df726bf3706de63fd7ad87ff1cd5e5e1b401f05

data/Rakefile

@@ -21,6 +21,7 @@ task :credentials do
 end
 
 namespace :docker do
+  # Common tasks performed with docker
   class Docker
     DOCKER_CACHE_PATH = File.expand_path('~/.docker')
     DOCKER_IMAGE_PATH = File.join(DOCKER_CACHE_PATH, 'image.tar')
@@ -91,7 +92,7 @@ namespace :docker do
     end
 
     def sha
-      sha = ENV['CIRCLE_SHA1'] ? ENV['CIRCLE_SHA1'] : `git rev-parse HEAD`.strip
+      ENV['CIRCLE_SHA1'] ? ENV['CIRCLE_SHA1'] : `git rev-parse HEAD`.strip
     end
   end
 

data/lib/lint_trap/container/base.rb

@@ -3,6 +3,7 @@ require_relative '../execution_error'
 
 module LintTrap
   module Container
+    # Interface for a container
     class Base
       ImagePullError = Class.new(ExecutionError)
 

data/lib/lint_trap/language/base.rb

@@ -2,16 +2,18 @@ module LintTrap
   module Language
     # Interface for languages
     class Base
-      def name
-        self.class.name.split('::').last
+      attr_reader :linters
+
+      def initialize
+        @linters = []
       end
 
-      def linters(*classes)
-        classes.map(&:new)
+      def name
+        self.class.name.split('::').last
       end
 
-      def known?
-        true
+      def add_linter(linter)
+        @linters << linter
       end
 
       def ==(other)

data/lib/lint_trap/language/coffeescript.rb

@@ -5,9 +5,6 @@ module LintTrap
   module Language
     # CoffeeScript
     class CoffeeScript < Base
-      def linters
-        super(Linter::CoffeeLint)
-      end
     end
   end
 end

data/lib/lint_trap/language/cpp.rb

@@ -8,10 +8,6 @@ module LintTrap
       def name
         'C++'
       end
-
-      def linters
-        super(Linter::CPPCheck)
-      end
     end
   end
 end

data/lib/lint_trap/language/css.rb

@@ -5,9 +5,6 @@ module LintTrap
   module Language
     # CSS
     class CSS < Base
-      def linters
-        super(Linter::CSSLint)
-      end
     end
   end
 end

data/lib/lint_trap/language/go.rb

@@ -5,9 +5,6 @@ module LintTrap
   module Language
     # Go
     class Go < Base
-      def linters
-        super(Linter::GoLint)
-      end
     end
   end
 end

data/lib/lint_trap/language/java.rb

@@ -5,9 +5,6 @@ module LintTrap
   module Language
     # Java
     class Java < Base
-      def linters
-        super(Linter::CheckStyle)
-      end
     end
   end
 end

data/lib/lint_trap/language/javascript.rb

@@ -5,9 +5,6 @@ module LintTrap
   module Language
     # JavaScript
     class JavaScript < Base
-      def linters
-        super(Linter::JSHint)
-      end
     end
   end
 end

data/lib/lint_trap/language/json.rb

@@ -5,9 +5,6 @@ module LintTrap
   module Language
     # JSON
     class JSON < Base
-      def linters
-        super(Linter::JSONLint)
-      end
     end
   end
 end

data/lib/lint_trap/language/python.rb

@@ -5,9 +5,6 @@ module LintTrap
   module Language
     # Python
     class Python < Base
-      def linters
-        super(Linter::PyLint)
-      end
     end
   end
 end

data/lib/lint_trap/language/ruby.rb

@@ -5,9 +5,6 @@ module LintTrap
   module Language
     # Ruby
     class Ruby < Base
-      def linters
-        super(Linter::RuboCop)
-      end
     end
   end
 end

data/lib/lint_trap/language/scss.rb

@@ -5,9 +5,6 @@ module LintTrap
   module Language
     # SCSS
     class SCSS < Base
-      def linters
-        super(Linter::SCSSLint)
-      end
     end
   end
 end

data/lib/lint_trap/language/unknown.rb

@@ -5,18 +5,8 @@ module LintTrap
   module Language
     # Interface for languages
     class Unknown < Base
-      attr_reader :name
-
-      def initialize(name = 'Unknown')
-        @name = name
-      end
-
       def linters
-        super(Linter::Unknown)
-      end
-
-      def known?
-        false
+        [Linter::Unknown.new]
       end
     end
   end

data/lib/lint_trap/language.rb

@@ -1,5 +1,6 @@
 require 'linguist'
 
+require_relative 'registerable'
 require_relative 'language/coffeescript'
 require_relative 'language/cpp'
 require_relative 'language/css'
@@ -13,31 +14,16 @@ require_relative 'language/scss'
 require_relative 'language/unknown'
 
 module LintTrap
-  # Language lookup
+  # Language registry
   module Language
-    @languages = {}
+    extend Registerable
 
     class << self
-      def register(language_class)
-        language = language_class.new
-        languages[language.name] = language
-      end
-
       def detect(file)
-        if (language = Linguist::FileBlob.new(file).language)
-          find(language.name)
-        else
-          Unknown.new
-        end
-      end
+        language = Linguist::FileBlob.new(file).language
 
-      def find(name)
-        languages[name] || Unknown.new(name)
+        find(language && language.name)
       end
-
-    protected
-
-      attr_reader :languages
     end
 
     register CoffeeScript
@@ -50,5 +36,6 @@ module LintTrap
     register Python
     register Ruby
     register SCSS
+    default Unknown
   end
 end

data/lib/lint_trap/linter/base.rb

@@ -1,31 +1,45 @@
-require_relative '../parser/standard'
 require_relative '../command'
 require_relative '../execution_error'
 
 module LintTrap
   module Linter
-    LintError = Class.new(ExecutionError)
-
     # The base class for all linters. Provides a template for linter execution.
     class Base
+      LintError = Class.new(ExecutionError)
+
       CONFIG_PATH = File.expand_path('../../../../config', __FILE__)
 
-      def lint(files, container, options)
-        return unless known?
+      attr_accessor :parser
+      attr_reader :languages
+
+      def initialize
+        @languages = []
+      end
 
+      def lint(files, container, options)
         violations_found, remaining_output = false, ''
+
         success = command(files, container, options).run(container) do |stdout|
-          remaining_output = parser(stdout, container).parse do |violation|
+          remaining_output = parser.parse(stdout, container) do |violation|
             violations_found = true
             yield violation
           end
         end
 
-        if !violations_found && !success
+        if violations_found
+          false
+        elsif success
+          true
+        else
           raise LintError.new(command(files, container, options).to_s(container), remaining_output)
         end
       end
 
+      def add_language(language)
+        @languages << language
+        language.add_linter(self)
+      end
+
       def name
         self.class.name.split('::').last
       end
@@ -42,14 +56,6 @@ module LintTrap
         "#{image}:#{version}"
       end
 
-      def languages(*classes)
-        classes.map(&:new)
-      end
-
-      def known?
-        true
-      end
-
       def ==(other)
         return false unless other.respond_to?(:name, true)
 
@@ -66,10 +72,6 @@ module LintTrap
         Command.new(command_name(container), flags(container, options), files)
       end
 
-      def parser(stdout, container)
-        LintTrap::Parser::Standard.new(stdout, container)
-      end
-
       def flags(_container, _options)
         raise NotImplementedError, 'Must implement flags.'
       end

data/lib/lint_trap/linter/checkstyle.rb

@@ -6,10 +6,6 @@ module LintTrap
     class CheckStyle < Base
       CHECKS_XML = 'checkstyle/sun_checks.xml'
 
-      def languages
-        super(Language::Java)
-      end
-
       def version
         '6.6'
       end

data/lib/lint_trap/linter/coffeelint.rb

@@ -6,10 +6,6 @@ module LintTrap
     class CoffeeLint < Base
       REPORTER = 'coffeelint/lint_trap.coffee'
 
-      def languages
-        super(Language::CoffeeScript)
-      end
-
       def version
         '1.9.7'
       end

data/lib/lint_trap/linter/cppcheck.rb

@@ -4,10 +4,6 @@ module LintTrap
   module Linter
     # Encapsulates logic specific to cppcheck command line tool.
     class CPPCheck < Base
-      def languages
-        super(Language::CPP)
-      end
-
       def version
         '1.67-1'
       end

data/lib/lint_trap/linter/csslint.rb

@@ -5,10 +5,6 @@ module LintTrap
   module Linter
     # Encapsulates logic specific to csslint command line tool.
     class CSSLint < Base
-      def languages
-        super(Language::CSS)
-      end
-
       def version
         '0.10.0'
       end
@@ -22,10 +18,6 @@ module LintTrap
           flags.concat(["--config=#{options[:config]}"]) if options[:config]
         end
       end
-
-      def parser(stdout, container)
-        LintTrap::Parser::CSSLint.new(stdout, container)
-      end
     end
   end
 end

data/lib/lint_trap/linter/golint.rb

@@ -5,10 +5,6 @@ module LintTrap
   module Linter
     # Encapsulates logic specific to golint command line tool.
     class GoLint < Base
-      def languages
-        super(Language::Go)
-      end
-
       def version
         LintTrap::VERSION
       end
@@ -18,10 +14,6 @@ module LintTrap
       def flags(_container, _options)
         []
       end
-
-      def parser(stdout, container)
-        LintTrap::Parser::VimQuickfix.new(stdout, container)
-      end
     end
   end
 end

data/lib/lint_trap/linter/jshint.rb

@@ -6,10 +6,6 @@ module LintTrap
     class JSHint < Base
       FORMATTER = 'jshint/formatter.js'
 
-      def languages
-        super(Language::JavaScript)
-      end
-
       def version
         '2.5.11'
       end

data/lib/lint_trap/linter/jsonlint.rb

@@ -4,10 +4,6 @@ module LintTrap
   module Linter
     # Encapsulates logic specific to durable-json-lint command line tool.
     class JSONLint < Base
-      def languages
-        super(Language::JSON)
-      end
-
       def version
         '0.0.4'
       end

data/lib/lint_trap/linter/pylint.rb

@@ -4,10 +4,6 @@ module LintTrap
   module Linter
     # Encapsulates logic specific to pylint command line tool.
     class PyLint < Base
-      def languages
-        super(Language::Python)
-      end
-
       def version
         '1.3.1-3'
       end

data/lib/lint_trap/linter/rubocop.rb

@@ -6,10 +6,6 @@ module LintTrap
     class RuboCop < Base
       FORMATTER = 'rubocop/formatter.rb'
 
-      def languages
-        super(Language::Ruby)
-      end
-
       def version
         '0.31.0'
       end

data/lib/lint_trap/linter/scsslint.rb

@@ -6,10 +6,6 @@ module LintTrap
     class SCSSLint < Base
       COMMAND = 'scsslint/scsslint'
 
-      def languages
-        super(Language::SCSS)
-      end
-
       def version
         '0.38.0'
       end

data/lib/lint_trap/linter/unknown.rb

@@ -4,23 +4,16 @@ module LintTrap
   module Linter
     # Encapsulates logic specific to scsslint command line tool.
     class Unknown < Base
-      attr_reader :name
-
-      def initialize(name = 'Unknown')
-        @name = name
+      def lint(_files, _container, _options)
       end
 
       def languages
-        super(Language::Unknown)
+        [Language::Unknown.new]
       end
 
       def version
         LintTrap::VERSION
       end
-
-      def known?
-        false
-      end
     end
   end
 end

data/lib/lint_trap/linter.rb

@@ -1,3 +1,4 @@
+require_relative 'registerable'
 require_relative 'linter/checkstyle'
 require_relative 'linter/coffeelint'
 require_relative 'linter/cppcheck'
@@ -11,39 +12,32 @@ require_relative 'linter/scsslint'
 require_relative 'linter/unknown'
 
 module LintTrap
-  # Linter lookup
+  # Linter registry
   module Linter
-    @linters = Hash.new{|h, v| h[v] = Unknown.new(v)}
+    extend Registerable
 
     class << self
-      def register(linter_class)
-        linter = linter_class.new
+      def register(linter_class, languages:, parser: nil)
+        linter = super(linter_class)
 
-        linters[linter.name] = linter
-      end
-
-      def find(name)
-        linters[name]
-      end
+        Array(languages).each do |language|
+          linter.add_language(Language.find(language))
+        end
 
-      def all
-        linters.values
+        linter.parser = Parser.find(parser)
       end
-
-    protected
-
-      attr_reader :linters
     end
 
-    register CheckStyle
-    register CoffeeLint
-    register CPPCheck
-    register CSSLint
-    register GoLint
-    register JSHint
-    register JSONLint
-    register PyLint
-    register RuboCop
-    register SCSSLint
+    register CheckStyle, languages: 'Java'
+    register CoffeeLint, languages: 'CoffeeScript'
+    register CPPCheck, languages: 'C++'
+    register CSSLint, languages: 'CSS', parser: 'CSSLint'
+    register GoLint, languages: 'Go', parser: 'VimQuickfix'
+    register JSHint, languages: 'JavaScript'
+    register JSONLint, languages: 'JSON'
+    register PyLint, languages: 'Python'
+    register RuboCop, languages: 'Ruby'
+    register SCSSLint, languages: 'SCSS'
+    default Unknown
   end
 end

data/lib/lint_trap/parser/base.rb

@@ -1,18 +1,14 @@
 module LintTrap
   module Parser
+    # Interface for parsers
     class Base
-      def initialize(io, container)
-        @io = io
-        @container = container
+      def parse(_io, _container)
+        raise NotImplementedError, 'Must implement parse.'
       end
 
-      def parse
-        raise NotImplementedError, "Must implement parse."
+      def name
+        self.class.name.split('::').last
       end
-
-    protected
-
-      attr_reader :container, :io
     end
   end
 end

data/lib/lint_trap/parser/line.rb

@@ -4,11 +4,11 @@ module LintTrap
   module Parser
     # Handles parsing line by line with regex
     class Line < Base
-      def parse
+      def parse(io, container)
         output = ''
 
         io.each_line do |line|
-          if (violation = parse_line(line))
+          if (violation = parse_line(line, container))
             yield violation
           else
             output << line
@@ -20,7 +20,7 @@ module LintTrap
 
     private
 
-      def parse_line(line)
+      def parse_line(line, container)
         return unless (match = line.match(violation_regex))
 
         violation = {}
@@ -32,7 +32,7 @@ module LintTrap
           end
         end
 
-        standardize(violation)
+        standardize(violation, container)
       end
 
       def violation_fields
@@ -40,10 +40,10 @@ module LintTrap
       end
 
       def violation_regex
-        raise NotImplementedError, "Must implement violation_regex."
+        raise NotImplementedError, 'Must implement violation_regex.'
       end
 
-      def standardize(violation)
+      def standardize(violation, container)
         violation[:file] = container.local_path(violation[:file])
 
         violation

data/lib/lint_trap/parser.rb

@@ -0,0 +1,16 @@
+require_relative 'registerable'
+require_relative 'parser/csslint'
+require_relative 'parser/standard'
+require_relative 'parser/vim_quickfix'
+
+module LintTrap
+  # Parser registry
+  module Parser
+    extend Registerable
+
+    register CSSLint
+    register Standard
+    register VimQuickfix
+    default Standard
+  end
+end

data/lib/lint_trap/registerable.rb

@@ -0,0 +1,20 @@
+require 'forwardable'
+require_relative 'registry'
+
+module LintTrap
+  # Provide a registry DSL
+  module Registerable
+    extend Forwardable
+
+    def_delegator :registry, :register
+    def_delegator :registry, :default
+    def_delegator :registry, :find
+    def_delegator :registry, :all
+
+  protected
+
+    def registry
+      @registry ||= Registry.new
+    end
+  end
+end