pronto-phpmd 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f8d8b8d417e7ec492d1d246ea116ffa5a8c00f9
+  data.tar.gz: 1e18d6f8e71c54a38f5162ff47c32842404ca25a
+SHA512:
+  metadata.gz: 28574b4761d9c2232c306c47aa2823ff3cfa57a6cdd8b6fe31b69177137f216ff173b12fd90da71c734eea1a7e3c94056f0673b65b8afa85b217a13dd2b467fa
+  data.tar.gz: f01e39888941379f5f351cbb09324ed04401d1479220cfa731eb6a81797f4c0e9678e1307d24b94608f7fe0a7347074fdf6ec9bb523d642a479de00ae7f3249a

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,22 @@
+# Pronto runner for PHPMD
+
+[![Build Status](https://travis-ci.org/EllisV/pronto-phpmd.svg?branch=master)](https://travis-ci.org/EllisV/pronto-phpmd)
+
+Pronto runner for [PHPMD](https://github.com/phpmd/phpmd).
+[What is Pronto?](https://github.com/mmozuras/pronto)
+
+
+Configuration
+-------------
+
+Configuration is available via following environment variables
+
+| Name                      | Default                                                   |
+|---------------------------|-----------------------------------------------------------|
+| `PRONTO_PHPMD_EXECUTABLE` | phpmd                                                     |
+| `PRONTO_PHPMD_RULESET`    | cleancode,codesize,controversial,design,naming,unusedcode |
+
+Copyright
+---------
+
+Copyright (c) 2016 Eligijus Vitkauskas. See [LICENSE](LICENSE) for further details.

data/lib/pronto/phpmd.rb

@@ -0,0 +1,61 @@
+require 'pronto'
+require 'shellwords'
+require 'rexml/document'
+
+module Pronto
+  class Phpmd < Runner
+    def initialize(patches, commit = nil)
+      super
+
+      @executable = ENV['PRONTO_PHPMD_EXECUTABLE'] || 'phpmd'
+      @ruleset = ENV['PRONTO_PHPMD_RULESET'] || 'cleancode,codesize,controversial,design,naming,unusedcode'
+    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_phpmd(path).map do |offence|
+        patch.added_lines.select { |line| line.new_lineno == offence[:line] }
+          .map { |line| new_message(offence, line) }
+      end
+    end
+
+    def run_phpmd(path)
+      escaped_executable = Shellwords.escape(@executable)
+      escaped_path = Shellwords.escape(path)
+      escaped_ruleset = Shellwords.escape(@ruleset)
+
+      xml = `#{escaped_executable} #{escaped_path} xml #{escaped_ruleset}`
+      doc = REXML::Document.new(xml)
+
+      doc.elements.collect('pmd/file/violation') do |el|
+        line = el.attributes['beginline'].to_i
+        next unless line > 0
+
+        { line: line, msg: el.first.to_s.strip }
+      end
+    end
+
+    def new_message(offence, line)
+      path = line.patch.delta.new_file[:path]
+      level = :warning
+
+      Message.new(path, line, level, offence[:msg], nil, self.class)
+    end
+
+    def php_file?(path)
+      File.extname(path) == '.php'
+    end
+  end
+end

data/lib/pronto/phpmd/version.rb

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

data/pronto-phpmd.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/phpmd/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'pronto-phpmd'
+  spec.version = Pronto::PhpmdVersion::VERSION
+  spec.authors = ['Eligijus Vitkauskas']
+  spec.email = ['eligijusvitkauskas@gmail.com']
+
+  spec.summary = 'Pronto runner for PHPMD'
+  spec.homepage = 'https://github.com/EllisV/pronto-phpmd'
+  spec.license = 'MIT'
+
+  spec.files = Dir.glob('lib/**/*.rb') + ['pronto-phpmd.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-phpmd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eligijus Vitkauskas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-13 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/phpmd.rb
+- lib/pronto/phpmd/version.rb
+- pronto-phpmd.gemspec
+homepage: https://github.com/EllisV/pronto-phpmd
+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.6.7
+signing_key: 
+specification_version: 4
+summary: Pronto runner for PHPMD
+test_files: []