Merge pull request #84 from thedyrt/fix-severity

Fix severity conversion; calculate overall severity based on RuboCop fail level
reviewdog · Jun 7, 2023 · c3efa96 · c3efa96
2 parents eb901a2 + ff0e80a
commit c3efa96
Show file tree

Hide file tree

Showing 2 changed files with 55 additions and 19 deletions.
diff --git a/rdjson_formatter/rdjson_formatter.rb b/rdjson_formatter/rdjson_formatter.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # https://docs.rubocop.org/rubocop/formatters.html
-# rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+# rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/ClassLength
 class RdjsonFormatter < RuboCop::Formatter::BaseFormatter
   include RuboCop::PathUtil
 
@@ -22,6 +22,8 @@ def file_finished(file, offenses)
 
       @rdjson[:diagnostics] << build_diagnostic(file, offense)
     end
+
+    @rdjson[:severity] = overall_severity(offenses)
   end
 
   def finished(_inspected_files)
@@ -30,6 +32,24 @@ def finished(_inspected_files)
 
   private
 
+  def overall_severity(offenses)
+    if offenses.any? { |o| o.severity >= minimum_severity_to_fail }
+      'ERROR'
+    elsif offenses.all? { |o| convert_severity(o.severity) == 'INFO' }
+      'INFO'
+    else
+      'WARNING'
+    end
+  end
+
+  def minimum_severity_to_fail
+    @minimum_severity_to_fail ||= begin
+      # Unless given explicitly as `fail_level`, `:info` severity offenses do not fail
+      name = options.fetch(:fail_level, :refactor)
+      RuboCop::Cop::Severity.new(name)
+    end
+  end
+
   # @param [String] file
   # @param [RuboCop::Cop::Offense] offense
   # @return [Hash]
@@ -91,12 +111,12 @@ def build_suggestions(offense)
   # @param [Symbol] severity
   # @return [String]
   def convert_severity(severity)
-    case severity
-    when :info
+    case severity.to_s
+    when 'info', 'refactor', 'convention'
       'INFO'
-    when :warning
+    when 'warning'
       'WARNING'
-    when :error
+    when 'error'
       'ERROR'
     else
       'UNKNOWN_SEVERITY'
@@ -136,4 +156,4 @@ def build_original_output(file, offense)
     )
   end
 end
-# rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+# rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/ClassLength
diff --git a/test/rdjson_formatter/testdata/result.ok b/test/rdjson_formatter/testdata/result.ok
@@ -19,7 +19,7 @@
           }
         }
       },
-      "severity": "UNKNOWN_SEVERITY",
+      "severity": "INFO",
       "code": {
         "value": "Style/FrozenStringLiteralComment"
       },
@@ -55,7 +55,7 @@
           }
         }
       },
-      "severity": "UNKNOWN_SEVERITY",
+      "severity": "INFO",
       "code": {
         "value": "Layout/SpaceAfterComma"
       },
@@ -91,7 +91,7 @@
           }
         }
       },
-      "severity": "UNKNOWN_SEVERITY",
+      "severity": "INFO",
       "code": {
         "value": "Layout/ExtraSpacing"
       },
@@ -127,7 +127,7 @@
           }
         }
       },
-      "severity": "UNKNOWN_SEVERITY",
+      "severity": "INFO",
       "code": {
         "value": "Layout/SpaceAroundOperators"
       },
@@ -163,7 +163,7 @@
           }
         }
       },
-      "severity": "UNKNOWN_SEVERITY",
+      "severity": "INFO",
       "code": {
         "value": "Layout/ExtraSpacing"
       },
@@ -199,7 +199,7 @@
           }
         }
       },
-      "severity": "UNKNOWN_SEVERITY",
+      "severity": "INFO",
       "code": {
         "value": "Style/Semicolon"
       },
@@ -235,7 +235,7 @@
           }
         }
       },
-      "severity": "UNKNOWN_SEVERITY",
+      "severity": "INFO",
       "code": {
         "value": "Style/RedundantReturn"
       },
@@ -271,7 +271,7 @@
           }
         }
       },
-      "severity": "UNKNOWN_SEVERITY",
+      "severity": "INFO",
       "code": {
         "value": "Layout/ExtraSpacing"
       },
@@ -307,7 +307,7 @@
           }
         }
       },
-      "severity": "UNKNOWN_SEVERITY",
+      "severity": "INFO",
       "code": {
         "value": "Naming/MethodParameterName"
       },
@@ -328,7 +328,7 @@
           }
         }
       },
-      "severity": "UNKNOWN_SEVERITY",
+      "severity": "INFO",
       "code": {
         "value": "Naming/MethodParameterName"
       },
@@ -349,11 +349,27 @@
           }
         }
       },
-      "severity": "UNKNOWN_SEVERITY",
+      "severity": "WARNING",
       "code": {
         "value": "Lint/UselessAssignment"
       },
-      "original_output": "test/rdjson_formatter/testdata/not_correctable_offenses.rb:5:5: W: Lint/UselessAssignment: Useless assignment to variable - `c`."
+      "original_output": "test/rdjson_formatter/testdata/not_correctable_offenses.rb:5:5: W: Lint/UselessAssignment: Useless assignment to variable - `c`.",
+      "suggestions": [
+        {
+          "range": {
+            "start": {
+              "line": 5,
+              "column": 5
+            },
+            "end": {
+              "line": 5,
+              "column": 14
+            }
+          },
+          "text": "a + b"
+        }
+      ]
     }
-  ]
+  ],
+  "severity": "ERROR"
 }