danger-periphery 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15302ed92faf0a3230ddcb167fe3db0ae2e8c1a51d6551d85a4c2cc37c760dd4
-  data.tar.gz: 18880214efa7cb5a29ee9b6872688a6eeb19d805e07cad6c445afeeb24f4cad2
+  metadata.gz: 1232912ce0ad696e3ea2b34b383fbc70831ccbf0a4294673a5a122c37909d677
+  data.tar.gz: 36c2fd6ab1f814f209cb0843db05e3d6c4bcad47360d6695db4968954048590e
 SHA512:
-  metadata.gz: 5e33a6b9fa62d733004fb63337fdff4973dd3b38d40a096db0b84a1249bc7789a3612a99a88d31020e22dd6494c3b7d3c953fe721be16347e825a58e8900a177
-  data.tar.gz: 47a37136e81dc9c4b6fc6b3331e476810e4520503c7fd062714363675926c51525502dc58ef2d610b890ee0d73d731d8ac87910bd8e6ab2f051f47c980b4ac88
+  metadata.gz: 67cbcfbbd827ab1f276d5f0f42728cea8a38a018495bbedefd62b441fae2b6e8fd92358269fde43d2d1c8d4e14494f5c3a510dc1c51473a8ac869375d4992f25
+  data.tar.gz: 68d40960394c7cba16e2ae6080803b493995641548bfaa31d3f5f0b32761cb47448863c063a7ae9be6b13283682ff6c5c9d4cece0fb200dd33bb0ca17c09dac8

data/lib/danger_plugin.rb

@@ -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,17 +38,22 @@ 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 }
+      @format = :checkstyle
     end
 
     # Scans Swift files.
@@ -54,7 +61,7 @@ module Danger
     #
     # @example Ignore all warnings from files matching regular expression
     #   periphery.scan do |violation|
-    #     ! violation.path.match(/.*\/generated\.swift/)
+    #     !violation.path.match(/.*\/generated\.swift/)
     #   end
     #
     # @param [Hash] options Options passed to Periphery with the following translation rules.
@@ -71,10 +78,10 @@ module Danger
     #                       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).each do |entry|
+      parser.parse(output).each do |entry|
         next unless files.include?(entry.path)
 
         result = postprocess(entry, &block)
@@ -85,18 +92,21 @@ module Danger
       end
     end
 
+    # @deprecated Use {#scan} with block instead.
+    #
     # 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)
+      deprecate_in_favor_of_scan
       @postprocessor = block
     end
 
+    def postprocessor=(postprocessor)
+      deprecate_in_favor_of_scan
+      @postprocessor = postprocessor
+    end
+
     private
 
     def files_in_diff
@@ -132,5 +142,29 @@ module Danger
         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
+        raise "#{@format} is unsupported"
+      end
+    end
   end
 end

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.rb

@@ -2,3 +2,4 @@
 
 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.1'
+  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.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Ryosuke Ito
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-29 00:00:00.000000000 Z
+date: 2022-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -34,6 +34,7 @@ files:
 - 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
@@ -57,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.