Sha256: bf7e9e8f31ceffab432ff95b38cb9ed2e8de693cf6914d847508d5dade28bb76

Contents?: true

Size: 1.19 KB

Versions: 10

Compression:

Stored size: 1.19 KB

Contents

# frozen_string_literal: true

require_relative "../rubocop" unless defined?(RuboCop::Cop::StatsD)

module RuboCop
  module Cop
    module StatsD
      # This Rubocop will check for using the return value of StatsD metric calls, which is deprecated.
      # To check your codebase, use the following Rubocop invocation:
      #
      #     rubocop --require `bundle show statsd-instrument`/lib/statsd/instrument/rubocop.rb \
      #       --only StatsD/MetricReturnValue
      #
      # This cop cannot autocorrect offenses. In production code, StatsD should be used in a fire-and-forget
      # fashion. This means that you shouldn't rely on the return value. If you really need to access the
      # emitted metrics, you can look into `capture_statsd_calls`
      class MetricReturnValue < Cop
        include RuboCop::Cop::StatsD

        MSG = "Do not use the return value of StatsD metric methods"

        INVALID_PARENTS = [:lvasgn, :array, :pair, :send, :return, :yield]

        def on_send(node)
          if metric_method?(node) && node.arguments.last&.type != :block_pass
            add_offense(node.parent) if INVALID_PARENTS.include?(node.parent&.type)
          end
        end
      end
    end
  end
end

Version data entries

10 entries across 10 versions & 1 rubygems

Version Path
statsd-instrument-3.9.2 lib/statsd/instrument/rubocop/metric_return_value.rb
statsd-instrument-3.9.1 lib/statsd/instrument/rubocop/metric_return_value.rb
statsd-instrument-3.9.0 lib/statsd/instrument/rubocop/metric_return_value.rb
statsd-instrument-3.8.0 lib/statsd/instrument/rubocop/metric_return_value.rb
statsd-instrument-3.7.0 lib/statsd/instrument/rubocop/metric_return_value.rb
statsd-instrument-3.6.1 lib/statsd/instrument/rubocop/metric_return_value.rb
statsd-instrument-3.6.0 lib/statsd/instrument/rubocop/metric_return_value.rb
statsd-instrument-3.5.12 lib/statsd/instrument/rubocop/metric_return_value.rb
statsd-instrument-3.5.11 lib/statsd/instrument/rubocop/metric_return_value.rb
statsd-instrument-3.5.10 lib/statsd/instrument/rubocop/metric_return_value.rb