praxis-mapper 4.0 → 4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04a36d68c2385426a0b0aed2295c41299b0c3943
-  data.tar.gz: 5eca3e994f89a94f67a7c1f0d9ec3ed64c274793
+  metadata.gz: 534dfb921f690285f07345acfe42725bdc8cef94
+  data.tar.gz: 603a6f23b61c9734595fc2358bc01f2d08de439f
 SHA512:
-  metadata.gz: 9604920ffc4719206ee8dd41cb2e3a642bb87f8efd64fa44c310d1e6db6f4a702a94c9965724bd98d27984336d745d06b131f766752b989ccfbeb127b754bf9e
-  data.tar.gz: 88a2a5c4c87f99701c955e4f1063e8d5169363f6250cf06b992b53f978581b6cc35cbd645c4d2c34229146e8ada75534ad5b338598038c870a2ace98f214b895
+  metadata.gz: 09b91f6256a04bc776a3aabc82e1b070182c2a03ecdfd9d86edb5abcee01f06529d99f0bb5667a2fc202d5089370799f19f226f5e869ae676339802b385f1f88
+  data.tar.gz: 88dec0ce7600e96e87bc08963f8228c18e0b963ebbaa2da448a550e5287bc6331c330559d75d574b681052f5de4d67a5cb64f614b5067bb2e4b743e09f3d9357

data/CHANGELOG.md

@@ -1,14 +1,22 @@
 # praxis-mapper changelog
 
+## next
+
+## 4.1
+
+* Added instrumentation through `ActiveSupport::Notifications`
+  * Use the 'praxis.mapper.load' to subscribe to `IdentityMap.load` calls
+  * Use the 'praxis.mapper.finalize' to subscribe to `IdentityMap.finalize!` calls
+
 ## 4.0
 
 * Optimization on handling repeated ids (especially noticeable when using subloads)
 * Refactored `ConnectionManager` repository handling to improve integration with other connection-pooling (specifically Sequel's at present).
 * Added two types of connection factory under `Praxis::Mapper::ConnectionFactories::`:
   * `Simple`: Takes a `connection:` option to specify the raw object to return for all `checkout`. Also, preserves current behavior with proc-based uses when `ConnectionManager.repository` is given a block. This is the default factory type if one is not specified for the repository.
-  * `Sequel`: Takes `connection:` option to specify a `Sequel::Database`, or hash of options to pass to `Sequel.connect`. 
+  * `Sequel`: Takes `connection:` option to specify a `Sequel::Database`, or hash of options to pass to `Sequel.connect`.
 * `IdentityMap#finalize!` now calls `ConnectionManager#release` to ensure any connections are returned to their respective pools, if applicable.
-* Added `SequelCompat` module, which provides support for using `Sequel::Model` objects with an `IdentityMap` when included in model class. 
+* Added `SequelCompat` module, which provides support for using `Sequel::Model` objects with an `IdentityMap` when included in model class.
   * This overrides the association accessors on instances associated with an `IdentityMap` (see below for more on this) to query the map instead of database.
   * See (spec/support/spec_sequel_models.rb) for example definition.
 * Added prototype for write-path support to `IdentityMap` (for `Sequel::Model` models):
@@ -18,7 +26,7 @@
     * with no argument, or nil, given it saves all modified records in the identity map.
     * with an instance of a model, it saves just that record.
     * with a model class, it saves all modified records for that class in the identity map.
-  * `IdentityMap#remove`: calls `detatch` with the record, and then calls`record.delete` to delete it. 
+  * `IdentityMap#remove`: calls `detatch` with the record, and then calls`record.delete` to delete it.
 
 
 ## 3.4.0

data/lib/praxis-mapper/identity_map.rb

@@ -127,16 +127,18 @@ module Praxis::Mapper
         return finalize_model!(model, query)
       end
 
-      records = query.execute
-      im_records = add_records(records)
+      ActiveSupport::Notifications.instrument 'praxis.mapper.load', model: model do
+        records = query.execute
+        im_records = add_records(records)
 
-      # TODO: refactor this to better-hide queries?
-      query.freeze
-      self.queries[model].add(query)
+        # TODO: refactor this to better-hide queries?
+        query.freeze
+        queries[model].add(query)
 
-      subload(model, query,records)
+        subload(model, query, records)
 
-      im_records
+        im_records
+      end
     end
 
     def stage_for!(spec, records)
@@ -183,17 +185,25 @@ module Praxis::Mapper
       end
     end
 
-    def finalize!(*models)
-      if models.empty?
-        models = @staged.keys
+    def finalize!(*models, instrument: true)
+      if instrument
+        ActiveSupport::Notifications.instrument 'praxis.mapper.finalize' do
+          _finalize!(*models)
+        end
+      else
+        _finalize!(*models)
       end
+    end
+
+    def _finalize!(*models)
+      models = @staged.keys if models.empty?
 
       did_something = models.any? do |model|
         finalize_model!(model).any?
       end
 
       if did_something
-        finalize!
+        _finalize!
       else
         release
       end
@@ -205,19 +215,18 @@ module Praxis::Mapper
 
     # don't doc. never ever use yourself!
     # FIXME: make private and fix specs that break?
-    def finalize_model!(model, query=nil)
+    def finalize_model!(model, query = nil)
       staged_queries = @staged[model].delete(:_queries) || []
       staged_keys = @staged[model].keys
-      identities = staged_keys && model.identities
       non_identities = staged_keys - model.identities
 
       results = Set.new
 
-      return results if @staged[model].all? { |(key,values)| values.empty? }
+      return results if @staged[model].all? { |(_key, values)| values.empty? }
 
       if query.nil?
         query_class = @connection_manager.repository(model.repository_name)[:query]
-        query = query_class.new(self,model)
+        query = query_class.new(self, model)
       end
 
       # Apply any relevant blocks passed to track in the original queries

data/lib/praxis-mapper/version.rb

@@ -1,5 +1,5 @@
 module Praxis
   module Mapper
-    VERSION = "4.0"
+    VERSION = "4.1"
   end
 end

data/spec/praxis-mapper/identity_map_spec.rb

@@ -104,6 +104,9 @@ describe Praxis::Mapper::IdentityMap do
       it 'builds a query, executes, freezes it, and returns the query results' do
         Praxis::Mapper::Support::MemoryQuery.any_instance.should_receive(:execute).and_return(records)
         Praxis::Mapper::Support::MemoryQuery.any_instance.should_receive(:freeze)
+        ActiveSupport::Notifications.should_receive(:instrument).
+          with('praxis.mapper.load', {model: model}).
+          and_call_original
         identity_map.load(model, &query_proc).should === records
       end
 
@@ -141,7 +144,7 @@ describe Praxis::Mapper::IdentityMap do
         identity_map.should_receive(:finalize_model!) do |model, query|
           model.should be(AddressModel)
           query.where.should be(nil)
-          query.track.should eq(Set.new([:foobar])) 
+          query.track.should eq(Set.new([:foobar]))
         end
       end
     end
@@ -283,7 +286,25 @@ describe Praxis::Mapper::IdentityMap do
     end
   end
 
+  context '#finalize!' do
+    let(:stage) { {:id => [1,2] } }
+    before do
+      identity_map.stage(PersonModel, stage)
+    end
+
+    it 'sends the correct ActiveSupport::Notification' do
+      ActiveSupport::Notifications.should_receive(:instrument).
+        with('praxis.mapper.finalize').
+        and_call_original
+      identity_map.finalize!
+    end
 
+    it 'does not send ActiveSupport::Notification if instrument: false is passed' do
+      ActiveSupport::Notifications.should_not_receive(:instrument)
+      identity_map.finalize!(instrument: false)
+    end
+
+  end
 
   context "#finalize_model!" do
     let(:record_query) { nil }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: praxis-mapper
 version: !ruby/object:Gem::Version
-  version: '4.0'
+  version: '4.1'
 platform: ruby
 authors:
 - Josep M. Blanquer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-22 00:00:00.000000000 Z
+date: 2015-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: randexp
@@ -316,7 +316,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A multi-datastore library designed for efficiency in loading large datasets.