hanami-model 0.6.1 → 0.7.0

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

@@ -1,6 +1,6 @@
 module Hanami
   module Model
-    module Migrator
+    class Migrator
       # Sequel connection wrapper
       #
       # Normalize external adapters interfaces
@@ -8,10 +8,14 @@ module Hanami
       # @since 0.5.0
       # @api private
       class Connection
-        attr_reader :adapter_connection
+        # @since 0.7.0
+        # @api private
+        attr_reader :raw
 
-        def initialize(adapter_connection)
-          @adapter_connection = adapter_connection
+        # @since 0.5.0
+        # @api private
+        def initialize(raw)
+          @raw = raw
         end
 
         # Returns DB connection host
@@ -48,12 +52,12 @@ module Hanami
         #
         # @example
         #   connection.database_type
-        #   # => 'postgres'
+        #     # => 'postgres'
         #
         # @since 0.5.0
         # @api private
         def database_type
-          adapter_connection.database_type
+          raw.database_type
         end
 
         # Returns user from DB connection
@@ -81,7 +85,7 @@ module Hanami
         # @since 0.5.0
         # @api private
         def uri
-          adapter_connection.uri
+          raw.uri
         end
 
         # Returns DB connection wihout specifying database name
@@ -89,7 +93,7 @@ module Hanami
         # @since 0.5.0
         # @api private
         def global_uri
-          adapter_connection.uri.sub(parsed_uri.select(:path).first, '')
+          raw.uri.sub(parsed_uri.select(:path).first, '')
         end
 
         # Returns a boolean telling if a DB connection is from JDBC or not
@@ -97,7 +101,7 @@ module Hanami
         # @since 0.5.0
         # @api private
         def jdbc?
-          !adapter_connection.uri.scan('jdbc:').empty?
+          !raw.uri.scan('jdbc:').empty?
         end
 
         # Returns database connection URI instance without JDBC namespace
@@ -105,7 +109,15 @@ module Hanami
         # @since 0.5.0
         # @api private
         def parsed_uri
-          @uri ||= URI.parse(adapter_connection.uri.sub('jdbc:', ''))
+          @uri ||= URI.parse(raw.uri.sub('jdbc:', ''))
+        end
+
+        # Return the database table for the given name
+        #
+        # @since 0.7.0
+        # @api private
+        def table(name)
+          raw[name] if raw.tables.include?(name)
         end
 
         private
@@ -125,7 +137,7 @@ module Hanami
         # @since 0.5.0
         # @api private
         def opts
-          adapter_connection.opts
+          raw.opts
         end
       end
     end

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

@@ -1,21 +1,28 @@
 module Hanami
   module Model
-    module Migrator
+    class Migrator
       # MySQL adapter
       #
       # @since 0.4.0
       # @api private
       class MySQLAdapter < Adapter
+        # @since 0.7.0
+        # @api private
+        PASSWORD = 'MYSQL_PWD'.freeze
+
         # @since 0.4.0
         # @api private
-        def create
-          new_connection(global: true).run %(CREATE DATABASE #{ database };)
+        def create # rubocop:disable Metrics/MethodLength
+          new_connection(global: true).run %(CREATE DATABASE #{database};)
         rescue Sequel::DatabaseError => e
-          message = if e.message.match(/database exists/)
-            "Database creation failed. There is 1 other session using the database"
-          else
-            e.message
-          end
+          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\
+                      "
+                    else
+                      e.message
+                    end
 
           raise MigrationError.new(message)
         end
@@ -23,13 +30,13 @@ module Hanami
         # @since 0.4.0
         # @api private
         def drop
-          new_connection(global: true).run %(DROP DATABASE #{ database };)
+          new_connection(global: true).run %(DROP DATABASE #{database};)
         rescue Sequel::DatabaseError => e
-          message = if e.message.match(/doesn\'t exist/)
-            "Cannot find database: #{ database }"
-          else
-            e.message
-          end
+          message = if e.message.match(/doesn\'t exist/) # rubocop:disable Performance/RedundantMatch
+                      "Cannot find database: #{database}"
+                    else
+                      e.message
+                    end
 
           raise MigrationError.new(message)
         end
@@ -37,6 +44,7 @@ module Hanami
         # @since 0.4.0
         # @api private
         def dump
+          set_environment_variables
           dump_structure
           dump_migrations_data
         end
@@ -44,27 +52,40 @@ module Hanami
         # @since 0.4.0
         # @api private
         def load
+          set_environment_variables
           load_structure
         end
 
         private
 
+        # @since 0.7.0
+        # @api private
+        def set_environment_variables
+          ENV[PASSWORD] = password unless password.nil?
+        end
+
+        # @since 0.7.0
+        # @api private
+        def password
+          connection.password
+        end
+
         # @since 0.4.0
         # @api private
         def dump_structure
-          system "mysqldump --user=#{ username } --password=#{ password } --no-data --skip-comments --ignore-table=#{ database }.#{ migrations_table } #{ database } > #{ schema }"
+          system "mysqldump --user=#{username} --no-data --skip-comments --ignore-table=#{database}.#{migrations_table} #{database} > #{schema}"
         end
 
         # @since 0.4.0
         # @api private
         def load_structure
-          system "mysql --user=#{ username } --password=#{ password } #{ database } < #{ escape(schema) }" if schema.exist?
+          system "mysql --user=#{username} #{database} < #{escape(schema)}" if schema.exist?
         end
 
         # @since 0.4.0
         # @api private
         def dump_migrations_data
-          system "mysqldump --user=#{ username } --password=#{ password } --skip-comments #{ database } #{ migrations_table } >> #{ schema }"
+          system "mysqldump --user=#{username} --skip-comments #{database} #{migrations_table} >> #{schema}"
         end
       end
     end

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

@@ -1,6 +1,6 @@
 module Hanami
   module Model
-    module Migrator
+    class Migrator
       # PostgreSQL adapter
       #
       # @since 0.4.0
@@ -24,15 +24,18 @@ module Hanami
 
         # @since 0.4.0
         # @api private
-        def create
+        def create # rubocop:disable Metrics/MethodLength
           set_environment_variables
 
           call_db_command('createdb') do |error_message|
-            message = if error_message.match(/already exists/)
-              "createdb: database creation failed. There is 1 other session using the database."
-            else
-              error_message
-            end
+            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\
+                        "
+                      else
+                        error_message
+                      end
 
             raise MigrationError.new(message)
           end
@@ -44,11 +47,11 @@ module Hanami
           set_environment_variables
 
           call_db_command('dropdb') do |error_message|
-            message = if error_message.match(/does not exist/)
-              "Cannot find database: #{ database }"
-            else
-              error_message
-            end
+            message = if error_message.match(/does not exist/) # rubocop:disable Performance/RedundantMatch
+                        "Cannot find database: #{database}"
+                      else
+                        error_message
+                      end
 
             raise MigrationError.new(message)
           end
@@ -83,19 +86,19 @@ module Hanami
         # @since 0.4.0
         # @api private
         def dump_structure
-          system "pg_dump -i -s -x -O -T #{ migrations_table } -f #{ escape(schema) } #{ database }"
+          system "pg_dump -s -x -O -T #{migrations_table} -f #{escape(schema)} #{database}"
         end
 
         # @since 0.4.0
         # @api private
         def load_structure
-          system "psql -X -q -f #{ escape(schema) } #{ database }" if schema.exist?
+          system "psql -X -q -f #{escape(schema)} #{database}" if schema.exist?
         end
 
         # @since 0.4.0
         # @api private
         def dump_migrations_data
-          system "pg_dump -t #{ migrations_table } #{ database } >> #{ escape(schema) }"
+          system "pg_dump -t #{migrations_table} #{database} >> #{escape(schema)}"
         end
 
         # @since 0.5.1
@@ -104,10 +107,8 @@ module Hanami
           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
-                yield stderr.read
-              end
+            Open3.popen3(command, database) do |_stdin, _stdout, stderr, wait_thr|
+              yield stderr.read unless wait_thr.value.success? # wait_thr.value is the exit status
             end
           rescue SystemCallError => e
             yield e.message

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

@@ -1,8 +1,9 @@
 require 'pathname'
+require 'hanami/utils'
 
 module Hanami
   module Model
-    module Migrator
+    class Migrator
       # SQLite3 Migrator
       #
       # @since 0.4.0
@@ -28,7 +29,7 @@ module Hanami
         #
         # @since 0.4.0
         # @api private
-        def initialize(connection)
+        def initialize(connection, configuration)
           super
           extend Memory if memory?
         end
@@ -39,7 +40,7 @@ module Hanami
           path.dirname.mkpath
           FileUtils.touch(path)
         rescue Errno::EACCES, Errno::EPERM
-          raise MigrationError.new("Permission denied: #{ path.sub(/\A\/\//, '') }")
+          raise MigrationError.new("Permission denied: #{path.sub(/\A\/\//, '')}")
         end
 
         # @since 0.4.0
@@ -47,7 +48,7 @@ module Hanami
         def drop
           path.delete
         rescue Errno::ENOENT
-          raise MigrationError.new("Cannot find database: #{ path.sub(/\A\/\//, '') }")
+          raise MigrationError.new("Cannot find database: #{path.sub(/\A\/\//, '')}")
         end
 
         # @since 0.4.0
@@ -69,7 +70,7 @@ module Hanami
         # @api private
         def path
           root.join(
-            @connection.uri.sub(/(jdbc\:|)sqlite\:\/\//, '')
+            @connection.uri.sub(/\A(jdbc:sqlite:|sqlite:\/\/)/, '')
           )
         end
 
@@ -90,19 +91,19 @@ module Hanami
         # @since 0.4.0
         # @api private
         def dump_structure
-          system "sqlite3 #{ escape(path) } .schema > #{ escape(schema) }"
+          system "sqlite3 #{escape(path)} .schema > #{escape(schema)}"
         end
 
         # @since 0.4.0
         # @api private
         def load_structure
-          system "sqlite3 #{ escape(path) } < #{ escape(schema) }" if schema.exist?
+          system "sqlite3 #{escape(path)} < #{escape(schema)}" if schema.exist?
         end
 
         # @since 0.4.0
         # @api private
         def dump_migrations_data
-          system %(sqlite3 #{ escape(path) } .dump | grep '^INSERT INTO "#{ migrations_table }"' >> #{ escape(schema) })
+          system %(sqlite3 #{escape(path)} .dump | grep '^INSERT INTO "#{migrations_table}"' >> #{escape(schema)})
         end
       end
     end

data/lib/hanami/model/plugins.rb

@@ -0,0 +1,25 @@
+module Hanami
+  module Model
+    # Plugins to extend read/write operations from/to the database
+    #
+    # @since 0.7.0
+    # @api private
+    module Plugins
+      # Wrapping input
+      #
+      # @since 0.7.0
+      # @api private
+      class WrappingInput
+        # @since 0.7.0
+        # @api private
+        def initialize(_relation, input)
+          @input = input || Hash
+        end
+      end
+
+      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

@@ -0,0 +1,55 @@
+module Hanami
+  module Model
+    module Plugins
+      # Transform output into model domain types (entities).
+      #
+      # @since 0.7.0
+      # @api private
+      module Mapping
+        # Takes the output and applies the transformations
+        #
+        # @since 0.7.0
+        # @api private
+        class InputWithMapping < WrappingInput
+          # @since 0.7.0
+          # @api private
+          def initialize(relation, input)
+            super
+            @mapping = Hanami::Model.configuration.mappings[relation.name.to_sym]
+          end
+
+          # Processes the output
+          #
+          # @since 0.7.0
+          # @api private
+          def [](value)
+            @mapping.process(@input[value])
+          end
+        end
+
+        # Class interface
+        #
+        # @since 0.7.0
+        # @api private
+        module ClassMethods
+          # Builds the output processor
+          #
+          # @since 0.7.0
+          # @api private
+          def build(relation, options = {})
+            input(InputWithMapping.new(relation, input))
+            super(relation, options.merge(input: input))
+          end
+        end
+
+        # @since 0.7.0
+        # @api private
+        def self.included(klass)
+          super
+
+          klass.extend ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+module Hanami
+  module Model
+    module Plugins
+      # Transform input values into database specific types (primitives).
+      #
+      # @since 0.7.0
+      # @api private
+      module Schema
+        # Takes the input and applies the values transformations.
+        #
+        # @since 0.7.0
+        # @api private
+        class InputWithSchema < WrappingInput
+          # @since 0.7.0
+          # @api private
+          def initialize(relation, input)
+            super
+            @schema = relation.schema_hash
+          end
+
+          # Processes the input
+          #
+          # @since 0.7.0
+          # @api private
+          def [](value)
+            @schema[@input[value]]
+          end
+        end
+
+        # Class interface
+        #
+        # @since 0.7.0
+        # @api private
+        module ClassMethods
+          # Builds the input processor
+          #
+          # @since 0.7.0
+          # @api private
+          def build(relation, options = {})
+            input(InputWithSchema.new(relation, input))
+            super(relation, options.merge(input: input))
+          end
+        end
+
+        # @since 0.7.0
+        # @api private
+        def self.included(klass)
+          super
+
+          klass.extend ClassMethods
+        end
+      end
+    end
+  end
+end