lotus-model 0.4.1 → 0.5.0

data/lib/lotus/model/coercer.rb

@@ -0,0 +1,74 @@
+module Lotus
+  module Model
+    # Abstract coercer
+    #
+    # It can be used as super class for custom mapping coercers.
+    #
+    # @since 0.5.0
+    #
+    # @see Lotus::Model::Mapper
+    #
+    # @example Postgres Array
+    #   require 'lotus/model/coercer'
+    #   require 'sequel/extensions/pg_array'
+    #
+    #   class PGArray < Lotus::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
+    #
+    #   Lotus::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 Lotus::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 Lotus::Model::Mapping::Coercers
+      def self.dump(value)
+        self.load(value)
+      end
+    end
+  end
+end

data/lib/lotus/model/configuration.rb

@@ -247,7 +247,7 @@ module Lotus
       # @api private
       # @since 0.2.0
       def _build_mapper
-        @mapper = Lotus::Model::Mapper.new(&@mapper_config.to_proc) if @mapper_config
+        @mapper = Lotus::Model::Mapper.new(&@mapper_config) if @mapper_config
       end
 
       # @api private

data/lib/lotus/model/mapper.rb

@@ -65,7 +65,7 @@ module Lotus
       #   * #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 `Lotus::Model::Mapping::Coercer`, by default.
+      # If not given, it uses `Lotus::Model::Mapping::CollectionCoercer`, by default.
       #
       #
       #
@@ -79,7 +79,7 @@ module Lotus
       #
       # @since 0.1.0
       def initialize(coercer = nil, &blk)
-        @coercer     = coercer || Mapping::Coercer
+        @coercer     = coercer || Mapping::CollectionCoercer
         @collections = {}
 
         instance_eval(&blk) if block_given?

data/lib/lotus/model/mapping.rb

@@ -1,6 +1,6 @@
 require 'lotus/model/mapping/collection'
-require 'lotus/model/mapping/coercer'
-require 'lotus/model/mapping/coercions'
+require 'lotus/model/mapping/collection_coercer'
+require 'lotus/model/mapping/coercers'
 
 module Lotus
   module Model

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

@@ -0,0 +1,85 @@
+require 'lotus/utils/class'
+
+module Lotus
+  module Model
+    module Mapping
+      # Mapping attribute
+      #
+      # @api private
+      # @since 0.5.0
+      class Attribute
+        # @api private
+        # @since 0.5.0
+        COERCERS_NAMESPACE = "Lotus::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 [Lotus::Model::Mapping::Attribute]
+        #
+        # @api private
+        # @since 0.5.0
+        #
+        # @see Lotus::Model::Coercer
+        # @see Lotus::Model::Mapping::Coercers
+        # @see Lotus::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 Lotus::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/lotus/model/mapping/coercers.rb

@@ -0,0 +1,314 @@
+require 'lotus/model/coercer'
+require 'lotus/utils/kernel'
+
+module Lotus
+  module Model
+    module Mapping
+      # Default coercers
+      #
+      # @since 0.5.0
+      # @api private
+      module Coercers
+        # Array coercer
+        #
+        # @since 0.5.0
+        # @api private
+        #
+        # @see Lotus::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 Lotus::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 Lotus::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 Lotus::Model::Coercer.load
+          # @see http://rdoc.info/gems/lotus-utils/Lotus/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 Lotus::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 Lotus::Model::Coercer.load
+          # @see http://rdoc.info/gems/lotus-utils/Lotus/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 Lotus::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 Lotus::Model::Coercer.load
+          # @see http://rdoc.info/gems/lotus-utils/Lotus/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 Lotus::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 Lotus::Model::Coercer.load
+          # @see http://rdoc.info/gems/lotus-utils/Lotus/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 Lotus::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 Lotus::Model::Coercer.load
+          # @see http://rdoc.info/gems/lotus-utils/Lotus/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 Lotus::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 Lotus::Model::Coercer.load
+          # @see http://rdoc.info/gems/lotus-utils/Lotus/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 Lotus::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 Lotus::Model::Coercer.load
+          # @see http://rdoc.info/gems/lotus-utils/Lotus/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 Lotus::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 Lotus::Model::Coercer.load
+          # @see http://rdoc.info/gems/lotus-utils/Lotus/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 Lotus::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 Lotus::Model::Coercer.load
+          # @see http://rdoc.info/gems/lotus-utils/Lotus/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 Lotus::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 Lotus::Model::Coercer.load
+          # @see http://rdoc.info/gems/lotus-utils/Lotus/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 Lotus::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 Lotus::Model::Coercer.load
+          # @see http://rdoc.info/gems/lotus-utils/Lotus/Utils/Kernel#Time-class_method
+          def self.load(value)
+            Utils::Kernel.Time(value) unless value.nil?
+          end
+        end
+      end
+    end
+  end
+end