rom 3.0.3 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21823f588a092ca791957a4d3bdb1ca3a78fed7e
-  data.tar.gz: b779976efe0eb2d4ec2e7af273cd67782def6120
+  metadata.gz: 60084563a6e8cbda433df877fa5ceeaf6e342551
+  data.tar.gz: 9cf468362a1adbc5b64e10d4459af3c1b05d31d6
 SHA512:
-  metadata.gz: e5f1e53320f6da430fed29b9c0619847c47b6e34808445852c362216a04a5354384af47b07b946410aa4fbd51c4925f753ef372c9d1485454c00337fc5ff973f
-  data.tar.gz: 610cc7feec934fb6550b371218d5ebbc901417bfcd25b7d1d6709f8ef91684435b16b4d1da5d5e5405284ed14d0ad8a968a1e0f61e5d30582b17a0afea17d098
+  metadata.gz: bd60b6cc80d21d168fe472b4f6b52cd854e7afb368c930ae652ecb0306e9c3946d9d64d9dee7e7cdfa9e9fd66593ec8820f8ea49117cac1317c7e099f8a72a26
+  data.tar.gz: 5db668afb63edb340bd298314eede1a5cf33f6703e5777a5f9654e62eaba8789717147f322cabbdb7d911407ec66159f18d64191a03b1ccdd9d30e5fc1dd0206

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v3.0.4 2017-03-01
+
+## Added
+
+* New configuration DSL for configuring plugins (solnic)
+* Instrumentation plugin for relations (solnic)
+* New `ROM::Relation::Loaded#empty?` method (solnic)
+* New `ROM::Relation::Graph#with_nodes` which returns a new graph with new nodes (solnic)
+* New `ROM::Schema#empty` which returns an empty schema (solnic)
+
+[Compare v3.0.3...v3.0.4](https://github.com/rom-rb/rom/compare/v3.0.3...v3.0.4)
+
 # v3.0.3 2017-02-24
 
 ## Fixed

data/Gemfile

@@ -2,9 +2,6 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'rom-mapper', git: 'https://github.com/rom-rb/rom-mapper.git', branch: 'master'
-gem 'transproc', git: 'https://github.com/solnic/transproc.git', branch: 'master'
-
 group :console do
   gem 'pry'
   gem 'pg', platforms: [:mri]
@@ -47,6 +44,7 @@ group :benchmarks do
   gem 'activerecord', '~> 5.0'
   gem 'benchmark-ips', '~> 2.2.0'
   gem 'rom-repository', git: 'https://github.com/rom-rb/rom-repository.git', branch: 'master'
+  gem 'hotch', platform: :mri
 end
 
 group :tools do

data/lib/rom.rb

@@ -30,6 +30,7 @@ require 'rom/create_container'
 # register core plugins
 require 'rom/plugins/configuration/configuration_dsl'
 require 'rom/plugins/relation/registry_reader'
+require 'rom/plugins/relation/instrumentation'
 require 'rom/plugins/command/schema'
 
 module ROM
@@ -38,6 +39,7 @@ module ROM
   plugins do
     register :macros, ROM::ConfigurationPlugins::ConfigurationDSL, type: :configuration
     register :registry_reader, ROM::Plugins::Relation::RegistryReader, type: :relation
+    register :instrumentation, ROM::Plugins::Relation::Instrumentation, type: :relation
     register :schema, ROM::Plugins::Command::Schema, type: :command
   end
 end

data/lib/rom/configuration.rb

@@ -13,7 +13,7 @@ module ROM
 
     attr_reader :environment, :setup
 
-    def_delegators :@setup, :register_relation, :register_command, :register_mapper,
+    def_delegators :@setup, :register_relation, :register_command, :register_mapper, :register_plugin,
                             :relation_classes, :command_classes, :mapper_classes,
                             :auto_registration
 

data/lib/rom/configuration_dsl.rb

@@ -70,5 +70,38 @@ module ROM
     def commands(name, &block)
       register_command(*CommandDSL.new(name, default_adapter, &block).command_classes)
     end
+
+    # Configures a plugin for a specific adapter to be enabled for all relations
+    #
+    # @example
+    #   config = ROM::Configuration.new(:sql, 'sqlite::memory')
+    #
+    #   config.plugin(:sql, relations: :instrumentation) do |p|
+    #     p.notifications = MyNotificationsBackend
+    #   end
+    #
+    #   config.plugin(:sql, relations: :pagination)
+    #
+    # @param [Symbol] adapter The adapter identifier
+    # @param [Hash<Symbol=>Symbol>] spec Component identifier => plugin identifier
+    #
+    # @return [Plugin]
+    #
+    # @api public
+    def plugin(adapter, spec, &block)
+      type, name = spec.flatten(1)
+      plugin = plugin_registry.send(type).adapter(adapter).fetch(name) { plugin_registry.send(type).fetch(name) }
+
+      if block
+        register_plugin(plugin.configure(&block))
+      else
+        register_plugin(plugin)
+      end
+    end
+
+    # @api private
+    def plugin_registry
+      ROM.plugin_registry
+    end
   end
 end

data/lib/rom/create_container.rb

@@ -27,6 +27,7 @@ module ROM
         relation_classes: setup.relation_classes,
         command_classes: setup.command_classes,
         mappers: setup.mapper_classes,
+        plugins: setup.plugins,
         config: environment.config.dup.freeze
       )
 

data/lib/rom/plugin.rb

@@ -1,10 +1,13 @@
 require 'rom/plugin_base'
+require 'rom/support/configurable'
 
 module ROM
   # Plugin is a simple object used to store plugin configurations
   #
   # @private
   class Plugin < PluginBase
+    include Configurable
+
     # Apply this plugin to the provided class
     #
     # @param [Class] klass

data/lib/rom/plugin_base.rb

@@ -13,10 +13,19 @@ module ROM
     # @api private
     attr_reader :options
 
+    # @api private
+    attr_reader :type
+
     # @api private
     def initialize(mod, options)
       @mod      = mod
       @options  = options
+      @type = options.fetch(:type)
+    end
+
+    # @api private
+    def relation?
+      type == :relation
     end
 
     # Apply this plugin to the provided class

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

@@ -0,0 +1,43 @@
+module ROM
+  module Plugins
+    module Relation
+      # Experimental plugin for configuring relations with an external
+      # instrumentation system like dry-monitor or ActiveSupport::Notifications
+      #
+      # @api public
+      module Instrumentation
+        # This hooks sets up a relation class with injectible notifications object
+        #
+        # @api private
+        def self.included(klass)
+          super
+          klass.option :notifications, reader: true
+          klass.extend(ClassInterface)
+          klass.instrument(:to_a)
+        end
+
+        module ClassInterface
+          def instrument(*methods)
+            methods.each do |meth|
+              define_method(meth) do
+                instrument { super() }
+              end
+            end
+          end
+        end
+
+        # @api public
+        def instrument(&block)
+          notifications.instrument(self.class.adapter, { name: name.relation }.merge(notification_payload(self)), &block)
+        end
+
+        private
+
+        # @api private
+        def notification_payload(relation)
+          EMPTY_HASH
+        end
+      end
+    end
+  end
+end

data/lib/rom/relation/graph.rb

@@ -61,6 +61,11 @@ module ROM
         @nodes = nodes
       end
 
+      # @api public
+      def with_nodes(nodes)
+        self.class.new(root, nodes)
+      end
+
       # Return if this is a graph relation
       #
       # @return [true]
@@ -90,10 +95,10 @@ module ROM
         left = root.call(*args)
 
         right =
-          if left.count > 0
-            nodes.map { |node| node.call(left) }
+          if left.empty?
+            nodes.map { |node| Loaded.new(node, EMPTY_ARRAY) }
           else
-            nodes.map { |node| Loaded.new(node, []) }
+            nodes.map { |node| node.call(left) }
           end
 
         Loaded.new(self, [left, right])

data/lib/rom/relation/loaded.rb

@@ -107,6 +107,15 @@ module ROM
         pluck(source.primary_key)
       end
 
+      # Return if loaded relation is empty
+      #
+      # @return [TrueClass,FalseClass]
+      #
+      # @api public
+      def empty?
+        collection.empty?
+      end
+
       # Return a loaded relation with a new collection
       #
       # @api public

data/lib/rom/setup.rb

@@ -17,11 +17,16 @@ module ROM
     # @api private
     attr_reader :command_classes
 
+
+    # @api private
+    attr_reader :plugins
+
     # @api private
     def initialize
       @relation_classes = []
       @command_classes = []
       @mapper_classes = []
+      @plugins = []
     end
 
     # Relation sub-classes are being registered with this method during setup
@@ -45,6 +50,11 @@ module ROM
       klasses.reduce(@command_classes, :<<)
     end
 
+    # @api private
+    def register_plugin(plugin)
+      plugins << plugin
+    end
+
     def auto_registration(directory, options = {})
       auto_registration = AutoRegistration.new(directory, options)
       auto_registration.relations.map { |r| register_relation(r) }

data/lib/rom/setup/finalize.rb

@@ -21,7 +21,7 @@ module ROM
   # @private
   class Finalize
     attr_reader :gateways, :repo_adapter, :datasets, :gateway_map,
-      :relation_classes, :mapper_classes, :mapper_objects, :command_classes, :config
+      :relation_classes, :mapper_classes, :mapper_objects, :command_classes, :plugins, :config
 
     # @api private
     def initialize(options)
@@ -37,6 +37,8 @@ module ROM
 
       @config = options.fetch(:config)
 
+      @plugins = options.fetch(:plugins)
+
       initialize_datasets
     end
 
@@ -90,7 +92,7 @@ module ROM
     #
     # @api private
     def load_relations
-      FinalizeRelations.new(gateways, relation_classes).run!
+      FinalizeRelations.new(gateways, relation_classes, plugins.select(&:relation?)).run!
     end
 
     # @api private

data/lib/rom/setup/finalize/finalize_relations.rb

@@ -11,9 +11,10 @@ module ROM
       # @param [Array] relation_classes a list of relation descendants
       #
       # @api private
-      def initialize(gateways, relation_classes)
+      def initialize(gateways, relation_classes, plugins = EMPTY_ARRAY)
         @gateways = gateways
         @relation_classes = relation_classes
+        @plugins = plugins
       end
 
       # @return [Hash]
@@ -53,9 +54,20 @@ module ROM
         klass.schema(infer: true) unless klass.schema
         schema = klass.schema.finalize!(gateway: gateway, relations: registry)
 
+        @plugins.each do |plugin|
+          plugin.apply_to(klass)
+        end
+
         dataset = gateway.dataset(klass.dataset).instance_exec(klass, &ds_proc)
 
-        klass.new(dataset, __registry__: registry, schema: schema.with(relations: registry))
+        options = { __registry__: registry, schema: schema.with(relations: registry), **plugin_options }
+
+        klass.new(dataset, options)
+      end
+
+      # @api private
+      def plugin_options
+        @plugins.map(&:config).map(&:to_hash).reduce(:merge) || EMPTY_HASH
       end
     end
   end

data/lib/rom/support/configurable.rb

@@ -21,6 +21,10 @@ module ROM
         settings.key?(name)
       end
 
+      def to_hash
+        settings
+      end
+
       # @api private
       def freeze
         settings.each_value(&:freeze)
@@ -31,13 +35,13 @@ module ROM
       def respond_to_missing?(_name, _include_private = false)
         true
       end
-      
+
       def dup
         self.class.new(dup_settings(settings))
       end
-        
+
       private
-      
+
       def dup_settings(settings)
         settings.each_with_object({}) do |(key, value), new_settings|
           if value.is_a?(self.class)
@@ -75,6 +79,7 @@ module ROM
     # @api public
     def configure
       yield(config)
+      self
     end
   end
 end

data/lib/rom/version.rb

@@ -1,3 +1,3 @@
 module ROM
-  VERSION = '3.0.3'.freeze
+  VERSION = '3.1.0'.freeze
 end

data/spec/integration/setup_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'rom/plugins/relation/key_inference'
 require 'dry-struct'
 
 RSpec.describe 'Configuring ROM' do
@@ -163,4 +164,27 @@ RSpec.describe 'Configuring ROM' do
       ROM.container(:memory) { |c| c.register_relation(Test::UserRelation) }
     end
   end
+
+  describe 'configuring plugins for all relations' do
+    it 'allows setting instrumentation for relations' do
+      Test::Notifications = double(:notifications)
+
+      configuration = ROM::Configuration.new(:memory)
+
+      configuration.plugin(:memory, relations: :instrumentation) do |p|
+        p.notifications = Test::Notifications
+      end
+
+      configuration.plugin(:memory, relations: :key_inference)
+
+      configuration.relation(:users)
+
+      container = ROM.container(configuration)
+
+      users = container.relations[:users]
+
+      expect(users.notifications).to be(Test::Notifications)
+      expect(users).to respond_to(:foreign_key)
+    end
+  end
 end

data/spec/unit/rom/plugins/relation/instrumentation_spec.rb

@@ -0,0 +1,40 @@
+require 'rom'
+require 'rom/memory'
+
+RSpec.describe ROM::Plugins::Relation::Instrumentation do
+  subject(:relation) do
+    relation_class.new(dataset, notifications: notifications)
+  end
+
+  let(:dataset) do
+    double(:dataset)
+  end
+
+  let(:relation_class) do
+    Class.new(ROM::Memory::Relation) do
+      schema(:users) do
+        attribute :name, ROM::Types::String
+      end
+
+      use :instrumentation
+
+      instrument def all
+        self
+      end
+    end
+  end
+
+  let(:notifications) { spy(:notifications) }
+
+  it 'uses notifications API when materializing a relation' do
+    relation.to_a
+
+    expect(notifications).to have_received(:instrument).with(:memory, name: :users)
+  end
+
+  it 'instruments custom methods' do
+    relation.all
+
+    expect(notifications).to have_received(:instrument).with(:memory, name: :users)
+  end
+end

data/spec/unit/rom/relation/graph_spec.rb

@@ -17,6 +17,10 @@ RSpec.describe ROM::Relation::Graph do
       def for_users(_users)
         self
       end
+
+      def by_title(title)
+        restrict(title: title)
+      end
     end.new(tasks_dataset)
   end
 
@@ -64,6 +68,15 @@ RSpec.describe ROM::Relation::Graph do
     end
   end
 
+  describe '#with_nodes' do
+    it 'returns a new graph with new nodes' do
+      new_tasks = tasks_relation.by_title('foo')
+      new_graph = graph.with_nodes([new_tasks])
+
+      expect(new_graph.nodes[0]).to be(new_tasks)
+    end
+  end
+
   describe '#call' do
     it 'materializes relations' do
       expect(graph.call).to match_array([

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rom
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.1.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-24 00:00:00.000000000 Z
+date: 2017-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -219,6 +219,7 @@ files:
 - lib/rom/plugin_registry.rb
 - lib/rom/plugins/command/schema.rb
 - lib/rom/plugins/configuration/configuration_dsl.rb
+- lib/rom/plugins/relation/instrumentation.rb
 - lib/rom/plugins/relation/key_inference.rb
 - lib/rom/plugins/relation/registry_reader.rb
 - lib/rom/registry.rb
@@ -349,6 +350,7 @@ files:
 - spec/unit/rom/memory/storage_spec.rb
 - spec/unit/rom/plugin_spec.rb
 - spec/unit/rom/plugins/command/schema_spec.rb
+- spec/unit/rom/plugins/relation/instrumentation_spec.rb
 - spec/unit/rom/plugins/relation/key_inference_spec.rb
 - spec/unit/rom/registry_spec.rb
 - spec/unit/rom/relation/attribute_reader_spec.rb