freeform 0.0.3.rc1 → 0.0.3.rc2

data/README.md

@@ -12,7 +12,7 @@ FreeForm is designed primarily with Rails in mind, but it should work on any Rub
 
 Add this line to your application's Gemfile:
 
-    gem 'freeform'
+    gem 'freeform', '~> 0.0.3rc2'
 
 And then execute:
 
@@ -212,16 +212,28 @@ form.build_phone_numbers(:phone => Phone.new)
 form.build_phone_number(:phone => Phone.new) 
 ```
 
-You can specify the default initializers for that form with the accessor `#{nested_form_name}_form_initializer`.
+**Working with nested_form gem**
+In order to support the `nested_form` gem, FreeForm currently uses a bit of hackiness. You actually need to specify an option on your nested forms called `class_initializer`, that points to a class method to use to specify the default parameters.  You can either provide the method hardcoded into the class, or set it externally.  It accepts either a hardcoded hash, or a Proc.
 ```ruby
-form = UserForm.new(
-  :user => User.new, 
-  :phone_numbers_form_initializer => {:phone => Phone.new} )
+class UserForm < FreeForm::Form
+  form_models :user
 
-form.build_phone_numbers
-form.build_phone_number
+  property :username,              :on => :user
+  property :email,                 :on => :user
+  
+  nested_form :phone_numbers, :class_initializer => :phone_initializer do
+    form_models :phone
+	
+	property :area_code,              :on => :phone
+	property :number,                 :on => :phone
+  end
+end
+
+UserForm.phone_initializer = lambda { { :phone => Phone.new } }
+form = UserForm.new( :user => User.new )
+form.build_phone_number # Uses Phone.new to initialize the nested form.
 ```
-This is a necessary parameter if you're using the `nested_form` gem, as new nested forms are initialized automatically.
+I apologize for the ugliness - In the future, I plan to roll FreeForm's own version of the `nested_form` javascript functionality.
 
 ## Initialize With Care!
 
@@ -238,7 +250,7 @@ class UserForm < FreeForm::Form
   property :username,              :on => :user
   property :email,                 :on => :user
   
-  nested_form :phone_numbers do
+  nested_form :phone_numbers, :class_initializer => :phone_initializer do
     form_models :phone
 	
 	property :area_code,              :on => :phone
@@ -253,6 +265,7 @@ Will the current_user's phone numbers automatically appear as nested forms? **No
 If you want them there, put them there, like this:
 
 ```ruby
+UserForm.phone_initializer = lambda { { :phone => current_user.phone_numbers.build } }
 current_user.phone_numbers.each do |phone_number|
   form.build_phone_number(:phone => phone_number)
 end

data/lib/freeform/form/nested.rb

@@ -12,6 +12,21 @@ module FreeForm
       attr_accessor :nested_forms      
 
       def nested_form(attribute, options={}, &block)
+        # Specify the class method on which we're defining the initializer for this form.
+        parent_class = self
+        initializer_method = options[:class_initializer]
+        unless initializer_method.nil?
+          define_singleton_method(:"#{initializer_method}") do
+            var = instance_variable_get(:"@#{initializer_method}")
+            var ||= {}
+            var
+          end
+  
+          define_singleton_method(:"#{initializer_method}=") do |val|
+            instance_variable_set(:"@#{initializer_method}", val)
+          end
+        end
+
         # Define an attr_accessor for the parent class to hold this attribute
         declared_model(attribute)
 
@@ -19,6 +34,22 @@ module FreeForm
         nested_form_class = Class.new(FreeForm::Form) do
           include FreeForm::Property
           self.instance_eval(&block)
+          
+          define_singleton_method(:default_initializer) do
+            unless initializer_method.nil?
+              method = parent_class.send(initializer_method)
+              if method.is_a? Proc
+                method.call
+              else
+                method
+              end
+            end
+          end
+
+          def initialize(p={}, *args)
+            p = self.class.default_initializer.merge(p)
+            super(p, *args)
+          end
         end
         self.const_set("#{attribute.to_s.camelize}Form", nested_form_class)
 
@@ -53,18 +84,10 @@ module FreeForm
           @nested_attributes ||= []
         end
         
-        # Example: form.address_form_initializer (aliased to form.addresses_form_initializer)
-        attr_accessor :"#{attribute}_form_initializer"
-        alias_method :"#{singularized_attribute}_form_initializer", :"#{attribute}_form_initializer"
-        alias_method :"#{singularized_attribute}_form_initializer=", :"#{attribute}_form_initializer="
-
         # Example: form.build_addresses (optional custom initializer)
-        define_method(:"build_#{attribute}") do |initializer=nil|
+        define_method(:"build_#{attribute}") do |initializer={}|
           # Get correct class
           form_class = self.class.nested_forms[:"#{attribute}"]
-          
-          # Set default intializer if none provided
-          initializer ||= send("#{attribute}_form_initializer").call
 
           # Build new model
           form_model = form_class.new(initializer)

data/lib/freeform/form/property.rb

@@ -93,4 +93,7 @@ module FreeForm
       end
     end
   end
+  
+  #Instance Methods
+  #----------------------------------------------------------------------------
 end

data/lib/freeform/version.rb

@@ -1,3 +1,3 @@
 module Freeform
-  VERSION = "0.0.3.rc1"
+  VERSION = "0.0.3.rc2"
 end

data/spec/acceptance_spec.rb

@@ -57,12 +57,12 @@ describe FreeForm::Form do
       allow_destroy_on_save
       
       property :username, :on => :user      
-      property :email,    :on => :user      
+      property :email,    :on => :user
       property :street, :on => :address      
       property :city,   :on => :address      
       property :state,  :on => :address      
 
-      has_many :phone_numbers do
+      has_many :phone_numbers, :class_initializer => :phone_number_initializer do
         form_model :phone
         validate_models
         allow_destroy_on_save
@@ -79,11 +79,8 @@ describe FreeForm::Form do
   end
 
   let(:form) do
-    form_model = form_class.new( 
-      :user => user_class.new, 
-      :address => address_class.new,
-      :phone_numbers_form_initializer => lambda { { :phone => phone_class.new } }
-      )
+    form_class.phone_number_initializer = lambda { {:phone => phone_class.new} }
+    form_model = form_class.new( :user => user_class.new, :address => address_class.new)
     form_model.build_phone_number
     form_model
   end

data/spec/form/nested_spec.rb

@@ -9,13 +9,13 @@ describe FreeForm::Nested do
         klass = Class.new(Module) do
           include FreeForm::Property
           include FreeForm::Nested
-
-          has_many :mailing_addresses do
+          
+          has_many :mailing_addresses, :class_initializer => :mailing_address_initializer do 
             declared_model :address
             
-            property :street, :on => :address
+            property :street, :on => :address            
           end
-          
+
           def initialize(h={})
             h.each {|k,v| send("#{k}=",v)}
           end  
@@ -28,9 +28,8 @@ describe FreeForm::Nested do
       end
   
       let(:form) do
-        form_model = form_class.new( 
-          :mailing_address_form_initializer => lambda { { :address => OpenStruct.new } } 
-        )
+        form_class.mailing_address_initializer = lambda { { :address => OpenStruct.new } } 
+        form_model = form_class.new
       end
 
       describe "form class" do
@@ -53,7 +52,8 @@ describe FreeForm::Nested do
 
         it "builds unique models" do
           # Using module here, since they initialize uniquely
-          form.mailing_address_form_initializer = lambda { { :address => Module.new } } 
+          form_class.mailing_address_initializer = lambda { { :address => Module.new } } 
+          form = form_class.new
           form.build_mailing_address
           form.build_mailing_address
           address_1 = form.mailing_addresses.first.address
@@ -61,6 +61,12 @@ describe FreeForm::Nested do
           address_1.should_not eq(address_2)
         end
 
+        it "builds initialized models through reflection on association" do
+          form_class.mailing_address_initializer = lambda { { :address => Module.new } } 
+          klass = form_class.reflect_on_association(:mailing_addresses).klass
+          klass.new.address.should be_a(Module)
+        end
+
         it "allows nested_forms to be built with custom initializers" do
           form.build_mailing_address(:address => OpenStruct.new(:street => "1600 Pennsylvania Ave."))
           form.mailing_addresses.first.street.should eq("1600 Pennsylvania Ave.")

data/spec/form/validation_spec.rb

@@ -46,12 +46,16 @@ describe FreeForm::Validation do
           property :username, :on => :user
           validates :username, :presence => true
           
-          nested_form :addresses do
+          nested_form :addresses, :class_initializer => :address_initializer do
             declared_model :address
             
             property :street, :on => :address
           end
           
+          def self.address_initializer
+            {:address => OpenStruct.new}
+          end
+          
           def initialize(h={})
             h.each {|k,v| send("#{k}=",v)}
           end  
@@ -64,10 +68,8 @@ describe FreeForm::Validation do
       end
   
       let(:form) do
-        test_form = form_class.new( 
-          :user => user, 
-          :address_form_initializer => lambda { { :address => address } } )
-        test_form.build_address
+        test_form = form_class.new(:user => user)
+        test_form.build_address(:address => address)
         test_form
       end
 
@@ -100,7 +102,7 @@ describe FreeForm::Validation do
           property :form_property
           validates :form_property, :presence => true
           
-          nested_form :addresses do
+          nested_form :addresses, :class_initializer => :address_initializer do
             include ActiveModel::Validations
             include FreeForm::Property
             include FreeForm::Nested
@@ -112,6 +114,10 @@ describe FreeForm::Validation do
             property :city, :on => :address
           end
           
+          def self.address_initializer
+            {:address => OpenStruct.new}
+          end
+          
           def initialize(h={})
             h.each {|k,v| send("#{k}=",v)}
           end  
@@ -124,10 +130,8 @@ describe FreeForm::Validation do
       end
   
       let(:form) do
-        test_form = form_class.new( 
-          :user => user, 
-          :address_form_initializer => lambda { { :address => address } } )
-        test_form.build_address
+        test_form = form_class.new( :user => user )
+        test_form.build_address( :address => address )
         test_form
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: freeform
 version: !ruby/object:Gem::Version
-  version: 0.0.3.rc1
+  version: 0.0.3.rc2
   prerelease: 6
 platform: ruby
 authors: