Started working on casted models, basic functionalities are now in.
property :casted_attribute, :cast_as => 'WithCastedModelMixin' A casted attribute now knows about its parent. (#casted_by to retrieve the parent's object)
This commit is contained in:
parent
fa7b176fce
commit
621f5565e9
10 changed files with 177 additions and 40 deletions
|
@ -1,18 +1,24 @@
|
|||
require File.join(File.dirname(__FILE__), '..', 'more', 'property')
|
||||
|
||||
module CouchRest
|
||||
module Mixins
|
||||
module DocumentProperties
|
||||
module Properties
|
||||
|
||||
class IncludeError < StandardError; end
|
||||
|
||||
def self.included(base)
|
||||
base.cattr_accessor(:properties)
|
||||
base.class_eval <<-EOS, __FILE__, __LINE__
|
||||
@@properties = []
|
||||
EOS
|
||||
base.extend(ClassMethods)
|
||||
raise CouchRest::Mixins::DocumentProporties::InludeError, "You can only mixin Properties in a class responding to [] and []=" unless (base.new.respond_to?(:[]) && base.new.respond_to?(:[]=))
|
||||
raise CouchRest::Mixins::Properties::IncludeError, "You can only mixin Properties in a class responding to [] and []=, if you tried to mixin CastedModel, make sure your class inherits from Hash or responds to the proper methods" unless (base.new.respond_to?(:[]) && base.new.respond_to?(:[]=))
|
||||
end
|
||||
|
||||
def apply_defaults
|
||||
return unless new_document?
|
||||
return unless self.respond_to?(:new_document?) && new_document?
|
||||
return unless self.class.respond_to?(:properties)
|
||||
return if self.class.properties.empty?
|
||||
|
||||
# TODO: cache the default object
|
||||
self.class.properties.each do |property|
|
||||
key = property.name.to_s
|
||||
|
@ -25,16 +31,38 @@ module CouchRest
|
|||
end
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
def cast_keys
|
||||
return unless self.class.properties
|
||||
# TODO move the argument checking to the cast method for early crashes
|
||||
self.class.properties.each do |property|
|
||||
next unless property.casted
|
||||
key = self.has_key?(property.name) ? property.name : property.name.to_sym
|
||||
target = property.type
|
||||
if target.is_a?(Array)
|
||||
klass = ::CouchRest.constantize(target[0])
|
||||
|
||||
self[property.name] = self[key].collect do |value|
|
||||
obj = ( (property.init_method == 'send') && klass == Time) ? Time.parse(value) : klass.send(property.init_method, value)
|
||||
obj.casted_by = self if obj.respond_to?(:casted_by)
|
||||
obj
|
||||
end
|
||||
else
|
||||
# Let people use :send as a Time parse arg
|
||||
self[property.name] = if ((property.init_method != 'send') && target == 'Time')
|
||||
Time.parse(self[property.init_method])
|
||||
else
|
||||
klass = ::CouchRest.constantize(target)
|
||||
klass.send(property.init_method, self[property.name])
|
||||
end
|
||||
self[key].casted_by = self if self[key].respond_to?(:casted_by)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
module ClassMethods
|
||||
|
||||
# Stores the class properties
|
||||
def properties
|
||||
@@properties ||= []
|
||||
end
|
||||
|
||||
def property(name, options={})
|
||||
define_property(name, options) unless properties.map{|p| p.name}.include?(name.to_s)
|
||||
end
|
||||
|
@ -44,29 +72,31 @@ module CouchRest
|
|||
# This is not a thread safe operation, if you have to set new properties at runtime
|
||||
# make sure to use a mutex.
|
||||
def define_property(name, options={})
|
||||
property = CouchRest::Property.new(name, options.delete(:type), options)
|
||||
# check if this property is going to casted
|
||||
options[:casted] = true if options[:cast_as]
|
||||
property = CouchRest::Property.new(name, (options.delete(:cast_as) || options.delete(:type)), options)
|
||||
create_property_getter(property)
|
||||
create_property_setter(property) unless property.read_only == true
|
||||
properties << property
|
||||
end
|
||||
|
||||
# defines the getter for the property
|
||||
# defines the getter for the property (and optional aliases)
|
||||
def create_property_getter(property)
|
||||
meth = property.name
|
||||
class_eval <<-EOS
|
||||
def #{meth}
|
||||
self['#{meth}']
|
||||
# meth = property.name
|
||||
class_eval <<-EOS, __FILE__, __LINE__
|
||||
def #{property.name}
|
||||
self['#{property.name}']
|
||||
end
|
||||
EOS
|
||||
|
||||
if property.alias
|
||||
class_eval <<-EOS
|
||||
alias #{property.alias.to_sym} #{meth.to_sym}
|
||||
class_eval <<-EOS, __FILE__, __LINE__
|
||||
alias #{property.alias.to_sym} #{property.name.to_sym}
|
||||
EOS
|
||||
end
|
||||
end
|
||||
|
||||
# defines the setter for the property
|
||||
# defines the setter for the property (and optional aliases)
|
||||
def create_property_setter(property)
|
||||
meth = property.name
|
||||
class_eval <<-EOS
|
||||
|
|
|
@ -126,10 +126,7 @@ module CouchRest
|
|||
self.respond_to?(name, true) ? self.send(name) : nil
|
||||
end
|
||||
|
||||
# Get the corresponding Resource property, if it exists.
|
||||
#
|
||||
# Note: CouchRest validations can be used on non-CouchRest resources.
|
||||
# In such cases, the return value will be nil.
|
||||
# Get the corresponding Object property, if it exists.
|
||||
def validation_property(field_name)
|
||||
properties.find{|p| p.name == field_name}
|
||||
end
|
||||
|
|
28
lib/couchrest/more/casted_model.rb
Normal file
28
lib/couchrest/more/casted_model.rb
Normal file
|
@ -0,0 +1,28 @@
|
|||
require File.join(File.dirname(__FILE__), '..', 'mixins', 'properties')
|
||||
|
||||
module CouchRest
|
||||
module CastedModel
|
||||
|
||||
def self.included(base)
|
||||
base.send(:include, CouchRest::Mixins::Properties)
|
||||
base.send(:attr_accessor, :casted_by)
|
||||
end
|
||||
|
||||
def initialize(keys={})
|
||||
super
|
||||
keys.each do |k,v|
|
||||
self[k.to_s] = v
|
||||
end if keys
|
||||
apply_defaults # defined in CouchRest::Mixins::Properties
|
||||
# cast_keys # defined in CouchRest::Mixins::Properties
|
||||
end
|
||||
|
||||
def []= key, value
|
||||
super(key.to_s, value)
|
||||
end
|
||||
|
||||
def [] key
|
||||
super(key.to_s)
|
||||
end
|
||||
end
|
||||
end
|
|
@ -15,7 +15,7 @@ module CouchRest
|
|||
class ExtendedDocument < Document
|
||||
include CouchRest::Callbacks
|
||||
include CouchRest::Mixins::DocumentQueries
|
||||
include CouchRest::Mixins::DocumentProperties
|
||||
include CouchRest::Mixins::Properties
|
||||
include CouchRest::Mixins::Views
|
||||
include CouchRest::Mixins::DesignDoc
|
||||
|
||||
|
@ -25,8 +25,8 @@ module CouchRest
|
|||
|
||||
def initialize(keys={})
|
||||
super
|
||||
apply_defaults # defined in CouchRest::Mixins::DocumentProperties
|
||||
# cast_keys
|
||||
apply_defaults # defined in CouchRest::Mixins::Properties
|
||||
cast_keys # defined in CouchRest::Mixins::Properties
|
||||
unless self['_id'] && self['_rev']
|
||||
self['couchrest-type'] = self.class.to_s
|
||||
end
|
||||
|
|
|
@ -2,12 +2,12 @@ module CouchRest
|
|||
|
||||
# Basic attribute support for adding getter/setter + validation
|
||||
class Property
|
||||
attr_reader :name, :type, :read_only, :alias, :default, :options
|
||||
attr_reader :name, :type, :read_only, :alias, :default, :casted, :init_method, :options
|
||||
|
||||
# attribute to define
|
||||
def initialize(name, type = nil, options = {})
|
||||
@name = name.to_s
|
||||
@type = type || String
|
||||
@name = name.to_s
|
||||
@type = type.nil? ? 'String' : type.to_s
|
||||
parse_options(options)
|
||||
self
|
||||
end
|
||||
|
@ -20,6 +20,8 @@ module CouchRest
|
|||
@read_only = options.delete(:read_only) if options[:read_only]
|
||||
@alias = options.delete(:alias) if options[:alias]
|
||||
@default = options.delete(:default) if options[:default]
|
||||
@casted = options[:casted] ? true : false
|
||||
@init_method = options[:send] ? options.delete[:send] : 'new'
|
||||
@options = options
|
||||
end
|
||||
|
||||
|
|
|
@ -107,7 +107,7 @@ module CouchRest
|
|||
end
|
||||
|
||||
# length
|
||||
if property.type == String
|
||||
if property.type == "String"
|
||||
# XXX: maybe length should always return a Range, with the min defaulting to 1
|
||||
# 52 being the max set
|
||||
len = property.options.fetch(:length, property.options.fetch(:size, 52))
|
||||
|
@ -145,7 +145,7 @@ module CouchRest
|
|||
end
|
||||
|
||||
# numeric validator
|
||||
if Integer == property.type
|
||||
if "Integer" == property.type
|
||||
opts[:integer_only] = true
|
||||
# validates_is_number property.name, opts
|
||||
validates_is_number property.name, options_with_message(opts, property, :is_number)
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue