rubocop-vendor 0.2.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5072a6d34dc157a8067353787c18de1f0d29391bcd444200db28663b207a69ba
-  data.tar.gz: 13f6b9f89c3f88aff7933d52d3f62eaa52e6ced21a90a25add5321a20083ea96
+  metadata.gz: 69207722d1f85c15ec43d9206abb228f4051f9bf5bb6df6891975427ffbcee57
+  data.tar.gz: 37d1f7a6075504487894018da7f7adb11d70c7e9d774f7a659c9a20f372e93d5
 SHA512:
-  metadata.gz: 5850e36f8d60e097beffbea26dd32453a3201ec49447dbec1e033eb200f99b54af2ebdc63557ed45e6741a09d0413c346134717b6b786f27a9dec22e22843ee1
-  data.tar.gz: f38f8b445d42bd1eef44dfd270a9a3c89d8093e9572de51acb0bbe1cfaba50bfa57444eda0b3aadd11fc1047e79d46ef2b43be5d4dc4b923d54230411029cf6d
+  metadata.gz: 7d4bb0376770d8be587725522cacf89ee448d4476d2f92a05656c9847d6169935076cefed131de3e2aad36107fb94893cd4197d88e034358cb68584f27e63284
+  data.tar.gz: e0e48ef333ed5842e26ba7a8b0e3fa4326f35cd240df0d44685dd6e650ad1714daaf0388e72a5ed6ac4f39d10b59623c3eb69462977e47993cefb2c93ad2365a

data/README.md

@@ -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.0'
+      STRING = '0.6.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-vendor
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Danilo Cabello
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-24 00:00:00.000000000 Z
+date: 2021-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -26,6 +26,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.53.0
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: keepachangelog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -54,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