danger-periphery 0.2.0 → 0.2.1

data/.rubocop.yml

@@ -1,338 +0,0 @@
-# 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/BlockForwarding:
-  Enabled: true
-
-Naming/FileName:
-  Enabled: false
-
-Layout/HeredocIndentation:
-  Enabled: false
-
-Style/SpecialGlobalVars:
-  Enabled: false
-
-Style/PercentLiteralDelimiters:
-  PreferredDelimiters:
-    "%":  ()
-    "%i": ()
-    "%q": ()
-    "%Q": ()
-    "%r": "{}"
-    "%s": ()
-    "%w": ()
-    "%W": ()
-    "%x": ()
-
-Security/CompoundHash:
-  Enabled: true
-
-Security/YAMLLoad:
-  Enabled: false
-
-Gemspec/DeprecatedAttributeAssignment:
-  Enabled: true
-
-Gemspec/RequireMFA:
-  Enabled: true
-
-Layout/LineContinuationLeadingSpace:
-  Enabled: true
-
-Layout/LineContinuationSpacing:
-  Enabled: true
-
-Layout/LineEndStringConcatenationIndentation:
-  Enabled: true
-
-Layout/SpaceBeforeBrackets:
-  Enabled: true
-
-Lint/AmbiguousAssignment:
-  Enabled: true
-
-Lint/AmbiguousOperatorPrecedence:
-  Enabled: true
-
-Lint/AmbiguousRange:
-  Enabled: true
-
-Lint/ConstantOverwrittenInRescue:
-  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/NonAtomicFileOperation:
-  Enabled: true
-
-Lint/NoReturnInBeginEndBlocks:
-  Enabled: true
-
-Lint/NumberedParameterAssignment:
-  Enabled: true
-
-Lint/OrAssignmentToConstant:
-  Enabled: true
-
-Lint/RedundantDirGlobSort:
-  Enabled: true
-
-Lint/RefinementImportMethods:
-  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
-
-Lint/UselessRuby2Keywords:
-  Enabled: true
-
-Security/IoMethods:
-  Enabled: true
-
-Style/ArgumentsForwarding:
-  Enabled: true
-
-Style/CollectionCompact:
-  Enabled: true
-
-Style/DocumentDynamicEvalDefinition:
-  Enabled: true
-
-Style/EndlessMethod:
-  Enabled: true
-
-Style/EnvHome:
-  Enabled: true
-
-Style/FetchEnvVar:
-  Enabled: true
-
-Style/FileRead:
-  Enabled: true
-
-Style/FileWrite:
-  Enabled: true
-
-Style/HashConversion:
-  Enabled: true
-
-Style/HashExcept:
-  Enabled: true
-
-Style/IfWithBooleanLiteralBranches:
-  Enabled: true
-
-Style/InPatternThen:
-  Enabled: true
-
-Style/MapCompactWithConditionalBlock:
-  Enabled: true
-
-Style/MapToHash:
-  Enabled: true
-
-Style/MultilineInPatternThen:
-  Enabled: true
-
-Style/NegatedIfElseCondition:
-  Enabled: true
-
-Style/NestedFileDirname:
-  Enabled: true
-
-Style/NilLambda:
-  Enabled: true
-
-Style/NumberedParameters:
-  Enabled: true
-
-Style/NumberedParametersLimit:
-  Enabled: true
-
-Style/ObjectThen:
-  Enabled: true
-
-Style/OpenStructUse:
-  Enabled: true
-
-Style/QuotedSymbols:
-  Enabled: true
-
-Style/RedundantArgument:
-  Enabled: true
-
-Style/RedundantInitialize:
-  Enabled: true
-
-Style/RedundantSelfAssignmentBranch:
-  Enabled: true
-
-Style/SelectByRegexp:
-  Enabled: true
-
-Style/StringChars:
-  Enabled: true
-
-Style/SwapValues:
-  Enabled: true

data/Dangerfile

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-rubocop.lint inline_comment: true
-
-periphery.binary_path = "bin/periphery"
-periphery.process_warnings do |path, line, column, message|
-  !message.match(/unused/i)
-end
-
-periphery.scan(
-  project: "spec/support/fixtures/test.xcodeproj",
-  schemes: "test",
-  targets: "test"
-)

data/Gemfile

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gemspec
-
-gem "bundler", "~> 2.0"
-gem "danger"
-gem "danger-rubocop"
-gem "guard"
-gem "guard-rspec"
-gem "listen"
-gem "pry"
-gem "rake"
-gem "rspec"
-gem "rubocop"
-gem "yard"

data/Gemfile.lock

@@ -1,178 +0,0 @@
-PATH
-  remote: .
-  specs:
-    danger-periphery (0.2.0)
-      danger-plugin-api (~> 1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.2)
-    claide (1.1.0)
-    claide-plugins (0.9.2)
-      cork
-      nap
-      open4 (~> 1.3)
-    coderay (1.1.3)
-    colored2 (3.1.2)
-    cork (0.3.0)
-      colored2 (~> 3.1)
-    danger (8.6.1)
-      claide (~> 1.0)
-      claide-plugins (>= 0.9.2)
-      colored2 (~> 3.1)
-      cork (~> 0.1)
-      faraday (>= 0.9.0, < 2.0)
-      faraday-http-cache (~> 2.0)
-      git (~> 1.7)
-      kramdown (~> 2.3)
-      kramdown-parser-gfm (~> 1.0)
-      no_proxy_fix
-      octokit (~> 4.7)
-      terminal-table (>= 1, < 4)
-    danger-plugin-api (1.0.0)
-      danger (> 2.0)
-    danger-rubocop (0.10.0)
-      danger
-      rubocop (~> 1.0)
-    diff-lcs (1.5.0)
-    faraday (1.10.0)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0)
-      faraday-multipart (~> 1.0)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.0)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      faraday-retry (~> 1.0)
-      ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-http-cache (2.4.0)
-      faraday (>= 0.8)
-    faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.4)
-      multipart-post (~> 2)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    faraday-retry (1.0.3)
-    ffi (1.15.5)
-    formatador (1.1.0)
-    git (1.11.0)
-      rchardet (~> 1.8)
-    guard (2.18.0)
-      formatador (>= 0.2.4)
-      listen (>= 2.7, < 4.0)
-      lumberjack (>= 1.0.12, < 2.0)
-      nenv (~> 0.1)
-      notiffany (~> 0.0)
-      pry (>= 0.13.0)
-      shellany (~> 0.0)
-      thor (>= 0.18.1)
-    guard-compat (1.2.1)
-    guard-rspec (4.7.3)
-      guard (~> 2.1)
-      guard-compat (~> 1.1)
-      rspec (>= 2.99.0, < 4.0)
-    json (2.6.2)
-    kramdown (2.4.0)
-      rexml
-    kramdown-parser-gfm (1.1.0)
-      kramdown (~> 2.0)
-    listen (3.7.1)
-      rb-fsevent (~> 0.10, >= 0.10.3)
-      rb-inotify (~> 0.9, >= 0.9.10)
-    lumberjack (1.2.8)
-    method_source (1.0.0)
-    multipart-post (2.2.3)
-    nap (1.1.0)
-    nenv (0.3.0)
-    no_proxy_fix (0.1.2)
-    notiffany (0.1.3)
-      nenv (~> 0.1)
-      shellany (~> 0.0)
-    octokit (4.25.1)
-      faraday (>= 1, < 3)
-      sawyer (~> 0.9)
-    open4 (1.3.4)
-    parallel (1.22.1)
-    parser (3.1.2.0)
-      ast (~> 2.4.1)
-    pry (0.14.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    public_suffix (4.0.7)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    rb-fsevent (0.11.1)
-    rb-inotify (0.10.1)
-      ffi (~> 1.0)
-    rchardet (1.8.0)
-    regexp_parser (2.5.0)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.31.2)
-      json (~> 2.3)
-      parallel (~> 1.10)
-      parser (>= 3.1.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.18.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.19.1)
-      parser (>= 3.1.1.0)
-    ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.5)
-    sawyer (0.9.2)
-      addressable (>= 2.3.5)
-      faraday (>= 0.17.3, < 3)
-    shellany (0.0.1)
-    terminal-table (3.0.2)
-      unicode-display_width (>= 1.1.1, < 3)
-    thor (1.2.1)
-    unicode-display_width (2.2.0)
-    webrick (1.7.0)
-    yard (0.9.28)
-      webrick (~> 1.7.0)
-
-PLATFORMS
-  ruby
-  universal-darwin-20
-
-DEPENDENCIES
-  bundler (~> 2.0)
-  danger
-  danger-periphery!
-  danger-rubocop
-  guard
-  guard-rspec
-  listen
-  pry
-  rake
-  rspec
-  rubocop
-  yard
-
-BUNDLED WITH
-   2.3.6

data/Guardfile

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module ::Guard
-  class Periphery < Plugin
-    def initialize(options = {})
-      opts = options.dup
-      @command = [
-        "bin/periphery",
-        "scan",
-        "--project",
-        opts.delete(:project),
-        "--targets",
-        opts.delete(:targets),
-        "--schemes",
-        opts.delete(:schemes),
-        "--format",
-        "checkstyle"
-      ]
-      super(opts)
-    end
-
-    def run_all
-      UI.info(@command.shelljoin)
-      system(*@command)
-    end
-
-    def run_on_changes(_paths)
-      run_all
-    end
-  end
-end
-
-guard :rspec, cmd: "bundle exec rspec -t ~slow", run_all: { cmd: "bundle exec rspec" } do
-  require "guard/rspec/dsl"
-  dsl = Guard::RSpec::Dsl.new(self)
-
-  rspec = dsl.rspec
-  watch(rspec.spec_helper) { rspec.spec_dir }
-  watch(rspec.spec_support) { rspec.spec_dir }
-  watch(rspec.spec_files)
-
-  ruby = dsl.ruby
-  dsl.watch_spec_files_for(ruby.lib_files)
-end
-
-guard :periphery, project: "spec/support/fixtures/test.xcodeproj", targets: "test", schemes: "test" do
-  watch("spec/support/fixtures/test/main.swift")
-end

data/LICENSE.txt

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

@@ -1,106 +0,0 @@
-# danger-periphery
-
-[![Test](https://github.com/manicmaniac/danger-periphery/actions/workflows/test.yml/badge.svg)](https://github.com/manicmaniac/danger-periphery/actions/workflows/test.yml)
-
-A Danger plugin to detect unused codes.
-
-## Installation
-
-You need to install [Periphery](https://github.com/peripheryapp/periphery) beforehand.
-
-Write the following code in your Gemfile.
-
-```ruby
-gem "danger-periphery"
-```
-
-## Usage
-
-If you already have `.periphery.yml`, the easiest way to use is just add this to your Dangerfile.
-
-```ruby
-periphery.scan
-```
-
-You can specify the path to executable in this way.
-
-```ruby
-periphery.binary_path = "bin/periphery"
-```
-
-You can pass command line options to `periphery.scan` like the following.
-See `periphery scan -h` for available options.
-
-```ruby
-periphery.scan(
-  project: "Foo.xcodeproj",
-  schemes: ["foo", "bar"],
-  targets: "foo",
-  clean_build: true
-)
-```
-
-## Advanced Usage
-
-### Postprocess warnings by passing block to `#scan`
-
-You can modify warnings as you like by passing a block to `scan`.
-`scan` takes a block that receives `ScanResult` instance as arguments.
-Each `ScanResult` instance corresponds with each entry of Danger warnings.
-If that block returns falsy value, danger-periphery suppresses the corresponding warning.
-
-For example, if you want your team members to be careful with warnings, the following code may work.
-
-```ruby
-periphery.scan do |violation|
-  violation.message = "Pay attention please! #{violation.message}"
-end
-```
-
-For another example, if you want to suppress warnings complaining about unused parameter of many of `didChangeValue(_ sender: Any)` methods, you can suppress this kind of warnings in the following way.
-
-```ruby
-periphery.scan do |violation|
-  ! violation.message.match(/Parameter 'sender' is unused/)
-end
-```
-
-### Postprocess warnings by calling `#process_warnings`
-
-You can modify warnings as you like by passing a block to `process_warnings`.
-`process_warnings` takes a block that receives `[path, line, column, message]` as arguments and returns one of the following types.
-
-- `Array` that exactly contains `[path, line, column, message]`
-- `true`
-- `false`
-- `nil`
-
-If an `Array` is returned, danger-periphery uses the values in an array instead of the raw result produced by Periphery.
-`true` has the same meaning as `[path, line, column, message]`, the argument array as-is.
-
-If it returns `false` or `nil`, the processing warning will be suppressed.
-
-For example, if you want your team members to be careful with warnings, the following code may work.
-
-```ruby
-periphery.process_warnings do |path, line, column, message|
-  [path, line, column, "Pay attention please! #{message}"]
-end
-```
-
-Or if you want to suppress all `unused` warnings, to return `nil` or `false` in the block works.
-
-```ruby
-periphery.process_warnings do |path, line, column, message|
-    !message.match(/unused/i)
-end
-```
-
-## 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.