rom 0.8.1 → 0.9.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5a38d2264b1f215a3dbcccadc91a7031358ab0d
-  data.tar.gz: 69054a1fdda6257167af21e190e6574f89d192ad
+  metadata.gz: ae4a8d67f3c8c7869c5eafa16d721cc6c4ba90eb
+  data.tar.gz: d2c9c1cdcde7ade22ad695dea60bea91a05bea42
 SHA512:
-  metadata.gz: 66241774ced83118c07f10e9266e1094f6e7211f7d194983a43779deca602ca734ee2ee79461af90b190b033057cd2aad3a296fc12b1804aae0851cbbb48fc33
-  data.tar.gz: 394fdb0895e9d020540b73ff39ae7fe8cf3051294f03d6c0f17584dafba6110130dc5c5ed26324ad6fbda311000027696a127531e00ef644ddfbfb226e01c098
+  metadata.gz: d8c3ba712a476f5f326863890e3e4abc42154601501595fb44e321854610ee4fed2d047b6d4c15b56be746c322d641f48f72f1ade653fc96ae547e6370218bef
+  data.tar.gz: 728ea3d960c3f18e0e314706dd90e6f35e32aa5014755a0875ba0a1613caa29358cad2af2fe7bc2c2b55f7d7fdccc780b60d9be89b297da7a3550440dc9784b0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.9.0 to-be-released
+
+[Compare v0.8.1...HEAD](https://github.com/rom-rb/rom/compare/v0.8.1...HEAD)
+
 ## v0.8.1 2015-07-12
 
 ### Fixed

data/README.md

@@ -21,9 +21,13 @@ full power of your datastore.
 Learn more:
 
 * [Introduction](http://rom-rb.org/introduction/)
-* [Guides](http://rom-rb.org/introduction/)
+* [Guides](http://rom-rb.org/guides/)
 * [Tutorials](http://rom-rb.org/tutorials/)
 
+## Support Campaign
+
+You can support ROM's development via our [campaign on Bountysource](https://salt.bountysource.com/teams/rom-rb). Cheers!
+
 ## Adapters
 
   * [rom-sql](https://github.com/rom-rb/rom-sql)

data/lib/rom.rb

@@ -1,5 +1,6 @@
 require 'equalizer'
 
+require 'rom-support'
 require 'rom/version'
 require 'rom/constants'
 
@@ -9,35 +10,53 @@ require 'rom/support/registry'
 require 'rom/support/options'
 require 'rom/support/class_macros'
 require 'rom/support/class_builder'
+require 'rom/support/guarded_inheritance_hook'
+require 'rom/support/inheritance_hook'
 
 # core parts
+require 'rom/environment_plugin'
 require 'rom/plugin'
 require 'rom/relation'
-require 'rom/mapper'
+require 'rom-mapper'
 require 'rom/commands'
 
-# default mapper processor using Transproc gem
-require 'rom/processor/transproc'
-
-# support for global-style setup
+# rom Global
 require 'rom/global'
-require 'rom/setup'
+
+# rom environments
+require 'rom/environment'
 
 # TODO: consider to make this part optional and don't require it here
 require 'rom/setup_dsl/setup'
 
-# env with registries
-require 'rom/env'
-
-module ROM
-  extend Global
-
-  RelationRegistry = Class.new(Registry)
-end
+# container with registries
+require 'rom/container'
 
 # register core plugins
+require 'rom/environment_plugins/auto_registration'
 require 'rom/plugins/relation/registry_reader'
 
-ROM.plugins do
-  register :registry_reader, ROM::Plugins::Relation::RegistryReader, type: :relation
+module ROM
+  extend Global
+
+  @environment = ROM::Environment.new
+
+  class << self
+    def method_missing(method, *args, &block)
+      if @environment.respond_to?(method)
+        @environment.__send__(method, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method, _include_private = false)
+      @environment.respond_to?(method) || super
+    end
+  end
+
+  plugins do
+    register :auto_registration, ROM::EnvironmentPlugins::AutoRegistration, type: :environment
+    register :registry_reader, ROM::Plugins::Relation::RegistryReader, type: :relation
+  end
 end

data/lib/rom/command.rb

@@ -6,6 +6,7 @@ module ROM
   # @private
   class Command < Commands::Abstract
     extend ClassMacros
+    extend ROM::Support::GuardedInheritanceHook
 
     include Equalizer.new(:relation, :options)
 
@@ -15,15 +16,6 @@ module ROM
     validator proc {}
     result :many
 
-    # Registers Create/Update/Delete descendant classes during the setup phase
-    #
-    # @api private
-    def self.inherited(klass)
-      super
-      return if klass.superclass == ROM::Command
-      ROM.register_command(klass)
-    end
-
     # Return adapter specific sub-class based on the adapter identifier
     #
     # This is a syntax sugar to make things consistent

data/lib/rom/commands/graph/class_interface.rb

@@ -7,9 +7,9 @@ module ROM
       module ClassInterface
         # Build a command graph recursively
         #
-        # This is used by `Env#command` when array with options is passed in
+        # This is used by `Container#command` when array with options is passed in
         #
-        # @param [Registry] registry The command registry from env
+        # @param [Registry] registry The command registry from container
         # @param [Array] options The options array
         # @param [Array] path The path for input evaluator proc
         #

data/lib/rom/constants.rb

@@ -1,7 +1,5 @@
 # Constants and errors common in the whole library
 module ROM
-  Undefined = Object.new.freeze
-
   AdapterLoadError = Class.new(StandardError)
 
   class AdapterNotPresentError < StandardError
@@ -19,7 +17,6 @@ module ROM
   CommandError = Class.new(StandardError)
   TupleCountMismatchError = Class.new(CommandError)
   MapperMissingError = Class.new(StandardError)
-  MapperMisconfiguredError = Class.new(StandardError)
   UnknownPluginError = Class.new(StandardError)
   UnsupportedRelationError = Class.new(StandardError)
 
@@ -37,7 +34,4 @@ module ROM
       set_backtrace(err.backtrace)
     end
   end
-
-  EMPTY_ARRAY = [].freeze
-  EMPTY_HASH = {}.freeze
 end

data/lib/rom/{env.rb → container.rb}

@@ -6,7 +6,7 @@ module ROM
   # Exposes defined gateways, relations and mappers
   #
   # @api public
-  class Env
+  class Container
     extend Deprecations
     include Equalizer.new(:gateways, :relations, :mappers, :commands)
 
@@ -72,9 +72,9 @@ module ROM
         end
 
       if mappers.key?(name)
-        relation.to_lazy(mappers: mappers[name])
+        relation.with(mappers: mappers[name])
       else
-        relation.to_lazy
+        relation
       end
     end
     deprecate :read, :relation, "For mapping append `.map_with(:your_mapper_name)`"

data/lib/rom/environment.rb

@@ -0,0 +1,238 @@
+require 'rom/setup'
+require 'rom/repository'
+
+module ROM
+  # Globally accessible public interface exposed via ROM module
+  #
+  # @api public
+  class Environment
+    # An internal gateway => identifier map used by the setup
+    #
+    # @return [Hash]
+    #
+    # @api private
+    attr_reader :gateways
+
+    # Setup object created during setup phase
+    #
+    # This gets set to nil after setup is finalized
+    #
+    # @return [Setup]
+    #
+    # @api private
+    attr_reader :boot
+
+    # Return ROM container configured by the setup
+    #
+    # @return [Container]
+    #
+    # @api public
+    attr_reader :container
+    alias_method :env, :container
+
+    # @api private
+    def initialize
+      @gateways = {}
+    end
+
+    # @api private
+    def adapters
+      ROM.adapters
+    end
+
+    # @api private
+    def plugin_registry
+      ROM.plugin_registry
+    end
+
+    # Apply
+    #
+    # @api public
+    def use(plugin)
+      plugin_registry.environment.fetch(plugin).apply_to(self)
+    end
+
+    # 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.
+    #   rom = ROM::Environment.new
+    #   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 = ROM::Environment.new
+    #   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 container
+    #   rom.container # returns the container 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 = ROM::Environment.new
+    #   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 = ROM::Environment.new
+    #   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 = ROM::Environment.new
+    #   rom.setup(:memory)
+    #
+    #   rom.mappers do
+    #     define(:uses) do
+    #       # ..
+    #     end
+    #   end
+    #
+    # @api public
+    def mappers(*args, &block)
+      boot.mappers(*args, &block)
+    end
+
+    # Finalize the setup and store default global container under 
+    # ROM::Environmrnt#container
+    #
+    # @example
+    #   rom = ROM::Environment.new
+    #   rom.setup(:memory)
+    #   rom.finalize # => rom
+    #   rom.boot # => nil
+    #   rom.container # => the container
+    #
+    # @return [ROM]
+    #
+    # @api public
+    def finalize
+      @container = boot.finalize
+      self
+    ensure
+      @boot = nil
+    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/environment_plugin.rb

@@ -0,0 +1,17 @@
+require 'rom/plugin_base'
+
+module ROM
+  # EnvironmentPlugin is a simple object used to store environment plugin configurations
+  #
+  # @private
+  class EnvironmentPlugin < PluginBase
+    # Apply this plugin to the provided environment
+    #
+    # @param [ROM::Environment] environment
+    #
+    # @api private
+    def apply_to(environment)
+      mod.apply(environment)
+    end
+  end
+end