lint_trap 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5da96ecc29117fe9f261fbc71fb1930d7cc45869
+  data.tar.gz: 854345788d30ce5c60677a78dc8359990203d4a3
+SHA512:
+  metadata.gz: 1f9c5c8f19a2cb08fb97ef0df44c26ffc32c72a5cb792e1d8f5db7bb729a1620f7bbbb85173c0703bc7185ec376872d9cdf599d52644ce75b51f120b059c78e1
+  data.tar.gz: 504e8acee1251edd2d957ea5066186f3885d9ce605cd256c3b0ffd186c9a3f2d17b2188f899fb584a2945e2b2ff444406851c92c5cde4ab884c30303857f362a

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lint_trap.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Allen Madsen
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# LintTrap
+
+Parses the output of various linters. Designed for usage with [permpress](https://github.com/lintci/permpress) on [LintCI](http://www.lintci.com).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lint_trap'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lint_trap
+
+## Usage
+
+``` ruby
+require 'lint_trap'
+require 'stringio'
+
+# This would typically be a stdout for another process
+io = StringIO.new("bad.rb:2:7:4:Style/MethodName:convention:Use snake_case for methods.\n")
+
+LintTrap.parse('rubocop', io) do |violation|
+  puts violation.inspect
+end
+
+# Output
+# {:file=>"bad.rb", :line=>"2", :column=>"7", :length=>"4", :rule=>"Style/MethodName", :severity=>"convention", :message=>"Use snake_case for methods."}
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/lint_trap/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/lint_trap/parser_factory.rb

@@ -0,0 +1,32 @@
+require_relative 'parsers/null_parser'
+require_relative 'parsers/standard_parser'
+require_relative 'parsers/vim_quickfix_parser'
+require_relative 'parsers/csslint_parser'
+
+module LintTrap
+  # Determines the appropriate parser for the given linter
+  module ParserFactory
+    class << self
+      def register(linter, parser)
+        @parsers ||= Hash.new{|h, k| h[k] = Parsers::NullParser}
+        @parsers[linter] = parser
+      end
+
+      def parser_for(linter)
+        @parsers[linter]
+      end
+    end
+
+    register 'standard', Parsers::StandardParser
+    register 'vim_quickfix', Parsers::VimQuickfixParser
+
+    register 'checkstyle', Parsers::StandardParser
+    register 'coffeelint', Parsers::StandardParser
+    register 'csslint', Parsers::CSSLintParser
+    register 'golint', Parsers::VimQuickfixParser
+    register 'jshint', Parsers::StandardParser
+    register 'jsonlint', Parsers::StandardParser
+    register 'rubocop', Parsers::StandardParser
+    register 'scsslint', Parsers::StandardParser
+  end
+end

data/lib/lint_trap/parsers/base_parser.rb

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

data/lib/lint_trap/parsers/csslint_parser.rb

@@ -0,0 +1,21 @@
+require_relative 'line_parser'
+
+module LintTrap
+  module Parsers
+    # Handles parsing LintCI standard format
+    class CSSLintParser < LineParser
+
+    private
+
+      def violation_regex
+        /
+          (?<file>[^:]+):
+          \sline\s(?<line>\d+),
+          \scol\s(?<column>\d+),
+          \s(?<severity>\w+)\s-\s
+          (?<message>.+)
+        /x
+      end
+    end
+  end
+end

data/lib/lint_trap/parsers/line_parser.rb

@@ -0,0 +1,38 @@
+require_relative 'base_parser'
+
+module LintTrap
+  module Parsers
+    # Handles parsing line by line with regex
+    class LineParser < BaseParser
+      def parse
+        @io.each_line do |line|
+          next unless (violation = parse_line(line))
+
+          yield violation
+        end
+      end
+
+    private
+
+      def parse_line(line)
+        return unless (match = line.match(violation_regex))
+
+        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
+      end
+
+      def violation_fields
+        %w(file line column length rule severity message)
+      end
+
+      def violation_regex
+        raise NotImplementedError, "Subclass #{self.class.name} must implement violation_regex."
+      end
+    end
+  end
+end

data/lib/lint_trap/parsers/null_parser.rb

@@ -0,0 +1,11 @@
+require_relative 'base_parser'
+
+module LintTrap
+  module Parsers
+    # Handles parsing for unknown linters
+    class NullParser < BaseParser
+      def parse
+      end
+    end
+  end
+end

data/lib/lint_trap/parsers/standard_parser.rb

@@ -0,0 +1,23 @@
+require_relative 'line_parser'
+
+module LintTrap
+  module Parsers
+    # Handles parsing LintCI standard format
+    class StandardParser < LineParser
+
+    private
+
+      def violation_regex
+        /
+          (?<file>[^:]+):
+          (?<line>[^:]*):
+          (?<column>[^:]*):
+          (?<length>[^:]*):
+          (?<rule>[^:]*):
+          (?<severity>[^:]*):
+          (?<message>.+)
+        /x
+      end
+    end
+  end
+end

data/lib/lint_trap/parsers/vim_quickfix_parser.rb

@@ -0,0 +1,20 @@
+require_relative 'line_parser'
+
+module LintTrap
+  module Parsers
+    # Handles parsing LintCI standard format
+    class VimQuickfixParser < LineParser
+
+    private
+
+      def violation_regex
+        /
+          (?<file>[^:]+):
+          (?<line>[^:]*):
+          (?<column>[^:]*):\s*
+          (?<message>.+)
+        /x
+      end
+    end
+  end
+end

data/lib/lint_trap/version.rb

@@ -0,0 +1,3 @@
+module LintTrap
+  VERSION = "0.0.1"
+end

data/lib/lint_trap.rb

@@ -0,0 +1,14 @@
+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

data/lint_trap.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lint_trap/version'
+
+Gem::Specification.new do |spec|
+  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.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.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry-byebug"
+end

data/spec/lint_trap_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe LintTrap do
+  it 'has a version number' do
+    expect(LintTrap::VERSION).not_to be nil
+  end
+
+  describe '.parse' do
+    let(:io){StringIO.new("bad.rb:2:7:4:Style/MethodName:convention:Use snake_case for methods.\n")}
+
+    it 'yields the expected violations' do
+      expect{|b| LintTrap.parse('rubocop', io, &b)}.to yield_successive_args({
+        file: 'bad.rb',
+        line: '2',
+        column: '7',
+        length: '4',
+        rule: 'Style/MethodName',
+        severity: 'convention',
+        message: 'Use snake_case for methods.'
+      })
+    end
+  end
+end

data/spec/parser_factory_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe LintTrap::ParserFactory do
+  describe '.linter_for' do
+    it 'returns a NullParser when no valid linter is given' do
+      expect(described_class.parser_for('blah')).to eq(LintTrap::Parsers::NullParser)
+    end
+
+    it 'returns the StandardParser when a valid linter is given' do
+      expect(described_class.parser_for('rubocop')).to eq(LintTrap::Parsers::StandardParser)
+    end
+
+    it 'returns the VimQuickfixParser when the parser itself is specified' do
+      expect(described_class.parser_for('vim_quickfix')).to eq(LintTrap::Parsers::VimQuickfixParser)
+    end
+  end
+end

data/spec/parsers/csslint_parser_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe LintTrap::Parsers::CSSLintParser do
+  let(:parser_output) do
+    "bad.css: line 2, col 5, Error - Using width with border can sometimes"\
+    " make elements larger than you expect.\n\n"
+  end
+  let(:io){StringIO.new(parser_output)}
+  subject(:parser){described_class}
+
+  describe '.parse' do
+    it 'parses violations from io' do
+      expect{|b| parser.parse(io, &b)}.to yield_successive_args(
+        {
+          file: 'bad.css',
+          line: '2',
+          column: '5',
+          length: nil,
+          rule: nil,
+          severity: 'Error',
+          message: 'Using width with border can sometimes make elements larger than you expect.'
+        }
+      )
+    end
+  end
+end

data/spec/parsers/standard_parser_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe LintTrap::Parsers::StandardParser do
+  let(:parser_output) do
+    "bad.java:1:0::com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck:error:"\
+    "Missing a Javadoc comment.\n"\
+    "bad.coffee:1:::camel_case_classes:error:Class names should be camel cased\n"\
+    "bad.js:2:13::W030:warning:Expected an assignment or function call and instead saw an expression.\n"\
+    "bad.json:2:2:::error:Json strings must use double quotes\n"\
+    "bad.rb:2:7:4:Style/MethodName:convention:Use snake_case for methods.\n"\
+    "bad.scss:2:3:12:BorderZero:warning:`border: 0;` is preferred over `border: none;`\n"
+  end
+  let(:io){StringIO.new(parser_output)}
+  subject(:parser){described_class}
+
+  describe '.parse' do
+    it 'parses violations from io' do
+      expect{|b| parser.parse(io, &b)}.to yield_successive_args(
+        {
+          file: 'bad.java',
+          line: '1',
+          column: '0',
+          length: nil,
+          rule: 'com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck',
+          severity: 'error',
+          message: 'Missing a Javadoc comment.'
+        },
+        {
+          file: 'bad.coffee',
+          line: '1',
+          column: nil,
+          length: nil,
+          rule: 'camel_case_classes',
+          severity: 'error',
+          message: 'Class names should be camel cased'
+        },
+        {
+          file: 'bad.js',
+          line: '2',
+          column: '13',
+          length: nil,
+          rule: 'W030',
+          severity: 'warning',
+          message: 'Expected an assignment or function call and instead saw an expression.'
+        },
+        {
+          file: 'bad.json',
+          line: '2',
+          column: '2',
+          length: nil,
+          rule: nil,
+          severity: 'error',
+          message: 'Json strings must use double quotes'
+        },
+        {
+          file: 'bad.rb',
+          line: '2',
+          column: '7',
+          length: '4',
+          rule: 'Style/MethodName',
+          severity: 'convention',
+          message: 'Use snake_case for methods.'
+        },
+        {
+          file: 'bad.scss',
+          line: '2',
+          column: '3',
+          length: '12',
+          rule: 'BorderZero',
+          severity: 'warning',
+          message: '`border: 0;` is preferred over `border: none;`'
+        }
+      )
+    end
+  end
+end

data/spec/parsers/vim_quickfix_parser_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe LintTrap::Parsers::VimQuickfixParser do
+  let(:parser_output) do
+    "bad.go:5:1: exported function Main should have comment or be unexported\n"
+  end
+  let(:io){StringIO.new(parser_output)}
+  subject(:parser){described_class}
+
+  describe '.parse' do
+    it 'parses violations from io' do
+      expect{|b| parser.parse(io, &b)}.to yield_successive_args(
+        {
+          file: 'bad.go',
+          line: '5',
+          column: '1',
+          length: nil,
+          rule: nil,
+          severity: nil,
+          message: 'exported function Main should have comment or be unexported'
+        }
+      )
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'lint_trap'

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: lint_trap
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Allen Madsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Parses the output of various linters.
+email:
+- blatyo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/lint_trap.rb
+- lib/lint_trap/parser_factory.rb
+- lib/lint_trap/parsers/base_parser.rb
+- lib/lint_trap/parsers/csslint_parser.rb
+- lib/lint_trap/parsers/line_parser.rb
+- lib/lint_trap/parsers/null_parser.rb
+- lib/lint_trap/parsers/standard_parser.rb
+- lib/lint_trap/parsers/vim_quickfix_parser.rb
+- lib/lint_trap/version.rb
+- lint_trap.gemspec
+- spec/lint_trap_spec.rb
+- spec/parser_factory_spec.rb
+- spec/parsers/csslint_parser_spec.rb
+- spec/parsers/standard_parser_spec.rb
+- spec/parsers/vim_quickfix_parser_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/lintci/lint_trap
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: Parses the output of various linters.
+test_files:
+- spec/lint_trap_spec.rb
+- spec/parser_factory_spec.rb
+- spec/parsers/csslint_parser_spec.rb
+- spec/parsers/standard_parser_spec.rb
+- spec/parsers/vim_quickfix_parser_spec.rb
+- spec/spec_helper.rb