danger-periphery 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1232912ce0ad696e3ea2b34b383fbc70831ccbf0a4294673a5a122c37909d677
-  data.tar.gz: 36c2fd6ab1f814f209cb0843db05e3d6c4bcad47360d6695db4968954048590e
+  metadata.gz: 9c9c3f228ac9ddf39d67684faca46dfaf969f9576a566a045b2ef0d50a714473
+  data.tar.gz: 7c60528ef9459c67a57c74566f6c76beb8871e04557afde65c8d8a05ffc81db1
 SHA512:
-  metadata.gz: 67cbcfbbd827ab1f276d5f0f42728cea8a38a018495bbedefd62b441fae2b6e8fd92358269fde43d2d1c8d4e14494f5c3a510dc1c51473a8ac869375d4992f25
-  data.tar.gz: 68d40960394c7cba16e2ae6080803b493995641548bfaa31d3f5f0b32761cb47448863c063a7ae9be6b13283682ff6c5c9d4cece0fb200dd33bb0ca17c09dac8
+  metadata.gz: 5f51ab7485b787644820d4df9a87a4b9f2d52be587792c03271a9f2defe8710697f1bc10578fa6ecf49bd2bc596807e79606c6ec888851bf6a8833c9a18a24a5
+  data.tar.gz: 92db186ee32f74f37d38b99787338bfae9101b5b4971f41a051a3bf0e19f2b888db542a735ecb6c9fefe87d7bd88f40d33df1703b9b8782b08c8460bda9f103a

data/lib/danger_plugin.rb

@@ -102,11 +102,42 @@ module Danger
       @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

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

@@ -9,7 +9,7 @@ module Periphery
     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)
+        message = compose_message(*entry.slice('name', 'kind', 'hints', 'modules').values)
         ScanResult.new(path, line, column, message)
       end
     end
@@ -28,14 +28,14 @@ module Periphery
       raise ArgumentError, "#{location} is not in a valid format"
     end
 
-    def compose_message(name, kind, hints)
+    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)}"
+      +"#{display_name(kind).capitalize} '#{name}' #{describe_hint(hint, modules)}"
     end
 
     def display_name(kind)
@@ -49,17 +49,13 @@ module Periphery
       end
     end
 
-    def describe_hint(hint)
+    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'
-      # 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'
+      when 'redundantPublicAccessibility' then "is declared public, but not used outside of #{modules.join(', ')}"
       else ''
       end
     end

data/lib/periphery.rb

@@ -1,5 +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.2'
+  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.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Ryosuke Ito
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-13 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,7 @@ 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
@@ -43,7 +58,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -51,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.1.2
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: A Danger plugin to detect unused codes.
 test_files: []