danger-phpmd 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1e49c9cf20dce174e2333d20d5061022fa3e30c11f742b3534fddffcb0a2850
-  data.tar.gz: d0d6c25a5a58ad42ecf16e7eeb297808dffe0f73315265ddb823475c84b32278
+  metadata.gz: fadbd745fa93f2da53a1a67b93a0ca61de2c21f64fc585a97443e61e56c5e7e1
+  data.tar.gz: 8b31e814c6293a58d0291c390a3aaac9ea803ea447950ac19fcb854d211a5131
 SHA512:
-  metadata.gz: 3f52ab2348cfd88d732af154e29cf75428bb6f1b32b2553dfc9b4a6ed37c1ca7d3fab00c39aa4734015dd380d297a43efefc9e935147a708df8f72d88e9d25f4
-  data.tar.gz: a36b2927dc3a6afc38ef368cc822b7c6ca297bc98e4a1aff29ffa6bb9818071a167f4e43c858e34271f8a507350b5f6f3d9ec6c76c8880a1666bd77fd9075436
+  metadata.gz: 4bbe29d4fd993884820861ed149c442764d07529aa8eeb2d80f69399c30b59be7dcf79378c994f6078ab7e1192b565737b0785676da7c05bdf0abe47ba0485b2
+  data.tar.gz: 6fd877b2192508304cfaf3a55485809f1676fdb4e4476f61add8fea52f4ba592b11d06a3bba32dc614823be946a7d4bc067f56e267ab5b89f881e08d861c890a

data/.github/workflows/CI.yml

@@ -0,0 +1,28 @@
+
+name: CI
+
+on: [push]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup PHP environment
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: '8.0'
+        coverage: none
+        tools: phpmd
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.rubocop.yml

@@ -3,6 +3,7 @@
 # If you don't like these settings, just delete this file :)
 
 AllCops:
+  NewCops: enable
   TargetRubyVersion: 2.6
 
 Style/StringLiterals:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-phpmd (0.0.1)
+    danger-phpmd (0.1.0)
       danger-plugin-api (~> 1.0)
 
 GEM
@@ -19,7 +19,7 @@ GEM
     colored2 (3.1.2)
     cork (0.3.0)
       colored2 (~> 3.1)
-    danger (8.4.1)
+    danger (8.4.2)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
@@ -34,17 +34,18 @@ GEM
       terminal-table (>= 1, < 4)
     danger-plugin-api (1.0.0)
       danger (> 2.0)
-    diff-lcs (1.4.4)
-    faraday (1.8.0)
+    diff-lcs (1.5.0)
+    faraday (1.9.3)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
       faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
+      faraday-net_http_persistent (~> 1.0)
       faraday-patron (~> 1.0)
       faraday-rack (~> 1.0)
-      multipart-post (>= 1.2, < 3)
+      faraday-retry (~> 1.0)
       ruby2_keywords (>= 0.0.4)
     faraday-em_http (1.0.0)
     faraday-em_synchrony (1.0.0)
@@ -52,13 +53,16 @@ GEM
     faraday-http-cache (2.2.0)
       faraday (>= 0.8)
     faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.2)
+      multipart-post (>= 1.2, < 3)
     faraday-net_http (1.0.1)
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
     ffi (1.15.4)
     formatador (0.3.0)
-    git (1.9.1)
+    git (1.10.2)
       rchardet (~> 1.8)
     guard (2.18.0)
       formatador (>= 0.2.4)
@@ -95,7 +99,7 @@ GEM
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
     parallel (1.21.0)
-    parser (3.0.2.0)
+    parser (3.1.0.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
@@ -107,7 +111,7 @@ GEM
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     rchardet (1.8.0)
-    regexp_parser (2.1.1)
+    regexp_parser (2.2.0)
     rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -122,16 +126,16 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.3)
-    rubocop (1.22.3)
+    rubocop (1.24.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
+      rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.12.0)
+    rubocop-ast (1.15.1)
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
@@ -141,9 +145,11 @@ GEM
     shellany (0.0.1)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
-    thor (1.1.0)
+    thor (1.2.1)
     unicode-display_width (2.1.0)
-    yard (0.9.26)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -6,6 +6,9 @@
 
     $ gem install danger-phpmd
 
+`phpmd` also needs to be installed before you run Danger.
+Please check the [installation guide](https://phpmd.org/download/index.html).
+
 ## Usage
 
 Add this to Dangerfile.
@@ -22,5 +25,33 @@ phpmd.run ruleset: "rulesets.xml"
 ```
 
 
+### GitHub actions
+
+```yaml
+name: CI
+
+on: [pull_request]
 
+jobs:
+  danger:
+    runs-on: ubuntu-latest
+    if: github.event_name  == 'pull_request'
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+        bundler-cache: true
+
+    - name: Setup PHP environment
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: '8.0'
+        coverage: none
+        tools: phpmd
+
+    - run: bundle exec danger
+      env:
+        DANGER_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
 

data/lib/phpmd/gem_version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Phpmd
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/lib/phpmd/plugin.rb

@@ -23,9 +23,10 @@ module Danger
     # @return [void]
     def run(options)
       return if target_files.empty?
-      cmd = binary_path || "phpmd"
-      json,e,s = Open3.capture3(cmd, target_files.join(","), "json", options[:ruleset])
-      results = parse(json)
+
+      tmpfile = Tempfile.open("phpmd_result")
+      Open3.capture3(cmd_path, "--reportfile", tmpfile.path, target_files.join(","), "json", options[:ruleset])
+      results = parse(tmpfile.read)
       results.each do |result|
         warn(result[:message], file: result[:file], line: result[:line])
       end
@@ -33,19 +34,26 @@ module Danger
 
     private
 
+    def cmd_path
+      return binary_path if binary_path
+
+      File.exist?("./vendor/bin/phpmd") ? "./vendor/bin/phpmd" : "phpmd"
+    end
+
     def parse(json)
       array = JSON.parse json
       return if array.empty?
+
       path = "#{Dir.pwd}/"
 
       results = []
-      array['files'].each do |line|
-        file = line['file'].sub(path, "")
-        line['violations'].each do |violation|
+      array["files"].each do |line|
+        file = line["file"].sub(path, "")
+        line["violations"].each do |violation|
           results << {
-            message: violation['description'],
+            message: violation["description"],
             file: file,
-            line: violation['beginLine']
+            line: violation["beginLine"]
           }
         end
       end
@@ -53,7 +61,7 @@ module Danger
     end
 
     def target_files
-      ((git.added_files + (git.modified_files - git.deleted_files)) - git.renamed_files.map{|r|r[:before]} + git.renamed_files.map{|r|r[:after]}).uniq
+      ((git.added_files + (git.modified_files - git.deleted_files)) - git.renamed_files.map { |r| r[:before] } + git.renamed_files.map { |r| r[:after] }).uniq
     end
   end
 end

data/spec/fixtures/cleancode_warnings.php

@@ -0,0 +1,11 @@
+<?php
+class Foo
+{
+  public function bar($flag) {
+    if ($flag) {
+      echo 'Hello';
+    } else {
+      echo 'World';
+    }
+  }
+}

data/spec/fixtures/no_warnings.php

@@ -0,0 +1 @@
+<?php

data/spec/phpmd_spec.rb

@@ -8,39 +8,44 @@ module Danger
       expect(Danger::DangerPhpmd.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
         @my_plugin = @dangerfile.phpmd
-
-        # mock the PR data
-        # you can then use this, eg. github.pr_author, later in the spec
-        json = File.read("#{File.dirname(__FILE__)}/support/fixtures/github_pr.json") # example json: `curl https://api.github.com/repos/danger/danger-plugin-template/pulls/18 > github_pr.json`
-        allow(@my_plugin.github).to receive(:pr_json).and_return(json)
       end
 
-      # Some examples for writing tests
-      # You should replace these with your own.
-
-      it "Warns on a monday" do
-        monday_date = Date.parse("2016-07-11")
-        allow(Date).to receive(:today).and_return monday_date
+      context "with a file included no warnings" do
+        before do
+          allow(@my_plugin).to receive(:target_files).and_return(
+            [File.expand_path("fixtures/no_warnings.php", __dir__)]
+          )
+        end
 
-        @my_plugin.warn_on_mondays
+        it "warns nothing" do
+          @my_plugin.run({ ruleset: "cleancode" })
 
-        expect(@dangerfile.status_report[:warnings]).to eq(["Trying to merge code on a Monday"])
+          expect(@dangerfile.status_report[:warnings]).to eq([])
+        end
       end
 
-      it "Does nothing on a tuesday" do
-        monday_date = Date.parse("2016-07-12")
-        allow(Date).to receive(:today).and_return monday_date
+      context "with a file included some warnings" do
+        let(:expected_message) { "The method bar uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them." }
+        before do
+          allow(@my_plugin).to receive(:target_files).and_return(
+            [File.expand_path("fixtures/cleancode_warnings.php", __dir__)]
+          )
+        end
+
+        it "warns nothing" do
+          @my_plugin.run({ ruleset: "cleancode" })
 
-        @my_plugin.warn_on_mondays
+          expect(@dangerfile.status_report[:warnings]).to eq([expected_message])
 
-        expect(@dangerfile.status_report[:warnings]).to eq([])
+          violation_report = @dangerfile.violation_report[:warnings].first
+          expect(violation_report.file).to eq("spec/fixtures/cleancode_warnings.php")
+          expect(violation_report.line).to eq(7)
+          expect(violation_report.message).to eq(expected_message)
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-phpmd
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Kyosuke Takayama
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-06 00:00:00.000000000 Z
+date: 2022-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -157,6 +157,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/CI.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - Gemfile
@@ -170,6 +171,8 @@ files:
 - lib/danger_plugin.rb
 - lib/phpmd/gem_version.rb
 - lib/phpmd/plugin.rb
+- spec/fixtures/cleancode_warnings.php
+- spec/fixtures/no_warnings.php
 - spec/phpmd_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/ktakayama/danger-phpmd
@@ -191,10 +194,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Danger plugin for PHPMD.
 test_files:
+- spec/fixtures/cleancode_warnings.php
+- spec/fixtures/no_warnings.php
 - spec/phpmd_spec.rb
 - spec/spec_helper.rb