fastlane-plugin-periphery 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 193810e605fc8f7f7f7285417cab60d865e5654b33c0e773ef616680a7303dfa
+  data.tar.gz: 4a0bdb31f320deee68c070247b9387f8ca80f9ef77ca98e42a019eb1815d150d
+SHA512:
+  metadata.gz: 7b986b0b8bb0269d3ce1c090447ce07cd06273099ae9e54b4bd4aa804421457580ae5a186ceec22b319d252667844886c2167b7185257cbe2abfdf148f66ed31
+  data.tar.gz: 80ebe6ecb9e9bf1bfbced75300d54f8368996eb73925992b77cb5c8bbe9baf4bd2d124c7725236284caafff9acb462e9579f5b93623672bd00f9795cd4101df8

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Liam Nichols <liam.nichols.ln@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# periphery plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-periphery)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-periphery`, add it to your project by running:
+
+```bash
+fastlane add_plugin periphery
+```
+
+## About periphery
+
+Identifies unused code in Swift projects using Periphery
+
+**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+
+**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/periphery.rb

@@ -0,0 +1,13 @@
+require 'fastlane/plugin/periphery/version'
+
+module Fastlane
+  module Periphery
+    def self.all_classes
+      Dir[File.expand_path('**/actions/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+Fastlane::Periphery.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/periphery/actions/periphery_action.rb

@@ -0,0 +1,188 @@
+require 'fastlane/action'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      PERIPHERY_RESULTS = :PERIPHERY_RESULTS
+    end
+
+    class PeripheryAction < Action
+      # https://github.com/peripheryapp/periphery/blob/master/Sources/Frontend/Formatters/JsonFormatter.swift
+      class Result
+        attr_reader :kind, :name, :modifiers, :attributes, :accessibility, :ids, :hints, :location
+
+        def initialize(raw)
+          @kind = raw['kind']
+          @name = raw['name']
+          @modifiers = raw['modifiers']
+          @attributes = raw['attributes']
+          @accessibility = raw['accessibility']
+          @ids = raw['ids']
+          @hints = raw['hints']
+          @location = raw['location']
+        end
+      end
+
+      class Runner
+        attr_reader :executable, :config, :skip_build, :index_store_path, :results
+
+        def expand_and_verify_path(path)
+          return nil if path.nil?
+
+          path = File.expand_path(path)
+          UI.user_error!("File or directory does not exist at path '#{path}'") unless File.exist?(path)
+
+          path
+        end
+
+        def initialize(params)
+          @executable = params[:executable] || 'periphery'
+          @config = expand_and_verify_path(params[:config])
+          @skip_build = params[:skip_build]
+          @index_store_path = expand_and_verify_path(params[:index_store_path])
+          @results = nil
+        end
+
+        def run
+          verify_executable
+          perform_scan
+          print_summary
+          results
+        end
+
+        def verify_executable
+          version = Actions.sh_control_output([executable, 'version'], print_command_output: false).strip!
+          UI.message("Using periphery version #{version}")
+        rescue
+          UI.user_error!("Unable to invoke periphery executable '#{executable}'. Is it installed?")
+        end
+
+        def perform_scan
+          # Run the periphery scan command and collect the output
+          UI.message("Performing scan. This might take a few moments...")
+          output = Actions.sh_control_output(scan_command, print_command_output: false, error_callback: lambda { |result|
+            UI.error(result)
+            UI.user_error!("The scan could not be completed successfully")
+          })
+
+          # Decode the JSON output and assign to the property/lane_context
+          @results = JSON.parse(output).map { |raw| Result.new(raw) }
+          Actions.lane_context[SharedValues::PERIPHERY_RESULTS] = results
+        end
+
+        def scan_command
+          # Build up the initial part of the command
+          command = [
+            executable,
+            'scan',
+            '--disable-update-check',
+            '--format',
+            'json'
+          ]
+
+          # Specify the path to the config if it was provided
+          if config
+            command << '--config'
+            command << config
+          end
+
+          # Support --skip-build mode
+          if skip_build || !index_store_path.nil?
+            command << '--skip-build'
+            command << '--index-store-path'
+            command << resolve_index_store_path
+          end
+
+          # Return the complete array of arguments
+          command
+        end
+
+        def resolve_index_store_path
+          # If it was explicitly specified, return the path to the index store
+          return index_store_path unless index_store_path.nil?
+
+          # Alternatively, use the derived data path defined by a prior action
+          derived_data_path = find_derived_data_path
+          return File.join(derived_data_path, 'Index', 'DataStore') unless derived_data_path.nil?
+
+          # Fail if we couldn't automatically resolve the path
+          UI.user_error!("The index store path could not be resolved. Either specify it using the index_store_path argument or provide a path to derived data when using build_app or xcodebuild actions.")
+        end
+
+        def find_derived_data_path
+          # These values are set by other actions that may have been used to build an app previously
+          candidates = [
+            Actions.lane_context[SharedValues::SCAN_DERIVED_DATA_PATH],
+            Actions.lane_context[SharedValues::XCODEBUILD_DERIVED_DATA_PATH]
+          ]
+
+          # Return the first candidate where the value was set and the directory still exists
+          candidates.find { |x| !x.nil? && File.exist?(x) }
+        end
+
+        def print_summary
+          # Group the results by their first hint (assume there is only one).
+          grouped_results = results
+                            .group_by { |result| result.hints.first }
+                            .transform_values(&:count)
+
+          # Print the counts in a table
+          FastlaneCore::PrintTable.print_values(config: grouped_results, title: 'Summary of Results') unless Helper.test?
+        end
+      end
+
+      def self.run(params)
+        require 'json'
+
+        Runner.new(params).run
+      end
+
+      def self.description
+        "Identifies unused code in Swift projects using Periphery"
+      end
+
+      def self.authors
+        ["Liam Nichols"]
+      end
+
+      def self.return_value
+        "Output of the command parsed from JSON into an array of Result objects"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :executable,
+                                       env_name: "PERIPHERY_EXECUTABLE",
+                                       description: "Path to the `periphery` executable on your machine",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :config,
+                                       env_name: "PERIPHERY_CONFIG",
+                                       description: "Path to configuration file",
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :skip_build,
+                                       env_name: "PERIPHERY_SKIP_BUILD",
+                                       description: "Skip the project build step",
+                                       optional: true,
+                                       default_value: false,
+                                       type: Boolean),
+          FastlaneCore::ConfigItem.new(key: :index_store_path,
+                                       env_name: "PERIPHERY_INDEX_STORE_PATH",
+                                       description: "Path to index store to use",
+                                       optional: true,
+                                       type: String)
+        ]
+      end
+
+      def self.output
+        [
+          ["PERIPHERY_RESULTS", "The output of periphery decoded into an array of Result objects."]
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/periphery/version.rb

@@ -0,0 +1,5 @@
+module Fastlane
+  module Periphery
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-periphery
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Liam Nichols
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.156.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.156.1
+description: 
+email: liam.nichols.ln@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/periphery.rb
+- lib/fastlane/plugin/periphery/actions/periphery_action.rb
+- lib/fastlane/plugin/periphery/version.rb
+homepage: https://github.com/liamnichols/fastlane-plugin-periphery
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Identifies unused code in Swift projects using Periphery
+test_files: []