danger-detekt-instacart 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b764046152e872ed4909383bf6ee158807244d1aef3ad6f13ab8d1d89ae50f3b
+  data.tar.gz: 0df1e39db6cb862cc6b00d0a1ee8b2eefc8fb2f3be2cd4010f36f7ae90cd1092
+SHA512:
+  metadata.gz: 2948c60dc188f6ffa8b8b9d0f8cfae99baff98176171d9a8419cb965c6dad328b0b21ecbbadae2125559127dc630233a32cf55b6786be3c00611c0c5cd23a077
+  data.tar.gz: f568ae43cc6f1e056aa6954af029168c70b6ddd2794dea27f0944334625ee218c69672a4c84ea25b8f378091a8c5bbabd550afba27960f786956a28e9221870f

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+pkg
+.idea/
+.yardoc
+*.gem

data/.rubocop.yml

@@ -0,0 +1,152 @@
+# 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.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  Enabled: true
+
+# kind_of? is a good way to check a type
+Style/ClassCheck:
+  EnforcedStyle: kind_of?
+
+# It's better to be more explicit about the type
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+# specs sometimes have useless assignments, which is fine
+Lint/UselessAssignment:
+  Exclude:
+    - '**/spec/**/*'
+
+# We could potentially enable the 2 below:
+Layout/IndentHash:
+  Enabled: false
+
+Layout/AlignHash:
+  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.
+Metrics/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
+
+Style/FileName:
+  Enabled: false
+
+Layout/IndentHeredoc:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+PercentLiteralDelimiters:
+  PreferredDelimiters:
+    "%":  ()
+    "%i": ()
+    "%q": ()
+    "%Q": ()
+    "%r": "{}"
+    "%s": ()
+    "%w": ()
+    "%W": ()
+    "%x": ()
+
+Security/YAMLLoad:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+cache:
+  directories:
+    - bundle
+
+rvm:
+  - 2.0
+  - 2.1.3
+  - 2.3.1
+
+script:
+    - bundle exec rake spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in danger-kotlin_detekt.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,151 @@
+PATH
+  remote: .
+  specs:
+    danger-kotlin_detekt (0.0.3)
+      danger-plugin-api (~> 1.0)
+      oga
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ansi (1.5.0)
+    ast (2.4.0)
+    claide (1.0.3)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    coderay (1.1.2)
+    colored2 (3.1.2)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (8.0.4)
+      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.0)
+      kramdown-parser-gfm (~> 1.0)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (~> 1)
+    danger-plugin-api (1.0.0)
+      danger (> 2.0)
+    diff-lcs (1.3)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    faraday-http-cache (2.2.0)
+      faraday (>= 0.8)
+    ffi (1.9.25)
+    formatador (0.2.5)
+    git (1.11.0)
+      rchardet (~> 1.8)
+    guard (2.14.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      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)
+    kramdown (2.3.1)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    listen (3.0.7)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    lumberjack (1.0.13)
+    method_source (0.9.0)
+    multipart-post (2.1.1)
+    nap (1.1.0)
+    nenv (0.3.0)
+    no_proxy_fix (0.1.2)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.18.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    oga (2.15)
+      ast
+      ruby-ll (~> 2.1)
+    open4 (1.3.4)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (4.0.6)
+    rainbow (2.2.2)
+      rake
+    rake (13.0.1)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rchardet (1.8.0)
+    rexml (3.2.5)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.49.1)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-ll (2.1.2)
+      ansi
+      ast
+    ruby-progressbar (1.10.0)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    shellany (0.0.1)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thor (0.20.0)
+    unicode-display_width (1.7.0)
+    yard (0.9.20)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  danger-kotlin_detekt!
+  guard (~> 2.14)
+  guard-rspec (~> 4.7)
+  listen (= 3.0.7)
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.4)
+  rubocop
+  yard
+
+BUNDLED WITH
+   1.16.5

data/Guardfile

@@ -0,0 +1,19 @@
+# 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) 2018 Nicolas Fesquet <n.fesquet@betclicgroup.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,55 @@
+### kotlin_detekt
+
+Detekt files of a gradle based Android project.
+This is done using the Android's [Detekt](https://github.com/arturbosch/detekt) tool.
+Results are passed out as tables in markdown.
+
+<blockquote>Running KotlinDetekt with its basic configuration
+  <pre>
+kotlin_detekt.detekt</pre>
+</blockquote>
+
+<blockquote>Running KotlinDetekt with a specific gradle task
+  <pre>
+kotlin_detekt.gradle_task = "detektCheckMyFlavorDebug"
+kotlin_detekt.detekt</pre>
+</blockquote>
+
+<blockquote>Running KotlinDetekt for a specific severity level and up
+  <pre>
+# options are ["warning", "error"]
+kotlin_detekt.severity = "error"
+kotlin_detekt.detekt</pre>
+</blockquote>
+
+
+
+#### Attributes
+
+`report_file` - Location of Detekt report file
+If your Detekt task outputs to a different location, you can specify it here.
+Defaults to "build/reports/detekt/detekt-checkstyle.xml".
+
+`gradle_task` - Custom gradle task to run.
+This is useful when your project has different flavors.
+Defaults to "detektCheck".
+
+`severity` - Defines the severity level of the execution.
+Selected levels are the chosen one and up.
+Possible values are "Warning", "Error" or "Fatal".
+Defaults to "Warning".
+
+`filtering` - Enable filtering
+Only show messages within changed files.
+
+`skip_gradle_task` - Skip gradle task
+
+
+
+
+#### Methods
+
+`detekt` - Calls Detekt task of your gradle project.
+It fails if `gradlew` cannot be found inside current directory.
+It fails if `severity` level is not a valid option.
+It fails if `xmlReport` configuration is not set to `true` in your `build.gradle` file.

data/Rakefile

@@ -0,0 +1,23 @@
+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/danger-kotlin_detekt.gemspec

@@ -0,0 +1,51 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kotlin_detekt/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'danger-detekt-instacart'
+  spec.version       = KotlinDetekt::VERSION
+  spec.authors       = ['Nicolas Fesquet', 'Chao Zhang']
+  spec.email         = ['n.fesquet@betclicgroup.com', 'zhangchao6865@gmail.com']
+  spec.description   = %q{A short description of danger-kotlin_detekt. This is a forked version to include detekt rule name.}
+  spec.summary       = %q{A longer description of danger-kotlin_detekt.  This is a forked version to include detekt rule name.}
+  spec.homepage      = 'https://github.com/chao2zhang/danger-kotlin_detekt'
+  spec.license       = 'MIT'
+
+  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 'oga'
+
+  spec.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
+
+  # General ruby development
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 13.0'
+
+  # Testing support
+  spec.add_development_dependency 'rspec', '~> 3.4'
+
+  # Linting code and docs
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "yard"
+
+  # Makes testing easy via `bundle exec guard`
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+
+  # If you want to work on older builds of ruby
+  spec.add_development_dependency 'listen', '3.0.7'
+
+  # This gives you the chance to run a REPL inside your tests
+  # via:
+  #
+  #    require 'pry'
+  #    binding.pry
+  #
+  # This will stop test execution and let you inspect the results
+  spec.add_development_dependency 'pry'
+end

data/lib/danger_kotlin_detekt.rb

@@ -0,0 +1 @@
+require "kotlin_detekt/gem_version"

data/lib/danger_plugin.rb

@@ -0,0 +1 @@
+require "kotlin_detekt/plugin"

data/lib/kotlin_detekt/gem_version.rb

@@ -0,0 +1,3 @@
+module KotlinDetekt
+  VERSION = "0.0.4".freeze
+end

data/lib/kotlin_detekt/plugin.rb

@@ -0,0 +1,181 @@
+module Danger
+  # Detekt files of a gradle based Android project.
+  # This is done using the Android's [Detekt](https://github.com/arturbosch/detekt) tool.
+  # Results are passed out as tables in markdown.
+  #
+  # @example Running KotlinDetekt with its basic configuration
+  #
+  #          kotlin_detekt.detekt
+  #
+  # @example Running KotlinDetekt with a specific gradle task
+  #
+  #          kotlin_detekt.gradle_task = "detektCheckMyFlavorDebug"
+  #          kotlin_detekt.detekt
+  #
+  # @example Running KotlinDetekt for a specific severity level and up
+  #
+  #          # options are ["warning", "error"]
+  #          kotlin_detekt.severity = "error"
+  #          kotlin_detekt.detekt
+  #
+  # @see  NFesquet/danger-kotlin_detekt
+  # @tags danger, detekt, kotlin
+  #
+  class DangerKotlinDetekt < Plugin
+    SEVERITY_LEVELS = %w(warning error).freeze
+
+    # Location of Detekt report file
+    # If your Detekt task outputs to a different location, you can specify it here.
+    # Defaults to "build/reports/detekt/detekt-checkstyle.xml".
+    # @return [String]
+    attr_accessor :report_file
+    # A getter for `report_file`.
+    # @return [String]
+    def report_file
+      return @report_file || "build/reports/detekt/detekt-checkstyle.xml"
+    end
+
+    # Custom gradle task to run.
+    # This is useful when your project has different flavors.
+    # Defaults to "detektCheck".
+    # @return [String]
+    attr_accessor :gradle_task
+
+    # Defines the severity level of the execution.
+    # Selected levels are the chosen one and up.
+    # Possible values are "Warning", "Error" or "Fatal".
+    # Defaults to "Warning".
+    # @return [String]
+    attr_writer :severity
+
+    # Enable filtering
+    # Only show messages within changed files.
+    attr_accessor :filtering
+
+    # Skip gradle task
+    attr_accessor :skip_gradle_task
+
+    # Calls Detekt task of your gradle project.
+    # It fails if `gradlew` cannot be found inside current directory.
+    # It fails if `severity` level is not a valid option.
+    # It fails if `xmlReport` configuration is not set to `true` in your `build.gradle` file.
+    # @return [void]
+    #
+    def detekt(inline_mode: false)
+      unless skip_gradle_task || gradlew_exists?
+        fail("Could not find `gradlew` inside current directory")
+        return
+      end
+
+      unless SEVERITY_LEVELS.include?(severity)
+        fail("'#{severity}' is not a valid value for `severity` parameter.")
+        return
+      end
+
+      system "./gradlew #{gradle_task || 'detektCheck'}" unless skip_gradle_task
+
+      unless File.exist?(report_file)
+        fail("Detekt report not found at `#{report_file}`. "\
+          "Have you forgot to add `xmlReport true` to your `build.gradle` file?")
+      end
+
+      issues = read_issues_from_report
+      filtered_issues = filter_issues_by_severity(issues)
+
+      if inline_mode
+        # Report with inline comment
+        send_inline_comment(filtered_issues)
+      else
+        message = message_for_issues(filtered_issues)
+        markdown("### Detekt found issues\n\n" + message) unless message.to_s.empty?
+      end
+    end
+
+    # A getter for `severity`, returning "warning" if value is nil.
+    # @return [String]
+    def severity
+      @severity || SEVERITY_LEVELS.first
+    end
+
+    private
+
+    def read_issues_from_report
+      file = File.open(report_file)
+
+      require "oga"
+      report = Oga.parse_xml(file)
+
+      report.xpath("//error")
+    end
+
+    def filter_issues_by_severity(issues)
+      issues.select do |issue|
+        severity_index(issue.get("severity")) >= severity_index(severity)
+      end
+    end
+
+    def severity_index(severity)
+      SEVERITY_LEVELS.index(severity) || 0
+    end
+
+    def message_for_issues(issues)
+      message = ""
+
+      SEVERITY_LEVELS.reverse.each do |level|
+        filtered = issues.select { |issue| issue.get("severity") == level }
+        message << parse_results(filtered, level) unless filtered.empty?
+      end
+
+      message
+    end
+
+    def parse_results(results, heading)
+      target_files = (git.modified_files - git.deleted_files) + git.added_files
+      dir = "#{Dir.pwd}/"
+      count = 0
+      message = ""
+
+      results.each do |r|
+        location = r.parent
+        filename = location.get("name").gsub(dir, "")
+        next unless !filtering || (target_files.include? filename)
+        line = r.get("line") || "N/A"
+        reason = r.get("message")
+        rule = r.get("source")
+        count += 1
+        message << "`#{filename}` | #{line} | #{reason} | #{rule} \n"
+      end
+      if count != 0
+        header = "#### #{heading} (#{count})\n\n"
+        header << "| File | Line | Reason | Rule |\n"
+        header << "| ---- | ---- | ------ | ---- |\n"
+        message = header + message
+      end
+
+      message
+    end
+
+    # Send inline comment with danger's warn or fail method
+    #
+    # @return [void]
+    def send_inline_comment(issues)
+      target_files = (git.modified_files - git.deleted_files) + git.added_files
+      dir = "#{Dir.pwd}/"
+      SEVERITY_LEVELS.reverse.each do |level|
+        filtered = issues.select { |issue| issue.get("severity") == level }
+        next if filtered.empty?
+        filtered.each do |r|
+          location = r.parent
+          filename = location.get("name").gsub(dir, "")
+          next unless !filtering || (target_files.include? filename)
+          line = (r.get("line") || "0").to_i
+          send(level == "warning" ? "warn" : "fail", r.get("message"), file: filename, line: line)
+        end
+      end
+    end
+
+    def gradlew_exists?
+      `ls gradlew`.strip.empty? == false
+    end
+  end
+end

data/spec/fixtures/detekt-result-with-everything.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="utf-8"?>
+<checkstyle version="4.3">
+    <file name="MyProject/app/src/main/java/com/company/package/model/Object1.kt">
+        <error line="5" column="28" severity="warning" message="The more parameters a method has the more complex it is. Long parameter lists are often used to control complex algorithms and violate the Single Responsibility Principle. Prefer methods with short parameter lists." source="detekt.LongParameterList" />
+    </file>
+    <file name="MyProject/app/src/main/java/com/company/package/model/Object2.kt">
+        <error line="41" column="22" severity="error" message="Thrown exception is too generic. Prefer throwing project specific exceptions to handle error cases." source="detekt.TooGenericExceptionCaught" />
+    </file>
+    <file name="MyProject/app/src/main/java/com/company/package/model/Object3.kt">
+        <error line="69" column="19" severity="warning" message="Report magic numbers. Magic number is a numeric literal that is not defined as a constant and hence it&apos;s unclear what the purpose of this number is. It&apos;s better to declare such numbers as constants and give them a proper name. By default, -1, 0, 1, and 2 are not considered to be magic numbers." source="detekt.MagicNumber" />
+    </file>
+</checkstyle>

data/spec/kotlin_detekt_spec.rb

@@ -0,0 +1,76 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+module Danger
+  describe Danger::DangerKotlinDetekt do
+    it "should be a plugin" do
+      expect(Danger::DangerKotlinDetekt.new(nil)).to be_a Danger::Plugin
+    end
+
+    #
+    # You should test your custom attributes and methods here
+    #
+    describe "with Dangerfile" do
+      before do
+        @dangerfile = testing_dangerfile
+        @kotlin_detekt = @dangerfile.kotlin_detekt
+
+        allow(@kotlin_detekt.git).to receive(:deleted_files).and_return([])
+        allow(@kotlin_detekt.git).to receive(:added_files).and_return([])
+        allow(@kotlin_detekt.git).to receive(:modified_files).and_return([])
+        # # mock the PR data
+        # # you can then use this, eg. github.pr_author, later in the spec
+        # json = File.read(File.dirname(__FILE__) + "/support/fixtures/github_pr.json") # example json: `curl https://api.github.com/repos/danger/danger-plugin-template/pulls/18 > github_pr.json`
+        # allow(@kotlin_detekt.github).to receive(:pr_json).and_return(json)
+      end
+
+      it "Fails if gradlew does not exist" do
+        allow(@kotlin_detekt).to receive(:`).with("ls gradlew").and_return("")
+
+        @kotlin_detekt.detekt
+        expect(@kotlin_detekt.status_report[:errors]).to eq(["Could not find `gradlew` inside current directory"])
+      end
+
+      it "Fails if severity is an unknown value" do
+        allow(@kotlin_detekt).to receive(:`).with("ls gradlew").and_return("gradlew")
+        allow(File).to receive(:exists?).with(@kotlin_detekt.report_file).and_return(true)
+
+        @kotlin_detekt.severity = "Dummy"
+        @kotlin_detekt.detekt
+
+        expect(@kotlin_detekt.status_report[:errors]).to eq(["'Dummy' is not a valid value for `severity` parameter."])
+      end
+
+      it "Sets severity to 'warning' if no severity param is provided" do
+        allow(@kotlin_detekt).to receive(:`).with("ls gradlew").and_return("gradlew")
+        allow(File).to receive(:exists?).with(@kotlin_detekt.report_file).and_return(true)
+
+        fake_result = File.open("spec/fixtures/detekt-result-with-everything.xml")
+        allow(File).to receive(:open).with(@kotlin_detekt.report_file).and_return(fake_result)
+
+        @kotlin_detekt.detekt
+        expect(@kotlin_detekt.severity).to eq("warning")
+      end
+
+      # # Some examples for writing tests
+      # # You should replace these with your own.
+      #
+      # it "Warns on a monday" do
+      #   monday_date = Date.parse("2016-07-11")
+      #   allow(Date).to receive(:today).and_return monday_date
+      #
+      #   @kotlin_detekt.warn_on_mondays
+      #
+      #   expect(@dangerfile.status_report[:warnings]).to eq(["Trying to merge code on a Monday"])
+      # end
+      #
+      # it "Does nothing on a tuesday" do
+      #   monday_date = Date.parse("2016-07-12")
+      #   allow(Date).to receive(:today).and_return monday_date
+      #
+      #   @kotlin_detekt.warn_on_mondays
+      #
+      #   expect(@dangerfile.status_report[:warnings]).to eq([])
+      # end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,65 @@
+require "pathname"
+ROOT = Pathname.new(File.expand_path("../../", __FILE__))
+$:.unshift((ROOT + "lib").to_s)
+$:.unshift((ROOT + "spec").to_s)
+
+require "bundler/setup"
+require "pry"
+
+require "rspec"
+require "danger"
+
+if `git remote -v` == ""
+  puts "You cannot run tests without setting a local git remote on this repo"
+  puts "It's a weird side-effect of Danger's internals."
+  exit(0)
+end
+
+# Use coloured output, it's the best.
+RSpec.configure do |config|
+  config.filter_gems_from_backtrace "bundler"
+  config.color = true
+  config.tty = true
+end
+
+require "danger_plugin"
+
+# These functions are a subset of https://github.com/danger/danger/blob/master/spec/spec_helper.rb
+# If you are expanding these files, see if it's already been done ^.
+
+# A silent version of the user interface,
+# it comes with an extra function `.string` which will
+# strip all ANSI colours from the string.
+
+# rubocop:disable Lint/NestedMethodDefinition
+def testing_ui
+  @output = StringIO.new
+  def @output.winsize
+    [20, 9999]
+  end
+
+  cork = Cork::Board.new(out: @output)
+  def cork.string
+    out.string.gsub(/\e\[([;\d]+)?m/, "")
+  end
+  cork
+end
+# rubocop:enable Lint/NestedMethodDefinition
+
+# Example environment (ENV) that would come from
+# running a PR on TravisCI
+def testing_env
+  {
+    "HAS_JOSH_K_SEAL_OF_APPROVAL" => "true",
+    "TRAVIS_PULL_REQUEST" => "800",
+    "TRAVIS_REPO_SLUG" => "artsy/eigen",
+    "TRAVIS_COMMIT_RANGE" => "759adcbd0d8f...13c4dc8bb61d",
+    "DANGER_GITHUB_API_TOKEN" => "123sbdq54erfsd3422gdfio"
+  }
+end
+
+# A stubbed out Dangerfile for use in tests
+def testing_dangerfile
+  env = Danger::EnvironmentManager.new(testing_env)
+  Danger::Dangerfile.new(env, testing_ui)
+end

metadata

@@ -0,0 +1,221 @@
+--- !ruby/object:Gem::Specification
+name: danger-detekt-instacart
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Nicolas Fesquet
+- Chao Zhang
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oga
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: danger-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: yard
+  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: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+- !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'
+description: A short description of danger-kotlin_detekt. This is a forked version
+  to include detekt rule name.
+email:
+- n.fesquet@betclicgroup.com
+- zhangchao6865@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- danger-kotlin_detekt.gemspec
+- lib/danger_kotlin_detekt.rb
+- lib/danger_plugin.rb
+- lib/kotlin_detekt/gem_version.rb
+- lib/kotlin_detekt/plugin.rb
+- spec/fixtures/detekt-result-with-everything.xml
+- spec/kotlin_detekt_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/chao2zhang/danger-kotlin_detekt
+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.3.13
+signing_key:
+specification_version: 4
+summary: A longer description of danger-kotlin_detekt.  This is a forked version to
+  include detekt rule name.
+test_files:
+- spec/fixtures/detekt-result-with-everything.xml
+- spec/kotlin_detekt_spec.rb
+- spec/spec_helper.rb