rom 0.5.0 → 0.6.0.beta1

data/lib/rom/relation/loaded.rb

@@ -0,0 +1,75 @@
+module ROM
+  class Relation
+    # Materializes a relation and exposes interface to access the data
+    #
+    # @api public
+    class Loaded
+      include Enumerable
+
+      # Source relation
+      #
+      # @return [Relation]
+      #
+      # @api private
+      attr_reader :source
+
+      # Materialized relation
+      #
+      # @return [Object]
+      #
+      # @api private
+      attr_reader :collection
+
+      # @api private
+      def initialize(source, collection = source.to_a)
+        @source = source
+        @collection = collection
+      end
+
+      # Yield relation tuples
+      #
+      # @yield [Hash]
+      #
+      # @api public
+      def each(&block)
+        return to_enum unless block
+        collection.each { |object| yield(object) }
+      end
+
+      # @api public
+      def new(collection)
+        self.class.new(source, collection)
+      end
+
+      # Returns a single tuple from the relation if there is one.
+      #
+      # @raise [ROM::TupleCountMismatchError] if the relation contains more than
+      #   one tuple
+      #
+      # @api public
+      def one
+        if collection.count > 1
+          raise(
+            TupleCountMismatchError,
+            'The relation consists of more than one tuple'
+          )
+        else
+          collection.first
+        end
+      end
+
+      # Like [one], but additionally raises an error if the relation is empty.
+      #
+      # @raise [ROM::TupleCountMismatchError] if the relation does not contain
+      #   exactly one tuple
+      #
+      # @api public
+      def one!
+        one || raise(
+          TupleCountMismatchError,
+          'The relation does not contain any tuples'
+        )
+      end
+    end
+  end
+end

data/lib/rom/relation/registry_reader.rb

@@ -0,0 +1,23 @@
+module ROM
+  class Relation
+    module RegistryReader
+      # @api private
+      def self.included(klass)
+        super
+        klass.option :__registry__, type: Hash, default: {}, reader: true
+      end
+
+      # @api private
+      def respond_to_missing?(name, _include_private = false)
+        __registry__.key?(name) || super
+      end
+
+      private
+
+      # @api private
+      def method_missing(name, *)
+        __registry__.fetch(name) { super }
+      end
+    end
+  end
+end

data/lib/rom/repository.rb

@@ -1,66 +1,125 @@
 module ROM
-  # Repository exposes native database connection and schema when it's
-  # supported by the adapter
+  # Abstract repository class
   #
   # @api public
   class Repository
-    include Concord::Public.new(:adapter)
+    # Return connection object
+    #
+    # @return [Object] type varies depending on the repository
+    #
+    # @api public
+    attr_reader :connection
 
-    # Return the dataset identified by name
+    # Setup a repository
+    #
+    # @overload setup(type, *args)
+    #   Sets up a single-repository given a repository type.
+    #   For custom repositories, create an instance and pass it directly.
+    #
+    #   @param [Symbol] type
+    #   @param [Array] *args
+    #
+    # @overload setup(repository)
+    #   @param [Repository] repository
+    #
+    # @return [Repository] a specific repository subclass
+    #
+    # @example
+    #   module SuperDB
+    #     class Repository < ROM::Repository
+    #       def initialize(options)
+    #       end
+    #     end
+    #   end
+    #
+    #   ROM.register_adapter(:super_db, SuperDB)
     #
-    # @param [String,Symbol] name
+    #   Repository.setup(:super_db, some: 'options')
+    #   # SuperDB::Repository.new(some: 'options') is called
+    #
+    #   # or alternatively
+    #   super_db = Repository.setup(SuperDB::Repository.new(some: 'options'))
+    #   Repository.setup(super_db)
     #
     # @api public
-    def [](name)
-      adapter[name]
+    def self.setup(repository_or_scheme, *args)
+      case repository_or_scheme
+      when String
+        raise ArgumentError, <<-STRING.gsub(/^ {10}/, '')
+          URIs without an explicit scheme are not supported anymore.
+          See https://github.com/rom-rb/rom/blob/master/CHANGELOG.md
+        STRING
+      when Symbol
+        class_from_symbol(repository_or_scheme).new(*args)
+      else
+        if args.empty?
+          repository_or_scheme
+        else
+          raise ArgumentError, "Can't accept arguments when passing an instance"
+        end
+      end
     end
 
-    # Set a logger for the adapter
+    # Get repository subclass for a specific adapter
     #
-    # @param [Object] logger
+    # @param [Symbol] type adapter identifier
     #
-    # @api public
-    def use_logger(logger)
-      adapter.logger = logger
+    # @return [Class]
+    #
+    # @api private
+    def self.class_from_symbol(type)
+      begin
+        require "rom/#{type}"
+      rescue LoadError
+        raise AdapterLoadError, "Failed to load adapter rom/#{type}"
+      end
+
+      adapter = ROM.adapters.fetch(type)
+      adapter.const_get(:Repository)
     end
 
-    # Return logger used by the adapter
+    # A generic interface for setting up a logger
     #
-    # @return [Object] logger
+    # @api public
+    def use_logger(*)
+      # noop
+    end
+
+    # A generic interface for returning default logger
     #
     # @api public
     def logger
-      adapter.logger
+      # noop
     end
 
-    # Return the database connection provided by the adapter
+    # Extension hook for adding repository-specific behavior to a command class
+    #
+    # @param [Class] klass command class
+    # @param [Object] _dataset dataset that will be used with this command class
+    #
+    # @return [Class]
     #
     # @api public
-    def connection
-      adapter.connection
+    def extend_command_class(klass, _dataset)
+      klass
     end
 
-    # Return the schema provided by the adapter
+    # Schema inference hook
+    #
+    # Every repository that supports schema inference should implement this method
+    #
+    # @return [Array] array with datasets and their names
     #
     # @api private
     def schema
-      adapter.schema
-    end
-
-    # @api private
-    def respond_to_missing?(name, include_private = false)
-      adapter.dataset?(name) || super
+      []
     end
 
-    private
-
-    # @api private
-    def method_missing(name, *args, &block)
-      if adapter.dataset?(name)
-        adapter[name]
-      else
-        super
-      end
+    # Disconnect is optional and it's a no-op by default
+    #
+    # @api public
+    def disconnect
+      # noop
     end
   end
 end

data/lib/rom/setup.rb

@@ -1,128 +1,67 @@
-require 'rom/setup/schema_dsl'
-require 'rom/setup/mapper_dsl'
-require 'rom/setup/command_dsl'
-
 require 'rom/setup/finalize'
 
 module ROM
-  # Exposes DSL for defining schema, relations, mappers and commands
+  # Exposes DSL for defining relations, mappers and commands
   #
-  # @public
+  # @api public
   class Setup
     include Equalizer.new(:repositories, :env)
 
+    # @return [Hash] configured repositories
+    #
     # @api private
-    attr_reader :repositories, :env
+    attr_reader :repositories
 
+    # @return [Symbol] default (first) adapter
+    #
     # @api private
-    def initialize(repositories)
-      @repositories = repositories
-      @schema = {}
-      @relations = {}
-      @mappers = []
-      @commands = {}
-      @adapter_relation_map = {}
-      @env = nil
-    end
+    attr_reader :default_adapter
 
-    # Schema definition DSL
+    # @return [Array] registered relation subclasses
     #
-    # @example
-    #
-    #   setup.schema do
-    #     base_relation(:users) do
-    #       repository :sqlite
-    #
-    #       attribute :id
-    #       attribute :name
-    #     end
-    #   end
-    #
-    # @api public
-    def schema(&block)
-      SchemaDSL.new(self, @schema, &block)
-    end
+    # @api private
+    attr_reader :relation_classes
 
-    # Relation definition DSL
+    # @return [Array] registered mapper subclasses
     #
-    # @example
-    #
-    #   setup.relation(:users) do
-    #     def names
-    #       project(:name)
-    #     end
-    #   end
-    #
-    # @api public
-    def relation(name, &block)
-      @relations.update(name => block)
-    end
+    # @api private
+    attr_reader :mapper_classes
 
-    # Mapper definition DSL
-    #
-    # @example
+    # @return [Array] registered command subclasses
     #
-    #   setup.mappers do
-    #     define(:users) do
-    #       model name: 'User'
-    #     end
-    #
-    #     define(:names, parent: :users) do
-    #       exclude :id
-    #     end
-    #   end
-    #
-    # @api public
-    def mappers(&block)
-      dsl = MapperDSL.new(&block)
-      @mappers.concat(dsl.mappers)
-    end
+    # @api private
+    attr_reader :command_classes
 
-    # Command definition DSL
-    #
-    # @example
+    # @return [Env] finalized env after setup phase is over
     #
-    #   setup.commands(:users) do
-    #     define(:create) do
-    #       input NewUserParams
-    #       validator NewUserValidator
-    #       result :one
-    #     end
-    #
-    #     define(:update) do
-    #       input UserParams
-    #       validator UserValidator
-    #       result :many
-    #     end
-    #
-    #     define(:delete) do
-    #       result :many
-    #     end
-    #   end
-    #
-    # @api public
-    def commands(name, &block)
-      dsl = CommandDSL.new(&block)
-      @commands.update(name => dsl.commands)
+    # @api private
+    attr_reader :env
+
+    # @api private
+    def initialize(repositories, default_adapter = nil)
+      @repositories = repositories
+      @default_adapter = default_adapter
+      @relation_classes = []
+      @mapper_classes = []
+      @command_classes = []
+      @env = nil
     end
 
     # Finalize the setup
     #
-    # @return [Env] frozen env with access to repositories, schema, relations,
+    # @return [Env] frozen env with access to repositories, relations,
     #                mappers and commands
     #
     # @api public
     def finalize
       raise EnvAlreadyFinalizedError if env
-
       finalize = Finalize.new(
-        repositories, @schema, @relations, @mappers, @commands
+        repositories, relation_classes, mapper_classes, command_classes
       )
-
       @env = finalize.run!
     end
 
-    # Returns repository identified by name
+    # Return repository identified by name
     #
     # @return [Repository]
     #
@@ -131,6 +70,27 @@ module ROM
       repositories.fetch(name)
     end
 
+    # Relation sub-classes are being registered with this method during setup
+    #
+    # @api private
+    def register_relation(klass)
+      @relation_classes << klass
+    end
+
+    # Mapper sub-classes are being registered with this method during setup
+    #
+    # @api private
+    def register_mapper(klass)
+      @mapper_classes << klass
+    end
+
+    # Command sub-classes are being registered with this method during setup
+    #
+    # @api private
+    def register_command(klass)
+      @command_classes << klass
+    end
+
     # Hook for respond_to? used internally
     #
     # @api private
@@ -146,11 +106,7 @@ module ROM
     #
     # @api private
     def method_missing(name, *)
-      if repositories.key?(name)
-        repositories.fetch(name)
-      else
-        super
-      end
+      repositories.fetch(name) { super }
     end
   end
 end