hanami-model 1.2.0 → 1.3.3

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,53 +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|
-              unless wait_thr.value.success? # wait_thr.value is the exit status
-                raise MigrationError.new(modified_message(stderr.read))
-              end
+            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
 

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

@@ -1,6 +1,8 @@
-require 'pathname'
-require 'hanami/utils'
-require 'English'
+# frozen_string_literal: true
+
+require "pathname"
+require "hanami/utils"
+require "English"
 
 module Hanami
   module Model
@@ -71,7 +73,7 @@ module Hanami
         # @api private
         def path
           root.join(
-            @connection.uri.sub(/\A(jdbc:sqlite:\/\/|sqlite:\/\/)/, '')
+            @connection.uri.sub(/\A(jdbc:sqlite:\/\/|sqlite:\/\/)/, "")
           )
         end
 
@@ -104,13 +106,11 @@ module Hanami
         # @since 0.4.0
         # @api private
         #
-        # rubocop:disable Metrics/AbcSize
-        # rubocop:disable Metrics/MethodLength
         def dump_migrations_data
           execute "sqlite3 #{escape(path)} .dump" do |stdout|
             begin
               contents = stdout.read.split($INPUT_RECORD_SEPARATOR)
-              contents = contents.grep(/^INSERT INTO "#{migrations_table}"/)
+              contents = contents.grep(/^INSERT INTO "?#{migrations_table}"?/)
 
               ::File.open(schema, ::File::CREAT | ::File::BINARY | ::File::WRONLY | ::File::APPEND) do |file|
                 file.write(contents.join($INPUT_RECORD_SEPARATOR))
@@ -120,8 +120,6 @@ module Hanami
             end
           end
         end
-        # rubocop:enable Metrics/MethodLength
-        # rubocop:enable Metrics/AbcSize
       end
     end
   end

data/lib/hanami/model/plugins.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Hanami
   module Model
     # Plugins to extend read/write operations from/to the database
@@ -17,9 +19,9 @@ module Hanami
         end
       end
 
-      require 'hanami/model/plugins/mapping'
-      require 'hanami/model/plugins/schema'
-      require 'hanami/model/plugins/timestamps'
+      require "hanami/model/plugins/mapping"
+      require "hanami/model/plugins/schema"
+      require "hanami/model/plugins/timestamps"
     end
   end
 end

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

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

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

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Hanami
   module Model
     module Plugins
@@ -32,6 +34,7 @@ module Hanami
           # @api private
           def [](value)
             return @input[value] unless timestamps?
+
             _touch(@input[value], Time.now)
           end
 

data/lib/hanami/model/relation_name.rb

@@ -1,5 +1,7 @@
-require_relative 'entity_name'
-require 'hanami/utils/string'
+# frozen_string_literal: true
+
+require_relative "entity_name"
+require "hanami/utils/string"
 
 module Hanami
   module Model

data/lib/hanami/model/sql.rb

@@ -1,12 +1,14 @@
-require 'rom-sql'
-require 'hanami/utils'
+# frozen_string_literal: true
+
+require "rom-sql"
+require "hanami/utils"
 
 module Hanami
   # Hanami::Model migrations
   module Model
-    require 'hanami/model/error'
-    require 'hanami/model/association'
-    require 'hanami/model/migration'
+    require "hanami/model/error"
+    require "hanami/model/association"
+    require "hanami/model/migration"
 
     # Define a migration
     #
@@ -53,8 +55,8 @@ module Hanami
     #
     # @since 0.7.0
     module Sql
-      require 'hanami/model/sql/types'
-      require 'hanami/model/sql/entity/schema'
+      require "hanami/model/sql/types"
+      require "hanami/model/sql/entity/schema"
 
       # Returns a SQL fragment that references a database function by the given name
       # This is useful for database migrations

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

@@ -1,4 +1,6 @@
-require 'uri'
+# frozen_string_literal: true
+
+require "uri"
 
 module Hanami
   module Model
@@ -24,16 +26,16 @@ module Hanami
 
         # @since 0.7.0
         # @api private
-        def console # rubocop:disable Metrics/MethodLength
+        def console
           case @uri.scheme
-          when 'sqlite'
-            require 'hanami/model/sql/consoles/sqlite'
+          when "sqlite"
+            require "hanami/model/sql/consoles/sqlite"
             Sql::Consoles::Sqlite.new(@uri)
-          when 'postgres', 'postgresql'
-            require 'hanami/model/sql/consoles/postgresql'
+          when "postgres", "postgresql"
+            require "hanami/model/sql/consoles/postgresql"
             Sql::Consoles::Postgresql.new(@uri)
-          when 'mysql', 'mysql2'
-            require 'hanami/model/sql/consoles/mysql'
+          when "mysql", "mysql2"
+            require "hanami/model/sql/consoles/mysql"
             Sql::Consoles::Mysql.new(@uri)
           end
         end

data/lib/hanami/model/sql/consoles/abstract.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Hanami
   module Model
     module Sql
@@ -18,7 +20,7 @@ module Hanami
           # @since 0.7.0
           # @api private
           def database_name
-            @uri.path.sub(/^\//, '')
+            @uri.path.sub(/^\//, "")
           end
 
           # @since 0.7.0

data/lib/hanami/model/sql/consoles/mysql.rb

@@ -1,4 +1,6 @@
-require_relative 'abstract'
+# frozen_string_literal: true
+
+require_relative "abstract"
 
 module Hanami
   module Model
@@ -11,7 +13,7 @@ module Hanami
         class Mysql < Abstract
           # @since 0.7.0
           # @api private
-          COMMAND = 'mysql'.freeze
+          COMMAND = "mysql"
 
           # @since 0.7.0
           # @api private

data/lib/hanami/model/sql/consoles/postgresql.rb

@@ -1,5 +1,7 @@
-require_relative 'abstract'
-require 'cgi'
+# frozen_string_literal: true
+
+require_relative "abstract"
+require "cgi"
 
 module Hanami
   module Model
@@ -12,11 +14,11 @@ module Hanami
         class Postgresql < Abstract
           # @since 0.7.0
           # @api private
-          COMMAND = 'psql'.freeze
+          COMMAND = "psql"
 
           # @since 0.7.0
           # @api private
-          PASSWORD = 'PGPASSWORD'.freeze
+          PASSWORD = "PGPASSWORD"
 
           # @since 0.7.0
           # @api private
@@ -48,22 +50,22 @@ module Hanami
           # @since 0.7.0
           # @api private
           def port
-            port = query['port'] || @uri.port
+            port = query["port"] || @uri.port
             " -p #{port}" if port
           end
 
           # @since 0.7.0
           # @api private
           def username
-            username = query['user'] || @uri.user
+            username = query["user"] || @uri.user
             " -U #{username}" if username
           end
 
           # @since 0.7.0
           # @api private
           def configure_password
-            password = query['password'] || @uri.password
-            ENV[PASSWORD] = CGI.unescape(query['password'] || @uri.password) if password
+            password = query["password"] || @uri.password
+            ENV[PASSWORD] = CGI.unescape(query["password"] || @uri.password) if password
           end
 
           # @since 1.1.0