statsd-instrument 2.0.10 → 2.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46e2e5b04875e5bd0d24688df4592fd7302dd00e
-  data.tar.gz: c489f07cdcf8e6bf9e41feb71f9e04fb47f24185
+  metadata.gz: 2b3d5d77001c8868328c05e1f62406ab13b92c03
+  data.tar.gz: 32b5ba8a24354acfb72f73ce2e514146e9e3773c
 SHA512:
-  metadata.gz: e01b79500359d7279fe7b2922d7264c9ad6852f610dfee06c5a83794673cbe142f98b3201a543695f6b62e26c8d6aeceee1d0e7c491347d81120e19db5dcc578
-  data.tar.gz: 0b4b9166b6229e01e601d67c9ef94227c6034b5d83ca4006ea0b5dfffa6788f10eccf1d28ae0f3d3fc5ceef97753117b71f48e8d57f9113c76c1bfda59d70024
+  metadata.gz: a94d925a45d26e5b5ebd366cc8aa2d2e61e06a577b79e5f4af908d1114598dad047cd24b0206d7864964be93f6a7e571f6f2d601ed68c26458433151cde8f540
+  data.tar.gz: d1bab44e9942aa4a7e1be4d1af6f88bcf33bf82106d7f8c3c5cfcb957579be583942693f30662f837a26e37f9a7adbadcebeea7a3c980ac06ae14e6931aa9bbc

data/README.md

@@ -87,7 +87,7 @@ StatsD.increment('GoogleBase.insert', 1, sample_rate: 0.1)
 
 #### StatsD.gauge
 
-A gauge is a single numerical value value that tells you the state of the system at a point in time. A good example would be the number of messages in a queue.
+A gauge is a single numerical value that tells you the state of the system at a point in time. A good example would be the number of messages in a queue.
 
 ``` ruby
 StatsD.gauge('GoogleBase.queued', 12, sample_rate: 1.0)
@@ -262,6 +262,10 @@ end
 ### RSpec
 
 ```ruby
+RSpec.configure do |config|
+  config.include StatsD::Instrument::Matchers
+end
+
 RSpec.describe 'Matchers' do
   context 'trigger_statsd_increment' do
     it 'will pass if there is exactly one matching StatsD call' do
@@ -269,9 +273,9 @@ RSpec.describe 'Matchers' do
     end
 
     it 'will pass if it matches the correct number of times' do
-      expect { 
+      expect {
         2.times do
-          StatsD.increment('counter') 
+          StatsD.increment('counter')
         end
       }.to trigger_statsd_increment('counter', times: 2)
     end
@@ -281,7 +285,6 @@ RSpec.describe 'Matchers' do
     end
   end
 end
-
 ```
 
 ## Notes

data/lib/statsd/instrument.rb

@@ -210,17 +210,39 @@ module StatsD
       raise ArgumentError, "already instrumented #{method} for #{self.name}" if method_defined? method_name_without_statsd
       raise ArgumentError, "could not find method #{method} for #{self.name}" unless method_defined?(method) || private_method_defined?(method)
 
+      method_scope = method_visibility(method)
+
       alias_method method_name_without_statsd, method
       yield method_name_without_statsd, method_name_with_statsd, metric_name
       alias_method method, method_name_with_statsd
+
+      private(method_name_without_statsd)
+      send(method_scope, method)
+      private(method_name_with_statsd)
     end
 
     def remove_from_method(method, name, action)
       method_name_without_statsd = :"#{method}_for_#{action}_on_#{self.name}_without_#{name}"
       method_name_with_statsd = :"#{method}_for_#{action}_on_#{self.name}_with_#{name}"
+
+      method_scope = method_visibility(method)
+
       send(:remove_method, method_name_with_statsd)
       alias_method method, method_name_without_statsd
       send(:remove_method, method_name_without_statsd)
+
+      send(method_scope, method)
+    end
+
+    def method_visibility(method)
+      case
+      when private_method_defined?(method)
+        :private
+      when protected_method_defined?(method)
+        :protected
+      else
+        :public
+      end
     end
   end
 

data/lib/statsd/instrument/assertions.rb

@@ -41,8 +41,8 @@ module StatsD::Instrument::Assertions
     assert options[:times] === metrics.length, "The amount of StatsD calls for metric #{metric_name} was unexpected. Expected #{options[:times].inspect}, found #{metrics.length}"
     metric = metrics.first
 
-    assert_equal options[:sample_rate], metric.sample_rate, "Unexpected value submitted for StatsD metric #{metric_name}" if options[:sample_rate]
-    assert_equal options[:value], metric.value, "Unexpected StatsD sample rate for metric #{metric_name}" if options[:value]
+    assert_equal options[:sample_rate], metric.sample_rate, "Unexpected StatsD sample rate for metric #{metric_name}" if options[:sample_rate]
+    assert_equal options[:value], metric.value, "Unexpected value submitted for StatsD metric #{metric_name}" if options[:value]
 
     if options[:tags]
       expected_tags = Set.new(StatsD::Instrument::Metric.normalize_tags(options[:tags]))

data/lib/statsd/instrument/matchers.rb

@@ -11,6 +11,7 @@ module StatsD::Instrument::Matchers
   }
 
   class Matcher
+    include RSpec::Matchers::Composable
     include StatsD::Instrument::Helpers
 
     def initialize(metric_type, metric_name, options = {})
@@ -50,11 +51,13 @@ module StatsD::Instrument::Matchers
       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
+      [:sample_rate, :value, :tags].each do |expectation|
+        next unless options[expectation]
 
-      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
+        if metrics.all? { |m| m.public_send(expectation) != options[expectation] }
+          raise RSpec::Expectations::ExpectationNotMetError, "Unexpected StatsD #{expectation.to_s.gsub('_', ' ')} for metric #{metric_name}"
+        end
+      end
 
       true
     end

data/lib/statsd/instrument/version.rb

@@ -1,5 +1,5 @@
 module StatsD
   module Instrument
-    VERSION = "2.0.10"
+    VERSION = "2.0.11"
   end
 end

data/test/matchers_test.rb

@@ -10,6 +10,16 @@ class MatchersTest < Minitest::Test
     refute StatsD::Instrument::Matchers::Increment.new(:c, 'counter', {}).matches? lambda { StatsD.increment('not_counter') }
   end
 
+  def test_statsd_increment_compound
+    matcher_1 = StatsD::Instrument::Matchers::Increment.new(:c, 'counter', tags: ['a'])
+    matcher_2 = StatsD::Instrument::Matchers::Increment.new(:c, 'counter', tags: ['b'])
+
+    assert RSpec::Matchers::BuiltIn::Compound::And.new(matcher_1, matcher_2).matches? lambda {
+      StatsD.increment('counter', tags: ['a'])
+      StatsD.increment('counter', tags: ['b'])
+    }
+  end
+
   def test_statsd_increment_with_times_matched
     assert StatsD::Instrument::Matchers::Increment.new(:c, 'counter', times: 1).matches? lambda { StatsD.increment('counter') }
   end

data/test/statsd_instrumentation_test.rb

@@ -45,6 +45,26 @@ end
 class GatewaySubClass < ActiveMerchant::Gateway
 end
 
+class InstrumentedClass
+  extend StatsD::Instrument
+
+  def public_and_instrumented
+  end
+  statsd_count :public_and_instrumented, 'InstrumentedClass.public_and_instrumented'
+
+  protected
+
+  def protected_and_instrumented
+  end
+  statsd_count :protected_and_instrumented, 'InstrumentedClass.protected_and_instrumented'
+
+  private
+
+  def private_and_instrumented
+  end
+  statsd_count :private_and_instrumented, 'InstrumentedClass.private_and_instrumented'
+end
+
 ActiveMerchant::Base.extend StatsD::Instrument
 
 class StatsDInstrumentationTest < Minitest::Test
@@ -116,7 +136,7 @@ class StatsDInstrumentationTest < Minitest::Test
     assert_statsd_increment('ActiveMerchant.Base.post_with_block.failure', times: 1) do
       assert_equal 'successful', ActiveMerchant::Base.new.post_with_block { 'successful' }
       assert_equal 'not so successful', ActiveMerchant::Base.new.post_with_block { 'not so successful' }
-    end    
+    end
 
     ActiveMerchant::Base.statsd_remove_count_success :post_with_block, 'ActiveMerchant.Base.post_with_block'
   end
@@ -219,4 +239,67 @@ class StatsDInstrumentationTest < Minitest::Test
 
     ActiveMerchant::Gateway.singleton_class.statsd_remove_count :sync, 'ActiveMerchant.Gateway.sync'
   end
+
+  def test_statsd_doesnt_change_method_scope_of_public_method
+    assert_scope InstrumentedClass, :public_and_instrumented, :public
+
+    assert_statsd_increment('InstrumentedClass.public_and_instrumented') do
+      InstrumentedClass.new.send(:public_and_instrumented)
+    end
+  end
+
+  def test_statsd_doesnt_change_method_scope_of_protected_method
+    assert_scope InstrumentedClass, :protected_and_instrumented, :protected
+
+    assert_statsd_increment('InstrumentedClass.protected_and_instrumented') do
+      InstrumentedClass.new.send(:protected_and_instrumented)
+    end
+  end
+
+  def test_statsd_doesnt_change_method_scope_of_private_method
+    assert_scope InstrumentedClass, :private_and_instrumented, :private
+
+    assert_statsd_increment('InstrumentedClass.private_and_instrumented') do
+      InstrumentedClass.new.send(:private_and_instrumented)
+    end
+  end
+
+  def test_statsd_doesnt_change_method_scope_on_removal_of_public_method
+    assert_scope InstrumentedClass, :public_and_instrumented, :public
+    InstrumentedClass.statsd_remove_count :public_and_instrumented, 'InstrumentedClass.public_and_instrumented'
+    assert_scope InstrumentedClass, :public_and_instrumented, :public
+
+    InstrumentedClass.statsd_count :public_and_instrumented, 'InstrumentedClass.public_and_instrumented'
+  end
+
+  def test_statsd_doesnt_change_method_scope_on_removal_of_protected_method
+    assert_scope InstrumentedClass, :protected_and_instrumented, :protected
+    InstrumentedClass.statsd_remove_count :protected_and_instrumented, 'InstrumentedClass.protected_and_instrumented'
+    assert_scope InstrumentedClass, :protected_and_instrumented, :protected
+
+    InstrumentedClass.statsd_count :protected_and_instrumented, 'InstrumentedClass.protected_and_instrumented'
+  end
+
+  def test_statsd_doesnt_change_method_scope_on_removal_of_private_method
+    assert_scope InstrumentedClass, :private_and_instrumented, :private
+    InstrumentedClass.statsd_remove_count :private_and_instrumented, 'InstrumentedClass.private_and_instrumented'
+    assert_scope InstrumentedClass, :private_and_instrumented, :private
+
+    InstrumentedClass.statsd_count :private_and_instrumented, 'InstrumentedClass.private_and_instrumented'
+  end
+
+  private
+
+  def assert_scope(klass, method, expected_scope)
+    method_scope = case
+    when klass.private_method_defined?(method)
+      :private
+    when klass.protected_method_defined?(method)
+      :protected
+    else
+      :public
+    end
+
+    assert_equal method_scope, expected_scope, "Expected method to be #{expected_scope}"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statsd-instrument
 version: !ruby/object:Gem::Version
-  version: 2.0.10
+  version: 2.0.11
 platform: ruby
 authors:
 - Jesse Storimer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-16 00:00:00.000000000 Z
+date: 2016-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake