hanami-model 0.6.1 → 0.7.0

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

@@ -0,0 +1,118 @@
+module Hanami
+  module Model
+    module Plugins
+      # Automatically set/update timestamp columns for create/update commands
+      #
+      # @since 0.7.0
+      # @api private
+      module Timestamps
+        # Takes the input and applies the timestamp transformation.
+        # This is an "abstract class", please look at the subclasses for
+        # specific behaviors.
+        #
+        # @since 0.7.0
+        # @api private
+        class InputWithTimestamp < WrappingInput
+          # Conventional timestamp names
+          #
+          # @since 0.7.0
+          # @api private
+          TIMESTAMPS = [:created_at, :updated_at].freeze
+
+          # @since 0.7.0
+          # @api private
+          def initialize(relation, input)
+            super
+            columns     = relation.columns.sort
+            @timestamps = (columns & TIMESTAMPS) == TIMESTAMPS
+          end
+
+          # Processes the input
+          #
+          # @since 0.7.0
+          # @api private
+          def [](value)
+            return value unless timestamps?
+            _touch(@input[value], Time.now)
+          end
+
+          protected
+
+          # @since 0.7.0
+          # @api private
+          def _touch(_value)
+            raise NotImplementedError
+          end
+
+          private
+
+          # @since 0.7.0
+          # @api private
+          def timestamps?
+            @timestamps
+          end
+        end
+
+        # Updates <tt>updated_at</tt> timestamp for update commands
+        #
+        # @since 0.7.0
+        # @api private
+        class InputWithUpdateTimestamp < InputWithTimestamp
+          protected
+
+          # @since 0.7.0
+          # @api private
+          def _touch(value, now)
+            value[:updated_at] = now
+            value
+          end
+        end
+
+        # Sets <tt>created_at</tt> and <tt>updated_at</tt> timestamps for create commands
+        #
+        # @since 0.7.0
+        # @api private
+        class InputWithCreateTimestamp < InputWithUpdateTimestamp
+          protected
+
+          # @since 0.7.0
+          # @api private
+          def _touch(value, now)
+            super
+            value[:created_at] = now
+            value
+          end
+        end
+
+        # Class interface
+        #
+        # @since 0.7.0
+        # @api private
+        module ClassMethods
+          # Build an input processor according to the current command (create or update).
+          #
+          # @since 0.7.0
+          # @api private
+          def build(relation, options = {})
+            plugin = if self < ROM::Commands::Create
+                       InputWithCreateTimestamp
+                     else
+                       InputWithUpdateTimestamp
+                     end
+
+            input(plugin.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/relation_name.rb

@@ -0,0 +1,24 @@
+require_relative 'entity_name'
+require 'hanami/utils/string'
+
+module Hanami
+  module Model
+    # Conventional name for relations.
+    #
+    # Given a repository named <tt>SourceFileRepository</tt>, the associated
+    # relation will be <tt>:source_files</tt>.
+    #
+    # @since 0.7.0
+    # @api private
+    class RelationName < EntityName
+      # @param name [Class,String] the class or its name
+      # @return [Symbol] the relation name
+      #
+      # @since 0.7.0
+      # @api private
+      def self.new(name)
+        Utils::String.new(super).underscore.pluralize.to_sym
+      end
+    end
+  end
+end

data/lib/hanami/model/sql.rb

@@ -0,0 +1,161 @@
+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'
+
+    # 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)
+      Migration.new(configuration.gateways[:default], &blk)
+    end
+
+    # SQL adapter
+    #
+    # @since 0.7.0
+    module Sql
+      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
+      #
+      # @param name [String,Symbol] the function name
+      # @return [String] the SQL fragment
+      #
+      # @since 0.7.0
+      #
+      # @example
+      #   Hanami::Model.migration do
+      #     up do
+      #       execute 'CREATE EXTENSION IF NOT EXISTS "uuid-ossp"'
+      #
+      #       create_table :source_files do
+      #         column :id, 'uuid', primary_key: true, default: Hanami::Model::Sql.function(:uuid_generate_v4)
+      #         # ...
+      #       end
+      #     end
+      #
+      #     down do
+      #       drop_table :source_files
+      #       execute 'DROP EXTENSION "uuid-ossp"'
+      #     end
+      #   end
+      def self.function(name)
+        Sequel.function(name)
+      end
+
+      # Returns a literal SQL fragment for the given SQL fragment.
+      # This is useful for database migrations
+      #
+      # @param string [String] the SQL fragment
+      # @return [String] the literal SQL fragment
+      #
+      # @since 0.7.0
+      #
+      # @example
+      #   Hanami::Model.migration do
+      #     up do
+      #       execute %{
+      #         CREATE TYPE inventory_item AS (
+      #           name            text,
+      #           supplier_id     integer,
+      #           price           numeric
+      #         );
+      #       }
+      #
+      #       create_table :items do
+      #         column :item, 'inventory_item', default: Hanami::Model::Sql.literal("ROW('fuzzy dice', 42, 1.99)")
+      #         # ...
+      #       end
+      #     end
+      #
+      #     down do
+      #       drop_table :itmes
+      #       execute 'DROP TYPE inventory_item'
+      #     end
+      #   end
+      def self.literal(string)
+        Sequel.lit(string)
+      end
+
+      # Returns SQL fragment for ascending order for the given column
+      #
+      # @param column [Symbol] the column name
+      # @return [String] the SQL fragment
+      #
+      # @since 0.7.0
+      def self.asc(column)
+        Sequel.asc(column)
+      end
+
+      # Returns SQL fragment for descending order for the given column
+      #
+      # @param column [Symbol] the column name
+      # @return [String] the SQL fragment
+      #
+      # @since 0.7.0
+      def self.desc(column)
+        Sequel.desc(column)
+      end
+    end
+
+    Error.register(ROM::SQL::DatabaseError,             DatabaseError)
+    Error.register(ROM::SQL::ConstraintError,           ConstraintViolationError)
+    Error.register(ROM::SQL::NotNullConstraintError,    NotNullConstraintViolationError)
+    Error.register(ROM::SQL::UniqueConstraintError,     UniqueConstraintViolationError)
+    Error.register(ROM::SQL::CheckConstraintError,      CheckConstraintViolationError)
+    Error.register(ROM::SQL::ForeignKeyConstraintError, ForeignKeyConstraintViolationError)
+
+    Error.register(Java::JavaSql::SQLException, DatabaseError) if Utils.jruby?
+  end
+end
+
+Sequel.default_timezone = :utc
+
+ROM.plugins do
+  adapter :sql do
+    register :mapping,    Hanami::Model::Plugins::Mapping,    type: :command
+    register :schema,     Hanami::Model::Plugins::Schema,     type: :command
+    register :timestamps, Hanami::Model::Plugins::Timestamps, type: :command
+  end
+end

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

@@ -0,0 +1,41 @@
+require 'uri'
+
+module Hanami
+  module Model
+    module Sql
+      # SQL console
+      #
+      # @since 0.7.0
+      # @api private
+      class Console
+        extend Forwardable
+
+        def_delegator :console, :connection_string
+
+        # @since 0.7.0
+        # @api private
+        def initialize(uri)
+          @uri = URI.parse(uri)
+        end
+
+        private
+
+        # @since 0.7.0
+        # @api private
+        def console # rubocop:disable Metrics/MethodLength
+          case @uri.scheme
+          when 'sqlite'
+            require 'hanami/model/sql/consoles/sqlite'
+            Sql::Consoles::Sqlite.new(@uri)
+          when 'postgres'
+            require 'hanami/model/sql/consoles/postgresql'
+            Sql::Consoles::Postgresql.new(@uri)
+          when 'mysql', 'mysql2'
+            require 'hanami/model/sql/consoles/mysql'
+            Sql::Consoles::Mysql.new(@uri)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module Hanami
+  module Model
+    module Sql
+      module Consoles
+        # Abstract adapter
+        #
+        # @since 0.7.0
+        # @api private
+        class Abstract
+          # @since 0.7.0
+          # @api private
+          def initialize(uri)
+            @uri = uri
+          end
+
+          private
+
+          # @since 0.7.0
+          # @api private
+          def database_name
+            @uri.path.sub(/^\//, '')
+          end
+
+          # @since 0.7.0
+          # @api private
+          def concat(*tokens)
+            tokens.join
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+require_relative 'abstract'
+
+module Hanami
+  module Model
+    module Sql
+      module Consoles
+        # MySQL adapter
+        #
+        # @since 0.7.0
+        # @api private
+        class Mysql < Abstract
+          # @since 0.7.0
+          # @api private
+          COMMAND = 'mysql'.freeze
+
+          # @since 0.7.0
+          # @api private
+          def connection_string
+            concat(command, host, database, port, username, password)
+          end
+
+          private
+
+          # @since 0.7.0
+          # @api private
+          def command
+            COMMAND
+          end
+
+          # @since 0.7.0
+          # @api private
+          def host
+            " -h #{@uri.host}"
+          end
+
+          # @since 0.7.0
+          # @api private
+          def database
+            " -D #{database_name}"
+          end
+
+          # @since 0.7.0
+          # @api private
+          def port
+            " -P #{@uri.port}" unless @uri.port.nil?
+          end
+
+          # @since 0.7.0
+          # @api private
+          def username
+            " -u #{@uri.user}" unless @uri.user.nil?
+          end
+
+          # @since 0.7.0
+          # @api private
+          def password
+            " -p #{@uri.password}" unless @uri.password.nil?
+          end
+        end
+      end
+    end
+  end
+end