rom-core 4.0.0.beta2 → 4.0.0.beta3

data/lib/rom/relation/composite.rb

@@ -23,10 +23,8 @@ module ROM
 
         if response.is_a?(Loaded)
           response
-        elsif relation.is_a?(Loaded)
-          relation.new(response)
         else
-          Loaded.new(relation, response)
+          relation.new(response)
         end
       end
       alias_method :[], :call

data/lib/rom/relation/curried.rb

@@ -20,7 +20,7 @@ module ROM
       param :relation
 
       option :view, type: Types::Strict::Symbol
-      option :arity, type: Types::Strict::Int, default: -> { -1 }
+      option :arity, type: Types::Strict::Int
       option :curry_args, default: -> { EMPTY_ARRAY }
 
       # Load relation if args match the arity
@@ -29,22 +29,18 @@ module ROM
       #
       # @api public
       def call(*args)
-        if arity != -1
-          all_args = curry_args + args
+        all_args = curry_args + args
 
-          if all_args.empty?
-            raise ArgumentError, "curried #{relation.class}##{view} relation was called without any arguments"
-          end
+        if all_args.empty?
+          raise ArgumentError, "curried #{relation.class}##{view} relation was called without any arguments"
+        end
 
-          if args.empty?
-            self
-          elsif arity == all_args.size
-            Loaded.new(relation.__send__(view, *all_args))
-          else
-            __new__(relation, curry_args: all_args)
-          end
+        if args.empty?
+          self
+        elsif arity == all_args.size
+          Loaded.new(relation.__send__(view, *all_args))
         else
-          super
+          __new__(relation, curry_args: all_args)
         end
       end
       alias_method :[], :call

data/lib/rom/relation/graph.rb

@@ -6,6 +6,7 @@ require 'rom/relation/loaded'
 require 'rom/relation/composite'
 require 'rom/relation/materializable'
 require 'rom/pipeline'
+require 'rom/support/memoizable'
 
 module ROM
   class Relation
@@ -15,6 +16,8 @@ module ROM
     class Graph
       extend Initializer
 
+      include Memoizable
+
       param :root
 
       param :nodes
@@ -70,6 +73,11 @@ module ROM
         mappers[to_ast]
       end
 
+      # @api private
+      memoize def to_ast
+        [:relation, [name.relation, attr_ast + nodes.map(&:to_ast), meta_ast]]
+      end
+
       private
 
       # @api private

data/lib/rom/relation/materializable.rb

@@ -4,13 +4,6 @@ module ROM
     #
     # @api public
     module Materializable
-      # @abstract
-      #
-      # @api public
-      def call(*)
-        raise NotImplementedError, "#{self.class}#call must be implemented"
-      end
-
       # Coerce the relation to an array
       #
       # @return [Array]

data/lib/rom/relation/name.rb

@@ -71,7 +71,7 @@ module ROM
 
       # @api private
       def aliased?
-        !aliaz.nil?
+        aliaz && aliaz != relation
       end
 
       # Return relation name
@@ -80,7 +80,7 @@ module ROM
       #
       # @api private
       def to_s
-        if aliaz
+        if aliased?
           "#{relation} on #{dataset} as #{aliaz}"
         elsif relation == dataset
           relation.to_s

data/lib/rom/relation/wrap.rb

@@ -1,4 +1,5 @@
 require 'rom/relation/graph'
+require 'rom/relation/combined'
 
 module ROM
   class Relation
@@ -6,18 +7,6 @@ module ROM
     #
     # @api public
     class Wrap < Graph
-      extend Initializer
-
-      include Materializable
-      include Pipeline
-      include Pipeline::Proxy
-
-      param :root
-      param :nodes
-
-      alias_method :left, :root
-      alias_method :right, :nodes
-
       # @api public
       def wrap(*args)
         self.class.new(root, nodes + root.wrap(*args).nodes)
@@ -39,21 +28,6 @@ module ROM
         raise NotImplementedError
       end
 
-      # @api private
-      def to_ast
-        @__ast__ ||= [:relation, [name.relation, attr_ast + nodes_ast, meta_ast]]
-      end
-
-      # @api private
-      def attr_ast
-        root.attr_ast
-      end
-
-      # @api private
-      def nodes_ast
-        nodes.map(&:to_ast)
-      end
-
       # Return if this is a wrap relation
       #
       # @return [true]
@@ -62,6 +36,13 @@ module ROM
       def wrap?
         true
       end
+
+      private
+
+      # @api private
+      def decorate?(other)
+        super || other.is_a?(Combined)
+      end
     end
   end
 end

data/lib/rom/relation.rb

@@ -14,6 +14,7 @@ require 'rom/command_registry'
 
 require 'rom/relation/loaded'
 require 'rom/relation/curried'
+require 'rom/relation/commands'
 require 'rom/relation/composite'
 require 'rom/relation/combined'
 require 'rom/relation/wrap'
@@ -55,9 +56,69 @@ module ROM
 
     extend Dry::Core::ClassAttributes
 
-    defines :adapter, :gateway, :schema_opts, :schema_class,
+    defines :adapter, :schema_opts, :schema_class,
             :schema_attr_class, :schema_inferrer, :schema_dsl,
-            :wrap_class, :auto_map, :auto_struct, :struct_namespace
+            :wrap_class
+
+    # @!method self.gateway
+    #  Manage the gateway
+    #
+    #  @overload gateway
+    #    Return the gateway key that the relation is associated with
+    #    @return [Symbol]
+    #
+    #  @overload gateway(gateway_key)
+    #    Link the relation to a gateway. Change this setting if the
+    #    relation is defined on a non-default gateway
+    #
+    #    @example
+    #      class Users < ROM::Relation[:sql]
+    #        gateway :custom
+    #      end
+    #
+    #    @param [Symbol] gateway_key
+    defines :gateway
+
+    # @!method self.auto_map
+    #   Whether or not a relation and its compositions should be auto-mapped
+    #
+    #   @overload auto_map
+    #     Return auto_map setting value
+    #     @return [Boolean]
+    #
+    #   @overload auto_map(value)
+    #     Set auto_map value
+    defines :auto_map
+
+    # @!method self.auto_struct
+    #   Whether or not tuples should be auto-mapped to structs
+    #
+    #   @overload auto_struct
+    #     Return auto_struct setting value
+    #     @return [Boolean]
+    #
+    #   @overload auto_struct(value)
+    #     Set auto_struct value
+    defines :auto_struct
+
+    # @!method self.struct_namespace
+    #  Get or set a namespace for auto-generated struct classes.
+    #  By default, new struct classes are created within ROM::Struct
+    #
+    #   @example using custom namespace
+    #     class Users < ROM::Relation[:sql]
+    #       struct_namespace Entities
+    #     end
+    #
+    #     users.by_pk(1).one! # => #<Entities::User id=1 name="Jane Doe">
+    #
+    #  @overload struct_namespace
+    #    @return [Module] Default struct namespace
+    #
+    #  @overload struct_namespace(namespace)
+    #    @param [Module] namespace
+    #
+    defines :struct_namespace
 
     gateway :default
 
@@ -67,7 +128,7 @@ module ROM
 
     schema_opts EMPTY_HASH
     schema_dsl Schema::DSL
-    schema_attr_class Schema::Attribute
+    schema_attr_class Attribute
     schema_class Schema
     schema_inferrer Schema::DEFAULT_INFERRER
 
@@ -109,12 +170,12 @@ module ROM
     # @!attribute [r] auto_map
     #   @return [TrueClass,FalseClass] Whether or not a relation and its compositions should be auto-mapped
     #   @api private
-    option :auto_map, reader: true, default: -> { self.class.auto_map }
+    option :auto_map, default: -> { self.class.auto_map }
 
     # @!attribute [r] auto_struct
     #   @return [TrueClass,FalseClass] Whether or not tuples should be auto-mapped to structs
     #   @api private
-    option :auto_struct, reader: true, default: -> { self.class.auto_struct }
+    option :auto_struct, default: -> { self.class.auto_struct }
 
     # @!attribute [r] struct_namespace
     #   @return [Module] Custom struct namespace
@@ -146,7 +207,7 @@ module ROM
     #   tasks_with_users[:title, :tasks]
     #   # => #<ROM::SQL::Attribute[String] primary_key=false name=:title source=ROM::Relation::Name(tasks)>
     #
-    # @return [Schema::Attribute]
+    # @return [Attribute]
     #
     # @api public
     def [](name)
@@ -176,7 +237,7 @@ module ROM
     #
     # @overload combine(*associations)
     #   Composes relations using configured associations
-
+    #
     #   @example
     #     users.combine(:tasks, :posts)
     #   @param *associations [Array<Symbol>] A list of association names
@@ -334,17 +395,19 @@ module ROM
     #
     # @api public
     def new(dataset, new_opts = EMPTY_HASH)
-      if new_opts.empty?
-        opts = options
-      elsif new_opts.key?(:schema)
-        opts = options.reject { |k, _| k == :input_schema || k == :output_schema }.merge(new_opts)
-      else
-        opts = options.merge(new_opts)
-      end
+      opts =
+        if new_opts.empty?
+          options
+        elsif new_opts.key?(:schema)
+          options.merge(new_opts).reject { |k, _| k == :input_schema || k == :output_schema }
+        else
+          options.merge(new_opts)
+        end
 
       self.class.new(dataset, opts)
     end
 
+    undef_method :with
     # Returns a new instance with the same dataset but new options
     #
     # @example
@@ -417,7 +480,7 @@ module ROM
     #   Map tuples to the provided custom model class
     #
     #   @example
-    #     users.as(MyUserModel)
+    #     users.map_with(MyUserModel)
     #
     #   @param [Class>] model Your custom model class
     #

data/lib/rom/schema/dsl.rb

@@ -1,7 +1,7 @@
 require 'dry/equalizer'
 
 require 'rom/types'
-require 'rom/schema/attribute'
+require 'rom/attribute'
 require 'rom/schema/associations_dsl'
 
 module ROM
@@ -45,7 +45,7 @@ module ROM
       # @api public
       def attribute(name, type, options = EMPTY_HASH)
         if attributes.key?(name)
-          ::Kernel.raise ::ROM::Schema::AttributeAlreadyDefinedError,
+          ::Kernel.raise ::ROM::AttributeAlreadyDefinedError,
                          "Attribute #{ name.inspect } already defined"
         end
 
@@ -93,6 +93,8 @@ module ROM
       def build_type(name, type, options = EMPTY_HASH)
         if options[:read]
           type.meta(name: name, source: relation, read: options[:read])
+        elsif type.optional? && !type.meta[:read] && type.right.meta[:read]
+          type.meta(name: name, source: relation, read: type.right.meta[:read].optional)
         else
           type.meta(name: name, source: relation)
         end

data/lib/rom/schema/inferrer.rb

@@ -11,7 +11,10 @@ module ROM
 
       MissingAttributesError = Class.new(StandardError) do
         def initialize(name, attributes)
-          super("missing attributes in #{name.inspect} schema: #{attributes.map(&:inspect).join(', ')}")
+          super(
+            "Following attributes in #{Relation::Name[name].relation.inspect} schema cannot "\
+            "be inferred and have to be defined explicitly: #{attributes.map(&:inspect).join(', ')}"
+          )
         end
       end
 

data/lib/rom/schema.rb

@@ -1,6 +1,7 @@
 require 'dry/equalizer'
 
-require 'rom/schema/attribute'
+require 'rom/constants'
+require 'rom/attribute'
 require 'rom/schema/dsl'
 require 'rom/schema/inferrer'
 require 'rom/association_set'
@@ -39,8 +40,10 @@ module ROM
       registry = event[:registry]
 
       registry.each do |_, relation|
-        relation.schema.finalize_associations!(relations: registry)
-        relation.schema.finalize!
+        unless relation.schema.frozen?
+          relation.schema.finalize_associations!(relations: registry)
+          relation.schema.finalize!
+        end
       end
     end
 
@@ -58,8 +61,6 @@ module ROM
 
     DEFAULT_INFERRER = Inferrer.new(enabled: false).freeze
 
-    AttributeAlreadyDefinedError = Class.new(StandardError)
-
     extend Initializer
 
     include Dry::Equalizer(:name, :attributes, :associations)
@@ -101,7 +102,7 @@ module ROM
     # Define a relation schema from plain rom types
     #
     # Resulting schema will decorate plain rom types with adapter-specific types
-    # By default `Schema::Attribute` will be used
+    # By default `Attribute` will be used
     #
     # @param [Relation::Name, Symbol] name The schema name, typically ROM::Relation::Name
     #
@@ -147,7 +148,7 @@ module ROM
 
     # Iterate over schema's attributes
     #
-    # @yield [Schema::Attribute]
+    # @yield [Attribute]
     #
     # @api public
     def each(&block)
@@ -197,7 +198,7 @@ module ROM
 
     # Project a schema to include only specified attributes
     #
-    # @param [*Array<Symbol, Schema::Attribute>] names Attribute names
+    # @param [*Array<Symbol, Attribute>] names Attribute names
     #
     # @return [Schema]
     #
@@ -260,7 +261,7 @@ module ROM
 
     # Return FK attribute for a given relation name
     #
-    # @return [Schema::Attribute]
+    # @return [Attribute]
     #
     # @api public
     def foreign_key(relation)
@@ -269,7 +270,7 @@ module ROM
 
     # Return primary key attributes
     #
-    # @return [Array<Schema::Attribute>]
+    # @return [Array<Attribute>]
     #
     # @api public
     def primary_key
@@ -292,7 +293,7 @@ module ROM
     #
     # This returns a new schema instance
     #
-    # @param [*Array<Schema::Attribute>]
+    # @param [*Array<Attribute>]
     #
     # @return [Schema]
     #
@@ -303,7 +304,7 @@ module ROM
 
     # Return a new schema with uniq attributes
     #
-    # @param [*Array<Schema::Attribute>]
+    # @param [*Array<Attribute>]
     #
     # @return [Schema]
     #

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

@@ -36,13 +36,14 @@ module ROM
       private
 
       def check_duplicate_registered_mappers
-        mappers_register_as = mapper_classes.map(&:register_as).compact
-        mappers_register_as.select { |register_as| mappers_register_as.count(register_as) > 1 }
+        mapper_relation_register = mapper_classes.map {|mapper_class| [mapper_class.relation, mapper_class.register_as].compact }
+        return if mapper_relation_register.uniq.count == mapper_classes.count
+        mapper_relation_register.select { |relation_register_as| mapper_relation_register.count(relation_register_as) > 1 }
           .uniq
           .each do |duplicated_mappers|
             raise MapperAlreadyDefinedError,
-                  "Mapper with `register_as #{duplicated_mappers.inspect}` registered more " \
-                  "than once"
+                  "Mapper with `register_as #{duplicated_mappers.last.inspect}` registered more " \
+                  "than once for relation #{duplicated_mappers.first.inspect}"
           end
       end
 

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

@@ -71,19 +71,17 @@ module ROM
         #       where klass' gateway points to non-existant repo
         gateway = @gateways.fetch(klass.gateway)
 
-        if klass.schema_proc && !klass.schema
-          plugins = schema_plugins
+        plugins = schema_plugins
 
-          resolved_schema = klass.schema_proc.call do
-            plugins.each { |plugin| app_plugin(plugin) }
-          end
-
-          klass.set_schema!(resolved_schema)
+        schema = klass.schema_proc.call do
+          plugins.each { |plugin| app_plugin(plugin) }
         end
 
+        klass.set_schema!(schema) if klass.schema.nil?
+
         notifications.trigger(
           'configuration.relations.schema.allocated',
-          schema: klass.schema, gateway: gateway, registry: registry
+          schema: schema, gateway: gateway, registry: registry
         )
 
         relation_plugins.each do |plugin|
@@ -92,10 +90,9 @@ module ROM
 
         notifications.trigger(
           'configuration.relations.schema.set',
-          schema: resolved_schema, relation: klass, adapter: klass.adapter
+          schema: schema, relation: klass, adapter: klass.adapter
         )
 
-        schema = klass.schema
         rel_key = schema.name.to_sym
         dataset = gateway.dataset(schema.name.dataset).instance_exec(klass, &klass.dataset)
 

data/lib/rom/support/notifications.rb

@@ -3,16 +3,61 @@ require 'dry/equalizer'
 require 'rom/constants'
 
 module ROM
+  # Notification subsystem
+  #
+  # This is an abstract event bus that implements a simple pub/sub protocol.
+  # The Notifications module is used in the setup process to decouple
+  # different modules from each other.
+  #
+  # @example
+  #   class Setup
+  #     extend ROM::Notifications
+  #
+  #     register_event('setup.before_setup')
+  #     register_event('setup.after_setup')
+  #
+  #     def initialize
+  #       @bus = Notifications.event_bus(:setup)
+  #     end
+  #
+  #     def setup
+  #       @bus.trigger('setup.before_setup', at: Time.now)
+  #       # ...
+  #       @bus.trigger('setup.after_setup', at: Time.now)
+  #     end
+  #   end
+  #
+  #   class Plugin
+  #     extend ROM::Notifications::Listener
+  #
+  #     subscribe('setup.after_setup') do |event|
+  #       puts "Loaded at #{event.at.iso8601}"
+  #     end
+  #   end
+  #
   module Notifications
     LISTENERS_HASH = Hash.new { |h, k| h[k] = [] }
 
     module Publisher
+      # Subscribe to events.
+      # If the query parameter is provided, filters events by payload.
+      #
+      # @param [String] event_id The event key
+      # @param [Hash] query An optional event filter
+      # @yield [block] The callback
+      # @return [Object] self
+      #
       # @api public
       def subscribe(event_id, query = EMPTY_HASH, &block)
         listeners[event_id] << [block, query]
         self
       end
 
+      # Trigger an event
+      #
+      # @param [String] event_id The event key
+      # @param [Hash] payload An optional payload
+      #
       # @api public
       def trigger(event_id, payload = EMPTY_HASH)
         event = events[event_id]
@@ -23,20 +68,40 @@ module ROM
       end
     end
 
+    # Event object
+    #
+    # @api public
     class Event
       include Dry::Equalizer(:id, :payload)
 
+      # @attr_reader [String] id Event ID
       attr_reader :id
 
+      # @api public
       def initialize(id, payload = EMPTY_HASH)
         @id = id
         @payload = payload
       end
 
+      # Get data from the payload
+      #
+      # @param [String,Symbol] name
+      #
+      # @api public
       def [](name)
         @payload.fetch(name)
       end
 
+      # Get or set a payload
+      #
+      # @overload
+      #   @return [Hash] payload
+      #
+      # @overload payload(data)
+      #   @param [Hash] data A new payload
+      #   @return [Event] A copy of the event with the provided payload
+      #
+      # @api public
       def payload(data = nil)
         if data
           self.class.new(id, @payload.merge(data))
@@ -45,10 +110,17 @@ module ROM
         end
       end
 
+      # Trigger the event
+      #
+      # @param [#call] listener
+      # @param [Hash] query
+      #
+      # @api private
       def trigger(listener, query = EMPTY_HASH)
         listener.(self) if trigger?(query)
       end
 
+      # @api private
       def trigger?(query)
         query.empty? || query.all? { |key, value| @payload[key] == value }
       end
@@ -56,6 +128,11 @@ module ROM
 
     extend Publisher
 
+    # Register an event
+    #
+    # @param [String] id A unique event key
+    # @param [Hash] info
+    #
     # @api public
     def register_event(id, info = EMPTY_HASH)
       Notifications.events[id] = Event.new(id, info)
@@ -71,6 +148,11 @@ module ROM
       @__listeners__ ||= LISTENERS_HASH.dup
     end
 
+    # Build an event bus
+    #
+    # @param [Symbol] id Bus key
+    # @return [Notifications::EventBus] A new bus
+    #
     # @api public
     def self.event_bus(id)
       EventBus.new(id, events: events.dup, listeners: listeners.dup)
@@ -78,12 +160,22 @@ module ROM
 
     # @api public
     module Listener
+      # Subscribe to events
+      #
+      # @param [String] event_id The event key
+      # @param [Hash] query An optional event filter
+      # @return [Object] self
+      #
       # @api public
       def subscribe(event_id, query = EMPTY_HASH, &block)
         Notifications.listeners[event_id] << [block, query]
       end
     end
 
+    # Event bus
+    #
+    # An event bus stores listeners (callbacks) and events
+    #
     # @api public
     class EventBus
       include Publisher

data/lib/rom/version.rb

@@ -1,5 +1,5 @@
 module ROM
   module Core
-    VERSION = '4.0.0.beta2'.freeze
+    VERSION = '4.0.0.beta3'.freeze
   end
 end