statsd-instrument 2.0.7 → 2.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 332aeb4ca9870d03b48fae2f8322f81396e0a70b
-  data.tar.gz: aabec4e189d0e494b77be52fe604a43548b8f4c5
+  metadata.gz: 289395b86a2c3614c55f80acb4e90c5bd0678fa9
+  data.tar.gz: f6025d65f1ff0c564cfb83686baf31f0d06246e8
 SHA512:
-  metadata.gz: b2f06ab8c82e1bfc4f2dfcedc9984d05ec7797e125da782dbca2fe4c60ba2948ec2920e8f3fcdee61e660568f6e2ab961b7694be7f29092f7c29a46d5925f30b
-  data.tar.gz: 9d1e015f071f34af4ca7294269ce923b05222e1297ed798adec1c8d080310fc878e76ece7c7a50dd2a5bf2366d421b4f0d07f437c7a3f38d8c2885e5bf8501a3
+  metadata.gz: becbd08e53ff69ac276c02add7b622da50a48ebf5395cc1fc7170049e39582806ee19f49e7a81cc7cc75a62e5620b5ece73e8a934771d952575a37cf5bdc6783
+  data.tar.gz: a6cbbc09993f6f88f4e48559386052dfdce381fd3532cacdcec1f13293efdb77318a6482a5adc0bc9fe369650086a5dde52dd3aee3674f7ffeb2a7fbb1892c4a

data/README.md

@@ -203,9 +203,11 @@ warning is logged to `StatsD.logger`.
 
 ## Testing
 
-This library comes with a module called `StatsD::Instrument::Assertions` to help you write tests
+This library comes with a module called `StatsD::Instrument::Assertions` and `StatsD::Instrument::Matchers` to help you write tests
 to verify StatsD is called properly.
 
+### minitest
+
 ``` ruby
 class MyTestcase < Minitest::Test
   include StatsD::Instrument::Assertions
@@ -257,6 +259,31 @@ end
 
 ```
 
+### RSpec
+
+```ruby
+RSpec.describe 'Matchers' do
+  context 'trigger_statsd_increment' do
+    it 'will pass if there is exactly one matching StatsD call' do
+      expect { StatsD.increment('counter') }.to trigger_statsd_increment('counter')
+    end
+
+    it 'will pass if it matches the correct number of times' do
+      expect { 
+        2.times do
+          StatsD.increment('counter') 
+        end
+      }.to trigger_statsd_increment('counter', times: 2)
+    end
+
+    it 'will pass if there is no matching StatsD call on negative expectation' do
+      expect { StatsD.increment('other_counter') }.not_to trigger_statsd_increment('counter')
+    end
+  end
+end
+
+```
+
 ## Notes
 
 ### Compatibility

data/lib/statsd/instrument.rb

@@ -354,6 +354,8 @@ end
 require 'statsd/instrument/version'
 require 'statsd/instrument/metric'
 require 'statsd/instrument/backend'
-require 'statsd/instrument/assertions'
 require 'statsd/instrument/environment'
+require 'statsd/instrument/helpers'
+require 'statsd/instrument/assertions'
+require 'statsd/instrument/matchers' if defined?(::RSpec)
 require 'statsd/instrument/railtie' if defined?(Rails)

data/lib/statsd/instrument/assertions.rb

@@ -1,17 +1,5 @@
 module StatsD::Instrument::Assertions
-
-  def capture_statsd_calls(&block)
-    mock_backend = StatsD::Instrument::Backends::CaptureBackend.new
-    old_backend, StatsD.backend = StatsD.backend, mock_backend
-    block.call
-    mock_backend.collected_metrics
-  ensure
-    if old_backend.kind_of?(StatsD::Instrument::Backends::CaptureBackend)
-      old_backend.collected_metrics.concat(mock_backend.collected_metrics)
-    end
-
-    StatsD.backend = old_backend
-  end
+  include StatsD::Instrument::Helpers
 
   def assert_no_statsd_calls(metric_name = nil, &block)
     metrics = capture_statsd_calls(&block)

data/lib/statsd/instrument/helpers.rb

@@ -0,0 +1,14 @@
+module StatsD::Instrument::Helpers
+  def capture_statsd_calls(&block)
+    mock_backend = StatsD::Instrument::Backends::CaptureBackend.new
+    old_backend, StatsD.backend = StatsD.backend, mock_backend
+    block.call
+    mock_backend.collected_metrics
+  ensure
+    if old_backend.kind_of?(StatsD::Instrument::Backends::CaptureBackend)
+      old_backend.collected_metrics.concat(mock_backend.collected_metrics)
+    end
+
+    StatsD.backend = old_backend
+  end
+end

data/lib/statsd/instrument/matchers.rb

@@ -0,0 +1,72 @@
+require 'rspec/expectations'
+
+module StatsD::Instrument::Matchers
+  CUSTOM_MATCHERS = {
+    increment: :c,
+    measure: :ms,
+    gauge: :g,
+    histogram: :h,
+    set: :s,
+    key_value: :kv
+  }
+
+  class Matcher
+    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)
+      begin
+        expect_statsd_call(@metric_type, @metric_name, @options, &block)
+      rescue RSpec::Expectations::ExpectationNotMetError => e
+        @message = e.message
+
+        false
+      end
+    end
+
+    def failure_message
+      @message
+    end
+
+    def failure_message_when_negated
+      "No StatsD calls for metric #{@metric_name} expected."
+    end
+
+    def supports_block_expectations?
+      true
+    end
+
+    private
+
+    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 }
+
+      raise RSpec::Expectations::ExpectationNotMetError, "No StatsD calls for metric #{metric_name} were made." if metrics.empty?
+      raise RSpec::Expectations::ExpectationNotMetError, "The numbers of StatsD calls for metric #{metric_name} was unexpected. Expected #{options[:times].inspect}, got #{metrics.length}" if options[:times] && options[:times] != metrics.length
+
+      metric = metrics.first
+
+      raise RSpec::Expectations::ExpectationNotMetError, "Unexpected value submitted for StatsD metric #{metric_name}" if options[:sample_rate] && options[:sample_rate] != metric.sample_rate
+      raise RSpec::Expectations::ExpectationNotMetError, "Unexpected StatsD sample rate for metric #{metric_name}" if options[:value] && options[:value] != metric.value
+      raise RSpec::Expectations::ExpectationNotMetError, "Unexpected StatsD tags for metric #{metric_name}" if options[:tags] && options[:tags] != metric.tags
+
+      true
+    end
+  end
+
+  CUSTOM_MATCHERS.each do |method_name, metric_type|
+    klass = Class.new(Matcher)
+
+    define_method "trigger_statsd_#{method_name}" do |metric_name, options = {}|
+      klass.new(metric_type, metric_name, options)
+    end
+
+    StatsD::Instrument::Matchers.const_set(method_name.capitalize, klass)
+  end
+end

data/lib/statsd/instrument/metric.rb

@@ -101,8 +101,8 @@ class StatsD::Instrument::Metric
   # @param tags [Array<String>, Hash<String, String>, nil] Tags specified in any form.
   # @return [Array<String>, nil] the list of tags in canonical form.
   def self.normalize_tags(tags)
-    return if tags.nil?
-    tags = tags.map { |k, v| "#{k.to_s.tr(':', '')}:#{v.to_s.tr(':', '')}" } if tags.is_a?(Hash)
+    return unless tags
+    tags = tags.map { |k, v| k.to_s + ":".freeze + v.to_s } if tags.is_a?(Hash)
     tags.map { |tag| tag.tr('|,'.freeze, ''.freeze) }
   end
 end

data/lib/statsd/instrument/version.rb

@@ -1,5 +1,5 @@
 module StatsD
   module Instrument
-    VERSION = "2.0.7"
+    VERSION = "2.0.8"
   end
 end

data/statsd-instrument.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'mocha'
   spec.add_development_dependency 'yard'
   spec.add_development_dependency 'benchmark-ips'

data/test/assertions_test.rb

@@ -1,27 +1,12 @@
 require 'test_helper'
 
 class AssertionsTest < Minitest::Test
-
   def setup
     test_class = Class.new(Minitest::Test)
     test_class.send(:include, StatsD::Instrument::Assertions)
     @test_case = test_class.new('fake')
   end
 
-  def test_capture_metrics_inside_block_only
-    StatsD.increment('counter')
-    metrics = @test_case.capture_statsd_calls do
-      StatsD.increment('counter')
-      StatsD.gauge('gauge', 12)
-    end
-    StatsD.gauge('gauge', 15)
-
-    assert_equal 2, metrics.length
-    assert_equal 'counter', metrics[0].name
-    assert_equal 'gauge', metrics[1].name
-    assert_equal 12, metrics[1].value
-  end
-
   def test_assert_no_statsd_calls
     assert_no_assertion_triggered do
       @test_case.assert_no_statsd_calls('counter') do
@@ -45,7 +30,7 @@ class AssertionsTest < Minitest::Test
       @test_case.assert_no_statsd_calls do
         StatsD.increment('other')
       end
-    end    
+    end
   end
 
   def test_assert_statsd_call
@@ -132,7 +117,7 @@ class AssertionsTest < Minitest::Test
           StatsD.increment('counter2')
         end
       end
-    end    
+    end
 
     assert_assertion_triggered do
       @test_case.assert_statsd_increment('counter1') do

data/test/helpers_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+
+class HelpersTest < Minitest::Test
+  def setup
+    test_class = Class.new(Minitest::Test)
+    test_class.send(:include, StatsD::Instrument::Helpers)
+    @test_case = test_class.new('fake')
+  end
+
+  def test_capture_metrics_inside_block_only
+    StatsD.increment('counter')
+    metrics = @test_case.capture_statsd_calls do
+      StatsD.increment('counter')
+      StatsD.gauge('gauge', 12)
+    end
+    StatsD.gauge('gauge', 15)
+
+    assert_equal 2, metrics.length
+    assert_equal 'counter', metrics[0].name
+    assert_equal 'gauge', metrics[1].name
+    assert_equal 12, metrics[1].value
+  end
+end
+

data/test/matchers_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+require 'statsd/instrument/matchers'
+
+class MatchersTest < Minitest::Test
+  def test_statsd_increment_matched
+    assert StatsD::Instrument::Matchers::Increment.new(:c, 'counter', {}).matches? lambda { StatsD.increment('counter') }
+  end
+
+  def test_statsd_increment_not_matched
+    refute StatsD::Instrument::Matchers::Increment.new(:c, 'counter', {}).matches? lambda { StatsD.increment('not_counter') }
+  end
+
+  def test_statsd_increment_with_times_matched
+    assert StatsD::Instrument::Matchers::Increment.new(:c, 'counter', times: 1).matches? lambda { StatsD.increment('counter') }
+  end
+
+  def test_statsd_increment_with_times_not_matched
+    refute StatsD::Instrument::Matchers::Increment.new(:c, 'counter', times: 2).matches? lambda { StatsD.increment('counter', times: 3) }
+  end
+
+  def test_statsd_increment_with_sample_rate_matched
+    assert StatsD::Instrument::Matchers::Increment.new(:c, 'counter', sample_rate: 0.5).matches? lambda { StatsD.increment('counter', sample_rate: 0.5) }
+  end
+
+  def test_statsd_increment_with_sample_rate_not_matched
+    refute StatsD::Instrument::Matchers::Increment.new(:c, 'counter', sample_rate: 0.5).matches? lambda { StatsD.increment('counter', sample_rate: 0.7) }
+  end
+
+  def test_statsd_increment_with_value_matched
+    assert StatsD::Instrument::Matchers::Increment.new(:c, 'counter', value: 1).matches? lambda { StatsD.increment('counter') }
+  end
+
+  def test_statsd_increment_with_value_not_matched
+    refute StatsD::Instrument::Matchers::Increment.new(:c, 'counter', value: 3).matches? lambda { StatsD.increment('counter') }
+  end
+
+  def test_statsd_increment_with_tags_matched
+    assert StatsD::Instrument::Matchers::Increment.new(:c, 'counter', tags: ['a', 'b']).matches? lambda { StatsD.increment('counter', tags: ['a', 'b']) }
+  end
+
+  def test_statsd_increment_with_tags_not_matched
+    refute StatsD::Instrument::Matchers::Increment.new(:c, 'counter', tags: ['a', 'b']).matches? lambda { StatsD.increment('counter', tags: ['c']) }
+  end
+end

data/test/metric_test.rb

@@ -26,7 +26,7 @@ class MetricTest < Minitest::Test
 
   def test_handle_bad_tags
     assert_equal ['ignored'], StatsD::Instrument::Metric.normalize_tags(['igno|red'])
-    assert_equal ['lolclass:omglol'], StatsD::Instrument::Metric.normalize_tags({ :"lol::class" => "omg::lol" })
+    assert_equal ['lol::class:omg::lol'], StatsD::Instrument::Metric.normalize_tags({ :"lol::class" => "omg::lol" })
   end
 
   def test_rewrite_tags_provided_as_hash

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statsd-instrument
 version: !ruby/object:Gem::Version
-  version: 2.0.7
+  version: 2.0.8
 platform: ruby
 authors:
 - Jesse Storimer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-05 00:00:00.000000000 Z
+date: 2015-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -40,6 +40,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +121,8 @@ files:
 - lib/statsd/instrument/backends/null_backend.rb
 - lib/statsd/instrument/backends/udp_backend.rb
 - lib/statsd/instrument/environment.rb
+- lib/statsd/instrument/helpers.rb
+- lib/statsd/instrument/matchers.rb
 - lib/statsd/instrument/metric.rb
 - lib/statsd/instrument/railtie.rb
 - lib/statsd/instrument/version.rb
@@ -116,8 +132,10 @@ files:
 - test/benchmark/tags.rb
 - test/capture_backend_test.rb
 - test/environment_test.rb
+- test/helpers_test.rb
 - test/integration_test.rb
 - test/logger_backend_test.rb
+- test/matchers_test.rb
 - test/metric_test.rb
 - test/statsd_instrumentation_test.rb
 - test/statsd_test.rb
@@ -152,8 +170,10 @@ test_files:
 - test/benchmark/tags.rb
 - test/capture_backend_test.rb
 - test/environment_test.rb
+- test/helpers_test.rb
 - test/integration_test.rb
 - test/logger_backend_test.rb
+- test/matchers_test.rb
 - test/metric_test.rb
 - test/statsd_instrumentation_test.rb
 - test/statsd_test.rb