pronto-phpstan 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ec6047701a9276539fe45eba7abf881312d573d
+  data.tar.gz: 5722944427639aad4383f55143e847319d6b0b16
+SHA512:
+  metadata.gz: 1b0b043c618da538a41450d5d489ce216402cd351583649081e8d8d9610b6c2a258246a0380954ae9bb9d93119f26af2e6d51ffed3ed8e114c6a3d371f2dd783
+  data.tar.gz: faa956aed9853e082aec450aea3914f2cf35029e728f715d7019a6b42da1cb842e9fbd53f857973a614d83f1c89aa39df4d48036351d895e1daedd4157c45958

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Thomas Rothe
+
+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,27 @@
+# Pronto runner for PHPStan
+
+[![Build Status](https://travis-ci.org/Powerhamster/pronto-phpstan.svg?branch=master)](https://travis-ci.org/Powerhamster/pronto-phpstan)
+
+Pronto runner for [PHPStan](https://github.com/phpstan/phpstan).
+[What is Pronto?](https://github.com/prontolabs/pronto)
+
+Configuration
+-------------
+
+Configuration is available via following environment variables
+
+| Name                        | Description                                                               | Default |
+|-----------------------------|---------------------------------------------------------------------------|---------|
+| `PRONTO_PHPSTAN_EXECUTABLE` | Path to a PHPStan executable                                              | phpstan |
+| `PRONTO_PHPSTAN_CONFIG`     | Additonal config file which should be ussd (-c)                           | none    |
+| `PRONTO_PHPSTAN_AUTOLOADER` | Autoloader file wich phpstan should use (-a)                              | none    |
+| `PRONTO_PHPSTAN_LEVEL`      | Level on which phpstan will run (-l)                                      | 7       |
+
+Credits
+-------
+inspired by [pronto-phpcs](https://github.com/EllisV/pronto-phpcs)
+
+Copyright
+---------
+
+Copyright (c) 2018 Thomas Rothe. See [LICENSE](LICENSE) for further details.

data/lib/pronto/phpstan.rb

@@ -0,0 +1,72 @@
+require 'pronto'
+require 'shellwords'
+require 'nokogiri'
+
+module Pronto
+  class PhpStan < Runner
+    def initialize(patches, commit = nil)
+      super
+
+      @executable = ENV['PRONTO_PHPSTAN_EXECUTABLE'] || 'phpstan'
+      @config = ENV['PRONTO_PHPSTAN_CONFIG'] || nil
+      @autoloader = ENV['PRONTO_PHPSTAN_AUTOLOADER'] || nil
+      @level = ENV['PRONTO_PHPSTAN_LEVEL'] || 7
+    end
+
+    def run
+      return [] unless @patches
+
+      @patches.select { |patch| valid_patch?(patch) }
+              .map { |patch| inspect(patch) }
+              .flatten.compact
+    end
+
+    def valid_patch?(patch)
+      patch.additions > 0 && php_file?(patch.new_file_full_path)
+    end
+
+    def inspect(patch)
+      path = patch.new_file_full_path.to_s
+      run_phpstan(path).map do |error_element|
+        line_no = Integer(error_element.attribute('line').value)
+        message = error_element.attribute('message').value
+        severity = error_element.attribute('severity').value
+        patch.added_lines.select { |line| line.new_lineno == line_no }
+             .map { |line| new_message(message, severity, line) }
+      end
+    end
+
+    def run_phpstan(path)
+      escaped_executable = Shellwords.escape(@executable)
+      escaped_level = Shellwords.escape(@level)
+      escaped_path = Shellwords.escape(path)
+
+      command = "#{escaped_executable} analyse --errorFormat=checkstyle -l #{escaped_level}"
+
+      unless @autoloader.nil?
+        escaped_autoloader = Shellwords.escape(@autoloader)
+        command = "#{command} -a #{escaped_autoloader}"
+      end
+
+      unless @config.nil?
+        escaped_config = Shellwords.escape(@config)
+        command = "#{command} -c #{escaped_config}"
+      end
+
+      command = "#{command} #{escaped_path}"
+      doc = Nokogiri::XML(`#{command}`)
+      doc.xpath('//file/error')
+    end
+
+    def new_message(message, severity, line)
+      path = line.patch.delta.new_file[:path]
+      level = severity == 'error' ? :error : :warning
+
+      Message.new(path, line, level, message, nil, self.class)
+    end
+
+    def php_file?(path)
+      File.extname(path) == '.php'
+    end
+  end
+end

data/lib/pronto/phpstan/version.rb

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

data/pronto-phpstan.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pronto/phpstan/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'pronto-phpstan'
+  spec.version = Pronto::PhpStanVersion::VERSION
+  spec.authors = ['Thomas Rothe']
+  spec.email = ['th.rothe@gmail.com']
+
+  spec.summary = 'Pronto runner for PHPStan'
+  spec.homepage = 'https://github.com/Powerhamster/pronto-phpstan'
+  spec.license = 'MIT'
+
+  spec.files = Dir.glob('lib/**/*.rb') + ['pronto-phpstan.gemspec', 'LICENSE', 'README.md']
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'pronto', '>= 0.8.0'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.8.0'
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: pronto-phpstan
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas Rothe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pronto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: 
+email:
+- th.rothe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/pronto/phpstan.rb
+- lib/pronto/phpstan/version.rb
+- pronto-phpstan.gemspec
+homepage: https://github.com/Powerhamster/pronto-phpstan
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Pronto runner for PHPStan
+test_files: []