rom 0.8.1 → 0.9.0.beta1

data/lib/rom/environment_plugins/auto_registration.rb

@@ -0,0 +1,17 @@
+module ROM
+  module EnvironmentPlugins
+    # Automatically registers relations, mappers and commands as they are defined
+    #
+    # For now this plugin is always enabled
+    #
+    # @api public
+    module AutoRegistration
+      # @api private
+      def self.apply(environment)
+        ROM::Relation.on(:inherited) { |relation| environment.register_relation(relation) }
+        ROM::Command.on(:inherited) { |command| environment.register_command(command) }
+        ROM::Mapper.on(:inherited) { |mapper| environment.register_mapper(mapper) }
+      end
+    end
+  end
+end

data/lib/rom/global.rb

@@ -1,7 +1,4 @@
-require 'rom/setup'
-require 'rom/repository'
 require 'rom/plugin_registry'
-
 require 'rom/global/plugin_dsl'
 
 module ROM
@@ -16,7 +13,6 @@ module ROM
       super
 
       rom.instance_variable_set('@adapters', {})
-      rom.instance_variable_set('@gateways', {})
       rom.instance_variable_set('@plugin_registry', PluginRegistry.new)
     end
 
@@ -27,13 +23,6 @@ module ROM
     # @api private
     attr_reader :adapters
 
-    # An internal gateway => identifier map used by the setup
-    #
-    # @return [Hash]
-    #
-    # @api private
-    attr_reader :gateways
-
     # An internal identifier => plugin map used by the setup
     #
     # @return [Hash]
@@ -41,137 +30,6 @@ module ROM
     # @api private
     attr_reader :plugin_registry
 
-    # Setup object created during env setup phase
-    #
-    # This gets set to nil after setup is finalized
-    #
-    # @return [Setup]
-    #
-    # @api private
-    attr_reader :boot
-
-    # Return global default ROM environment configured by the setup
-    #
-    # @return [Env]
-    #
-    # @api public
-    attr_reader :env
-
-    # Starts the setup process for relations, mappers and commands.
-    #
-    # @overload setup(type, *args)
-    #   Sets up a single-gateway environment given a gateway type provided
-    #   under the ROM umbrella. For custom gateways, create an instance and
-    #   pass it directly.
-    #
-    #   @param [Symbol] type
-    #   @param [Array] *args
-    #
-    # @overload setup(gateway)
-    #   @param [Gateway] gateway
-    #
-    # @overload setup(gateways)
-    #   Sets up multiple gateways.
-    #
-    #   @param [Hash{Symbol=>Symbol,Array}] gateways
-    #
-    # @return [Setup] boot object
-    #
-    # @example
-    #   # Use the in-memory adapter shipped with ROM as the default gateway.
-    #   env = ROM.setup(:memory, 'memory://test')
-    #   # Use `rom-sql` with an in-memory sqlite database as default gateway.
-    #   ROM.setup(:sql, 'sqlite::memory')
-    #   # Registers a `default` and a `warehouse` gateway.
-    #   env = ROM.setup(
-    #     default: [:sql, 'sqlite::memory'],
-    #     warehouse: [:sql, 'postgres://localhost/warehouse']
-    #   )
-    #
-    # @example A full environment
-    #
-    #   ROM.setup(:memory, 'memory://test')
-    #
-    #   ROM.relation(:users) do
-    #     # ...
-    #   end
-    #
-    #   ROM.mappers do
-    #     define(:users) do
-    #       # ...
-    #     end
-    #   end
-    #
-    #   ROM.commands(:users) do
-    #     define(:create) do
-    #       # ...
-    #     end
-    #   end
-    #
-    #   ROM.finalize # builds the env
-    #   ROM.env # returns the env registry
-    #
-    # @api public
-    def setup(*args, &block)
-      config = setup_config(*args)
-      @boot = Setup.new(setup_gateways(config), adapters.keys.first)
-
-      if block
-        @boot.instance_exec(&block)
-        @boot.finalize
-      else
-        @boot
-      end
-    end
-
-    # Global relation setup DSL
-    #
-    # @example
-    #   ROM.setup(:memory)
-    #
-    #   ROM.relation(:users) do
-    #     def by_name(name)
-    #       restrict(name: name)
-    #     end
-    #   end
-    #
-    # @api public
-    def relation(*args, &block)
-      boot.relation(*args, &block)
-    end
-
-    # Global commands setup DSL
-    #
-    # @example
-    #   ROM.setup(:memory)
-    #
-    #   ROM.commands(:users) do
-    #     define(:create) do
-    #       # ..
-    #     end
-    #   end
-    #
-    # @api public
-    def commands(*args, &block)
-      boot.commands(*args, &block)
-    end
-
-    # Global mapper setup DSL
-    #
-    # @example
-    #   ROM.setup(:memory)
-    #
-    #   ROM.mappers do
-    #     define(:uses) do
-    #       # ..
-    #     end
-    #   end
-    #
-    # @api public
-    def mappers(*args, &block)
-      boot.mappers(*args, &block)
-    end
-
     # Global plugin setup DSL
     #
     # @example
@@ -184,24 +42,6 @@ module ROM
       PluginDSL.new(plugin_registry, *args, &block)
     end
 
-    # Finalize the setup and store default global env under ROM.env
-    #
-    # @example
-    #   ROM.setup(:memory)
-    #   ROM.finalize # => ROM
-    #   ROM.boot # => nil
-    #   ROM.env # => the env
-    #
-    # @return [ROM]
-    #
-    # @api public
-    def finalize
-      @env = boot.finalize
-      self
-    ensure
-      @boot = nil
-    end
-
     # Register adapter namespace under a specified identifier
     #
     # @param [Symbol] identifier
@@ -214,48 +54,5 @@ module ROM
       adapters[identifier] = adapter
       self
     end
-
-    # Relation subclass registration during setup phase
-    #
-    # @api private
-    def register_relation(klass)
-      boot.register_relation(klass) if boot
-    end
-
-    # Mapper subclass registration during setup phase
-    #
-    # @api private
-    def register_mapper(klass)
-      boot.register_mapper(klass) if boot
-    end
-
-    # Command subclass registration during setup phase
-    #
-    # @api private
-    def register_command(klass)
-      boot.register_command(klass) if boot
-    end
-
-    private
-
-    # Helper method to handle single- or multi-repo setup options
-    #
-    # @api private
-    def setup_config(*args)
-      args.first.is_a?(Hash) ? args.first : { default: args }
-    end
-
-    # Build gateways using the setup interface
-    #
-    # @api private
-    def setup_gateways(config)
-      config.each_with_object({}) do |(name, spec), hash|
-        identifier, *args = Array(spec)
-        gateway = Gateway.setup(identifier, *(args.flatten))
-        hash[name] = gateway
-
-        gateways[gateway] = identifier unless identifier.is_a?(Gateway)
-      end
-    end
   end
 end

data/lib/rom/mapper_registry.rb

@@ -1,3 +1,5 @@
+require 'rom/support/registry'
+
 module ROM
   # @private
   class MapperRegistry < Registry

data/lib/rom/pipeline.rb

@@ -1,3 +1,5 @@
+require 'equalizer'
+
 module ROM
   # Data pipeline common interface
   #

data/lib/rom/plugin.rb

@@ -1,27 +1,13 @@
+require 'rom/plugin_base'
+
 module ROM
   # Plugin is a simple object used to store plugin configurations
   #
   # @private
-  class Plugin
-    # @return [Module] a module representing the plugin
-    #
-    # @api private
-    attr_reader :mod
-
-    # @return [Hash] configuration options
-    #
-    # @api private
-    attr_reader :options
-
-    # @api private
-    def initialize(mod, options)
-      @mod      = mod
-      @options  = options
-    end
-
+  class Plugin < PluginBase
     # Apply this plugin to the provided class
     #
-    # @param klass [Class]
+    # @param [Class] klass
     #
     # @api private
     def apply_to(klass)

data/lib/rom/plugin_base.rb

@@ -0,0 +1,31 @@
+module ROM
+  # Abstract plugin base
+  #
+  # @private
+  class PluginBase
+    # @return [Module] a module representing the plugin
+    #
+    # @api private
+    attr_reader :mod
+
+    # @return [Hash] configuration options
+    #
+    # @api private
+    attr_reader :options
+
+    # @api private
+    def initialize(mod, options)
+      @mod      = mod
+      @options  = options
+    end
+
+    # Apply this plugin to the provided class
+    #
+    # @param [Mixed] base
+    #
+    # @api private
+    def apply_to(base)
+      raise NotImplementedError, "#{self.class}#apply_to not implemented"
+    end
+  end
+end

data/lib/rom/plugin_registry.rb

@@ -5,6 +5,12 @@ module ROM
   #
   # @api private
   class PluginRegistry
+    # Internal registry for environment plugins
+    #
+    # @return [EnvironmentPluginRegistry]
+    #
+    # @api private
+    attr_reader :environment
     # Internal registry for command plugins
     #
     # @return [InternalPluginRegistry]
@@ -28,6 +34,7 @@ module ROM
 
     # @api private
     def initialize
+      @environment = EnvironmentPluginRegistry.new
       @mappers = InternalPluginRegistry.new
       @commands = InternalPluginRegistry.new
       @relations = InternalPluginRegistry.new
@@ -46,7 +53,7 @@ module ROM
       type    = options.fetch(:type)
       adapter = options.fetch(:adapter, :default)
 
-      plugins_for(type, adapter)[name] = Plugin.new(mod, options)
+      plugins_for(type, adapter).register(name, mod, options)
     end
 
     private
@@ -56,27 +63,17 @@ module ROM
     # @api private
     def plugins_for(type, adapter)
       case type
-      when :command   then commands.adapter(adapter)
-      when :mapper    then mappers.adapter(adapter)
-      when :relation  then relations.adapter(adapter)
+      when :environment then environment
+      when :command     then commands.adapter(adapter)
+      when :mapper      then mappers.adapter(adapter)
+      when :relation    then relations.adapter(adapter)
       end
     end
   end
-
-  # A registry storing specific plugins
+  # Abstract registry defining common behaviour
   #
   # @api private
-  class AdapterPluginRegistry < Registry
-    # Assign a plugin to this adapter registry
-    #
-    # @param [Symbol] name The registered plugin name
-    # @param [Plugin] plugin The plugin to register
-    #
-    # @api private
-    def []=(name, plugin)
-      elements[name] = plugin
-    end
-
+  class PluginRegistryBase < Registry
     # Retrieve a registered plugin
     #
     # @param [Symbol] name The plugin to retrieve
@@ -88,6 +85,46 @@ module ROM
       elements[name]
     end
   end
+  # A registry storing environment specific plugins
+  #
+  # @api private
+  class EnvironmentPluginRegistry < PluginRegistryBase
+    # Assign a plugin to this environment registry
+    #
+    # @param [Symbol] name The registered plugin name
+    # @param [Module] mod The plugin to register
+    # @param [Hash] options optional configuration data
+    #
+    # @api private
+    def register(name, mod, options)
+      elements[name] = EnvironmentPlugin.new(mod, options)
+    end
+    # Return an environment plugin
+    #
+    # @param [Symbol] name The name of the environment plugin
+    #
+    # @raises [UnknownPluginError] if no plugin is found with the given name
+    #
+    # @api public
+    def fetch(name)
+      self[name] || raise(UnknownPluginError, name)
+    end
+  end
+  # A registry storing adapter specific plugins
+  #
+  # @api private
+  class AdapterPluginRegistry < PluginRegistryBase
+    # Assign a plugin to this adapter registry
+    #
+    # @param [Symbol] name The registered plugin name
+    # @param [Module] mod The plugin to register
+    # @param [Hash] options optional configuration data
+    #
+    # @api private
+    def register(name, mod, options)
+      elements[name] = Plugin.new(mod, options)
+    end
+  end
 
   # Store a set of registries grouped by adapter
   #

data/lib/rom/relation.rb

@@ -1,7 +1,14 @@
+require 'rom/support/deprecations'
 require 'rom/relation/class_interface'
 
-require 'rom/relation/lazy'
+require 'rom/pipeline'
+require 'rom/mapper_registry'
+
+require 'rom/relation/loaded'
 require 'rom/relation/curried'
+require 'rom/relation/composite'
+require 'rom/relation/graph'
+require 'rom/relation/materializable'
 
 module ROM
   # Base relation class
@@ -12,17 +19,23 @@ module ROM
   # however, is considered private and should not be used outside of the
   # relation instance.
   #
-  # ROM builds sub-classes of this class for every relation defined in the env
-  # for easy inspection and extensibility - every gateway can provide extensions
-  # for those sub-classes but there is always a vanilla relation instance stored
-  # in the schema registry.
+  # ROM builds sub-classes of this class for every relation defined in the 
+  # environment for easy inspection and extensibility - every gateway can
+  # provide extensions for those sub-classes but there is always a vanilla
+  # relation instance stored in the schema registry.
   #
   # @api public
   class Relation
+    extend Deprecations
     extend ClassInterface
+    extend ROM::Support::GuardedInheritanceHook
 
     include Options
     include Equalizer.new(:dataset)
+    include Materializable
+    include Pipeline
+
+    option :mappers, reader: true, default: proc { MapperRegistry.new }
 
     # Dataset used by the relation
     #
@@ -49,6 +62,26 @@ module ROM
       dataset.each { |tuple| yield(tuple) }
     end
 
+    # Eager load other relation(s) for this relation
+    #
+    # @param [Array<Relation>] others The other relation(s) to eager load
+    #
+    # @return [Relation::Graph]
+    #
+    # @api public
+    def combine(*others)
+      Graph.build(self, others)
+    end
+
+    # Load relation
+    #
+    # @return [Relation::Loaded]
+    #
+    # @api public
+    def call
+      Loaded.new(self)
+    end
+
     # Materialize a relation into an array
     #
     # @return [Array<Hash>]
@@ -58,15 +91,25 @@ module ROM
       to_enum.to_a
     end
 
-    # Turn relation into a lazy-loadable and composable relation
+    # Return if this relation is curried
     #
-    # @see Lazy
-    #
-    # @return [Lazy]
+    # @return [false]
     #
+    # @api private
+    def curried?
+      false
+    end
+
+    # @api private
+    def with(options)
+      __new__(dataset, options)
+    end
+    deprecate :to_lazy, :with, "to_lazy is no longer needed"
+
     # @api public
-    def to_lazy(*args)
-      Lazy.new(self, *args)
+    def relation
+      Deprecations.announce("#relation", 'all relations are now lazy')
+      self
     end
 
     private