hanami-model 1.3.2 → 1.3.3

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
@@ -136,10 +138,10 @@ module Hanami
       # @api private
       def rom
         @rom ||= ROM::Configuration.new(@backend, @url, infer_relations: false)
-      rescue => e
-        raise UnknownDatabaseAdapterError.new(@url) if e.message =~ /adapters/
+      rescue => exception
+        raise UnknownDatabaseAdapterError.new(@url) if exception.message =~ /adapters/
 
-        raise e
+        raise exception
       end
 
       # @raise [Hanami::Model::UnknownDatabaseAdapterError] if `url` is blank,
@@ -147,7 +149,7 @@ module Hanami
       #
       # @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
@@ -157,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.
@@ -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

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.

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

@@ -1,4 +1,6 @@
-require 'cgi'
+# frozen_string_literal: true
+
+require "cgi"
 
 module Hanami
   module Model
@@ -36,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
@@ -46,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
@@ -85,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
@@ -95,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
@@ -111,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
@@ -119,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
@@ -127,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

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

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Hanami
   module Model
     class Migrator
@@ -8,23 +10,27 @@ module Hanami
       class MySQLAdapter < Adapter
         # @since 0.7.0
         # @api private
-        PASSWORD = 'MYSQL_PWD'.freeze
+        PASSWORD = "MYSQL_PWD"
+
+        # @since 1.3.3
+        # @api private
+        DEFAULT_PORT = 3306
 
         # @since 1.0.0
         # @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
+        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"
 
         # @since 0.4.0
         # @api private
         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
+        rescue Sequel::DatabaseError => exception
+          message = if exception.message.match(/database exists/)
                       DB_CREATION_ERROR
                     else
-                      e.message
+                      exception.message
                     end
 
           raise MigrationError.new(message)
@@ -34,11 +40,11 @@ module Hanami
         # @api private
         def drop
           new_connection(global: true).run %(DROP DATABASE `#{database}`;)
-        rescue Sequel::DatabaseError => e
-          message = if e.message.match(/doesn\'t exist/) # rubocop:disable Performance/RedundantMatch
+        rescue Sequel::DatabaseError => exception
+          message = if exception.message.match(/doesn\'t exist/)
                       "Cannot find database: #{database}"
                     else
-                      e.message
+                      exception.message
                     end
 
           raise MigrationError.new(message)
@@ -65,22 +71,26 @@ module Hanami
           connection.password
         end
 
+        def port
+          super || DEFAULT_PORT
+        end
+
         # @since 0.4.0
         # @api private
         def dump_structure
-          execute "mysqldump --host=#{host} --port=#{port} --user=#{username} --no-data --skip-comments --ignore-table=#{database}.#{migrations_table} #{database} > #{schema}", env: { PASSWORD => password }
+          execute "mysqldump --host=#{host} --port=#{port} --user=#{username} --no-data --skip-comments --ignore-table=#{database}.#{migrations_table} #{database} > #{schema}", env: {PASSWORD => password}
         end
 
         # @since 0.4.0
         # @api private
         def load_structure
-          execute("mysql --host=#{host} --port=#{port} --user=#{username} #{database} < #{escape(schema)}", env: { PASSWORD => password }) if schema.exist?
+          execute("mysql --host=#{host} --port=#{port} --user=#{username} #{database} < #{escape(schema)}", env: {PASSWORD => password}) if schema.exist?
         end
 
         # @since 0.4.0
         # @api private
         def dump_migrations_data
-          execute "mysqldump --host=#{host} --port=#{port} --user=#{username} --skip-comments #{database} #{migrations_table} >> #{schema}", env: { PASSWORD => password }
+          execute "mysqldump --host=#{host} --port=#{port} --user=#{username} --skip-comments #{database} #{migrations_table} >> #{schema}", env: {PASSWORD => password}
         end
       end
     end

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

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require "hanami/utils/blank"
+
 module Hanami
   module Model
     class Migrator
@@ -8,46 +12,41 @@ module Hanami
       class PostgresAdapter < Adapter
         # @since 0.4.0
         # @api private
-        HOST     = 'PGHOST'.freeze
+        HOST     = "PGHOST"
 
         # @since 0.4.0
         # @api private
-        PORT     = 'PGPORT'.freeze
+        PORT     = "PGPORT"
 
         # @since 0.4.0
         # @api private
-        USER     = 'PGUSER'.freeze
+        USER     = "PGUSER"
 
         # @since 0.4.0
         # @api private
-        PASSWORD = 'PGPASSWORD'.freeze
+        PASSWORD = "PGPASSWORD"
 
         # @since 1.0.0
         # @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
+        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"
 
         # @since 0.4.0
         # @api private
         def create
-          set_environment_variables
-
-          call_db_command('createdb')
+          call_db_command("createdb")
         end
 
         # @since 0.4.0
         # @api private
         def drop
-          set_environment_variables
-
-          call_db_command('dropdb')
+          call_db_command("dropdb")
         end
 
         # @since 0.4.0
         # @api private
         def dump
-          set_environment_variables
           dump_structure
           dump_migrations_data
         end
@@ -55,51 +54,54 @@ module Hanami
         # @since 0.4.0
         # @api private
         def load
-          set_environment_variables
           load_structure
         end
 
         private
 
-        # @since 0.4.0
+        # @since 1.3.3
         # @api private
-        def set_environment_variables
-          ENV[HOST]     = host      unless host.nil?
-          ENV[PORT]     = port.to_s unless port.nil?
-          ENV[PASSWORD] = password  unless password.nil?
-          ENV[USER]     = username  unless username.nil?
+        def environment_variables
+          {}.tap do |env|
+            env[HOST] = host unless host.nil?
+            env[PORT] = port.to_s unless port.nil?
+            env[PASSWORD] = password unless password.nil?
+            env[USER] = username unless username.nil?
+          end
         end
 
         # @since 0.4.0
         # @api private
         def dump_structure
-          execute "pg_dump -s -x -O -T #{migrations_table} -f #{escape(schema)} #{database}"
+          execute "pg_dump -s -x -O -T #{migrations_table} -f #{escape(schema)} #{database}", env: environment_variables
         end
 
         # @since 0.4.0
         # @api private
         def load_structure
-          execute "psql -X -q -f #{escape(schema)} #{database}" if schema.exist?
+          return unless schema.exist?
+
+          execute "psql -X -q -f #{escape(schema)} #{database}", env: environment_variables
         end
 
         # @since 0.4.0
         # @api private
         def dump_migrations_data
           error = ->(err) { raise MigrationError.new(err) unless err =~ /no matching tables/i }
-          execute "pg_dump -t #{migrations_table} #{database} >> #{escape(schema)}", error: error
+          execute "pg_dump -t #{migrations_table} #{database} >> #{escape(schema)}", error: error, env: environment_variables
         end
 
         # @since 0.5.1
         # @api private
         def call_db_command(command)
-          require 'open3'
+          require "open3"
 
           begin
-            Open3.popen3(command, database) do |_stdin, _stdout, stderr, wait_thr|
+            Open3.popen3(environment_variables, command, database) do |_stdin, _stdout, stderr, wait_thr|
               raise MigrationError.new(modified_message(stderr.read)) unless wait_thr.value.success? # wait_thr.value is the exit status
             end
-          rescue SystemCallError => e
-            raise MigrationError.new(modified_message(e.message))
+          rescue SystemCallError => exception
+            raise MigrationError.new(modified_message(exception.message))
           end
         end