danger-wcc 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2559417d0fc17cc5432a264afe84b98076248c88
-  data.tar.gz: 7bd3382415a0414c6b48214c28806f13356f822f
+  metadata.gz: a19b6ce24d61f5ff2a951f9902122eda8942c8c7
+  data.tar.gz: e958cfa4740a01893df04a960f902ea5eb541dfc
 SHA512:
-  metadata.gz: fee811c11bdb726932f1964379bade0ce0a4e61ff6d26acb34734155bd2048abfa707c15188c0e9dae2251a9ae77e53eb5f958433a1cf7c032caab6cc116edf9
-  data.tar.gz: 512a9dba219287d1640e7bf7c4f57c9399e82760e31c0efab9cf6c7692f6af853e285588cc35384056fd95d0acce3e3f23e5d258a39b3fac5d55213e983520e5
+  metadata.gz: 2779c8031e0b5dbcc595c07b9bec606c4daab6e94214fa1808909f80819b2f4c95358448adf93b4ec8462c5e1179c981489cfd4eb5be7f48291a4635189e62d3
+  data.tar.gz: 353a0fb641903e0ce67fc874114976fcd90070a5c28c9c6d81f59682926e874d1ef67236ebe0de64e75f97572353b86fa4b0398ed91155cb0254a7e8787691f4

data/.rubocop.yml

@@ -47,28 +47,36 @@ Metrics/ModuleLength:
    - 'lib/wcc/utils.rb'
    - 'spec/**/*.rb'
 
-Naming/UncommunicativeMethodParamName:
+Naming/MethodParameterName:
   Enabled: false
 
 Naming/MemoizedInstanceVariableName:
   Enabled: false
 
-Performance/UnfreezeString:
-  Exclude:
-    - 'spec/**/*.rb'
-
-Style/BracesAroundHashParameters:
-  Enabled: false
-
 Lint/AssignmentInCondition:
   Enabled: false
 
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
 Style/EmptyMethod:
   EnforcedStyle: expanded
 
 Style/Alias:
   EnforcedStyle: prefer_alias_method
 
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
 Style/NumericPredicate:
   EnforcedStyle: comparison
 
@@ -79,13 +87,13 @@ Style/RegexpLiteral:
 Style/SignalException:
   Enabled: false
 
-Layout/AlignParameters:
+Layout/ParameterAlignment:
   EnforcedStyle: with_fixed_indentation
 
-Layout/IndentHash:
+Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
 
-Layout/AlignHash:
+Layout/HashAlignment:
   # allow coder to get around alignment rules by explicitly defining the hash param
   EnforcedLastArgumentHashStyle: ignore_explicit
 

data/danger-wcc.gemspec

@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'webmock', '~> 3.1'
 
   # Linting code and docs
-  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop', '~> 0.81'
   spec.add_development_dependency 'yard'
 
   # Makes testing easy via `bundle exec guard`

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DangerWCC
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/lib/wcc/commit_lint.rb

@@ -102,7 +102,7 @@ class Danger::DangerWCC < Danger::Plugin
       return unless c.fail?
 
       messaging.issue([c.message, message[:sha]].join("\n"),
-        severity: severity)
+                      severity: severity)
     end
 
     def checkers
@@ -141,6 +141,7 @@ class Danger::DangerWCC < Danger::Plugin
 
     def warning_checks
       return checks if @config[:warn] == :all
+
       @config[:warn] || []
     end
 

data/lib/wcc/jshint.rb

@@ -56,8 +56,8 @@ class Danger::DangerWCC < Danger::Plugin
       )
 
       plugin.warn(warning.captures[2],
-        file: warning.captures[0],
-        line: warning.captures[1].to_i)
+                  file: warning.captures[0],
+                  line: warning.captures[1].to_i)
     end
   end
 end

data/lib/wcc/plugin.rb

@@ -12,23 +12,26 @@ class Danger::DangerWCC < Danger::Plugin
   include Utils
   include Github
 
-  CHECKS = %i[
-    rubocop_exceptions
-    todos
-    commit_lint
-    reek
-    flay
-    brakeman
-    jshint
-  ].freeze
+  DEFAULT_OPTIONS = {
+    rubocop_exceptions: true,
+    flay: true,
+    todos: true,
+    brakeman: true,
+    commit_lint: false,
+    reek: false,
+    jshint: false
+  }.freeze
 
   # Runs all the included checks in the plugin
   def all(options = {})
-    to_run = CHECKS.reject { |check_name| options[check_name] == false }
+    options = DEFAULT_OPTIONS.merge(options)
+
+    to_run = options.keys.reject { |check_name| options[check_name] == false }
     raise ArgumentError, 'No Enabled Checks' if to_run.empty?
 
     to_run.each do |check_name|
-      public_send(check_name, options.fetch(check_name, {}))
+      check_options = options.fetch(check_name, {})
+      public_send(check_name, check_options == true ? {} : check_options)
     end
   end
 

data/lib/wcc/reek.rb

@@ -49,8 +49,8 @@ class Danger::DangerWCC < Danger::Plugin
 
       line_info = with_line_number.match(/^\s*([^\:]+)\:(\d+)\:/i)
       plugin.warn(format_links_as_markdown(warning.captures[0]),
-        file: line_info.captures[0],
-        line: line_info.captures[1].to_i)
+                  file: line_info.captures[0],
+                  line: line_info.captures[1].to_i)
     end
   end
 end

data/lib/wcc/rubocop_exceptions.rb

@@ -6,9 +6,9 @@ class Danger::DangerWCC < Danger::Plugin
   class RubocopExceptions
     include Utils
 
-    DISABLE_REGEX = /^(?:\+\s)?.*\#\s*rubocop\:disable\s+(\S+)/i
-    ENABLE_REGEX = /^(?:\+\s)?\s*\#\s*rubocop\:enable\s+(\S+)/i
-    COMMENT_LINE_REGEX = /^(?:\+\s)?\s*\#\s*(.+)$/i
+    DISABLE_REGEX = /^(?:\+\s)?.*\#\s*rubocop\:disable\s+(\S+)/i.freeze
+    ENABLE_REGEX = /^(?:\+\s)?\s*\#\s*rubocop\:enable\s+(\S+)/i.freeze
+    COMMENT_LINE_REGEX = /^(?:\+\s)?\s*\#\s*(.+)$/i.freeze
 
     def initialize(plugin, options = {})
       @plugin = plugin
@@ -20,7 +20,7 @@ class Danger::DangerWCC < Danger::Plugin
         message = build_message(e)
         severity = message_severity(e)
         issue(message,
-          severity: severity, file: e[:file], line: e[:disabled_at])
+              severity: severity, file: e[:file], line: e[:disabled_at])
       end
     end
 
@@ -35,7 +35,7 @@ class Danger::DangerWCC < Danger::Plugin
         else
           "  \nPlease provide an explanation why this rule was disabled."
         end
-      unless e[:reenabled]
+      unless e[:inline] || e[:reenabled]
         message += "\n\nThe rule was not reenabled!\n"\
           'Please add a `rubocop:enable` comment so the rule is disabled '\
           'for the minimal scope.'
@@ -44,7 +44,7 @@ class Danger::DangerWCC < Danger::Plugin
     end
 
     def message_severity(e)
-      if !e[:reenabled]
+      if !e[:inline] && !e[:reenabled]
         'fail'
       elsif e[:context_lines].empty?
         'warn'
@@ -60,18 +60,23 @@ class Danger::DangerWCC < Danger::Plugin
       end
     end
 
+    # rubocop:disable Metrics/AbcSize
     def make_violation(file_contents, hunk, line, rule)
+      is_inline_comment = !/^\s*\+?\s*\#/.match(line.content)
+
       reenable_line_offset = find_reenable(file_contents,
-        line.line_number.right,
-        rule)
+                                           line.line_number.right,
+                                           rule)
 
       {
         rule: rule,
         disabled_at: line.line_number.right,
+        inline: is_inline_comment,
         reenabled: !reenable_line_offset.nil?,
         context_lines: find_context(hunk.lines.drop(hunk.lines.index(line)))
       }
     end
+    # rubocop:enable Metrics/AbcSize
 
     def find_context(diff_lines)
       # search for all non-`rubocop:` comment lines immediately

data/lib/wcc/todos.rb

@@ -6,8 +6,8 @@ class Danger::DangerWCC < Danger::Plugin
   class Todos
     include Utils
 
-    TODO_REGEX = /^\+.*\#.*TODO:?/i
-    LINK_REGEX = /\#.*(https?\:\/\/\S+)/i
+    TODO_REGEX = /^\+.*\#.*TODO:?/i.freeze
+    LINK_REGEX = /\#.*(https?\:\/\/\S+)/i.freeze
 
     def initialize(plugin, options = {})
       @plugin = plugin
@@ -26,11 +26,11 @@ class Danger::DangerWCC < Danger::Plugin
       if result[:link]
         plugin.message "TODO added in #{result[:file_link]} "\
           "referencing [#{result[:link]}](#{result[:link]})",
-          file: result[:file], line: result[:line]
+                       file: result[:file], line: result[:line]
       else
         plugin.warn "TODO added in #{result[:file_link]} - "\
           'is there a card associated with that?',
-          file: result[:file], line: result[:line]
+                    file: result[:file], line: result[:line]
       end
     end
 
@@ -72,6 +72,7 @@ class Danger::DangerWCC < Danger::Plugin
     def max(a, b)
       return a if b.nil?
       return b if a.nil?
+
       a > b ? a : b
     end
   end

data/lib/wcc/utils.rb

@@ -12,6 +12,7 @@ module Utils
 
   def logger
     return @logger if @logger
+
     @logger = Logger.new(STDERR)
     @logger.level = ENV['DANGER_LOG_LEVEL'] ||
       (plugin.verbose ? Logger::INFO : Logger::ERROR)

data/spec/fixtures/exception_inline_disabled_rule.diff

@@ -0,0 +1,12 @@
+diff --git a/spec/fixtures/rubocop_exception.rb b/spec/fixtures/rubocop_exception.rb
+index eee0aa0..5a0e804 100644
+--- a/spec/fixtures/rubocop_exception.rb
++++ b/spec/fixtures/rubocop_exception.rb
+@@ -36,4 +36,7 @@ module RubocopException
+     }
+     # rubocop:enable Layout/AlignHash
+   end
++
++  def some_inline_disabled_rule # rubocop:disable Rails/SomeRule
++  end
+ end

data/spec/fixtures/rubocop_exception.rb

@@ -36,4 +36,7 @@ module RubocopException
     }
     # rubocop:enable Layout/AlignHash
   end
+
+  def some_inline_disabled_rule # rubocop:disable Rails/SomeRule
+  end
 end

data/spec/wcc/commit_lint_spec.rb

@@ -16,7 +16,7 @@ TEST_MESSAGES = {
     'separating the subject and the body.",
   all_errors: "this is a really long subject and it even ends in a period.\n'\
     'Not to mention the missing empty line!",
-  valid:  "This is a valid message\n\nYou can tell because it meets all the '\
+  valid: "This is a valid message\n\nYou can tell because it meets all the '\
     'criteria and the linter does not complain."
 }.freeze
 
@@ -130,7 +130,7 @@ module Danger
 
               checks.each do |check, _|
                 commit = double(:commit,
-                  message: TEST_MESSAGES[check], sha: sha)
+                                message: TEST_MESSAGES[check], sha: sha)
                 allow(@git).to receive(:commits).and_return([commit])
 
                 commit_lint disable: [check]
@@ -193,7 +193,7 @@ module Danger
 
               checks.each do |check, warning|
                 commit = double(:commit,
-                  message: TEST_MESSAGES[check], sha: sha)
+                                message: TEST_MESSAGES[check], sha: sha)
                 allow(@git).to receive(:commits).and_return([commit])
 
                 expect {
@@ -279,7 +279,7 @@ module Danger
 
               checks.each do |check, warning|
                 commit = double(:commit,
-                  message: TEST_MESSAGES[check], sha: sha)
+                                message: TEST_MESSAGES[check], sha: sha)
                 allow(@git).to receive(:commits).and_return([commit])
 
                 expect {
@@ -367,7 +367,7 @@ module Danger
 
             options.each_with_index do |(check, opts), i|
               commit = double(:commit,
-                message: TEST_MESSAGES[:valid], sha: sha)
+                              message: TEST_MESSAGES[:valid], sha: sha)
               allow(@git).to receive(:commits).and_return([commit])
 
               arg = {}

data/spec/wcc/github_spec.rb

@@ -37,8 +37,10 @@ module Danger
       end
 
       it '#add_labels adds existing labels to issue' do
-        stub = stub_request(:post,
-          API_URL + '/repos/watermarkchurch/danger-wcc/issues/2/labels')
+        stub = stub_request(
+          :post,
+          API_URL + '/repos/watermarkchurch/danger-wcc/issues/2/labels'
+        )
           .with(body: '["backlog","bug","duplicate"]')
 
         # act
@@ -49,11 +51,15 @@ module Danger
       end
 
       it '#add_labels creates new labels before adding to issue' do
-        stub = stub_request(:post,
-          API_URL + '/repos/watermarkchurch/danger-wcc/labels')
+        stub = stub_request(
+          :post,
+          API_URL + '/repos/watermarkchurch/danger-wcc/labels'
+        )
           .with(body: '{"name":"new_label","color":"ffffff"}')
-        stub_request(:post,
-          API_URL + '/repos/watermarkchurch/danger-wcc/issues/2/labels')
+        stub_request(
+          :post,
+          API_URL + '/repos/watermarkchurch/danger-wcc/issues/2/labels'
+        )
           .with(body: '["backlog","new_label"]')
 
         # act

data/spec/wcc/plugin_spec.rb

@@ -16,18 +16,21 @@ module Danger
     end
 
     describe 'all' do
-      it 'runs all checks and passes default options' do
-        Danger::DangerWCC::CHECKS.each do |check|
+      it 'runs all default and passes default options' do
+        %i[rubocop_exceptions flay todos brakeman].each do |check|
           expect(@my_plugin).to receive(check)
             .with({})
         end
+        %i[commit_lint reek jshint].each do |check|
+          expect(@my_plugin).to_not receive(check)
+        end
 
         # act
         @my_plugin.all
       end
 
       it 'errors if all checks disabled' do
-        disabled = Danger::DangerWCC::CHECKS
+        disabled = Danger::DangerWCC::DEFAULT_OPTIONS.keys
         options = disabled.each_with_object({}) { |v, h| h[v] = false; }
 
         # expect
@@ -42,20 +45,18 @@ module Danger
       end
 
       it 'runs only enabled checks' do
-        enabled = %i[todos commit_lint]
-        disabled =
-          Danger::DangerWCC::CHECKS.reject do |check|
-            enabled.include?(check)
-          end
-        options = disabled.each_with_object({}) { |v, h| h[v] = false; }
+        options = {
+          rubocop_exceptions: false,
+          todos: false,
+          brakeman: false,
+          reek: true
+        }
 
         # expect
-        enabled.each do |check|
-          expect(@my_plugin).to receive(check)
-        end
-        disabled.each do |check|
-          expect(@my_plugin).to_not receive(check)
-        end
+        expect(@my_plugin).to receive(:reek)
+        expect(@my_plugin).to receive(:flay)
+        expect(@my_plugin).to_not receive(:rubocop_exceptions)
+        expect(@my_plugin).to_not receive(:commit_lint)
 
         # act
         @my_plugin.all options
@@ -63,7 +64,7 @@ module Danger
 
       it 'passes options' do
         options =
-          Danger::DangerWCC::CHECKS.each_with_object({}) do |v, h|
+          Danger::DangerWCC::DEFAULT_OPTIONS.keys.each_with_object({}) do |v, h|
             h[v] = false
           end
         options[:commit_lint] = { test: { options: 1 } }

data/spec/wcc/rubocop_exceptions_spec.rb

@@ -30,9 +30,9 @@ module Danger
           .to eq([Violation.new('Rubocop rule Rails/SomeRule disabled in '\
             '<a href="github_html_link">spec/fixtures/rubocop_exception.rb</a>'\
               "  \nPlease provide an explanation why this rule was disabled.",
-            false,
-            'spec/fixtures/rubocop_exception.rb',
-            5)])
+                                false,
+                                'spec/fixtures/rubocop_exception.rb',
+                                5)])
       end
 
       it 'Errors when rubocop exception not reenabled' do
@@ -52,9 +52,28 @@ module Danger
               "\n\nThe rule was not reenabled!\n"\
               'Please add a `rubocop:enable` comment so the rule is disabled '\
               'for the minimal scope.',
-            false,
+                                false,
+                                'spec/fixtures/rubocop_exception.rb',
+                                10)])
+      end
+
+      it 'does not require reenabling for inline comments' do
+        allow(@git).to receive(:diff)
+          .and_return([load_diff(
             'spec/fixtures/rubocop_exception.rb',
-            10)])
+            'exception_inline_disabled_rule'
+          )])
+
+        # act
+        @my_plugin.rubocop_exceptions
+
+        expect(@dangerfile.violation_report[:warnings])
+          .to eq([Violation.new('Rubocop rule Rails/SomeRule disabled in '\
+            '<a href="github_html_link">spec/fixtures/rubocop_exception.rb</a>'\
+              "  \nPlease provide an explanation why this rule was disabled.",
+                                false,
+                                'spec/fixtures/rubocop_exception.rb',
+                                40)])
       end
 
       it 'Messages when exception added with context' do
@@ -71,9 +90,9 @@ module Danger
           .to eq([Violation.new('Rubocop rule Metrics/LineLength disabled in '\
             '<a href="github_html_link">spec/fixtures/rubocop_exception.rb</a>'\
             "  explanation:\n\t> Disabling because I want to.",
-            false,
-            'spec/fixtures/rubocop_exception.rb',
-            15)])
+                                false,
+                                'spec/fixtures/rubocop_exception.rb',
+                                15)])
       end
 
       it 'Messages when exception added with multiline context' do
@@ -92,9 +111,9 @@ module Danger
             '  explanation:'\
             "\n\t> I want to disable this because.."\
             "\n\t> I forgot the reasons.",
-            false,
-            'spec/fixtures/rubocop_exception.rb',
-            30)])
+                                false,
+                                'spec/fixtures/rubocop_exception.rb',
+                                30)])
       end
 
       it 'Messages when exception added in between existing comments' do
@@ -112,9 +131,9 @@ module Danger
             '<a href="github_html_link">spec/fixtures/rubocop_exception.rb</a>'\
             '  explanation:'\
             "\n\t> here is my comment why we are disabling ABC",
-            false,
-            'spec/fixtures/rubocop_exception.rb',
-            21)])
+                                false,
+                                'spec/fixtures/rubocop_exception.rb',
+                                21)])
       end
 
       it 'Does not message when no exception added' do

data/spec/wcc/todos_spec.rb

@@ -27,9 +27,9 @@ module Danger
           .to eq([Violation.new('TODO added in '\
             '<a href="github_html_link">spec/fixtures/todo.rb</a>'\
               ' - is there a card associated with that?',
-            false,
-            'spec/fixtures/todo.rb',
-            9)])
+                                false,
+                                'spec/fixtures/todo.rb',
+                                9)])
       end
 
       it 'Does not warn when TODO removed' do
@@ -68,9 +68,9 @@ module Danger
             '<a href="github_html_link">spec/fixtures/todo.rb</a> '\
               'referencing [https://zube.io/watermark/asdf1234]'\
               '(https://zube.io/watermark/asdf1234)',
-            false,
-            'spec/fixtures/todo.rb',
-            13)])
+                                false,
+                                'spec/fixtures/todo.rb',
+                                13)])
       end
 
       it 'Sends message when todo below link' do
@@ -87,9 +87,9 @@ module Danger
             '<a href="github_html_link">spec/fixtures/todo.rb</a> '\
               'referencing [https://www.github.com/watermarkchurch/asdf/1234]'\
               '(https://www.github.com/watermarkchurch/asdf/1234)',
-            false,
-            'spec/fixtures/todo.rb',
-            18)])
+                                false,
+                                'spec/fixtures/todo.rb',
+                                18)])
       end
     end
   end

data/spec/wcc/utils_spec.rb

@@ -50,7 +50,7 @@ module Danger
             [
               load_diff('spec/fixtures/todo.rb', 'no_todo'),
               load_diff('spec/fixtures/find_in_diff.rb',
-                'find_in_diff_2_chunks')
+                        'find_in_diff_2_chunks')
             ]
           )
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-wcc
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Watermark Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-24 00:00:00.000000000 Z
+date: 2020-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brakeman
@@ -154,16 +154,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.81'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.81'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -291,6 +291,7 @@ files:
 - spec/fixtures/brakeman/brakeman.diff
 - spec/fixtures/brakeman/brakeman.out
 - spec/fixtures/exception_context.diff
+- spec/fixtures/exception_inline_disabled_rule.diff
 - spec/fixtures/exception_insert_context.diff
 - spec/fixtures/exception_misspelled.diff
 - spec/fixtures/exception_multiline_context.diff
@@ -356,6 +357,7 @@ test_files:
 - spec/fixtures/brakeman/brakeman.diff
 - spec/fixtures/brakeman/brakeman.out
 - spec/fixtures/exception_context.diff
+- spec/fixtures/exception_inline_disabled_rule.diff
 - spec/fixtures/exception_insert_context.diff
 - spec/fixtures/exception_misspelled.diff
 - spec/fixtures/exception_multiline_context.diff