strumbar 0.3.0 → 0.4.0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 0.4.0 (2013-02-09)
+
+#### /!\ Breaks Backwards Compatibility /!\
+
+* instrumentation is no longer loaded by default.
+* `Strumbar::Configuration#instrumentation &block` is now gone: use the new `config.instruments.use MyInstrument` syntax instead.
+* default values for options are now stored on the configuration object instead of the `Strumbar` module.
+
 ## 0.3.0 (2013-02-04)
 
 * Adds wrapper for gauge, set, and count: `Strumbar::Client.(gauge|set|count) key, value, sample_rate = Strumbar.default_rate`.

data/README.md

@@ -66,30 +66,38 @@ Strumbar.strum 'view.render', payload do
 end
 ```
 
+## Instruments
 
-## Default Instruments
+Strumbar allows middleware-style instruments to be added via the configure block.  These instruments
+need only respond to `#load` with an optional hash. Strumbar comes with a few instruments to be added.
+Here's an example:
 
-Strumbar takes the approach of auto-detecting the libraries being used and
-loading default instrumentation subscriptions.  Currently, this list includes:
+``` ruby
+class Guitar
+  def self.load options = {}
+    Strumbar.subscribe 'query.*' do |client, event|
+      client.increment "query.#{event.payload[:query]}", options[:rate]
+    end
+  end
+end
 
-- ActionController
-- ActiveRecord
-- Redis
+Strumbar.configure do |config|
+    # Can pass optional hash of data to controller for access when loading
+    config.instruments.use Strumbar::Instrumentation::ActiveRecord, rate: 0.8
+    config.instruments.use Strumbar::Instrumentation::ActionController, rate: 1.0
 
-Alternatively, you can choose specific instrumentations to load
-and set your own sample rates for each by passing a block to config.instrumentation, like so:
+    # Unless passed, `rate` will be passed as the value of Strumbar.default_rate
+    config.instruments.use Strumbar::Instrumentation::Redis
 
-``` ruby
-Strumbar.configure do |config|
-  config.instrumentation do
-    Strumbar::Instrumentation::ActionController.load rate: 0.5
-    Strumbar::Instrumentation::ActiveRecord.load
-    Strumbar::Instrumentation::Redis.load
+    # When passing an array of objects, each element of the array will use the
+    # same optional information, and will use the default rate if not supplied
 
-    AppName::Instrumentation::ThirdPartyInstrument.load rate: 0.8
-  end
-end
+    # Guitar and SnareDrum will receive `{ rate: Strumbar.default_rate }`
+    config.instruments.use [Guitar, SnareDrum]
 
+    # SixStringBass and FourStringBass will receive the same hash
+    config.instruments.use [SixStringBass, FourStringBass], rate: 0.75
+end
 ```
 
 ## Authors

data/lib/strumbar.rb

@@ -5,11 +5,10 @@ require 'strumbar/instrumentation'
 
 require 'active_support'
 require 'active_support/core_ext/object/try'
+require 'active_support/core_ext/module/delegation'
 
 module Strumbar
   class << self
-    attr_reader :configuration
-
     def configure
       @configuration = Configuration.new
       yield @configuration
@@ -20,21 +19,11 @@ module Strumbar
       @client ||= Client.new host, port
     end
 
-    def host
-      configuration.try(:host) || 'localhost'
-    end
-
-    def port
-      configuration.try(:port) || 8125
+    def configuration
+      @configuration ||= Configuration.new
     end
 
-    def application
-      configuration.try(:application) || 'statsd_appname'
-    end
-
-    def default_rate
-      configuration.try(:default_rate) || 1
-    end
+    delegate :host, :port, :instruments, :application, :default_rate, to: :configuration
 
     def subscribe identifier
       ActiveSupport::Notifications.subscribe identifier do |*args|

data/lib/strumbar/configuration.rb

@@ -1,13 +1,69 @@
 module Strumbar
+  class InstrumentList
+    include Enumerable
+
+    def initialize
+      @instruments = []
+    end
+
+    def each &block
+      @instruments.each &block
+    end
+
+    def empty?
+      @instruments.empty?
+    end
+
+    def use instruments, options = {}
+      if instruments.respond_to? :each
+        instruments.each do |instrument|
+          add instrument, options
+        end
+      else
+        add instruments, options
+      end
+    end
+
+    def delete instrument
+      @instruments.delete_if { |i| i[0] == instrument }
+    end
+
+    private
+
+    def add instrument, options
+      if instrument.respond_to? :load
+        @instruments << [instrument, options]
+      else
+        raise 'Instrument does not respond to load'
+      end
+    end
+  end
+
   class Configuration
     attr_accessor :port,
                   :host,
                   :application,
                   :default_rate,
-                  :custom_load
+                  :instruments
+
+    def initialize
+      @instruments = InstrumentList.new
+    end
+
+    def host
+      @host || 'localhost'
+    end
+
+    def port
+      @port || 8125
+    end
+
+    def application
+      @application || 'statsd_appname'
+    end
 
-    def instrumentation(&block)
-      @custom_load = block
+    def default_rate
+      @default_rate || 1
     end
   end
 end

data/lib/strumbar/instrumentation.rb

@@ -6,15 +6,13 @@ module Strumbar
     autoload :Redis, 'strumbar/instrumentation/redis'
 
     def self.load
-      custom_load = Strumbar.configuration.custom_load
+      Strumbar.instruments.each do |instrument_info|
+        instrument  = instrument_info[0]
+        options     = instrument_info[1]
 
-      if custom_load
-        custom_load.call
-      else
-        Strumbar::Instrumentation::ActionController.load if defined?(::ActionController)
-        Strumbar::Instrumentation::ActiveRecord.load if defined?(::ActiveRecord)
-        Strumbar::Instrumentation::Mongoid.load if defined?(::Mongoid)
-        Strumbar::Instrumentation::Redis.load if defined?(::Redis)
+        options[:rate] ||= Strumbar.default_rate
+
+        instrument.load options
       end
     end
   end

data/lib/strumbar/version.rb

@@ -1,3 +1,3 @@
 module Strumbar
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/spec/configuration_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+module Strumbar
+  describe Configuration do
+    let(:config) { Configuration.new }
+
+    context "default configuration values" do
+      it "defaults #host to 'localhost'" do
+        config.host.should == 'localhost'
+      end
+
+      it "defaults #port to 8125" do
+        config.port.should == 8125
+      end
+
+      it "defaults #application to 'statsd_appname'" do
+        config.application.should == 'statsd_appname'
+      end
+
+      it "defaults #default_rate to 1" do
+        config.default_rate.should == 1
+      end
+    end
+
+  end
+end

data/spec/instrumentation_spec.rb

@@ -1,105 +1,97 @@
 require 'spec_helper'
 
+class Guitar
+  def self.load options = {}
+    
+  end
+end
+
+class BassGuitar < Guitar ; end
+class Pencil ; end
+
 describe Strumbar::Instrumentation do
   describe '#load' do
-    def undefine klass
-      Object.send :remove_const, klass
-    end
-
-    context 'without a custom instrumentation loader' do
-      before do
+    context 'configuration block' do
+      it 'accepts an instrument that responds to #load' do
         Strumbar.configure do |config|
+          config.instruments.use Guitar
         end
-      end
-
-      it 'loads the ActionController subscription if ActionController is defined' do
-
-        ActionController = true
-
-        Strumbar::Instrumentation::ActionController.should_receive :load
-        Strumbar::Instrumentation.load
 
-        undefine :ActionController
+        Strumbar.instruments.should include [Guitar, { rate: 1.0}]
       end
 
-      it 'does not load ActionController subscription if not defined' do
-        Strumbar::Instrumentation::ActionController.should_not_receive :load
-        Strumbar::Instrumentation.load
-      end
-
-      it 'loads the ActiveRecord subscription if ActiveRecord is loaded' do
-        ActiveRecord = true
-
-        Strumbar::Instrumentation::ActiveRecord.should_receive :load
-        Strumbar::Instrumentation.load
+      it 'accepts an array of instruments' do
+        Strumbar.configure do |config|
+          config.instruments.use [Guitar, BassGuitar]
+        end
 
-        undefine :ActiveRecord
+        Strumbar.instruments.should include [Guitar, {rate: 1.0}]
+        Strumbar.instruments.should include [BassGuitar, {rate: 1.0}]
       end
 
-      it 'does not load ActiveRecord subscription if not defined' do
-        Strumbar::Instrumentation::ActiveRecord.should_not_receive :load
-        Strumbar::Instrumentation.load
+      it 'allows deletion of instruments from Strumbar' do
+        Strumbar.configure do |config|
+          config.instruments.use Guitar
+          config.instruments.should include [Guitar, {}]
+          config.instruments.delete Guitar
+          config.instruments.should_not include [Guitar, {}]
+        end
       end
 
-      it 'loads the Redis subscription if Redis is defined' do
-        class Redis
-          class Client
-            def process ; end
-          end
+      it 'raises an exception when trying to load an Instrument that does not respond to load' do
+        Strumbar.configure do |config|
+          expect { config.instruments.use Pencil }.to raise_error
         end
-
-        Strumbar::Instrumentation::Redis.should_receive :load
-        Strumbar::Instrumentation.load
-
-        undefine :Redis
       end
 
-      it 'does not load Redis subscription if not defined' do
-        Strumbar::Instrumentation::Redis.should_not_receive :load
-        Strumbar::Instrumentation.load
+      it 'accepts a hash of options' do
+        Guitar.should_receive(:load).with(rate: 1.2)
+        Strumbar.configure do |config|
+          config.instruments.use Guitar, rate: 1.2
+        end
       end
 
-    end
-
-    context 'with a custom instrumentations loader' do
-      before do
+      it 'passes the default rate to an instrument if no hash is specified' do
+        Guitar.should_receive(:load).with(rate: 1.0)
         Strumbar.configure do |config|
-          config.instrumentation do
-            Strumbar::Instrumentation::ActionController.load
-          end
+          config.instruments.use Guitar
         end
       end
 
-      it 'does load the ActionController subscription' do
-        ActionController = true
-        Strumbar::Instrumentation::ActionController.should_receive :load
-        Strumbar::Instrumentation.load
-        undefine :ActionController
-      end
+      it 'passes the same hash to an array of instruments' do
+        Guitar.should_receive(:load).with(rate: 1.5)
+        BassGuitar.should_receive(:load).with(rate: 1.5)
 
-      it 'does not load the ActiveRecord subscription even if ActiveRecord is loaded' do
-        ActiveRecord = true
+        Strumbar.configure do |config|
+          config.instruments.use [Guitar, BassGuitar], rate: 1.5
+        end
+      end
 
-        Strumbar::Instrumentation::ActiveRecord.should_not_receive :load
-        Strumbar::Instrumentation.load
+      it 'passes the default rate to to an array of instruments' do
+        Guitar.should_receive(:load).with(rate: 1.0)
+        BassGuitar.should_receive(:load).with(rate: 1.0)
 
-        undefine :ActiveRecord
+        Strumbar.configure do |config|
+          config.instruments.use [Guitar, BassGuitar]
+        end
       end
 
-      it 'does not load the Redis subscription even if Redis is defined' do
-        class Redis
-          class Client
-            def process ; end
-          end
+      it 'loads no default instruments unless specified' do
+        Strumbar.configure do
+          # NOPE
         end
-
+        Strumbar.instruments.should be_empty
         Strumbar::Instrumentation::Redis.should_not_receive :load
-        Strumbar::Instrumentation.load
-
-        undefine :Redis
       end
 
-    end
+      it 'sends the load message to all instruments in Strumbar' do
+        Guitar.should_receive :load
+        BassGuitar.should_receive :load
 
+        Strumbar.configure do |config|
+          config.instruments.use [Guitar, BassGuitar]
+        end
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strumbar
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-04 00:00:00.000000000 Z
+date: 2013-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -103,6 +103,7 @@ files:
 - lib/strumbar/instrumentation/redis.rb
 - lib/strumbar/version.rb
 - spec/client_spec.rb
+- spec/configuration_spec.rb
 - spec/instrumentation/mongoid/controller_runtime_spec.rb
 - spec/instrumentation/mongoid/runtime_tracker_spec.rb
 - spec/instrumentation/redis_spec.rb
@@ -124,7 +125,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2742179501174448112
+      hash: -3917631635399669521
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -133,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2742179501174448112
+      hash: -3917631635399669521
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -142,6 +143,7 @@ specification_version: 3
 summary: Helper library to strum along in your application.
 test_files:
 - spec/client_spec.rb
+- spec/configuration_spec.rb
 - spec/instrumentation/mongoid/controller_runtime_spec.rb
 - spec/instrumentation/mongoid/runtime_tracker_spec.rb
 - spec/instrumentation/redis_spec.rb