danger-warnings 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1700e0b2ada290034b7845b68d581e81c73997f235d038f46903ec00526a3074
-  data.tar.gz: 482a5cd7478ce44da357b53f9932d06f64eac91adfab014ba205942434319dd2
+  metadata.gz: 90dcfaf900785427cae7f5996651fd006b6fc4fee2f67eb0674e330ff171ccab
+  data.tar.gz: f9c6800309d84929707bde221549d6ad3da3b84ddf51171cbad5f314132feccd
 SHA512:
-  metadata.gz: 682d89cec48fff79bb526b88fec0e0c628db4a88b7f52dcc39a2603913d4e09b1798ffbf33beb9cf31697d56ce8a94ffd73159bdbc159ae313f44698f3f34ccb
-  data.tar.gz: cddb903ba7cfd7b8532360adb1c598f49eaa64d4c5a770c0c83a73088c16f89425a166bd200e4e8a153832829f8d487d2400eec64d20b47711874ce05e8ab388
+  metadata.gz: 184a35b56e0e5c80ae92f169df055033e26d88f7d09db9310987933582fab388c9579939b57ff886d789bc486d941b166b3ae17d6df8411fcfd4695f876c17a6
+  data.tar.gz: e942fad54a71a5f1bf3cdb31675228db17744ae7abf3777b80c4160a4739489250b19611422c7c469c69156d5113c430ac2300bc5f26545d1669cc178ae67d43

data/CHANGELOG.md

@@ -6,6 +6,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.0] - 2019-01-23
+### Added 
+- PylintParser - Support Pylint formatted reports
+- RuboCopParser - Support RuboCop formatted reports
+
+### Changed
+- Renamed issue.id to issue.category
+
+### Removed
+- Remove issue.name 
+
 ## [0.0.1] - 2019-01-21
 ### Added
 - Initial release

data/Dangerfile

@@ -0,0 +1,5 @@
+warnings.report(
+  parser: :rubocop,
+  file: 'spec/assets/rubocop.txt',
+  filter: false
+)

data/README.md

@@ -10,6 +10,17 @@
 
 </br>
 
+<div align="center">
+  <!-- Version -->
+  <a href="https://badge.fury.io/rb/danger-warnings">
+    <img src="https://badge.fury.io/rb/danger-warnings.svg" alt="Version" />
+  </a>
+  <!-- Downloads -->
+  <a href="https://badge.fury.io/rb/danger-warnings">
+    <img src="https://img.shields.io/gem/dt/danger-warnings.svg" alt="Downloads" />
+  </a>
+</div>
+
 <div align="center">
   <!-- Build Status -->
   <a href="https://travis-ci.org/Kyaak/danger-warnings">
@@ -79,8 +90,10 @@
 
 </br>
 
-This [danger](https://github.com/danger/danger) plugin provides a uniform report format for various lint [tools](#parsers). <br>
-The purpose is a simple to use plugin regardless of the linter tool used to create the issues.
+This [danger](https://github.com/danger/danger) plugin provides a uniform report format for various [tools](#parsers). <br>
+The purpose is a simple to use plugin regardless of the tool used to find issues in your project :detective:
+
+This plugin was inspired by the work of [warnings-ng-plugin](https://github.com/jenkinsci/warnings-ng-plugin) :bowing_man:
 
 ## Table of Contents
 - [How it looks like](#how-does-it-look)
@@ -206,8 +219,23 @@ All [default](#override-default-settings) fields can be passed as parameters to
 
 These will override the configuration for this report **only**.
 
+#### What it does not
+It is not the responsibility of this plugin to exclude / include files or directories. We will only process the result and present it to you.
+Something like this belongs to your tool configuration before running it.
+
 ## Parsers
 
-|Number|Name|ID|File Format|
-|:---:|---|---|---|
-|1|[bandit](https://github.com/PyCQA/bandit)|bandit|json|
+Find a list with supported report formats and their parsers. 
+
+If your desired parser is not explicitly named, look into your tools documentation - maybe you can format 
+the report in a different style (and give it a custom name when calling `warnings.report`). 
+
+`any` file format means that the file is most likely read line by line, so the extension is not important.
+
+Your parser is missing and you cannot export into another format? -> [Create an Issue](https://github.com/Kyaak/danger-warnings/issues) 
+
+|Number|Name|ID|File Format|Formatter|
+|:---:|:---|:---|:---:|:----:|
+|1|[Bandit](https://github.com/PyCQA/bandit)|bandit|json|json
+|2|[Pylint](https://github.com/PyCQA/pylint)|pylint|any|parseable
+|3|[RuboCop](https://github.com/rubocop-hq/rubocop)|rubocop|json, any|json, simple

data/lib/warnings/gem_version.rb

@@ -1,3 +1,3 @@
 module Warnings
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.1.0'.freeze
 end

data/lib/warnings/{markdown_util.rb → helper/message_util.rb}

@@ -1,11 +1,11 @@
-require_relative 'issue'
+require_relative '../report/issue'
 
 module Warnings
-  # Utility class to write the markdown report.
-  module MarkdownUtil
-    TABLE_HEADER = 'Severity|File|Message'.freeze
+  # Utility class to write the markdown and inline reports.
+  module MessageUtil
+    TABLE_HEADER = '|Severity|File|Message|'.freeze
     COLUMN_SEPARATOR = '|'.freeze
-    TABLE_SEPARATOR = "---#{COLUMN_SEPARATOR}---#{COLUMN_SEPARATOR}---".freeze
+    TABLE_SEPARATOR = "#{COLUMN_SEPARATOR}---#{COLUMN_SEPARATOR}---#{COLUMN_SEPARATOR}---#{COLUMN_SEPARATOR}".freeze
     LINE_SEPARATOR = "\n".freeze
 
     module_function
@@ -15,12 +15,20 @@ module Warnings
     # @param name [String] The name of the report to be printed.
     # @param issues [Array<Issue>] List of parsed issues.
     # @return [String] String in danger markdown format.
-    def generate(name, issues)
+    def markdown(name, issues)
       result = header_name(name)
       result << header
       result << issues(issues)
     end
 
+    # Create an inline comment containing all issue information.
+    #
+    # @param issue [Issue] The issue to report.
+    # @return String Text to add as comment.
+    def inline(issue)
+      "#{issue.severity.to_s.capitalize}\n#{meta_information(issue)}\n#{issue.message}"
+    end
+
     # Create the report name string.
     #
     # @param report_name [String] The name of the report.
@@ -47,15 +55,31 @@ module Warnings
     def issues(issues)
       result = ''
       issues.each do |issue|
+        result << COLUMN_SEPARATOR.dup
         result << issue.severity.to_s.capitalize
         result << COLUMN_SEPARATOR
         result << "#{issue.file_name}:#{issue.line}"
         result << COLUMN_SEPARATOR
-        result << "[#{issue.id}-#{issue.name}] #{issue.message}"
+        result << "#{meta_information(issue)} #{issue.message}"
+        result << COLUMN_SEPARATOR
         result << LINE_SEPARATOR
       end
       # rubocop:enable Metrics/AbcSize
       result
     end
+
+    # Combine meta information about the issue.
+    # Meta information are considered infos about the check itself.
+    # e.g. category
+    #
+    # @param issue [Issue] Issue to extract information.
+    # @return String combined information.
+    def meta_information(issue)
+      return unless issue.category
+
+      result = '['
+      result << issue.category
+      result << ']'
+    end
   end
 end

data/lib/warnings/helper/severity_util.rb

@@ -0,0 +1,45 @@
+module Warnings
+  # Defines severity levels and provides helper methods.
+  module SeverityUtil
+    LOW = :low
+    MEDIUM = :medium
+    HIGH = :high
+
+    module_function
+
+    # Map a common shortened severity [R/C/W/E/F0000] to a defined severity level.
+    #
+    # @param name [String] The shortened severity without '[]'
+    # @return [Symbol] Mapped severity level.
+    def rcwef_short(name)
+      char = name.chars.first.downcase
+      case char
+      when 'r', 'c'
+        LOW
+      when 'w'
+        MEDIUM
+      when 'e', 'f'
+        HIGH
+      else
+        LOW
+      end
+    end
+
+    # Map a common full severity to a defined severity level.
+    #
+    # @param name [String] The shortened severity without '[]'
+    # @return [Symbol] Mapped severity level.
+    def rcwef_full(name)
+      case name.downcase
+      when 'refactor', 'convention'
+        LOW
+      when 'warning'
+        MEDIUM
+      when 'error', 'fatal'
+        HIGH
+      else
+        LOW
+      end
+    end
+  end
+end

data/lib/warnings/parser/bandit_parser.rb

@@ -1,18 +1,13 @@
 require_relative 'parser'
-require_relative '../issue'
+require_relative '../report/issue'
 
 module Warnings
   # Parser class for bandit generated json files.
   class BanditParser < Parser
     RESULTS_KEY = 'results'.freeze
-    FILE_TYPES = %i(json).freeze
     NAME = 'Bandit'.freeze
     ERROR_MISSING_KEY = "Missing bandit key '#{RESULTS_KEY}'.".freeze
 
-    def file_types
-      FILE_TYPES
-    end
-
     def parse(file)
       json_hash = json(file)
       results_hash = json_hash[RESULTS_KEY]
@@ -33,8 +28,7 @@ module Warnings
       issue.severity = to_severity(hash['issue_severity'])
       issue.message = hash['issue_text']
       issue.line = hash['line_number']
-      issue.id = hash['test_id']
-      issue.name = hash['test_name']
+      issue.category = "#{hash['test_id']}-#{hash['test_name']}"
       @issues << issue
     end
 

data/lib/warnings/parser/parser.rb

@@ -5,15 +5,12 @@ module Warnings
   # Base parser class to define common methods.
   class Parser
     ERROR_FILE_NOT_EXIST = 'File \'%s\' does not exist.'.freeze
-    ERROR_EXT_NOT_SUPPORTED = 'File extension \'%s\' is not supported for parser %s.'.freeze
+    ERROR_EXT_NOT_JSON = '%s is not a json file.'.freeze
+    EXT_JSON = 'json'.freeze
     # All issues found by the parser.
     #
     # @return [Array<Issue>]
     attr_accessor :issues
-    # Defines all supported file types for the parser.
-    #
-    # @return [Array<Symbol>] Array of file types.
-    abstract_method :file_types
     # Execute the parser.
     # Read the file and create an array of issues.
     #
@@ -30,15 +27,36 @@ module Warnings
 
     protected
 
+    # Check if the file is a json file.
+    #
+    # @param file_path [String] Path to a file to be read as json.
+    # @return [Bool] Whether the file is a json or not.
+    def json?(file_path)
+      File.extname(file_path).delete('.').downcase.eql?(EXT_JSON)
+    end
+
     # Parse a file as json content.
     #
     # @param file_path [String] Path to a file to be read as json.
     # @return [String] Hash of json values.
     def json(file_path)
+      raise(format(ERROR_EXT_NOT_JSON, file_path)) unless json?(file_path)
+
       content = read_file(file_path)
       JSON.parse(content)
     end
 
+    # Read the file into memory and serve each line.
+    #
+    # @param file_path [String] Path to a file to be read.
+    # @raise If file does not exist.
+    # @return [String] Array of line contents.
+    def read_lines(file_path)
+      raise(format(ERROR_FILE_NOT_EXIST, file_path)) unless File.exist?(file_path)
+
+      File.readlines(file_path, chomp: true)
+    end
+
     private
 
     # Evaluate and read the file into memory.
@@ -47,19 +65,9 @@ module Warnings
     # @raise If file does not exist or ist empty.
     # @return [String] File content.
     def read_file(file_path)
-      check_extname(file_path)
       raise(format(ERROR_FILE_NOT_EXIST, file_path)) unless File.exist?(file_path)
 
       File.read(file_path)
     end
-
-    # Evaluate the files extension name.
-    #
-    # @param file_path [String] Path to a file to be evaluated.
-    # @raise If file extension is not supported by the current parser.
-    def check_extname(file_path)
-      ext = File.extname(file_path).delete('.')
-      raise(format(ERROR_EXT_NOT_SUPPORTED, ext, self.class.name)) unless file_types.include?(ext.to_sym)
-    end
   end
 end

data/lib/warnings/parser/parser_factory.rb

@@ -1,11 +1,15 @@
 require_relative 'bandit_parser'
+require_relative 'pylint_parser'
+require_relative 'rubocop_parser'
 
 module Warnings
   # Factory class for supported parsers.
   class ParserFactory
     ERROR_NOT_SUPPORTED = 'Parser \'%s\' not supported.'.freeze
     AVAILABLE_PARSERS = {
-      bandit: BanditParser
+      bandit: BanditParser,
+      pylint: PylintParser,
+      rubocop: RubocopParser
     }.freeze
 
     # Create a new parser implementation.

data/lib/warnings/parser/pylint_parser.rb

@@ -0,0 +1,38 @@
+require_relative 'parser'
+require_relative '../report/issue'
+require_relative '../helper/severity_util'
+
+module Warnings
+  # Parser class for pylint formatted files.
+  class PylintParser < Parser
+    NAME = 'Pylint'.freeze
+    ISSUE_PATTERN = /(.*):(\d+):\s*\[(\w\d+)\]\s*(.*)/.freeze
+
+    def parse(file)
+      read_lines(file).each do |line|
+        match = line.scan(ISSUE_PATTERN)
+        store_issue(match[0]) unless match.empty?
+      end
+    end
+
+    def name
+      NAME
+    end
+
+    private
+
+    # Match the regex result and store it as issue implementation.
+    #
+    # @param match [Array<String>] The regex matches for a single issue.
+    # @return Void
+    def store_issue(match)
+      issue = Issue.new
+      issue.file_name = match[0]
+      issue.line = match[1]
+      issue.category = match[2]
+      issue.severity = SeverityUtil.rcwef_short(issue.category)
+      issue.message = match[3]
+      @issues << issue
+    end
+  end
+end

data/lib/warnings/parser/rubocop_parser.rb

@@ -0,0 +1,77 @@
+require_relative 'parser'
+require_relative '../report/issue'
+require_relative '../helper/severity_util'
+
+module Warnings
+  # Parser class for rubocop reports.
+  class RubocopParser < Parser
+    NAME = 'RuboCop'.freeze
+    FILE_PATTERN = /==\s(.*)\s==/.freeze
+    ISSUE_PATTERN = /(\w):\s*(\d+):\s*\d+:\s(.*)/.freeze
+
+    def parse(file)
+      if json?(file)
+        extract_json_issues(file)
+      else
+        extract_pattern_issues(file)
+      end
+    end
+
+    def name
+      NAME
+    end
+
+    private
+
+    def extract_json_issues(file)
+      json_hash = json(file)
+      files = json_hash['files']
+      files.each(&method(:store_json_issue))
+    end
+
+    def extract_pattern_issues(file)
+      last_file = nil
+      read_lines(file).each do |line|
+        file_match = line.scan(FILE_PATTERN)
+        unless file_match.empty?
+          last_file = file_match[0][0]
+          next
+        end
+        issue_match = line.scan(ISSUE_PATTERN)
+        next if issue_match.empty?
+
+        issue_content = issue_match[0]
+        issue = {
+          severity: issue_content[0],
+          line: issue_content[1],
+          message: issue_content[2]
+        }
+        store_simple_issue(last_file, issue)
+      end
+    end
+
+    def store_json_issue(file_hash)
+      offenses = file_hash['offenses']
+      return if offenses.empty?
+
+      offenses.each do |offense|
+        issue = Issue.new
+        issue.file_name = file_hash['path']
+        issue.line = offense['location']['line']
+        issue.category = offense['cop_name']
+        issue.severity = SeverityUtil.rcwef_full(offense['severity'])
+        issue.message = offense['message']
+        @issues << issue
+      end
+    end
+
+    def store_simple_issue(file, issue_hash)
+      issue = Issue.new
+      issue.file_name = file
+      issue.line = issue_hash[:line].to_i
+      issue.severity = SeverityUtil.rcwef_full(issue_hash[:severity])
+      issue.message = issue_hash[:message]
+      @issues << issue
+    end
+  end
+end