hanami-model 0.6.1 → 0.7.0

data/lib/hanami/model/configuration.rb

@@ -1,5 +1,4 @@
-require 'hanami/model/config/adapter'
-require 'hanami/model/config/mapper'
+require 'rom/configuration'
 
 module Hanami
   module Model
@@ -9,265 +8,94 @@ module Hanami
     # via `Hanami::Model.configure`.
     #
     # @since 0.2.0
-    class Configuration
-      # Default migrations path
-      #
-      # @since 0.4.0
+    class Configuration < ROM::Configuration
+      # @since 0.7.0
       # @api private
-      #
-      # @see Hanami::Model::Configuration#migrations
-      DEFAULT_MIGRATIONS_PATH = Pathname.new('db/migrations').freeze
+      attr_reader :mappings
 
-      # Default schema path
-      #
-      # @since 0.4.0
+      # @since 0.7.0
       # @api private
-      #
-      # @see Hanami::Model::Configuration#schema
-      DEFAULT_SCHEMA_PATH = Pathname.new('db/schema.sql').freeze
+      attr_reader :entities
 
-      # The persistence mapper
-      #
-      # @return [Hanami::Model::Mapper]
-      #
       # @since 0.2.0
-      attr_reader :mapper
-
-      # An adapter configuration template
-      #
-      # @return [Hanami::Model::Config::Adapter]
-      #
-      # @since 0.2.0
-      attr_reader :adapter_config
-
-      # Initialize a configuration instance
-      #
-      # @return [Hanami::Model::Configuration] a new configuration's
-      #   instance
-      #
-      # @since 0.2.0
-      def initialize
-        reset!
+      # @api private
+      def initialize(configurator)
+        super(configurator.backend, configurator.url)
+        @migrations   = configurator._migrations
+        @schema       = configurator._schema
+        @mappings     = {}
+        @entities     = {}
       end
 
-      # Reset all the values to the defaults
-      #
-      # @return void
+      # NOTE: This must be changed when we want to support several adapters at the time
       #
-      # @since 0.2.0
-      def reset!
-        @adapter = nil
-        @adapter_config = nil
-        @mapper = NullMapper.new
-        @mapper_config = nil
-        @migrations = DEFAULT_MIGRATIONS_PATH
-        @schema = DEFAULT_SCHEMA_PATH
+      # @since 0.7.0
+      # @api private
+      def url
+        connection.url
       end
 
-      alias_method :unload!, :reset!
-
-      # Load the configuration for the current framework
+      # NOTE: This must be changed when we want to support several adapters at the time
       #
-      # @return void
-      #
-      # @since 0.2.0
-      def load!
-        _build_mapper
-        _build_adapter
-
-        mapper.load!(@adapter)
+      # @since 0.7.0
+      # @api private
+      def connection
+        gateway.connection
       end
 
-      # Register adapter
-      #
-      # There could only 1 adapter can be registered per application
-      #
-      # @overload adapter
-      #   Retrieves the configured adapter
-      #   @return [Hanami::Model::Config::Adapter,NilClass] the adapter, if
-      #     present
-      #
-      # @overload adapter
-      #   Register the adapter
-      #     @param @options [Hash] A set of options to register an adapter
-      #     @option options [Symbol] :type The adapter type. Eg. :sql, :memory
-      #       (mandatory)
-      #     @option options [String] :uri The database uri string (mandatory)
-      #
-      # @return void
-      #
-      # @raise [ArgumentError] if one of the mandatory options is omitted
-      #
-      # @see Hanami::Model.configure
-      # @see Hanami::Model::Config::Adapter
-      #
-      # @example Register the adapter
-      #   require 'hanami/model'
+      # NOTE: This must be changed when we want to support several adapters at the time
       #
-      #   Hanami::Model.configure do
-      #     adapter type: :sql, uri: 'sqlite3://localhost/database'
-      #   end
-      #
-      #   Hanami::Model.configuration.adapter_config
-      #
-      # @since 0.2.0
-      def adapter(options = nil)
-        if options.nil?
-          @adapter_config
-        else
-          _check_adapter_options!(options)
-          @adapter_config ||= Hanami::Model::Config::Adapter.new(options)
-        end
+      # @since 0.7.0
+      # @api private
+      def gateway
+        environment.gateways[:default]
       end
 
-      # Set global persistence mapping
-      #
-      # @overload mapping(blk)
-      #   Specify a set of mapping in the given block
-      #   @param blk [Proc] the mapping definitions
-      #
-      # @overload mapping(path)
-      #   Specify a relative path where to find the mapping file
-      #   @param path [String] the relative path
-      #
-      # @return void
-      #
-      # @see Hanami::Model.configure
-      # @see Hanami::Model::Mapper
-      #
-      # @example Set global persistence mapper
-      #   require 'hanami/model'
-      #
-      #   Hanami::Model.configure do
-      #     mapping do
-      #       collection :users do
-      #         entity User
-      #
-      #         attribute :id,   Integer
-      #         attribute :name, String
-      #       end
-      #     end
-      #   end
+      # Root directory
       #
-      # @since 0.2.0
-      def mapping(path=nil, &blk)
-        @mapper_config = Hanami::Model::Config::Mapper.new(path, &blk)
+      # @since 0.4.0
+      # @api private
+      def root
+        Hanami.respond_to?(:root) ? Hanami.root : Pathname.pwd
       end
 
       # Migrations directory
       #
-      # It defaults to <tt>db/migrations</tt>.
-      #
-      # @overload migrations
-      #   Get migrations directory
-      #   @return [Pathname] migrations directory
-      #
-      # @overload migrations(path)
-      #   Set migrations directory
-      #   @param path [String,Pathname] the path
-      #   @raise [Errno::ENOENT] if the given path doesn't exist
-      #
       # @since 0.4.0
-      #
-      # @see Hanami::Model::Migrations::DEFAULT_MIGRATIONS_PATH
-      #
-      # @example Set Custom Path
-      #   require 'hanami/model'
-      #
-      #   Hanami::Model.configure do
-      #     # ...
-      #     migrations 'path/to/migrations'
-      #   end
-      def migrations(path = nil)
-        if path.nil?
-          @migrations
-        else
-          @migrations = root.join(path).realpath
-        end
+      def migrations
+        (@migrations.nil? ? root : root.join(@migrations)).realpath
       end
 
-      # Schema
-      #
-      # It defaults to <tt>db/schema.sql</tt>.
-      #
-      # @overload schema
-      #   Get schema path
-      #   @return [Pathname] schema path
-      #
-      # @overload schema(path)
-      #   Set schema path
-      #   @param path [String,Pathname] the path
+      # Path for schema dump file
       #
       # @since 0.4.0
-      #
-      # @see Hanami::Model::Migrations::DEFAULT_SCHEMA_PATH
-      #
-      # @example Set Custom Path
-      #   require 'hanami/model'
-      #
-      #   Hanami::Model.configure do
-      #     # ...
-      #     schema 'path/to/schema.sql'
-      #   end
-      def schema(path = nil)
-        if path.nil?
-          @schema
-        else
-          @schema = root.join(path)
-        end
+      def schema
+        @schema.nil? ? root : root.join(@schema)
       end
 
-      # Root directory
-      #
-      # @since 0.4.0
+      # @since 0.7.0
       # @api private
-      def root
-        Hanami.respond_to?(:root) ? Hanami.root : Pathname.pwd
+      def define_mappings(root, &blk)
+        @mappings[root] = Mapping.new(&blk)
       end
 
-      # Duplicate by copying the settings in a new instance.
-      #
-      # @return [Hanami::Model::Configuration] a copy of the configuration
-      #
-      # @since 0.2.0
+      # @since 0.7.0
       # @api private
-      def duplicate
-        Configuration.new.tap do |c|
-          c.instance_variable_set(:@adapter_config, @adapter_config)
-          c.instance_variable_set(:@mapper, @mapper)
-        end
+      def register_entity(plural, singular, klass)
+        @entities[plural]   = klass
+        @entities[singular] = klass
       end
 
-      private
-
-      # Instantiate mapper from mapping block
-      #
-      # @see Hanami::Model::Configuration#mapping
-      #
+      # @since 0.7.0
       # @api private
-      # @since 0.2.0
-      def _build_mapper
-        @mapper = Hanami::Model::Mapper.new(&@mapper_config) if @mapper_config
-      end
+      def define_entities_mappings(container, repositories)
+        return unless defined?(Sql::Entity::Schema)
 
-      # @api private
-      # @since 0.1.0
-      def _build_adapter
-        @adapter = adapter_config.build(mapper)
-      end
+        repositories.each do |r|
+          relation = r.relation
+          entity   = r.entity
 
-      # @api private
-      # @since 0.2.0
-      #
-      # NOTE Drop this manual check when Ruby 2.0 will not be supported anymore.
-      #   Use keyword arguments instead.
-      def _check_adapter_options!(options)
-        # TODO Maybe this is a candidate for Hanami::Utils::Options
-        # We already have two similar cases:
-        #   1. Hanami::Router :only/:except for RESTful resources
-        #   2. Hanami::Validations.validate_options!
-        [:type, :uri].each do |keyword|
-          raise ArgumentError.new("missing keyword: #{keyword}") if !options.keys.include?(keyword)
+          entity.schema = Sql::Entity::Schema.new(entities, container.relations[relation], mappings.fetch(relation))
         end
       end
     end

data/lib/hanami/model/configurator.rb

@@ -0,0 +1,62 @@
+module Hanami
+  module Model
+    # Configuration DSL
+    #
+    # @since 0.7.0
+    # @api private
+    class Configurator
+      # @since 0.7.0
+      # @api private
+      attr_reader :backend
+
+      # @since 0.7.0
+      # @api private
+      attr_reader :url
+
+      # @since 0.7.0
+      # @api private
+      attr_reader :directory
+
+      # @since 0.7.0
+      # @api private
+      attr_reader :_migrations
+
+      # @since 0.7.0
+      # @api private
+      attr_reader :_schema
+
+      # @since 0.7.0
+      # @api private
+      def self.build(&block)
+        new.tap { |config| config.instance_eval(&block) }
+      end
+
+      private
+
+      # @since 0.7.0
+      # @api private
+      def adapter(backend, url)
+        @backend = backend
+        @url = url
+      end
+
+      # @since 0.7.0
+      # @api private
+      def path(path)
+        @directory = path
+      end
+
+      # @since 0.7.0
+      # @api private
+      def migrations(path)
+        @_migrations = path
+      end
+
+      # @since 0.7.0
+      # @api private
+      def schema(path)
+        @_schema = path
+      end
+    end
+  end
+end

data/lib/hanami/model/entity_name.rb

@@ -0,0 +1,35 @@
+module Hanami
+  module Model
+    # Conventional name for entities.
+    #
+    # Given a repository named <tt>SourceFileRepository</tt>, the associated
+    # entity will be <tt>SourceFile</tt>.
+    #
+    # @since 0.7.0
+    # @api private
+    class EntityName
+      # @since 0.7.0
+      # @api private
+      SUFFIX = /Repository\z/
+
+      # @param name [Class,String] the class or its name
+      # @return [String] the entity name
+      #
+      # @since 0.7.0
+      # @api private
+      def initialize(name)
+        @name = name.sub(SUFFIX, '')
+      end
+
+      # @since 0.7.0
+      # @api private
+      def underscore
+        Utils::String.new(@name).underscore.to_sym
+      end
+
+      def to_s
+        @name
+      end
+    end
+  end
+end

data/lib/hanami/model/error.rb

@@ -1,41 +1,54 @@
+require 'concurrent'
+
 module Hanami
   module Model
-
     # Default Error class
     #
     # @since 0.5.1
-    Error = Class.new(::StandardError)
+    class Error < ::StandardError
+      # @api private
+      # @since 0.7.0
+      @__mapping__ = Concurrent::Map.new # rubocop:disable Style/VariableNumber
 
-    # Error for non persisted entity
-    # It's raised when we try to update or delete a non persisted entity.
-    #
-    # @since 0.1.0
-    #
-    # @see Hanami::Repository.update
-    NonPersistedEntityError = Class.new(Error)
+      # @api private
+      # @since 0.7.0
+      def self.for(exception)
+        mapping.fetch(exception.class, self).new(exception)
+      end
 
-    # Error for invalid mapper configuration
-    # It's raised when mapping is not configured correctly
-    #
-    # @since 0.2.0
+      # @api private
+      # @since 0.7.0
+      def self.register(external, internal)
+        mapping.put_if_absent(external, internal)
+      end
+
+      # @api private
+      # @since 0.7.0
+      def self.mapping
+        @__mapping__
+      end
+    end
+
+    # Generic database error
     #
-    # @see Hanami::Configuration#mapping
-    InvalidMappingError = Class.new(Error)
+    # @since 0.7.0
+    class DatabaseError < Error
+    end
 
     # Error for invalid raw command syntax
     #
     # @since 0.5.0
     class InvalidCommandError < Error
-      def initialize(message = "Invalid command")
+      def initialize(message = 'Invalid command')
         super
       end
     end
 
-    # Error for invalid raw query syntax
+    # Error for Constraint Violation
     #
-    # @since 0.3.1
-    class InvalidQueryError < Error
-      def initialize(message = "Invalid query")
+    # @since 0.7.0
+    class ConstraintViolationError < Error
+      def initialize(message = 'Constraint has been violated')
         super
       end
     end
@@ -44,7 +57,7 @@ module Hanami
     #
     # @since 0.6.1
     class UniqueConstraintViolationError < Error
-      def initialize(message = "Unique constraint has been violated")
+      def initialize(message = 'Unique constraint has been violated')
         super
       end
     end
@@ -53,7 +66,7 @@ module Hanami
     #
     # @since 0.6.1
     class ForeignKeyConstraintViolationError < Error
-      def initialize(message = "Foreign key constraint has been violated")
+      def initialize(message = 'Foreign key constraint has been violated')
         super
       end
     end
@@ -62,7 +75,7 @@ module Hanami
     #
     # @since 0.6.1
     class NotNullConstraintViolationError < Error
-      def initialize(message = "NOT NULL constraint has been violated")
+      def initialize(message = 'NOT NULL constraint has been violated')
         super
       end
     end
@@ -71,7 +84,7 @@ module Hanami
     #
     # @since 0.6.1
     class CheckConstraintViolationError < Error
-      def initialize(message = "Check constraint has been violated")
+      def initialize(message = 'Check constraint has been violated')
         super
       end
     end