hanami-model 1.2.0 → 1.3.3

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "hanami/utils/hash"
 
 module Hanami
@@ -7,7 +9,7 @@ module Hanami
       #
       # @since 0.7.0
       # @api private
-      class ManyToMany # rubocop:disable Metrics/ClassLength
+      class ManyToMany
         # @since 0.7.0
         # @api private
         def self.schema_type(entity)
@@ -76,8 +78,8 @@ module Hanami
         def add(*data)
           command(:create, relation(through), use: [:timestamps])
             .call(associate(serialize(data)))
-        rescue => e
-          raise Hanami::Model::Error.for(e)
+        rescue => exception
+          raise Hanami::Model::Error.for(exception)
         end
 
         # @since 1.1.0
@@ -88,18 +90,16 @@ module Hanami
 
         # @since 1.1.0
         # @api private
-        # rubocop:disable Metrics/AbcSize
         def remove(target_id)
           association_record = relation(through)
-                               .where(target_foreign_key => target_id, source_foreign_key => subject.fetch(source_primary_key))
-                               .one
+            .where(target_foreign_key => target_id, source_foreign_key => subject.fetch(source_primary_key))
+            .one
 
           return if association_record.nil?
 
           ar_id = association_record.public_send relation(through).primary_key
           command(:delete, relation(through)).by_pk(ar_id).call
         end
-        # rubocop:enable Metrics/AbcSize
 
         private
 
@@ -172,17 +172,15 @@ module Hanami
         # @since 1.1.0
         #
         # @api private
-        # rubocop:disable Metrics/AbcSize
         def _build_scope
           result = relation(association.target.to_sym).qualified
           unless subject.nil?
             result = result
-                     .join(through, target_foreign_key => target_primary_key)
-                     .where(source_foreign_key => subject.fetch(source_primary_key))
+              .join(through, target_foreign_key => target_primary_key)
+              .where(source_foreign_key => subject.fetch(source_primary_key))
           end
           result.as(Model::MappedRelation.mapper_name)
         end
-        # rubocop:enable Metrics/AbcSize
 
         # @since 1.1.0
         # @api private

data/lib/hanami/model/configuration.rb

@@ -1,4 +1,6 @@
-require 'rom/configuration'
+# frozen_string_literal: true
+
+require "rom/configuration"
 
 module Hanami
   module Model
@@ -30,13 +32,13 @@ module Hanami
       def initialize(configurator)
         @backend = configurator.backend
         @url = configurator.url
-        @migrations        = configurator._migrations
-        @schema            = configurator._schema
-        @gateway_config    = configurator._gateway
-        @logger            = configurator._logger
+        @migrations = configurator._migrations
+        @schema = configurator._schema
+        @gateway_config = configurator._gateway
+        @logger = configurator._logger
         @migrations_logger = configurator.migrations_logger
-        @mappings          = {}
-        @entities          = {}
+        @mappings = {}
+        @entities = {}
       end
 
       # NOTE: This must be changed when we want to support several adapters at the time
@@ -47,6 +49,9 @@ module Hanami
 
       # NOTE: This must be changed when we want to support several adapters at the time
       #
+      # @raise [Hanami::Model::UnknownDatabaseAdapterError] if `url` is blank,
+      #   or it uses an unknown adapter.
+      #
       # @since 0.7.0
       # @api private
       def connection
@@ -55,6 +60,9 @@ module Hanami
 
       # NOTE: This must be changed when we want to support several adapters at the time
       #
+      # @raise [Hanami::Model::UnknownDatabaseAdapterError] if `url` is blank,
+      #   or it uses an unknown adapter.
+      #
       # @since 0.7.0
       # @api private
       def gateway
@@ -119,18 +127,29 @@ module Hanami
       # @api private
       def logger=(value)
         return if value.nil?
+
         gateway.use_logger(@logger = value)
       end
 
+      # @raise [Hanami::Model::UnknownDatabaseAdapterError] if `url` is blank,
+      #   or it uses an unknown adapter.
+      #
       # @since 1.0.0
       # @api private
       def rom
         @rom ||= ROM::Configuration.new(@backend, @url, infer_relations: false)
+      rescue => exception
+        raise UnknownDatabaseAdapterError.new(@url) if exception.message =~ /adapters/
+
+        raise exception
       end
 
+      # @raise [Hanami::Model::UnknownDatabaseAdapterError] if `url` is blank,
+      #   or it uses an unknown adapter.
+      #
       # @since 1.0.0
       # @api private
-      def load!(repositories, &blk) # rubocop:disable Metrics/AbcSize
+      def load!(repositories, &blk)
         rom.setup.auto_registration(config.directory.to_s) unless config.directory.nil?
         rom.instance_eval(&blk)                            if     block_given?
         configure_gateway
@@ -140,8 +159,8 @@ module Hanami
         container = ROM.container(rom)
         define_entities_mappings(container, repositories)
         container
-      rescue => e
-        raise Hanami::Model::Error.for(e)
+      rescue => exception
+        raise Hanami::Model::Error.for(exception)
       end
 
       # @since 1.0.0

data/lib/hanami/model/configurator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Hanami
   module Model
     # Configuration DSL
@@ -42,7 +44,7 @@ module Hanami
       # @since 1.0.0
       # @api private
       def migrations_logger(stream = $stdout)
-        require 'hanami/model/migrator/logger'
+        require "hanami/model/migrator/logger"
         @migrations_logger ||= Hanami::Model::Migrator::Logger.new(stream)
       end
 
@@ -76,10 +78,10 @@ module Hanami
       # @since 1.0.0
       # @api private
       def logger(stream, options = {})
-        require 'hanami/logger'
+        require "hanami/logger"
 
         opts = options.merge(stream: stream)
-        @_logger = Hanami::Logger.new('hanami.model', opts)
+        @_logger = Hanami::Logger.new("hanami.model", **opts)
       end
 
       # @since 1.0.0

data/lib/hanami/model/entity_name.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Hanami
   module Model
     # Conventional name for entities.
@@ -10,7 +12,7 @@ module Hanami
     class EntityName
       # @since 0.7.0
       # @api private
-      SUFFIX = /Repository\z/
+      SUFFIX = /Repository\z/.freeze
 
       # @param name [Class,String] the class or its name
       # @return [String] the entity name
@@ -18,7 +20,7 @@ module Hanami
       # @since 0.7.0
       # @api private
       def initialize(name)
-        @name = name.sub(SUFFIX, '')
+        @name = name.sub(SUFFIX, "")
       end
 
       # @since 0.7.0

data/lib/hanami/model/error.rb

@@ -1,4 +1,6 @@
-require 'concurrent'
+# frozen_string_literal: true
+
+require "concurrent"
 
 module Hanami
   module Model
@@ -41,7 +43,7 @@ module Hanami
     class InvalidCommandError < Error
       # @since 0.5.0
       # @api private
-      def initialize(message = 'Invalid command')
+      def initialize(message = "Invalid command")
         super
       end
     end
@@ -52,7 +54,7 @@ module Hanami
     class ConstraintViolationError < Error
       # @since 0.7.0
       # @api private
-      def initialize(message = 'Constraint has been violated')
+      def initialize(message = "Constraint has been violated")
         super
       end
     end
@@ -63,7 +65,7 @@ module Hanami
     class UniqueConstraintViolationError < ConstraintViolationError
       # @since 0.6.1
       # @api private
-      def initialize(message = 'Unique constraint has been violated')
+      def initialize(message = "Unique constraint has been violated")
         super
       end
     end
@@ -74,7 +76,7 @@ module Hanami
     class ForeignKeyConstraintViolationError < ConstraintViolationError
       # @since 0.6.1
       # @api private
-      def initialize(message = 'Foreign key constraint has been violated')
+      def initialize(message = "Foreign key constraint has been violated")
         super
       end
     end
@@ -85,7 +87,7 @@ module Hanami
     class NotNullConstraintViolationError < ConstraintViolationError
       # @since 0.6.1
       # @api private
-      def initialize(message = 'NOT NULL constraint has been violated')
+      def initialize(message = "NOT NULL constraint has been violated")
         super
       end
     end
@@ -96,7 +98,7 @@ module Hanami
     class CheckConstraintViolationError < ConstraintViolationError
       # @since 0.6.1
       # @api private
-      def initialize(message = 'Check constraint has been violated')
+      def initialize(message = "Check constraint has been violated")
         super
       end
     end
@@ -118,5 +120,14 @@ module Hanami
     # @since 1.2.0
     class UnknownAttributeError < Error
     end
+
+    # Unknown database adapter error
+    #
+    # @since 1.2.1
+    class UnknownDatabaseAdapterError < Error
+      def initialize(url)
+        super("Unknown database adapter for URL: #{url.inspect}. Please check your database configuration (hint: ENV['DATABASE_URL']).")
+      end
+    end
   end
 end

data/lib/hanami/model/mapped_relation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Hanami
   module Model
     # Mapped proxy for ROM relations.
@@ -51,8 +53,8 @@ module Hanami
       #   end
       def [](attribute)
         @relation[attribute]
-      rescue KeyError => e
-        raise UnknownAttributeError.new(e.message)
+      rescue KeyError => exception
+        raise UnknownAttributeError.new(exception.message)
       end
     end
   end

data/lib/hanami/model/mapping.rb

@@ -1,4 +1,6 @@
-require 'transproc/all'
+# frozen_string_literal: true
+
+require "transproc/all"
 
 module Hanami
   module Model

data/lib/hanami/model/migration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Hanami
   module Model
     # Database migration

data/lib/hanami/model/migrator.rb

@@ -1,5 +1,7 @@
-require 'sequel'
-require 'sequel/extensions/migration'
+# frozen_string_literal: true
+
+require "sequel"
+require "sequel/extensions/migration"
 
 module Hanami
   module Model
@@ -13,8 +15,8 @@ module Hanami
     #
     # @since 0.4.0
     class Migrator
-      require 'hanami/model/migrator/connection'
-      require 'hanami/model/migrator/adapter'
+      require "hanami/model/migrator/connection"
+      require "hanami/model/migrator/adapter"
 
       # Create database defined by current configuration.
       #
@@ -327,7 +329,7 @@ module Hanami
       # @see Hanami::Model::Migrator.prepare
       def prepare
         drop
-      rescue # rubocop:disable Lint/HandleExceptions
+      rescue # rubocop:disable Lint/SuppressedException
       ensure
         create
         adapter.load

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

@@ -1,6 +1,8 @@
-require 'uri'
-require 'shellwords'
-require 'open3'
+# frozen_string_literal: true
+
+require "uri"
+require "shellwords"
+require "open3"
 
 module Hanami
   module Model
@@ -26,18 +28,18 @@ module Hanami
         #
         # @since 0.4.0
         # @api private
-        def self.for(configuration) # rubocop:disable Metrics/MethodLength
+        def self.for(configuration)
           connection = Connection.new(configuration)
 
           case connection.database_type
           when :sqlite
-            require 'hanami/model/migrator/sqlite_adapter'
+            require "hanami/model/migrator/sqlite_adapter"
             SQLiteAdapter
           when :postgres
-            require 'hanami/model/migrator/postgres_adapter'
+            require "hanami/model/migrator/postgres_adapter"
             PostgresAdapter
           when :mysql
-            require 'hanami/model/migrator/mysql_adapter'
+            require "hanami/model/migrator/mysql_adapter"
             MySQLAdapter
           else
             self
@@ -80,8 +82,8 @@ module Hanami
           version = Integer(version) unless version.nil?
 
           Sequel::Migrator.run(connection.raw, migrations, target: version, allow_missing_migration_files: true)
-        rescue Sequel::Migrator::Error => e
-          raise MigrationError.new(e.message)
+        rescue Sequel::Migrator::Error => exception
+          raise MigrationError.new(exception.message)
         end
 
         # @since 1.1.0
@@ -91,8 +93,8 @@ module Hanami
           version = version_to_rollback(table, steps)
 
           Sequel::Migrator.run(connection.raw, migrations, target: version, allow_missing_migration_files: true)
-        rescue Sequel::Migrator::Error => e
-          raise MigrationError.new(e.message)
+        rescue Sequel::Migrator::Error => exception
+          raise MigrationError.new(exception.message)
         end
 
         # Load database schema.
@@ -124,7 +126,7 @@ module Hanami
 
         # @since 1.1.0
         # @api private
-        MIGRATIONS_FILE_NAME_PATTERN = /\A[\d]{14}/
+        MIGRATIONS_FILE_NAME_PATTERN = /\A[\d]{14}/.freeze
 
         # @since 1.1.0
         # @api private

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

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require "cgi"
+
 module Hanami
   module Model
     class Migrator
@@ -34,7 +38,7 @@ module Hanami
         # @since 0.5.0
         # @api private
         def host
-          @host ||= parsed_uri.host || parsed_opt('host')
+          @host ||= parsed_uri.host || parsed_opt("host")
         end
 
         # Returns DB connection port
@@ -44,7 +48,7 @@ module Hanami
         # @since 0.5.0
         # @api private
         def port
-          @port ||= parsed_uri.port || parsed_opt('port').to_i.nonzero?
+          @port ||= parsed_uri.port || parsed_opt("port").to_i.nonzero?
         end
 
         # Returns DB name from conenction
@@ -83,7 +87,7 @@ module Hanami
         # @since 0.5.0
         # @api private
         def user
-          @user ||= parsed_opt('user') || parsed_uri.user
+          @user ||= parsed_opt("user") || parsed_uri.user
         end
 
         # Returns user from DB connection
@@ -93,7 +97,7 @@ module Hanami
         # @since 0.5.0
         # @api private
         def password
-          @password ||= parsed_opt('password') || parsed_uri.password
+          @password ||= parsed_opt("password") || parsed_uri.password
         end
 
         # Returns DB connection URI directly from adapter
@@ -109,7 +113,7 @@ module Hanami
         # @since 0.5.0
         # @api private
         def global_uri
-          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
@@ -117,7 +121,7 @@ module Hanami
         # @since 0.5.0
         # @api private
         def jdbc?
-          !uri.scan('jdbc:').empty?
+          !uri.scan("jdbc:").empty?
         end
 
         # Returns database connection URI instance without JDBC namespace
@@ -125,7 +129,7 @@ module Hanami
         # @since 0.5.0
         # @api private
         def parsed_uri
-          @parsed_uri ||= URI.parse(uri.sub('jdbc:', ''))
+          @parsed_uri ||= URI.parse(uri.sub("jdbc:", ""))
         end
 
         # @api private
@@ -153,8 +157,11 @@ module Hanami
         #
         # @since 0.5.0
         # @api private
-        def parsed_opt(option)
-          parsed_uri.to_s.match(/[\?|\&]#{ option }=(\w+)\&?/).to_a.last
+        def parsed_opt(option, query: parsed_uri.query)
+          return if query.nil?
+
+          @parsed_query_opts ||= CGI.parse(query)
+          @parsed_query_opts[option].to_a.last
         end
       end
     end