pronto-phpcs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ccc7f5dd3fef25c2040de57c18885ab5e85f1af3
+  data.tar.gz: 9e0af923c84c0ec2651f42953f2ba8b1391aadcf
+SHA512:
+  metadata.gz: c203577bff1b8f83320950f526d49567a13977e8cd1fd046515747a4b523639db890574ca8b836e6cf582603c9a1d9828473f18941d9a14db6b53abe490630a4
+  data.tar.gz: b89f9dc6d20187ce555ff8b98d04336afe6fac4d1f00a2c2e22317603b0dd15a0f0f4c947e1e1318e349a2e731eb2d86ec55fde8309c5d89b295e700188819f0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Eligijus Vitkauskas
+
+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,21 @@
+# Pronto runner for PHP CodeSniffer
+
+[![Build Status](https://travis-ci.org/EllisV/pronto-phpcs.svg?branch=master)](https://travis-ci.org/EllisV/pronto-phpcs)
+
+Pronto runner for [PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer).
+[What is Pronto?](https://github.com/mmozuras/pronto)
+
+Configuration
+-------------
+
+Configuration is available via following environment variables
+
+| Name                      | Description                                                               | Default |
+|---------------------------|---------------------------------------------------------------------------|---------|
+| `PRONTO_PHPCS_EXECUTABLE` | Path to a PHP CodeSniffer executable                                      | phpcs   |
+| `PRONTO_PHPCS_STANDARD`   | Which standard to run. Name of a built in standard or a path to standard. | PSR2    |
+
+Copyright
+---------
+
+Copyright (c) 2016 Eligijus Vitkauskas. See [LICENSE](LICENSE) for further details.

data/lib/pronto/phpcs/version.rb

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

data/lib/pronto/phpcs.rb

@@ -0,0 +1,60 @@
+require 'pronto'
+require 'shellwords'
+require 'json'
+
+module Pronto
+  class Phpcs < Runner
+    def initialize(patches, commit = nil)
+      super
+
+      @executable = ENV['PRONTO_PHPCS_EXECUTABLE'] || 'phpcs'
+      @standard = ENV['PRONTO_PHPCS_STANDARD'] || 'PSR2'
+    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_phpcs(path).map do |offence|
+        patch.added_lines.select { |line| line.new_lineno == offence['line'] }
+          .map { |line| new_message(offence, line) }
+      end
+    end
+
+    def run_phpcs(path)
+      escaped_executable = Shellwords.escape(@executable)
+      escaped_standard = Shellwords.escape(@standard)
+      escaped_path = Shellwords.escape(path)
+
+      begin
+        JSON.parse(`#{escaped_executable} --report=json --standard=#{escaped_standard} #{escaped_path}`)
+          .fetch('files', {})
+          .fetch(path, {})
+          .fetch('messages', [])
+      rescue JSON::ParserError
+        []
+      end
+    end
+
+    def new_message(offence, line)
+      path = line.patch.delta.new_file[:path]
+      level = if offence['type'] == 'ERROR' then :error else :warning end
+
+      Message.new(path, line, level, offence['message'], nil, self.class)
+    end
+
+    def php_file?(path)
+      File.extname(path) == '.php'
+    end
+  end
+end

data/pronto-phpcs.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pronto/phpcs/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'pronto-phpcs'
+  spec.version = Pronto::PhpcsVersion::VERSION
+  spec.authors = ['Eligijus Vitkauskas']
+  spec.email = ['eligijusvitkauskas@gmail.com']
+
+  spec.summary = 'Pronto runner for PHP CodeSniffer'
+  spec.homepage = 'https://github.com/EllisV/pronto-phpcs'
+  spec.license = 'MIT'
+
+  spec.files = Dir.glob('lib/**/*.rb') + ['pronto-phpcs.gemspec', 'LICENSE', 'README.md']
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency('pronto', '~> 0.7.0')
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: pronto-phpcs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eligijus Vitkauskas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pronto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.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: '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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- eligijusvitkauskas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/pronto/phpcs.rb
+- lib/pronto/phpcs/version.rb
+- pronto-phpcs.gemspec
+homepage: https://github.com/EllisV/pronto-phpcs
+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 PHP CodeSniffer
+test_files: []