hanami-model 0.7.0 → 1.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac96a7e41555f5a379c12d3fd45c999ea4ce7e93
-  data.tar.gz: 59f4d8fe809cd3536bc47fff73830ba37304a6c7
+  metadata.gz: 396fbb6a95d9e5526ff1e2415246d0bebc3f8413
+  data.tar.gz: 67a3c00a1e9c29ced838ba349082db34262edd1d
 SHA512:
-  metadata.gz: f730a23b1a29d426405c1cb79ee2ea74ab73f9baaa73521c7136b3f39913a4a9dcc6cdeed2e45ce4ffd2b334fbb839e637b8ff60edbafa19777d47fb9e5c505d
-  data.tar.gz: 382a94c09b68ed787d67643b6128ce1d2f54b0d2c669bc2c0248ad45c8e54fbfe14bd613bb9e9268988d16dcc29f2dd05c30be08c7461ec1a30b11fe34f9f635
+  metadata.gz: b47a74240ea4e92273809b248531ce3d06b301b4e6ab5dc9e588f8bd1297157d368b1ee4725281a401f578db1fbf17a698be2a03844718c8f7c73c594e19288b
+  data.tar.gz: 9307402f7125c83e3d9e3e1b1365ffb7cdcb661167bc1348969e52d13658edbf0ba28110e4923b1da4a1461554ee308564a9b6853b2240633ffb4c517975677f

data/CHANGELOG.md

@@ -1,6 +1,24 @@
 # Hanami::Model
 A persistence layer for Hanami
 
+## v1.0.0.beta1 - 2017-02-14
+### Added
+- [Luca Guidi] Official support for Ruby: MRI 2.4
+- [Luca Guidi] Introduced `Repository#read` to fetch from database with raw SQL string
+- [Luca Guidi] Introduced `Repository.schema` to manually configure the schema of a database table. This is useful for legacy databases where Hanami::Model autoinferring doesn't map correctly the schema.
+- [Luca Guidi & Alfonso Uceda] Added `Hanami::Model::Configuration#gateway` to configure gateway and the raw connection
+- [Luca Guidi] Added `Hanami::Model::Configuration#logger` to configure a logger
+- [Luca Guidi] Database operations (including migrations) print informations to standard output
+
+### Fixed
+- [Thorbjørn Hermansen] Ensure repository to not override given timestamps
+- [Luca Guidi] Raise `Hanami::Model::MissingPrimaryKeyError` if `Repository#find` is ran against a database w/o a primary key
+- [Alfonso Uceda] Ensure SQLite databases to be used on JRuby when the database path is in the same directory of the Ruby script (eg. `./test.sqlite`)
+
+### Changed
+- [Luca Guidi] Automap the main relation in a repository, by removing the need of use `.as(:entity)`
+- [Luca Guidi] Raise an `Hanami::Model::UnknownDatabaseTypeError` when the application is loaded and there is an unknown column type in the database
+
 ## v0.7.0 - 2016-11-15
 ### Added
 - [Luca Guidi] `Hanami::Entity` defines an automatic schema for SQL databases

data/README.md

@@ -127,7 +127,7 @@ This architecture has several advantages:
 
   * Multiple data sources can easily coexist in an application
 
-When a class includes `Hanami::Repository`, it will receive the following interface:
+When a class inherits from `Hanami::Repository`, it will receive the following interface:
 
   * `#create(data)`     – Create a record for the given data (or entity)
   * `#update(id, data)` – Update the record corresponding to the given id by setting the given data (or entity)
@@ -207,7 +207,7 @@ class UserRepository < Hanami::Repository
   end
 end
 ```
-**NOTE:** This feature should be used only when **_automapping_** fails because the naming mismatch.
+**NOTE:** This feature should be used only when **_automapping_** fails because of the naming mismatch.
 
 ### Conventions
 
@@ -216,7 +216,7 @@ end
 ### Thread safety
 
 **Hanami::Model**'s is thread safe during the runtime, but it isn't during the loading process.
-The mapper compiles some code internally, be sure to safely load it before your application starts.
+The mapper compiles some code internally, so be sure to safely load it before your application starts.
 
 ```ruby
 Mutex.new.synchronize do
@@ -224,7 +224,7 @@ Mutex.new.synchronize do
 end
 ```
 
-**This is not necessary, when Hanami::Model is used within a Hanami application.**
+**This is not necessary when Hanami::Model is used within a Hanami application.**
 
 ## Features
 
@@ -258,6 +258,25 @@ puts user.created_at.to_s # => "2016-09-19 13:40:13 UTC"
 puts user.updated_at.to_s # => "2016-09-19 13:40:16 UTC"
 ```
 
+## Configuration
+
+### Logging
+
+In order to log database operations, you can configure a logger:
+
+```ruby
+Hanami::Model.configure do
+  # ...
+  logger "log/development.log", level: :debug
+end
+```
+
+It accepts the following arguments:
+
+  * `stream`: a Ruby StringIO object - it can be `$stdout` or a path to file (eg. `"log/development.log"`) - Defaults to `$stdout`
+  * `:level`: logging level - it can be: `:debug`, `:info`, `:warn`, `:error`, `:fatal`, `:unknown` - Defaults to `:debug`
+  * `:formatter`: logging formatter - it can be: `:default` or `:json` - Defaults to `:default`
+
 ## Versioning
 
 __Hanami::Model__ uses [Semantic Versioning 2.0.0](http://semver.org)
@@ -272,6 +291,6 @@ __Hanami::Model__ uses [Semantic Versioning 2.0.0](http://semver.org)
 
 ## Copyright
 
-Copyright © 2014-2016 Luca Guidi – Released under MIT License
+Copyright © 2014-2017 Luca Guidi – Released under MIT License
 
 This project was formerly known as Lotus (`lotus-model`).

data/hanami-model.gemspec

@@ -19,9 +19,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.3.0'
 
-  spec.add_runtime_dependency 'hanami-utils',    '~> 0.8'
-  spec.add_runtime_dependency 'rom-sql',         '~> 0.9'
-  spec.add_runtime_dependency 'rom-repository',  '~> 0.3'
+  spec.add_runtime_dependency 'hanami-utils',    '~> 1.0.0.beta'
+  spec.add_runtime_dependency 'rom-sql',         '~> 1.0'
+  spec.add_runtime_dependency 'rom-repository',  '~> 1.0'
   spec.add_runtime_dependency 'dry-types',       '~> 0.9'
   spec.add_runtime_dependency 'concurrent-ruby', '~> 1.0'
 

data/lib/hanami/entity.rb

@@ -141,7 +141,7 @@ module Hanami
     #
     # @since 0.7.0
     def method_missing(m, *)
-      attribute?(m) or super # rubocop:disable Style/AndOr
+      attribute?(m) or super
       attributes.fetch(m, nil)
     end
 

data/lib/hanami/entity/schema.rb

@@ -207,7 +207,7 @@ module Hanami
       def call(attributes)
         Utils::Hash.new(
           schema.call(attributes)
-        ).symbolize!
+        ).deep_symbolize!
       end
 
       # @since 0.7.0

data/lib/hanami/model.rb

@@ -17,7 +17,7 @@ module Hanami
 
     # @api private
     # @since 0.7.0
-    @__repositories__ = Concurrent::Array.new # rubocop:disable Style/VariableNumber
+    @__repositories__ = Concurrent::Array.new
 
     class << self
       # @since 0.7.0
@@ -72,15 +72,9 @@ module Hanami
     end
 
     # @since 0.1.0
-    def self.load!(&blk) # rubocop:disable Metrics/AbcSize
-      configuration.setup.auto_registration(config.directory.to_s) unless config.directory.nil?
-      configuration.instance_eval(&blk)                            if     block_given?
-      repositories.each(&:load!)
-
-      @container = ROM.container(configuration)
-      configuration.define_entities_mappings(@container, repositories)
-
-      @loaded = true
+    def self.load!(&blk)
+      @container = configuration.load!(repositories, &blk)
+      @loaded    = true
     end
   end
 end

data/lib/hanami/model/associations/has_many.rb

@@ -186,7 +186,7 @@ module Hanami
         def _build_scope
           result = relation(target)
           result = result.where(foreign_key => subject.fetch(primary_key)) unless subject.nil?
-          result.as(Repository::MAPPER_NAME)
+          result.as(Model::MappedRelation.mapper_name)
         end
 
         # @since 0.7.0

data/lib/hanami/model/configuration.rb

@@ -8,7 +8,7 @@ module Hanami
     # via `Hanami::Model.configure`.
     #
     # @since 0.2.0
-    class Configuration < ROM::Configuration
+    class Configuration
       # @since 0.7.0
       # @api private
       attr_reader :mappings
@@ -17,23 +17,33 @@ module Hanami
       # @api private
       attr_reader :entities
 
+      # @since 1.0.0.beta1
+      # @api private
+      attr_reader :logger
+
+      # @since 1.0.0.beta1
+      # @api private
+      attr_reader :migrations_logger
+
       # @since 0.2.0
       # @api private
       def initialize(configurator)
-        super(configurator.backend, configurator.url)
-        @migrations   = configurator._migrations
-        @schema       = configurator._schema
-        @mappings     = {}
-        @entities     = {}
+        @backend = configurator.backend
+        @url = configurator.url
+        @migrations        = configurator._migrations
+        @schema            = configurator._schema
+        @gateway_config    = configurator._gateway
+        @logger            = configurator._logger
+        @migrations_logger = configurator.migrations_logger
+        @mappings          = {}
+        @entities          = {}
       end
 
       # NOTE: This must be changed when we want to support several adapters at the time
       #
       # @since 0.7.0
       # @api private
-      def url
-        connection.url
-      end
+      attr_reader :url
 
       # NOTE: This must be changed when we want to support several adapters at the time
       #
@@ -48,7 +58,7 @@ module Hanami
       # @since 0.7.0
       # @api private
       def gateway
-        environment.gateways[:default]
+        gateways[:default]
       end
 
       # Root directory
@@ -98,6 +108,51 @@ module Hanami
           entity.schema = Sql::Entity::Schema.new(entities, container.relations[relation], mappings.fetch(relation))
         end
       end
+
+      # @since 1.0.0.beta1
+      # @api private
+      def configure_gateway
+        @gateway_config.call(gateway) unless @gateway_config.nil?
+      end
+
+      # @since 1.0.0.beta1
+      # @api private
+      def logger=(value)
+        return if value.nil?
+        gateway.use_logger(@logger = value)
+      end
+
+      # @since 1.0.0.beta1
+      # @api private
+      def rom
+        @rom ||= ROM::Configuration.new(@backend, @url, infer_relations: false)
+      end
+
+      # @since 1.0.0.beta1
+      # @api private
+      def load!(repositories, &blk) # rubocop:disable Metrics/AbcSize
+        rom.setup.auto_registration(config.directory.to_s) unless config.directory.nil?
+        rom.instance_eval(&blk)                            if     block_given?
+        configure_gateway
+        repositories.each(&:load!)
+        self.logger = logger
+
+        container = ROM.container(rom)
+        define_entities_mappings(container, repositories)
+        container
+      rescue => e
+        raise Hanami::Model::Error.for(e)
+      end
+
+      # @since 1.0.0.beta1
+      # @api private
+      def method_missing(method_name, *args, &blk)
+        if rom.respond_to?(method_name)
+          rom.__send__(method_name, *args, &blk)
+        else
+          super
+        end
+      end
     end
   end
 end

data/lib/hanami/model/configurator.rb

@@ -25,12 +25,27 @@ module Hanami
       # @api private
       attr_reader :_schema
 
+      # @since 1.0.0.beta1
+      # @api private
+      attr_reader :_logger
+
+      # @since 1.0.0.beta1
+      # @api private
+      attr_reader :_gateway
+
       # @since 0.7.0
       # @api private
       def self.build(&block)
         new.tap { |config| config.instance_eval(&block) }
       end
 
+      # @since 1.0.0.beta1
+      # @api private
+      def migrations_logger(stream = $stdout)
+        require 'hanami/model/migrator/logger'
+        @migrations_logger ||= Hanami::Model::Migrator::Logger.new(stream)
+      end
+
       private
 
       # @since 0.7.0
@@ -57,6 +72,21 @@ module Hanami
       def schema(path)
         @_schema = path
       end
+
+      # @since 1.0.0.beta1
+      # @api private
+      def logger(stream, options = {})
+        require 'hanami/logger'
+
+        opts = options.merge(stream: stream)
+        @_logger = Hanami::Logger.new('hanami.model', opts)
+      end
+
+      # @since 1.0.0.beta1
+      # @api private
+      def gateway(&blk)
+        @_gateway = blk
+      end
     end
   end
 end

data/lib/hanami/model/error.rb

@@ -8,7 +8,7 @@ module Hanami
     class Error < ::StandardError
       # @api private
       # @since 0.7.0
-      @__mapping__ = Concurrent::Map.new # rubocop:disable Style/VariableNumber
+      @__mapping__ = Concurrent::Map.new
 
       # @api private
       # @since 0.7.0
@@ -88,5 +88,17 @@ module Hanami
         super
       end
     end
+
+    # Unknown database type error for repository auto-mapping
+    #
+    # @since 1.0.0.beta1
+    class UnknownDatabaseTypeError < Error
+    end
+
+    # Unknown primary key error
+    #
+    # @since 1.0.0.beta1
+    class MissingPrimaryKeyError < Error
+    end
   end
 end

data/lib/hanami/model/mapped_relation.rb

@@ -0,0 +1,33 @@
+module Hanami
+  module Model
+    # Mapped proxy for ROM relations.
+    #
+    # It eliminates the need of use #as for repository queries
+    #
+    # @since 1.0.0.beta1
+    # @api private
+    class MappedRelation < SimpleDelegator
+      # Mapper name.
+      #
+      # With ROM mapping there is a link between the entity class and a generic
+      # reference for it. Example: <tt>BookRepository</tt> references <tt>Book</tt>
+      # as <tt>:entity</tt>.
+      #
+      # @since 1.0.0.beta1
+      # @api private
+      MAPPER_NAME = :entity
+
+      # @since 1.0.0.beta1
+      # @api private
+      def self.mapper_name
+        MAPPER_NAME
+      end
+
+      # @since 1.0.0.beta1
+      # @api private
+      def initialize(relation)
+        super(relation.as(self.class.mapper_name))
+      end
+    end
+  end
+end

data/lib/hanami/model/mapping.rb

@@ -1,4 +1,4 @@
-require 'transproc'
+require 'transproc/all'
 
 module Hanami
   module Model
@@ -6,11 +6,19 @@ module Hanami
     #
     # @since 0.1.0
     class Mapping
+      extend Transproc::Registry
+
+      import Transproc::HashTransformations
+
       def initialize(&blk)
         @attributes   = {}
         @r_attributes = {}
         instance_eval(&blk)
-        @processor = @attributes.empty? ? ::Hash : Transproc(:rename_keys, @attributes)
+        @processor = @attributes.empty? ? ::Hash : t(:rename_keys, @attributes)
+      end
+
+      def t(name, *args)
+        self.class[name, *args]
       end
 
       def model(entity)

data/lib/hanami/model/migrator/adapter.rb

@@ -26,7 +26,7 @@ module Hanami
         # @since 0.4.0
         # @api private
         def self.for(configuration) # rubocop:disable Metrics/MethodLength
-          connection = connection_for(configuration)
+          connection = Connection.new(configuration)
 
           case connection.database_type
           when :sqlite
@@ -40,30 +40,15 @@ module Hanami
             MySQLAdapter
           else
             self
-          end.new(connection, configuration)
-        end
-
-        class << self
-          private
-
-          # @since 0.7.0
-          # @api private
-          def connection_for(configuration)
-            Sequel.connect(
-              configuration.url
-            )
-          rescue Sequel::AdapterNotFound
-            raise MigrationError.new("Current adapter (#{configuration.adapter.type}) doesn't support SQL database operations.")
-          end
+          end.new(connection)
         end
 
         # Initialize an adapter
         #
         # @since 0.4.0
         # @api private
-        def initialize(connection, configuration)
-          @connection = Connection.new(connection)
-          @schema     = configuration.schema
+        def initialize(connection)
+          @connection = connection
         end
 
         # Create database.
@@ -128,7 +113,9 @@ module Hanami
 
         # @since 0.4.0
         # @api private
-        attr_reader :schema
+        def schema
+          connection.schema
+        end
 
         # Returns a database connection
         #

data/lib/hanami/model/migrator/connection.rb

@@ -8,14 +8,23 @@ module Hanami
       # @since 0.5.0
       # @api private
       class Connection
-        # @since 0.7.0
+        # @since 0.5.0
         # @api private
-        attr_reader :raw
+        def initialize(configuration)
+          @configuration = configuration
+        end
 
-        # @since 0.5.0
+        # @since 0.7.0
         # @api private
-        def initialize(raw)
-          @raw = raw
+        def raw
+          @raw ||= begin
+                     Sequel.connect(
+                       configuration.url,
+                       loggers: [configuration.migrations_logger]
+                     )
+                   rescue Sequel::AdapterNotFound
+                     raise MigrationError.new("Current adapter (#{configuration.adapter.type}) doesn't support SQL database operations.")
+                   end
         end
 
         # Returns DB connection host
@@ -25,7 +34,7 @@ module Hanami
         # @since 0.5.0
         # @api private
         def host
-          @host ||= opts.fetch(:host, parsed_uri.host)
+          @host ||= parsed_uri.host
         end
 
         # Returns DB connection port
@@ -35,7 +44,7 @@ module Hanami
         # @since 0.5.0
         # @api private
         def port
-          @port ||= opts.fetch(:port, parsed_uri.port)
+          @port ||= parsed_uri.port
         end
 
         # Returns DB name from conenction
@@ -45,7 +54,7 @@ module Hanami
         # @since 0.5.0
         # @api private
         def database
-          @database ||= opts.fetch(:database, parsed_uri.path[1..-1])
+          @database ||= parsed_uri.path[1..-1]
         end
 
         # Returns DB type
@@ -57,7 +66,14 @@ module Hanami
         # @since 0.5.0
         # @api private
         def database_type
-          raw.database_type
+          case uri
+          when /sqlite/
+            :sqlite
+          when /postgres/
+            :postgres
+          when /mysql/
+            :mysql
+          end
         end
 
         # Returns user from DB connection
@@ -67,7 +83,7 @@ module Hanami
         # @since 0.5.0
         # @api private
         def user
-          @user ||= opts.fetch(:user, parsed_opt('user'))
+          @user ||= parsed_opt('user')
         end
 
         # Returns user from DB connection
@@ -77,7 +93,7 @@ module Hanami
         # @since 0.5.0
         # @api private
         def password
-          @password ||= opts.fetch(:password, parsed_opt('password'))
+          @password ||= parsed_opt('password')
         end
 
         # Returns DB connection URI directly from adapter
@@ -85,7 +101,7 @@ module Hanami
         # @since 0.5.0
         # @api private
         def uri
-          raw.uri
+          @configuration.url
         end
 
         # Returns DB connection wihout specifying database name
@@ -93,7 +109,7 @@ module Hanami
         # @since 0.5.0
         # @api private
         def global_uri
-          raw.uri.sub(parsed_uri.select(:path).first, '')
+          uri.sub(parsed_uri.select(:path).first, '')
         end
 
         # Returns a boolean telling if a DB connection is from JDBC or not
@@ -101,7 +117,7 @@ module Hanami
         # @since 0.5.0
         # @api private
         def jdbc?
-          !raw.uri.scan('jdbc:').empty?
+          !uri.scan('jdbc:').empty?
         end
 
         # Returns database connection URI instance without JDBC namespace
@@ -109,7 +125,11 @@ module Hanami
         # @since 0.5.0
         # @api private
         def parsed_uri
-          @uri ||= URI.parse(raw.uri.sub('jdbc:', ''))
+          @uri ||= URI.parse(uri.sub('jdbc:', ''))
+        end
+
+        def schema
+          configuration.schema
         end
 
         # Return the database table for the given name
@@ -122,6 +142,10 @@ module Hanami
 
         private
 
+        # @since 1.0.0.beta1
+        # @api private
+        attr_reader :configuration
+
         # Returns a value of a given query string param
         #
         # @param option [String] which option from database connection will be extracted from URI
@@ -131,14 +155,6 @@ module Hanami
         def parsed_opt(option)
           parsed_uri.to_s.match(/[\?|\&]#{ option }=(\w+)\&?/).to_a.last
         end
-
-        # Fetch connection options from adapter
-        #
-        # @since 0.5.0
-        # @api private
-        def opts
-          raw.opts
-        end
       end
     end
   end

data/lib/hanami/model/migrator/logger.rb

@@ -0,0 +1,33 @@
+require 'hanami/logger'
+
+module Hanami
+  module Model
+    class Migrator
+      # Automatic logger for migrations
+      #
+      # @since 1.0.0.beta1
+      # @api private
+      class Logger < Hanami::Logger
+        # Formatter for migrations logger
+        #
+        # @since 1.0.0.beta1
+        # @api private
+        class Formatter < Hanami::Logger::Formatter
+          private
+
+          # @since 1.0.0.beta1
+          # @api private
+          def _format(hash)
+            "[hanami] [#{hash.fetch(:severity)}] #{hash.fetch(:message)}\n"
+          end
+        end
+
+        # @since 1.0.0.beta1
+        # @api private
+        def initialize(stream)
+          super(nil, stream: stream, formatter: Formatter.new)
+        end
+      end
+    end
+  end
+end

data/lib/hanami/model/migrator/mysql_adapter.rb

@@ -10,16 +10,19 @@ module Hanami
         # @api private
         PASSWORD = 'MYSQL_PWD'.freeze
 
+        # @since 1.0.0.beta1
+        # @api private
+        DB_CREATION_ERROR = 'Database creation failed. If the database exists, ' \
+                            'then its console may be open. See this issue for more details: ' \
+                            'https://github.com/hanami/model/issues/250'.freeze
+
         # @since 0.4.0
         # @api private
-        def create # rubocop:disable Metrics/MethodLength
+        def create
           new_connection(global: true).run %(CREATE DATABASE #{database};)
         rescue Sequel::DatabaseError => e
           message = if e.message.match(/database exists/) # rubocop:disable Performance/RedundantMatch
-                      "Database creation failed. If the database exists, \
-                         then its console may be open. See this issue for more details:\
-                         https://github.com/hanami/model/issues/250\
-                      "
+                      DB_CREATION_ERROR
                     else
                       e.message
                     end

data/lib/hanami/model/migrator/postgres_adapter.rb

@@ -22,17 +22,20 @@ module Hanami
         # @api private
         PASSWORD = 'PGPASSWORD'.freeze
 
+        # @since 1.0.0.beta1
+        # @api private
+        DB_CREATION_ERROR = 'createdb: database creation failed. If the database exists, ' \
+                            'then its console may be open. See this issue for more details: ' \
+                            'https://github.com/hanami/model/issues/250'.freeze
+
         # @since 0.4.0
         # @api private
-        def create # rubocop:disable Metrics/MethodLength
+        def create
           set_environment_variables
 
           call_db_command('createdb') do |error_message|
             message = if error_message.match(/already exists/) # rubocop:disable Performance/RedundantMatch
-                        "createdb: database creation failed. If the database exists, \
-                         then its console may be open. See this issue for more details:\
-                         https://github.com/hanami/model/issues/250\
-                        "
+                        DB_CREATION_ERROR
                       else
                         error_message
                       end

data/lib/hanami/model/migrator/sqlite_adapter.rb

@@ -29,7 +29,7 @@ module Hanami
         #
         # @since 0.4.0
         # @api private
-        def initialize(connection, configuration)
+        def initialize(configuration)
           super
           extend Memory if memory?
         end
@@ -70,7 +70,7 @@ module Hanami
         # @api private
         def path
           root.join(
-            @connection.uri.sub(/\A(jdbc:sqlite:|sqlite:\/\/)/, '')
+            @connection.uri.sub(/\A(jdbc:sqlite:\/\/|sqlite:\/\/)/, '')
           )
         end
 

data/lib/hanami/model/plugins/schema.rb

@@ -15,7 +15,7 @@ module Hanami
           # @api private
           def initialize(relation, input)
             super
-            @schema = relation.schema_hash
+            @schema = relation.input_schema
           end
 
           # Processes the input

data/lib/hanami/model/plugins/timestamps.rb

@@ -63,7 +63,7 @@ module Hanami
           # @since 0.7.0
           # @api private
           def _touch(value, now)
-            value[:updated_at] = now
+            value[:updated_at] ||= now
             value
           end
         end
@@ -79,7 +79,7 @@ module Hanami
           # @api private
           def _touch(value, now)
             super
-            value[:created_at] = now
+            value[:created_at] ||= now
             value
           end
         end

data/lib/hanami/model/sql.rb

@@ -145,6 +145,8 @@ module Hanami
     Error.register(ROM::SQL::UniqueConstraintError,     UniqueConstraintViolationError)
     Error.register(ROM::SQL::CheckConstraintError,      CheckConstraintViolationError)
     Error.register(ROM::SQL::ForeignKeyConstraintError, ForeignKeyConstraintViolationError)
+    Error.register(ROM::SQL::UnknownDBTypeError,        UnknownDatabaseTypeError)
+    Error.register(ROM::SQL::MissingPrimaryKeyError,    MissingPrimaryKeyError)
 
     Error.register(Java::JavaSql::SQLException, DatabaseError) if Utils.jruby?
   end

data/lib/hanami/model/sql/types.rb

@@ -60,9 +60,10 @@ module Hanami
           #
           # @since 0.7.0
           # @api private
-          def self.coercible(type)
-            return type if type.constrained?
-            MAPPING.fetch(type.with(meta: {}), type)
+          def self.coercible(attribute)
+            return attribute if attribute.constrained?
+            # TODO: figure out a better way of inferring coercions from schema types
+            MAPPING.fetch(attribute.type.with(meta: {}), attribute)
           end
 
           # Coercer for SQL associations target

data/lib/hanami/model/version.rb

@@ -3,6 +3,6 @@ module Hanami
     # Defines the version
     #
     # @since 0.1.0
-    VERSION = '0.7.0'.freeze
+    VERSION = '1.0.0.beta1'.freeze
   end
 end

data/lib/hanami/repository.rb

@@ -1,6 +1,7 @@
 require 'rom-repository'
 require 'hanami/model/entity_name'
 require 'hanami/model/relation_name'
+require 'hanami/model/mapped_relation'
 require 'hanami/model/associations/dsl'
 require 'hanami/model/association'
 require 'hanami/utils/class'
@@ -107,19 +108,6 @@ module Hanami
   # @see http://martinfowler.com/eaaCatalog/repository.html
   # @see http://en.wikipedia.org/wiki/Dependency_inversion_principle
   class Repository < ROM::Repository::Root
-    # Mapper name.
-    #
-    # With ROM mapping there is a link between the entity class and a generic
-    # reference for it. Example: <tt>BookRepository</tt> references <tt>Book</tt>
-    # as <tt>:entity</tt>.
-    #
-    # @since 0.7.0
-    # @api private
-    #
-    # @see Hanami::Repository.inherited
-    # @see Hanami::Repository.define_mapping
-    MAPPER_NAME = :entity
-
     # Plugins for database commands
     #
     # @since 0.7.0
@@ -151,24 +139,33 @@ module Hanami
     #
     # @since 0.7.0
     # @api private
-    def self.define_relation # rubocop:disable Metrics/MethodLength
+    #
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
+    def self.define_relation
       a = @associations
+      s = @schema
 
       configuration.relation(relation) do
-        schema(infer: true) do
-          associations(&a) unless a.nil?
+        if s.nil?
+          schema(infer: true) do
+            associations(&a) unless a.nil?
+          end
+        else
+          schema(&s)
         end
-
-        # rubocop:disable Lint/NestedMethodDefinition
-        def by_primary_key(id)
-          where(primary_key => id)
-        end
-        # rubocop:enable Lint/NestedMethodDefinition
       end
 
       relations(relation)
       root(relation)
+      class_eval %{
+        def #{relation}
+          Hanami::Model::MappedRelation.new(@#{relation})
+        end
+      }
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
 
     # Defines the ampping between a database table and an entity.
     #
@@ -186,7 +183,7 @@ module Hanami
 
       blk = lambda do |_|
         model       e
-        register_as MAPPER_NAME
+        register_as Model::MappedRelation.mapper_name
         instance_exec(&m) unless m.nil?
       end
 
@@ -225,6 +222,27 @@ module Hanami
       @associations = blk
     end
 
+    # Declare database schema
+    #
+    # NOTE: This should be used **only** when Hanami can't find a corresponding Ruby type for your column.
+    #
+    # @since 1.0.0.beta1
+    #
+    # @example
+    #   # In this example `name` is a PostgreSQL Enum type that we want to treat like a string.
+    #
+    #   class ColorRepository < Hanami::Repository
+    #     schema do
+    #       attribute :id,         Hanami::Model::Sql::Types::Int
+    #       attribute :name,       Hanami::Model::Sql::Types::String
+    #       attribute :created_at, Hanami::Model::Sql::Types::DateTime
+    #       attribute :updated_at, Hanami::Model::Sql::Types::DateTime
+    #     end
+    #   end
+    def self.schema(&blk)
+      @schema = blk
+    end
+
     # Declare mapping between database columns and entity's attributes
     #
     # NOTE: This should be used **only** when there is a name mismatch (eg. in legacy databases).
@@ -268,7 +286,7 @@ module Hanami
         class_attribute :relation
         self.relation = Model::RelationName.new(name)
 
-        commands :create, update: :by_primary_key, delete: :by_primary_key, mapper: MAPPER_NAME, use: COMMAND_PLUGINS
+        commands :create, update: :by_pk, delete: :by_pk, mapper: Model::MappedRelation.mapper_name, use: COMMAND_PLUGINS
         prepend Commands
       end
 
@@ -364,6 +382,9 @@ module Hanami
     #
     # @return [Hanami::Entity,NilClass] the entity, if found
     #
+    # @raise [Hanami::Model::MissingPrimaryKeyError] if the table doesn't
+    #   define a primary key
+    #
     # @since 0.7.0
     #
     # @example
@@ -372,7 +393,9 @@ module Hanami
     #
     #   user       = repository.find(user.id)
     def find(id)
-      root.by_primary_key(id).as(:entity).one
+      root.by_pk(id).as(:entity).one
+    rescue => e
+      raise Hanami::Model::Error.for(e)
     end
 
     # Return all the records for the relation

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanami-model
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 1.0.0.beta1
 platform: ruby
 authors:
 - Luca Guidi
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-15 00:00:00.000000000 Z
+date: 2017-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hanami-utils
@@ -18,42 +18,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 1.0.0.beta
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 1.0.0.beta
 - !ruby/object:Gem::Dependency
   name: rom-sql
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rom-repository
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: dry-types
   requirement: !ruby/object:Gem::Requirement
@@ -149,11 +149,13 @@ files:
 - lib/hanami/model/configurator.rb
 - lib/hanami/model/entity_name.rb
 - lib/hanami/model/error.rb
+- lib/hanami/model/mapped_relation.rb
 - lib/hanami/model/mapping.rb
 - lib/hanami/model/migration.rb
 - lib/hanami/model/migrator.rb
 - lib/hanami/model/migrator/adapter.rb
 - lib/hanami/model/migrator/connection.rb
+- lib/hanami/model/migrator/logger.rb
 - lib/hanami/model/migrator/mysql_adapter.rb
 - lib/hanami/model/migrator/postgres_adapter.rb
 - lib/hanami/model/migrator/sqlite_adapter.rb
@@ -189,12 +191,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: A persistence layer for Hanami