danger-periphery 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8478fb86f4d5952f88ee7772f352049288bbc5c21f2f5d452ab7b37389b561ec
+  data.tar.gz: 63c976e46da5ad41bd5797adb3f1ddc83edd5c09f8d607c043757924b3b32cad
+SHA512:
+  metadata.gz: aeae221bc8e42918a500eb3050b3bd44451a4fa4af5e2e42a77e252a64cfc17ca7213b455af830d26c1c001a0250a2af4e532303b1bce8c5e45dd2b02c817dfb
+  data.tar.gz: d07fd15ea7105b6fbb875d628771a70c557bbd4066246712e26e5f1599d80d6d42e078d61b22e3c0c30c677105c0da317596a2d3a60595b3f16355193a8bed48

data/.github/workflows/lint.yml

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,10 @@
+.DS_Store
+.idea/
+.yardoc
+/tmp
+Gemfile.lock
+bin/lib_InternalSwiftSyntaxParser.dylib
+bin/periphery
+pkg
+project.xcworkspace
+xcuserdata

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,281 @@
+# Defaults can be found here: https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+
+# If you don't like these settings, just delete this file :)
+
+AllCops:
+  TargetRubyVersion: 2.6
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  Enabled: true
+
+# kind_of? is a good way to check a type
+Style/ClassCheck:
+  EnforcedStyle: kind_of?
+
+# specs sometimes have useless assignments, which is fine
+Lint/UselessAssignment:
+  Exclude:
+    - '**/spec/**/*'
+
+# We could potentially enable the 2 below:
+Layout/FirstHashElementIndentation:
+  Enabled: false
+
+Layout/HashAlignment:
+  Enabled: false
+
+# HoundCI doesn't like this rule
+Layout/DotPosition:
+  Enabled: false
+
+# We allow !! as it's an easy way to convert ot boolean
+Style/DoubleNegation:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+# We want to allow class Fastlane::Class
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 60
+
+# The %w might be confusing for new users
+Style/WordArray:
+  MinSize: 19
+
+# raise and fail are both okay
+Style/SignalException:
+  Enabled: false
+
+# Better too much 'return' than one missing
+Style/RedundantReturn:
+  Enabled: false
+
+# Having if in the same line might not always be good
+Style/IfUnlessModifier:
+  Enabled: false
+
+# and and or is okay
+Style/AndOr:
+  Enabled: false
+
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 350
+
+Metrics/CyclomaticComplexity:
+  Max: 17
+
+# Configuration parameters: AllowURI, URISchemes.
+Layout/LineLength:
+  Max: 370
+
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 18
+
+# Sometimes it's easier to read without guards
+Style/GuardClause:
+  Enabled: false
+
+# something = if something_else
+# that's confusing
+Style/ConditionalAssignment:
+  Enabled: false
+
+# Better to have too much self than missing a self
+Style/RedundantSelf:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 60
+
+# We're not there yet
+Style/Documentation:
+  Enabled: false
+
+# Adds complexity
+Style/IfInsideElse:
+  Enabled: false
+
+# danger specific
+
+Style/BlockComments:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+# FIXME: 25
+Metrics/BlockLength:
+  Max: 345
+  Exclude:
+    - "**/*_spec.rb"
+
+Style/MixinGrouping:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false
+
+Layout/HeredocIndentation:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    "%":  ()
+    "%i": ()
+    "%q": ()
+    "%Q": ()
+    "%r": "{}"
+    "%s": ()
+    "%w": ()
+    "%W": ()
+    "%x": ()
+
+Security/YAMLLoad:
+  Enabled: false
+
+Gemspec/DateAssignment:
+  Enabled: true
+
+Layout/LineEndStringConcatenationIndentation:
+  Enabled: true
+
+Layout/SpaceBeforeBrackets:
+  Enabled: true
+
+Lint/AmbiguousAssignment:
+  Enabled: true
+
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: true
+
+Lint/AmbiguousRange:
+  Enabled: true
+
+Lint/DeprecatedConstants:
+  Enabled: true
+
+Lint/DuplicateBranch:
+  Enabled: true
+
+Lint/DuplicateRegexpCharacterClassElement:
+  Enabled: true
+
+Lint/EmptyBlock:
+  Enabled: true
+
+Lint/EmptyClass:
+  Enabled: true
+
+Lint/EmptyInPattern:
+  Enabled: true
+
+Lint/IncompatibleIoSelectWithFiberScheduler:
+  Enabled: true
+
+Lint/LambdaWithoutLiteralBlock:
+  Enabled: true
+
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: true
+
+Lint/NumberedParameterAssignment:
+  Enabled: true
+
+Lint/OrAssignmentToConstant:
+  Enabled: true
+
+Lint/RedundantDirGlobSort:
+  Enabled: true
+
+Lint/RequireRelativeSelfPath:
+  Enabled: true
+
+Lint/SymbolConversion:
+  Enabled: true
+
+Lint/ToEnumArguments:
+  Enabled: true
+
+Lint/TripleQuotes:
+  Enabled: true
+
+Lint/UnexpectedBlockArity:
+  Enabled: true
+
+Lint/UnmodifiedReduceAccumulator:
+  Enabled: true
+
+Security/IoMethods:
+  Enabled: true
+
+Style/ArgumentsForwarding:
+  Enabled: true
+
+Style/CollectionCompact:
+  Enabled: true
+
+Style/DocumentDynamicEvalDefinition:
+  Enabled: true
+
+Style/EndlessMethod:
+  Enabled: true
+
+Style/HashConversion:
+  Enabled: true
+
+Style/HashExcept:
+  Enabled: true
+
+Style/IfWithBooleanLiteralBranches:
+  Enabled: true
+
+Style/InPatternThen:
+  Enabled: true
+
+Style/MultilineInPatternThen:
+  Enabled: true
+
+Style/NegatedIfElseCondition:
+  Enabled: true
+
+Style/NilLambda:
+  Enabled: true
+
+Style/NumberedParameters:
+  Enabled: true
+
+Style/NumberedParametersLimit:
+  Enabled: true
+
+Style/QuotedSymbols:
+  Enabled: true
+
+Style/RedundantArgument:
+  Enabled: true
+
+Style/RedundantSelfAssignmentBranch:
+  Enabled: true
+
+Style/SelectByRegexp:
+  Enabled: true
+
+Style/StringChars:
+  Enabled: true
+
+Style/SwapValues:
+  Enabled: true

data/Dangerfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+rubocop.lint inline_comment: true
+
+periphery.binary_path = "bin/periphery"
+periphery.scan(
+  project: "spec/support/fixtures/test.xcodeproj",
+  schemes: "test",
+  targets: "test"
+)

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in danger-periphery.gemspec
+gemspec
+
+gem "bundler", "~> 2.0"
+gem "danger"
+gem "danger-rubocop"
+gem "guard", "~> 2.14"
+gem "guard-rspec", "~> 4.7"
+gem "listen", "3.0.7"
+gem "pry"
+gem "rake", "~> 10.0"
+gem "rspec", "~> 3.4"
+gem "rubocop"
+gem "yard"

data/Guardfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# A guardfile for making Danger Plugins
+# For more info see https://github.com/guard/guard#readme
+
+# To run, use `bundle exec guard`.
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2021 Ryosuke Ito <rito.0305@gmail.com>
+
+MIT License
+
+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,42 @@
+# danger-periphery
+
+A Danger plugin to detect unused codes.
+
+## Installation
+
+You need to install [Periphery](https://github.com/peripheryapp/periphery) beforehand.
+
+Currently `danger-periphery` is in early development stage so it's not published to rubygems.org yet.
+
+Write the following code in your Gemfile.
+
+    gem "danger-periphery", git: "https://github.com/manicmaniac/danger-periphery.git"
+
+## Usage
+
+If you already have `.periphery.yml`, the easiest way to use is just add this to your Dangerfile.
+
+    periphery.scan
+
+You can specify the path to executable in this way.
+
+    periphery.binary_path = "bin/periphery"
+
+You can pass command line options to `periphery.scan` like the following.
+See `periphery scan -h` for available options.
+
+    periphery.scan(
+      project: "Foo.xcodeproj",
+      schemes: ["foo", "bar"],
+      targets: "foo",
+      clean_build: true
+    )
+
+## Development
+
+1. Clone this repo
+2. Run `bundle install` to setup dependencies.
+3. Run `bin/download_periphery` to install Periphery.
+4. Run `bundle exec rake spec` to run the tests.
+5. Use `bundle exec guard` to automatically have tests run as you make changes.
+6. Make your changes.

data/Rakefile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:specs)
+
+task default: :specs
+
+task :spec do
+  Rake::Task["specs"].invoke
+  Rake::Task["rubocop"].invoke
+  Rake::Task["spec_docs"].invoke
+end
+
+desc "Run RuboCop on the lib/specs directory"
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ["lib/**/*.rb", "spec/**/*.rb"]
+end
+
+desc "Ensure that the plugin passes `danger plugins lint`"
+task :spec_docs do
+  sh "bundle exec danger plugins lint"
+end

data/bin/download_periphery

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+cd "$(dirname "$0")"
+version="2.8.1"
+curl -Lo periphery.zip "https://github.com/peripheryapp/periphery/releases/download/$version/periphery-v$version.zip"
+unzip periphery.zip
+rm periphery.zip LICENSE.md

data/danger-periphery.gemspec

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "version"
+
+Gem::Specification.new do |spec|
+  spec.name = "danger-periphery"
+  spec.version = DangerPeriphery::VERSION
+  spec.authors = ["Ryosuke Ito"]
+  spec.email = ["rito.0305@gmail.com"]
+  spec.description = "A Danger plugin to detect unused codes."
+  spec.summary = spec.description
+  spec.homepage = "https://github.com/manicmaniac/danger-periphery"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.3.0"
+
+  spec.files = `git ls-files`.split($/)
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "danger-plugin-api", "~> 1.0"
+end

data/lib/danger_plugin.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "periphery/runner"
+require "periphery/scan_log_parser"
+
+module Danger
+  # Analyze Swift files and detect unused codes in your project.
+  # This is done using [Periphery](https://github.com/peripheryapp/periphery).
+  #
+  # @example Specifying options to Periphery.
+  #
+  #          periphery.scan(
+  #            project: "Foo.xcodeproj"
+  #            schemes: ["foo", "bar"],
+  #            targets: "foo",
+  #            clean_build: true
+  #          )
+  #
+  # @see manicmaniac/danger-periphery
+  # @tags swift
+  class DangerPeriphery < Plugin
+    # Path to Periphery executable.
+    # By default the value is nil and the executable is searched from $PATH.
+    # @return [String]
+    attr_accessor :binary_path
+
+    # Scans Swift files.
+    # Raises an error when Periphery executable is not found.
+    #
+    # @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.
+    # @return [void]
+    def scan(**options)
+      output = Periphery::Runner.new(binary_path).scan(options.merge(disable_update_check: true, format: "xcode", quiet: true))
+      entries = Periphery::ScanLogParser.new.parse(output)
+      files = files_in_diff
+      entries.
+        select { |entry| files.include?(entry.path) }.
+        each { |entry| warn(entry.message, file: entry.path, line: entry.line) }
+    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.map { |rename| [rename[:before], rename[:after]] }.to_h
+      post_rename_modified_files = git.modified_files.map { |modified_file| renamed_files_hash[modified_file] || modified_file }
+      (post_rename_modified_files - git.deleted_files) + git.added_files
+    end
+  end
+end

data/lib/periphery/runner.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "open3"
+
+module Periphery
+  class Runner
+    attr_reader :binary_path
+
+    def initialize(binary_path)
+      @binary_path = binary_path || "periphery"
+    end
+
+    def scan(options)
+      arguments = [binary_path, "scan"] + scan_arguments(options)
+      stdout, stderr, status = Open3.capture3(*arguments)
+      raise "error: #{arguments} exited with status code #{status.exitstatus}. #{stderr}" unless status.success?
+
+      stdout
+    end
+
+    def scan_arguments(options)
+      options.
+        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] }.
+        flatten.
+        compact
+    end
+  end
+end

data/lib/periphery/scan_log_parser.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Periphery
+  class ScanLogParser
+    def parse(string)
+      string.lines.map do |line|
+        match = line.match(/^(?<path>.+):(?<line>\d+):(?<column>\d+): warning: (?<message>.*)\n?$/)
+        ScanLogEntry.new(relative_path(match[:path]), match[:line].to_i, match[:column].to_i, match[:message]) if match
+      end.compact
+    end
+
+    private
+
+    def relative_path(path, base = Pathname.getwd)
+      Pathname.new(path).relative_path_from(base).to_s
+    end
+  end
+
+  ScanLogEntry = Struct.new(:path, :line, :column, :message)
+end

data/lib/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DangerPeriphery
+  VERSION = "0.0.1"
+end