danger-periphery 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15302ed92faf0a3230ddcb167fe3db0ae2e8c1a51d6551d85a4c2cc37c760dd4
-  data.tar.gz: 18880214efa7cb5a29ee9b6872688a6eeb19d805e07cad6c445afeeb24f4cad2
+  metadata.gz: 9c9c3f228ac9ddf39d67684faca46dfaf969f9576a566a045b2ef0d50a714473
+  data.tar.gz: 7c60528ef9459c67a57c74566f6c76beb8871e04557afde65c8d8a05ffc81db1
 SHA512:
-  metadata.gz: 5e33a6b9fa62d733004fb63337fdff4973dd3b38d40a096db0b84a1249bc7789a3612a99a88d31020e22dd6494c3b7d3c953fe721be16347e825a58e8900a177
-  data.tar.gz: 47a37136e81dc9c4b6fc6b3331e476810e4520503c7fd062714363675926c51525502dc58ef2d610b890ee0d73d731d8ac87910bd8e6ab2f051f47c980b4ac88
+  metadata.gz: 5f51ab7485b787644820d4df9a87a4b9f2d52be587792c03271a9f2defe8710697f1bc10578fa6ecf49bd2bc596807e79606c6ec888851bf6a8833c9a18a24a5
+  data.tar.gz: 92db186ee32f74f37d38b99787338bfae9101b5b4971f41a051a3bf0e19f2b888db542a735ecb6c9fefe87d7bd88f40d33df1703b9b8782b08c8460bda9f103a

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,52 @@ 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
 
+    # @deprecated Use {#scan} with block instead.
+    #
+    # A block to manipulate each warning before it is displayed.
+    #
+    # @param [Proc] postprocessor Block to process each warning just before showing it.
+    #                             The Proc is called like `postprocessor(path, line, column, message)`
+    #                             where `path` is a String that indicates the file path the warning points out,
+    #                             `line` and `column` are Integers that indicates the location in the file,
+    #                             `message` is a String message body of the warning.
+    #                             The Proc returns either of the following:
+    #                             1. an Array contains `path`, `line`, `column`, `message` in this order.
+    #                             2. true
+    #                             3. false or nil
+    #                             If it returns falsy value, the warning will be suppressed.
+    #                             If it returns `true`, the warning will be displayed as-is.
+    #                             Otherwise it returns an Array, the warning is newly created by the returned array
+    #                             and displayed.
+    # @return [void]
+    def postprocessor=(postprocessor)
+      deprecate_in_favor_of_scan
+      @postprocessor = postprocessor
+    end
+
+    # Download and install Periphery executable binary.
+    #
+    # @param [String, Symbol] version The version of Periphery you want to install.
+    #                                 `:latest` is treated as special keyword that specifies the latest version.
+    # @param [String] path            The path to install Periphery including the filename itself.
+    # @param [Boolean] force          If `true`, an existing file will be overwritten. Otherwise an error occurs.
+    # @return [void]
+    def install(version: :latest, path: 'periphery', force: false)
+      installer = Periphery::Installer.new(version)
+      installer.install(path, force: force)
+      self.binary_path = File.absolute_path(path)
+    end
+
     private
 
     def files_in_diff
@@ -132,5 +173,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/installer.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'net/http'
+require 'open-uri'
+require 'rubygems/version'
+require 'zip'
+
+module Periphery
+  # Downloads Periphery binary executable and install it to the specified path.
+  class Installer
+    def initialize(version_spec)
+      @version_spec = version_spec
+    end
+
+    def install(dest_path, force: false)
+      URI.parse(download_url).open do |src|
+        entry = Zip::File.open_buffer(src).get_entry('periphery')
+        entry.restore_permissions = true
+        FileUtils.rm_f(dest_path) if force
+        entry.extract(dest_path)
+      end
+    end
+
+    def version
+      @version ||= @version_spec == :latest ? fetch_latest_version : @version_spec
+    end
+
+    private
+
+    def download_url
+      if Gem::Version.new(version) >= Gem::Version.new('2.14.0')
+        "https://github.com/peripheryapp/periphery/releases/download/#{version}/periphery-#{version}.zip"
+      else
+        "https://github.com/peripheryapp/periphery/releases/download/#{version}/periphery-v#{version}.zip"
+      end
+    end
+
+    def fetch_latest_version
+      Net::HTTP.start('github.com', port: 443, use_ssl: true) do |http|
+        response = http.head('/peripheryapp/periphery/releases/latest')
+        URI.parse(response['location']).path.split('/').last
+      end
+    end
+  end
+end

data/lib/periphery/json_parser.rb

@@ -0,0 +1,63 @@
+# 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', 'modules').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, modules = [])
+      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, modules)}"
+    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, modules)
+      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'
+      when 'redundantPublicAccessibility' then "is declared public, but not used outside of #{modules.join(', ')}"
+      else ''
+      end
+    end
+  end
+end

data/lib/periphery.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
 
+require 'periphery/installer'
 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.3'
 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.3
 platform: ruby
 authors:
 - Ryosuke Ito
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-29 00:00:00.000000000 Z
+date: 2023-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: A Danger plugin to detect unused codes.
 email:
 - rito.0305@gmail.com
@@ -34,6 +48,8 @@ files:
 - lib/danger_plugin.rb
 - lib/periphery.rb
 - lib/periphery/checkstyle_parser.rb
+- lib/periphery/installer.rb
+- lib/periphery/json_parser.rb
 - lib/periphery/runner.rb
 - lib/periphery/scan_result.rb
 - lib/version.rb
@@ -42,7 +58,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -50,15 +66,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: A Danger plugin to detect unused codes.
 test_files: []