danger-php_codesniffer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9fbc1d6bc595b3950846a2011d8f337d8e1e044c34aa74ffe44dde1df195ad98
+  data.tar.gz: 4bf62fa2c4a933800d97cd62a41604b5723a9dbddbc31b8fb809ebc0235c20b4
+SHA512:
+  metadata.gz: e380a24d2f6d5f3af26543480477fee71760c42e5c54f17ca1865c1aa32cfcaaa19781a12327b16e7e94689dbb8434586b6cc945f3407e2d5da94c6015eaa24e
+  data.tar.gz: 513fc22cf91f3549958a87b4e5c067431141e44165e361f262a1e6659d06b5641d8f3cc0fbf95a459c982773bffc40d7b98d67d18490e9004ade02cb96c9b8c4

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+pkg
+.idea/
+.yardoc
+*.gem

data/.rubocop.yml

@@ -0,0 +1,152 @@
+# Defaults can be found here: https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+
+# If you don't like these settings, just delete this file :)
+
+AllCops:
+  TargetRubyVersion: 2.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  Enabled: true
+
+# kind_of? is a good way to check a type
+Style/ClassCheck:
+  EnforcedStyle: kind_of?
+
+# It's better to be more explicit about the type
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+# specs sometimes have useless assignments, which is fine
+Lint/UselessAssignment:
+  Exclude:
+    - '**/spec/**/*'
+
+# We could potentially enable the 2 below:
+Layout/IndentHash:
+  Enabled: false
+
+Layout/AlignHash:
+  Enabled: false
+
+# HoundCI doesn't like this rule
+Layout/DotPosition:
+  Enabled: false
+
+# We allow !! as it's an easy way to convert ot boolean
+Style/DoubleNegation:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+# We want to allow class Fastlane::Class
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 60
+
+# The %w might be confusing for new users
+Style/WordArray:
+  MinSize: 19
+
+# raise and fail are both okay
+Style/SignalException:
+  Enabled: false
+
+# Better too much 'return' than one missing
+Style/RedundantReturn:
+  Enabled: false
+
+# Having if in the same line might not always be good
+Style/IfUnlessModifier:
+  Enabled: false
+
+# and and or is okay
+Style/AndOr:
+  Enabled: false
+
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 350
+
+Metrics/CyclomaticComplexity:
+  Max: 17
+
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 370
+
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 18
+
+# Sometimes it's easier to read without guards
+Style/GuardClause:
+  Enabled: false
+
+# something = if something_else
+# that's confusing
+Style/ConditionalAssignment:
+  Enabled: false
+
+# Better to have too much self than missing a self
+Style/RedundantSelf:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 60
+
+# We're not there yet
+Style/Documentation:
+  Enabled: false
+
+# Adds complexity
+Style/IfInsideElse:
+  Enabled: false
+
+# danger specific
+
+Style/BlockComments:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+# FIXME: 25
+Metrics/BlockLength:
+  Max: 345
+  Exclude:
+    - "**/*_spec.rb"
+
+Style/MixinGrouping:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Layout/IndentHeredoc:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+PercentLiteralDelimiters:
+  PreferredDelimiters:
+    "%":  ()
+    "%i": ()
+    "%q": ()
+    "%Q": ()
+    "%r": "{}"
+    "%s": ()
+    "%w": ()
+    "%W": ()
+    "%x": ()
+
+Security/YAMLLoad:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+cache:
+  directories:
+    - bundle
+
+rvm:
+  - 2.0
+  - 2.1.3
+  - 2.3.1
+
+script:
+    - bundle exec rake spec

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in danger-php_codesniffer.gemspec
+gemspec
+
+gem 'rspec', '~> 3.4'
+gem 'pry'

data/Gemfile.lock

@@ -0,0 +1,136 @@
+PATH
+  remote: .
+  specs:
+    danger-php_codesniffer (0.1.0)
+      danger-plugin-api (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    claide (1.0.2)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    coderay (1.1.2)
+    colored2 (3.1.2)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (5.11.1)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (~> 0.9)
+      faraday-http-cache (~> 1.0)
+      git (~> 1.5)
+      kramdown (~> 1.5)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (~> 1)
+    danger-plugin-api (1.0.0)
+      danger (> 2.0)
+    diff-lcs (1.3)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    faraday-http-cache (1.3.1)
+      faraday (~> 0.8)
+    ffi (1.10.0)
+    formatador (0.2.5)
+    git (1.5.0)
+    guard (2.15.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    jaro_winkler (1.5.2)
+    kramdown (1.17.0)
+    listen (3.0.7)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
+    multipart-post (2.0.0)
+    nap (1.1.0)
+    nenv (0.3.0)
+    no_proxy_fix (0.1.2)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.13.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    open4 (1.3.4)
+    parallel (1.13.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.3)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.63.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
+    shellany (0.0.1)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thor (0.20.3)
+    unicode-display_width (1.4.1)
+    yard (0.9.16)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  danger-php_codesniffer!
+  guard (~> 2.14)
+  guard-rspec (~> 4.7)
+  listen (= 3.0.7)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.4)
+  rubocop (~> 0.63)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   1.17.3

data/Guardfile

@@ -0,0 +1,19 @@
+# A guardfile for making Danger Plugins
+# For more info see https://github.com/guard/guard#readme
+
+# To run, use `bundle exec guard`.
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2019 ymhuang <ymhuang@golface.com.tw>
+
+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,20 @@
+# danger-php_codesniffer
+
+A description of danger-php_codesniffer.
+
+## Installation
+
+    $ gem install danger-php_codesniffer
+
+## Usage
+
+    Methods and attributes from this plugin are available in
+    your `Dangerfile` under the `php_codesniffer` namespace.
+
+## Development
+
+1. Clone this repo
+2. Run `bundle install` to setup dependencies.
+3. Run `bundle exec rake spec` to run the tests.
+4. Use `bundle exec guard` to automatically have tests run as you make changes.
+5. Make your changes.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:specs)
+
+task default: :specs
+
+task :spec do
+  Rake::Task['specs'].invoke
+  Rake::Task['rubocop'].invoke
+  Rake::Task['spec_docs'].invoke
+end
+
+desc 'Run RuboCop on the lib/specs directory'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+end
+
+desc 'Ensure that the plugin passes `danger plugins lint`'
+task :spec_docs do
+  sh 'bundle exec danger plugins lint'
+end

data/danger-php_codesniffer.gemspec

@@ -0,0 +1,49 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'php_codesniffer/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'danger-php_codesniffer'
+  spec.version       = PhpCodesniffer::VERSION
+  spec.authors       = ['ymhuang0808']
+  spec.email         = ['ymhuang@golface.com.tw']
+  spec.description   = %q{Danger plugin for PHP_CodeSniffer.}
+  spec.summary       = %q{Help you use Danger to check code standard and create comments on PR/MR}
+  spec.homepage      = 'https://github.com/Golface/danger-php_codesniffer'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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_runtime_dependency 'danger-plugin-api', '~> 1.0'
+
+  # General ruby development
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  # Testing support
+  spec.add_development_dependency 'rspec', '~> 3.4'
+
+  # Linting code and docs
+  spec.add_development_dependency "rubocop", '~>0.63'
+  spec.add_development_dependency "yard", '~>0.9'
+
+  # Makes testing easy via `bundle exec guard`
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+
+  # If you want to work on older builds of ruby
+  spec.add_development_dependency 'listen', '3.0.7'
+
+  # This gives you the chance to run a REPL inside your tests
+  # via:
+  #
+  #    require 'pry'
+  #    binding.pry
+  #
+  # This will stop test execution and let you inspect the results
+  spec.add_development_dependency 'pry'
+end

data/lib/danger_php_codesniffer.rb

@@ -0,0 +1 @@
+require "php_codesniffer/gem_version"

data/lib/danger_plugin.rb

@@ -0,0 +1 @@
+require "php_codesniffer/plugin"

data/lib/php_codesniffer/gem_version.rb

@@ -0,0 +1,3 @@
+module PhpCodesniffer
+  VERSION = "0.1.0".freeze
+end

data/lib/php_codesniffer/plugin.rb

@@ -0,0 +1,138 @@
+require "json"
+
+module Danger
+  # Checks PHP files code standard using [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer).
+  #
+  # @example Execute PHP_CodeSniffer with changed files only and ignored directory
+  #
+  #          php_codesniffer.ignore = "./vendor"
+  #          php_codesniffer.filtering = true
+  #          php_codesniffer.exec
+  #
+  # @see  golface/danger-php_codesniffer
+  # @tags monday, weekends, time, rattata
+  #
+  class DangerPhpCodesniffer < Plugin
+
+    # An attribute that you can read/write from your Dangerfile
+    #
+    # @return   [String]
+    attr_accessor :ignore
+
+    # Enable filtering
+    # Only show messages within changed files.
+    # @return [Boolean]
+    attr_accessor :filtering
+
+    # Execute and process phpcs CLL's result.
+    #
+    # @return [void]
+    def exec
+      bin = phpcs_path
+      raise "phpcs is not installed" unless bin
+
+      summary = { "errors"=> 0, "warnings"=> 0, "fixable"=> 0 }
+      report = []
+
+      unless filtering
+        result = run_phpcs(bin, ".")
+        summary = result.fetch("totals")
+        report = generate_report result
+      else
+        ((git.modified_files - git.deleted_files) + git.added_files)
+          .select {|file| ((file.end_with? ".php") || (file.end_with? ".inc"))}
+          .map { |file| file.gsub("#{Dir.pwd}/", '') }
+          .each do |file|
+            result = run_phpcs(bin, file)
+            totals = result.fetch("totals")
+
+            summary["errors"] += totals["errors"]
+            summary["warnings"] += totals.fetch("warnings")
+            summary["fixable"] += totals.fetch("fixable")
+
+            report.push(generate_report result)
+          end
+      end
+
+      markdown "# PHP_CodeSniffer report"
+      markdown generate_summary_markdown summary
+      markdown report
+    end
+
+    private
+
+    # Get phpcs' bin path
+    #
+    # @return [String]
+    def phpcs_path
+      path = "./vendor/bin/phpcs"
+      File.exist?(path) ? path : find_executable("phpcs")
+    end
+
+    # Execute phpcs CLI and return the the result in JSON object
+    #
+    # @return [Hash]
+    def run_phpcs(bin, file)
+      command = "#{bin} --report=json "
+      command << "--basepath=. "
+      command << "--ignore=#{ignore}" if ignore
+      result = `#{command} #{file}`
+      JSON.parse result
+    end
+
+    # Generate summary markdown text
+    #
+    # @param  [Hash] summary
+    #         The report summary, default: errors, warnings and fixable are 0
+    # @return [String]
+    def generate_summary_markdown(summary = { errors: 0, warnings: 0, fixable: 0 })
+      request_type = host_type == :gitlab ? "MR" : "PR"
+      "## There are #{summary["errors"]} errors, #{summary["warnings"]} warnings and #{summary["fixable"]} fixable in the #{request_type}"
+    end
+
+    # Generate phpcs report markdown text by each file
+    #
+    # @param [Hash] result
+    #         The phpcs result
+    # @return [Array<String>]
+    def generate_report(result)
+      report = []
+
+      result.fetch("files")
+        .each do |file_name, v|
+          tbody = v.fetch("messages")
+            .map do |item|
+              # puts item
+              emoji = item.fetch("type") == "ERROR" ? ":no_entry_sign:" : ":warning:"
+              "<tr><td>#{emoji}</td><td>At line #{item.fetch("line")}</td><td>#{item.fetch("message")}</td></tr>"
+            end
+            .join("\n")
+
+          line = "<details><summary>#{file_name}</summary>"
+          line << "<table><thead><tr><th>Type</th><th>line</th><th>message</th></tr></thead>"
+          line << "<tbody>#{tbody}</tbody></table></details>"
+
+          report.push line
+        end
+
+      report
+    end
+
+    # Get SCM host_type
+    #
+    # return [Symbol]
+    def host_type
+      scm = :other
+      if defined? @dangerfile.gitlab
+        scm = :gitlab
+
+      elsif defined? @dangerfile.github
+        scm = :github
+
+      end
+
+      scm
+    end
+
+  end
+end

data/spec/fixtures/php/empty.php

@@ -0,0 +1,7 @@
+<?php
+
+$i=true;
+if($i)
+{
+echo 'TEST';
+}

data/spec/fixtures/php/error.php

@@ -0,0 +1,9 @@
+<?php
+
+$i=false;
+if($i)
+{
+echo 'TEST';
+} else {
+ecoh 'FALSE';
+}

data/spec/fixtures/php/warning.php

@@ -0,0 +1,7 @@
+<?php
+
+$i=true;
+if($i)
+{
+echo 'TEST';
+}

data/spec/fixtures/result/empty.json

@@ -0,0 +1,14 @@
+{
+  "totals": {
+    "errors": 0,
+    "warnings": 0,
+    "fixable": 0
+  },
+  "files": {
+    "spec/fixtures/php/empty.php": {
+      "errors": 0,
+      "warnings": 0,
+      "messages": []
+    }
+  }
+}

data/spec/fixtures/result/error.json

@@ -0,0 +1,24 @@
+{
+  "totals": {
+    "errors": 1,
+    "warnings": 0,
+    "fixable": 1
+  },
+  "files": {
+    "spec/fixtures/php/error.php": {
+      "errors": 1,
+      "warnings": 0,
+      "messages": [
+        {
+          "message": "PHP keywords must be lowercase; expected \"or\" but found \"OR\"",
+          "source": "Generic.PHP.LowerCaseKeyword.Found",
+          "severity": 5,
+          "fixable": true,
+          "type": "ERROR",
+          "line": 2,
+          "column": 21
+        }
+      ]
+    }
+  }
+}

data/spec/fixtures/result/multiple.json

@@ -0,0 +1,57 @@
+{
+  "totals": {
+    "errors": 3,
+    "warnings": 1,
+    "fixable": 4
+  },
+  "files": {
+    "application/config/autoload.php": {
+      "errors": 1,
+      "warnings": 1,
+      "messages": [
+        {
+          "message": "PHP keywords must be lowercase; expected \"or\" but found \"OR\"",
+          "source": "Generic.PHP.LowerCaseKeyword.Found",
+          "severity": 5,
+          "fixable": true,
+          "type": "ERROR",
+          "line": 2,
+          "column": 21
+        },
+        {
+          "message": "Fake warning message",
+          "source": "Fake warning source",
+          "severity": 4,
+          "fixable": true,
+          "type": "WARN",
+          "line": 3,
+          "column": 10
+        }
+      ]
+    },
+    "application/config/hooks.php": {
+      "errors": 2,
+      "warnings": 0,
+      "messages": [
+        {
+          "message": "PHP keywords must be lowercase; expected \"or\" but found \"OR\"",
+          "source": "Generic.PHP.LowerCaseKeyword.Found",
+          "severity": 5,
+          "fixable": true,
+          "type": "ERROR",
+          "line": 2,
+          "column": 21
+        },
+        {
+          "message": "Spaces must be used to indent lines; tabs are not allowed",
+          "source": "Generic.WhiteSpace.DisallowTabIndent.TabsUsed",
+          "severity": 5,
+          "fixable": true,
+          "type": "ERROR",
+          "line": 11,
+          "column": 1
+        }
+      ]
+    }
+  }
+}

data/spec/fixtures/result/warning.json

@@ -0,0 +1,24 @@
+{
+  "totals": {
+    "errors": 0,
+    "warnings": 1,
+    "fixable": 1
+  },
+  "files": {
+    "spec/fixtures/php/warning.php": {
+      "errors": 0,
+      "warnings": 1,
+      "messages": [
+        {
+          "message": "PHP keywords must be lowercase; expected \"or\" but found \"OR\"",
+          "source": "Generic.PHP.LowerCaseKeyword.Found",
+          "severity": 4,
+          "fixable": true,
+          "type": "WARN",
+          "line": 2,
+          "column": 10
+        }
+      ]
+    }
+  }
+}

data/spec/php_codesniffer_spec.rb

@@ -0,0 +1,115 @@
+require File.expand_path("../spec_helper", __FILE__)
+require 'json'
+
+module Danger
+  describe Danger::DangerPhpCodesniffer do
+    it "should be a plugin" do
+      expect(Danger::DangerPhpCodesniffer.new(nil)).to be_a Danger::Plugin
+    end
+
+    #
+    # You should test your custom attributes and methods here
+    #
+    describe "with Dangerfile" do
+      before do
+        @dangerfile = testing_dangerfile
+        @php_codesniffer = @dangerfile.php_codesniffer
+      end
+
+      before do
+        gitlab = Danger::RequestSources::GitLab.new({}, testing_env)
+        allow(@dangerfile).to receive(:gitlab).and_return gitlab
+        allow(@dangerfile).to receive(:github)
+      end
+
+      it "raises error if phpcs is not installed" do
+        allow(@php_codesniffer).to receive(:phpcs_path).and_return(nil)
+        expect { @php_codesniffer.exec }.to raise_error("phpcs is not installed")
+      end
+
+      describe :exec do
+        before do
+          @mix_result = JSON.parse File.read('spec/fixtures/result/multiple.json')
+          @error_result = JSON.parse File.read('spec/fixtures/result/error.json')
+          @warning_result = JSON.parse File.read('spec/fixtures/result/warning.json')
+          @empty_result = JSON.parse File.read('spec/fixtures/result/empty.json')
+
+          allow(@php_codesniffer).to receive(:run_phpcs)
+                                         .with("phpcs", "spec/fixtures/php/error.php")
+                                         .and_return @error_result
+          allow(@php_codesniffer).to receive(:run_phpcs)
+                                         .with("phpcs", "spec/fixtures/php/warning.php")
+                                         .and_return @warning_result
+          allow(@php_codesniffer).to receive(:run_phpcs)
+                                         .with("phpcs", "spec/fixtures/php/empty.php")
+                                         .and_return @empty_result
+        end
+
+        before do
+          allow(@php_codesniffer).to receive(:phpcs_path).and_return "phpcs"
+
+        end
+
+        it "checks all PHP files when filtering is not set" do
+          allow(@php_codesniffer).to receive(:run_phpcs).and_return @mix_result
+          @php_codesniffer.exec
+          output = @php_codesniffer.status_report[:markdowns]
+
+          expect(output.length).to eq(4)
+          expect(output[0].message).to eq("# PHP_CodeSniffer report")
+          expect(output[1].message).to eq("## There are 3 errors, 1 warnings and 4 fixable in the MR")
+          expect(output[2].message).to include("application/config/autoload.php")
+          expect(output[3].message).to include("application/config/hooks.php")
+        end
+
+        describe "when filtering is true" do
+          before do
+            @php_codesniffer.filtering = true
+          end
+
+        end
+
+        it "checks PHP files with only modified_files" do
+          allow(@php_codesniffer.git).to receive(:modified_files)
+            .and_return(["spec/fixtures/php/error.php"])
+          allow(@php_codesniffer.git).to receive(:deleted_files)
+            .and_return([])
+          allow(@php_codesniffer.git).to receive(:added_files)
+            .and_return([])
+          allow(@php_codesniffer).to receive(:phpcs_path).and_return "phpcs"
+
+          @php_codesniffer.filtering = true
+          @php_codesniffer.exec
+
+          output = @php_codesniffer.status_report[:markdowns]
+
+          expect(output.length).to eq 3
+          expect(output[0].message).to eq("# PHP_CodeSniffer report")
+          expect(output[1].message).to eq("## There are 1 errors, 0 warnings and 1 fixable in the MR")
+          expect(output[2].message).to include("spec/fixtures/php/error.php")
+        end
+
+        it "checks PHP files without deleted files and with modified and added files" do
+          allow(@php_codesniffer.git).to receive(:modified_files)
+                                             .and_return(["spec/fixtures/php/error.php"])
+          allow(@php_codesniffer.git).to receive(:deleted_files)
+                                             .and_return(["spec/fixtures/php/empty.php"])
+          allow(@php_codesniffer.git).to receive(:added_files)
+                                             .and_return(["spec/fixtures/php/warning.php"])
+          allow(@php_codesniffer).to receive(:phpcs_path).and_return "phpcs"
+
+
+          @php_codesniffer.filtering = true
+          @php_codesniffer.exec
+
+          output = @php_codesniffer.status_report[:markdowns]
+
+          expect(output.length).to eq 4
+          expect(output[0].message).to eq("# PHP_CodeSniffer report")
+          expect(output[1].message).to eq("## There are 1 errors, 1 warnings and 2 fixable in the MR")
+          expect(output[2].message).to include("spec/fixtures/php/error.php")
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,67 @@
+require "pathname"
+ROOT = Pathname.new(File.expand_path("../../", __FILE__))
+$:.unshift((ROOT + "lib").to_s)
+$:.unshift((ROOT + "spec").to_s)
+
+require "bundler/setup"
+require "pry"
+
+require "rspec"
+require "danger"
+
+if `git remote -v` == ''
+  puts "You cannot run tests without setting a local git remote on this repo"
+  puts "It's a weird side-effect of Danger's internals."
+  exit(0)
+end
+
+# Use coloured output, it's the best.
+RSpec.configure do |config|
+  config.filter_gems_from_backtrace "bundler"
+  config.color = true
+  config.tty = true
+end
+
+require "danger_plugin"
+
+# These functions are a subset of https://github.com/danger/danger/blob/master/spec/spec_helper.rb
+# If you are expanding these files, see if it's already been done ^.
+
+# A silent version of the user interface,
+# it comes with an extra function `.string` which will
+# strip all ANSI colours from the string.
+
+# rubocop:disable Lint/NestedMethodDefinition
+def testing_ui
+  @output = StringIO.new
+  def @output.winsize
+    [20, 9999]
+  end
+
+  cork = Cork::Board.new(out: @output)
+  def cork.string
+    out.string.gsub(/\e\[([;\d]+)?m/, "")
+  end
+  cork
+end
+# rubocop:enable Lint/NestedMethodDefinition
+
+# Example environment (ENV) that would come from
+# running a PR on TravisCI
+def testing_env
+  {
+    "HAS_JOSH_K_SEAL_OF_APPROVAL" => "true",
+    "TRAVIS_PULL_REQUEST" => "800",
+    "TRAVIS_REPO_SLUG" => "artsy/eigen",
+    "TRAVIS_COMMIT_RANGE" => "759adcbd0d8f...13c4dc8bb61d",
+    "DANGER_GITHUB_API_TOKEN" => "123sbdq54erfsd3422gdfio",
+    "DANGER_GITLAB_API_TOKEN" => "123abcd54erfsd3422gdfio",
+    "DANGER_GITLAB_API_BASE_URL" => "https://mygitlab.com"
+  }
+end
+
+# A stubbed out Dangerfile for use in tests
+def testing_dangerfile
+  env = Danger::EnvironmentManager.new(testing_env)
+  Danger::Dangerfile.new(env, testing_ui)
+end

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: danger-php_codesniffer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ymhuang0808
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: danger-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.63'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.63'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Danger plugin for PHP_CodeSniffer.
+email:
+- ymhuang@golface.com.tw
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- danger-php_codesniffer.gemspec
+- lib/danger_php_codesniffer.rb
+- lib/danger_plugin.rb
+- lib/php_codesniffer/gem_version.rb
+- lib/php_codesniffer/plugin.rb
+- spec/fixtures/php/empty.php
+- spec/fixtures/php/error.php
+- spec/fixtures/php/warning.php
+- spec/fixtures/result/empty.json
+- spec/fixtures/result/error.json
+- spec/fixtures/result/multiple.json
+- spec/fixtures/result/warning.json
+- spec/php_codesniffer_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Golface/danger-php_codesniffer
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Help you use Danger to check code standard and create comments on PR/MR
+test_files:
+- spec/fixtures/php/empty.php
+- spec/fixtures/php/error.php
+- spec/fixtures/php/warning.php
+- spec/fixtures/result/empty.json
+- spec/fixtures/result/error.json
+- spec/fixtures/result/multiple.json
+- spec/fixtures/result/warning.json
+- spec/php_codesniffer_spec.rb
+- spec/spec_helper.rb