custom-attributes 0.2.17 → 0.2.18

data/Gemfile

@@ -1,8 +1,9 @@
 source :gemcutter
 
 # Rails 3.0
-gem 'rails',        '3.0.0'
+gem 'rails',        '3.0.1'
 gem 'rspec',        '2.0.0'
+#gem 'validates_timeliness', '~> 3.0.0'
 gem 'sqlite3-ruby', :require => 'sqlite3'
 gem 'mysql'
 gem 'pg'

data/Gemfile.lock

@@ -2,12 +2,12 @@ GEM
   remote: http://rubygems.org/
   specs:
     abstract (1.0.0)
-    actionmailer (3.0.0)
-      actionpack (= 3.0.0)
+    actionmailer (3.0.1)
+      actionpack (= 3.0.1)
       mail (~> 2.2.5)
-    actionpack (3.0.0)
-      activemodel (= 3.0.0)
-      activesupport (= 3.0.0)
+    actionpack (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
       builder (~> 2.1.2)
       erubis (~> 2.6.6)
       i18n (~> 0.4.1)
@@ -15,19 +15,19 @@ GEM
       rack-mount (~> 0.6.12)
       rack-test (~> 0.5.4)
       tzinfo (~> 0.3.23)
-    activemodel (3.0.0)
-      activesupport (= 3.0.0)
+    activemodel (3.0.1)
+      activesupport (= 3.0.1)
       builder (~> 2.1.2)
       i18n (~> 0.4.1)
-    activerecord (3.0.0)
-      activemodel (= 3.0.0)
-      activesupport (= 3.0.0)
+    activerecord (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
       arel (~> 1.0.0)
       tzinfo (~> 0.3.23)
-    activeresource (3.0.0)
-      activemodel (= 3.0.0)
-      activesupport (= 3.0.0)
-    activesupport (3.0.0)
+    activeresource (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+    activesupport (3.0.1)
     arel (1.0.1)
       activesupport (~> 3.0.0)
     builder (2.1.2)
@@ -59,17 +59,17 @@ GEM
       rack (>= 1.0.0)
     rack-test (0.5.6)
       rack (>= 1.0)
-    rails (3.0.0)
-      actionmailer (= 3.0.0)
-      actionpack (= 3.0.0)
-      activerecord (= 3.0.0)
-      activeresource (= 3.0.0)
-      activesupport (= 3.0.0)
+    rails (3.0.1)
+      actionmailer (= 3.0.1)
+      actionpack (= 3.0.1)
+      activerecord (= 3.0.1)
+      activeresource (= 3.0.1)
+      activesupport (= 3.0.1)
       bundler (~> 1.0.0)
-      railties (= 3.0.0)
-    railties (3.0.0)
-      actionpack (= 3.0.0)
-      activesupport (= 3.0.0)
+      railties (= 3.0.1)
+    railties (3.0.1)
+      actionpack (= 3.0.1)
+      activesupport (= 3.0.1)
       rake (>= 0.8.4)
       thor (~> 0.14.0)
     rake (0.8.7)
@@ -100,7 +100,7 @@ DEPENDENCIES
   jeweler
   mysql
   pg
-  rails (= 3.0.0)
+  rails (= 3.0.1)
   rcov
   rspec (= 2.0.0)
   sqlite3-ruby

data/VERSION

@@ -1 +1 @@
-0.2.17
+0.2.18

data/lib/active_record/custom_attributes.rb

@@ -21,14 +21,19 @@ module ActiveRecord
         field_definitions = CustomAttributeDefinitionHelper.new field_types
         yield field_definitions if block_given?
         defined_custom_attributes = field_definitions.defined_attributes
+        defined_custom_validations = field_definitions.defined_validations
 
         if has_custom_attributes?
           write_inheritable_attribute(:defined_custom_attributes, self.defined_custom_attributes.deep_merge(defined_custom_attributes))
+          write_inheritable_attribute(:defined_custom_validations, self.defined_custom_validations.deep_merge(defined_custom_validations))
           write_inheritable_attribute(:defined_custom_field_types, field_types)
         else
           write_inheritable_attribute(:defined_custom_attributes, defined_custom_attributes)
           class_inheritable_reader(:defined_custom_attributes)
 
+          write_inheritable_attribute(:defined_custom_validations, defined_custom_validations)
+          class_inheritable_reader(:defined_custom_validations)
+
           write_inheritable_attribute(:defined_custom_field_types, extra_field_types)
           class_inheritable_reader(:defined_custom_field_types)
 
@@ -48,6 +53,7 @@ module ActiveRecord
 
       def initialize extra_field_types
         @defined_attributes = {}
+        @defined_validations = {}
 
         extra_field_types.each do |key, value|
           class_eval do
@@ -64,12 +70,14 @@ module ActiveRecord
         end
       end
 
-      attr_reader :defined_attributes
+      attr_reader :defined_attributes, :defined_validations
 
       private
 
       def define_field(type, *args)
         options = args.extract_options!
+        options.assert_valid_keys(:on_model, :validate_with, :validate_all_with)
+
         attributes_on_model = {}
         if options[:on_model].is_a? Array
           options[:on_model].each do |attribute|
@@ -78,13 +86,18 @@ module ActiveRecord
         elsif options[:on_model].is_a? Hash
           attributes_on_model = options[:on_model]
         end
+        if options[:validate_all_with]
+          @defined_validations[type] = options[:validate_all_with]
+        end
+
         args.each do |field|
           field = field.to_sym
           @defined_attributes[type] ||= {}
           @defined_attributes[type][field] = {
                   :type => type,
                   :name => field,
-                  :on_model => attributes_on_model[field] || false
+                  :on_model => attributes_on_model[field] || false,
+                  :validate_with => options[:validate_with] || nil
           }
         end
       end
@@ -101,6 +114,7 @@ module ActiveRecord
 
         base.before_save :cache_custom_attributes
         base.after_save :save_custom_attributes
+        base.validate :validate_custom_attributes
       end
 
       module ClassMethods
@@ -126,6 +140,11 @@ module ActiveRecord
         def save_custom_attributes
           custom_attributes.save
         end
+
+        def validate_custom_attributes
+          custom_attributes.validate(errors)
+        end
+
       end
 
     end

data/lib/active_record/custom_attributes/custom_attribute.rb

@@ -5,6 +5,7 @@ class ActiveRecord::CustomAttributes::CustomAttribute
     @item_list = item_list
     @attribute_model = attribute_model
     @marked_for_destruction = false
+    @errors = ActiveModel::Errors.new(self)
     load if @attribute_model
   end
 
@@ -30,23 +31,34 @@ class ActiveRecord::CustomAttributes::CustomAttribute
     @marked_for_destruction
   end
 
-  def save
-    attribute_model.destroy and return if marked_for_destruction?
-
-    attribute_model.value_type = type.to_s
-    attribute_model.field_name = internal_label.to_s
-    attribute_model.field_label = label
-    write_value = item_list.supported_attribute_types[type]
-    field = FIELD_MAPPING[write_value]
+  def validate
+    errors.clear
+    return if marked_for_destruction?
+    assign_model_value
+    unless attribute_model.valid?
+      attribute_model.errors.each do |attribute, message|
+        errors.add :value, message
+      end
+    end
+    validations = item_list.get_custom_validations_for type, internal_label
+    validations.each do |validator|
+      main_model.send(validator, self) if validator.is_a? Symbol
+      validator.call(self) if validator.is_a? Proc
+    end
+  end
 
-    converted_value = value
-    converted_value = value ? 1 : 0 if write_value == :boolean
+  def valid?
+    errors.empty?
+  end
 
-    ([:text, :date_time, :number, :float] - [field]).each { |value_field| attribute_model.send("#{value_field}_value=", nil) }
-    attribute_model.send("#{field}_value=", value)
+  def save
+    attribute_model.destroy and return if marked_for_destruction?
+    assign_model_value
     attribute_model.save
   end
 
+  attr_reader :errors
+
   private
 
   attr_reader :main_model, :item_list
@@ -62,6 +74,20 @@ class ActiveRecord::CustomAttributes::CustomAttribute
           :time => :date_time
   }
 
+  def assign_model_value
+    attribute_model.value_type = type.to_s
+    attribute_model.field_name = internal_label.to_s
+    attribute_model.field_label = label
+    write_value = item_list.supported_attribute_types[type]
+    field = FIELD_MAPPING[write_value]
+
+    converted_value = value
+    converted_value = value ? 1 : 0 if write_value == :boolean
+
+    ([:text, :date_time, :number, :float] - [field]).each { |value_field| attribute_model.send("#{value_field}_value=", nil) }
+    attribute_model.send("#{field}_value=", converted_value)
+  end
+
   def load
     self.type = attribute_model.value_type.to_sym
     self.internal_label = attribute_model.field_name.to_sym

data/lib/active_record/custom_attributes/custom_attribute_list.rb

@@ -1,8 +1,9 @@
 class ActiveRecord::CustomAttributes::CustomAttributeList
 
   def initialize(record)
-    @record = record
-    @defined_attributes = @record.class.defined_custom_attributes
+    @record                = record
+    @defined_attributes    = @record.class.defined_custom_attributes
+    @defined_validations   = @record.class.defined_custom_validations
     @extra_attribute_types = @record.class.defined_custom_field_types
     define_attribute_methods
   end
@@ -21,10 +22,10 @@ class ActiveRecord::CustomAttributes::CustomAttributeList
   end
 
   def add(type, label, value)
-    type = type.to_sym
+    type            = type.to_sym
     return if label.blank? and value.respond_to? :blank? and value.blank?
-    internal_label = convert_to_internal_label(type, label)
-    attribute = get_attribute(type, internal_label || label, true)
+    internal_label  = convert_to_internal_label(type, label)
+    attribute       = get_attribute(type, internal_label || label, true)
     attribute.value = value
   end
 
@@ -46,6 +47,21 @@ class ActiveRecord::CustomAttributes::CustomAttributeList
     loaded_attributes.each(&:save)
   end
 
+  def validate(errors)
+    loaded_attributes.each do |a|
+      a.validate
+      unless a.valid?
+        a.errors.each do |attribute, error_message|
+          errors.add(:custom_attributes, error_message)
+        end
+      end
+    end
+  end
+
+  def get_custom_validations_for(type, name)
+    [defined_validations[type], defined_attributes[type][name][:validate_with]].compact
+  end
+
   def defined_attribute_types
     (extra_attribute_types.keys + defined_attributes.keys).uniq
   end
@@ -60,14 +76,14 @@ class ActiveRecord::CustomAttributes::CustomAttributeList
 
   def supported_attribute_types
     return @supported_attribute_types if @supported_attribute_types
-    standard_attribute_types = {}
+    standard_attribute_types   = {}
     ActiveRecord::CustomAttributes::CUSTOM_ATTRIBUTE_TYPES.each { |t| standard_attribute_types[t.to_sym] = t.to_sym }
     @supported_attribute_types = (standard_attribute_types.merge extra_attribute_types)
   end
 
   def rename_label_of attribute, new_name
-    internal_label = convert_to_internal_label(attribute.type, new_name)
-    attribute.label = new_name
+    internal_label           = convert_to_internal_label(attribute.type, new_name)
+    attribute.label          = new_name
     attribute.internal_label = internal_label
   end
 
@@ -77,26 +93,26 @@ class ActiveRecord::CustomAttributes::CustomAttributeList
 
   private
 
-  attr_reader :defined_attributes, :extra_attribute_types, :record
+  attr_reader :defined_attributes, :extra_attribute_types, :defined_validations, :record
 
   def get_attribute(type, internal_label, auto_create = false)
     if internal_label.is_a? Symbol
-      attribute = loaded_attributes.find { |a| a.type == type and a.internal_label.to_s == internal_label.to_s  }
+      attribute = loaded_attributes.find { |a| a.type == type and a.internal_label.to_s == internal_label.to_s }
     else
       attribute = loaded_attributes.find { |a| a.type == type and a.label == internal_label }
     end
     return attribute if attribute
     return nil unless auto_create
 
-    new_attribute = ActiveRecord::CustomAttributes::CustomAttribute.new(self, record, nil)
+    new_attribute      = ActiveRecord::CustomAttributes::CustomAttribute.new(self, record, nil)
     new_attribute.type = type.to_sym
 
     if internal_label.is_a? Symbol
       new_attribute.internal_label = internal_label
-      new_attribute.label = human_label_for(type, internal_label)
+      new_attribute.label          = human_label_for(type, internal_label)
     else
       new_attribute.internal_label = convert_to_internal_label(type, internal_label)
-      new_attribute.label = internal_label
+      new_attribute.label          = internal_label
     end
 
     loaded_attributes << new_attribute
@@ -112,7 +128,7 @@ class ActiveRecord::CustomAttributes::CustomAttributeList
 
   def human_label_for(type, internal_name)
     translate_scope = [:activerecord, :custom_attributes, record.class.name.underscore.to_sym, type.to_sym]
-    defaults = [internal_name.to_s.underscore.gsub("_", " ").capitalize]
+    defaults        = [internal_name.to_s.underscore.gsub("_", " ").capitalize]
     I18n.t(internal_name, :scope => translate_scope, :default => defaults)
   end
 

data/lib/active_record/custom_attributes/custom_attribute_model.rb

@@ -2,4 +2,12 @@ class ActiveRecord::CustomAttributes::CustomAttributeModel < ActiveRecord::Base
   set_table_name "custom_attributes"
 
   belongs_to :item, :polymorphic => true
+  validates :date_time_value, :presence => { :if => :date_storage? }
+
+  private
+
+  def date_storage?
+    ["date_time", "date", "time"].include? value_type
+  end
+
 end

data/spec/custom_attributes/has_custom_attributes_spec.rb

@@ -1,19 +1,13 @@
 require File.expand_path('../../spec_helper', __FILE__)
 
 describe "Model without custom attributes" do
-
   subject { Location }
-
   it { should_not have_custom_attributes }
-
 end
 
 describe "Model with custom attributes" do
-
   subject { Person }
-
   it { should have_custom_attributes }
-
 end
 
 describe "Custom attributes of a person" do
@@ -21,11 +15,12 @@ describe "Custom attributes of a person" do
     clean_database!
 
     I18n.backend.store_translations :'nl', {
-            :activerecord => {:custom_attributes => {:person => {:telephone => {:private => "Prive"}}}}
+            :activerecord => {:custom_attributes => {:person => {:telephone => {:private => "Prive"}}}},
+            :date         => {:formats => {:default => "%d-%m-%Y"}}
     }
     I18n.default_locale = 'nl'
 
-    @person = Person.new
+    @person             = Person.new
   end
 
   subject { @person.custom_attributes }
@@ -51,7 +46,7 @@ describe "Custom attributes of a person" do
     @person.save
 
     loaded_person = Person.find @person.id
-    fields = loaded_person.custom_attributes.telephone_attributes
+    fields        = loaded_person.custom_attributes.telephone_attributes
     fields.should have(1).item
     fields[0].value.should == "06 28 61 06 28"
   end
@@ -86,7 +81,7 @@ describe "Custom attributes of a person" do
   it "should mark attributes for deletion" do
     @person.custom_attributes.add_telephone "Prive", "06 28 61 06 28"
 
-    fields = @person.custom_attributes.telephone_attributes
+    fields         = @person.custom_attributes.telephone_attributes
     fields.should have(1).item
     fields[0].mark_for_destruction
 
@@ -100,7 +95,7 @@ describe "Custom attributes of a person" do
   it "should accept post data in an custom_attributes hash" do
     # field format is #{@object.class.model_name.underscore}[custom_attributes][#{attribute_type}][#{field_type}][]
 
-    custom_attribute_post_data = {
+    custom_attribute_post_data        = {
             "telephone" => {
                     "0" => {
                             "label" => "Prive",
@@ -111,7 +106,7 @@ describe "Custom attributes of a person" do
                             "value" => "1234567890"
                     }
             },
-            "email" => {
+            "email"     => {
                     "0" => {
                             "label" => "Prive",
                             "value" => "matthijs.groen@gmail.com"
@@ -119,9 +114,9 @@ describe "Custom attributes of a person" do
             }
     }
 
-    @person.custom_attributes = custom_attribute_post_data
+    @person.custom_attributes         = custom_attribute_post_data
 
-    fields = @person.custom_attributes.telephone_attributes
+    fields                            = @person.custom_attributes.telephone_attributes
     fields.should have(2).items
     fields[0].value.should == "06 28 61 06 28"
     fields[1].value.should == "1234567890"
@@ -130,31 +125,63 @@ describe "Custom attributes of a person" do
     custom_attribute_second_post_data = {
             "telephone" => {
                     "0" => {
-                            "label" => "Prive",
-                            "value" => "06 28 61 06 28",
+                            "label"    => "Prive",
+                            "value"    => "06 28 61 06 28",
                             "_destroy" => true
                     },
                     "1" => {
-                            "label" => "Werk",
-                            "value" => "1234567890",
+                            "label"    => "Werk",
+                            "value"    => "1234567890",
                             "_destroy" => "false"
                     }
             },
-            "email" => {
+            "email"     => {
                     "0" => {
                             "label" => "Prive",
                             "value" => "matthijs.groen@gmail.com"
                     }
             }
     }
-    @person.custom_attributes = custom_attribute_second_post_data
+    @person.custom_attributes         = custom_attribute_second_post_data
 
-    fields = @person.custom_attributes.telephone_attributes
+    fields                            = @person.custom_attributes.telephone_attributes
     fields.should have(1).items
     fields[0].value.should == "1234567890"
 
   end
 
+  it "should invalidate incorrect values" do
+    custom_attribute_invalid_post_data = {
+            "date" => {
+                    "0" => {
+                            "label" => "Born on",
+                            "value" => "23422stufferror"
+
+                    }
+            }
+    }
+    @person.custom_attributes          = custom_attribute_invalid_post_data
+    @person.should_not be_valid
+
+    date_attributes = @person.custom_attributes.date_attributes
+    date_attributes.should have(1).items
+    date_attributes[0].should_not be_valid
+  end
+
+  it "should validate correct values" do
+    custom_attribute_valid_post_data   = {
+            "date" => {
+                    "0" => {
+                            "label" => "Born on",
+                            "value" => "31-05-1981"
+
+                    }
+            }
+    }
+    @person.custom_attributes          = custom_attribute_valid_post_data
+    @person.should be_valid
+  end
+
 end
 
 describe "Custom attributes of a product" do
@@ -199,4 +226,19 @@ describe "Custom attributes of a product" do
     @product.custom_attributes.size_value_of(:width).should == nil
   end
 
+  it "should run custom validations as method" do
+    @product.custom_attributes.add_size "Width", 16.3 # too large
+    @product.should_not be_valid
+  end
+
+  it "should run custom validations as lambda (value incorrect)" do
+    @product.custom_attributes.add_date "In stock since", Date.civil(2009, 12, 31)
+    @product.should_not be_valid
+  end
+
+  it "should run custom validations as lambda (value correct)" do
+    @product.custom_attributes.add_date "In stock since", Date.civil(2010, 1, 1)
+    @product.should be_valid
+  end
+
 end

data/spec/models.rb

@@ -3,7 +3,11 @@ class Person < ActiveRecord::Base
   has_custom_attributes :telephone => :string, :email => :string do |fields|
     fields.telephone :work, :private, :mobile, :fax
     fields.email :work, :private
-    fields.date :born_on, :wed_on, :died_on, :on_model => [ :born_on ]
+    fields.date :born_on, :wed_on, :died_on, :on_model => [:born_on]
+  end
+
+  def attribute_email(errors)
+
   end
 
 end
@@ -14,7 +18,13 @@ class Product < ActiveRecord::Base
 
   has_custom_attributes :size => :float do |fields|
     fields.size :width, :height, :depth
-    fields.url :details, :on_model => { :details => :details_url }
+    fields.size :validate_all_with => :attribute_size_validation
+    fields.url :details, :on_model => {:details => :details_url}
+    fields.date :in_stock_since, :validate_with => lambda { |attribute| attribute.errors.add(:value, "must be after 2010") if attribute.value.to_date.year < 2010 }
+  end
+
+  def attribute_size_validation(attribute)
+    attribute.errors.add(:value, "should be between 1 and 10") if attribute.value < 1 or attribute.value > 10
   end
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: custom-attributes
 version: !ruby/object:Gem::Version 
-  hash: 53
+  hash: 51
   prerelease: false
   segments: 
   - 0
   - 2
-  - 17
-  version: 0.2.17
+  - 18
+  version: 0.2.18
 platform: ruby
 authors: 
 - Matthijs Groen
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-20 00:00:00 +02:00
+date: 2010-10-27 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -45,6 +45,7 @@ files:
 - lib/generators/custom_attributes/migration/migration_generator.rb
 - lib/generators/custom_attributes/migration/templates/active_record/migration.rb
 - rails/init.rb
+- spec/custom_attributes/custom_attributes.sqlite3
 - spec/custom_attributes/has_custom_attributes_spec.rb
 - spec/database.yml
 - spec/database.yml.sample