rom-sql 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a59a75e6eb28bd684acbd721bf2718637ec3463
-  data.tar.gz: eb2281b8bb5f156d73056e1b56f8a58fa7fa174a
+  metadata.gz: a673acd61e77b7b2c2a49c3dd781e06d716cec4e
+  data.tar.gz: e45523ac3f3c46e314fe529eb98d6ac721694e8d
 SHA512:
-  metadata.gz: 3385bfffcc897f83b3d7c0a77d93d4a7bb9ff3416be241fe9df53e5b8a4c38371a196461d8f7b7c90dcf99f2083cfe876fcfe109b86d3fe3910913c8537fc95a
-  data.tar.gz: 6c4cf20e4be86dc15f49162657ced6df27818c8d3c4a12bf966ce327541a585ce8d94ad7c2ad003ee318e442ae5611b4f4979114e099947b5627ba82264e9bf4
+  metadata.gz: d810deb9e4bc9d86bd35d8603644a7aa87dd7f2f7b712d681d9260482763c376f367535a22833f1b18ab36ff9d67ef26c175e4339967d52b6a7a18dfead68bf8
+  data.tar.gz: fc32e693d9b079c81108f495df1e42fcb8cdfa971104fead58c635f75a7fcb837933eb743265be7a866282f417a3d937fb7e166ebb319090809ef43ada8e331a

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## v2.2.1 2017-11-10
+
+### Fixed
+
+* Instrumentation works with all db interactions (not just queries that materialize relations) (solnic)
+* Typo in `MissingEnv` exception message (romatr)
+
+[Compare v2.2.0...v2.2.1](https://github.com/rom-rb/rom-sql/compare/v2.2.0...v2.2.1)
+
 ## v2.2.0 2017-11-02
 
 ### Added

data/lib/rom/plugins/relation/sql/instrumentation.rb

@@ -1,23 +1,86 @@
-require 'rom/plugins/relation/instrumentation'
-
 module ROM
   module Plugins
     module Relation
       module SQL
-        # @api private
+        # Instrumentation for relations and commands
+        #
+        # This plugin allows configuring a notification system, that will be used
+        # to instrument interactions with databases, it's based on an abstract API
+        # so it should work with any instrumentation object that provides
+        # `instrument(identifier, payload)` method.
+        #
+        # By default, instrumentation is triggered with following arguments:
+        #   - `identifier` is set to `:sql`
+        #   - `payload` is set to a hash with following keys:
+        #     - `:name` database type, ie `:sqlite`, `:postgresql` etc.
+        #     - `:query` a string with an SQL statement that was executed
+        #
+        # @example configuring notifications
+        #   config = ROM::Configuration.new(:sqlite, 'sqlite::memory')
+        #
+        #   config.plugin(:sql, relations: :instrumentation) do |c|
+        #     c.notifications = MyNotifications.new
+        #   end
+        #
+        # @api public
         module Instrumentation
-          def self.included(klass)
-            super
+          extend Notifications::Listener
+
+          subscribe('configuration.relations.registry.created') do |event|
+            registry = event[:registry]
+
+            relations = registry.select { |_, r| r.adapter == :sql && r.respond_to?(:notifications) }.to_h
+            db_notifications = relations.values.map { |r| [r.dataset.db, r.notifications] }.uniq.to_h
+
+            db_notifications.each do |db, notifications|
+              instrumenter = Instrumenter.new(db.database_type, notifications)
+              db.extend(instrumenter)
+            end
+          end
+
+          # This stateful module is used to extend database connection objects
+          # and monkey-patches `log_connection_yield` method, which unfortunately
+          # is the only way to provide instrumentation on the sequel side.
+          #
+          # @api private
+          class Instrumenter < Module
+            # @!attribute [r] name
+            #   @return [Symbol] database type
+            attr_reader :name
 
-            klass.class_eval do
-              include ROM::Plugins::Relation::Instrumentation
+            # @!attribute [r] notifications
+            #   @return [Object] any object that responds to `instrument`
+            attr_reader :notifications
 
-              # @api private
-              def notification_payload(relation)
-                super.merge(query: relation.dataset.sql)
+            # @api private
+            def initialize(name, notifications)
+              @name = name
+              @notifications = notifications
+              define_log_connection_yield
+            end
+
+            private
+
+            # @api private
+            def define_log_connection_yield
+              name = self.name
+              notifications = self.notifications
+
+              define_method(:log_connection_yield) do |*args, &block|
+                notifications.instrument(:sql, name: name, query: args[0]) do
+                  super(*args, &block)
+                end
               end
             end
           end
+
+          # Add `:notifications` option to a relation
+          #
+          # @api private
+          def self.included(klass)
+            super
+            klass.option :notifications
+          end
         end
       end
     end

data/lib/rom/sql/tasks/migration_tasks.rake

@@ -27,7 +27,7 @@ module ROM
         def gateway
           if env.nil?
             Gateway.instance ||
-              raise(MissingEnv, "Set up a configutation with ROM::SQL::RakeSupport.env= in the db:setup task")
+              raise(MissingEnv, "Set up a configuration with ROM::SQL::RakeSupport.env= in the db:setup task")
           else
             env.gateways[:default]
           end

data/lib/rom/sql/version.rb

@@ -1,5 +1,5 @@
 module ROM
   module SQL
-    VERSION = '2.2.0'.freeze
+    VERSION = '2.2.1'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rom-sql
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-02 00:00:00.000000000 Z
+date: 2017-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -246,7 +246,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: SQL databases support for ROM