hanami-model 0.6.1 → 0.7.0

data/lib/hanami/model/adapters/sql_adapter.rb

@@ -1,296 +0,0 @@
-require 'hanami/model/adapters/abstract'
-require 'hanami/model/adapters/implementation'
-require 'hanami/model/adapters/sql/collection'
-require 'hanami/model/adapters/sql/command'
-require 'hanami/model/adapters/sql/query'
-require 'hanami/model/adapters/sql/console'
-require 'sequel'
-
-module Hanami
-  module Model
-    module Adapters
-      # Adapter for SQL databases
-      #
-      # In order to use it with a specific database, you must require the Ruby
-      # gem before of loading Hanami::Model.
-      #
-      # @see Hanami::Model::Adapters::Implementation
-      #
-      # @api private
-      # @since 0.1.0
-      class SqlAdapter < Abstract
-        include Implementation
-
-        # Initialize the adapter.
-        #
-        # Hanami::Model uses Sequel. For a complete reference of the connection
-        # URI, please see: http://sequel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html
-        #
-        # @param mapper [Object] the database mapper
-        # @param uri [String] the connection uri for the database
-        # @param options [Hash] a hash of non-mandatory adapter options
-        #
-        # @return [Hanami::Model::Adapters::SqlAdapter]
-        #
-        # @raise [Hanami::Model::Adapters::DatabaseAdapterNotFound] if the given
-        #   URI refers to an unknown or not registered adapter.
-        #
-        # @raise [URI::InvalidURIError] if the given URI is malformed
-        #
-        # @see Hanami::Model::Mapper
-        # @see http://sequel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html
-        #
-        # @api private
-        # @since 0.1.0
-        def initialize(mapper, uri, options = {})
-          super
-          @connection = Sequel.connect(@uri, @options)
-        rescue Sequel::AdapterNotFound => e
-          raise DatabaseAdapterNotFound.new(e.message)
-        end
-
-        # Creates a record in the database for the given entity.
-        # It assigns the `id` attribute, in case of success.
-        #
-        # @param collection [Symbol] the target collection (it must be mapped).
-        # @param entity [#id=] the entity to create
-        #
-        # @return [Object] the entity
-        #
-        # @api private
-        # @since 0.1.0
-        def create(collection, entity)
-          command(
-            query(collection)
-          ).create(entity)
-        end
-
-        # Updates a record in the database corresponding to the given entity.
-        #
-        # @param collection [Symbol] the target collection (it must be mapped).
-        # @param entity [#id] the entity to update
-        #
-        # @return [Object] the entity
-        #
-        # @api private
-        # @since 0.1.0
-        def update(collection, entity)
-          command(
-            _find(collection, entity.id)
-          ).update(entity)
-        end
-
-        # Deletes a record in the database corresponding to the given entity.
-        #
-        # @param collection [Symbol] the target collection (it must be mapped).
-        # @param entity [#id] the entity to delete
-        #
-        # @api private
-        # @since 0.1.0
-        def delete(collection, entity)
-          command(
-            _find(collection, entity.id)
-          ).delete
-        end
-
-        # Deletes all the records from the given collection.
-        #
-        # @param collection [Symbol] the target collection (it must be mapped).
-        #
-        # @api private
-        # @since 0.1.0
-        def clear(collection)
-          command(query(collection)).clear
-        end
-
-        # Fabricates a command for the given query.
-        #
-        # @param query [Hanami::Model::Adapters::Sql::Query] the query object to
-        #   act on.
-        #
-        # @return [Hanami::Model::Adapters::Sql::Command]
-        #
-        # @see Hanami::Model::Adapters::Sql::Command
-        #
-        # @api private
-        # @since 0.1.0
-        def command(query)
-          Sql::Command.new(query)
-        end
-
-        # Fabricates a query
-        #
-        # @param collection [Symbol] the target collection (it must be mapped).
-        # @param blk [Proc] a block of code to be executed in the context of
-        #   the query.
-        #
-        # @return [Hanami::Model::Adapters::Sql::Query]
-        #
-        # @see Hanami::Model::Adapters::Sql::Query
-        #
-        # @api private
-        # @since 0.1.0
-        def query(collection, context = nil, &blk)
-          Sql::Query.new(_collection(collection), context, &blk)
-        end
-
-        # Wraps the given block in a transaction.
-        #
-        # For performance reasons the block isn't in the signature of the method,
-        # but it's yielded at the lower level.
-        #
-        # @param options [Hash] options for transaction
-        # @option rollback [Symbol] the optional rollback policy: `:always` or
-        #   `:reraise`.
-        #
-        # @see Hanami::Repository::ClassMethods#transaction
-        #
-        # @since 0.2.3
-        # @api private
-        #
-        # @example Basic usage
-        #   require 'hanami/model'
-        #
-        #   class Article
-        #     include Hanami::Entity
-        #     attributes :title, :body
-        #   end
-        #
-        #   class ArticleRepository
-        #     include Hanami::Repository
-        #   end
-        #
-        #   article = Article.new(title: 'Introducing transactions',
-        #     body: 'lorem ipsum')
-        #
-        #   ArticleRepository.transaction do
-        #     ArticleRepository.dangerous_operation!(article) # => RuntimeError
-        #     # !!! ROLLBACK !!!
-        #   end
-        #
-        # @example Policy rollback always
-        #   require 'hanami/model'
-        #
-        #   class Article
-        #     include Hanami::Entity
-        #     attributes :title, :body
-        #   end
-        #
-        #   class ArticleRepository
-        #     include Hanami::Repository
-        #   end
-        #
-        #   article = Article.new(title: 'Introducing transactions',
-        #     body: 'lorem ipsum')
-        #
-        #   ArticleRepository.transaction(rollback: :always) do
-        #     ArticleRepository.create(article)
-        #     # !!! ROLLBACK !!!
-        #   end
-        #
-        #   # The operation is rolled back, even in no exceptions were raised.
-        #
-        # @example Policy rollback reraise
-        #   require 'hanami/model'
-        #
-        #   class Article
-        #     include Hanami::Entity
-        #     attributes :title, :body
-        #   end
-        #
-        #   class ArticleRepository
-        #     include Hanami::Repository
-        #   end
-        #
-        #   article = Article.new(title: 'Introducing transactions',
-        #     body: 'lorem ipsum')
-        #
-        #   ArticleRepository.transaction(rollback: :reraise) do
-        #     ArticleRepository.dangerous_operation!(article) # => RuntimeError
-        #     # !!! ROLLBACK !!!
-        #   end # => RuntimeError
-        #
-        #   # The operation is rolled back, but RuntimeError is re-raised.
-        def transaction(options = {})
-          @connection.transaction(options) do
-            yield
-          end
-        end
-
-        # Returns a string which can be executed to start a console suitable
-        # for the configured database, adding the necessary CLI flags, such as
-        # url, password, port number etc.
-        #
-        # @return [String]
-        #
-        # @since 0.3.0
-        def connection_string
-          Sql::Console.new(@uri).connection_string
-        end
-
-        # Executes a raw SQL command
-        #
-        # @param raw [String] the raw SQL statement to execute on the connection
-        #
-        # @raise [Hanami::Model::InvalidCommandError] if the raw SQL statement is invalid
-        #
-        # @return [NilClass]
-        #
-        # @since 0.3.1
-        def execute(raw)
-          begin
-            @connection.execute(raw)
-            nil
-          rescue Sequel::DatabaseError => e
-            raise Hanami::Model::InvalidCommandError.new(e.message)
-          end
-        end
-
-        # Fetches raw result sets for the given SQL query
-        #
-        # @param raw [String] the raw SQL query
-        # @param blk [Proc] optional block that is yielded for each record
-        #
-        # @return [Array]
-        #
-        # @raise [Hanami::Model::InvalidQueryError] if the raw SQL statement is invalid
-        #
-        # @since 0.5.0
-        def fetch(raw, &blk)
-          if block_given?
-            @connection.fetch(raw, &blk)
-          else
-            @connection.fetch(raw).to_a
-          end
-        rescue Sequel::DatabaseError => e
-          raise Hanami::Model::InvalidQueryError.new(e.message)
-        end
-
-        # @api private
-        # @since 0.5.0
-        #
-        # @see Hanami::Model::Adapters::Abstract#disconnect
-        def disconnect
-          @connection.disconnect
-          @connection = DisconnectedResource.new
-        end
-
-        private
-
-        # Returns a collection from the given name.
-        #
-        # @param name [Symbol] a name of the collection (it must be mapped).
-        #
-        # @return [Hanami::Model::Adapters::Sql::Collection]
-        #
-        # @see Hanami::Model::Adapters::Sql::Collection
-        #
-        # @api private
-        # @since 0.1.0
-        def _collection(name)
-          Sql::Collection.new(@connection[name], _mapped_collection(name))
-        end
-      end
-    end
-  end
-end

data/lib/hanami/model/coercer.rb

@@ -1,74 +0,0 @@
-module Hanami
-  module Model
-    # Abstract coercer
-    #
-    # It can be used as super class for custom mapping coercers.
-    #
-    # @since 0.5.0
-    #
-    # @see Hanami::Model::Mapper
-    #
-    # @example Postgres Array
-    #   require 'hanami/model/coercer'
-    #   require 'sequel/extensions/pg_array'
-    #
-    #   class PGArray < Hanami::Model::Coercer
-    #     def self.dump(value)
-    #       ::Sequel.pg_array(value) rescue nil
-    #     end
-    #
-    #     def self.load(value)
-    #       ::Kernel.Array(value) unless value.nil?
-    #     end
-    #   end
-    #
-    #   Hanami::Model.configure do
-    #     mapping do
-    #       collection :articles do
-    #         entity     Article
-    #         repository ArticleRepository
-    #
-    #         attribute :id,    Integer
-    #         attribute :title, String
-    #         attribute :tags,  PGArray
-    #       end
-    #     end
-    #   end.load!
-    #
-    #   # When the entity is serialized, it calls `PGArray.dump` to store `tags`
-    #   # as a Postgres Array.
-    #   #
-    #   # When the record is loaded (unserialized) from the database, it calls
-    #   # `PGArray.load` and returns a Ruby Array.
-    class Coercer
-      # Deserialize (load) a value coming from the database into a Ruby object.
-      #
-      # When inheriting from this class, it's a good practice to return <tt>nil</tt>
-      # if the given value it's <tt>nil</tt>.
-      #
-      # @abstract
-      #
-      # @raise [TypeError] if the value can't be coerced
-      #
-      # @since 0.5.0
-      #
-      # @see Hanami::Model::Mapping::Coercers
-      def self.load(value)
-        raise NotImplementedError
-      end
-
-      # Serialize (dump) a Ruby object into a value that can be store by the database.
-      #
-      # @abstract
-      #
-      # @raise [TypeError] if the value can't be coerced
-      #
-      # @since 0.5.0
-      #
-      # @see Hanami::Model::Mapping::Coercers
-      def self.dump(value)
-        self.load(value)
-      end
-    end
-  end
-end

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

@@ -1,116 +0,0 @@
-require 'hanami/utils/class'
-
-module Hanami
-  module Model
-    module Config
-      # Raised when an adapter class does not exist
-      #
-      # @since 0.2.0
-      class AdapterNotFound < Hanami::Model::Error
-        def initialize(adapter_name)
-          super "Cannot find Hanami::Model adapter #{adapter_name}"
-        end
-      end
-
-      # Configuration for the adapter
-      #
-      # Hanami::Model has its own global configuration that can be manipulated
-      # via `Hanami::Model.configure`.
-      #
-      # New adapter configuration can be registered via `Hanami::Model.adapter`.
-      #
-      # @see Hanami::Model.adapter
-      #
-      # @example
-      #   require 'hanami/model'
-      #
-      #   Hanami::Model.configure do
-      #     adapter type: :sql, uri: 'postgres://localhost/database'
-      #   end
-      #
-      #   Hanami::Model.configuration.adapter_config
-      #   # => Hanami::Model::Config::Adapter(type: :sql, uri: 'postgres://localhost/database')
-      #
-      # By convention, Hanami inflects type to find the adapter class
-      # For example, if type is :sql, derived class will be `Hanami::Model::Adapters::SqlAdapter`
-      #
-      # @since 0.2.0
-      class Adapter
-        # @return [Symbol] the adapter name
-        #
-        # @since 0.2.0
-        attr_reader :type
-
-        # @return [String] the adapter URI
-        #
-        # @since 0.2.0
-        attr_reader :uri
-
-        # @return [Hash] a list of non-mandatory options for the adapter
-        #
-        attr_reader :options
-
-        # @return [String] the adapter class name
-        #
-        # @since 0.2.0
-        attr_reader :class_name
-
-        # Initialize an adapter configuration instance
-        #
-        # @param options [Hash] configuration options
-        # @option options [Symbol] :type adapter type name
-        # @option options [String] :uri adapter URI
-        #
-        # @return [Hanami::Model::Config::Adapter] a new apdapter configuration's
-        #   instance
-        #
-        # @since 0.2.0
-        def initialize(**options)
-          opts     = options.dup
-
-          @type    = opts.delete(:type)
-          @uri     = opts.delete(:uri)
-          @options = opts
-
-          @class_name ||= Hanami::Utils::String.new("#{@type}_adapter").classify
-        end
-
-        # Initialize the adapter
-        #
-        # @param mapper [Hanami::Model::Mapper] the mapper instance
-        #
-        # @return [Hanami::Model::Adapters::SqlAdapter, Hanami::Model::Adapters::MemoryAdapter] an adapter instance
-        #
-        # @see Hanami::Model::Adapters
-        #
-        # @since 0.2.0
-        def build(mapper)
-          load_adapter
-          instantiate_adapter(mapper)
-        end
-
-        private
-
-        def load_adapter
-          begin
-            require "hanami/model/adapters/#{type}_adapter"
-          rescue LoadError => e
-            raise LoadError.new("Cannot find Hanami::Model adapter '#{type}' (#{e.message})")
-          end
-        end
-
-        def instantiate_adapter(mapper)
-          begin
-            klass = Hanami::Utils::Class.load!(class_name, Hanami::Model::Adapters)
-            klass.new(mapper, uri, options)
-          rescue NameError
-            raise AdapterNotFound.new(class_name)
-          rescue => e
-            raise "Cannot instantiate adapter of #{klass} (#{e.message})"
-          end
-        end
-
-      end
-    end
-  end
-end