danger-chikuwatter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 907f5157662a6a69023d661f64e7461a279466ae66adfc9e51d3692ccf061502
+  data.tar.gz: 8d4f3e8f7161fba38842d320fb309519024af2f854b962e898597cbaf4b9c5bb
+SHA512:
+  metadata.gz: 771c21e1fbb14c3f49029412068543a43c50b25ff2f54ff329ef492bda564e3980c1790e473a63ba04611aec895d7ca845ebd99766cc165dc2a4dc2850b02f58
+  data.tar.gz: 206194f8d5f75d279c40c53c5faaf06cdc8d5f9c481c46164aedfcb10bb73b0f2a03f478997d33659fedabbdf36515390effceaf30a2a43ab1e61aa7aea40189

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,148 @@
+# 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.7
+
+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

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+cache:
+  directories:
+    - bundle
+
+rvm:
+  - 2.7
+
+script:
+    - bundle exec rake spec

data/.vscode/settings.json

@@ -0,0 +1,9 @@
+{
+    "github.copilot.inlineSuggest.enable": true,
+    "github.copilot.enable": {
+        "*": false,
+        "ruby": true,
+        "yaml": true,
+        "markdown": true,
+    }
+}

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in danger-chikuwatter.gemspec
+gemspec
+gem 'faraday-retry'

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) 2023 watanavex <watanave.tech@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,39 @@
+# danger-chikuwatter
+
+Danger Plugin for reporting flutter analyze errors, warnings and **info**.
+
+## Installation
+
+Add this line to your Gemfile:
+
+```
+gem danger-chikuwa
+```
+
+## Usage
+
+Run flutter analyze and save the result to a file.
+
+```
+$ flutter analyze > result.log
+```
+
+Add the following to your Dangerfile.
+
+```
+chikuwa.report "result.log"
+```
+
+If `inline_mode` is true, the plugin will report the errors, warnings and **info** as inline comments.
+
+```
+chikuwa.inline_mode = true
+```
+
+## Development
+
+1. Clone this repo
+2. Run `bundle install` to setup dependencies.
+3. Run `bundle exec rake spec` to run the tests.
+4. Use `bundle exec guard` to automatically have tests run as you make changes.
+5. 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/danger-chikuwatter.gemspec

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "chikuwatter/gem_version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "danger-chikuwatter"
+  spec.version       = Chikuwatter::VERSION
+  spec.authors       = ["watanavex"]
+  spec.email         = ["watanave.tech@gmail.com"]
+  spec.description   = "A short description of danger-chikuwatter."
+  spec.summary       = "A longer description of danger-chikuwatter."
+  spec.homepage      = "https://github.com/watanavex/danger-chikuwatter"
+  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_runtime_dependency "danger-plugin-api", "~> 1.0"
+
+  # General ruby development
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.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/chikuwatter/gem_version.rb

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

data/lib/chikuwatter/plugin.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Danger
+  # Lint markdown files inside your projects.
+  # This is done using the [proselint](http://proselint.com) python egg.
+  # Results are passed out as a table in markdown.
+  #
+  # @example Output analyze results with inline comments
+  #
+  #          (You must run `flutter analyze` before using this plugin.)
+  #          ($ flutter analize > result.log)
+  #
+  #          chikuwatter.inline_mode = true
+  #          chikuwatter.report = result.log
+  #
+  class DangerChikuwatter < Plugin
+    attr_accessor :project_root, :inline_mode
+
+    # Project root directory
+    def _project_root
+      root = @project_root || Dir.pwd
+      root += "/" unless root.end_with? "/"
+      root
+    end
+
+    # Inline mode
+    def _inline_mode
+      @inline_mode || false
+    end
+
+    # Report analyze results
+    def report(file_path)
+      if File.exist?(file_path)
+        results = parse_analyze_log(file_path)
+        send_reports(results)
+      else
+        fail "analyze log file not found"
+      end
+    end
+
+    # Output level
+    module Type
+      INFO = "info"
+      WARN = "warning"
+      ERROR = "error"
+
+      def self.from_string(str)
+        case str.downcase
+        when INFO then INFO
+        when WARN then WARN
+        when ERROR then ERROR
+        else
+          raise ArgumentError, "Invalid type: #{str}"
+        end
+      end
+    end
+
+    # Report data
+    class ReportData
+      attr_accessor :message, :type, :file, :line
+
+      def initialize(message, type, file, line)
+        self.message = message
+        self.type = type
+        self.file = file
+        self.line = line
+      end
+    end
+
+    # Parse analyze log
+    def parse_analyze_log(file_path)
+      _project_root = Dir.pwd
+      report_data = []
+      File.foreach(file_path) do |line|
+        logs = line.split("•")
+        if logs.length < 4
+          next
+        end
+
+        type_str = logs[0].strip!
+        type = Type.from_string(type_str)
+        file, line_num = logs[2].strip!.split(":")
+
+        message = "#{type_str} • #{logs[3].strip!}: #{logs[1].strip!}"
+
+        report_data.push(ReportData.new(message, type, file, line_num))
+      end
+
+      return report_data
+    end
+
+    # Send analyze results
+    def send_reports(results)
+      results.each do |data|
+        case data.type
+        when Type::INFO
+          if _inline_mode
+            warn(data.message, file: data.file, line: data.line)
+          else
+            warn(data.message)
+          end
+        when Type::WARN
+          if _inline_mode
+            warn(data.message, file: data.file, line: data.line)
+          else
+            warn(data.message)
+          end
+        when Type::ERROR
+          if _inline_mode
+            failure(data.message, file: data.file, line: data.line)
+          else
+            failure(data.message)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/danger_chikuwatter.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "chikuwatter/gem_version"

data/lib/danger_plugin.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "chikuwatter/plugin"

data/spec/chikuwatter_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require File.expand_path("spec_helper", __dir__)
+
+module Danger
+  describe Danger::DangerChikuwatter do
+    it "should be a plugin" do
+      expect(Danger::DangerChikuwatter.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
+        @my_plugin = @dangerfile.chikuwatter
+
+        # 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(@my_plugin.github).to receive(:pr_json).and_return(json)
+      end
+
+      # Some examples for writing tests
+      # You should replace these with your own.
+
+      it "Errors on file not found" do
+        @my_plugin.report "no file"
+        expect(@dangerfile.status_report[:errors]).to eq(["analyze log file not found"])
+      end
+
+      it "Report" do
+        file_path = "#{File.dirname(__FILE__)}/fixtures/result.log"
+        @my_plugin.inline_mode = true
+        @my_plugin.report file_path
+        expect(@dangerfile.status_report[:warnings]).to eq(["warning • lint_rule: warning message", "info • lint_rule: info message"])
+        expect(@dangerfile.status_report[:errors]).to eq(["error • lint_rule: error message"])
+      end
+    end
+  end
+end

data/spec/fixtures/result.log

@@ -0,0 +1,5 @@
+Analyzing master...                                             
+
+warning • warning message • lib/main.dart:10:10 • lint_rule
+  error • error message • lib/main.dart:10:10 • lint_rule
+   info • info message • lib/main.dart:10:10 • lint_rule

data/spec/spec_helper.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "pathname"
+ROOT = Pathname.new(File.expand_path("..", __dir__))
+$:.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,203 @@
+--- !ruby/object:Gem::Specification
+name: danger-chikuwatter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- watanavex
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-04-11 00:00:00.000000000 Z
+dependencies:
+- !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: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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-chikuwatter.
+email:
+- watanave.tech@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".vscode/settings.json"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- danger-chikuwatter.gemspec
+- lib/chikuwatter/gem_version.rb
+- lib/chikuwatter/plugin.rb
+- lib/danger_chikuwatter.rb
+- lib/danger_plugin.rb
+- spec/chikuwatter_spec.rb
+- spec/fixtures/result.log
+- spec/spec_helper.rb
+homepage: https://github.com/watanavex/danger-chikuwatter
+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.1.6
+signing_key: 
+specification_version: 4
+summary: A longer description of danger-chikuwatter.
+test_files:
+- spec/chikuwatter_spec.rb
+- spec/fixtures/result.log
+- spec/spec_helper.rb