nested_form 0.0.0

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ryan Bates
+
+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.rdoc

@@ -0,0 +1,57 @@
+= Nested Form
+
+A Rails gem to conveniently manage multiple nested models in a single form. It does so in an unobtrusive way through jQuery.
+
+To learn more about how this works under the hood: http://blog.madebydna.com/dynamic-nested-forms-in-rails-3-with-the-nest
+
+
+== Install
+
+Add it to your Gemfile
+  
+  gem "nested_form"
+
+Run
+  
+  bundle install
+
+Run the generator
+
+  rails generate nested_form:install
+
+
+== Usage
+
+Running the generator will add a file at public/javascripts/nested_form.js which should be included after the jQuery or Prototype framework.
+
+  <%= javascript_include_tag :defaults, "nested_form" %>
+
+You can then generate a nested form using the nested_form_for helper method.
+
+  <%= nested_form_for @project do |f| %>
+
+Use this form just like normal, including the +fields_for+ helper method for nesting models. The benefit of this plugin comes from the +link_to_add+ and +link_to_remove+ helper methods on the form builder.
+
+  <%= f.fields_for :tasks do |task_form| %>
+    <%= task_form.text_field :name %>
+    <%= task_form.link_to_remove "Remove this task" %>
+  <% end %>
+  <%= f.link_to_add "Add a task", :tasks %>
+
+This generates links which dynamically add and remove fields.
+
+
+== Partials
+
+It is often desirable to move the nested fields into a partial to keep things organized. If you don't supply a block to fields_for it will look for a partial and use that.
+
+  <%= f.fields_for :tasks %>
+
+In this case it will look for a partial called "task_fields" and pass the form builder as an f variable to it.
+
+
+== Special Thanks
+
+This gem was originally based on the solution by Tim Riley in his {complex-form-examples fork}[https://github.com/timriley/complex-form-examples/tree/unobtrusive-jquery-deep-fix2].
+
+Thank you Andrew Manshin for the Rails 3 transition, {Andrea Singh}[https://github.com/madebydna] for converting to a gem and {Peter Giacomo Lombardo}[https://github.com/pglombardo] for Prototype support.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc "Run RSpec"
+RSpec::Core::RakeTask.new do |t|
+  t.verbose = false
+end
+
+task :default => :spec

data/lib/generators/nested_form/install_generator.rb

@@ -0,0 +1,17 @@
+module NestedForm
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      def self.source_root
+        File.dirname(__FILE__) + "/templates"
+      end
+      
+      def copy_jquery_file
+        if File.exists?('public/javascripts/prototype.js')
+          copy_file 'prototype_nested_form.js', 'public/javascripts/nested_form.js'
+        else
+          copy_file 'jquery_nested_form.js', 'public/javascripts/nested_form.js'
+        end
+      end
+    end
+  end
+end

data/lib/generators/nested_form/templates/jquery_nested_form.js

@@ -0,0 +1,46 @@
+$(function() {
+$('form a.add_nested_fields').live('click', function() {
+  // Setup
+  var assoc   = $(this).attr('data-association');           // Name of child
+  var content = $('#' + assoc + '_fields_blueprint').html(); // Fields template
+
+  // Make the context correct by replacing new_<parents> with the generated ID
+  // of each of the parent objects
+  var context = ($(this).closest('.fields').find('input:first').attr('name') || '').replace(new RegExp('\[[a-z]+\]$'), '');
+
+  // context will be something like this for a brand new form:
+  // project[tasks_attributes][1255929127459][assignments_attributes][1255929128105]
+  // or for an edit form:
+  // project[tasks_attributes][0][assignments_attributes][1]
+  if(context) {
+    var parent_names = context.match(/[a-z_]+_attributes/g) || [];
+    var parent_ids   = context.match(/[0-9]+/g);
+
+    for(i = 0; i < parent_names.length; i++) {
+      if(parent_ids[i]) {
+        content = content.replace(
+          new RegExp('(\\[' + parent_names[i] + '\\])\\[.+?\\]', 'g'),
+          '$1[' + parent_ids[i] + ']'
+        )
+      }
+    }
+  }
+
+  // Make a unique ID for the new child
+  var regexp  = new RegExp('new_' + assoc, 'g');
+  var new_id  = new Date().getTime();
+  content     = content.replace(regexp, new_id);
+
+  $(this).before(content);
+  return false;
+});
+
+$('form a.remove_nested_fields').live('click', function() {
+  var hidden_field = $(this).prev('input[type=hidden]')[0];
+  if(hidden_field) {
+    hidden_field.value = '1';
+  }
+  $(this).closest('.fields').hide();
+  return false;
+});
+});

data/lib/generators/nested_form/templates/prototype_nested_form.js

@@ -0,0 +1,48 @@
+document.observe('click', function(e, el) {
+	if (el = e.findElement('form a.add_nested_fields')) {
+	  // Setup
+	  var assoc   = el.readAttribute('data-association');           // Name of child
+	  var content = $(assoc + '_fields_blueprint').innerHTML; // Fields template
+
+	  // Make the context correct by replacing new_<parents> with the generated ID
+	  // of each of the parent objects
+	  var context = (el.getOffsetParent('.fields').firstDescendant().readAttribute('name') || '').replace(new RegExp('\[[a-z]+\]$'), '');
+
+	  // context will be something like this for a brand new form:
+	  // project[tasks_attributes][1255929127459][assignments_attributes][1255929128105]
+	  // or for an edit form:
+	  // project[tasks_attributes][0][assignments_attributes][1]
+	  if(context) {
+	    var parent_names = context.match(/[a-z_]+_attributes/g) || [];
+	    var parent_ids   = context.match(/[0-9]+/g);
+
+	    for(i = 0; i < parent_names.length; i++) {
+	      if(parent_ids[i]) {
+	        content = content.replace(
+	          new RegExp('(\\[' + parent_names[i] + '\\])\\[.+?\\]', 'g'),
+	          '$1[' + parent_ids[i] + ']'
+	        )
+	      }
+	    }
+	  }
+
+	  // Make a unique ID for the new child
+	  var regexp  = new RegExp('new_' + assoc, 'g');
+	  var new_id  = new Date().getTime();
+	  content     = content.replace(regexp, new_id);
+
+	  el.insert({ before: content });
+	  return false;
+	}
+});
+
+document.observe('click', function(e, el) {
+  	if (el = e.findElement('form a.remove_nested_fields')) {
+		var hidden_field = el.previous(0);
+		if(hidden_field) {
+		  hidden_field.value = '1';
+		}
+		el.ancestors()[0].hide();
+		return false;
+	}
+});

data/lib/nested_form/builder.rb

@@ -0,0 +1,32 @@
+module NestedForm
+  class Builder < ::ActionView::Helpers::FormBuilder
+    def link_to_add(name, association)
+      @fields ||= {}
+      @template.after_nested_form(association) do
+        model_object = object.class.reflect_on_association(association).klass.new
+        output = %Q[<div id="#{association}_fields_blueprint" style="display: none">].html_safe
+        output << fields_for(association, model_object, :child_index => "new_#{association}", &@fields[association])
+        output.safe_concat('</div>')
+        output
+      end
+      @template.link_to(name, "javascript:void(0)", :class => "add_nested_fields", "data-association" => association)
+    end
+
+    def link_to_remove(name)
+      hidden_field(:_destroy) + @template.link_to(name, "javascript:void(0)", :class => "remove_nested_fields")
+    end
+
+    def fields_for_with_nested_attributes(association, args, block)
+      @fields ||= {}
+      @fields[association] = block
+      super
+    end
+
+    def fields_for_nested_model(name, association, args, block)
+      output = '<div class="fields">'.html_safe
+      output << super
+      output.safe_concat('</div>')
+      output
+    end
+  end
+end

data/lib/nested_form/view_helper.rb

@@ -0,0 +1,26 @@
+module NestedForm
+  module ViewHelper
+    def nested_form_for(*args, &block)
+      options = args.extract_options!.reverse_merge(:builder => NestedForm::Builder)
+      output = form_for(*(args << options), &block)
+      @after_nested_form_callbacks ||= []
+      fields = @after_nested_form_callbacks.map do |callback|
+        callback.call
+      end
+      output << fields.join(" ").html_safe
+    end
+    
+    def after_nested_form(association, &block)
+      @associations ||= []
+      @after_nested_form_callbacks ||= []
+      unless @associations.include?(association)
+        @associations << association 
+        @after_nested_form_callbacks << block
+      end
+    end
+  end
+end
+
+class ActionView::Base
+  include NestedForm::ViewHelper
+end

data/lib/nested_form.rb

@@ -0,0 +1,2 @@
+require "nested_form/builder"
+require "nested_form/view_helper"

data/spec/nested_form/builder_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+describe NestedForm::Builder do
+  describe "with no options" do
+    before(:each) do
+      @project = Project.new
+      @template = ActionView::Base.new
+      @template.output_buffer = ""
+      @builder = NestedForm::Builder.new(:item, @project, @template, {}, proc {})
+    end
+
+    it "should have an add link" do
+      @builder.link_to_add("Add", :tasks).should == '<a href="javascript:void(0)" class="add_nested_fields" data-association="tasks">Add</a>'
+    end
+
+    it "should have a remove link" do
+      @builder.link_to_remove("Remove").should == '<input id="item__destroy" name="item[_destroy]" type="hidden" value="false" /><a href="javascript:void(0)" class="remove_nested_fields">Remove</a>'
+    end
+
+    it "should wrap nested fields each in a div with class" do
+      2.times { @project.tasks.build }
+      @builder.fields_for(:tasks) do
+        "Task"
+      end.should == '<div class="fields">Task</div><div class="fields">Task</div>'
+    end
+
+    it "should add task fields to hidden div after form" do
+      pending
+      output = ""
+      mock(@template).after_nested_form(:tasks) { |arg, block| output << block.call }
+      @builder.fields_for(:tasks) { "Task" }
+      @builder.link_to_add("Add", :tasks)
+      output.should == '<div id="tasks_fields_blueprint" style="display: none"><div class="fields">Task</div></div>'
+    end 
+  end
+end

data/spec/nested_form/view_helper_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+describe NestedForm::ViewHelper do
+  before(:each) do
+    @template = ActionView::Base.new
+    @template.output_buffer = ""
+    @template.stubs(:url_for).returns("")
+    @template.stubs(:projects_path).returns("")
+    @template.stubs(:protect_against_forgery?).returns(false)
+  end
+
+  it "should pass nested form builder to form_for along with other options" do
+    pending
+    mock.proxy(@template).form_for(:first, :as => :second, :other => :arg, :builder => NestedForm::Builder) do |form_html|
+      form_html
+    end
+    @template.nested_form_for(:first, :as => :second, :other => :arg) {"form"}
+  end
+
+  it "should pass instance of NestedForm::Builder to nested_form_for block" do
+    @template.nested_form_for(Project.new) do |f|
+      f.should be_instance_of(NestedForm::Builder)
+    end
+  end
+
+  it "should append content to end of nested form" do
+    @template.after_nested_form(:tasks) { @template.concat("123") }
+    @template.after_nested_form(:milestones) { @template.concat("456") }
+    @template.nested_form_for(Project.new) {}
+    @template.output_buffer.should include("123456")
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,55 @@
+require "rubygems"
+require "bundler/setup"
+
+require "action_view"
+require "active_record"
+
+Bundler.require(:default)
+
+# require 'active_model'
+# require 'active_record'
+# require 'action_controller'
+# require 'action_view'
+# require 'action_view/template'
+# require "active_support/all"
+
+# require 'nested_form/view_helper'
+# require 'nested_form/builder'
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end
+
+class TablelessModel < ActiveRecord::Base
+  def self.columns() @columns ||= []; end
+ 
+  def self.column(name, sql_type = nil, default = nil, null = true)
+    columns << ActiveRecord::ConnectionAdapters::Column.new(name.to_s, default, sql_type.to_s, null)
+  end
+  
+  def self.quoted_table_name
+    name.pluralize.underscore
+  end
+  
+  def quoted_id
+    "0"
+  end
+end
+
+class Project < TablelessModel
+  column :name, :string
+  has_many :tasks
+  accepts_nested_attributes_for :tasks
+end
+
+class Task < TablelessModel
+  column :project_id, :integer
+  column :name, :string
+  belongs_to :project
+end
+
+class Milestone < TablelessModel
+  column :task_id, :integer
+  column :name, :string
+  belongs_to :task
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: nested_form
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Ryan Bates
+- Andrea Singh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-15 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+  type: :development
+  version_requirements: *id003
+description: Gem to conveniently handle multiple models in a single form with Rails 3 and jQuery or Prototype.
+email: ryan@railscasts.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/generators/nested_form/install_generator.rb
+- lib/generators/nested_form/templates/jquery_nested_form.js
+- lib/generators/nested_form/templates/prototype_nested_form.js
+- lib/nested_form/builder.rb
+- lib/nested_form/view_helper.rb
+- lib/nested_form.rb
+- spec/nested_form/builder_spec.rb
+- spec/nested_form/view_helper_spec.rb
+- spec/spec_helper.rb
+- Gemfile
+- LICENSE
+- Rakefile
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/ryanb/nested_form
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.3.4
+requirements: []
+
+rubyforge_project: nested_form
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Gem to conveniently handle multiple models in a single form.
+test_files: []
+