danger-shiphawk-plugin 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 956b926da7b191ddf6269153898a4125749e820543a3db8c612b4adbdeea0fe7
+  data.tar.gz: 1c8c91391a63e964e5fd0feb5880fcb5f4b89d43abc41ec0ce90ac5688519d0c
+SHA512:
+  metadata.gz: 767995b6772dc77638e159abca5bad83b19375e7ad08d8ec32a81739593b87440ae884d2f33afab94163a08e4b32c75281cce7bae7bf1a7edfb67a0bdbf2e699
+  data.tar.gz: f3ce9e204381b432fd335300fe9da858d92a90106dc94fbc553f7e1639dca96c1a17871039d01f8353592459e7e35c4dc399f4b7d9d89e50396d1d9d53136713

data/LICENSE

@@ -0,0 +1,19 @@
+The MIT License (MIT)
+
+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,36 @@
+# Danger ShipHawk Plugin
+A [Danger](https://github.com/danger/danger) plugin for [Rubocop](https://github.com/bbatsov/rubocop) that prints warnings.
+
+## Installation:
+Add this line to your Gemfile:
+
+```rb
+gem 'danger-shiphawk-plugin'
+```
+
+## Usage:
+Inside `Dangerfile` specifying next line
+
+```ruby
+shiphawk_plugin.checkup
+```
+
+#### Options:
+This method accepts configuration hash.
+The following keys are supported:
+
+* `files: 'all'` ('all' | 'diff') Files to lint
+* `config: nil` Path to the config `.rubocop.yml` file
+* `limit_of_warnings: 10` (Number) Count of offenses that should be displayed
+* `autofix_count: 30` (Number) Rubocop auto-fix will appear when errors count less then this number
+
+## License:
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## How to: Build
+Upgrade version in `lib/version.rb`
+Then create new version of a gem:
+
+```
+gem build danger-shiphawk-plugin.gemspec
+```

data/lib/danger_plugin.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+require 'shellwords'
+
+module Danger
+  # Run Ruby files through Rubocop.
+  # Results are passed out in a hash with errors/warnings
+  #
+  # @example Specifying custom config file.
+  #
+  #          shiphawk_plugin.checkup
+  #
+  #
+  # @see  ShipHawk/danger-shiphawk-plugin
+  # @tags ruby, rubocop, rubocop-plugin
+  #
+  class ShiphawkPlugin < Plugin
+    # Runs Ruby files through Rubocop. Generates a list of errors/warnings
+    #
+    # @param  [Hash] options
+    # @return [void]
+    def checkup(options = {})
+      @files = options.fetch(:files, 'all')
+      @config = options.fetch(:config, nil)
+      @limit_of_warnings = options.fetch(:limit_of_warnings, 10)
+      @autofix_count = options.fetch(:autofix_count, 30)
+
+      return if offenses.empty?
+
+      message_detailed_report
+      message_compact_report
+      message_hint
+      message_autofix
+
+      nil
+    end
+
+    private
+
+    def offenses
+      @offenses ||= detect_offenses
+    end
+
+    def detect_offenses
+      rubocop_output = json_parse(rubocop)
+
+      all_offenses = rubocop_output.files.flat_map do |file|
+        offenses = file.offenses
+        next [] if offenses.empty?
+
+        offenses.map do |offense|
+          OpenStruct.new(
+            path: file.path,
+            message: offense.message,
+            serenity: serenity_lvl_for(offense.cop_name)
+          )
+        end
+      end
+
+      all_offenses.sort_by(&:serenity)
+    end
+
+    def rubocop
+      command = ['rubocop']
+      command << ['--format', 'json']
+      command << ['--config', @config.shellescape] if @config
+
+      `#{command.join(' ')} #{files_to_lint}`
+    end
+
+    def files_to_lint
+      file_paths = case @files
+      when 'all'
+        Dir.glob('.')
+      when 'diff'
+        git.modified_files + git.added_files
+      else
+        raise ArgumentError, "Incorrect 'files' option"
+      end
+
+      Shellwords.join(file_paths)
+    end
+
+    def message_autofix
+      return if offenses.empty?
+      return if offenses.size > @autofix_count
+
+      msg = '## Please fix rubocop mistakes: `rubocop --auto-correct`'
+      print_message(msg, :fail)
+    end
+
+    def message_detailed_report
+      wide_report_offenses = offenses[0...@limit_of_warnings]
+
+      wide_report_offenses.each do |offense|
+        msg = []
+        msg << '## Syntax error detected:' if offense.serenity == :fail
+        msg << offense.path
+        msg << offense.message
+
+        print_message(msg.join('\n'), offense.serenity)
+      end
+    end
+
+    def message_compact_report
+      compact_report_offenses = offenses[@limit_of_warnings..-1]
+
+      return if compact_report_offenses.nil?
+
+      msg = "...And other #{compact_report_offenses.size} warnings"
+      print_message(msg, :warn)
+    end
+
+    def message_hint
+      file_names = offenses.map(&:path).uniq
+      file_paths_sentance = Shellwords.join(file_names)
+
+      msg = "To locally check these files run: \n `rubocop #{file_paths_sentance}`"
+      print_message(msg, :warn)
+    end
+
+    def print_message(message, serenity)
+      __send__(serenity, message)
+    end
+
+    def serenity_lvl_for(cop_name)
+      return :fail if cop_name == 'Lint/Syntax'
+
+      :warn
+    end
+
+    def json_parse(data)
+      JSON.parse(data, object_class: OpenStruct)
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Danger
+  module ShipHawkPlugin
+    VERSION = '1.0.2'
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: danger-shiphawk-plugin
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- ShipHawk Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: danger
+  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: rubocop
+  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: 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: '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: 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: 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: 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'
+description: A Danger plugin for running Ruby files through Rubocop.
+email: dev@shiphawk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/danger_plugin.rb
+- lib/version.rb
+homepage: https://github.com/Shiphawk/danger-shiphawk-plugin
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: A Danger plugin for running Ruby files through Rubocop.
+test_files: []