hanami-model 0.6.1 → 0.7.0

data/lib/hanami/model/mapping.rb

@@ -1,47 +1,41 @@
-require 'hanami/model/mapping/collection'
-require 'hanami/model/mapping/collection_coercer'
-require 'hanami/model/mapping/coercers'
+require 'transproc'
 
 module Hanami
   module Model
-    # Mapping internal utilities
+    # Mapping
     #
     # @since 0.1.0
-    module Mapping
-      # Unmapped collection error.
-      #
-      # It gets raised when the application tries to access to a non-mapped
-      # collection.
-      #
-      # @since 0.1.0
-      class UnmappedCollectionError < Hanami::Model::Error
-        def initialize(name)
-          super("Cannot find collection: #{ name }")
-        end
+    class Mapping
+      def initialize(&blk)
+        @attributes   = {}
+        @r_attributes = {}
+        instance_eval(&blk)
+        @processor = @attributes.empty? ? ::Hash : Transproc(:rename_keys, @attributes)
       end
 
-      # Invalid entity error.
-      #
-      # It gets raised when the application tries to access to a existing
-      # entity.
-      #
-      # @since 0.2.0
-      class EntityNotFound < Hanami::Model::Error
-        def initialize(name)
-          super("Cannot find class for entity: #{ name }")
-        end
+      def model(entity)
       end
 
-      # Invalid repository error.
-      #
-      # It gets raised when the application tries to access to a existing
-      # repository.
-      #
-      # @since 0.2.0
-      class RepositoryNotFound < Hanami::Model::Error
-        def initialize(name)
-          super("Cannot find class for repository: #{ name }")
-        end
+      def register_as(name)
+      end
+
+      def attribute(name, options)
+        from = options.fetch(:from, name)
+
+        @attributes[name]   = from
+        @r_attributes[from] = name
+      end
+
+      def process(input)
+        @processor[input]
+      end
+
+      def reverse?
+        @r_attributes.any?
+      end
+
+      def translate(attribute)
+        @r_attributes.fetch(attribute)
       end
     end
   end

data/lib/hanami/model/migration.rb

@@ -0,0 +1,31 @@
+module Hanami
+  module Model
+    # Database migration
+    #
+    # @since 0.7.0
+    # @api private
+    class Migration
+      # @since 0.7.0
+      # @api private
+      attr_reader :gateway
+
+      # @since 0.7.0
+      # @api private
+      attr_reader :migration
+
+      # @since 0.7.0
+      # @api private
+      def initialize(gateway, &block)
+        @gateway = gateway
+        @migration = gateway.migration(&block)
+        freeze
+      end
+
+      # @since 0.7.0
+      # @api private
+      def run(direction = :up)
+        migration.apply(gateway.connection, direction)
+      end
+    end
+  end
+end

data/lib/hanami/model/migrator.rb

@@ -1,7 +1,5 @@
 require 'sequel'
 require 'sequel/extensions/migration'
-require 'hanami/model/migrator/connection'
-require 'hanami/model/migrator/adapter'
 
 module Hanami
   module Model
@@ -11,51 +9,13 @@ module Hanami
     class MigrationError < Hanami::Model::Error
     end
 
-    # Define a migration
-    #
-    # It must define an up/down strategy to write schema changes (up) and to
-    # rollback them (down).
-    #
-    # We can use <tt>up</tt> and <tt>down</tt> blocks for custom strategies, or
-    # only one <tt>change</tt> block that automatically implements "down" strategy.
-    #
-    # @param blk [Proc] a block that defines up/down or change database migration
-    #
-    # @since 0.4.0
-    #
-    # @example Use up/down blocks
-    #   Hanami::Model.migration do
-    #     up do
-    #       create_table :books do
-    #         primary_key :id
-    #         column :book, String
-    #       end
-    #     end
-    #
-    #     down do
-    #       drop_table :books
-    #     end
-    #   end
-    #
-    # @example Use change block
-    #   Hanami::Model.migration do
-    #     change do
-    #       create_table :books do
-    #         primary_key :id
-    #         column :book, String
-    #       end
-    #     end
-    #
-    #     # DOWN strategy is automatically generated
-    #   end
-    def self.migration(&blk)
-      Sequel.migration(&blk)
-    end
-
     # Database schema migrator
     #
     # @since 0.4.0
-    module Migrator
+    class Migrator
+      require 'hanami/model/migrator/connection'
+      require 'hanami/model/migrator/adapter'
+
       # Create database defined by current configuration.
       #
       # It's only implemented for the following databases:
@@ -76,12 +36,14 @@ module Hanami
       #
       #   Hanami::Model.configure do
       #     # ...
-      #     adapter type: :sql, uri: 'postgres://localhost/foo'
+      #     adapter :sql, 'postgres://localhost/foo'
       #   end
       #
       #   Hanami::Model::Migrator.create # Creates `foo' database
+      #
+      # NOTE: Class level interface SHOULD be removed in Hanami 2.0
       def self.create
-        adapter(connection).create
+        new.create
       end
 
       # Drop database defined by current configuration.
@@ -104,12 +66,14 @@ module Hanami
       #
       #   Hanami::Model.configure do
       #     # ...
-      #     adapter type: :sql, uri: 'postgres://localhost/foo'
+      #     adapter :sql, 'postgres://localhost/foo'
       #   end
       #
       #   Hanami::Model::Migrator.drop # Drops `foo' database
+      #
+      # NOTE: Class level interface SHOULD be removed in Hanami 2.0
       def self.drop
-        adapter(connection).drop
+        new.drop
       end
 
       # Migrate database schema
@@ -132,7 +96,7 @@ module Hanami
       #
       #   Hanami::Model.configure do
       #     # ...
-      #     adapter    type: :sql, uri: 'postgres://localhost/foo'
+      #     adapter    :sql, 'postgres://localhost/foo'
       #     migrations 'db/migrations'
       #   end
       #
@@ -145,7 +109,7 @@ module Hanami
       #
       #   Hanami::Model.configure do
       #     # ...
-      #     adapter    type: :sql, uri: 'postgres://localhost/foo'
+      #     adapter    :sql, 'postgres://localhost/foo'
       #     migrations 'db/migrations'
       #   end
       #
@@ -154,12 +118,10 @@ module Hanami
       #
       #   # Migrate to a specifiy version
       #   Hanami::Model::Migrator.migrate(version: "20150610133853")
+      #
+      # NOTE: Class level interface SHOULD be removed in Hanami 2.0
       def self.migrate(version: nil)
-        version = Integer(version) unless version.nil?
-
-        Sequel::Migrator.run(connection, migrations, target: version, allow_missing_migration_files: true) if migrations?
-      rescue Sequel::Migrator::Error => e
-        raise MigrationError.new(e.message)
+        new.migrate(version: version)
       end
 
       # Migrate, dump schema, delete migrations.
@@ -192,7 +154,7 @@ module Hanami
       #
       #   Hanami::Model.configure do
       #     # ...
-      #     adapter    type: :sql, uri: 'postgres://localhost/foo'
+      #     adapter    :sql, 'postgres://localhost/foo'
       #     migrations 'db/migrations'
       #     schema     'db/schema.sql'
       #   end
@@ -200,10 +162,10 @@ module Hanami
       #   # Reads all files from "db/migrations" and apply and delete them.
       #   # It generates an updated version of "db/schema.sql"
       #   Hanami::Model::Migrator.apply
+      #
+      # NOTE: Class level interface SHOULD be removed in Hanami 2.0
       def self.apply
-        migrate
-        adapter(connection).dump
-        delete_migrations
+        new.apply
       end
 
       # Prepare database: drop, create, load schema (if any), migrate.
@@ -223,7 +185,7 @@ module Hanami
       #
       #   Hanami::Model.configure do
       #     # ...
-      #     adapter    type: :sql, uri: 'postgres://localhost/foo'
+      #     adapter    :sql, 'postgres://localhost/foo'
       #     migrations 'db/migrations'
       #   end
       #
@@ -235,18 +197,17 @@ module Hanami
       #
       #   Hanami::Model.configure do
       #     # ...
-      #     adapter    type: :sql, uri: 'postgres://localhost/foo'
+      #     adapter    :sql, 'postgres://localhost/foo'
       #     migrations 'db/migrations'
       #     schema     'db/schema.sql'
       #   end
       #
       #   Hanami::Model::Migrator.apply   # => updates schema dump
       #   Hanami::Model::Migrator.prepare # => creates `foo', load schema and run pending migrations (if any)
+      #
+      # NOTE: Class level interface SHOULD be removed in Hanami 2.0
       def self.prepare
-        drop rescue nil
-        create
-        adapter(connection).load
-        migrate
+        new.prepare
       end
 
       # Return current database version timestamp
@@ -262,40 +223,82 @@ module Hanami
       #   #  20150610133853_create_books.rb
       #
       #   Hanami::Model::Migrator.version # => "20150610133853"
+      #
+      # NOTE: Class level interface SHOULD be removed in Hanami 2.0
       def self.version
-        adapter(connection).version
+        new.version
       end
 
-      private
+      # Instantiate a new migrator
+      #
+      # @param configuration [Hanami::Model::Configuration] framework configuration
+      #
+      # @return [Hanami::Model::Migrator] a new instance
+      #
+      # @since 0.7.0
+      # @api private
+      def initialize(configuration: self.class.configuration)
+        @configuration = configuration
+        @adapter       = Adapter.for(configuration)
+      end
 
-      # Loads an adapter for the given connection
+      # @since 0.7.0
+      # @api private
       #
-      # @since 0.4.0
+      # @see Hanami::Model::Migrator.create
+      def create
+        adapter.create
+      end
+
+      # @since 0.7.0
       # @api private
-      def self.adapter(connection)
-        Adapter.for(connection)
+      #
+      # @see Hanami::Model::Migrator.drop
+      def drop
+        adapter.drop
       end
 
-      # Delete all the migrations
+      # @since 0.7.0
+      # @api private
       #
-      # @since 0.4.0
+      # @see Hanami::Model::Migrator.migrate
+      def migrate(version: nil)
+        adapter.migrate(migrations, version) if migrations?
+      end
+
+      # @since 0.7.0
       # @api private
-      def self.delete_migrations
-        migrations.each_child(&:delete)
+      #
+      # @see Hanami::Model::Migrator.apply
+      def apply
+        migrate
+        adapter.dump
+        delete_migrations
       end
 
-      # Database connection
+      # @since 0.7.0
+      # @api private
       #
-      # @since 0.4.0
+      # @see Hanami::Model::Migrator.prepare
+      def prepare
+        drop
+      rescue
+      ensure
+        create
+        adapter.load
+        migrate
+      end
+
+      # @since 0.7.0
       # @api private
-      def self.connection
-        Sequel.connect(
-          configuration.adapter.uri
-        )
-      rescue Sequel::AdapterNotFound
-        raise MigrationError.new("Current adapter (#{ configuration.adapter.type }) doesn't support SQL database operations.")
+      #
+      # @see Hanami::Model::Migrator.version
+      def version
+        adapter.version
       end
 
+      private
+
       # Hanami::Model configuration
       #
       # @since 0.4.0
@@ -304,20 +307,40 @@ module Hanami
         Model.configuration
       end
 
+      # @since 0.7.0
+      # @api private
+      attr_reader :configuration
+
+      # @since 0.7.0
+      # @api private
+      attr_reader :connection
+
+      # @since 0.7.0
+      # @api private
+      attr_reader :adapter
+
       # Migrations directory
       #
-      # @since 0.4.0
+      # @since 0.7.0
       # @api private
-      def self.migrations
+      def migrations
         configuration.migrations
       end
 
       # Check if there are migrations
       #
-      # @since 0.4.0
+      # @since 0.7.0
+      # @api private
+      def migrations?
+        Dir["#{migrations}/*.rb"].any?
+      end
+
+      # Delete all the migrations
+      #
+      # @since 0.7.0
       # @api private
-      def self.migrations?
-        Dir["#{ migrations }/*.rb"].any?
+      def delete_migrations
+        migrations.each_child(&:delete)
       end
     end
   end

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

@@ -3,7 +3,7 @@ require 'shellwords'
 
 module Hanami
   module Model
-    module Migrator
+    class Migrator
       # Migrator base adapter
       #
       # @since 0.4.0
@@ -25,7 +25,9 @@ module Hanami
         #
         # @since 0.4.0
         # @api private
-        def self.for(connection)
+        def self.for(configuration) # rubocop:disable Metrics/MethodLength
+          connection = connection_for(configuration)
+
           case connection.database_type
           when :sqlite
             require 'hanami/model/migrator/sqlite_adapter'
@@ -38,15 +40,30 @@ module Hanami
             MySQLAdapter
           else
             self
-          end.new(connection)
+          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
 
         # Initialize an adapter
         #
         # @since 0.4.0
         # @api private
-        def initialize(connection)
+        def initialize(connection, configuration)
           @connection = Connection.new(connection)
+          @schema     = configuration.schema
         end
 
         # Create database.
@@ -57,7 +74,7 @@ module Hanami
         #
         # @see Hanami::Model::Migrator.create
         def create
-          raise MigrationError.new("Current adapter (#{ connection.database_type }) doesn't support create.")
+          raise MigrationError.new("Current adapter (#{connection.database_type}) doesn't support create.")
         end
 
         # Drop database.
@@ -68,7 +85,15 @@ module Hanami
         #
         # @see Hanami::Model::Migrator.drop
         def drop
-          raise MigrationError.new("Current adapter (#{ connection.database_type }) doesn't support drop.")
+          raise MigrationError.new("Current adapter (#{connection.database_type}) doesn't support drop.")
+        end
+
+        def migrate(migrations, version)
+          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)
         end
 
         # Load database schema.
@@ -79,7 +104,7 @@ module Hanami
         #
         # @see Hanami::Model::Migrator.prepare
         def load
-          raise MigrationError.new("Current adapter (#{ connection.database_type }) doesn't support load.")
+          raise MigrationError.new("Current adapter (#{connection.database_type}) doesn't support load.")
         end
 
         # Database version.
@@ -87,9 +112,10 @@ module Hanami
         # @since 0.4.0
         # @api private
         def version
-          return unless connection.adapter_connection.tables.include?(MIGRATIONS_TABLE)
+          table = connection.table(MIGRATIONS_TABLE)
+          return if table.nil?
 
-          if record = connection.adapter_connection[MIGRATIONS_TABLE].order(MIGRATIONS_TABLE_VERSION_COLUMN).last
+          if record = table.order(MIGRATIONS_TABLE_VERSION_COLUMN).last
             record.fetch(MIGRATIONS_TABLE_VERSION_COLUMN).scan(/\A[\d]{14}/).first.to_s
           end
         end
@@ -100,6 +126,10 @@ module Hanami
         # @api private
         attr_reader :connection
 
+        # @since 0.4.0
+        # @api private
+        attr_reader :schema
+
         # Returns a database connection
         #
         # Given a DB connection URI we can connect to a specific database or not, we need this when creating
@@ -110,7 +140,6 @@ module Hanami
         #
         # @since 0.5.0
         # @api private
-        #
         def new_connection(global: false)
           uri = global ? connection.global_uri : connection.uri
 
@@ -147,12 +176,6 @@ module Hanami
           escape connection.password
         end
 
-        # @since 0.4.0
-        # @api private
-        def schema
-          Model.configuration.schema
-        end
-
         # @since 0.4.0
         # @api private
         def migrations_table