lint_trap 0.0.2 → 0.0.3

data/lib/lint_trap/command.rb

@@ -0,0 +1,39 @@
+require_relative 'container/fake'
+require 'open3'
+
+module LintTrap
+  # Wraps the execution of linter commands
+  class Command
+    attr_reader :binary
+
+    def initialize(binary, flags, files)
+      @binary = binary
+      @flags = flags
+      @files = files
+    end
+
+    def run(container)
+      Bundler.with_clean_env do
+        puts command(container) if ENV['DEBUG_LINTING']
+        Open3.popen3(command(container)) do |_, stdout, _, thread|
+          yield stdout
+
+          thread.join
+        end
+      end
+    end
+
+    def command(container = LintTrap::Container::Fake.new)
+      container.wrap("#{binary} #{flags} #{files(container)} 2>&1")
+    end
+    alias_method :to_s, :command
+
+    def files(container = LintTrap::Container::Fake.new)
+      Shellwords.join(@files.map{|file| container.container_path(file)})
+    end
+
+    def flags
+      @flags.join(' ')
+    end
+  end
+end

data/lib/lint_trap/container/base.rb

@@ -0,0 +1,30 @@
+require 'pathname'
+
+module LintTrap
+  module Container
+    class Base
+      LOCAL_CONFIG_PATH = Pathname.new(File.expand_path('../../../../config', __FILE__))
+
+      def initialize(image, repo_path)
+        @image = image
+        @repo_path = Pathname.new(repo_path)
+      end
+
+      def wrap(_command)
+        raise NotImplementedError
+      end
+
+      def config_path(_path)
+        raise NotImplementedError
+      end
+
+      def file_path(_path)
+        raise NotImplementedError
+      end
+
+    protected
+
+      attr_reader :image, :repo_path
+    end
+  end
+end

data/lib/lint_trap/container/docker.rb

@@ -0,0 +1,46 @@
+require_relative 'base'
+require 'pathname'
+
+module LintTrap
+  module Container
+    # Acts like a container, without actually requiring a container.
+    class Docker < Base
+      CONFIG_PATH = Pathname.new('/opt/lint_trap/config')
+      CODE_PATH = Pathname.new('/home/spin_cycle')
+
+      def wrap(command)
+        "docker run #{flags} #{image} #{command}"
+      end
+
+      def config_path(path)
+        CONFIG_PATH.join(path).to_s
+      end
+
+      def local_path(path)
+        relative_path = Pathname.new(path).relative_path_from(CODE_PATH)
+
+        repo_path.join(relative_path).to_s
+      end
+
+      def container_path(path)
+        relative_path = Pathname.new(path).relative_path_from(repo_path)
+
+        CODE_PATH.join(relative_path).to_s
+      end
+
+    private
+
+      def flags
+        [
+          # '-m', '50m', # memory
+          # '-c', '1', # number of cpus
+          '--privileged=false',
+          '-v', "#{LOCAL_CONFIG_PATH}:#{CONFIG_PATH}",
+          '-v', "#{repo_path}:#{CODE_PATH}",
+          "--workdir=#{CODE_PATH}",
+          '--user=spin_cycle'
+        ].join(' ')
+      end
+    end
+  end
+end

data/lib/lint_trap/container/fake.rb

@@ -0,0 +1,28 @@
+require_relative 'base'
+
+module LintTrap
+  module Container
+    # Acts like a container, without actually requiring a container.
+    class Fake < Base
+      def initialize
+        super('no/image', 'local')
+      end
+
+      def wrap(command)
+        command
+      end
+
+      def config_path(path)
+        LOCAL_CONFIG_PATH.join(path).to_s
+      end
+
+      def container_path(path)
+        path
+      end
+
+      def local_path(path)
+        path
+      end
+    end
+  end
+end

data/lib/lint_trap/language/base.rb

@@ -0,0 +1,18 @@
+module LintTrap
+  module Language
+    # Interface for languages
+    class Base
+      def self.canonical_name
+        name.split('::').last
+      end
+
+      def name
+        self.class.canonical_name
+      end
+
+      def linters
+        raise NotImplementedError, 'Must define what linters this language supports.'
+      end
+    end
+  end
+end

data/lib/lint_trap/language/coffeescript.rb

@@ -0,0 +1,13 @@
+require_relative 'base'
+require_relative '../linter/coffeelint'
+
+module LintTrap
+  module Language
+    # CoffeeScript
+    class CoffeeScript < Base
+      def linters
+        [Linter::CoffeeLint]
+      end
+    end
+  end
+end

data/lib/lint_trap/language/cpp.rb

@@ -0,0 +1,17 @@
+require_relative 'base'
+require_relative '../linter/cppcheck'
+
+module LintTrap
+  module Language
+    # C++
+    class CPP < Base
+      def self.canonical_name
+        'C++'
+      end
+
+      def linters
+        [Linter::CPPCheck]
+      end
+    end
+  end
+end

data/lib/lint_trap/language/css.rb

@@ -0,0 +1,13 @@
+require_relative 'base'
+require_relative '../linter/csslint'
+
+module LintTrap
+  module Language
+    # CSS
+    class CSS < Base
+      def linters
+        [Linter::CSSLint]
+      end
+    end
+  end
+end

data/lib/lint_trap/language/go.rb

@@ -0,0 +1,13 @@
+require_relative 'base'
+require_relative '../linter/golint'
+
+module LintTrap
+  module Language
+    # Go
+    class Go < Base
+      def linters
+        [Linter::GoLint]
+      end
+    end
+  end
+end

data/lib/lint_trap/language/java.rb

@@ -0,0 +1,13 @@
+require_relative 'base'
+require_relative '../linter/checkstyle'
+
+module LintTrap
+  module Language
+    # Java
+    class Java < Base
+      def linters
+        [Linter::CheckStyle]
+      end
+    end
+  end
+end

data/lib/lint_trap/language/javascript.rb

@@ -0,0 +1,13 @@
+require_relative 'base'
+require_relative '../linter/jshint'
+
+module LintTrap
+  module Language
+    # JavaScript
+    class JavaScript < Base
+      def linters
+        [Linter::JSHint]
+      end
+    end
+  end
+end

data/lib/lint_trap/language/json.rb

@@ -0,0 +1,13 @@
+require_relative 'base'
+require_relative '../linter/jsonlint'
+
+module LintTrap
+  module Language
+    # JSON
+    class JSON < Base
+      def linters
+        [Linter::JSONLint]
+      end
+    end
+  end
+end

data/lib/lint_trap/language/python.rb

@@ -0,0 +1,13 @@
+require_relative 'base'
+require_relative '../linter/pylint'
+
+module LintTrap
+  module Language
+    # Python
+    class Python < Base
+      def linters
+        [Linter::PyLint]
+      end
+    end
+  end
+end

data/lib/lint_trap/language/ruby.rb

@@ -0,0 +1,13 @@
+require_relative 'base'
+require_relative '../linter/rubocop'
+
+module LintTrap
+  module Language
+    # Ruby
+    class Ruby < Base
+      def linters
+        [Linter::RuboCop]
+      end
+    end
+  end
+end

data/lib/lint_trap/language/scss.rb

@@ -0,0 +1,13 @@
+require_relative 'base'
+require_relative '../linter/scsslint'
+
+module LintTrap
+  module Language
+    # SCSS
+    class SCSS < Base
+      def linters
+        [Linter::SCSSLint]
+      end
+    end
+  end
+end

data/lib/lint_trap/language.rb

@@ -0,0 +1,50 @@
+require 'linguist'
+
+require_relative 'language/coffeescript'
+require_relative 'language/cpp'
+require_relative 'language/css'
+require_relative 'language/go'
+require_relative 'language/java'
+require_relative 'language/javascript'
+require_relative 'language/json'
+require_relative 'language/python'
+require_relative 'language/ruby'
+require_relative 'language/scss'
+
+module LintTrap
+  # Language lookup
+  module Language
+    @languages = {}
+
+    class << self
+      def register(language)
+        languages[language.canonical_name] = language
+      end
+
+      def detect(file)
+        language = Linguist::FileBlob.new(file).language
+
+        find(language.name)
+      end
+
+      def find(name)
+        languages[name]
+      end
+
+    protected
+
+      attr_reader :languages
+    end
+
+    register CoffeeScript
+    register CPP
+    register CSS
+    register Go
+    register Java
+    register JavaScript
+    register JSON
+    register Python
+    register Ruby
+    register SCSS
+  end
+end

data/lib/lint_trap/linter/base.rb

@@ -0,0 +1,58 @@
+require_relative '../parser/standard'
+require_relative '../command'
+
+module LintTrap
+  module Linter
+    # The base class for all linters. Provides a template for linter execution.
+    class Base
+      CONFIG_PATH = File.expand_path('../../../../config', __FILE__)
+
+      def self.canonical_name
+        name.split('::').last
+      end
+
+      def initialize(container:, **options)
+        @container = container
+        @options = options
+      end
+
+      def lint(files)
+        command(files).run(container) do |stdout|
+          parser(stdout).parse do |violation|
+            yield violation
+          end
+        end
+      end
+
+      def name
+        self.class.canonical_name
+      end
+
+    protected
+
+      attr_reader :container, :options
+
+    private
+
+      def command(files)
+        Command.new(command_name, flags, files)
+      end
+
+      def parser(stdout)
+        LintTrap::Parser::Standard.new(stdout, container)
+      end
+
+      def config_path(path)
+        container.config_path(path)
+      end
+
+      def flags
+        raise NotImplementedError, 'Method flags must be implemented.'
+      end
+
+      def command_name
+        name.downcase
+      end
+    end
+  end
+end

data/lib/lint_trap/linter/checkstyle.rb

@@ -0,0 +1,24 @@
+require_relative 'base'
+
+module LintTrap
+  module Linter
+    # Encapsulates logic specific to checkstyle command line tool.
+    class CheckStyle < Base
+      JAR = 'checkstyle/checkstyle_logger-all.jar'
+      CHECKS_XML = 'checkstyle/sun_checks.xml'
+
+    private
+
+      def command_name
+        'java'
+      end
+
+      def flags
+        [
+          '-jar', config_path(JAR),
+          '-c', options[:config] || config_path(CHECKS_XML)
+        ]
+      end
+    end
+  end
+end

data/lib/lint_trap/linter/coffeelint.rb

@@ -0,0 +1,21 @@
+require_relative 'base'
+
+module LintTrap
+  module Linter
+    # Encapsulates logic specific to coffeelint command line tool.
+    class CoffeeLint < Base
+      REPORTER = 'coffeelint/lint_trap.coffee'
+
+    private
+
+      def flags
+        [
+          "--reporter=#{config_path(REPORTER)}",
+          '--nocolor'
+        ].tap do |flags|
+          flags.concat(["--file=#{options[:config]}"]) if options[:config]
+        end
+      end
+    end
+  end
+end

data/lib/lint_trap/linter/cppcheck.rb

@@ -0,0 +1,18 @@
+require_relative 'base'
+
+module LintTrap
+  module Linter
+    # Encapsulates logic specific to cppcheck command line tool.
+    class CPPCheck < Base
+    private
+
+      def flags
+        [
+          '--enable=all',
+          '--error-exitcode=1',
+          '--template="{file}:{line}:::{id}:{severity}:{message}"'
+        ]
+      end
+    end
+  end
+end

data/lib/lint_trap/linter/csslint.rb

@@ -0,0 +1,23 @@
+require_relative 'base'
+require_relative '../parser/csslint'
+
+module LintTrap
+  module Linter
+    # Encapsulates logic specific to csslint command line tool.
+    class CSSLint < Base
+    private
+
+      def flags
+        [
+          '--format=compact'
+        ].tap do |flags|
+          flags.concat(["--config=#{options[:config]}"]) if options[:config]
+        end
+      end
+
+      def parser(stdout)
+        LintTrap::Parser::CSSLint.new(stdout, container)
+      end
+    end
+  end
+end

data/lib/lint_trap/linter/golint.rb

@@ -0,0 +1,19 @@
+require_relative 'base'
+require_relative '../parser/vim_quickfix'
+
+module LintTrap
+  module Linter
+    # Encapsulates logic specific to golint command line tool.
+    class GoLint < Base
+    private
+
+      def flags
+        []
+      end
+
+      def parser(stdout)
+        LintTrap::Parser::VimQuickfix.new(stdout, container)
+      end
+    end
+  end
+end

data/lib/lint_trap/linter/jshint.rb

@@ -0,0 +1,20 @@
+require_relative 'base'
+
+module LintTrap
+  module Linter
+    # Encapsulates logic specific to jshint command line tool.
+    class JSHint < Base
+      FORMATTER = 'jshint/formatter.js'
+
+    private
+
+      def flags
+        [
+          '--reporter', config_path(FORMATTER)
+        ].tap do |flags|
+          flags.concat(['--config', options[:config]]) if options[:config]
+        end
+      end
+    end
+  end
+end

data/lib/lint_trap/linter/jsonlint.rb

@@ -0,0 +1,18 @@
+require_relative 'base'
+
+module LintTrap
+  module Linter
+    # Encapsulates logic specific to durable-json-lint command line tool.
+    class JSONLint < Base
+    private
+
+      def command_name
+        'durable-json-lint'
+      end
+
+      def flags
+        ['--format', '{{file}}:{{line}}:{{column}}:::error:{{{description}}}']
+      end
+    end
+  end
+end

data/lib/lint_trap/linter/pylint.rb

@@ -0,0 +1,19 @@
+require_relative 'base'
+
+module LintTrap
+  module Linter
+    # Encapsulates logic specific to pylint command line tool.
+    class PyLint < Base
+    private
+
+      def flags
+        [
+          '-r', 'no',
+          '--msg-template', '"{abspath}:{line}:{column}::{symbol}:{category}:{msg}"'
+        ].tap do |flags|
+          flags.concat(['--rcfile', options[:config]]) if options[:config]
+        end
+      end
+    end
+  end
+end

data/lib/lint_trap/linter/rubocop.rb

@@ -0,0 +1,22 @@
+require_relative 'base'
+
+module LintTrap
+  module Linter
+    # Encapsulates logic specific to rubocop command line tool.
+    class RuboCop < Base
+      FORMATTER = 'rubocop/formatter.rb'
+
+    private
+
+      def flags
+        [
+          '--require', config_path(FORMATTER),
+          '--format', 'LintTrap::Rubocop::Formatter',
+          '--no-color'
+        ].tap do |flags|
+          flags.concat(['--config', options[:config]]) if options[:config]
+        end
+      end
+    end
+  end
+end

data/lib/lint_trap/linter/scsslint.rb

@@ -0,0 +1,22 @@
+require_relative 'base'
+
+module LintTrap
+  module Linter
+    # Encapsulates logic specific to scsslint command line tool.
+    class SCSSLint < Base
+      COMMAND = 'scsslint/scsslint'
+
+      def command_name
+        config_path(COMMAND)
+      end
+
+      def flags
+        [
+          '--format=LintTrap'
+        ].tap do |flags|
+          flags.concat(['--config', options[:config]]) if options[:config]
+        end
+      end
+    end
+  end
+end

data/lib/lint_trap/linter.rb

@@ -0,0 +1,42 @@
+require_relative 'linter/checkstyle'
+require_relative 'linter/coffeelint'
+require_relative 'linter/cppcheck'
+require_relative 'linter/csslint'
+require_relative 'linter/golint'
+require_relative 'linter/jshint'
+require_relative 'linter/jsonlint'
+require_relative 'linter/pylint'
+require_relative 'linter/rubocop'
+require_relative 'linter/scsslint'
+
+module LintTrap
+  # Linter lookup
+  module Linter
+    @linters = {}
+
+    class << self
+      def register(linter)
+        linters[linter.canonical_name] = linter
+      end
+
+      def find(name)
+        linters[name]
+      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
+  end
+end