statsd-instrument 3.0.0.pre1 → 3.1.0

data/lib/statsd/instrument/helpers.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
-module StatsD::Instrument::Helpers
-  def capture_statsd_datagrams(client: nil, &block)
-    client ||= StatsD.singleton_client
-    client.capture(&block)
-  end
+module StatsD
+  module Instrument
+    module Helpers
+      def capture_statsd_datagrams(client: nil, &block)
+        client ||= StatsD.singleton_client
+        client.capture(&block)
+      end
 
-  # For backwards compatibility
-  alias_method :capture_statsd_calls, :capture_statsd_datagrams
+      # For backwards compatibility
+      alias_method :capture_statsd_calls, :capture_statsd_datagrams
+    end
+  end
 end

data/lib/statsd/instrument/log_sink.rb

@@ -1,24 +1,28 @@
 # frozen_string_literal: true
 
-# @note This class is part of the new Client implementation that is intended
-#   to become the new default in the next major release of this library.
-class StatsD::Instrument::LogSink
-  attr_reader :logger, :severity
+module StatsD
+  module Instrument
+    # @note This class is part of the new Client implementation that is intended
+    #   to become the new default in the next major release of this library.
+    class LogSink
+      attr_reader :logger, :severity
 
-  def initialize(logger, severity: Logger::DEBUG)
-    @logger = logger
-    @severity = severity
-  end
+      def initialize(logger, severity: Logger::DEBUG)
+        @logger = logger
+        @severity = severity
+      end
 
-  def sample?(_sample_rate)
-    true
-  end
+      def sample?(_sample_rate)
+        true
+      end
 
-  def <<(datagram)
-    # Some implementations require a newline at the end of datagrams.
-    # When logging, we make sure those newlines are removed using chomp.
+      def <<(datagram)
+        # Some implementations require a newline at the end of datagrams.
+        # When logging, we make sure those newlines are removed using chomp.
 
-    logger.add(severity, "[StatsD] #{datagram.chomp}")
-    self
+        logger.add(severity, "[StatsD] #{datagram.chomp}")
+        self
+      end
+    end
   end
 end

data/lib/statsd/instrument/matchers.rb

@@ -1,100 +1,119 @@
 # frozen_string_literal: true
 
-require 'rspec/expectations'
-require 'rspec/core/version'
-
-module StatsD::Instrument::Matchers
-  CUSTOM_MATCHERS = {
-    increment: :c,
-    measure: :ms,
-    gauge: :g,
-    histogram: :h,
-    distribution: :d,
-    set: :s,
-    key_value: :kv,
-  }
-
-  class Matcher
-    include RSpec::Matchers::Composable if RSpec::Core::Version::STRING.start_with?('3')
-    include StatsD::Instrument::Helpers
-
-    def initialize(metric_type, metric_name, options = {})
-      @metric_type = metric_type
-      @metric_name = metric_name
-      @options = options
-    end
+require "rspec/expectations"
+require "rspec/core/version"
+
+module StatsD
+  module Instrument
+    module Matchers
+      class Matcher
+        include(RSpec::Matchers::Composable) if RSpec::Core::Version::STRING.start_with?("3")
+        include StatsD::Instrument::Helpers
+
+        def initialize(metric_type, metric_name, options = {})
+          @metric_type = metric_type
+          @metric_name = metric_name
+          @options = options
+        end
 
-    def matches?(block)
-      expect_statsd_call(@metric_type, @metric_name, @options, &block)
-    rescue RSpec::Expectations::ExpectationNotMetError => e
-      @message = e.message
-      false
-    end
+        def matches?(block)
+          expect_statsd_call(@metric_type, @metric_name, @options, &block)
+        rescue RSpec::Expectations::ExpectationNotMetError => e
+          @message = e.message
+          false
+        end
 
-    def failure_message
-      @message
-    end
+        def failure_message
+          @message
+        end
 
-    def failure_message_when_negated
-      "No StatsD calls for metric #{@metric_name} expected."
-    end
+        def failure_message_when_negated
+          "No StatsD calls for metric #{@metric_name} expected."
+        end
 
-    def supports_block_expectations?
-      true
-    end
+        def supports_block_expectations?
+          true
+        end
 
-    private
+        def description
+          "trigger a statsd call for metric #{@metric_name}"
+        end
 
-    def expect_statsd_call(metric_type, metric_name, options, &block)
-      metrics = capture_statsd_calls(&block)
-      metrics = metrics.select { |m| m.type == metric_type && m.name == metric_name }
+        private
 
-      if metrics.empty?
-        raise RSpec::Expectations::ExpectationNotMetError, "No StatsD calls for metric #{metric_name} were made."
-      elsif options[:times] && options[:times] != metrics.length
-        raise RSpec::Expectations::ExpectationNotMetError, "The numbers of StatsD calls for metric #{metric_name} " \
-         "was unexpected. Expected #{options[:times].inspect}, got #{metrics.length}"
-      end
+        def expect_statsd_call(metric_type, metric_name, options, &block)
+          metrics = capture_statsd_calls(&block)
+          metrics = metrics.select { |m| m.type == metric_type && m.name == metric_name }
+
+          if metrics.empty?
+            raise RSpec::Expectations::ExpectationNotMetError, "No StatsD calls for metric #{metric_name} were made."
+          elsif options[:times] && options[:times] != metrics.length
+            raise RSpec::Expectations::ExpectationNotMetError, "The numbers of StatsD calls for metric " \
+             "#{metric_name} was unexpected. Expected #{options[:times].inspect}, got #{metrics.length}"
+          end
+
+          [:sample_rate, :value, :tags].each do |expectation|
+            next unless options[expectation]
 
-      [:sample_rate, :value, :tags].each do |expectation|
-        next unless options[expectation]
+            num_matches = metrics.count do |m|
+              matcher = RSpec::Matchers::BuiltIn::Match.new(options[expectation])
+              matcher.matches?(m.public_send(expectation))
+            end
 
-        num_matches = metrics.count do |m|
-          matcher = RSpec::Matchers::BuiltIn::Match.new(options[expectation])
-          matcher.matches?(m.public_send(expectation))
+            found = options[:times] ? num_matches == options[:times] : num_matches > 0
+
+            unless found
+              message = metric_information(metric_name, options, metrics, expectation)
+              raise RSpec::Expectations::ExpectationNotMetError, message
+            end
+          end
+
+          true
         end
 
-        found = options[:times] ? num_matches == options[:times] : num_matches > 0
+        def metric_information(metric_name, options, metrics, expectation)
+          message = "expected StatsD #{expectation.inspect} for metric '#{metric_name}' to be called"
+
+          message += "\n  "
+          message += options[:times] ? "exactly #{options[:times]} times" : "at least once"
+          message += " with: #{options[expectation]}"
+
+          message += "\n  captured metric values: #{metrics.map(&expectation).join(", ")}"
 
-        unless found
-          message = metric_information(metric_name, options, metrics, expectation)
-          raise RSpec::Expectations::ExpectationNotMetError, message
+          message
         end
       end
 
-      true
-    end
+      Increment = Class.new(Matcher)
+      Measure = Class.new(Matcher)
+      Gauge = Class.new(Matcher)
+      Set = Class.new(Matcher)
+      Histogram = Class.new(Matcher)
+      Distribution = Class.new(Matcher)
 
-    def metric_information(metric_name, options, metrics, expectation)
-      message = "expected StatsD #{expectation.inspect} for metric '#{metric_name}' to be called"
+      def trigger_statsd_increment(metric_name, options = {})
+        Increment.new(:c, metric_name, options)
+      end
 
-      message += "\n  "
-      message += options[:times] ? "exactly #{options[:times]} times" : "at least once"
-      message += " with: #{options[expectation]}"
+      def trigger_statsd_measure(metric_name, options = {})
+        Measure.new(:ms, metric_name, options)
+      end
 
-      message += "\n  captured metric values: #{metrics.map(&expectation).join(', ')}"
+      def trigger_statsd_gauge(metric_name, options = {})
+        Gauge.new(:g, metric_name, options)
+      end
 
-      message
-    end
-  end
+      def trigger_statsd_set(metric_name, options = {})
+        Set.new(:s, metric_name, options)
+      end
 
-  CUSTOM_MATCHERS.each do |method_name, metric_type|
-    klass = Class.new(Matcher)
+      def trigger_statsd_histogram(metric_name, options = {})
+        Histogram.new(:h, metric_name, options)
+      end
 
-    define_method "trigger_statsd_#{method_name}" do |metric_name, options = {}|
-      klass.new(metric_type, metric_name, options)
+      def trigger_statsd_distribution(metric_name, options = {})
+        Distribution.new(:d, metric_name, options)
+      end
     end
-
-    StatsD::Instrument::Matchers.const_set(method_name.capitalize, klass)
   end
 end

data/lib/statsd/instrument/null_sink.rb

@@ -1,13 +1,17 @@
 # frozen_string_literal: true
 
-# @note This class is part of the new Client implementation that is intended
-#   to become the new default in the next major release of this library.
-class StatsD::Instrument::NullSink
-  def sample?(_sample_rate)
-    true
-  end
+module StatsD
+  module Instrument
+    # @note This class is part of the new Client implementation that is intended
+    #   to become the new default in the next major release of this library.
+    class NullSink
+      def sample?(_sample_rate)
+        true
+      end
 
-  def <<(_datagram)
-    self # noop
+      def <<(_datagram)
+        self # noop
+      end
+    end
   end
 end

data/lib/statsd/instrument/railtie.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
-# This Railtie runs some initializers that will set the logger to <tt>Rails#logger</tt>,
-# and will initialize the {StatsD#backend} based on the Rails environment.
-#
-# @see StatsD::Instrument::Environment
-class StatsD::Instrument::Railtie < Rails::Railtie
-  initializer 'statsd-instrument.use_rails_logger' do
-    ::StatsD.logger = Rails.logger
+module StatsD
+  module Instrument
+    # This Railtie runs some initializers that will set the logger to <tt>Rails#logger</tt>,
+    # and will initialize the {StatsD#backend} based on the Rails environment.
+    #
+    # @see StatsD::Instrument::Environment
+    class Railtie < Rails::Railtie
+      initializer "statsd-instrument.use_rails_logger" do
+        ::StatsD.logger = Rails.logger
+      end
+    end
   end
 end

data/lib/statsd/instrument/rubocop.rb

@@ -72,11 +72,11 @@ module RuboCop
   end
 end
 
-require_relative 'rubocop/metaprogramming_positional_arguments'
-require_relative 'rubocop/metric_return_value'
-require_relative 'rubocop/metric_value_keyword_argument'
-require_relative 'rubocop/positional_arguments'
-require_relative 'rubocop/splat_arguments'
-require_relative 'rubocop/measure_as_dist_argument'
-require_relative 'rubocop/metric_prefix_argument'
-require_relative 'rubocop/singleton_configuration'
+require_relative "rubocop/metaprogramming_positional_arguments"
+require_relative "rubocop/metric_return_value"
+require_relative "rubocop/metric_value_keyword_argument"
+require_relative "rubocop/positional_arguments"
+require_relative "rubocop/splat_arguments"
+require_relative "rubocop/measure_as_dist_argument"
+require_relative "rubocop/metric_prefix_argument"
+require_relative "rubocop/singleton_configuration"

data/lib/statsd/instrument/rubocop/measure_as_dist_argument.rb

@@ -1,6 +1,6 @@
 # frozen-string-literal: true
 
-require_relative '../rubocop' unless defined?(RuboCop::Cop::StatsD)
+require_relative "../rubocop" unless defined?(RuboCop::Cop::StatsD)
 
 module RuboCop
   module Cop

data/lib/statsd/instrument/rubocop/metaprogramming_positional_arguments.rb

@@ -1,6 +1,6 @@
 # frozen-string-literal: true
 
-require_relative '../rubocop' unless defined?(RuboCop::Cop::StatsD)
+require_relative "../rubocop" unless defined?(RuboCop::Cop::StatsD)
 
 module RuboCop
   module Cop
@@ -19,7 +19,7 @@ module RuboCop
       class MetaprogrammingPositionalArguments < Cop
         include RuboCop::Cop::StatsD
 
-        MSG = 'Use keyword arguments for StatsD metaprogramming macros'
+        MSG = "Use keyword arguments for StatsD metaprogramming macros"
 
         def on_send(node)
           if metaprogramming_method?(node)

data/lib/statsd/instrument/rubocop/metric_prefix_argument.rb

@@ -1,6 +1,6 @@
 # frozen-string-literal: true
 
-require_relative '../rubocop' unless defined?(RuboCop::Cop::StatsD)
+require_relative "../rubocop" unless defined?(RuboCop::Cop::StatsD)
 
 module RuboCop
   module Cop

data/lib/statsd/instrument/rubocop/metric_return_value.rb

@@ -1,6 +1,6 @@
 # frozen-string-literal: true
 
-require_relative '../rubocop' unless defined?(RuboCop::Cop::StatsD)
+require_relative "../rubocop" unless defined?(RuboCop::Cop::StatsD)
 
 module RuboCop
   module Cop
@@ -17,7 +17,7 @@ module RuboCop
       class MetricReturnValue < Cop
         include RuboCop::Cop::StatsD
 
-        MSG = 'Do not use the return value of StatsD metric methods'
+        MSG = "Do not use the return value of StatsD metric methods"
 
         INVALID_PARENTS = %i{lvasgn array pair send return yield}
 

data/lib/statsd/instrument/rubocop/metric_value_keyword_argument.rb

@@ -1,6 +1,6 @@
 # frozen-string-literal: true
 
-require_relative '../rubocop' unless defined?(RuboCop::Cop::StatsD)
+require_relative "../rubocop" unless defined?(RuboCop::Cop::StatsD)
 
 module RuboCop
   module Cop

data/lib/statsd/instrument/rubocop/positional_arguments.rb

@@ -1,6 +1,6 @@
 # frozen-string-literal: true
 
-require_relative '../rubocop' unless defined?(RuboCop::Cop::StatsD)
+require_relative "../rubocop" unless defined?(RuboCop::Cop::StatsD)
 
 module RuboCop
   module Cop
@@ -17,7 +17,7 @@ module RuboCop
       class PositionalArguments < Cop
         include RuboCop::Cop::StatsD
 
-        MSG = 'Use keyword arguments for StatsD calls'
+        MSG = "Use keyword arguments for StatsD calls"
 
         POSITIONAL_ARGUMENT_TYPES = Set[:int, :float, :nil]
         UNKNOWN_ARGUMENT_TYPES = Set[:send, :const, :lvar, :splat]
@@ -80,7 +80,7 @@ module RuboCop
 
               tags = positional_arguments[1]
               if tags && tags.type != :nil
-                keyword_arguments << if tags.type == :hash && tags.source[0] != '{'
+                keyword_arguments << if tags.type == :hash && tags.source[0] != "{"
                   "tags: { #{tags.source} }"
                 else
                   "tags: #{tags.source}"
@@ -88,7 +88,7 @@ module RuboCop
               end
 
               unless keyword_arguments.empty?
-                corrector.insert_after(value_argument.source_range, ", #{keyword_arguments.join(', ')}")
+                corrector.insert_after(value_argument.source_range, ", #{keyword_arguments.join(", ")}")
               end
             end
           end

data/lib/statsd/instrument/rubocop/singleton_configuration.rb

@@ -1,6 +1,6 @@
 # frozen-string-literal: true
 
-require_relative '../rubocop' unless defined?(RuboCop::Cop::StatsD)
+require_relative "../rubocop" unless defined?(RuboCop::Cop::StatsD)
 
 module RuboCop
   module Cop

data/lib/statsd/instrument/rubocop/splat_arguments.rb

@@ -1,6 +1,6 @@
 # frozen-string-literal: true
 
-require_relative '../rubocop' unless defined?(RuboCop::Cop::StatsD)
+require_relative "../rubocop" unless defined?(RuboCop::Cop::StatsD)
 
 module RuboCop
   module Cop
@@ -16,7 +16,7 @@ module RuboCop
       class SplatArguments < Cop
         include RuboCop::Cop::StatsD
 
-        MSG = 'Do not use splat arguments in StatsD metric calls'
+        MSG = "Do not use splat arguments in StatsD metric calls"
 
         def on_send(node)
           if metric_method?(node)