rom 0.4.2 → 0.5.0

data/lib/rom/relation_builder.rb

@@ -1,14 +1,16 @@
 module ROM
-
   # @api private
   class RelationBuilder
     attr_reader :schema, :mod
 
     # @api private
-    def initialize(schema)
+    def initialize(schema, relations)
       @schema = schema
-      @mod = schema.each_with_object(Module.new) do |(name, relation), m|
-        m.send(:define_method, name) { relation.dataset }
+
+      @mod = Module.new
+
+      @mod.module_exec do
+        define_method(:__relations__) { relations }
       end
     end
 
@@ -34,6 +36,20 @@ module ROM
         def name
           #{name.inspect}
         end
+
+        def respond_to_missing?(name, _include_private = false)
+          __relations__.key?(name) || super
+        end
+
+        private
+
+        def method_missing(name, *args, &block)
+          if __relations__.key?(name)
+            __relations__[name]
+          else
+            super
+          end
+        end
       RUBY
 
       klass.send(:include, mod)
@@ -42,7 +58,5 @@ module ROM
 
       klass.new(schema_relation.dataset, schema_relation.header)
     end
-
   end
-
 end

data/lib/rom/repository.rb

@@ -1,5 +1,4 @@
 module ROM
-
   # Repository exposes native database connection and schema when it's
   # supported by the adapter
   #
@@ -64,5 +63,4 @@ module ROM
       end
     end
   end
-
 end

data/lib/rom/setup.rb

@@ -0,0 +1,156 @@
+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
+  #
+  # @public
+  class Setup
+    include Equalizer.new(:repositories, :env)
+
+    # @api private
+    attr_reader :repositories, :env
+
+    # @api private
+    def initialize(repositories)
+      @repositories = repositories
+      @schema = {}
+      @relations = {}
+      @mappers = []
+      @commands = {}
+      @adapter_relation_map = {}
+      @env = nil
+    end
+
+    # Schema definition DSL
+    #
+    # @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
+
+    # Relation definition DSL
+    #
+    # @example
+    #
+    #   setup.relation(:users) do
+    #     def names
+    #       project(:name)
+    #     end
+    #   end
+    #
+    # @api public
+    def relation(name, &block)
+      @relations.update(name => block)
+    end
+
+    # Mapper definition DSL
+    #
+    # @example
+    #
+    #   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
+
+    # Command definition DSL
+    #
+    # @example
+    #
+    #   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)
+    end
+
+    # Finalize the setup
+    #
+    # @return [Env] frozen env with access to repositories, schema, relations,
+    #                mappers and commands
+    #
+    # @api public
+    def finalize
+      raise EnvAlreadyFinalizedError if env
+
+      finalize = Finalize.new(
+        repositories, @schema, @relations, @mappers, @commands
+      )
+
+      @env = finalize.run!
+    end
+
+    # Returns repository identified by name
+    #
+    # @return [Repository]
+    #
+    # @api private
+    def [](name)
+      repositories.fetch(name)
+    end
+
+    # Hook for respond_to? used internally
+    #
+    # @api private
+    def respond_to_missing?(name, _include_context = false)
+      repositories.key?(name)
+    end
+
+    private
+
+    # Returns repository if method is a name of a registered repository
+    #
+    # @return [Repository]
+    #
+    # @api private
+    def method_missing(name, *)
+      if repositories.key?(name)
+        repositories.fetch(name)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/rom/{boot → setup}/base_relation_dsl.rb

@@ -1,14 +1,14 @@
 module ROM
-  class Boot
-
+  class Setup
     class BaseRelationDSL
       attr_reader :env, :name, :header
 
-      def initialize(env, name)
+      def initialize(env, name, &block)
         @env = env
         @name = name
         @header = []
         @repository = nil
+        instance_exec(&block)
       end
 
       def repository(name = nil)
@@ -23,9 +23,7 @@ module ROM
         header << name
       end
 
-      def call(&block)
-        instance_exec(&block)
-
+      def call
         dataset =
           if adapter.respond_to?(:dataset)
             adapter.dataset(name, header)
@@ -43,8 +41,6 @@ module ROM
       def adapter
         repository.adapter
       end
-
     end
-
   end
 end

data/lib/rom/setup/command_dsl.rb

@@ -0,0 +1,46 @@
+require 'rom/mapper_builder'
+
+module ROM
+  class Setup
+    class CommandDSL
+      attr_reader :commands
+
+      class CommandDefinition
+        attr_reader :options
+
+        def initialize(options, &block)
+          @options = options
+          instance_exec(&block) if block
+        end
+
+        def to_h
+          options
+        end
+
+        def type
+          options[:type]
+        end
+
+        private
+
+        def method_missing(name, *args, &block)
+          if args.size == 1
+            options[name] = args.first
+          else
+            super
+          end
+        end
+      end
+
+      def initialize(&block)
+        @commands = {}
+        instance_exec(&block)
+      end
+
+      def define(name, options = {}, &block)
+        commands[name] = CommandDefinition.new(options, &block)
+        self
+      end
+    end
+  end
+end

data/lib/rom/setup/finalize.rb

@@ -0,0 +1,125 @@
+require 'rom/relation_builder'
+require 'rom/reader_builder'
+require 'rom/command_registry'
+
+require 'rom/env'
+
+module ROM
+  class Setup
+    # @private
+    class Finalize
+      attr_reader :repositories, :adapter_relation_map
+
+      # @api private
+      def initialize(repositories, schema, relations, mappers, commands)
+        @repositories = repositories
+        @schema = schema
+        @relations = relations
+        @mappers = mappers
+        @commands = commands
+        @adapter_relation_map = {}
+      end
+
+      # @api private
+      def run!
+        schema = load_schema
+        relations = load_relations(schema)
+        readers = load_readers(relations)
+        commands = load_commands(relations)
+
+        Env.new(repositories, schema, relations, readers, commands)
+      end
+
+      private
+
+      # @api private
+      def load_schema
+        repositories.each_value do |repo|
+          (@schema[repo] ||= []).concat(repo.schema)
+        end
+
+        base_relations = @schema.each_with_object({}) do |(repo, schema), h|
+          schema.each do |name, dataset, header|
+            adapter_relation_map[name] = repo.adapter
+            h[name] = Relation.new(dataset, header)
+          end
+        end
+
+        Schema.new(base_relations)
+      end
+
+      # @api private
+      def load_relations(schema)
+        return RelationRegistry.new unless adapter_relation_map.any?
+
+        relations = {}
+        builder = RelationBuilder.new(schema, relations)
+
+        @relations.each do |name, block|
+          relations[name] = build_relation(name, builder, block)
+        end
+
+        (schema.elements.keys - relations.keys).each do |name|
+          relations[name] = build_relation(name, builder)
+        end
+
+        relations.each_value do |relation|
+          relation.class.finalize(relations, relation)
+        end
+
+        RelationRegistry.new(relations)
+      end
+
+      # @api private
+      def build_relation(name, builder, block = nil)
+        adapter = adapter_relation_map[name]
+
+        relation = builder.call(name) do |klass|
+          adapter.extend_relation_class(klass)
+          methods = klass.public_instance_methods
+
+          klass.class_eval(&block) if block
+
+          klass.relation_methods = klass.public_instance_methods - methods
+        end
+
+        adapter.extend_relation_instance(relation)
+
+        relation
+      end
+
+      # @api private
+      def load_readers(relations)
+        return ReaderRegistry.new unless adapter_relation_map.any?
+
+        reader_builder = ReaderBuilder.new(relations)
+
+        readers = @mappers.each_with_object({}) do |(name, options, block), h|
+          h[name] = reader_builder.call(name, options, &block)
+        end
+
+        ReaderRegistry.new(readers)
+      end
+
+      def load_commands(relations)
+        return Registry.new unless relations.elements.any?
+
+        commands = @commands.each_with_object({}) do |(name, definitions), h|
+          adapter = adapter_relation_map[name]
+
+          rel_commands = {}
+
+          definitions.each do |command_name, definition|
+            rel_commands[command_name] = adapter.command(
+              command_name, relations[name], definition
+            )
+          end
+
+          h[name] = CommandRegistry.new(rel_commands)
+        end
+
+        Registry.new(commands)
+      end
+    end
+  end
+end

data/lib/rom/setup/mapper_dsl.rb

@@ -0,0 +1,19 @@
+require 'rom/mapper_builder'
+
+module ROM
+  class Setup
+    class MapperDSL
+      attr_reader :mappers
+
+      def initialize(&block)
+        @mappers = []
+        instance_exec(&block)
+      end
+
+      def define(name, options = {}, &block)
+        mappers << [name, options, block]
+        self
+      end
+    end
+  end
+end