toystore 0.13.1 → 0.13.2

data/Changelog.md

@@ -2,12 +2,14 @@
 
 I will do my best to keep this up to date with significant changes here, starting in 0.8.3.
 
-## master
+## 0.13.2
 
-* No longer defaulting uuid to new instance, use :default instead. This allows for nil values for attributes of uuid type.
+* Added instrumentation and log subscriber
+* Removed Toy.logger, Toy.logger? and Toy.logger=. All logging is now through log_subscriber. See the README.
 
-## 0.14.0
+## 0.13.1
 
+* No longer defaulting uuid to new instance, use :default instead. This allows for nil values for attributes of uuid type.
 * No longer persisting nil attributes
 * Added Toy::Types::JSON for storing serialized JSON as an attribute value
 * Added #persisted_id and made it public so people can override confidently. It is now used in adapter.write and adapter.delete.

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source "https://rubygems.org"
 gemspec
 
 gem 'activesupport', '~> 3.2.0'
@@ -6,6 +6,8 @@ gem 'activemodel',   '~> 3.2.0'
 gem 'rake',          '~> 0.9.0'
 gem 'oj',            '~> 1.0.0'
 gem 'multi_json',    '~> 1.3.2'
+gem 'metriks', :require => false
+gem 'statsd-ruby', :require => false
 
 group(:guard) do
   gem 'guard',          '~> 1.0.0'

data/README.md

@@ -1,4 +1,4 @@
-# Toystore [![Build Status](https://secure.travis-ci.org/jnunemaker/toystore.png)](http://travis-ci.org/jnunemaker/toystore)
+# Toystore
 
 An object mapper for any [adapter](https://github.com/jnunemaker/adapter) that can read, write, delete, and clear data.
 
@@ -206,6 +206,34 @@ If that doesn't excite you, nothing will. At this point, you are probably wishin
 
 Luckily, there is an entire directory full of [examples](https://github.com/jnunemaker/toystore/tree/master/examples) and I created a few power user guides, which I will kindly link next.
 
+## Instrumentation
+
+ToyStore comes with a log subscriber and automatic metriks instrumentation. By
+default these work with ActiveSupport::Notifications, but only require the
+pieces of ActiveSupport that are needed and only do so if you actually attempt
+to require the instrumentation files listed below.
+
+To use the log subscriber:
+
+```ruby
+# Gemfile
+gem 'activesupport'
+
+# config/initializers/toystore.rb (or wherever you want it)
+require 'toy/instrumentation/log_subscriber'
+```
+
+To use the metriks instrumentation:
+
+```ruby
+# Gemfile
+gem 'activesupport'
+gem 'metriks'
+
+# config/initializers/toystore.rb (or wherever you want it)
+require 'toy/instrumentation/metriks'
+```
+
 ## ToyStore Power User Guides
 
 * [Wiki Home](https://github.com/jnunemaker/toystore/wiki)

data/gemfiles/rails_3_0.gemfile

@@ -6,6 +6,8 @@ gem 'activemodel',   '~> 3.0.0'
 gem 'rake',          '~> 0.9.0'
 gem 'oj',            '~> 1.0.0'
 gem 'multi_json',    '~> 1.3.2'
+gem 'metriks', :require => false
+gem 'statsd-ruby', :require => false
 
 group(:guard) do
   gem 'guard',          '~> 1.0.0'

data/gemfiles/rails_3_1.gemfile

@@ -6,6 +6,8 @@ gem 'activemodel',   '~> 3.1.0'
 gem 'rake',          '~> 0.9.0'
 gem 'oj',            '~> 1.0.0'
 gem 'multi_json',    '~> 1.3.2'
+gem 'metriks', :require => false
+gem 'statsd-ruby', :require => false
 
 group(:guard) do
   gem 'guard',          '~> 1.0.0'

data/lib/toy.rb

@@ -14,21 +14,11 @@ require 'active_support/core_ext'
 extensions_path = root_path.join('lib', 'toy', 'extensions')
 Dir[extensions_path + '**/*.rb'].each { |file| require(file) }
 
+require 'toy/instrumenters/noop'
+
 module Toy
   extend self
 
-  def logger
-    @logger
-  end
-
-  def logger?
-    @logger.present?
-  end
-
-  def logger=(logger)
-    @logger = logger
-  end
-
   def key_factory=(key_factory)
     @key_factory = key_factory
   end
@@ -37,6 +27,14 @@ module Toy
     @key_factory ||= Toy::Identity::UUIDKeyFactory.new
   end
 
+  def instrumenter
+    @instrumenter || Toy::Instrumenters::Noop
+  end
+
+  def instrumenter=(instrumenter)
+    @instrumenter = instrumenter
+  end
+
   module Middleware
     autoload 'IdentityMap', 'toy/middleware/identity_map'
   end
@@ -52,7 +50,6 @@ module Toy
   autoload 'Equality',                'toy/equality'
   autoload 'Inspect',                 'toy/inspect'
   autoload 'Inheritance',             'toy/inheritance'
-  autoload 'Logger',                  'toy/logger'
   autoload 'MassAssignmentSecurity',  'toy/mass_assignment_security'
   autoload 'Persistence',             'toy/persistence'
   autoload 'Querying',                'toy/querying'

data/lib/toy/callbacks.rb

@@ -7,7 +7,7 @@ module Toy
       define_model_callbacks :save, :create, :update, :destroy
     end
 
-    def save(*)
+    def save(options={})
       run_callbacks(:save) { super }
     end
 

data/lib/toy/dirty_store.rb

@@ -22,11 +22,11 @@ module Toy
       end
     end
 
-    def save(*)
+    def save(options={})
       super.tap do
         @previously_changed = changes
         @changed_attributes.clear if @changed_attributes
       end
     end
   end
-end
+end

data/lib/toy/identity_map.rb

@@ -62,11 +62,11 @@ module Toy
       end
     end
 
-    def save(*)
+    def save(options={})
       super.tap { |result| add_to_identity_map if result }
     end
 
-    def delete(*)
+    def delete
       super.tap { remove_from_identity_map }
     end
 

data/lib/toy/instrumentation/active_support_notifications.rb

@@ -0,0 +1,5 @@
+require 'securerandom'
+require 'active_support/notifications'
+
+# Set the instrumenter to active support notifications.
+Toy.instrumenter = ActiveSupport::Notifications

data/lib/toy/instrumentation/log_subscriber.rb

@@ -0,0 +1,49 @@
+require 'toy/instrumentation/active_support_notifications'
+require 'active_support/log_subscriber'
+
+module Toy
+  module Instrumentation
+    class LogSubscriber < ::ActiveSupport::LogSubscriber
+      def read(event)
+        return unless logger.debug?
+        log_event :read, event
+      end
+
+      def read_multiple(event)
+        return unless logger.debug?
+        log_event :read_multiple, event
+      end
+
+      def key(event)
+        return unless logger.debug?
+        log_event :key, event
+      end
+
+      def create(event)
+        return unless logger.debug?
+        log_event :create, event
+      end
+
+      def update(event)
+        return unless logger.debug?
+        log_event :update, event
+      end
+
+      def destroy(event)
+        return unless logger.debug?
+        log_event :destroy, event
+      end
+
+      def log_event(action, event)
+        id = event.payload[:id]
+        model = event.payload[:model]
+
+        name = '%s (%.1fms)' % ["#{model.name} #{action}", event.duration]
+
+        debug "  #{color(name, CYAN, true)}  [ #{id.inspect} ]"
+      end
+    end
+  end
+end
+
+Toy::Instrumentation::LogSubscriber.attach_to :toystore

data/lib/toy/instrumentation/metriks.rb

@@ -0,0 +1,5 @@
+require 'toy/instrumentation/active_support_notifications'
+require 'toy/instrumentation/metriks_subscriber'
+
+ActiveSupport::Notifications.subscribe /toystore/,
+  Toy::Instrumentation::MetriksSubscriber

data/lib/toy/instrumentation/metriks_subscriber.rb

@@ -0,0 +1,16 @@
+# Note: You should never need to require this file directly if you are using
+# ActiveSupport::Notifications. Instead, you should require the metriks file
+# that lives in the same directory as this file. The benefit is that it
+# subscribes to the correct events and does everything for your.
+require 'toy/instrumentation/subscriber'
+require 'metriks'
+
+module Toy
+  module Instrumentation
+    class MetriksSubscriber < Subscriber
+      def update_timer(metric)
+        Metriks.timer(metric).update(@duration)
+      end
+    end
+  end
+end

data/lib/toy/instrumentation/statsd.rb

@@ -0,0 +1,5 @@
+require 'toy/instrumentation/active_support_notifications'
+require 'toy/instrumentation/statsd_subscriber'
+
+ActiveSupport::Notifications.subscribe /toystore/,
+  Toy::Instrumentation::StatsdSubscriber

data/lib/toy/instrumentation/statsd_subscriber.rb

@@ -0,0 +1,22 @@
+# Note: You should never need to require this file directly if you are using
+# ActiveSupport::Notifications. Instead, you should require the metriks file
+# that lives in the same directory as this file. The benefit is that it
+# subscribes to the correct events and does everything for your.
+require 'toy/instrumentation/subscriber'
+require 'statsd'
+
+module Toy
+  module Instrumentation
+    class StatsdSubscriber < Subscriber
+      class << self
+        attr_accessor :client
+      end
+
+      def update_timer(metric)
+        if self.class.client
+          self.class.client.timing metric, (@duration * 1_000).round
+        end
+      end
+    end
+  end
+end

data/lib/toy/instrumentation/subscriber.rb

@@ -0,0 +1,38 @@
+require 'toy/instrumentation/subscriber'
+
+module Toy
+  module Instrumentation
+    class Subscriber
+      # Public: Use this as the subscribed block.
+      def self.call(name, start, ending, transaction_id, payload)
+        new(name, start, ending, transaction_id, payload).update
+      end
+
+      # Private: Initializes a new event processing instance.
+      def initialize(name, start, ending, transaction_id, payload)
+        @name = name
+        @start = start
+        @ending = ending
+        @payload = payload
+        @duration = ending - start
+        @transaction_id = transaction_id
+
+        @action = @name.split('.').first
+        @model = @payload[:model]
+      end
+
+      # Public: Actually update all the timers for the event.
+      #
+      # Returns nothing.
+      def update
+        update_timer "toystore.#{@action}"
+        update_timer "toystore.#{@model}.#{@action}"
+      end
+
+      # Internal: Override in subclass.
+      def update_timer(metric)
+        raise 'not implemented'
+      end
+    end
+  end
+end

data/lib/toy/instrumenters/memory.rb

@@ -0,0 +1,27 @@
+module Toy
+  module Instrumenters
+    # Instrumentor that is useful for tests as it stores each of the events that
+    # are instrumented.
+    class Memory
+      Event = Struct.new(:name, :payload, :result)
+
+      attr_reader :events
+
+      def initialize
+        @events = []
+      end
+
+      def instrument(name, payload = {})
+        result = if block_given?
+          yield payload
+        else
+          nil
+        end
+
+        @events << Event.new(name, payload, result)
+
+        result
+      end
+    end
+  end
+end

data/lib/toy/instrumenters/noop.rb

@@ -0,0 +1,9 @@
+module Toy
+  module Instrumenters
+    class Noop
+      def self.instrument(name, payload = {})
+        yield payload if block_given?
+      end
+    end
+  end
+end

data/lib/toy/middleware/identity_map.rb

@@ -1,24 +1,8 @@
+require 'rack/body_proxy'
+
 module Toy
   module Middleware
     class IdentityMap
-      class Body
-        def initialize(target, original)
-          @target   = target
-          @original = original
-        end
-
-        def each(&block)
-          @target.each(&block)
-        end
-
-        def close
-          @target.close if @target.respond_to?(:close)
-        ensure
-          Toy::IdentityMap.enabled = @original
-          Toy::IdentityMap.clear
-        end
-      end
-
       def initialize(app)
         @app = app
       end
@@ -27,9 +11,14 @@ module Toy
         Toy::IdentityMap.clear
         enabled = Toy::IdentityMap.enabled
         Toy::IdentityMap.enabled = true
-        status, headers, body = @app.call(env)
-        [status, headers, Body.new(body, enabled)]
+
+        response = @app.call(env)
+        response[2] = Rack::BodyProxy.new(response[2]) {
+          Toy::IdentityMap.enabled = enabled
+          Toy::IdentityMap.clear
+        }
+        response
       end
     end
   end
-end
+end

data/lib/toy/object.rb

@@ -10,7 +10,6 @@ module Toy
     include Dirty
     include Equality
     include Inspect
-    include Logger
     include Inheritance
     include Serialization
 

data/lib/toy/persistence.rb

@@ -75,8 +75,18 @@ module Toy
       !new_record? && !destroyed?
     end
 
-    def save(*)
-      new_record? ? create : update
+    def save(options={})
+      default_payload = {
+        :id => persisted_id,
+        :model => self.class,
+      }
+
+      new_record = new_record?
+      action = new_record ? 'create' : 'update'
+
+      Toy.instrumenter.instrument("#{action}.toystore", default_payload) { |payload|
+        new_record ? create : update
+      }
     end
 
     def update_attributes(attrs)
@@ -85,7 +95,14 @@ module Toy
     end
 
     def destroy
-      delete
+      default_payload = {
+        :id => persisted_id,
+        :model => self.class,
+      }
+
+      Toy.instrumenter.instrument('destroy.toystore', default_payload) { |payload|
+        delete
+      }
     end
 
     def delete
@@ -112,7 +129,8 @@ module Toy
       attributes
     end
 
-    # Public: Choke point for overriding how data gets written.
+    # Public: Choke point for overriding how data gets written. Don't call this
+    # directory, but you can safely override it.
     def persist
       adapter.write(persisted_id, persisted_attributes)
     end