hanami-model 0.6.1 → 0.7.0

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

@@ -1,45 +0,0 @@
-require 'hanami/utils/kernel'
-
-module Hanami
-  module Model
-    module Config
-      # Read mapping file for mapping DSL
-      #
-      # @since 0.2.0
-      # @api private
-      class Mapper
-        EXTNAME = '.rb'
-
-        def initialize(path=nil, &blk)
-          if block_given?
-            @blk = blk
-          elsif path
-            @path = root.join(path)
-          else
-            raise Hanami::Model::InvalidMappingError.new('You must specify a block or a file.')
-          end
-        end
-
-        def to_proc
-          unless @blk
-            code = realpath.read
-            @blk = Proc.new { eval(code) }
-          end
-
-          @blk
-        end
-
-        private
-        def realpath
-          Utils::Kernel.Pathname("#{ @path }#{ EXTNAME }").realpath
-        rescue Errno::ENOENT
-          raise ArgumentError, 'You must specify a valid filepath.'
-        end
-
-        def root
-          Utils::Kernel.Pathname(Dir.pwd).realpath
-        end
-      end
-    end
-  end
-end

data/lib/hanami/model/mapper.rb

@@ -1,124 +0,0 @@
-require 'hanami/model/mapping'
-
-module Hanami
-  module Model
-    # Error for missing mapper
-    # It's raised when loading model without mapper
-    #
-    # @since 0.2.0
-    #
-    # @see Hanami::Model::Configuration#mapping
-    class NoMappingError < Hanami::Model::Error
-      def initialize
-        super("Mapping is missing. Please check your framework configuration.")
-      end
-    end
-
-    # @since 0.2.0
-    # @api private
-    class NullMapper
-      def method_missing(m, *args)
-        raise NoMappingError.new
-      end
-    end
-
-    # A persistence mapper that keeps entities independent from database details.
-    #
-    # This is database independent. It can work with SQL, document, and even
-    # with key/value stores.
-    #
-    # @since 0.1.0
-    #
-    # @see http://martinfowler.com/eaaCatalog/dataMapper.html
-    #
-    # @example
-    #   require 'hanami/model'
-    #
-    #   mapper = Hanami::Model::Mapper.new do
-    #     collection :users do
-    #       entity User
-    #
-    #       attribute :id,   Integer
-    #       attribute :name, String
-    #     end
-    #   end
-    #
-    #   # This guarantees thread-safety and should happen as last thing before
-    #   # to start the app code.
-    #   mapper.load!
-    class Mapper
-      # @attr_reader collections [Hash] all the mapped collections
-      #
-      # @since 0.1.0
-      # @api private
-      attr_reader :collections
-
-      # Instantiate a mapper.
-      #
-      # It accepts an optional argument (`coercer`) a class that defines the
-      # policies for entities translations from/to the database.
-      #
-      # If provided, this class must implement the following interface:
-      #
-      #   * #initialize(collection) # Hanami::Model::Mapping::Collection
-      #   * #to_record(entity)      # translates an entity to the database type
-      #   * #from_record(record)    # translates a record into an entity
-      #   * #deserialize_*(value)   # a set of methods, one for each database column.
-      #
-      # If not given, it uses `Hanami::Model::Mapping::CollectionCoercer`, by default.
-      #
-      #
-      #
-      # @param coercer [Class] an optional class that defines the policies for
-      #   entity translations from/to the database.
-      #
-      # @param blk [Proc] an optional block of code that gets evaluated in the
-      #   context of the current instance
-      #
-      # @return [Hanami::Model::Mapper]
-      #
-      # @since 0.1.0
-      def initialize(coercer = nil, &blk)
-        @coercer     = coercer || Mapping::CollectionCoercer
-        @collections = {}
-
-        instance_eval(&blk) if block_given?
-      end
-
-      # Maps a collection.
-      #
-      # A collection is a set of homogeneous records. Think of a table of a SQL
-      # database or about collection of MongoDB.
-      #
-      # @param name [Symbol] the name of the mapped collection. If used with a
-      #   SQL database it's the table name.
-      #
-      # @param blk [Proc] the block that maps the attributes of that collection.
-      #
-      # @since 0.1.0
-      #
-      # @see Hanami::Model::Mapping::Collection
-      def collection(name, &blk)
-        if block_given?
-          @collections[name] = Mapping::Collection.new(name, @coercer, &blk)
-        else
-          @collections[name] or raise Mapping::UnmappedCollectionError.new(name)
-        end
-      end
-
-      # Loads the internals of the mapper, in order to guarantee thread safety.
-      #
-      # This method MUST be invoked as the last thing before of start using the
-      # application.
-      #
-      # @since 0.1.0
-      def load!(adapter = nil)
-        @collections.each_value do |collection|
-          collection.adapter = adapter
-          collection.load!
-        end
-        self
-      end
-    end
-  end
-end

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

@@ -1,85 +0,0 @@
-require 'hanami/utils/class'
-
-module Hanami
-  module Model
-    module Mapping
-      # Mapping attribute
-      #
-      # @api private
-      # @since 0.5.0
-      class Attribute
-        # @api private
-        # @since 0.5.0
-        COERCERS_NAMESPACE = "Hanami::Model::Mapping::Coercers".freeze
-
-        # Initialize a new attribute
-        #
-        # @param name [#to_sym] attribute name
-        # @param coercer [.load, .dump] a coercer
-        # @param options [Hash] a set of options
-        #
-        # @option options [#to_sym] :as Resolve mismatch between database column
-        #   name and entity attribute name
-        #
-        # @return [Hanami::Model::Mapping::Attribute]
-        #
-        # @api private
-        # @since 0.5.0
-        #
-        # @see Hanami::Model::Coercer
-        # @see Hanami::Model::Mapping::Coercers
-        # @see Hanami::Model::Mapping::Collection#attribute
-        def initialize(name, coercer, options)
-          @name    = name.to_sym
-          @coercer = coercer
-          @options = options
-        end
-
-        # Returns the mapped name
-        #
-        # @return [Symbol] the mapped name
-        #
-        # @api private
-        # @since 0.5.0
-        #
-        # @see Hanami::Model::Mapping::Collection#attribute
-        def mapped
-          (@options.fetch(:as) { name }).to_sym
-        end
-
-        # @api private
-        # @since 0.5.0
-        def load_coercer
-          "#{ coercer }.load"
-        end
-
-        # @api private
-        # @since 0.5.0
-        def dump_coercer
-          "#{ coercer }.dump"
-        end
-
-        # @api private
-        # @since 0.5.0
-        def ==(other)
-          self.class     == other.class   &&
-            self.name    == other.name    &&
-            self.mapped  == other.mapped  &&
-            self.coercer == other.coercer
-        end
-
-        protected
-
-        # @api private
-        # @since 0.5.0
-        attr_reader :name
-
-        # @api private
-        # @since 0.5.0
-        def coercer
-          Utils::Class.load_from_pattern!("(#{ COERCERS_NAMESPACE }::#{ @coercer }|#{ @coercer })")
-        end
-      end
-    end
-  end
-end

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

@@ -1,314 +0,0 @@
-require 'hanami/model/coercer'
-require 'hanami/utils/kernel'
-
-module Hanami
-  module Model
-    module Mapping
-      # Default coercers
-      #
-      # @since 0.5.0
-      # @api private
-      module Coercers
-        # Array coercer
-        #
-        # @since 0.5.0
-        # @api private
-        #
-        # @see Hanami::Model::Coercer
-        class Array < Coercer
-          # Transform a value from the database into a Ruby Array, unless nil
-          #
-          # @param value [Object] the object to coerce
-          #
-          # @return [Array] the result of the coercion
-          #
-          # @raise [TypeError] if the value can't be coerced
-          #
-          # @since 0.5.0
-          # @api private
-          #
-          # @see Hanami::Model::Coercer.load
-          # @see http://ruby-doc.org/core/Kernel.html#method-i-Array
-          def self.load(value)
-            ::Kernel.Array(value) unless value.nil?
-          end
-        end
-
-        # Boolean coercer
-        #
-        # @since 0.5.0
-        # @api private
-        #
-        # @see Hanami::Model::Coercer
-        class Boolean < Coercer
-          # Transform a value from the database into a Boolean, unless nil
-          #
-          # @param value [Object] the object to coerce
-          #
-          # @return [Boolean] the result of the coercion
-          #
-          # @raise [TypeError] if the value can't be coerced
-          #
-          # @since 0.5.0
-          # @api private
-          #
-          # @see Hanami::Model::Coercer.load
-          # @see http://rdoc.info/gems/hanami-utils/Hanami/Utils/Kernel#Boolean-class_method
-          def self.load(value)
-            Utils::Kernel.Boolean(value) unless value.nil?
-          end
-        end
-
-        # Date coercer
-        #
-        # @since 0.5.0
-        # @api private
-        #
-        # @see Hanami::Model::Coercer
-        class Date < Coercer
-          # Transform a value from the database into a Date, unless nil
-          #
-          # @param value [Object] the object to coerce
-          #
-          # @return [Date] the result of the coercion
-          #
-          # @raise [TypeError] if the value can't be coerced
-          #
-          # @since 0.5.0
-          # @api private
-          #
-          # @see Hanami::Model::Coercer.load
-          # @see http://rdoc.info/gems/hanami-utils/Hanami/Utils/Kernel#Date-class_method
-          def self.load(value)
-            Utils::Kernel.Date(value) unless value.nil?
-          end
-        end
-
-        # DateTime coercer
-        #
-        # @since 0.5.0
-        # @api private
-        #
-        # @see Hanami::Model::Coercer
-        class DateTime < Coercer
-          # Transform a value from the database into a DateTime, unless nil
-          #
-          # @param value [Object] the object to coerce
-          #
-          # @return [DateTime] the result of the coercion
-          #
-          # @raise [TypeError] if the value can't be coerced
-          #
-          # @since 0.5.0
-          # @api private
-          #
-          # @see Hanami::Model::Coercer.load
-          # @see http://rdoc.info/gems/hanami-utils/Hanami/Utils/Kernel#DateTime-class_method
-          def self.load(value)
-            Utils::Kernel.DateTime(value) unless value.nil?
-          end
-        end
-
-        # Float coercer
-        #
-        # @since 0.5.0
-        # @api private
-        #
-        # @see Hanami::Model::Coercer
-        class Float < Coercer
-          # Transform a value from the database into a Float, unless nil
-          #
-          # @param value [Object] the object to coerce
-          #
-          # @return [Float] the result of the coercion
-          #
-          # @raise [TypeError] if the value can't be coerced
-          #
-          # @since 0.5.0
-          # @api private
-          #
-          # @see Hanami::Model::Coercer.load
-          # @see http://rdoc.info/gems/hanami-utils/Hanami/Utils/Kernel#Float-class_method
-          def self.load(value)
-            Utils::Kernel.Float(value) unless value.nil?
-          end
-        end
-
-        # Hash coercer
-        #
-        # @since 0.5.0
-        # @api private
-        #
-        # @see Hanami::Model::Coercer
-        class Hash < Coercer
-          # Transform a value from the database into a Hash, unless nil
-          #
-          # @param value [Object] the object to coerce
-          #
-          # @return [Hash] the result of the coercion
-          #
-          # @raise [TypeError] if the value can't be coerced
-          #
-          # @since 0.5.0
-          # @api private
-          #
-          # @see Hanami::Model::Coercer.load
-          # @see http://rdoc.info/gems/hanami-utils/Hanami/Utils/Kernel#Hash-class_method
-          def self.load(value)
-            Utils::Kernel.Hash(value) unless value.nil?
-          end
-        end
-
-        # Integer coercer
-        #
-        # @since 0.5.0
-        # @api private
-        #
-        # @see Hanami::Model::Coercer
-        class Integer < Coercer
-          # Transform a value from the database into a Integer, unless nil
-          #
-          # @param value [Object] the object to coerce
-          #
-          # @return [Integer] the result of the coercion
-          #
-          # @raise [TypeError] if the value can't be coerced
-          #
-          # @since 0.5.0
-          # @api private
-          #
-          # @see Hanami::Model::Coercer.load
-          # @see http://rdoc.info/gems/hanami-utils/Hanami/Utils/Kernel#Integer-class_method
-          def self.load(value)
-            Utils::Kernel.Integer(value) unless value.nil?
-          end
-        end
-
-        # BigDecimal coercer
-        #
-        # @since 0.5.0
-        # @api private
-        #
-        # @see Hanami::Model::Coercer
-        class BigDecimal < Coercer
-          # Transform a value from the database into a BigDecimal, unless nil
-          #
-          # @param value [Object] the object to coerce
-          #
-          # @return [BigDecimal] the result of the coercion
-          #
-          # @raise [TypeError] if the value can't be coerced
-          #
-          # @since 0.5.0
-          # @api private
-          #
-          # @see Hanami::Model::Coercer.load
-          # @see http://rdoc.info/gems/hanami-utils/Hanami/Utils/Kernel#BigDecimal-class_method
-          def self.load(value)
-            Utils::Kernel.BigDecimal(value) unless value.nil?
-          end
-        end
-
-        # Set coercer
-        #
-        # @since 0.5.0
-        # @api private
-        #
-        # @see Hanami::Model::Coercer
-        class Set < Coercer
-          # Transform a value from the database into a Set, unless nil
-          #
-          # @param value [Object] the object to coerce
-          #
-          # @return [Set] the result of the coercion
-          #
-          # @raise [TypeError] if the value can't be coerced
-          #
-          # @since 0.5.0
-          # @api private
-          #
-          # @see Hanami::Model::Coercer.load
-          # @see http://rdoc.info/gems/hanami-utils/Hanami/Utils/Kernel#Set-class_method
-          def self.load(value)
-            Utils::Kernel.Set(value) unless value.nil?
-          end
-        end
-
-        # String coercer
-        #
-        # @since 0.5.0
-        # @api private
-        #
-        # @see Hanami::Model::Coercer
-        class String < Coercer
-          # Transform a value from the database into a String, unless nil
-          #
-          # @param value [Object] the object to coerce
-          #
-          # @return [String] the result of the coercion
-          #
-          # @raise [TypeError] if the value can't be coerced
-          #
-          # @since 0.5.0
-          # @api private
-          #
-          # @see Hanami::Model::Coercer.load
-          # @see http://rdoc.info/gems/hanami-utils/Hanami/Utils/Kernel#String-class_method
-          def self.load(value)
-            Utils::Kernel.String(value) unless value.nil?
-          end
-        end
-
-        # Symbol coercer
-        #
-        # @since 0.5.0
-        # @api private
-        #
-        # @see Hanami::Model::Coercer
-        class Symbol < Coercer
-          # Transform a value from the database into a Symbol, unless nil
-          #
-          # @param value [Object] the object to coerce
-          #
-          # @return [Symbol] the result of the coercion
-          #
-          # @raise [TypeError] if the value can't be coerced
-          #
-          # @since 0.5.0
-          # @api private
-          #
-          # @see Hanami::Model::Coercer.load
-          # @see http://rdoc.info/gems/hanami-utils/Hanami/Utils/Kernel#Symbol-class_method
-          def self.load(value)
-            Utils::Kernel.Symbol(value) unless value.nil?
-          end
-        end
-
-        # Time coercer
-        #
-        # @since 0.5.0
-        # @api private
-        #
-        # @see Hanami::Model::Coercer
-        class Time < Coercer
-          # Transform a value from the database into a Time, unless nil
-          #
-          # @param value [Object] the object to coerce
-          #
-          # @return [Time] the result of the coercion
-          #
-          # @raise [TypeError] if the value can't be coerced
-          #
-          # @since 0.5.0
-          # @api private
-          #
-          # @see Hanami::Model::Coercer.load
-          # @see http://rdoc.info/gems/hanami-utils/Hanami/Utils/Kernel#Time-class_method
-          def self.load(value)
-            Utils::Kernel.Time(value) unless value.nil?
-          end
-        end
-      end
-    end
-  end
-end