pronto-luacheck 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f557b842b04ee546cda9616268baa85ae162477d
+  data.tar.gz: f59e7e134448ed7f1aaa8b7ba8844044feabcfaa
+SHA512:
+  metadata.gz: 9f87c41dc6e54b1ea2588fd9ef8b9d293811c586d83f627ace51d6fc881724bd5e61556ef7ff500c88b2843b63996ba8a8ddad27e34d28b853198862c0baaeb4
+  data.tar.gz: 6707bc5e670317684f06029947fb538bbf9cb13a1122f8d54e3033f24f374daca2e031d033f23f246dd49e3a0a52b1eb093c489053818c59a739c7636572ccf9

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.ruby-version
+.*~
+*~
+
+*.gem
+examples/
+.pryrc
+vendor/

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.8
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Seiichi KONDO
+
+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,51 @@
+# Pronto::Luacheck
+
+[![Gem Version](https://badge.fury.io/rb/pronto-luacheck.svg)](http://badge.fury.io/rb/pronto-luacheck)
+[![Build Status](https://travis-ci.org/seikichi/pronto-luacheck.svg?branch=master)](https://travis-ci.org/seikichi/pronto-luacheck)
+[![Coverage Status](https://coveralls.io/repos/seikichi/pronto-luacheck/badge.svg?branch=master&service=github)](https://coveralls.io/github/seikichi/pronto-luacheck?branch=master)
+
+[Pronto](https://github.com/mmozuras/pronto) runner for [Luacheck](https://github.com/mpeterv/luacheck).
+
+`luacheck` is needed to be installed for this runner to work.
+
+## Configuration
+
+Configuring Luacheck via `.luacheckrc` will work just fine with `pronto-luacheck`.
+
+You can explicitly specify location of Luacheck runner by passing `PRONTO_LUACHECK_PATH` env variable e.g:
+
+```bash
+PRONTO_LUACHECK_PATH=/usr/very/hidden/bin/luacheck pronto run --index
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pronto-luacheck'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pronto-luacheck
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies. Then, run `rake test` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`,
+which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/seikichi/pronto-luacheck.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# coding: UTF-8
+
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+
+task default: [:test]
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.ruby_opts = ['-r./test/helper']
+  t.test_files = Dir['test/**/test_*.rb']
+  t.verbose = true
+end
+
+RuboCop::RakeTask.new

data/lib/pronto/luacheck.rb

@@ -0,0 +1,2 @@
+require_relative 'luacheck/version'
+require_relative 'luacheck_runner'

data/lib/pronto/luacheck/version.rb

@@ -0,0 +1,5 @@
+module Pronto
+  module Luacheck
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/pronto/luacheck/wrapper.rb

@@ -0,0 +1,63 @@
+require 'open3'
+require 'rexml/document'
+
+module Pronto
+  module Luacheck
+    class Wrapper
+      def initialize
+        @luacheck_path = ENV['PRONTO_LUACHECK_PATH'] || 'luacheck'
+      end
+
+      def run(filepath)
+        stdout, stderr, = run_luacheck(filepath)
+        puts "WARN: pronto-luacheck: #{stderr}" if stderr && !stderr.empty?
+        return [] if stdout.nil? || stdout == 0
+        parse_output(stdout)
+      end
+
+      private
+
+      def parse_output(output)
+        doc = REXML::Document.new(output)
+
+        result = []
+        REXML::XPath.match(doc, '//testcase').each do |testcase|
+          file = testcase.attributes['classname']
+          next if testcase.elements.size != 1
+
+          failure = testcase.elements.first
+          md = failure.attributes['message'].
+               match(/\A#{Regexp.escape(file)}:(?<line>\d+):(?<column>\d+):\s+(?<message>.*)\z/)
+          next unless md
+
+          result << {
+            file: file,
+            line: md[:line].to_i,
+            column: md[:column].to_i,
+            level: level(failure),
+            message: md[:message],
+            rule: rule(failure)
+          }
+        end
+
+        result
+      end
+
+      def run_luacheck(path)
+        Open3.capture3("#{@luacheck_path.shellescape} --formatter=JUnit #{path.shellescape}")
+      end
+
+      def rule(failure)
+        type = failure.attributes['type']
+        type[1..-1]
+      end
+
+      def level(failure)
+        type = failure.attributes['type']
+        return :warning if type.start_with?('W')
+        return :error if type.start_with?('E')
+        :info
+      end
+    end
+  end
+end

data/lib/pronto/luacheck_runner.rb

@@ -0,0 +1,48 @@
+require 'pronto'
+
+require_relative 'luacheck/wrapper'
+
+module Pronto
+  class LuacheckRunner < Runner
+    def initialize(_, __ = nil)
+      super
+
+      @inspector = ::Pronto::Luacheck::Wrapper.new
+    end
+
+    def run
+      return [] unless @patches
+
+      @patches.select { |patch| valid_patch?(patch) }
+              .map { |patch| inspect(patch) }
+              .flatten
+              .compact
+    end
+
+    private
+
+    def valid_patch?(patch)
+      return false if patch.additions < 1
+
+      lua_file?(patch)
+    end
+
+    def lua_file?(patch)
+      patch.new_file_full_path.to_s.end_with?('.lua')
+    end
+
+    def inspect(patch)
+      offences = @inspector.run(patch.new_file_full_path.to_s)
+      offences.map do |offence|
+        patch.added_lines
+             .select { |line| line.new_lineno == offence[:line] }
+             .map { |line| new_message(offence, line) }
+      end
+    end
+
+    def new_message(offence, line)
+      path = line.patch.delta.new_file[:path]
+      Message.new(path, line, offence[:level], offence[:message], nil, self.class)
+    end
+  end
+end

data/pronto-luacheck.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pronto/luacheck/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pronto-luacheck'
+  spec.version       = Pronto::Luacheck::VERSION
+  spec.authors       = ['Seiichi KONDO']
+  spec.email         = ['seikichi@kmc.gr.jp']
+
+  spec.summary       = 'Pronto runner for Luacheck'
+  spec.description   = <<-EOF
+    A pronto runner for Luacheck - Lua code analyzer.
+    Pronto runs analysis quickly by checking only the relevant changes.
+    Created to be used on pull requests, but suited for other scenarios as well.
+  EOF
+  spec.homepage      = 'https://github.com/seikichi/pronto-luacheck'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency('pronto', '~> 0.6.0')
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.40'
+  spec.add_development_dependency 'simplecov', '~> 0.10.0'
+  spec.add_development_dependency 'test-unit', '~> 3.0'
+  spec.add_development_dependency 'test-unit-rr', '~> 1.0'
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: pronto-luacheck
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Seiichi KONDO
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pronto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit-rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: |2
+      A pronto runner for Luacheck - Lua code analyzer.
+      Pronto runs analysis quickly by checking only the relevant changes.
+      Created to be used on pull requests, but suited for other scenarios as well.
+email:
+- seikichi@kmc.gr.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pronto/luacheck.rb
+- lib/pronto/luacheck/version.rb
+- lib/pronto/luacheck/wrapper.rb
+- lib/pronto/luacheck_runner.rb
+- pronto-luacheck.gemspec
+homepage: https://github.com/seikichi/pronto-luacheck
+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.2.5
+signing_key: 
+specification_version: 4
+summary: Pronto runner for Luacheck
+test_files: []