rom 2.0.2 → 3.0.0.beta1

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

@@ -23,7 +23,7 @@ module ROM
   MissingAdapterIdentifierError = Class.new(StandardError)
 
   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
@@ -98,7 +97,6 @@ module ROM
   #
   # @api public
   class Container
-    include ROM::Support::Publisher
     include Dry::Equalizer(:gateways, :relations, :mappers, :commands)
 
     # @return [Hash] configured gateways

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,9 +1,13 @@
+require 'dry/core/class_attributes'
+
+require 'rom/transaction'
+
 module ROM
   # Abstract gateway class
   #
   # @api public
   class Gateway
-    extend ClassMacros
+    extend Dry::Core::ClassAttributes
 
     defines :adapter
 
@@ -88,11 +92,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
@@ -150,5 +150,22 @@ 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
+
+    # @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

data/lib/rom/memory/dataset.rb

@@ -1,5 +1,4 @@
-require 'rom/support/options' # FIXME: this shouldn't be required, fix needed in rom-support
-require 'rom/support/array_dataset'
+require 'rom/array_dataset'
 
 module ROM
   module Memory

data/lib/rom/memory/relation.rb

@@ -1,4 +1,5 @@
 require 'rom/memory/types'
+require 'rom/memory/schema'
 
 module ROM
   module Memory
@@ -14,8 +15,20 @@ module ROM
       include Memory
 
       adapter :memory
+      schema_class Memory::Schema
 
-      forward :take, :join, :project, :restrict, :order
+      forward :take, :join, :restrict, :order
+
+      # Project a relation with provided attribute names
+      #
+      # @param [*Array] names A list with attribute names
+      #
+      # @return [Memory::Relation]
+      #
+      # @api public
+      def project(*names)
+        schema.project(*names).(self)
+      end
 
       # Insert tuples into the relation
       #

data/lib/rom/memory/schema.rb

@@ -0,0 +1,13 @@
+require 'rom/schema'
+
+module ROM
+  module Memory
+    class Schema < ROM::Schema
+      # @see Schema#call
+      # @api public
+      def call(relation)
+        relation.new(relation.dataset.project(*map(&:name)), schema: self)
+      end
+    end
+  end
+end

data/lib/rom/plugin_registry.rb

@@ -1,4 +1,4 @@
-require 'rom/support/registry'
+require 'rom/registry'
 
 module ROM
   # Stores all registered plugins

data/lib/rom/plugins/configuration/configuration_dsl.rb

@@ -1,5 +1,5 @@
 require 'rom/configuration_dsl'
-require 'rom/support/deprecations'
+require 'dry/core/deprecations'
 
 module ROM
   module ConfigurationPlugins
@@ -10,7 +10,11 @@ module ROM
 
       # @api private
       def self.apply(configuration, options = {})
-        ROM::Deprecations.announce(:macros, "Calling `use(:macros)` is no longer necessary. Macros are enabled by default.")
+        Dry::Core::Deprecations.announce(
+          :macros,
+          "Calling `use(:macros)` is no longer necessary. Macros are enabled by default.",
+          tag: :rom
+        )
       end
     end
   end

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

@@ -1,3 +1,5 @@
+require 'dry/core/inflector'
+
 module ROM
   module Plugins
     module Relation
@@ -11,7 +13,7 @@ module ROM
         # @api private
         def foreign_key(other = nil)
           if other
-            if schema
+            if schema?
               rel_name = other.respond_to?(:to_sym) ?
                 ROM::Relation::Name[other.to_sym] : other.base_name
 
@@ -24,7 +26,7 @@ module ROM
               relation.foreign_key
             end
           else
-            :"#{Inflector.singularize(name.dataset)}_id"
+            :"#{Dry::Core::Inflector.singularize(name.dataset)}_id"
           end
         end
 

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

@@ -12,7 +12,11 @@ module ROM
         # @api private
         def self.included(klass)
           super
-          klass.option :__registry__, type: RelationRegistry, default: EMPTY_REGISTRY, reader: true
+          return if klass.instance_methods.include?(:__registry__)
+          klass.option :__registry__,
+                       default: proc { EMPTY_REGISTRY },
+                       reader: true,
+                       optional: true
         end
 
         # @api private

data/lib/rom/registry.rb

@@ -0,0 +1,50 @@
+module ROM
+  # @api private
+  class Registry
+    include Enumerable
+    include Dry::Equalizer(:elements)
+
+    class ElementNotFoundError < KeyError
+      def initialize(key, name)
+        super("#{key.inspect} doesn't exist in #{name} registry")
+      end
+    end
+
+    attr_reader :elements, :name
+
+    def initialize(elements = {}, name = self.class.name)
+      @elements = elements
+      @name = name
+    end
+
+    def each(&block)
+      return to_enum unless block
+      elements.each { |element| yield(element) }
+    end
+
+    def key?(name)
+      !name.nil? && elements.key?(name.to_sym)
+    end
+
+    def fetch(key)
+      raise ArgumentError.new('key cannot be nil') if key.nil?
+
+      elements.fetch(key.to_sym) do
+        return yield if block_given?
+
+        raise ElementNotFoundError.new(key, name)
+      end
+    end
+    alias_method :[], :fetch
+
+    def respond_to_missing?(name, include_private = false)
+      elements.key?(name) || super
+    end
+
+    private
+
+    def method_missing(name, *)
+      elements.fetch(name) { super }
+    end
+  end
+end