rom 2.0.2 → 3.0.0

data/lib/rom/commands/graph.rb

@@ -1,5 +1,5 @@
+require 'rom/initializer'
 require 'rom/pipeline'
-require 'rom/support/options'
 require 'rom/commands/graph/class_interface'
 
 module ROM
@@ -8,35 +8,27 @@ module ROM
     #
     # @api private
     class Graph
+      extend Initializer
       include Dry::Equalizer(:root, :nodes)
 
       extend ClassInterface
 
-      include Options
       include Pipeline
       include Pipeline::Proxy
 
       # @attr_reader [Command] root The root command
-      attr_reader :root
+      param :root
 
       # @attr_reader [Array<Command>] nodes The child commands
-      attr_reader :nodes
-
-      # @attr_reader [Symbol] root's relation name
-      attr_reader :name
+      param :nodes
 
       alias_method :left, :root
       alias_method :right, :nodes
 
-      option :mappers, reader: true, default: proc { MapperRegistry.new }
+      # @attr_reader [Symbol] root's relation name
+      option :name, reader: true, default: -> g { g.root.name }
 
-      # @api private
-      def initialize(root, nodes, options = EMPTY_HASH)
-        super
-        @root = root
-        @nodes = nodes
-        @name = root.name
-      end
+      option :mappers, reader: true, default: proc { MapperRegistry.new }
 
       # Calls root and all nodes with the result from root
       #

data/lib/rom/commands/lazy/update.rb

@@ -20,7 +20,7 @@ module ROM
 
             if input.is_a?(Array)
               input.map.with_index do |item, index|
-                command_proc[command, last, item].call(item, *args[1..size-1])
+                command_proc[command, last, item].call(item,  *args[1..size-1])
               end
             else
               command_proc[command, *(size > 1 ? [last, input] : [input])]

data/lib/rom/configuration.rb

@@ -1,3 +1,5 @@
+require 'forwardable'
+
 require 'rom/environment'
 require 'rom/setup'
 require 'rom/configuration_dsl'

data/lib/rom/configuration_dsl/command.rb

@@ -1,7 +1,5 @@
-require 'rom/support/constants'
-
-require 'rom/support/inflector'
-require 'rom/support/class_builder'
+require 'dry/core/inflector'
+require 'dry/core/class_builder'
 
 module ROM
   module ConfigurationDSL
@@ -16,12 +14,12 @@ module ROM
       # @api private
       def self.build_class(name, relation, options = EMPTY_HASH, &block)
         type = options.fetch(:type) { name }
-        command_type = Inflector.classify(type)
+        command_type = Dry::Core::Inflector.classify(type)
         adapter = options.fetch(:adapter)
         parent = ROM::Command.adapter_namespace(adapter).const_get(command_type)
         class_name = generate_class_name(adapter, command_type, relation)
 
-        ClassBuilder.new(name: class_name, parent: parent).call do |klass|
+        Dry::Core::ClassBuilder.new(name: class_name, parent: parent).call do |klass|
           klass.register_as(name)
           klass.relation(relation)
           klass.class_eval(&block) if block
@@ -33,9 +31,9 @@ module ROM
       # @api private
       def self.generate_class_name(adapter, command_type, relation)
         pieces = ['ROM']
-        pieces << Inflector.classify(adapter)
+        pieces << Dry::Core::Inflector.classify(adapter)
         pieces << 'Commands'
-        pieces << "#{command_type}[#{Inflector.classify(relation)}s]"
+        pieces << "#{command_type}[#{Dry::Core::Inflector.classify(relation)}s]"
         pieces.join('::')
       end
     end

data/lib/rom/configuration_dsl/mapper.rb

@@ -1,5 +1,4 @@
-require 'rom/support/constants'
-require 'rom/support/class_builder'
+require 'dry/core/class_builder'
 
 module ROM
   module ConfigurationDSL
@@ -25,7 +24,7 @@ module ROM
             ROM::Mapper
           end
 
-        ClassBuilder.new(name: class_name, parent: parent_class).call do |klass|
+        Dry::Core::ClassBuilder.new(name: class_name, parent: parent_class).call do |klass|
           klass.relation(name)
           klass.inherit_header(inherit_header)
 

data/lib/rom/configuration_dsl/mapper_dsl.rb

@@ -1,4 +1,3 @@
-require 'rom/support/constants'
 require 'rom/configuration_dsl/mapper'
 
 module ROM

data/lib/rom/configuration_dsl/relation.rb

@@ -1,5 +1,5 @@
-require 'rom/support/constants'
-require 'rom/support/class_builder'
+require 'dry/core/class_builder'
+require 'dry/core/inflector'
 
 module ROM
   module ConfigurationDSL
@@ -13,10 +13,10 @@ module ROM
       #
       # @api private
       def self.build_class(name, options = EMPTY_HASH)
-        class_name = "ROM::Relation[#{Inflector.camelize(name)}]"
+        class_name = "ROM::Relation[#{Dry::Core::Inflector.camelize(name)}]"
         adapter = options.fetch(:adapter)
 
-        ClassBuilder.new(name: class_name, parent: ROM::Relation[adapter]).call do |klass|
+        Dry::Core::ClassBuilder.new(name: class_name, parent: ROM::Relation[adapter]).call do |klass|
           klass.gateway(options.fetch(:gateway, :default))
           klass.dataset(name)
         end

data/lib/rom/configuration_dsl.rb

@@ -1,5 +1,3 @@
-require 'rom/support/constants'
-
 require 'rom/configuration_dsl/relation'
 require 'rom/configuration_dsl/mapper_dsl'
 require 'rom/configuration_dsl/command_dsl'
@@ -55,13 +53,11 @@ module ROM
     #   setup.commands(:users) do
     #     define(:create) do
     #       input NewUserParams
-    #       validator NewUserValidator
     #       result :one
     #     end
     #
     #     define(:update) do
     #       input UserParams
-    #       validator UserValidator
     #       result :many
     #     end
     #

data/lib/rom/constants.rb

@@ -22,8 +22,14 @@ module ROM
   UnsupportedRelationError = Class.new(StandardError)
   MissingAdapterIdentifierError = Class.new(StandardError)
 
+  MissingSchemaClassError = Class.new(StandardError) do
+    def initialize(klass)
+      super("#{klass.inspect} relation is missing schema_class")
+    end
+  end
+
   DuplicateConfigurationError = Class.new(StandardError)
-  DuplicateContainerError = Class.new(StandardError)  
+  DuplicateContainerError = Class.new(StandardError)
 
   InvalidOptionValueError = Class.new(StandardError)
   InvalidOptionKeyError = Class.new(StandardError)

data/lib/rom/container.rb

@@ -1,7 +1,6 @@
 require 'rom/relation/loaded'
 require 'rom/commands/graph'
 require 'rom/commands/graph/builder'
-require 'rom/support/publisher'
 
 module ROM
   # ROM container is an isolated environment with no global state where all
@@ -12,14 +11,14 @@ module ROM
   #
   # There are 3 types of container setup:
   #
-  # * in-line setup - a simple block-based configuration which allows configuring
+  # * Setup DSL - a simple block-based configuration which allows configuring
   #   all components and gives you back a container instance. This type is suitable
   #   for small scripts, or in some cases rake tasks
-  # * multi-step setup - this type requires creating a configuration object,
+  # * Explicit setup - this type requires creating a configuration object,
   #   registering component classes (ie relation classes) and passing the config
   #   to container builder function. This type is suitable when your environment
   #   is not typical and you need full control over component registration
-  # * multi-step setup with auto-registration - same as multi-step but allows
+  # * Explicit setup with auto-registration - same as explicit setup but allows
   #   you to configure auto-registration mechanism which will register component
   #   classes for you, based on dir/file naming conventions. This is the most
   #   common type of setup that's used by framework integrations
@@ -98,27 +97,22 @@ module ROM
   #
   # @api public
   class Container
-    include ROM::Support::Publisher
     include Dry::Equalizer(:gateways, :relations, :mappers, :commands)
 
-    # @return [Hash] configured gateways
-    #
-    # @api public
+    # @!attribute [r] gateways
+    #   @return [Hash] A hash with configured gateways
     attr_reader :gateways
 
-    # @return [RelationRegistry] relation registry
-    #
-    # @api public
+    # @!attribute [r] relations
+    #   @return [RelationRegistry] The relation registry
     attr_reader :relations
 
-    # @return [Registry] command registry
-    #
-    # @api public
+    # @!attribute [r] gateways
+    #   @return [CommandRegistry] The command registry
     attr_reader :commands
 
-    # @return [Registry] mapper registry
-    #
-    # @api public
+    # @!attribute [r] mappers
+    #   @return [Hash] A hash with configured custom mappers
     attr_reader :mappers
 
     # @api private

data/lib/rom/create_container.rb

@@ -5,8 +5,6 @@ require 'rom/setup/finalize'
 
 module ROM
   class CreateContainer
-    include ROM::Support::Publisher
-
     attr_reader :container
 
     def initialize(environment, setup)

data/lib/rom/data_proxy.rb

@@ -0,0 +1,94 @@
+module ROM
+  # Helper module for dataset classes
+  #
+  # It provides a constructor accepting data, header and an optional row_proc.
+  # This module is used internally by EnumerableDataset and ArrayDataset.
+  #
+  # @private
+  module DataProxy
+    NON_FORWARDABLE = [
+      :each, :to_a, :to_ary, :kind_of?, :instance_of?, :is_a?
+    ].freeze
+
+    # Wrapped data array
+    #
+    # @return [Object] Data object for the iterator
+    #
+    # @api private
+    attr_reader :data
+
+    # @return [Proc] tuple processing proc
+    #
+    # @api private
+    attr_reader :row_proc
+
+    # Extends the class with `forward` DSL and Equalizer using `data` attribute
+    #
+    # @see ClassMethods#forward
+    #
+    # @api private
+    def self.included(klass)
+      klass.class_eval do
+        extend ClassMethods
+
+        include Dry::Equalizer(:data)
+
+        option :row_proc, reader: true, default: proc { |obj| obj.class.row_proc }
+      end
+    end
+
+    # Iterate over data using row_proc
+    #
+    # @return [Enumerator] if block is not given
+    #
+    # @api private
+    def each
+      return to_enum unless block_given?
+      data.each { |tuple| yield(row_proc[tuple]) }
+    end
+
+    module ClassMethods
+      # Default no-op tuple proc
+      #
+      # @return [Proc]
+      #
+      # @api private
+      def row_proc
+        -> tuple { tuple }
+      end
+
+      # Forward provided methods to the underlaying data object
+      #
+      # @example
+      #
+      #   class MyDataset
+      #     include DataProxy
+      #
+      #     forward(:find_all, :map)
+      #   end
+      #
+      # @return [undefined]
+      #
+      # @api public
+      def forward(*methods)
+        # FIXME: we should probably raise if one of the non-forwardable methods
+        #       was provided
+        (methods - NON_FORWARDABLE).each do |method_name|
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{method_name}(*args, &block)
+              response = data.public_send(#{method_name.inspect}, *args, &block)
+
+              if response.equal?(data)
+                self
+              elsif response.is_a?(data.class)
+                self.class.new(response)
+              else
+                response
+              end
+            end
+          RUBY
+        end
+      end
+    end
+  end
+end

data/lib/rom/enumerable_dataset.rb

@@ -0,0 +1,68 @@
+require 'rom/initializer'
+require 'rom/data_proxy'
+
+module ROM
+  # A helper module that adds data-proxy behavior to an enumerable object
+  #
+  # This module is intended to be used by gateways
+  #
+  # Class that includes this module can define `row_proc` class method which
+  # must return a proc-like object which will be used to process each element
+  # in the enumerable
+  #
+  # @example
+  #   class MyDataset
+  #     include ROM::EnumerableDataset
+  #
+  #     def self.row_proc
+  #       -> tuple { tuple.each_with_object({}) { |(k,v), h| h[k.to_sym] = v } }
+  #     end
+  #   end
+  #
+  #   ds = MyDataset.new([{ 'name' => 'Jane' }, [:name])
+  #   ds.to_a # => { :name => 'Jane' }
+  #
+  # @api public
+  module EnumerableDataset
+    extend DataProxy::ClassMethods
+    include Enumerable
+
+    # Coerce a dataset to an array
+    #
+    # @return [Array]
+    #
+    # @api public
+    alias_method :to_ary, :to_a
+
+    # Included hook which extends a class with DataProxy behavior
+    #
+    # This module can also be included into other modules so we apply the
+    # extension only for classes
+    #
+    # @api private
+    def self.included(klass)
+      return unless klass.is_a?(Class)
+
+      klass.class_eval do
+        extend Initializer
+        include DataProxy
+
+        param :data
+      end
+    end
+
+    forward :take
+
+    [
+      :chunk, :collect, :collect_concat, :drop_while, :find_all, :flat_map,
+      :grep, :map, :reject, :select, :sort, :sort_by, :take_while
+    ].each do |method|
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{method}(*args, &block)
+          return to_enum unless block
+          self.class.new(super(*args, &block), options)
+        end
+      RUBY
+    end
+  end
+end

data/lib/rom/gateway.rb

@@ -1,49 +1,65 @@
+require 'dry/core/class_attributes'
+
+require 'rom/transaction'
+
 module ROM
   # Abstract gateway class
   #
+  # Every adapter needs to inherit from this class and implement
+  # required interface
+  #
+  # @abstract
+  #
   # @api public
   class Gateway
-    extend ClassMacros
+    extend Dry::Core::ClassAttributes
 
     defines :adapter
 
-    # Return connection object
-    #
-    # @return [Object] type varies depending on the gateway
-    #
-    # @api public
+    # @!attribute [r] connection
+    #   @return [Object] The gateway's connection object (type varies across adapters)
     attr_reader :connection
 
-    # Setup a gateway
+    # Set up a gateway
     #
     # @overload setup(type, *args)
     #   Sets up a single-gateway given a gateway type.
     #   For custom gateways, create an instance and pass it directly.
     #
-    #   @param [Symbol] type
-    #   @param [Array] *args
+    #   @example
+    #     module SuperDB
+    #       class Gateway < ROM::Gateway
+    #         def initialize(options)
+    #         end
+    #       end
+    #     end
     #
-    # @overload setup(gateway)
-    #   @param [Gateway] gateway
+    #     ROM.register_adapter(:super_db, SuperDB)
     #
-    # @return [Gateway] a specific gateway subclass
+    #     Gateway.setup(:super_db, some: 'options')
+    #     # SuperDB::Gateway.new(some: 'options') is called
+    #
+    #   @param [Symbol] type Registered gateway identifier
+    #   @param [Array] args Additional gateway options
     #
-    # @example
-    #   module SuperDB
-    #     class Gateway < ROM::Gateway
-    #       def initialize(options)
+    # @overload setup(gateway)
+    #   Set up a gateway instance
+    #
+    #   @example
+    #     module SuperDB
+    #       class Gateway < ROM::Gateway
+    #         def initialize(options)
+    #         end
     #       end
     #     end
-    #   end
     #
-    #   ROM.register_adapter(:super_db, SuperDB)
+    #     ROM.register_adapter(:super_db, SuperDB)
     #
-    #   Gateway.setup(:super_db, some: 'options')
-    #   # SuperDB::Gateway.new(some: 'options') is called
+    #     Gateway.setup(SuperDB::Gateway.new(some: 'options'))
+    #
+    #   @param [Gateway] gateway
     #
-    #   # or alternatively
-    #   super_db = Gateway.setup(SuperDB::Gateway.new(some: 'options'))
-    #   Gateway.setup(super_db)
+    # @return [Gateway] a specific gateway subclass
     #
     # @api public
     def self.setup(gateway_or_scheme, *args)
@@ -72,7 +88,7 @@ module ROM
 
     # Get gateway subclass for a specific adapter
     #
-    # @param [Symbol] type adapter identifier
+    # @param [Symbol] type Adapter identifier
     #
     # @return [Class]
     #
@@ -88,11 +104,7 @@ module ROM
         ROM.adapters.fetch(type)
       }
 
-      if adapter.const_defined?(:Gateway)
-        adapter.const_get(:Gateway)
-      else
-        adapter.const_get(:Repository)
-      end
+      adapter.const_get(:Gateway)
     end
 
     # Returns the adapter, defined for the class
@@ -109,6 +121,10 @@ module ROM
 
     # A generic interface for setting up a logger
     #
+    # This is not a required interface, it's a no-op by default
+    #
+    # @abstract
+    #
     # @api public
     def use_logger(*)
       # noop
@@ -116,6 +132,11 @@ module ROM
 
     # A generic interface for returning default logger
     #
+    # Adapters should implement this method as handling loggers is different
+    # across adapters. This is a no-op by default and returns nil.
+    #
+    # @return [NilClass]
+    #
     # @api public
     def logger
       # noop
@@ -123,8 +144,10 @@ module ROM
 
     # Extension hook for adding gateway-specific behavior to a command class
     #
-    # @param [Class] klass command class
-    # @param [Object] _dataset dataset that will be used with this command class
+    # This simply returns back the class by default
+    #
+    # @param [Class] klass The command class
+    # @param [Object] _dataset The dataset that will be used with this command class
     #
     # @return [Class]
     #
@@ -137,7 +160,7 @@ module ROM
     #
     # Every gateway that supports schema inference should implement this method
     #
-    # @return [Array] array with datasets and their names
+    # @return [Array] An array with dataset names
     #
     # @api private
     def schema
@@ -150,5 +173,24 @@ module ROM
     def disconnect
       # noop
     end
+
+    # Runs a block inside a transaction. The underlying transaction engine
+    # is adapter-specific
+    #
+    # @param [Hash] Transaction options
+    # @return The result of yielding the block or +nil+ if
+    #         the transaction was rolled back
+    #
+    # @api public
+    def transaction(opts = EMPTY_HASH, &block)
+      transaction_runner(opts).run(opts, &block)
+    end
+
+    private
+
+    # @api private
+    def transaction_runner(_)
+      Transaction::NoOp
+    end
   end
 end

data/lib/rom/global/plugin_dsl.rb

@@ -1,5 +1,3 @@
-require 'rom/support/constants'
-
 module ROM
   module Global
     # plugin registration DSL

data/lib/rom/global.rb

@@ -1,7 +1,5 @@
-# -*- coding: utf-8 -*-
 require 'rom/plugin_registry'
 require 'rom/global/plugin_dsl'
-require 'rom/support/deprecations'
 
 module ROM
   # Globally accessible public interface exposed via ROM module

data/lib/rom/initializer.rb

@@ -0,0 +1,26 @@
+require 'dry-initializer'
+
+module ROM
+
+  # @api private
+  module Initializer
+
+    # @api private
+    def self.extended(base)
+      base.extend(Dry::Initializer::Mixin)
+      base.include(InstanceMethods)
+    end
+
+    # @api private
+    module InstanceMethods
+      # Instance options
+      #
+      # @return [Hash]
+      #
+      # @api public
+      def options
+        @__options__
+      end
+    end
+  end
+end

data/lib/rom/lint/gateway.rb

@@ -69,6 +69,23 @@ module ROM
         complain "#{gateway_instance} must respond to dataset?"
       end
 
+      # Lint: Ensure +gateway_instance+ supports +transaction+ interface
+      #
+      # @api public
+      def lint_transaction_support
+        result = gateway_instance.transaction { 1 }
+
+        if result != 1
+          complain "#{gateway_instance} must return the result of a transaction block"
+        end
+
+        gateway_instance.transaction do |t|
+          t.rollback!
+
+          complain "#{gateway_instance} must interrupt a transaction on rollback"
+        end
+      end
+
       private
 
       # Setup gateway instance

data/lib/rom/mapper_registry.rb

@@ -1,4 +1,4 @@
-require 'rom/support/registry'
+require 'rom/registry'
 
 module ROM
   # @private

data/lib/rom/memory/commands.rb

@@ -17,7 +17,6 @@ module ROM
         def execute(tuples)
           Array([tuples]).flatten.map { |tuple|
             attributes = input[tuple]
-            validator.call(attributes)
             relation.insert(attributes.to_h)
             attributes
           }.to_a
@@ -34,7 +33,6 @@ module ROM
         # @see ROM::Commands::Update#execute
         def execute(params)
           attributes = input[params]
-          validator.call(attributes)
           relation.map { |tuple| tuple.update(attributes.to_h) }
         end
       end