datts_right 0.0.31 → 0.0.32

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    datts_right (0.0.31)
+    datts_right (0.0.32)
       datts_right
 
 GEM

data/VERSION

@@ -1 +1 @@
-0.0.31
+0.0.32

data/datts_right.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{datts_right}
-  s.version = "0.0.31"
+  s.version = "0.0.32"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ramon Tayag"]
-  s.date = %q{2011-04-27}
+  s.date = %q{2011-04-29}
   s.description = %q{Creates a separate table that saves all your dynamic attributes.}
   s.email = %q{ramon@tayag.net}
   s.extra_rdoc_files = [
@@ -31,12 +31,14 @@ Gem::Specification.new do |s|
     "lib/datts_right.rb",
     "lib/datts_right/base.rb",
     "lib/datts_right/category.rb",
+    "lib/datts_right/category_without_reflection.rb",
     "lib/datts_right/dynamic_attribute.rb",
     "lib/datts_right/dynamic_attribute_definition.rb",
     "lib/datts_right/errors.rb",
     "lib/datts_right/exceptions.rb",
     "lib/datts_right/instance_methods.rb",
     "lib/datts_right/page.rb",
+    "lib/datts_right/page_without_reflection.rb",
     "lib/datts_right/query_methods.rb",
     "spec/datt_spec.rb",
     "spec/datts_right/add_definition_spec.rb",
@@ -55,6 +57,7 @@ Gem::Specification.new do |s|
     "spec/datts_right/remove_definition_spec.rb",
     "spec/datts_right/remove_definitions_spec.rb",
     "spec/datts_right/remove_dynamic_attribute_spec.rb",
+    "spec/datts_right/sync_definition_spec.rb",
     "spec/datts_right/update_definition_spec.rb",
     "spec/datts_right/update_definitions_spec.rb",
     "spec/datts_right/where_dynamic_attribute_spec.rb",
@@ -87,6 +90,7 @@ Gem::Specification.new do |s|
     "spec/datts_right/remove_definition_spec.rb",
     "spec/datts_right/remove_definitions_spec.rb",
     "spec/datts_right/remove_dynamic_attribute_spec.rb",
+    "spec/datts_right/sync_definition_spec.rb",
     "spec/datts_right/update_definition_spec.rb",
     "spec/datts_right/update_definitions_spec.rb",
     "spec/datts_right/where_dynamic_attribute_spec.rb",

data/lib/datts_right/base.rb

@@ -8,7 +8,7 @@ module DattsRight
       has_many :dynamic_attributes, :as => :attributable, :dependent => :destroy
       has_one :dynamic_attribute_definition, :as => :attribute_defineable, :dependent => :destroy
       after_save :save_dynamic_attribute_definition
-      after_create :create_dynamic_attribute_definition_if_needed, :inherit_definition
+      after_create :create_dynamic_attribute_definition_if_needed, :inherit_definition!
       delegate :definition, :definition=, :to => :dynamic_attribute_definition
 
       # Carry out delayed actions before save
@@ -17,6 +17,7 @@ module DattsRight
       after_find :cache_dynamic_attributes
       default_scope includes(:dynamic_attributes).includes(:dynamic_attribute_definition)
 
+      #validate :must_be_reflected_by_definer
 
       # scope :scope_self when looking through attributes so we don't look through all dynamic_attributes
       # Why? What if you have Friend and Page models. 
@@ -74,6 +75,38 @@ module DattsRight
         end
       end
 
+      def self.defines?(klass=nil)
+        return false unless !dynamic_attributes_options[:defines].nil? && !dynamic_attributes_options[:defines].empty?
+        #puts "There is [:defines], and it's not empty"
+        if klass
+          klass = klass.class unless klass.is_a?(Class)
+          klass_symbol = klass.name.downcase.to_sym
+          dynamic_attributes_options[:defines].include?(klass_symbol)
+        else
+          true
+        end
+      end
+
+      def self.defines
+        dynamic_attributes_options[:defines] if defines?
+      end
+
+      def self.defined?
+        dynamic_attributes_options[:of]
+      end
+
+      def self.defined_by?(arg)
+        return false unless self.defined?
+        symbol = if arg.is_a?(Class)
+          arg.name.underscore.to_sym
+        elsif arg.is_a?(Symbol)
+          arg
+        else # should be an instance
+          arg.class.name.underscore.to_sym
+        end
+        dynamic_attributes_options[:of] == symbol
+      end
+
       private
 
       def self.method_missing(method_id, *arguments)

data/lib/datts_right/category.rb

@@ -1,5 +1,5 @@
 class Category < ActiveRecord::Base
-  has_dynamic_attributes :definition => true
+  has_dynamic_attributes :defines => [:page]
   has_many :pages
 
   def definition_attributes=(new_attributes)

data/lib/datts_right/category_without_reflection.rb

@@ -0,0 +1,4 @@
+class CategoryWithoutReflection < ActiveRecord::Base
+  set_table_name "categories"
+  has_dynamic_attributes :defines => [:something_else]
+end

data/lib/datts_right/instance_methods.rb

@@ -117,7 +117,7 @@ module DattsRight
     end
 
     def create_dynamic_attribute_definition_if_needed
-      if dynamic_attributes_options[:definition]
+      if self.defines?
         DynamicAttributeDefinition.create :attribute_defineable_id => self.id, :attribute_defineable_type => self.class.name, :definition => {}
       end
     end
@@ -126,7 +126,9 @@ module DattsRight
       if key
         key = key.to_sym
         #puts "add_definition(:#{key}, #{value.inspect}). current definition: #{definition.nil?}"
-        if dynamic_attributes_options[:definition]
+        if dynamic_attributes_options[:defines].nil? || dynamic_attributes_options[:defines].empty?
+          raise NoDefinitionError
+        else
           #puts ":definition is true, so let's see if definition[:#{key}] already exists"
           # Checking definition straight seems to cause a problem. Is this a bug with Rails?
           # The problem was like this (assuming definition was actually nil):
@@ -142,8 +144,6 @@ module DattsRight
           else
             definition.merge!({key => value})
           end
-        else
-          raise NoDefinitionError
         end
       else
         raise AttributeKeyRequired
@@ -180,25 +180,20 @@ module DattsRight
     end
 
     def update_definition(key, new_values={})
-      if dynamic_attributes_options[:definition]
-        if definition && definition[key]
-          attr_key = new_values.symbolize_keys[:attr_key]
-          new_values.each do |k, v|
-            definition[key][k] = v unless k.to_s == "attr_key"
-          end
+      raise NoDefinitionError unless self.defines?
+      raise NotDefinedError, "#{key} is not defined" unless definition && definition[key]
 
-          #puts "attr_key is #{attr_key}, key is #{key}"
-          if attr_key && attr_key != key.to_s
-            #puts "Adding definition: #{attr_key} => #{definition[key]}"
-            add_definition(attr_key, definition[key])
-            #puts "Removing definition: #{key} => #{definition[key]}"
-            remove_definition(key)
-          end
-        else
-          raise NotDefinedError, "#{key} is not defined"
-        end
-      else
-        raise NoDefinitionError
+      attr_key = new_values.symbolize_keys[:attr_key]
+      new_values.each do |k, v|
+        definition[key][k] = v unless k.to_s == "attr_key"
+      end
+
+      #puts "attr_key is #{attr_key}, key is #{key}"
+      if attr_key && attr_key != key.to_s
+        #puts "Adding definition: #{attr_key} => #{definition[key]}"
+        add_definition(attr_key, definition[key])
+        #puts "Removing definition: #{key} => #{definition[key]}"
+        remove_definition(key)
       end
     end
 
@@ -211,15 +206,9 @@ module DattsRight
     def remove_definition(key)
       if key
         key = key.to_sym
-        if dynamic_attributes_options[:definition]
-          if definition && definition[key]
-            definition.delete(key)
-          else
-            raise NotDefinedError, "#{key} is not defined"
-          end
-        else
-          raise NoDefinitionError
-        end
+        raise NoDefinitionError unless self.defines?
+        raise NotDefinedError, "#{key} is not defined" unless definition && definition[key]
+        definition.delete(key)
       end
     end
 
@@ -231,6 +220,71 @@ module DattsRight
       end
     end
 
+    # Adds dynamic attributes to inheriting model, based on the definition of the defining model.
+    #   class InheritingModel < AR::Base
+    #     has_dynamic_attributes :of => :defining_model
+    #   end
+    #
+    # The DefiningModel should have the code:
+    #   class DefiningModel < AR::Base
+    #     has_dynamic_attributes :defines => [:inheriting_model]
+    #   end
+    #
+    # Example:
+    #   @defining_model.add_definitions(:name => {:object_type => "string"}, :body => {:object_type => "text"})
+    #   @defining_model.save
+    #   InheritingModel.create # creates an instance with dynamic attributes: name and body, that are "string" and "text", respectively
+    #
+    # Calling this method manually only _adds_ to the inheriting instance you call it on. If you remove some definitions from the defining model, then you call @inheriting_model.inherit_definition!@, the new definitions will be added. If there are no new definitions, nothing will happen.
+    def inherit_definition!
+      #puts "In inherit_definition"
+      #puts "------- #{dynamic_attributes_options[:of]}"
+      #dynamic_attribute_definition.create if dynamic_attributes_options[:definition]
+      if self.defined? && defining_record
+        defining_record.definition.each do |k, v|
+          datt = add_dynamic_attribute(k, v[:object_type])
+          datt.dynamic_attribute_definition
+          #puts "Added #{datt.inspect}"
+        end
+      end
+    end
+
+    # Adds and removes dynamic attributes based on the defining record
+    def sync_definition!
+      defining_record.definition.each do |k, v|
+        add_dynamic_attribute(k, v[:object_type]) if dynamic_attribute_details(k).nil?
+      end
+      @dynamic_attributes_cache.each do |k, v|
+        #puts "Remove #{k}?"
+        remove_dynamic_attribute(k) if v.definer.nil?
+      end
+    end
+
+    # Returns true if this defines any other class
+    def defines?(klass=nil)
+      self.class.defines?(klass)
+    end
+
+    # Returns true if this is defined by any other class
+    def defined?
+      self.class.defined?
+    end
+
+    # Returns true if the calling instance is defined by the argument
+    def defined_by?(arg)
+      self.class.defined_by?(arg)
+    end
+
+    # Returns an array of symbols of the classes that this defines
+    def defines
+      self.class.defines
+    end
+
+    #def must_be_reflected_by_definer
+      #errors.add(:base, "#{self.class.name} inherits its definition from #{dynamic_attributes_options[:of]} but that does not define #{self.class.name}.") \
+        #unless dynamic_attributes_options[:of].to_s.classify.constantize.defines?(self.class)
+    #end
+
     private
 
     # Called after validation on update so that dynamic attributes behave
@@ -267,22 +321,6 @@ module DattsRight
       dynamic_attribute_definition.save if dynamic_attribute_definition
     end
 
-    def inherit_definition
-      #puts "In inherit_definition"
-      #puts "------- #{dynamic_attributes_options[:of]}"
-      #dynamic_attribute_definition.create if dynamic_attributes_options[:definition]
-      if dynamic_attributes_options[:of]
-        #puts "There is a defining record of #{self.class.name}##{self.name} in #{defining_record.inspect}. #{defining_record.dynamic_attribute_definition.inspect}"
-        if defining_record
-          defining_record.definition.each do |k, v|
-            datt = add_dynamic_attribute(k, v[:object_type])
-            datt.dynamic_attribute_definition
-            #puts "Added #{datt.inspect}"
-          end
-        end
-      end
-    end
-
     alias :add_datt :add_dynamic_attribute
     alias :add_datt! :add_dynamic_attribute!
     alias :remove_datt :remove_dynamic_attribute

data/lib/datts_right/page_without_reflection.rb

@@ -0,0 +1,9 @@
+class PageWithoutReflection < ActiveRecord::Base
+  set_table_name "pages"
+  belongs_to :category_without_reflection
+  has_dynamic_attributes :of => :category_without_reflection
+
+  def virtual_attribute=(something)
+    puts "Setting virtual_attribute to #{something}"
+  end
+end

data/spec/datts_right/definition_spec.rb

@@ -4,4 +4,50 @@ describe DattsRight, "on the definition" do
   it "should not be created if it is not defined" do
     Page.create.dynamic_attribute_definition.should be_nil
   end
+
+  describe ".defines?" do
+    it "should return true if nil is passed, and it has the option and it's not empty" do
+      Category.defines?.should be_true
+      Category.new.defines?.should be_true
+    end
+
+    it "should return true if a class is passed, it has the option, and it defines the class" do
+      Category.defines?(Page).should be_true
+      Category.new.defines?(Page).should be_true
+      Category.defines?(Page.new).should be_true
+      Category.new.defines?(Page.new).should be_true
+    end
+  end
+
+  describe ".defines" do
+    it "should return the array of classes that it defines" do
+      Category.defines.should == [:page]
+      Category.new.defines.should == [:page]
+    end
+
+    it "should return nil if it does not define anything" do
+      Page.defines.should be_nil
+      Page.new.defines.should be_nil
+    end
+  end
+
+  describe ".defined?" do
+    it "should return true if it has the option and it's not empty" do
+      Page.defined?.should be_true
+      Page.new.defined?.should be_true
+    end
+  end
+
+  describe ".defined_by?(klass_or_instance)" do
+    it "should return true if a class is passed, it has the option, and it defines the class" do
+      Page.defined_by?(Category).should be_true
+      Page.defined_by?(Category.new).should be_true
+      Page.defined_by?(:category).should be_true
+    end
+
+    it "should be the same as the instance method" do
+      Page.should_receive(:defined_by?).with(Category)
+      Page.new.defined_by?(Category)
+    end
+  end
 end

data/spec/datts_right/sync_definition_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe DattsRight, ".sync_definition!" do
+  before do
+    reset_database
+    @category = Category.create
+    @category.definition = {:teaser => {:object_type => "text"}, :body => {:object_type => "text"}}
+    @category.save
+    @page = Page.create :category => @category
+  end
+
+  it "should add any new definitions" do
+    @category.add_definition(:price, {:object_type => "integer"})
+    @category.save
+    @page.sync_definition!
+    @page.dynamic_attribute_details(:price)[:object_type].should == "integer"
+  end
+
+  it "should remove any dynamic attributes if the definitions are removed" do
+    @category.remove_definition(:body)
+    @category.save
+    @page.sync_definition!
+    @page.dynamic_attribute_details(:teaser)[:object_type].should == "text"
+    lambda {@page.body}.should raise_error(NoMethodError)
+  end
+end

data/spec/datts_right_spec.rb

@@ -178,4 +178,8 @@ describe DattsRight do
   it "should still allow virtual attributes to work (for mass assignment)" do
     lambda {Category.create.update_attributes(:definition_attributes => {"attr_key" => "some_attr", "object_type" => "string"}, :name => "hello")}.should_not raise_error(ActiveRecord::UnknownAttributeError)
   end
+
+  #it "should validate reflection of inheritance" do
+    #PageWithoutReflection.new.errors[:base].should include("Page inherits its definition from category_without_reflection but that does not define Page.")
+  #end
 end

data/spec/spec_helper.rb

@@ -6,7 +6,9 @@ require 'active_record/errors'
 require 'rspec'
 require 'datts_right'
 require 'datts_right/page'
+require 'datts_right/page_without_reflection'
 require 'datts_right/category'
+require 'datts_right/category_without_reflection'
 
 # Allow to connect to SQLite
 root = File.expand_path(File.join(File.dirname(__FILE__), '..'))

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: datts_right
 version: !ruby/object:Gem::Version 
-  hash: 33
+  hash: 95
   prerelease: 
   segments: 
   - 0
   - 0
-  - 31
-  version: 0.0.31
+  - 32
+  version: 0.0.32
 platform: ruby
 authors: 
 - Ramon Tayag
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-27 00:00:00 +08:00
+date: 2011-04-29 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -162,12 +162,14 @@ files:
 - lib/datts_right.rb
 - lib/datts_right/base.rb
 - lib/datts_right/category.rb
+- lib/datts_right/category_without_reflection.rb
 - lib/datts_right/dynamic_attribute.rb
 - lib/datts_right/dynamic_attribute_definition.rb
 - lib/datts_right/errors.rb
 - lib/datts_right/exceptions.rb
 - lib/datts_right/instance_methods.rb
 - lib/datts_right/page.rb
+- lib/datts_right/page_without_reflection.rb
 - lib/datts_right/query_methods.rb
 - spec/datt_spec.rb
 - spec/datts_right/add_definition_spec.rb
@@ -186,6 +188,7 @@ files:
 - spec/datts_right/remove_definition_spec.rb
 - spec/datts_right/remove_definitions_spec.rb
 - spec/datts_right/remove_dynamic_attribute_spec.rb
+- spec/datts_right/sync_definition_spec.rb
 - spec/datts_right/update_definition_spec.rb
 - spec/datts_right/update_definitions_spec.rb
 - spec/datts_right/where_dynamic_attribute_spec.rb
@@ -246,6 +249,7 @@ test_files:
 - spec/datts_right/remove_definition_spec.rb
 - spec/datts_right/remove_definitions_spec.rb
 - spec/datts_right/remove_dynamic_attribute_spec.rb
+- spec/datts_right/sync_definition_spec.rb
 - spec/datts_right/update_definition_spec.rb
 - spec/datts_right/update_definitions_spec.rb
 - spec/datts_right/where_dynamic_attribute_spec.rb