babysitter 0.0.2 → 0.0.4

data/README.md

@@ -7,7 +7,7 @@ When provided with a Logger it will output statistics of progress to the logs.
 
 Add this line to your application's Gemfile:
 
-    gem "babysitter", git: 'git@github.com:lonelyplanet/babysitter.git'
+    gem "babysitter"
 
 And then execute:
 

data/babysitter.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
   gem.add_dependency 'fozzie'
+  gem.add_dependency 'timecop'
 
   gem.add_development_dependency 'awesome_print'
   gem.add_development_dependency 'rspec'

data/lib/babysitter.rb

@@ -4,14 +4,15 @@ require_relative "babysitter/version"
 require_relative "babysitter/null_logger"
 require_relative "babysitter/configuration"
 require_relative "babysitter/logging"
-require_relative "babysitter/progress_counter"
 require_relative "babysitter/progress"
-
+require_relative "babysitter/monitor"
+require_relative "babysitter/counter"
+require 'fozzie'
 
 module Babysitter
 
   def self.monitor(*args)
-    Progress.new(*args)
+    Monitor.new(*args)
   end
 
   def self.configuration
@@ -27,4 +28,4 @@ module Babysitter
   end
 
 
-end
+end

data/lib/babysitter/{progress_counter.rb → counter.rb}

@@ -1,16 +1,17 @@
 module Babysitter
-  class ProgressCounter
+  class Counter
     include Logging
 
-    attr_reader :count, :counting, :template, :logged_count, :stat_name
-    attr_accessor :log_every
+    attr_reader :count, :log_every, :template, :logged_count, :stat_name, :counting
 
-    def initialize(log_every, stat_name=nil)
+    attr_accessor :template
+
+    def initialize(log_every, opts)
       @count = 0
       @logged_count = 0
-      @stat_name = stat_name
-      @counting = :iterations
       @log_every = log_every
+      @stat_name = opts.delete(:stat_name)
+      @counting = opts.delete(:counting)
       @timer_start = Time.now
     end
 
@@ -23,16 +24,14 @@ module Babysitter
       log_counter_messsage if log_this_time
     end
 
-    def final_report
-      log_counter_messsage if !(template.nil? or template.empty?) && count != logged_count
-    end
-
-    private
-
     def block_number(count)
       count / @log_every
     end
 
+    def final_report?
+      !(template.nil? or template.empty?) && count != logged_count
+    end
+
     def log_counter_messsage
       logger.info( "Done:  #{template.gsub("{{count}}", count.to_s)}" )
       send_progress_stats(count - logged_count)
@@ -53,5 +52,9 @@ module Babysitter
       Stats.count stat_name+[counting, :progress], progress unless stat_name.nil?
     end
 
+    def send_total_stats
+      Stats.gauge stat_name+[counting, :total], count
+    end
+
   end
-end
+end

data/lib/babysitter/monitor.rb

@@ -0,0 +1,56 @@
+module Babysitter
+  class Monitor
+    include Logging
+
+    attr_accessor :stat_name
+
+    def initialize(stat_name=nil)
+      @stat_name = convert_stat_name_to_array(stat_name)
+    end
+
+    def start(msg=nil, log_every=100, &blk)
+      raise ArgumentError, "Stats bucket name must not be blank" if stat_name.nil? or stat_name.empty?
+      log_msg = format_log_message(msg)
+      progress = Progress.new(log_every, stat_name)
+      logger.info "Start: #{log_msg}"
+
+      begin
+        result = Stats.time_to_do stat_name+[:overall] do
+          blk.call(progress)
+        end
+      rescue Exception => e
+        progress.final_report rescue nil
+        log_exception_details( log_msg, e )
+        raise
+      end
+
+      progress.send_total_stats
+      progress.final_report
+      logger.info "End:   #{log_msg}"
+      result
+    end
+
+    def completed(msg)
+      logger.info "Done:  #{msg}"
+    end
+
+    private
+
+    def format_log_message(msg)
+      log_msg = stat_name.join('.')
+      [log_msg,msg].compact.join(' ')
+    end
+
+    def convert_stat_name_to_array(stat_name)
+      stat_name.is_a?(Array) ? stat_name : stat_name.split('.') unless stat_name.nil? or stat_name.empty?
+    end
+
+    def log_exception_details( msg, exception )
+      logger.error "Aborting: #{msg} due to exception #{exception.class}: #{exception}"
+      if exception.backtrace
+        exception.backtrace.each { |line| logger.error "    #{line}" }
+      end
+    end
+  end
+
+end

data/lib/babysitter/progress.rb

@@ -2,56 +2,51 @@ module Babysitter
   class Progress
     include Logging
 
-    attr_accessor :stat_name
+    attr_reader :counting, :stat_name, :counter
+    attr_accessor :log_every
+
+    def initialize(log_every, stat_name=nil)
+      @stat_name = stat_name
+      @counting = :iterations
+      @log_every = log_every
+      @counter = Counter.new(log_every, stat_name: stat_name, counting: counting)
+    end
+
+    def inc(*args)
+      counter.inc(*args)
+    end
 
-    def initialize(stat_name=nil)
-      @stat_name = convert_stat_name_to_array(stat_name)
+    def count
+      counter.count
     end
 
-    def start(msg=nil, log_every=100, &blk)
-      raise ArgumentError, "Stats bucket name must not be blank" if stat_name.nil? or stat_name.empty?
-      log_msg = format_log_message(msg)
-      counter = ProgressCounter.new(log_every, stat_name)
-      logger.info "Start: #{log_msg}"
+    def final_report
+      counter.log_counter_messsage if counter.final_report?
+    end
 
-      begin
-        result = Stats.time_to_do stat_name+[:overall] do
-          blk.call(counter)
-        end
-      rescue Exception => e
-        counter.final_report rescue nil
-        log_exception_details( log_msg, e )
-        raise
-      end
+    def warn(partial_bucket_name, message)
+      logger.warn(message)
+      send_warning_stat(partial_bucket_name)
+    end
 
-      Stats.gauge stat_name+[counter.counting, :total], counter.count
-      counter.final_report
-      logger.info "End:   #{log_msg}"
-      result
+    def error(partial_bucket_name, message)
+      logger.error(message)
+      send_error_stat(partial_bucket_name)
     end
 
-    def completed(msg)
-      logger.info "Done:  #{msg}"
+    def send_total_stats
+      counter.send_total_stats
     end
 
     private
 
-    def format_log_message(msg)
-      log_msg = stat_name.join('.')
-      [log_msg,msg].compact.join(' ')
+    def send_warning_stat(partial_bucket_name)
+      Stats.increment stat_name+[partial_bucket_name, :warnings] unless stat_name.nil?
     end
 
-    def convert_stat_name_to_array(stat_name)
-      stat_name.is_a?(Array) ? stat_name : stat_name.split('.') unless stat_name.nil? or stat_name.empty?
+    def send_error_stat(partial_bucket_name)
+      Stats.increment stat_name+[partial_bucket_name, :errors] unless stat_name.nil?
     end
 
-    def log_exception_details( msg, exception )
-      logger.error "Aborting: #{msg} due to exception #{exception.class}: #{exception}"
-      if exception.backtrace
-        exception.backtrace.each { |line| Babysitter.logger.error "    #{line}" }
-      end
-    end
   end
-
-
 end

data/lib/babysitter/version.rb

@@ -1,3 +1,3 @@
 module Babysitter
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

data/spec/lib/babysitter/{progress_spec.rb → monitor_spec.rb}

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 module Babysitter
-  describe Progress  do
+  describe Monitor do
     before(:each) do
       Stats.stub!(:count).with(anything, anything)
       Stats.stub!(:gauge).with(anything, anything)
@@ -9,7 +9,7 @@ module Babysitter
 
     context 'when initialized with a dot separated bucket name' do
 
-      subject{ Progress.new(bucket_name) }
+      subject{ Monitor.new(bucket_name) }
       let(:bucket_name) { 'my.splendid.bucket.name' }
       let(:start_block) { Proc.new{ block_result } }
       let(:block_result) { double('block result').as_null_object }
@@ -17,7 +17,7 @@ module Babysitter
 
       describe '#completed' do
         it 'logs a done message' do
-          Progress.any_instance.stub(:logger).and_return(logger)
+          Monitor.any_instance.stub(:logger).and_return(logger)
           logger.should_receive(:info).with("Done:  the completed thing")
           subject.completed('the completed thing')
         end
@@ -36,26 +36,26 @@ module Babysitter
         end
 
         it 'calls logger.info with start message' do
-          Progress.any_instance.stub(:logger).and_return(logger)
+          Monitor.any_instance.stub(:logger).and_return(logger)
           logger.should_receive(:info).with("Start: #{bucket_name}")
           subject.start(&start_block)
         end
 
         it 'calls logger.info with end message' do
-          Progress.any_instance.stub(:logger).and_return(logger)
+          Monitor.any_instance.stub(:logger).and_return(logger)
           logger.should_receive(:info).with("End:   #{bucket_name}")
           subject.start(&start_block)
         end
 
         context 'when the start method is given a message' do
           it 'calls logger.info with start message' do
-            Progress.any_instance.stub(:logger).and_return(logger)
+            Monitor.any_instance.stub(:logger).and_return(logger)
             logger.should_receive(:info).with("Start: #{bucket_name} special message")
             subject.start('special message', &start_block)
           end
 
           it 'calls logger.info with end message' do
-            Progress.any_instance.stub(:logger).and_return(logger)
+            Monitor.any_instance.stub(:logger).and_return(logger)
             logger.should_receive(:info).with("End:   #{bucket_name} special message")
             subject.start('special message', &start_block)
           end
@@ -75,7 +75,7 @@ module Babysitter
           end
 
           it 'calls logger.info with each done message once' do
-            ProgressCounter.any_instance.stub(:logger).and_return(logger)
+            Counter.any_instance.stub(:logger).and_return(logger)
             [5,10].each { |inc| logger.should_receive(:info).with( "Done:  incrementing by #{inc} things").once }
             subject.start('short message', 5, &start_block_two_increments)
           end
@@ -95,7 +95,7 @@ module Babysitter
           end
 
           it 'calls logger.info with each done message once' do
-            ProgressCounter.any_instance.stub(:logger).and_return(logger)
+            Counter.any_instance.stub(:logger).and_return(logger)
             [5,7].each { |inc| logger.should_receive(:info).with( "Done:  incrementing by #{inc} things").once }
             subject.start('short message', 5, &start_block_seven_increments)
           end
@@ -109,12 +109,74 @@ module Babysitter
           end
 
           it 'calls logger.info with increments 18,27,36,45,54,63' do
-            ProgressCounter.any_instance.stub(:logger).and_return(logger)
+            Counter.any_instance.stub(:logger).and_return(logger)
             [18,27,36,45,54,63].each { |inc| logger.should_receive(:info).with( "Done:  incrementing by #{inc} things").once }
             subject.start('short message', 10, &start_block_three_increments)
           end
         end # context 'when logging every 10th call, and the block increments the counter 7 times, each with a count of 9, and identifies counted objects' do
 
+        context "when the block logs a warning" do 
+          let(:start_block_with_warning) do
+            Proc.new do |monitor|
+              monitor.warn(:my_warning_bucket, 'my warning message')
+            end
+          end
+
+          it 'calls logger.info with the warning message' do
+            Progress.any_instance.stub(:logger).and_return(logger)
+            logger.should_receive(:warn).with( "my warning message")
+            Stats.stub!(:increment)
+            subject.start(&start_block_with_warning)
+          end
+
+          it 'calls Stats.count with warning bucket name' do
+            expected_bucket_name = bucket_name.split('.') + [:my_warning_bucket, :warnings]
+            Stats.should_receive(:increment).with(expected_bucket_name)
+            subject.start(&start_block_with_warning)
+          end
+        end
+
+        context "when the block logs an error" do 
+          let(:start_block_with_error) do
+            Proc.new do |monitor|
+              monitor.error(:my_error_bucket, 'my error message')
+            end
+          end
+
+          it 'calls logger.error with the error message' do
+            Progress.any_instance.stub(:logger).and_return(logger)
+            logger.should_receive(:error).with( "my error message")
+            Stats.stub!(:increment)
+            subject.start(&start_block_with_error)
+          end
+
+          it 'calls Stats.count with error bucket name' do
+            expected_bucket_name = bucket_name.split('.') + [:my_error_bucket, :errors]
+            Stats.should_receive(:increment).with(expected_bucket_name)
+            subject.start(&start_block_with_error)
+          end
+        end
+
+        context 'when the block increments 2 times at intervals of 2 seconds' do
+          let(:start_block_for_timing) do
+            Proc.new do |counter|
+              2.times do
+                Timecop.travel(Time.now+2) # move on 2 seconds
+                counter.inc('doing increment',1)
+              end
+            end
+          end
+          before(:each) { Timecop.travel(Time.now) }
+          after(:each)  { Timecop.return           }
+
+          it 'calculates a rate close to 0.5 per second' do
+            Counter.any_instance.should_receive(:send_rate_stats) do |rate|
+              rate.should be_within(0.01).of(0.5)
+            end
+            subject.start(&start_block_for_timing)
+          end
+        end
+
       end
 
     end

data/spec/lib/babysitter_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Babysitter do
+
+  describe '.monitor' do
+    it 'returns an instance of Monitor' do
+      Babysitter.monitor.should be_an_instance_of(Babysitter::Monitor)
+    end
+  end
+
+  describe '.configuration' do
+    it 'returns an instance of Configuration' do
+      Babysitter.configuration.should be_an_instance_of(Babysitter::Configuration)
+    end
+
+    it 'returns the same instance every time' do
+      c = Babysitter.configuration
+      Babysitter.configuration.should eql(c)
+    end
+  end
+
+  describe '.configure' do
+    describe 'object yielded to block' do
+      it 'is the unique configuration object' do
+        Babysitter.configure do |c|
+          c.should eql(Babysitter.configuration)
+        end
+      end
+    end
+  end
+
+  describe '.logger' do
+    let(:configured_logger) { double('configured logger').as_null_object }
+
+    it 'returns the logger from the configuration' do
+      Babysitter::Configuration.any_instance.stub(:logger).and_return(configured_logger)
+      Babysitter.logger.should eql(configured_logger)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -5,8 +5,8 @@
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 require 'awesome_print'
-require 'fozzie'
 require 'babysitter'
+require 'timecop'
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: babysitter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-15 00:00:00.000000000 Z
+date: 2013-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fozzie
@@ -29,6 +29,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -78,13 +94,15 @@ files:
 - babysitter.gemspec
 - lib/babysitter.rb
 - lib/babysitter/configuration.rb
+- lib/babysitter/counter.rb
 - lib/babysitter/logging.rb
+- lib/babysitter/monitor.rb
 - lib/babysitter/null_logger.rb
 - lib/babysitter/progress.rb
-- lib/babysitter/progress_counter.rb
 - lib/babysitter/version.rb
 - spec/lib/babysitter/configuration_spec.rb
-- spec/lib/babysitter/progress_spec.rb
+- spec/lib/babysitter/monitor_spec.rb
+- spec/lib/babysitter_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses: []
@@ -106,11 +124,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.22
 signing_key: 
 specification_version: 3
 summary: Babysits long-running processes and reports progress or failures
 test_files:
 - spec/lib/babysitter/configuration_spec.rb
-- spec/lib/babysitter/progress_spec.rb
+- spec/lib/babysitter/monitor_spec.rb
+- spec/lib/babysitter_spec.rb
 - spec/spec_helper.rb