danger-warnings 0.0.1 → 0.1.0

data/spec/assets/rubocop.json

@@ -0,0 +1,265 @@
+{
+  "metadata": {
+    "rubocop_version": "0.49.1",
+    "ruby_engine": "ruby",
+    "ruby_version": "2.5.1",
+    "ruby_patchlevel": "57",
+    "ruby_platform": "x86_64-darwin18"
+  },
+  "files": [
+    {
+      "path": "spec/lib/danger/danger_core/plugins/dangerfile_gitlab_plugin_spec.rb",
+      "offenses": [
+        {
+          "severity": "convention",
+          "message": "Do not use semicolons to terminate expressions.",
+          "cop_name": "Style/Semicolon",
+          "corrected": false,
+          "location": {
+            "line": 82,
+            "column": 65,
+            "length": 1
+          }
+        }
+      ]
+    },
+    {
+      "path": "lib/danger/danger_core/plugins/dangerfile_messaging_plugin.rb",
+      "offenses": [
+        {
+          "severity": "convention",
+          "message": "Use `alias` instead of `alias_method` in a class body.",
+          "cop_name": "Style/Alias",
+          "corrected": false,
+          "location": {
+            "line": 181,
+            "column": 5,
+            "length": 12
+          }
+        }
+      ]
+    },
+    {
+      "path": "lib/danger/danger_core/plugins/dangerfile_local_only_plugin.rb",
+      "offenses": [
+        {
+          "severity": "convention",
+          "message": "Trailing whitespace detected.",
+          "cop_name": "Layout/TrailingWhitespace",
+          "corrected": false,
+          "location": {
+            "line": 9,
+            "column": 66,
+            "length": 1
+          }
+        },
+        {
+          "severity": "convention",
+          "message": "Trailing whitespace detected.",
+          "cop_name": "Layout/TrailingWhitespace",
+          "corrected": false,
+          "location": {
+            "line": 14,
+            "column": 82,
+            "length": 1
+          }
+        }
+      ]
+    },
+    {
+      "path": "lib/danger/request_sources/gitlab.rb",
+      "offenses": [
+        {
+          "severity": "convention",
+          "message": "Prefer double-quoted strings unless you need single quotes to avoid extra backslashes for escaping.",
+          "cop_name": "Style/StringLiterals",
+          "corrected": false,
+          "location": {
+            "line": 171,
+            "column": 20,
+            "length": 8
+          }
+        }
+      ]
+    },
+    {
+      "path": "lib/danger/ci_source/support/find_repo_info_from_url.rb",
+      "offenses": [
+        {
+          "severity": "convention",
+          "message": "Trailing whitespace detected.",
+          "cop_name": "Layout/TrailingWhitespace",
+          "corrected": false,
+          "location": {
+            "line": 11,
+            "column": 1,
+            "length": 4
+          }
+        }
+      ]
+    },
+    {
+      "path": "lib/danger/ci_source/code_build.rb",
+      "offenses": [
+        {
+          "severity": "warning",
+          "message": "Assignment in condition - you probably meant to use `==`.",
+          "cop_name": "Lint/AssignmentInCondition",
+          "corrected": false,
+          "location": {
+            "line": 19,
+            "column": 31,
+            "length": 1
+          }
+        },
+        {
+          "severity": "convention",
+          "message": "Keep a blank line before and after `private`.",
+          "cop_name": "Layout/EmptyLinesAroundAccessModifier",
+          "corrected": false,
+          "location": {
+            "line": 33,
+            "column": 5,
+            "length": 7
+          }
+        },
+        {
+          "severity": "warning",
+          "message": "Useless `private` access modifier.",
+          "cop_name": "Lint/UselessAccessModifier",
+          "corrected": false,
+          "location": {
+            "line": 33,
+            "column": 5,
+            "length": 7
+          }
+        },
+        {
+          "severity": "convention",
+          "message": "Inconsistent indentation detected.",
+          "cop_name": "Layout/IndentationConsistency",
+          "corrected": false,
+          "location": {
+            "line": 34,
+            "column": 7,
+            "length": 189
+          }
+        },
+        {
+          "severity": "warning",
+          "message": "`private` (on line 33) does not make singleton methods private. Use `private_class_method` or `private` inside a `class << self` block instead.",
+          "cop_name": "Lint/IneffectiveAccessModifier",
+          "corrected": false,
+          "location": {
+            "line": 34,
+            "column": 7,
+            "length": 3
+          }
+        },
+        {
+          "severity": "convention",
+          "message": "Use `%r` around regular expression.",
+          "cop_name": "Style/RegexpLiteral",
+          "corrected": false,
+          "location": {
+            "line": 37,
+            "column": 47,
+            "length": 30
+          }
+        },
+        {
+          "severity": "convention",
+          "message": "Inconsistent indentation detected.",
+          "cop_name": "Layout/IndentationConsistency",
+          "corrected": false,
+          "location": {
+            "line": 40,
+            "column": 7,
+            "length": 164
+          }
+        },
+        {
+          "severity": "warning",
+          "message": "`private` (on line 33) does not make singleton methods private. Use `private_class_method` or `private` inside a `class << self` block instead.",
+          "cop_name": "Lint/IneffectiveAccessModifier",
+          "corrected": false,
+          "location": {
+            "line": 40,
+            "column": 7,
+            "length": 3
+          }
+        },
+        {
+          "severity": "convention",
+          "message": "Inconsistent indentation detected.",
+          "cop_name": "Layout/IndentationConsistency",
+          "corrected": false,
+          "location": {
+            "line": 46,
+            "column": 7,
+            "length": 449
+          }
+        },
+        {
+          "severity": "warning",
+          "message": "`private` (on line 33) does not make singleton methods private. Use `private_class_method` or `private` inside a `class << self` block instead.",
+          "cop_name": "Lint/IneffectiveAccessModifier",
+          "corrected": false,
+          "location": {
+            "line": 46,
+            "column": 7,
+            "length": 3
+          }
+        },
+        {
+          "severity": "warning",
+          "message": "Useless assignment to variable - `source_origin`. Use `_` or `_source_origin` as a variable name to indicate that it won't be used.",
+          "cop_name": "Lint/UselessAssignment",
+          "corrected": false,
+          "location": {
+            "line": 51,
+            "column": 9,
+            "length": 13
+          }
+        }
+      ]
+    },
+    {
+      "path": "lib/danger/commands/init_helpers/interviewer.rb",
+      "offenses": []
+    },
+    {
+      "path": "lib/danger/commands/runner.rb",
+      "offenses": []
+    },
+    {
+      "path": "lib/danger/helpers/find_max_num_violations.rb",
+      "offenses": []
+    },
+    {
+      "path": "lib/danger/helpers/comments_helper.rb",
+      "offenses": []
+    },
+    {
+      "path": "lib/danger/helpers/emoji_mapper.rb",
+      "offenses": []
+    },
+    {
+      "path": "lib/danger/helpers/array_subclass.rb",
+      "offenses": []
+    },
+    {
+      "path": "lib/danger/helpers/comments_parsing_helper.rb",
+      "offenses": []
+    },
+    {
+      "path": "lib/danger/helpers/comment.rb",
+      "offenses": []
+    }
+  ],
+  "summary": {
+    "offense_count": 18,
+    "target_file_count": 183,
+    "inspected_file_count": 183
+  }
+}

data/spec/assets/rubocop.txt

@@ -0,0 +1,27 @@
+== spec/lib/danger/danger_core/plugins/dangerfile_gitlab_plugin_spec.rb ==
+C: 82: 65: Do not use semicolons to terminate expressions.
+== spec/lib/danger/request_sources/github_spec.rb ==
+C:598: 16: Avoid comma after the last parameter of a method call.
+== lib/danger/danger_core/plugins/dangerfile_messaging_plugin.rb ==
+C:181:  5: Use alias instead of alias_method in a class body.
+== lib/danger/danger_core/plugins/dangerfile_local_only_plugin.rb ==
+C:  9: 66: Trailing whitespace detected.
+C: 14: 82: Trailing whitespace detected.
+== lib/danger/request_sources/gitlab.rb ==
+C:171: 20: Prefer double-quoted strings unless you need single quotes to avoid extra backslashes for escaping.
+== lib/danger/ci_source/support/find_repo_info_from_url.rb ==
+C: 11:  1: Trailing whitespace detected.
+== lib/danger/ci_source/code_build.rb ==
+W: 19: 31: Assignment in condition - you probably meant to use ==.
+C: 33:  5: Keep a blank line before and after private.
+W: 33:  5: Useless private access modifier.
+C: 34:  7: Inconsistent indentation detected.
+W: 34:  7: private (on line 33) does not make singleton methods private. Use private_class_method or private inside a class << self block instead.
+C: 37: 47: Use %r around regular expression.
+C: 40:  7: Inconsistent indentation detected.
+W: 40:  7: private (on line 33) does not make singleton methods private. Use private_class_method or private inside a class << self block instead.
+C: 46:  7: Inconsistent indentation detected.
+W: 46:  7: private (on line 33) does not make singleton methods private. Use private_class_method or private inside a class << self block instead.
+W: 51:  9: Useless assignment to variable - source_origin. Use _ or _source_origin as a variable name to indicate that it won't be used.
+
+183 files inspected, 18 offenses detected

data/spec/assets/rubocop_multi_offenses.json

@@ -0,0 +1,142 @@
+{
+  "metadata": {
+    "rubocop_version": "0.49.1",
+    "ruby_engine": "ruby",
+    "ruby_version": "2.5.1",
+    "ruby_patchlevel": "57",
+    "ruby_platform": "x86_64-darwin18"
+  },
+  "files": [
+    {
+      "path": "lib/danger/ci_source/code_build.rb",
+      "offenses": [
+        {
+          "severity": "warning",
+          "message": "Assignment in condition - you probably meant to use `==`.",
+          "cop_name": "Lint/AssignmentInCondition",
+          "corrected": false,
+          "location": {
+            "line": 19,
+            "column": 31,
+            "length": 1
+          }
+        },
+        {
+          "severity": "convention",
+          "message": "Keep a blank line before and after `private`.",
+          "cop_name": "Layout/EmptyLinesAroundAccessModifier",
+          "corrected": false,
+          "location": {
+            "line": 33,
+            "column": 5,
+            "length": 7
+          }
+        },
+        {
+          "severity": "warning",
+          "message": "Useless `private` access modifier.",
+          "cop_name": "Lint/UselessAccessModifier",
+          "corrected": false,
+          "location": {
+            "line": 33,
+            "column": 5,
+            "length": 7
+          }
+        },
+        {
+          "severity": "convention",
+          "message": "Inconsistent indentation detected.",
+          "cop_name": "Layout/IndentationConsistency",
+          "corrected": false,
+          "location": {
+            "line": 34,
+            "column": 7,
+            "length": 189
+          }
+        },
+        {
+          "severity": "warning",
+          "message": "`private` (on line 33) does not make singleton methods private. Use `private_class_method` or `private` inside a `class << self` block instead.",
+          "cop_name": "Lint/IneffectiveAccessModifier",
+          "corrected": false,
+          "location": {
+            "line": 34,
+            "column": 7,
+            "length": 3
+          }
+        },
+        {
+          "severity": "convention",
+          "message": "Use `%r` around regular expression.",
+          "cop_name": "Style/RegexpLiteral",
+          "corrected": false,
+          "location": {
+            "line": 37,
+            "column": 47,
+            "length": 30
+          }
+        },
+        {
+          "severity": "convention",
+          "message": "Inconsistent indentation detected.",
+          "cop_name": "Layout/IndentationConsistency",
+          "corrected": false,
+          "location": {
+            "line": 40,
+            "column": 7,
+            "length": 164
+          }
+        },
+        {
+          "severity": "warning",
+          "message": "`private` (on line 33) does not make singleton methods private. Use `private_class_method` or `private` inside a `class << self` block instead.",
+          "cop_name": "Lint/IneffectiveAccessModifier",
+          "corrected": false,
+          "location": {
+            "line": 40,
+            "column": 7,
+            "length": 3
+          }
+        },
+        {
+          "severity": "convention",
+          "message": "Inconsistent indentation detected.",
+          "cop_name": "Layout/IndentationConsistency",
+          "corrected": false,
+          "location": {
+            "line": 46,
+            "column": 7,
+            "length": 449
+          }
+        },
+        {
+          "severity": "warning",
+          "message": "`private` (on line 33) does not make singleton methods private. Use `private_class_method` or `private` inside a `class << self` block instead.",
+          "cop_name": "Lint/IneffectiveAccessModifier",
+          "corrected": false,
+          "location": {
+            "line": 46,
+            "column": 7,
+            "length": 3
+          }
+        },
+        {
+          "severity": "warning",
+          "message": "Useless assignment to variable - `source_origin`. Use `_` or `_source_origin` as a variable name to indicate that it won't be used.",
+          "cop_name": "Lint/UselessAssignment",
+          "corrected": false,
+          "location": {
+            "line": 51,
+            "column": 9,
+            "length": 13
+          }
+        }
+      ]
+    }
+  ],
+  "summary": {
+    "offense_count": 11,
+    "target_file_count": 1,
+    "inspected_file_count": 1
+  }
+}

data/spec/helper/message_util_spec.rb

@@ -0,0 +1,108 @@
+require_relative '../spec_helper'
+require_relative '../../lib/warnings/helper/message_util'
+
+module Warnings
+  describe Warnings::MessageUtil do
+    MARKDOWN_TEST_REPORT_NAME = 'My Report Name'.freeze
+    COLUMN_ONE = 1
+    COLUMN_TWO = 2
+    COLUMN_THREE = 3
+
+    context '#markdown' do
+      context 'header' do
+        it 'adds header name at first line' do
+          result = MessageUtil.markdown(MARKDOWN_TEST_REPORT_NAME, [])
+          header_name = result.split(MessageUtil::LINE_SEPARATOR).first
+          expect(header_name).to eq("# #{MARKDOWN_TEST_REPORT_NAME}")
+        end
+
+        it 'adds table header at second line' do
+          result = MessageUtil.markdown(MARKDOWN_TEST_REPORT_NAME, [])
+          table_header = result.split(MessageUtil::LINE_SEPARATOR)[1]
+          expect(table_header).to eq(MessageUtil::TABLE_HEADER)
+        end
+
+        it 'adds table separator at third line' do
+          result = MessageUtil.markdown(MARKDOWN_TEST_REPORT_NAME, [])
+          table_header = result.split(MessageUtil::LINE_SEPARATOR)[2]
+          expect(table_header).to eq(MessageUtil::TABLE_SEPARATOR)
+        end
+      end
+
+      context 'with issues' do
+        before do
+          @issue = Issue.new
+          @issue.severity = :low
+          @issue.file_name = 'hello/test.py'
+          @issue.message = 'Consider possible security implications associated with pickle module.'
+          @issue.line = 1234
+          @issue.category = 'B403-blacklist'
+
+          result = MessageUtil.markdown(MARKDOWN_TEST_REPORT_NAME, [@issue])
+          issue_line = result.split(MessageUtil::LINE_SEPARATOR)[3]
+          @issue_columns = issue_line.split(MessageUtil::COLUMN_SEPARATOR)
+        end
+
+        it 'first column contains severity upcase' do
+          text = @issue_columns[COLUMN_ONE]
+          expect(text).not_to be_nil
+          expect(text).to eq(@issue.severity.to_s.capitalize)
+        end
+
+        it 'second column contains filename:line' do
+          text = @issue_columns[COLUMN_TWO]
+          expect(text).not_to be_nil
+          expect(text).to eq("#{@issue.file_name}:#{@issue.line}")
+        end
+
+        it 'third column contains [category-name]' do
+          text = @issue_columns[COLUMN_THREE]
+          expect(text).not_to be_nil
+          match = text.match(/^\[#{@issue.category}\]/)
+          expect(match).not_to be_nil
+        end
+
+        it 'third column contains message' do
+          text = @issue_columns[COLUMN_THREE]
+          expect(text).not_to be_nil
+          match = text.match(/#{@issue.message}/)
+          expect(match).not_to be_nil
+        end
+      end
+    end
+
+    context '#inline' do
+      before do
+        @issue = Issue.new
+        @issue.severity = :low
+        @issue.file_name = 'hello/test.py'
+        @issue.message = 'Consider possible security implications associated with pickle module.'
+        @issue.line = 1234
+        @issue.category = 'B403-blacklist'
+
+        result = MessageUtil.inline(@issue)
+        @issue_lines = result.split(MessageUtil::LINE_SEPARATOR)
+      end
+
+      it 'first line contains severity upcase' do
+        text = @issue_lines[0]
+        expect(text).not_to be_nil
+        expect(text).to eq(@issue.severity.to_s.capitalize)
+      end
+
+      it 'second line contains [category-name]' do
+        text = @issue_lines[1]
+        expect(text).not_to be_nil
+        match = text.match(/^\[#{@issue.category}\]/)
+        expect(match).not_to be_nil
+      end
+
+      it 'third line contains message' do
+        text = @issue_lines[2]
+        expect(text).not_to be_nil
+        match = text.match(/#{@issue.message}/)
+        expect(match).not_to be_nil
+      end
+    end
+  end
+end