Working on adding support for allowing dynamic properties
This commit is contained in:
parent
85cd1308bc
commit
97347e70e3
33
README.md
33
README.md
|
@ -71,11 +71,14 @@ but no guarantees!
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
Only attributes with a property definition will be stored be CouchRest Model (as opposed
|
A property is the definition of an attribute, it describes what the attribute is called, how it should
|
||||||
to a normal CouchRest Document which will store everything). To help prevent confusion,
|
be type casted, if at all, and other options such as the default value. These replace your typical
|
||||||
a property should be considered as the definition of an attribute. An attribute must be associated
|
`add_column` methods typically found in migrations.
|
||||||
with a property, but a property may not have any attributes associated if none have been set.
|
|
||||||
|
|
||||||
|
By default only attributes with a property definition will be stored in CouchRest Model, as opposed
|
||||||
|
to a normal CouchRest Document which will store everything. This however can be disabled using the
|
||||||
|
`allow_dynamic_properties` configuration option either for all of CouchRest Model, or for specific
|
||||||
|
models. See the configuration section for more details.
|
||||||
|
|
||||||
In its simplest form, a property
|
In its simplest form, a property
|
||||||
will only create a getter and setter passing all attribute data directly to the database. Assuming the attribute
|
will only create a getter and setter passing all attribute data directly to the database. Assuming the attribute
|
||||||
|
@ -290,6 +293,28 @@ you'd like to ensure the ID is unique between several types of document. For exa
|
||||||
Pretty cool!
|
Pretty cool!
|
||||||
|
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
CouchRest Model supports a few configuration options. These can be set either for the whole Model code
|
||||||
|
base or for a specific model of your chosing. To configure globally, provide something similar to the
|
||||||
|
following in your projects loading code:
|
||||||
|
|
||||||
|
CouchRestModel::Model::Base.configure do |config|
|
||||||
|
config.allow_dynamic_properties = true
|
||||||
|
config.model_type_key = 'couchrest-type'
|
||||||
|
end
|
||||||
|
|
||||||
|
To set for a specific model:
|
||||||
|
|
||||||
|
class Cat < CouchRest::Model::Base
|
||||||
|
allow_dynamic_properties true
|
||||||
|
end
|
||||||
|
|
||||||
|
Options currently avilable are:
|
||||||
|
|
||||||
|
* `allow_dynamic_properties` - false by default, when true properties do not need to be defined to be stored, although they will have no accessors.
|
||||||
|
* `model_type_key` - 'model' by default, useful for migrating from an older CouchRest ExtendedDocument when the default used to be 'couchrest-type'.
|
||||||
|
|
||||||
|
|
||||||
## Notable Issues
|
## Notable Issues
|
||||||
|
|
||||||
|
|
|
@ -4,6 +4,7 @@ module CouchRest::Model
|
||||||
extend ActiveSupport::Concern
|
extend ActiveSupport::Concern
|
||||||
|
|
||||||
included do
|
included do
|
||||||
|
include CouchRest::Model::Configuration
|
||||||
include CouchRest::Model::AttributeProtection
|
include CouchRest::Model::AttributeProtection
|
||||||
include CouchRest::Model::Attributes
|
include CouchRest::Model::Attributes
|
||||||
include CouchRest::Model::Callbacks
|
include CouchRest::Model::Callbacks
|
||||||
|
|
|
@ -9,9 +9,11 @@ module CouchRest
|
||||||
|
|
||||||
included do
|
included do
|
||||||
add_config :model_type_key
|
add_config :model_type_key
|
||||||
|
add_config :allow_dynamic_properties
|
||||||
|
|
||||||
configure do |config|
|
configure do |config|
|
||||||
config.model_type_key = 'model'
|
config.model_type_key = 'model'
|
||||||
|
config.allow_dynamic_properties = false
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
|
@ -29,7 +29,7 @@ module CouchRest
|
||||||
|
|
||||||
def write_attribute(property, value)
|
def write_attribute(property, value)
|
||||||
prop = find_property!(property)
|
prop = find_property!(property)
|
||||||
self[prop.to_s] = prop.cast(self, value)
|
self[prop.to_s] = prop.is_a?(String) ? value : prop.cast(self, value)
|
||||||
end
|
end
|
||||||
|
|
||||||
def apply_all_property_defaults
|
def apply_all_property_defaults
|
||||||
|
@ -41,10 +41,11 @@ module CouchRest
|
||||||
end
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
|
|
||||||
def find_property!(property)
|
def find_property!(property)
|
||||||
prop = property.is_a?(Property) ? property : self.class.properties.detect {|p| p.to_s == property.to_s}
|
prop = property.is_a?(Property) ? property : self.class.properties.detect {|p| p.to_s == property.to_s}
|
||||||
raise ArgumentError, "Missing property definition for #{property.to_s}" unless prop
|
raise ArgumentError, "Missing property definition for #{property.to_s}" unless allow_dynamic_properties or !prop.nil?
|
||||||
prop
|
prop || property
|
||||||
end
|
end
|
||||||
|
|
||||||
module ClassMethods
|
module ClassMethods
|
||||||
|
|
|
@ -88,6 +88,13 @@ describe "Model properties" do
|
||||||
expect { @card.write_attribute(:this_property_should_not_exist, 823) }.to raise_error(ArgumentError)
|
expect { @card.write_attribute(:this_property_should_not_exist, 823) }.to raise_error(ArgumentError)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
it 'should not raise an error if the property does not exist and dynamic properties are allowed' do
|
||||||
|
@card.class.allow_dynamic_properties = true
|
||||||
|
expect { @card.write_attribute(:this_property_should_not_exist, 823) }.to_not raise_error(ArgumentError)
|
||||||
|
@card.class.allow_dynamic_properties = false
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
it "should let you use write_attribute on readonly properties" do
|
it "should let you use write_attribute on readonly properties" do
|
||||||
lambda {
|
lambda {
|
||||||
@card.read_only_value = "foo"
|
@card.read_only_value = "foo"
|
||||||
|
|
Loading…
Reference in a new issue