freeform 0.0.4 → 1.0.0

data/.gitignore

@@ -1,17 +1,8 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/*
+test/dummy/.sass-cache

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in freeform.gemspec
-gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,150 @@
+PATH
+  remote: .
+  specs:
+    freeform (0.0.4)
+      activemodel
+      formtastic
+      nested_form (~> 0.3.2)
+      rails (~> 3.2.0)
+      simple_form
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.16)
+      actionpack (= 3.2.16)
+      mail (~> 2.5.4)
+    actionpack (3.2.16)
+      activemodel (= 3.2.16)
+      activesupport (= 3.2.16)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.16)
+      activesupport (= 3.2.16)
+      builder (~> 3.0.0)
+    activerecord (3.2.16)
+      activemodel (= 3.2.16)
+      activesupport (= 3.2.16)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.16)
+      activemodel (= 3.2.16)
+      activesupport (= 3.2.16)
+    activesupport (3.2.16)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    arel (3.0.3)
+    builder (3.0.4)
+    capybara (1.1.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    ffi (1.9.3)
+    formtastic (2.2.1)
+      actionpack (>= 3.0)
+    hike (1.2.3)
+    i18n (0.6.9)
+    journey (1.0.4)
+    json (1.8.1)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    metaclass (0.0.1)
+    mime-types (1.25.1)
+    mini_portile (0.5.2)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.8.2)
+    nested_form (0.3.2)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
+    polyglot (0.3.3)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.16)
+      actionmailer (= 3.2.16)
+      actionpack (= 3.2.16)
+      activerecord (= 3.2.16)
+      activeresource (= 3.2.16)
+      activesupport (= 3.2.16)
+      bundler (~> 1.0)
+      railties (= 3.2.16)
+    railties (3.2.16)
+      actionpack (= 3.2.16)
+      activesupport (= 3.2.16)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    rspec-rails (2.14.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rubyzip (1.1.0)
+    selenium-webdriver (2.38.0)
+      childprocess (>= 0.2.5)
+      multi_json (~> 1.0)
+      rubyzip (~> 1.0)
+      websocket (~> 1.0.4)
+    simple_form (2.1.1)
+      actionpack (~> 3.0)
+      activemodel (~> 3.0)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.8)
+    thor (0.18.1)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.38)
+    websocket (1.0.7)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  capybara (~> 1.1)
+  freeform!
+  mocha
+  rake
+  rspec
+  rspec-rails (~> 2.6)
+  sqlite3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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', '>= 0.0.4'
+    gem 'freeform', '>= 1.0.0'
 
 And then execute:
 
@@ -24,7 +24,7 @@ Or install it yourself as:
 
 ## How It Works
 
-FreeForm can 1-*n* models, exposing whatever attributes you wish from each model, and delegating those assignments back to the models themselves.  This means that one form can be used just as easily to support parent/child models, multiple unrelated models, etc.  Your database relationships can change, and your forms won't have to.
+FreeForm creates model objects that can hold 1-*n* models, exposing whatever attributes you wish from each model, and delegating those assignments back to the models themselves.  This means that one form can be used just as easily to support parent/child models, multiple unrelated models, etc.  Your database relationships can change, and your forms won't have to.
 
 **Example**
 
@@ -185,7 +185,9 @@ Personally, I use validations in both places.  My domain models have their own v
 
 ## Nesting Forms
 
-Sometimes, you need to be able to support a collection of unknown size (e.g. a user with many phone numbers).  Since FreeForm makes no assumptions about your domain models, we nest forms themselves.
+One of the benefits of forms objects is that you don't have to mess with models accepting nested attributes.
+But sometimes, you need to be able to support a collection of unknown size (e.g. a user with many phone numbers).  
+Since FreeForm makes no assumptions about your domain models, we nest forms themselves.
 
 ```ruby
 class UserForm < FreeForm::Form
@@ -193,51 +195,32 @@ class UserForm < FreeForm::Form
 
   property :username,              :on => :user
   property :email,                 :on => :user
+    
+  has_many :phone_numbers, :class => PhoneNumberForm, :default_initializer => :phone_initializer
   
-  nested_form :phone_numbers do
-    form_models :phone
-	
-	property :area_code,              :on => :phone
-	property :number,                 :on => :phone
+  def phone_initializer
+    { :phone => user.phone_numbers.build }
   end
 end
+
+class PhoneNumberForm < FreeForm::Form
+  form_models :phone
+
+  property :area_code,              :on => :phone
+  property :number,                 :on => :phone
+end
 ```
 **Note:**  The method `nested_form` is also aliased as `has_many` and `has_one`, if you prefer the expressiveness of that syntax.  The functionality is the same in any case.
 
 When using a nested form, the form starts with **no** nested forms pre-built.  FreeForm provides a method called `build_#{nested_form_model}` (e.g. `build_phone_numbers`) that you can use to build a nested form.  You must provide the initializer:
 ```ruby
 form = UserForm.new(:user => User.new)
-form.build_phone_numbers(:phone => Phone.new)
-# The singularized version is aliased as well.
-form.build_phone_number(:phone => Phone.new) 
-```
-
-**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
-class UserForm < FreeForm::Form
-  form_models :user
-
-  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.
+form.build_phone_number # Now the nested form is created
 ```
-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!
-
-FreeForm's flexibility comes at a bit of a cost - it makes no assumptions about relationships between initialized models or nested forms.  So initializing the form correctly is important.
+**Ryan Bates' nested_form gem functionality**
+FreeForm has a built in implementation of the functionality from Ryan Bates' *nested_form* gem.
+When building a form, just use the method `freeform_for...`
 
 ** Example **
 ```ruby
@@ -250,14 +233,20 @@ class UserForm < FreeForm::Form
   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
+  has_many :phone_numbers, :class => PhoneNumberForm, :default_initializer => :phone_initializer
+  
+  def phone_initializer
+    { :phone => user.phone_numbers.build }
   end
 end
 
+class PhoneNumberForm < FreeForm::Form
+  form_models :phone
+
+  property :area_code,              :on => :phone
+  property :number,                 :on => :phone
+end
+
 form = UserForm.new(:user => current_user)
 ```
 
@@ -265,7 +254,6 @@ 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/Rakefile

@@ -1 +1,32 @@
-require "bundler/gem_tasks"
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Freeform'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/freeform.gemspec

@@ -4,24 +4,31 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'freeform/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "freeform"
-  spec.version       = Freeform::VERSION
-  spec.authors       = ["brycesenz"]
-  spec.email         = ["bryce.senz@gmail.com"]
-  spec.description   = %q{Decouple your forms from your domain models}
-  spec.summary       = %q{FreeForm lets you compose forms however you like, explicitly guiding how each field maps back to your domain models.  No more accepting nested attributes!}
-  spec.homepage      = "https://github.com/brycesenz/freeform"
-  spec.license       = "MIT"
+  spec.name = "freeform"
+  spec.version = Freeform::VERSION
+  spec.authors = ["brycesenz"]
+  spec.email = ["bryce.senz@gmail.com"]
+  spec.description = %q{Decouple your forms from your domain models}
+  spec.summary = %q{FreeForm lets you compose forms however you like, explicitly guiding how each field maps back to your domain models. No more accepting nested attributes!}
+  spec.homepage = "https://github.com/brycesenz/freeform"
+  spec.license = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files = `git ls-files`.split($/)
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency             "activemodel"
+  spec.add_dependency "activemodel"
+  spec.add_dependency "simple_form"
+  spec.add_dependency "formtastic"
+  spec.add_dependency "nested_form", "~> 0.3.2"
+  spec.add_dependency "rails", "~> 3.2.0"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-
-  # Customer Development Dependencies
+  spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "rspec"
-end
+  spec.add_development_dependency "rspec-rails", "~> 2.6"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "capybara", "~> 1.1"
+end
+

data/lib/freeform/builder/builder_mixin.rb

@@ -0,0 +1,111 @@
+module FreeForm
+  module BuilderMixin
+    # Adds a link to insert a new associated records. The first argument is the name of the link, the second is the name of the association.
+    #
+    # f.link_to_add("Add Task", :tasks)
+    #
+    # You can pass HTML options in a hash at the end and a block for the content.
+    #
+    # <%= f.link_to_add(:tasks, :class => "add_task", :href => new_task_path) do %>
+    # Add Task
+    # <% end %>
+    #
+    # You can also pass <tt>model_object</tt> option with an object for use in
+    # the blueprint, e.g.:
+    #
+    # <%= f.link_to_add(:tasks, :model_object => Task.new(:name => 'Task')) %>
+    #
+    # See the README for more details on where to call this method.
+    def link_to_add(*args, &block)
+      options = args.extract_options!.symbolize_keys
+      association = args.pop
+
+      unless object.respond_to?("#{association}_attributes=")
+        raise ArgumentError, "Invalid association. Make sure that a nested form for #{association.to_s} exists."
+      end
+
+      #FIXME: I need to use the build method for child models
+      model_object = options.delete(:model_object) do
+        object.send("build_#{association.to_s.singularize}")
+      end
+
+      options[:class] = [options[:class], "add_nested_form"].compact.join(" ")
+      options["data-association"] = association
+      options["data-blueprint-id"] = fields_blueprint_id = fields_blueprint_id_for(association)
+      args << (options.delete(:href) || "javascript:void(0)")
+      args << options
+
+      @fields ||= {}
+      @template.after_freeform(fields_blueprint_id) do
+        blueprint = {:id => fields_blueprint_id, :style => 'display: none'}
+        block, options = @fields[fields_blueprint_id].values_at(:block, :options)
+        options[:child_index] = "new_#{association}"
+        blueprint[:"data-blueprint"] = fields_for(association, model_object, options, &block).to_str
+        @template.content_tag(:div, nil, blueprint)
+      end
+      @template.link_to(*args, &block)
+    end
+
+    # Adds a link to remove the associated record. The first argment is the name of the link.
+    #
+    # f.link_to_remove("Remove Task")
+    #
+    # You can pass HTML options in a hash at the end and a block for the content.
+    #
+    # <%= f.link_to_remove(:class => "remove_task", :href => "#") do %>
+    # Remove Task
+    # <% end %>
+    #
+    # See the README for more details on where to call this method.
+    def link_to_remove(*args, &block)
+      options = args.extract_options!.symbolize_keys
+      options[:class] = [options[:class], "remove_nested_form"].compact.join(" ")
+
+      # Extracting "milestones" from "...[milestones_attributes][...]"
+      md = object_name.to_s.match(/(\w+)_attributes\](?:\[[\w\d]+\])?$/)
+      association = md && md[1]
+      options["data-association"] = association
+
+      args << (options.delete(:href) || "javascript:void(0)")
+      args << options
+      hidden_field(:_destroy, :value => 0) << @template.link_to(*args, &block)
+    end
+
+    def fields_for_with_nested_attributes(association_name, *args)
+      # TODO Test this better
+      block = args.pop || Proc.new { |fields| @template.render(:partial => "#{association_name.to_s.singularize}_fields", :locals => {:f => fields}) }
+
+      options = args.dup.extract_options!
+
+      # Rails 3.0.x
+      if options.empty? && args[0].kind_of?(Array)
+        options = args[0].dup.extract_options!
+      end
+
+      @fields ||= {}
+      @fields[fields_blueprint_id_for(association_name)] = { :block => block, :options => options }
+      super(association_name, *(args << block))
+    end
+
+    def fields_for_nested_model(name, object, options, block)
+      classes = 'fields'
+      classes << ' marked_for_destruction' if object.respond_to?(:marked_for_destruction?) && object.marked_for_destruction?
+
+      perform_wrap   = options.fetch(:nested_wrapper, true)
+      perform_wrap &&= options[:wrapper] != false # wrap even if nil
+
+      if perform_wrap
+        @template.content_tag(:div, super, :class => classes)
+      else
+        super
+      end
+    end
+
+  private
+    def fields_blueprint_id_for(association)
+      assocs = object_name.to_s.scan(/(\w+)_attributes/).map(&:first)
+      assocs << association
+      assocs.join('_') + '_fields_blueprint'
+    end
+  end
+end

data/lib/freeform/builder/builders.rb

@@ -0,0 +1,32 @@
+require 'action_view'
+require 'freeform/builder/builder_mixin'
+
+module FreeForm
+  class Builder < ::ActionView::Helpers::FormBuilder
+    include ::FreeForm::BuilderMixin
+  end
+
+  begin
+    require 'simple_form'
+    class SimpleBuilder < ::SimpleForm::FormBuilder
+      include ::FreeForm::BuilderMixin
+    end
+  rescue LoadError
+  end
+
+  begin
+    require 'formtastic'
+    class FormtasticBuilder < (defined?(::Formtastic::FormBuilder) ? Formtastic::FormBuilder : ::Formtastic::SemanticFormBuilder)
+      include ::FreeForm::BuilderMixin
+    end
+  rescue LoadError
+  end
+
+  begin
+    require 'formtastic-bootstrap'
+    class FormtasticBootstrapBuilder < ::FormtasticBootstrap::FormBuilder
+      include ::FreeForm::BuilderMixin
+    end
+  rescue LoadError
+  end
+end

data/lib/freeform/builder/engine.rb

@@ -0,0 +1,14 @@
+require 'rails'
+
+module FreeForm
+  class Engine < ::Rails::Engine
+    initializer 'freeform' do |app|
+      ActiveSupport.on_load(:action_view) do
+        require "freeform/builder/view_helper"
+        class ActionView::Base
+          include FreeForm::ViewHelper
+        end
+      end
+    end
+  end
+end

data/lib/freeform/builder/view_helper.rb

@@ -0,0 +1,56 @@
+module FreeForm
+  module ViewHelper
+    def freeform_for(*args, &block)
+      options = args.extract_options!.reverse_merge(:builder => FreeForm::Builder)
+      form_for(*(args << options)) do |f|
+        capture(f, &block).to_s << after_freeform_callbacks
+      end
+    end
+
+    if defined?(FreeForm::SimpleBuilder)
+      def simple_freeform_for(*args, &block)
+        options = args.extract_options!.reverse_merge(:builder => FreeForm::SimpleBuilder)
+        simple_form_for(*(args << options)) do |f|
+          capture(f, &block).to_s << after_freeform_callbacks
+        end
+      end
+    end
+
+    if defined?(FreeForm::FormtasticBuilder)
+      def semantic_freeform_for(*args, &block)
+        options = args.extract_options!.reverse_merge(:builder => FreeForm::FormtasticBuilder)
+        semantic_form_for(*(args << options)) do |f|
+          capture(f, &block).to_s << after_freeform_callbacks
+        end
+      end
+    end
+
+    if defined?(FreeForm::FormtasticBootstrapBuilder)
+      def semantic_bootstrap_freeform_for(*args, &block)
+        options = args.extract_options!.reverse_merge(:builder => FreeForm::FormtasticBootstrapBuilder)
+        semantic_form_for(*(args << options)) do |f|
+          capture(f, &block).to_s << after_freeform_callbacks
+        end
+      end
+    end
+
+    def after_freeform(association, &block)
+      @associations ||= []
+      @after_freeform_callbacks ||= []
+      unless @associations.include?(association)
+        @associations << association
+        @after_freeform_callbacks << block
+      end
+    end
+
+  private
+    def after_freeform_callbacks
+      @after_freeform_callbacks ||= []
+      fields = []
+      while callback = @after_freeform_callbacks.shift
+        fields << callback.call
+      end
+      fields.join(" ").html_safe
+    end
+  end
+end

data/lib/freeform/form/form_input_key.rb

@@ -7,7 +7,7 @@ module FreeForm
     module ClassMethods
       def form_input_key(name)
         constant = name.to_s.camelize
-        Object.const_set(constant, Class.new) unless Object.const_defined?(constant)    
+        Object.const_set(constant, Module.new) unless const_defined?(constant)    
         define_singleton_method(:model_name) do
           ActiveModel::Name.new(constant.constantize)
         end