pulse-meter 0.3.2 → 0.4.0

data/lib/pulse-meter.rb

@@ -14,18 +14,25 @@ require "pulse-meter/command_aggregator/sync"
 module PulseMeter
   @@redis = nil
 
+  # Returns global Redis client
   def self.redis
     @@redis 
   end
 
+  # Sets global Redis client
+  # @param redis [Redis] redis client
   def self.redis=(redis)
     @@redis = redis
   end
 
+  # Returns global command aggegator (i.e. object that accumulates Redis commands emitted by events and sends them into client)
   def self.command_aggregator
     @@command_aggregator ||= PulseMeter::CommandAggregator::Async.instance
   end
-
+  
+  # Sets global command_aggregator
+  # @param type [Symbol] type of command aggegator (:async or :sync)
+  # @raise [ArgumentError] if type is none of :async, :sync
   def self.command_aggregator=(command_aggregator)
     @@command_aggregator = case command_aggregator
       when :sync; PulseMeter::CommandAggregator::Sync.instance
@@ -33,4 +40,25 @@ module PulseMeter
       else raise ArgumentError
     end
   end
+
+  # Sets global logger for all PulseMeter error messages
+  # @param logger [Logger] logger to be used
+  def self.logger=(new_logger)
+    @@logger = new_logger
+  end
+
+  # Returns global PulseMeter logger
+  def self.logger
+    @@logger ||= begin 
+      logger = Logger.new($stderr)
+      logger.datetime_format = '%Y-%m-%d %H:%M:%S.%3N'
+      logger
+    end
+  end
+
+  # Sends error message to PulseMeter logger
+  # @param message [String] error message
+  def self.error(msg)
+    logger.error(msg)
+  end
 end

data/lib/pulse-meter/command_aggregator/async.rb

@@ -67,7 +67,7 @@ module PulseMeter
               end
             end
           rescue StandardError => e
-            STDERR.puts "error in consumer_thread: #{e}, #{e.backtrace.join("\n")}"
+            PulseMeter.error "error in consumer thread: #{e}, #{e.backtrace.join("\n")}"
           end
         end
       end

data/lib/pulse-meter/sensor/configuration.rb

@@ -5,59 +5,86 @@ module PulseMeter
       include PulseMeter::Mixins::Utils
       include Enumerable
 
-      # @!attribute [r] sensors
-      #   @return [Hash] hash of sensors with names as keys and sensors as values 
-      attr_reader :sensors
-
       # Initializes sensors
       # @param opts [Hash] sensors' configuration
       def initialize(opts = {})
-        @sensors = {}
-        opts.each do |name, opts|
-          add_sensor(name, opts)
+        @opts = opts
+      end
+
+      # Returns previously initialized sensor by name
+      # @param name [Symbol] sensor name
+      # @yield [sensor] Gives sensor(if it is found) to the block
+      def sensor(name)
+        raise ArgumentError, "need a block" unless block_given?
+        with_resque do
+          s = sensors[name.to_s]
+          yield(s) if s
         end
       end
 
-      # Adds sensor
+      # Returns true value if sensor with specified name exists in configuration, false otherwise
       # @param name [Symbol] sensor name
-      # @param opts [Hash] sensor options
-      def add_sensor(name, opts)
-        sensor_type = opts.respond_to?(:sensor_type) ? opts.sensor_type : opts[:sensor_type]
-        klass_s = sensor_class(sensor_type)
-        klass = constantize(klass_s)
-        raise ArgumentError, "#{klass_s} is not a valid class for a sensor" unless klass
-        args = (opts.respond_to?(:args) ? opts.args : opts[:args]) || {}
-        @sensors[name.to_s] = klass.new(name, symbolize_keys(args.to_hash))
+      def has_sensor?(name)
+        has_sensor = false
+        with_resque do
+          has_sensor = sensors.has_key?(name)
+        end
+        has_sensor
       end
 
-      # Returns previously initialized sensor by name
+      # Adds sensor
       # @param name [Symbol] sensor name
-      # @return [Sensor] sensor 
-      def sensor(name)
-        @sensors[name.to_s]
+      # @param opts [Hash] sensor options
+      def add_sensor(name, opts)
+        with_resque do
+          sensors[name.to_s] = create_sensor(name, opts)
+        end
       end
 
       # Iterates over each sensor
       def each
-        @sensors.each_value do |sensor|
-          yield(sensor)
+        with_resque do
+          sensors.each_value do |s|
+            yield(s)
+          end
         end
       end
 
-      # Invokes event for any sensor 
+      # Invokes event(_at) for any sensor 
       # @raise [ArgumentError] unless sensor exists
       def method_missing(name, *args)
-        name = name.to_s
-        if @sensors.has_key?(name)
-          @sensors[name].event(*args)
-        elsif (name =~ /^(.*)_at$/) && @sensors.has_key?($1) 
-          @sensors[$1].event_at(*args)
-        else
-          raise ArgumentError, "Unknown sensor: `#{name}'"
+        with_resque do
+          name = name.to_s
+          if sensors.has_key?(name)
+            sensors[name].event(*args)
+          elsif name =~ /\A(.*)_at\z/
+            sensor_name = $1
+            sensors[sensor_name].event_at(*args) if sensors.has_key?(sensor_name) 
+          end
         end
       end
 
-      protected
+      private
+
+      def with_resque
+        yield
+      rescue StandardError => e
+        PulseMeter.error "Configuration error: #{e}, #{e.backtrace.join("\n")}"
+        nil
+      end
+
+
+      # Tries to create a specific sensor
+      # @param name [Symbol] sensor name
+      # @param opts [Hash] sensor options
+      def create_sensor(name, opts)
+        sensor_type = opts.respond_to?(:sensor_type) ? opts.sensor_type : opts[:sensor_type]
+        klass_s = sensor_class(sensor_type)
+        klass = constantize(klass_s)
+        raise ArgumentError, "#{klass_s} is not a valid class for a sensor" unless klass
+        args = (opts.respond_to?(:args) ? opts.args : opts[:args]) || {}
+        klass.new(name, symbolize_keys(args.to_hash))
+      end
 
       def sensor_class(sensor_type)
         entries = sensor_type.to_s.split('/').map do |entry|
@@ -66,6 +93,14 @@ module PulseMeter
         entries.unshift('PulseMeter::Sensor').join('::')
       end
 
+      # Lazy collection of sensors, specified by opts
+      # @raise [ArgumentError] unless one of the sensors exists
+      def sensors
+        @sensors ||= @opts.each_with_object({}){ |(name, opts), sensor_acc|
+          sensor_acc[name.to_s] = create_sensor(name, opts)
+        }
+      end
+
     end
   end
 end

data/lib/pulse-meter/sensor/multi.rb

@@ -20,7 +20,8 @@ module PulseMeter
       end
 
       def sensor(name)
-        sensors.sensor(name)
+        raise ArgumentError, 'need a block' unless block_given?
+        sensors.sensor(name){|s| yield(s)}
       end
 
       def event(factors_hash, value)
@@ -28,8 +29,9 @@ module PulseMeter
 
         each_factors_combination do |combination|
           factor_values = factor_values_for_combination(combination, factors_hash)
-          sensor = get_or_create_sensor(combination, factor_values)
-          sensor.event(value)
+          get_or_create_sensor(combination, factor_values) do |s|
+            s.event(value)
+          end
         end
       end
 
@@ -38,9 +40,8 @@ module PulseMeter
       end
 
       def sensor_for_factors(factor_names, factor_values)
-        sensor(
-           get_sensor_name(factor_names, factor_values)
-        )
+        raise ArgumentError, 'need a block' unless block_given?
+        sensor(get_sensor_name(factor_names, factor_values)){|s| yield(s)}
       end
 
       protected
@@ -50,12 +51,15 @@ module PulseMeter
       end
 
       def get_or_create_sensor(factor_names, factor_values)
+        raise ArgumentError, 'need a block' unless block_given?
         name = get_sensor_name(factor_names, factor_values)
-        unless sensor(name)
+        unless sensors.has_sensor?(name)
           sensors.add_sensor(name, configuration_options)
           dump!(false)
         end
-        sensor(name)
+        sensor(name) do |s|
+          yield(s)
+        end
       end
 
       def ensure_valid_factors!(factors_hash)

data/lib/pulse-meter/version.rb

@@ -1,3 +1,3 @@
 module PulseMeter
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/spec/pulse_meter/sensor/configuration_spec.rb

@@ -16,38 +16,39 @@ describe PulseMeter::Sensor::Configuration do
     let(:cfg) {described_class.new}
 
     it "should create sensor available under passed name" do
-      cfg.sensor(:foo).should be_nil
+      cfg.has_sensor?(:foo).should be_false
       cfg.add_sensor(:foo, sensor_type: 'counter')
-      cfg.sensor(:foo).should_not be_nil
+      cfg.has_sensor?(:foo).should_not be_true
     end
 
     it "should have event shortcut for the sensor" do
       cfg.add_sensor(:foo, sensor_type: 'counter')
-      sensor = cfg.sensor(:foo)
-      sensor.should_receive(:event).with(321)
+      puts cfg.to_yaml
+      cfg.sensor(:foo){|s| s.should_receive(:event).with(321)}
       cfg.foo(321)
     end
     
     it "should have event_at shortcut for the sensor" do
       cfg.add_sensor(:foo, sensor_type: 'counter')
-      sensor = cfg.sensor(:foo)
       now = Time.now
-      sensor.should_receive(:event_at).with(now, 321)
+      cfg.sensor(:foo) do |sensor|
+        sensor.should_receive(:event_at).with(now, 321)
+      end
       cfg.foo_at(now, 321)
     end
 
     it "should create sensor with correct type" do
       cfg.add_sensor(:foo, sensor_type: 'counter')
-      cfg.sensor(:foo).should be_kind_of(PulseMeter::Sensor::Counter)
+      cfg.sensor(:foo){|s| s.should be_kind_of(PulseMeter::Sensor::Counter)}
     end
 
-    it "should raise exception if sensor type is bad" do
-      expect{ cfg.add_sensor(:foo, sensor_type: 'baaaar') }.to raise_exception(ArgumentError)
+    it "should not raise exception if sensor type is bad" do
+      expect{ cfg.add_sensor(:foo, sensor_type: 'baaaar') }.not_to raise_exception
     end
 
     it "should pass args to created sensor" do
       cfg.add_sensor(:foo, sensor_type: 'counter', args: {annotation: "My Foo Counter"} )
-      cfg.sensor(:foo).annotation.should == "My Foo Counter"
+      cfg.sensor(:foo){|s| s.annotation.should == "My Foo Counter" }
     end
 
     it "should accept hashie-objects" do
@@ -61,7 +62,7 @@ describe PulseMeter::Sensor::Configuration do
       end
 
       cfg.add_sensor(:foo, Dummy.new)
-      cfg.sensor(:foo).annotation.should == "My Foo Counter"
+      cfg.sensor(:foo){|s| s.annotation.should == "My Foo Counter"}
     end
   end
 
@@ -78,22 +79,15 @@ describe PulseMeter::Sensor::Configuration do
       cfg1 = described_class.new(opts)
       cfg2 = described_class.new
       opts.each{|k,v| cfg2.add_sensor(k, v)}
-      cfg1.to_yaml.should == cfg2.to_yaml
+      cfg1.sensors.to_yaml.should == cfg2.sensors.to_yaml
     end
   end
 
   describe "#sensor" do
-    it "should give access to added sensors" do
-      cfg = described_class.new(counter_config)
-      cfg.sensor(:cnt).annotation.should == "MySensor"
-      cfg.sensor("cnt").annotation.should == "MySensor"
-    end
-  end
-
-  describe "#sensors" do
-    it "returns hash of sensors" do
+    it "should give access to added sensors via block" do
       cfg = described_class.new(counter_config)
-      cfg.sensors.should == {"cnt" => cfg.sensor(:cnt)}
+      cfg.sensor(:cnt){ |s| s.annotation.should == "MySensor" }
+      cfg.sensor("cnt"){ |s| s.annotation.should == "MySensor" }
     end
   end
 
@@ -102,7 +96,8 @@ describe PulseMeter::Sensor::Configuration do
       cfg = described_class.new(counter_config)
       sensors = {}
       cfg.each {|s| sensors[s.name.to_sym] = s}
-      sensors.should == {:cnt => cfg.sensor(:cnt)}
+      sensor = cfg.sensor(:cnt){|s| s}
+      sensors.should == {:cnt => sensor}
     end
   end
 end

data/spec/pulse_meter/sensor/multi_spec.rb

@@ -95,8 +95,9 @@ describe PulseMeter::Sensor::Multi do
         ["#{name}_f1_f1v1_f2_f2v1", 1],
         ["#{name}_f1_f1v2_f2_f2v1", 2]
       ].each do |sensor_name, sum|
-        s = sensor.sensor(sensor_name)
-        s.value.should == sum
+        sensor.sensor(sensor_name) { |s|
+          s.value.should == sum
+        }
       end
     end
   end
@@ -117,16 +118,18 @@ describe PulseMeter::Sensor::Multi do
 
   describe "#sensor_for_factors" do
     context "when sensor has already been created" do
-      it "returns sensor for given combination of factors and their values" do
+      it "yields block with sensor for given combination of factors and their values" do
         sensor.event({f1: :f1v1, f2: :f2v1}, 1)
-        sensor.sensor_for_factors([:f1, :f2], [:f1v1, :f2v1]).name.should == "#{name}_f1_f1v1_f2_f2v1"
-        sensor.sensor_for_factors([:f1], [:f1v1]).name.should == "#{name}_f1_f1v1"
+        sensor.sensor_for_factors([:f1, :f2], [:f1v1, :f2v1]){|s| s.name.should == "#{name}_f1_f1v1_f2_f2v1"}
+        sensor.sensor_for_factors([:f1], [:f1v1]){|s| s.name.should == "#{name}_f1_f1v1"}
       end
     end
 
     context "when such a sensor was not created" do
-      it "returns nil" do
-        sensor.sensor_for_factors([:foo], [:bar]).should be_nil
+      it "does not yields block" do
+        yielded = false
+        sensor.sensor_for_factors([:foo], [:bar]){ yielded = true }
+        yielded.should be_false
       end
     end
   end

data/spec/pulse_meter_spec.rb

@@ -50,4 +50,23 @@ describe PulseMeter do
       ca1.should == ca2
     end
   end
+
+  describe "::logger" do
+    it "should return PulseMeter logger" do
+      PulseMeter.logger = 123
+      PulseMeter.logger.should == 123
+    end
+
+    it "should return default logger" do
+      PulseMeter.logger = nil
+      PulseMeter.logger.should be_kind_of(Logger)
+    end
+  end
+
+  describe "::error" do
+    it "should delegate error message to logger" do
+      PulseMeter.logger.should_receive(:error)
+      PulseMeter.error("foo")
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -29,6 +29,7 @@ RSpec.configure do |config|
   config.before(:each) do
     PulseMeter.redis = MockRedis.new
     Timecop.return
+    PulseMeter.logger = Logger.new("/dev/null")
   end
   config.filter_run :focus => true
   config.run_all_when_everything_filtered = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pulse-meter
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-05 00:00:00.000000000 Z
+date: 2012-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gon-sinatra
@@ -605,9 +605,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 284340155524977771
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23