Sha256: 66cbde796c5ef620dd6d7e3976ae0a32fa2c155ba1419c45c11d2928b8ca866b

Contents?: true

Size: 1.25 KB

Versions: 10

Compression:

Stored size: 1.25 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 providing the value for a metric using a keyword argument, which is
      # deprecated. Use the following Rubocop invocation to check your project's codebase:
      #
      #    rubocop --require \
      #      `bundle show statsd-instrument`/lib/statsd/instrument/rubocop.rb \
      #      --only StatsD/MetricValueKeywordArgument
      #
      # This cop will not autocorrect offenses. Most of the time, these are easy to fix by providing the
      # value as the second argument, rather than a keyword argument.
      #
      # `StatsD.increment('foo', value: 3)` => `StatsD.increment('foo', 3)`
      class MetricValueKeywordArgument < Cop
        include RuboCop::Cop::StatsD

        MSG = <<~MSG
          Do not use the StatsD.metric('name', value: <value>, ...). The `value` keyword argument is deprecated.

          Use a positional argument instead: StatsD.metric('name', <value>, ...).
        MSG

        def on_send(node)
          if metric_method?(node) && has_keyword_argument?(node, :value)
            add_offense(node)
          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_value_keyword_argument.rb
statsd-instrument-3.9.1 lib/statsd/instrument/rubocop/metric_value_keyword_argument.rb
statsd-instrument-3.9.0 lib/statsd/instrument/rubocop/metric_value_keyword_argument.rb
statsd-instrument-3.8.0 lib/statsd/instrument/rubocop/metric_value_keyword_argument.rb
statsd-instrument-3.7.0 lib/statsd/instrument/rubocop/metric_value_keyword_argument.rb
statsd-instrument-3.6.1 lib/statsd/instrument/rubocop/metric_value_keyword_argument.rb
statsd-instrument-3.6.0 lib/statsd/instrument/rubocop/metric_value_keyword_argument.rb
statsd-instrument-3.5.12 lib/statsd/instrument/rubocop/metric_value_keyword_argument.rb
statsd-instrument-3.5.11 lib/statsd/instrument/rubocop/metric_value_keyword_argument.rb
statsd-instrument-3.5.10 lib/statsd/instrument/rubocop/metric_value_keyword_argument.rb