danger-periphery 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b949d4e8279afb04d63616f89e15f3ef0efaf700b83d027273f1973d085fa23
-  data.tar.gz: cd8e2564827d41bdee17e7b8fead197f3dc1481f129ee9dcbc22779ea1783489
+  metadata.gz: 1232912ce0ad696e3ea2b34b383fbc70831ccbf0a4294673a5a122c37909d677
+  data.tar.gz: 36c2fd6ab1f814f209cb0843db05e3d6c4bcad47360d6695db4968954048590e
 SHA512:
-  metadata.gz: 3d0e28054ab01f50603b92cf32b6005d1befa875545afaa9d8fbd80bdf048d097776bcfcdfe01cc746a0cc24d9455284a400be7b9d11142249db9b2731d1b578
-  data.tar.gz: 97d0f89856d52fe03fbda8f3b8539279343e2b28340042ee5db2aa2984222cf6e3ac5eacde6ad17eebc7b393f9d6163ce16f296e8a044fe984442b31566ae6ee
+  metadata.gz: 67cbcfbbd827ab1f276d5f0f42728cea8a38a018495bbedefd62b441fae2b6e8fd92358269fde43d2d1c8d4e14494f5c3a510dc1c51473a8ac869375d4992f25
+  data.tar.gz: 68d40960394c7cba16e2ae6080803b493995641548bfaa31d3f5f0b32761cb47448863c063a7ae9be6b13283682ff6c5c9d4cece0fb200dd33bb0ca17c09dac8

data/lib/danger_plugin.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require "periphery"
+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.
   #
@@ -15,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.
@@ -23,6 +23,8 @@ module Danger
     # @return [String]
     attr_accessor :binary_path
 
+    # @deprecated Use {#scan} with block instead.
+    #
     # Proc object to process each warnings just before showing them.
     # The Proc must receive 4 arguments: path, line, column, message
     # and return one of:
@@ -36,78 +38,132 @@ module Danger
     #
     # By default the Proc returns true.
     # @return [Proc]
-    attr_accessor :postprocessor
+    attr_reader :postprocessor
+
+    # For internal use only.
+    #
+    # @return [Symbol]
+    attr_writer :format
 
     OPTION_OVERRIDES = {
       disable_update_check: true,
-      format: "checkstyle",
       quiet: true
     }.freeze
 
     def initialize(dangerfile)
       super(dangerfile)
-      @postprocessor = ->(path, line, column, message) { true }
+      @postprocessor = ->(_path, _line, _column, _message) { true }
+      @format = :checkstyle
     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, &block)
-      output = Periphery::Runner.new(binary_path).scan(options.merge(OPTION_OVERRIDES))
+    def scan(options = {}, &block)
+      output = Periphery::Runner.new(binary_path).scan(options.merge(OPTION_OVERRIDES).merge(format: @format))
       files = files_in_diff
-      Periphery::CheckstyleParser.new.parse(output).
-        lazy.
-        select { |entry| files.include?(entry.path) }.
-        map { |entry| postprocess(entry, &block) }.
-        force.
-        compact.
-        each { |path, line, column, message| warn(message, file: path, line: line) }
+      parser.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.
+    # @deprecated Use {#scan} with block instead.
     #
-    # @return [Proc]
+    # Convenience method to set {#postprocessor} with block.
     #
-    # @example Ignore all warnings from files matching regular expression
-    #   periphery.process_warnings do |path, line, column, message|
-    #     !path.match(/.*\/generated\.swift/)
-    #   end
+    # @return [Proc]
     def process_warnings(&block)
+      deprecate_in_favor_of_scan
       @postprocessor = block
     end
 
+    def postprocessor=(postprocessor)
+      deprecate_in_favor_of_scan
+      @postprocessor = postprocessor
+    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.to_h { |rename| [rename[:before], rename[:after]] }
-      post_rename_modified_files = git.modified_files.map { |modified_file| renamed_files_hash[modified_file] || modified_file }
+      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
-        if block.call(entry)
-          [entry.path, entry.line, entry.column, entry.message]
-        end
+        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
+
+    def deprecate_in_favor_of_scan
+      caller_method_name = caller(1, 1)[0].sub(/.*`(.*)'.*/, '\1')
+      caller_location = caller_locations(2, 1)[0]
+      message = [
+        "`#{self.class}##{caller_method_name}` is deprecated; use `#{self.class}#scan` with block instead. ",
+        'It will be removed from future releases.'
+      ].join
+      location_message = "#{self.class}##{caller_method_name} called from #{caller_location}"
+      Kernel.warn("NOTE: #{message}\n#{location_message}")
+      issue_reference = 'See manicmaniac/danger-periphery#37 for detail.'
+      warn("#{message}\n#{issue_reference}", file: caller_location.path, line: caller_location.lineno)
+    end
+
+    def parser
+      case @format
+      when :checkstyle
+        Periphery::CheckstyleParser.new
+      when :json
+        Periphery::JsonParser.new
       else
-        result = @postprocessor.call(entry.path, entry.line, entry.column, entry.message)
-        if !result
-          nil
-        elsif result.kind_of?(TrueClass)
-          [entry.path, entry.line, entry.column, entry.message]
-        elsif result.kind_of?(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
+        raise "#{@format} is unsupported"
       end
     end
   end

data/lib/periphery/checkstyle_parser.rb

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
 
-require "pathname"
-require "periphery/scan_result"
-require "rexml/parsers/baseparser"
-require "rexml/parsers/streamparser"
-require "rexml/streamlistener"
+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
+    class Listener # :nodoc:
       include REXML::StreamListener
 
       attr_reader :results
@@ -20,22 +21,17 @@ module Periphery
 
       def tag_start(name, attrs)
         case name
-        when "file"
-          @current_file = relative_path(attrs["name"])
-        when "error"
+        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"]
-            )
+            @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"
+        @current_file = nil if name == 'file'
       end
 
       private

data/lib/periphery/json_parser.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'periphery/scan_result'
+
+module Periphery
+  # Parses JSON formatted output produced by Periphery with +--format=json+ option.
+  class JsonParser
+    def parse(string)
+      JSON.parse(string).map do |entry|
+        path, line, column = parse_location(entry['location'])
+        message = compose_message(*entry.slice('name', 'kind', 'hints').values)
+        ScanResult.new(path, line, column, message)
+      end
+    end
+
+    private
+
+    def relative_path(path, base = Pathname.getwd)
+      Pathname.new(path).relative_path_from(base).to_s
+    end
+
+    # Parses a string like '/path/to/file.swift:19:10'
+    def parse_location(location)
+      location.scan(/^(.+):(\d+):(\d+)$/) do |path, line, column|
+        return [relative_path(path), line.to_i, column.to_i]
+      end
+      raise ArgumentError, "#{location} is not in a valid format"
+    end
+
+    def compose_message(name, kind, hints)
+      return 'unused' unless name
+
+      # Assumes hints contains only one item.
+      # https://github.com/peripheryapp/periphery/blob/2.9.0/Sources/Frontend/Formatters/JsonFormatter.swift#L27
+      # https://github.com/peripheryapp/periphery/blob/2.9.0/Sources/Frontend/Formatters/JsonFormatter.swift#L42
+      hint = hints[0]
+      +"#{display_name(kind).capitalize} '#{name}' #{describe_hint(hint)}"
+    end
+
+    def display_name(kind)
+      case kind
+      when 'enumelement' then 'enum case'
+      when 'function.constructor' then 'initializer'
+      when 'var.parameter' then 'parameter'
+      when 'generic_type_param' then 'generic type parameter'
+      when nil then ''
+      else kind.start_with?('var') ? 'property' : kind.split('.', 2)[0]
+      end
+    end
+
+    def describe_hint(hint)
+      case hint
+      when 'unused' then 'is unused'
+      when 'assignOnlyProperty' then 'is assigned, but never used'
+      when 'redundantProtocol' then "is redundant as it's never used as an existential type"
+      when 'redundantConformance' then 'conformance is redundant'
+      # FIXME: There's no information about the name of module in JSON output,
+      #        unlike other formatters can output `outside of FooModule`.
+      #        This is known problem and may be fixed in future Periphery's release.
+      #        See the status of https://github.com/peripheryapp/periphery/pull/519
+      when 'redundantPublicAccessibility' then 'is declared public, but not used outside of the module'
+      else ''
+      end
+    end
+  end
+end

data/lib/periphery/runner.rb

@@ -1,35 +1,32 @@
 # 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)
-      if status.success?
-        stdout
-      else
-        raise "error: #{arguments} exited with status code #{status.exitstatus}. #{stderr}" unless status.success?
-      end
+      raise "error: #{arguments} exited with status code #{status.exitstatus}. #{stderr}" unless status.success?
+
+      stdout
     end
 
     def scan_arguments(options)
-      options.
-        lazy.
-        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&.to_s] }.
-        force.
-        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.rb

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

data/lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-periphery
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Ryosuke Ito
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-22 00:00:00.000000000 Z
+date: 2022-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -27,39 +27,17 @@ 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
-- Gemfile.lock
-- 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/json_parser.rb
 - lib/periphery/runner.rb
 - lib/periphery/scan_result.rb
 - lib/version.rb
-- spec/danger_plugin_spec.rb
-- spec/periphery/checkstyle_parser_spec.rb
-- spec/periphery/runner_spec.rb
-- spec/spec_helper.rb
-- spec/support/fixtures/github_pr.json
-- spec/support/fixtures/mock-periphery
-- spec/support/fixtures/test.xcodeproj/project.pbxproj
-- spec/support/fixtures/test/main.swift
 homepage: https://github.com/manicmaniac/danger-periphery
 licenses:
 - MIT
@@ -80,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A Danger plugin to detect unused codes.

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,9 +0,0 @@
-.DS_Store
-.idea/
-.yardoc
-/tmp
-bin/lib_InternalSwiftSyntaxParser.dylib
-bin/periphery
-pkg
-project.xcworkspace
-xcuserdata

data/.rspec

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