rubocop-vendor 0.2.1 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe1f462290839dea864712489498d9692d77909835d10c3210f6188683f90e24
-  data.tar.gz: d228e77bcc8c2df232f4160d98765bf2305c12d4fbed668aaaa3f535b0e1a65b
+  metadata.gz: 14c18d2f337b52f8134c40f8e43c92e68a2124fe963c28f51538305f10c256d0
+  data.tar.gz: ee0e68653af5d24dd75d29a894c8da2725030c92714e75924603db2c984e3430
 SHA512:
-  metadata.gz: 8f231f57b14ff0aeba3c034863f4dc5eec541c15b0f2d6e035c4205101739c6b23684ab1934c8b8e071e0f33c8fe14a9677a5ea224ab4e6905bec7f88dbe23c7
-  data.tar.gz: 0c14aad1fc61dd8010d6b01476441a43293d29807051d5c4e0625eb9cea9e9a5705644826b7e9a1e0a5c8afdaec4f76e00bc45f7ec4007e61283e21903c69b4a
+  metadata.gz: 96d0eb7c18afbe8711722aa88d9a75adc25284ce437c97e565d74a0218f2b9a9e473fba2de7cf417360a059a288ff7b42a21d594de1c27f1044124d1c3d2ced0
+  data.tar.gz: 0e7efef91d82dbf624c5726713539f35dd49a760235396eebff75dca84b17e80d778ec9c81882c4a93c59b3597162c3dee57e59d0cbe492218d8eaa5d50637e3

data/README.md

@@ -1,7 +1,7 @@
-# RuboCop Vendor
+# rubocop-vendor
 
 [![Gem Version](https://badge.fury.io/rb/rubocop-vendor.svg)](https://badge.fury.io/rb/rubocop-vendor)
-[![CircleCI](https://circleci.com/gh/wealthsimple/rubocop-vendor.svg?style=svg)](https://circleci.com/gh/wealthsimple/rubocop-vendor)
+[![GitHub Actions Badge](https://github.com/wealthsimple/rubocop-vendor/actions/workflows/main.yml/badge.svg)](https://github.com/wealthsimple/rubocop-vendor/actions)
 
 Vendor integration analysis for your projects, as an extension to [RuboCop](https://github.com/rubocop-hq/rubocop).
 
@@ -59,7 +59,7 @@ In your `.rubocop.yml`, you may treat the Vendor cops just like any other
 cop. For example:
 
 ```yaml
-Vednor/RollbarLogger:
+Vendor/RollbarLogger:
   Exclude:
     - lib/example.rb
 ```

data/lib/rubocop/cop/vendor/rollbar_inside_rescue.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Vendor
+      # This cop checks for Rollbar calls outside `rescue` blocks.
+      #
+      # The main reason for this suggestion is that Rollbar should not be used
+      # as a logger given it has a quota that is often multiple times smaller
+      # than the log quota. By reporting errors outside rescue blocks
+      # the developer is most likely in control of the exceptional flow and
+      # won't need a stack trace.
+      #
+      # @example
+      #   # bad
+      #   Rollbar.error("Unable to sync account")
+      #
+      #   # good
+      #   begin
+      #     1 / 0
+      #   rescue StandardError => exception
+      #     Rollbar.error(exception, "Unable to sync account")
+      #   end
+      #
+      #   # good
+      #   class ApplicationController < ActionController::Base
+      #     rescue_from InvalidRecord do |e|
+      #       Rollbar.error(e)
+      #     end
+      #   end
+      #
+      class RollbarInsideRescue < Cop
+        MSG = 'Only call Rollbar when handling errors inside a `rescue` block.'
+
+        # @!method rollbar?(node)
+        def_node_matcher :rollbar?, <<-PATTERN
+          (send
+            (const nil? :Rollbar) {:log :debug :info :warning :error :critical} ...)
+        PATTERN
+
+        # @!method active_support_rescuable_block?(node)
+        def_node_matcher :active_support_rescuable_block?, <<-PATTERN
+          (block
+            (send nil? :rescue_from ...) ...)
+        PATTERN
+
+        def on_send(node)
+          return unless rollbar?(node)
+          return if in_rescue_block?(node)
+
+          add_offense(node, location: node.children[0].loc.expression)
+        end
+
+        def in_rescue_block?(node)
+          current_node = node
+
+          while (current_node = current_node.parent)
+            return true if current_node.rescue_type?
+            return true if active_support_rescuable_block?(current_node)
+
+            break if current_node.def_type?
+            break if current_node.class_type?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/vendor/rollbar_interpolation.rb

@@ -19,6 +19,7 @@ module RuboCop
       class RollbarInterpolation < Cop
         MSG = 'Send extra fields as hash parameter instead of interpolated message.'
 
+        # @!method bad_method?(node)
         def_node_matcher :bad_method?, <<-PATTERN
           (send
             (const nil? :Rollbar) {:error :critical}

data/lib/rubocop/cop/vendor/rollbar_log.rb

@@ -16,25 +16,42 @@ module RuboCop
       #   Rollbar.info('Stale message')
       #
       class RollbarLog < Cop
+        include RangeHelp
+
         MSG = 'Use `Rollbar.%<method>s` instead of `Rollbar.log`.'
 
+        # @!method bad_method?(node)
         def_node_matcher :bad_method?, <<-PATTERN
           (send
             (const nil? :Rollbar) :log
-            $({str sym} _) ...)
+            ({str sym} _) ...)
         PATTERN
 
         def on_send(node)
-          level = bad_method?(node)
-          return unless level
+          return unless bad_method?(node)
+
+          add_offense(node, location: offending_range(node))
+        end
 
-          add_offense(level)
+        def autocorrect(node)
+          range = offending_range(node)
+          replacement = "#{node.children[2].value}#{range.source.include?('(') ? '(' : ' '}"
+          lambda do |corrector|
+            corrector.replace(range, replacement)
+          end
         end
 
         private
 
+        def offending_range(node)
+          range_between(
+            node.children[0].loc.last_column + 1,
+            node.children[3].loc.column
+          )
+        end
+
         def message(node)
-          format(MSG, method: node.value)
+          format(MSG, method: node.children[2].value)
         end
       end
     end

data/lib/rubocop/cop/vendor/rollbar_logger.rb

@@ -20,20 +20,20 @@ module RuboCop
       class RollbarLogger < Cop
         MSG = 'Use `Rails.logger` for `debug`, `info` or `warning` calls.'
 
+        # @!method bad_method?(node)
         def_node_matcher :bad_method?, <<-PATTERN
-          (send $(const nil? :Rollbar) {:debug :info :warning} ...)
+          (send (const nil? :Rollbar) {:debug :info :warning} {str hash})
         PATTERN
 
         def on_send(node)
-          rollbar_call = bad_method?(node)
-          return unless rollbar_call
+          return unless bad_method?(node)
 
-          add_offense(rollbar_call)
+          add_offense(node, location: node.children[0].loc.expression)
         end
 
         def autocorrect(node)
           lambda do |corrector|
-            corrector.replace(node.loc.expression, 'Rails.logger')
+            corrector.replace(node.children[0].loc.expression, 'Rails.logger')
           end
         end
       end

data/lib/rubocop/cop/vendor/rollbar_with_exception.rb

@@ -24,6 +24,7 @@ module RuboCop
 
         MSG = 'Send exception as first parameter when calling `error` or `critical`.'
 
+        # @!method bad_method?(node)
         def_node_matcher :bad_method?, <<-PATTERN
           (send
             (const nil? :Rollbar) {:error :critical}

data/lib/rubocop/cop/vendor_cops.rb

@@ -3,6 +3,7 @@
 module RuboCop
 end
 
+require_relative 'vendor/rollbar_inside_rescue'
 require_relative 'vendor/rollbar_interpolation'
 require_relative 'vendor/rollbar_log'
 require_relative 'vendor/rollbar_logger'

data/lib/rubocop/vendor/version.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Vendor
     module Version
-      STRING = '0.2.1'
+      STRING = '0.6.1'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-vendor
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.6.1
 platform: ruby
 authors:
 - Danilo Cabello
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-25 00:00:00.000000000 Z
+date: 2021-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -82,6 +82,7 @@ files:
 - README.md
 - config/default.yml
 - lib/rubocop-vendor.rb
+- lib/rubocop/cop/vendor/rollbar_inside_rescue.rb
 - lib/rubocop/cop/vendor/rollbar_interpolation.rb
 - lib/rubocop/cop/vendor/rollbar_log.rb
 - lib/rubocop/cop/vendor/rollbar_logger.rb
@@ -95,7 +96,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://rubocop-vendor.readthedocs.io/
-  changelog_uri: https://github.com/wealthsimple/rubocop-vendor/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/wealthsimple/rubocop-vendor/blob/main/CHANGELOG.md
   source_code_uri: https://github.com/wealthsimple/rubocop-vendor/
   documentation_uri: https://rubocop-vendor.readthedocs.io/
   bug_tracker_uri: https://github.com/wealthsimple/rubocop-vendor/issues
@@ -107,14 +108,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Automatic vendor integration checking tool for Ruby code.