danger-periphery 0.0.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8478fb86f4d5952f88ee7772f352049288bbc5c21f2f5d452ab7b37389b561ec
-  data.tar.gz: 63c976e46da5ad41bd5797adb3f1ddc83edd5c09f8d607c043757924b3b32cad
+  metadata.gz: 15302ed92faf0a3230ddcb167fe3db0ae2e8c1a51d6551d85a4c2cc37c760dd4
+  data.tar.gz: 18880214efa7cb5a29ee9b6872688a6eeb19d805e07cad6c445afeeb24f4cad2
 SHA512:
-  metadata.gz: aeae221bc8e42918a500eb3050b3bd44451a4fa4af5e2e42a77e252a64cfc17ca7213b455af830d26c1c001a0250a2af4e532303b1bce8c5e45dd2b02c817dfb
-  data.tar.gz: d07fd15ea7105b6fbb875d628771a70c557bbd4066246712e26e5f1599d80d6d42e078d61b22e3c0c30c677105c0da317596a2d3a60595b3f16355193a8bed48
+  metadata.gz: 5e33a6b9fa62d733004fb63337fdff4973dd3b38d40a096db0b84a1249bc7789a3612a99a88d31020e22dd6494c3b7d3c953fe721be16347e825a58e8900a177
+  data.tar.gz: 47a37136e81dc9c4b6fc6b3331e476810e4520503c7fd062714363675926c51525502dc58ef2d610b890ee0d73d731d8ac87910bd8e6ab2f051f47c980b4ac88

data/lib/danger_plugin.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
-require "periphery/runner"
-require "periphery/scan_log_parser"
+require 'periphery'
 
 module Danger
   # Analyze Swift files and detect unused codes in your project.
-  # This is done using [Periphery](https://github.com/peripheryapp/periphery).
+  # This is done using {https://github.com/peripheryapp/periphery Periphery}.
   #
   # @example Specifying options to Periphery.
   #
@@ -16,7 +15,7 @@ module Danger
   #            clean_build: true
   #          )
   #
-  # @see manicmaniac/danger-periphery
+  # @see file:README.md
   # @tags swift
   class DangerPeriphery < Plugin
     # Path to Periphery executable.
@@ -24,32 +23,114 @@ module Danger
     # @return [String]
     attr_accessor :binary_path
 
+    # Proc object to process each warnings just before showing them.
+    # The Proc must receive 4 arguments: path, line, column, message
+    # and return one of:
+    #   - an array that contains 4 elements [path, line, column, message]
+    #   - true
+    #   - false
+    #   - nil
+    # If Proc returns an array, the warning will be raised based on returned elements.
+    # If Proc returns true, the warning will not be modified.
+    # If Proc returns false or nil, the warning will be ignored.
+    #
+    # By default the Proc returns true.
+    # @return [Proc]
+    attr_accessor :postprocessor
+
+    OPTION_OVERRIDES = {
+      disable_update_check: true,
+      format: 'checkstyle',
+      quiet: true
+    }.freeze
+
+    def initialize(dangerfile)
+      super(dangerfile)
+      @postprocessor = ->(_path, _line, _column, _message) { true }
+    end
+
     # Scans Swift files.
     # Raises an error when Periphery executable is not found.
     #
+    # @example Ignore all warnings from files matching regular expression
+    #   periphery.scan do |violation|
+    #     ! violation.path.match(/.*\/generated\.swift/)
+    #   end
+    #
     # @param [Hash] options Options passed to Periphery with the following translation rules.
     #                       1. Replace all underscores with hyphens in each key.
     #                       2. Prepend double hyphens to each key.
     #                       3. If value is an array, transform it to comma-separated string.
     #                       4. If value is true, drop value and treat it as option without argument.
-    #                       5. Override some options like --disable-update-check, --format, --quiet and so.
+    #                       5. Override some options listed in {OPTION_OVERRIDES}.
+    #                       Run +$ periphery help scan+ for available options.
+    #
+    # @param [Proc] block   Block to process each warning just before showing it.
+    #                       The Proc receives 1 {Periphery::ScanResult} instance as argument.
+    #                       If the Proc returns falsy value, the warning corresponding to the given ScanResult will be
+    #                       suppressed, otherwise not.
+    #
     # @return [void]
-    def scan(**options)
-      output = Periphery::Runner.new(binary_path).scan(options.merge(disable_update_check: true, format: "xcode", quiet: true))
-      entries = Periphery::ScanLogParser.new.parse(output)
+    def scan(**options, &block)
+      output = Periphery::Runner.new(binary_path).scan(options.merge(OPTION_OVERRIDES))
       files = files_in_diff
-      entries.
-        select { |entry| files.include?(entry.path) }.
-        each { |entry| warn(entry.message, file: entry.path, line: entry.line) }
+      Periphery::CheckstyleParser.new.parse(output).each do |entry|
+        next unless files.include?(entry.path)
+
+        result = postprocess(entry, &block)
+        next unless result
+
+        path, line, _column, message = result
+        warn(message, file: path, line: line)
+      end
+    end
+
+    # Convenience method to set {#postprocessor} with block.
+    #
+    # @return [Proc]
+    #
+    # @example Ignore all warnings from files matching regular expression
+    #   periphery.process_warnings do |path, line, column, message|
+    #     ! path.match(/.*\/generated\.swift/)
+    #   end
+    def process_warnings(&block)
+      @postprocessor = block
     end
 
     private
 
     def files_in_diff
       # Taken from https://github.com/ashfurrow/danger-ruby-swiftlint/blob/5184909aab00f12954088684bbf2ce5627e08ed6/lib/danger_plugin.rb#L214-L216
-      renamed_files_hash = git.renamed_files.map { |rename| [rename[:before], rename[:after]] }.to_h
-      post_rename_modified_files = git.modified_files.map { |modified_file| renamed_files_hash[modified_file] || modified_file }
+      renamed_files_hash = git.renamed_files.to_h { |rename| [rename[:before], rename[:after]] }
+      post_rename_modified_files = git.modified_files.map do |modified_file|
+        renamed_files_hash[modified_file] || modified_file
+      end
       (post_rename_modified_files - git.deleted_files) + git.added_files
     end
+
+    def postprocess(entry, &block)
+      if block
+        postprocess_with_block(entry, &block)
+      else
+        postprocess_with_postprocessor(entry)
+      end
+    end
+
+    def postprocess_with_block(entry, &block)
+      [entry.path, entry.line, entry.column, entry.message] if block.call(entry)
+    end
+
+    def postprocess_with_postprocessor(entry)
+      result = @postprocessor.call(entry.path, entry.line, entry.column, entry.message)
+      if !result
+        nil
+      elsif result.is_a?(TrueClass)
+        [entry.path, entry.line, entry.column, entry.message]
+      elsif result.is_a?(Array) && result.size == 4
+        result
+      else
+        raise 'Proc passed to postprocessor must return one of nil, true, false and Array that includes 4 elements.'
+      end
+    end
   end
 end

data/lib/periphery/checkstyle_parser.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'periphery/scan_result'
+require 'rexml/parsers/streamparser'
+require 'rexml/streamlistener'
+
+module Periphery
+  # Parses {https://checkstyle.sourceforge.io/ Checkstyle} format XML produced by Periphery with
+  # +--format=checkstyle+ option.
+  class CheckstyleParser
+    class Listener # :nodoc:
+      include REXML::StreamListener
+
+      attr_reader :results
+
+      def initialize
+        @current_file = nil
+        @results = []
+      end
+
+      def tag_start(name, attrs)
+        case name
+        when 'file'
+          @current_file = relative_path(attrs['name'])
+        when 'error'
+          if @current_file
+            @results << ScanResult.new(@current_file, attrs['line'].to_i, attrs['column'].to_i, attrs['message'])
+          end
+        end
+      end
+
+      def tag_end(name)
+        @current_file = nil if name == 'file'
+      end
+
+      private
+
+      def relative_path(path, base = Pathname.getwd)
+        Pathname.new(path).relative_path_from(base).to_s
+      end
+    end
+
+    def parse(string)
+      listener = Listener.new
+      REXML::Parsers::StreamParser.new(string, listener).parse
+      listener.results
+    end
+  end
+end

data/lib/periphery/runner.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
-require "open3"
+require 'open3'
 
 module Periphery
-  class Runner
+  class Runner # :nodoc:
     attr_reader :binary_path
 
     def initialize(binary_path)
-      @binary_path = binary_path || "periphery"
+      @binary_path = binary_path || 'periphery'
     end
 
     def scan(options)
-      arguments = [binary_path, "scan"] + scan_arguments(options)
+      arguments = [binary_path, 'scan'] + scan_arguments(options)
       stdout, stderr, status = Open3.capture3(*arguments)
       raise "error: #{arguments} exited with status code #{status.exitstatus}. #{stderr}" unless status.success?
 
@@ -19,13 +19,14 @@ module Periphery
     end
 
     def scan_arguments(options)
-      options.
-        select { |_key, value| value }.
-        map { |key, value| value.kind_of?(TrueClass) ? [key, nil] : [key, value] }.
-        map { |key, value| value.kind_of?(Array) ? [key, value.join(",")] : [key, value] }.
-        map { |key, value| ["--#{key.to_s.tr('_', '-')}", value] }.
-        flatten.
-        compact
+      options.each_with_object([]) do |(key, value), new_options|
+        next unless value
+
+        value = nil if value.is_a?(TrueClass)
+        value = value.join(',') if value.is_a?(Array)
+        new_options << "--#{key.to_s.tr('_', '-')}"
+        new_options << value&.to_s if value
+      end
     end
   end
 end

data/lib/periphery/scan_result.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Periphery
+  ScanResult = Struct.new(:path, :line, :column, :message)
+end

data/lib/periphery.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'periphery/runner'
+require 'periphery/checkstyle_parser'

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DangerPeriphery
-  VERSION = "0.0.1"
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-periphery
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Ryosuke Ito
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-24 00:00:00.000000000 Z
+date: 2022-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -27,39 +27,21 @@ dependencies:
 description: A Danger plugin to detect unused codes.
 email:
 - rito.0305@gmail.com
-executables:
-- download_periphery
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/lint.yml"
-- ".github/workflows/test.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- Dangerfile
-- Gemfile
-- Guardfile
-- LICENSE.txt
-- README.md
-- Rakefile
-- bin/download_periphery
-- danger-periphery.gemspec
 - lib/danger_plugin.rb
+- lib/periphery.rb
+- lib/periphery/checkstyle_parser.rb
 - lib/periphery/runner.rb
-- lib/periphery/scan_log_parser.rb
+- lib/periphery/scan_result.rb
 - lib/version.rb
-- spec/danger_plugin_spec.rb
-- spec/periphery/runner_spec.rb
-- spec/periphery/scan_log_parser_spec.rb
-- spec/spec_helper.rb
-- spec/support/fixtures/github_pr.json
-- spec/support/fixtures/test.xcodeproj/project.pbxproj
-- spec/support/fixtures/test/main.swift
 homepage: https://github.com/manicmaniac/danger-periphery
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -68,22 +50,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: A Danger plugin to detect unused codes.
-test_files:
-- spec/danger_plugin_spec.rb
-- spec/periphery/runner_spec.rb
-- spec/periphery/scan_log_parser_spec.rb
-- spec/spec_helper.rb
-- spec/support/fixtures/github_pr.json
-- spec/support/fixtures/test.xcodeproj/project.pbxproj
-- spec/support/fixtures/test/main.swift
+test_files: []

data/.github/workflows/lint.yml

@@ -1,12 +0,0 @@
-name: Lint
-on: [pull_request]
-jobs:
-  lint:
-    runs-on: macOS-11
-    env:
-      DANGER_GITHUB_API_TOKEN: ${{ secrets.DANGER_GITHUB_API_TOKEN }}
-    steps:
-      - uses: actions/checkout@v2
-      - run: bin/download_periphery
-      - run: bundle install
-      - run: bundle exec danger

data/.github/workflows/test.yml

@@ -1,10 +0,0 @@
-name: Test
-on: [push]
-jobs:
-  unit-test:
-    runs-on: macOS-11
-    steps:
-      - uses: actions/checkout@v2
-      - run: bin/download_periphery
-      - run: bundle install
-      - run: bundle exec rake

data/.gitignore

@@ -1,10 +0,0 @@
-.DS_Store
-.idea/
-.yardoc
-/tmp
-Gemfile.lock
-bin/lib_InternalSwiftSyntaxParser.dylib
-bin/periphery
-pkg
-project.xcworkspace
-xcuserdata

data/.rspec

@@ -1,3 +0,0 @@
---color
---require spec_helper
---format documentation

data/.rubocop.yml

@@ -1,281 +0,0 @@
-# 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.6
-  SuggestExtensions: false
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-  Enabled: true
-
-# kind_of? is a good way to check a type
-Style/ClassCheck:
-  EnforcedStyle: kind_of?
-
-# specs sometimes have useless assignments, which is fine
-Lint/UselessAssignment:
-  Exclude:
-    - '**/spec/**/*'
-
-# We could potentially enable the 2 below:
-Layout/FirstHashElementIndentation:
-  Enabled: false
-
-Layout/HashAlignment:
-  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.
-Layout/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
-
-Naming/FileName:
-  Enabled: false
-
-Layout/HeredocIndentation:
-  Enabled: false
-
-Style/SpecialGlobalVars:
-  Enabled: false
-
-Style/PercentLiteralDelimiters:
-  PreferredDelimiters:
-    "%":  ()
-    "%i": ()
-    "%q": ()
-    "%Q": ()
-    "%r": "{}"
-    "%s": ()
-    "%w": ()
-    "%W": ()
-    "%x": ()
-
-Security/YAMLLoad:
-  Enabled: false
-
-Gemspec/DateAssignment:
-  Enabled: true
-
-Layout/LineEndStringConcatenationIndentation:
-  Enabled: true
-
-Layout/SpaceBeforeBrackets:
-  Enabled: true
-
-Lint/AmbiguousAssignment:
-  Enabled: true
-
-Lint/AmbiguousOperatorPrecedence:
-  Enabled: true
-
-Lint/AmbiguousRange:
-  Enabled: true
-
-Lint/DeprecatedConstants:
-  Enabled: true
-
-Lint/DuplicateBranch:
-  Enabled: true
-
-Lint/DuplicateRegexpCharacterClassElement:
-  Enabled: true
-
-Lint/EmptyBlock:
-  Enabled: true
-
-Lint/EmptyClass:
-  Enabled: true
-
-Lint/EmptyInPattern:
-  Enabled: true
-
-Lint/IncompatibleIoSelectWithFiberScheduler:
-  Enabled: true
-
-Lint/LambdaWithoutLiteralBlock:
-  Enabled: true
-
-Lint/NoReturnInBeginEndBlocks:
-  Enabled: true
-
-Lint/NumberedParameterAssignment:
-  Enabled: true
-
-Lint/OrAssignmentToConstant:
-  Enabled: true
-
-Lint/RedundantDirGlobSort:
-  Enabled: true
-
-Lint/RequireRelativeSelfPath:
-  Enabled: true
-
-Lint/SymbolConversion:
-  Enabled: true
-
-Lint/ToEnumArguments:
-  Enabled: true
-
-Lint/TripleQuotes:
-  Enabled: true
-
-Lint/UnexpectedBlockArity:
-  Enabled: true
-
-Lint/UnmodifiedReduceAccumulator:
-  Enabled: true
-
-Security/IoMethods:
-  Enabled: true
-
-Style/ArgumentsForwarding:
-  Enabled: true
-
-Style/CollectionCompact:
-  Enabled: true
-
-Style/DocumentDynamicEvalDefinition:
-  Enabled: true
-
-Style/EndlessMethod:
-  Enabled: true
-
-Style/HashConversion:
-  Enabled: true
-
-Style/HashExcept:
-  Enabled: true
-
-Style/IfWithBooleanLiteralBranches:
-  Enabled: true
-
-Style/InPatternThen:
-  Enabled: true
-
-Style/MultilineInPatternThen:
-  Enabled: true
-
-Style/NegatedIfElseCondition:
-  Enabled: true
-
-Style/NilLambda:
-  Enabled: true
-
-Style/NumberedParameters:
-  Enabled: true
-
-Style/NumberedParametersLimit:
-  Enabled: true
-
-Style/QuotedSymbols:
-  Enabled: true
-
-Style/RedundantArgument:
-  Enabled: true
-
-Style/RedundantSelfAssignmentBranch:
-  Enabled: true
-
-Style/SelectByRegexp:
-  Enabled: true
-
-Style/StringChars:
-  Enabled: true
-
-Style/SwapValues:
-  Enabled: true

data/Dangerfile

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-rubocop.lint inline_comment: true
-
-periphery.binary_path = "bin/periphery"
-periphery.scan(
-  project: "spec/support/fixtures/test.xcodeproj",
-  schemes: "test",
-  targets: "test"
-)