hallmonitor 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42d53cff1626075b9bc669c136a0bf7983f5880a
-  data.tar.gz: bd47a1799c522220ea030ecadaa2af429cea63ca
+  metadata.gz: 2d62d082477737cb28427f17c204445f84782d1f
+  data.tar.gz: 949e08d6e519ecbe58cebd50f5b663671e0496ce
 SHA512:
-  metadata.gz: 6a3b4472a87957f81d4fde0c5690a29d1e833b3565c1fd491d5fd121ac93e97d8276ca13b4a37dd634fd70d16cadf1a6e119bba9174bbd0e996591fc3231c6d5
-  data.tar.gz: b80bd2b03fe7879ad46230194c08885d78d972e0d065ca2abc310aed0d8fecfbba34fb10654c8d7362de304afc61ca639fdf0835f035cc712dd3f546732d9425
+  metadata.gz: 6f244f06a3c98c8da024fb9b5e608a3a7cef717ac58092d88eb40b28827d1888286c386d31a48ecc4ef3f1c21e7aedcf6de4184f5f08cdabb11680426fd10e3d
+  data.tar.gz: d0c64796b5c0328f19dab64c63747375ee345b929b106592fc6bd4f27962906cab6cf1ee62c244b08b780e958dd134f795ee0068de234014f66a5e633df9092c

data/hallmonitor.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency("json", [">= 0"])
   s.add_runtime_dependency("statsd-ruby", [">= 0"])
-  s.add_development_dependency("rspec", [">= 2.14"])
+  s.add_development_dependency("rspec", [">= 3.0"])
   s.add_development_dependency("rdoc", [">= 0"])
   s.add_development_dependency("bundler", ["~> 1.3"])
   s.add_development_dependency("pry-byebug", [">= 0"])

data/lib/hallmonitor/monitored.rb

@@ -3,6 +3,12 @@
 module Hallmonitor
   module Monitored
     module ClassMethods
+      # Sets up a timer for a method by symbol.  Method must have already been
+      # defined (ie. put this after the method definition)
+      # @param method_sym [Symbol] method name as a symbol
+      # @options [Hash] Optional settings:
+      #   metric_name: [String] Metric name to emit, defaults to
+      #   "#{underscore(name)}.#{method_sym}"
       def timer_for(method_sym, options = {})
         metric_name = options[:metric_name] || "#{underscore(name)}.#{method_sym}"
         send(:define_method, "#{method_sym}_with_hallmonitor_timer") do |*args|
@@ -15,6 +21,12 @@ module Hallmonitor
         alias_method method_sym, "#{method_sym}_with_hallmonitor_timer".to_sym
       end
 
+      # Sets up a counter for a method by symbol.  Method must have already been
+      # defined (ie. put this after the method definition)
+      # @param method_sym [Symbol] method name as a symbol
+      # @options [Hash] Optional settings:
+      #   metric_name: [String] Metric name to emit, defaults to
+      #   "#{underscore(name)}.#{method_sym}"
       def count_for(method_sym, options = {})
         metric_name = options[:metric_name] || "#{underscore(name)}.#{method_sym}"
         send(:define_method, "#{method_sym}_with_hallmonitor_counter") do |*args|
@@ -36,38 +48,44 @@ module Hallmonitor
         word
       end
     end
-    
+
     def self.included(base)
       base.extend(ClassMethods)
     end
-    
-    ##
+
     # Emits an event: either self or an event if one is passed in, or constructs
     # a base event from the passed in param
-    # If the parameter is a #Hallmonitor::Event, it will be emitted as is.
-    # Otherwise, a new Hallmonitor::Event will be created with the parameter and emitted.
+    # If the parameter is a {Hallmonitor::Event}, it will be emitted as is.
+    # Otherwise, a new {Hallmonitor::Event} will be created with the parameter
+    # and emitted.
+    # @param event [Mixed] The thing to emit, see method description
+    # @return nil
     def emit(event = nil)
-      to_emit = self;
+      to_emit = self
       unless event.nil?
-        to_emit = event.kind_of?(Hallmonitor::Event) ? event : Hallmonitor::Event.new(event)
+        to_emit = event.is_a?(Hallmonitor::Event) ? event : Hallmonitor::Event.new(event)
       end
-      
+
       # If we were given a block, then we want to execute that
       yield(to_emit) if block_given?
-      
+
       Outputter.output(to_emit)
+      nil
     end
 
-    ##
     # Executes and times a block of code and emits a Hallmonitor::TimedEvent
+    # Will emit even if the block raises an error
+    # @param name [String] The name of the event to emit
+    # @return Whatever the block's return value is
     def watch(name)
       event = Hallmonitor::TimedEvent.new(name)
       event.start = Time.now
-      retval = yield(event)
-      event.stop = Time.now
-      emit(event)
-      retval
+      begin
+        yield(event)
+      ensure
+        event.stop = Time.now
+        emit(event)
+      end
     end
   end
 end
-

data/lib/hallmonitor/version.rb

@@ -1,7 +1,7 @@
 module Hallmonitor
   module Version
     MAJOR = 0
-    MINOR = 3
+    MINOR = 4
     PATCH = 0
     BUILD = nil
 

data/spec/monitored_spec.rb

@@ -18,15 +18,15 @@ RSpec::Matchers.define :an_event_with_name do |expected_name|
   match { |actual| actual.is_a?(Hallmonitor::Event) && actual.name == expected_name }
 end
 
-RSpec::Matchers.define :a_timed_event_with_name do |expected_name| 
+RSpec::Matchers.define :a_timed_event_with_name do |expected_name|
   match { |actual| actual.is_a?(Hallmonitor::TimedEvent) && actual.name == expected_name }
 end
 
-describe Hallmonitor::Monitored do
+RSpec.describe Hallmonitor::Monitored do
   subject { Thing.new }
 
   describe '#timer_for' do
-    it 'should emit a timer with an appropriate name' do
+    it 'emits a timer with an appropriate name' do
       expect(Hallmonitor::Outputter).to(
         receive(:output).with(a_timed_event_with_name('thing.timer_for_test')))
       Thing.new.timer_for_test
@@ -34,7 +34,7 @@ describe Hallmonitor::Monitored do
   end
 
   describe '#count_for' do
-    it 'should emit an event with an appropriate name' do
+    it 'emits an event with an appropriate name' do
       expect(Hallmonitor::Outputter).to(
         receive(:output).with(an_event_with_name('thing.count_for_test')))
       Thing.new.count_for_test
@@ -44,31 +44,53 @@ describe Hallmonitor::Monitored do
   describe '#watch' do
     let(:retval) { 'Hello World' }
     let(:name) { 'foo' }
-    before do
-      expect(Hallmonitor::Outputter).to receive(:output).with(a_timed_event_with_name(name))
-    end
-    it 'should return the value the block returns' do
+
+    it 'returns the value the block returns' do
       value = subject.watch(name) do
         retval
       end
       expect(value).to eq(retval)
+
+      value = subject.watch(name) do
+        nil
+      end
+      expect(value).to_not be
+    end
+
+    it 'emits a timer event for the block' do
+      expect(Hallmonitor::Outputter).to(
+        receive(:output).with(a_timed_event_with_name(name)))
+      subject.watch(name) do
+        'foo'
+      end
+    end
+
+    describe 'when the block raises an error' do
+      it 'emits a timer for the block' do
+        expect(Hallmonitor::Outputter).to(
+          receive(:output).with(a_timed_event_with_name(name)))
+        expect {
+          subject.watch(name) do
+            raise 'OOPS!'
+          end
+        }.to raise_error
+      end
     end
   end
 
   describe '#emit' do
     describe 'with a string parameter' do
-      let(:name) {"foo"}
-      before do
-        expect(Hallmonitor::Outputter).to receive(:output).with(an_event_with_name(name))
-      end
+      let(:name) { 'foo' }
 
-      it "should emit an event with the passed in name" do
+      it 'emits an event with the passed in name' do
+        expect(Hallmonitor::Outputter).to(
+          receive(:output).with(an_event_with_name(name)))
         subject.emit(name)
       end
     end
 
     describe 'with a block' do
-      it 'should yield to the block' do
+      it 'yields to the block' do
         yielded = false
         var = nil
         subject.emit('foo') do |thing|
@@ -83,11 +105,9 @@ describe Hallmonitor::Monitored do
 
     describe 'with an event parameter' do
       let(:event) { Hallmonitor::Event.new('bar') }
-      before do
-        expect(Hallmonitor::Outputter).to receive(:output).with(event)
-      end
 
-      it 'should emit the passed in event' do
+      it 'emits the passed in event' do
+        expect(Hallmonitor::Outputter).to receive(:output).with(event)
         subject.emit(event)
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hallmonitor
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Chris TenHarmsel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-14 00:00:00.000000000 Z
+date: 2015-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement