custom_fields 1.0.0.beta.25 → 1.1.0.rc1

data/lib/custom_fields/field.rb

@@ -25,31 +25,33 @@ module CustomFields
     field :required, :type => Boolean, :default => false
 
     ## validations ##
-    validates_presence_of :label, :kind
-    validates_exclusion_of :_alias, :in => Module.new {
-      def self.include?(el); CustomFields.options[:reserved_aliases].include?(el); end
-    }
-    validates_format_of :_alias, :with => /^[a-z]([A-Za-z0-9_]+)?$/
-    validate :uniqueness_of_label_and_alias
+    validates_presence_of   :label, :kind
+    validates_exclusion_of  :_alias, :in => lambda { |f| CustomFields.options[:reserved_aliases].map(&:to_s) }
+    validates_format_of     :_alias, :with => /^[a-z]([A-Za-z0-9_]+)?$/
+    validate                :uniqueness_of_label_and_alias
 
     ## other accessors ##
-    attr_accessor :association_name # missing in 2.0.0 rc 7
-
     attr_accessor :parentized_done # for performance purpose
 
     ## callbacks ##
     before_validation :set_alias
-    after_validation  :set_target_klass_flag
-
-    before_save     :invalidate_target_klass
-    after_destroy   :invalidate_target_klass
+    before_save       :invalidate_proxy_klass
 
     ## methods ##
 
+    # Returns the type class related to this field
+    #
+    # @return [ Class ] The class defining the field type
+    #
     def field_type
       self.class.field_types[self.safe_kind.to_sym]
     end
 
+    # Enhance a document class by applying to it the information stored
+    # in the type related to this field
+    #
+    # @param [ Class ] klass The document class
+    #
     def apply(klass)
       klass.field self._name, :type => self.field_type if self.field_type
 
@@ -70,33 +72,75 @@ module CustomFields
       end
     end
 
+    # Make sure it returns a valid alias
+    #
+    # @return [ String ] the alias
+    #
     def safe_alias
       self.set_alias
       self._alias
     end
 
+    # Returns the kind (or type) of the current field.
+    # Because of compatibility purpose, prior version of CustomFields used to have the value of kind in uppercase.
+    #
+    # @return [ String ] the kind
+    #
     def safe_kind
-      self.kind.downcase # for compatibility purpose: prior version of CustomFields used to have the value of kind in uppercase.
-    end
-
-    def write_attributes_with_invalidation(attrs = nil)
-      klass = self._parent.send(:"fetch_#{singular_target_name}_klass")
-
-      write_attributes_without_invalidation(attrs)
-
-      klass.apply_custom_field(self)
+      self.kind.downcase
+    end
+
+    # Returns the name of the relation binding this field and the custom_fields in the parent class
+    #
+    # @example:
+    #   class Company
+    #     embeds_many :employees
+    #     custom_fields_for :employees
+    #   end
+    #
+    #   field = company.employees_custom_fields.build :label => 'His/her position', :_alias => 'position', :kind => 'string'
+    #   field.custom_fields_relation_name == 'employees'
+    #
+    # @return [ String ] the relation's name
+    #
+    def custom_fields_relation_name
+      self.metadata.name.to_s.gsub('_custom_fields', '')
+    end
+
+    # Checks if the field is valid without running the callback which marks
+    # the proxy class as invalidated
+    #
+    # @return [ Boolean ] true if the field has no errors, false otherwise
+    def quick_valid?
+      # true
+      # CustomFields::Field.without_callback(:validation, :after, :invalidate_proxy_klass) do
+      CustomFields::Field.without_callback(:save, :before, :invalidate_proxy_klass) do
+        self.valid?
+      end
     end
 
-    alias_method_chain :write_attributes, :invalidation
-
-    def singular_target_name
-      if self.association_name.to_s == '_metadata_custom_fields'
-        'metadata'
-      else
-        self.association_name.to_s.gsub('_custom_fields', '').singularize
+    # Destroys a field and saves the parent too in order to keep track of the changes
+    # for the parent (for instance, the version has to be bumped).
+    #
+    # @param [ Hash ] options Options to pass to destroy.
+    #
+    # @return [ true, false ] True if successful, false if not.
+    #
+    def destroy(options = {})
+      super.tap do
+        self.mark_proxy_klass_flag_as_invalidated
+        self._parent.save
       end
     end
 
+    # Collects all the important attributes of this field.
+    # It also accepts an extra hash which will be merged with
+    # the one built by this method (by default, this is an empty hash)
+    #
+    # @param [ Hash ] more The extra hash
+    #
+    # @return [ Hash ] the hash
+    #
     def to_hash(more = {})
       self.fields.keys.inject({}) do |memo, meth|
         memo[meth] = self.send(meth.to_sym); memo
@@ -114,6 +158,10 @@ module CustomFields
       }).merge(more)
     end
 
+    # Overides the default behaviour of the to_json method by using the to_hash method
+    #
+    # @return [ String ] the json object
+    #
     def to_json
       ActiveSupport::JSON.encode(self.to_hash)
     end
@@ -143,48 +191,36 @@ module CustomFields
     end
 
     def increment_counter!
-      next_value = (self._parent.send(:"#{self.association_name}_counter") || 0) + 1
-      self._parent.send(:"#{self.association_name}_counter=", next_value)
-      next_value
+      name = self.custom_fields_relation_name
+      self._parent.bump_custom_fields_counter(name)
     end
 
     def siblings
-      self._parent.send(self.association_name)
+      self._parent.send(self.metadata.name)
     end
 
     def parentize_with_custom_fields(object)
       return if self.parentized_done
 
-      object_name = object.class.to_s.underscore
-
-      self.association_name = self.metadata ? self.metadata.name : self.relations[object_name].inverse_of
-
       parentize_without_custom_fields(object)
 
       self.send(:set_unique_name!)
 
       self.parentized_done = true
     end
-
     alias_method_chain :parentize, :custom_fields
 
-    def invalidate_target_klass
-      # puts "[field/#{self.label}] invalidate_target_klass" # for debug purpose
-      if self._parent.instance_variable_get(:@_writing_attributes_with_custom_fields)
-        if self.destroyed? # force the parent to invalidate the related target class
-          self.set_target_klass_flag
-        elsif self.changed?
-          self.set_target_klass_flag
-        end
-      else
-        self.set_target_klass_flag
-        self._parent.save
+    def invalidate_proxy_klass
+      # puts "#{self._name} / #{self._alias} _ invalidate_proxy_klass !!! #{self.flagged_for_destroy?} / #{self.destroyed?}"
+      if self.changed? || self.flagged_for_destroy?
+        self.mark_proxy_klass_flag_as_invalidated
       end
     end
 
-    def set_target_klass_flag
-      # puts "[field/set_target_klass_flag/#{self.label}] called" # debug purpose
-      self._parent.send(:"invalidate_#{self.singular_target_name}_klass_flag=", true)
+    def mark_proxy_klass_flag_as_invalidated
+      # puts "\t*** [mark_proxy_klass_flag_as_invalidated] called for '#{self._name}'"
+      name = self.custom_fields_relation_name
+      self._parent.mark_klass_with_custom_fields_as_invalidated(name)
     end
 
   end

data/lib/custom_fields/proxy_class/base.rb

@@ -0,0 +1,112 @@
+module CustomFields
+  module ProxyClass
+
+    module Base
+
+      extend ActiveSupport::Concern
+
+      included do
+        cattr_accessor :custom_fields, :_parent, :association_name, :built_at, :version
+      end
+
+      module InstanceMethods
+
+        # Returns the list of the custom fields used to build this class
+        #
+        # @return [ List ] the list of custom fields
+        #
+        def custom_fields
+          self.class.custom_fields
+        end
+
+        # Returns the fields specified by the custom fields and their values
+        #
+        # @return [ Hash ] the hash
+        #
+        def aliased_attributes
+          hash = { :created_at => self.created_at, :updated_at => self.updated_at } rescue {}
+
+          (self.custom_fields || []).each do |field|
+            case field.kind
+            when 'file' then hash[field._alias] = self.send(field._name.to_sym).url
+            else
+              hash[field._alias] = self.send(field._name.to_sym)
+            end
+          end
+
+          hash
+        end
+
+      end
+
+      module ClassMethods
+
+        # Returns the fields specified by the custom fields and their values
+        #
+        def model_name
+          @_model_name ||= ActiveModel::Name.new(self.superclass)
+        end
+
+        # Declares a field within the class based on the information given by the custom field
+        #
+        # @param [ Field ] field The custom field
+        #
+        def apply_custom_field(field)
+          # puts "field #{field._name} persisted? #{field.persisted?} / valid ? #{field.quick_valid?}"
+          return if !field.persisted? || !field.quick_valid?
+
+          self.custom_fields ||= []
+
+           if self.lookup_custom_field(field._name).nil?
+             self.custom_fields << field
+             field.apply(self)
+           end
+        end
+
+        # Determines if the class has already declared the field
+        #
+        # @param [ String ] name The name of the custom field
+        #
+        # @return [ true, false ] True if found it, false if not.
+        #
+        def lookup_custom_field(name)
+          self.custom_fields.detect { |f| f._name == name }
+        end
+
+        # Convenient method to get the name of a custom field from its alias
+        #
+        # @param [ String ] value The _alias value of the custom field
+        #
+        # @return [ String ] The name of the custom field.
+        #
+        def custom_field_alias_to_name(value)
+          self.custom_fields.detect { |f| f._alias == value }._name
+        end
+
+        # Convenient method to get the _alias of a custom field from its name
+        #
+        # @param [ String ] value The name value of the custom field
+        #
+        # @return [ String ] The _alias of the custom field.
+        #
+        def custom_field_name_to_alias(value)
+          self.custom_fields.detect { |f| f._name == value }._alias
+        end
+
+        # Tells Mongoid that this class is a child of a super class (even if it is no true)
+        #
+        def hereditary?
+          false
+        end
+
+      end
+
+    end
+
+  end
+end
+
+
+
+
+

data/lib/custom_fields/proxy_class/builder.rb

@@ -0,0 +1,60 @@
+module CustomFields
+  module ProxyClass
+
+    module Builder
+
+      # Returns the proxy class based on the current class and enhanced by the custom fields.
+      # If the custom fields have been modified, then a new version
+      # of the proxy class is built
+      #
+      # @param [ String, Symbol ] name The name of the relation in the parent object
+      # @param [ Document ] parent The parent document describing the custom fields
+      # @param [ List ] fields The list of custom fields
+      #
+      # @return [ Class ] The proxy class.
+      #
+      def to_klass_with_custom_fields(name, parent, fields)
+        klass = self.klass_with_custom_fields(name, parent)
+
+        if klass && klass.version != self.klass_version_with_custom_fields(name, parent) # new version ?
+          self.invalidate_klass_with_custom_fields(name, parent)
+          klass = nil
+        end
+
+        if klass.nil?
+          klass       = self.build_klass_with_custom_fields(name, parent, fields)
+          klass_name  = self.klass_name_with_custom_fields(name, parent)
+
+          Object.const_set(klass_name, klass)
+        end
+
+        klass
+      end
+
+      # Builds the proxy class based on the current class and enhanced by the custom fields.
+      #
+      # @param [ String, Symbol ] name The name of the relation in the parent object
+      # @param [ Document ] parent The parent document describing the custom fields
+      # @param [ List ] fields The list of custom fields
+      #
+      # @return [ Class ] The proxy class.
+      #
+      def build_klass_with_custom_fields(name, parent, fields)
+        # puts "CREATING new '#{name}' klass (#{self.klass_version_with_custom_fields(name, parent)})"
+        Class.new(self).tap do |klass|
+          klass.send :include, CustomFields::ProxyClass::Base
+
+          # copy scopes from the parent class (scopes does not inherit automatically from the parents in mongoid)
+          klass.write_inheritable_attribute(:scopes, self.scopes)
+
+          klass.association_name  = name.to_sym
+          klass._parent           = parent
+          klass.version           = self.klass_version_with_custom_fields(name, parent)
+
+          [*fields].each { |field| klass.apply_custom_field(field) }
+        end
+      end
+    end
+
+  end
+end

data/lib/custom_fields/proxy_class/helper.rb

@@ -0,0 +1,57 @@
+module CustomFields
+  module ProxyClass
+
+    module Helper
+
+      # Gets the name of the proxy class built with the custom fields.
+      #
+      # @param [ String, Symbol ] name The name of the relation in the parent object
+      # @param [ Document ] parent The parent document describing the custom fields
+      #
+      # @return [ String ] The class name
+      #
+      def klass_name_with_custom_fields(name, parent)
+        "#{name.to_s.gsub(/^_/, '').singularize.camelize}#{parent.class.name.camelize}#{parent._id}"
+      end
+
+      # Returns the current proxy class built with the custom fields.
+      #
+      # @param [ String, Symbol ] name The name of the relation in the parent object
+      # @param [ Document ] parent The parent document describing the custom fields
+      #
+      # @return [ Class ] The proxy class
+      #
+      def klass_with_custom_fields(name, parent)
+        klass_name = self.klass_name_with_custom_fields(name, parent)
+        Object.const_defined?(klass_name) ? Object.const_get(klass_name): nil
+      end
+
+      # Returns the version of the proxy class built with the custom fields.
+      #
+      # @param [ String, Symbol ] name The name of the relation in the parent object
+      # @param [ Document ] parent The parent document describing the custom fields
+      #
+      # @return [ String ] The class name
+      #
+      def klass_version_with_custom_fields(name, parent)
+        parent.send(:"#{name}_custom_fields_version")
+      end
+
+      # Destroy the class enhanced by the custom fields so that next time we need it,
+      # we have a fresh new one.
+      #
+      # @param [ String, Symbol ] name The name of the relation in the parent object
+      # @param [ Document ] parent The parent document describing the custom fields
+      #
+      def invalidate_klass_with_custom_fields(name, parent)
+        klass_name = self.klass_name_with_custom_fields(name, parent)
+
+        if Object.const_defined?(klass_name)
+          Object.send(:remove_const, klass_name)
+        end
+      end
+
+    end
+
+  end
+end

data/lib/custom_fields/{metadata.rb → self_metadata.rb}

@@ -1,9 +1,10 @@
 module CustomFields
 
-  class Metadata
+  class SelfMetadata
 
     include ::Mongoid::Document
-    include CustomFields::ProxyClassEnabler
+    extend  CustomFields::ProxyClass::Helper
+    extend  CustomFields::ProxyClass::Builder
 
     ## other accessors ##
     attr_accessor :association_name # missing in 2.0.0 rc

data/lib/custom_fields/version.rb

@@ -1,5 +1,4 @@
-module Mongoid
-  module CustomFields
-    VERSION = "1.0.0.beta.25"
-  end
+# encoding: utf-8
+module CustomFields #:nodoc
+  VERSION = "1.1.0.rc1"
 end

data/lib/custom_fields.rb

@@ -1,12 +1,12 @@
 $:.unshift File.expand_path(File.dirname(__FILE__))
 
 require 'active_support'
-require 'carrierwave'
+require 'carrierwave/mongoid'
 
 module CustomFields
 
   @@options = {
-    :reserved_aliases => Mongoid.destructive_fields
+    :reserved_aliases => Mongoid.destructive_fields + %w(id _id send class)
   }
 
   def self.options=(options)
@@ -20,6 +20,7 @@ module CustomFields
 end
 
 require 'custom_fields/version'
+require 'custom_fields/extensions/active_support'
 require 'custom_fields/extensions/mongoid/document'
 require 'custom_fields/extensions/mongoid/relations/accessors'
 require 'custom_fields/extensions/mongoid/relations/builders'
@@ -34,18 +35,29 @@ require 'custom_fields/types/has_one'
 require 'custom_fields/types/has_many/proxy_collection'
 require 'custom_fields/types/has_many/reverse_lookup_proxy_collection'
 require 'custom_fields/types/has_many'
-require 'custom_fields/proxy_class_enabler'
+require 'custom_fields/proxy_class/base'
+require 'custom_fields/proxy_class/builder'
+require 'custom_fields/proxy_class/helper'
 require 'custom_fields/field'
-require 'custom_fields/metadata'
+require 'custom_fields/self_metadata'
 require 'custom_fields/custom_fields_for'
 
 module Mongoid
   module CustomFields
     extend ActiveSupport::Concern
     included do
+      extend  ::CustomFields::ProxyClass::Helper
       include ::CustomFields::CustomFieldsFor
     end
   end
+
+  module TargetCustomFields
+    extend ActiveSupport::Concern
+    included do
+      extend ::CustomFields::ProxyClass::Helper
+      extend ::CustomFields::ProxyClass::Builder
+    end
+  end
 end
 
 ActiveSupport::Inflector.inflections do |inflect|

metadata

@@ -2,7 +2,7 @@
 name: custom_fields
 version: !ruby/object:Gem::Version 
   prerelease: 6
-  version: 1.0.0.beta.25
+  version: 1.1.0.rc1
 platform: ruby
 authors: 
 - Didier Lafforgue
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-31 00:00:00 Z
+date: 2011-10-27 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: mongoid
@@ -19,7 +19,7 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        version: 2.0.2
+        version: 2.3.2
   type: :runtime
   prerelease: false
   version_requirements: *id001
@@ -30,10 +30,87 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 3.0.9
+        version: 3.1.1
   type: :runtime
   prerelease: false
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: carrierwave-mongoid
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: yard
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.7.3
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bson_ext
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.4.1
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.12
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.6"
+  type: :development
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: database_cleaner
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.6.7
+  type: :development
+  prerelease: false
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: RedCloth
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 4.2.8
+  type: :development
+  prerelease: false
+  version_requirements: *id009
 description: Manage custom fields to a mongoid document or a collection. This module is one of the core features we implemented in our custom cms named Locomotive.
 email: 
 - didier@nocoffee.fr
@@ -49,12 +126,15 @@ files:
 - MIT-LICENSE
 - README.textile
 - lib/custom_fields/custom_fields_for.rb
+- lib/custom_fields/extensions/active_support.rb
 - lib/custom_fields/extensions/mongoid/document.rb
 - lib/custom_fields/extensions/mongoid/relations/accessors.rb
 - lib/custom_fields/extensions/mongoid/relations/builders.rb
 - lib/custom_fields/field.rb
-- lib/custom_fields/metadata.rb
-- lib/custom_fields/proxy_class_enabler.rb
+- lib/custom_fields/proxy_class/base.rb
+- lib/custom_fields/proxy_class/builder.rb
+- lib/custom_fields/proxy_class/helper.rb
+- lib/custom_fields/self_metadata.rb
 - lib/custom_fields/types/boolean.rb
 - lib/custom_fields/types/category.rb
 - lib/custom_fields/types/date.rb
@@ -85,7 +165,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -976967473644545936
+      hash: 1403562502793807305
       segments: 
       - 0
       version: "0"
@@ -98,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: nowarning
-rubygems_version: 1.8.5
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Custom fields extension for Mongoid