form_forms 0.1.0

data/lib/form_forms/elements/block.rb

@@ -0,0 +1,28 @@
+module FormForms
+  module Elements
+    class Block < BaseElement
+      allowed_sub_element :field
+      allowed_sub_element :block
+      allowed_sub_element :fieldset
+      allowed_sub_element :fields
+      allowed_sub_element :table_fields
+
+      def initialize(element, args = {})
+        @element = element.to_sym
+        self.args args
+        super
+      end
+
+      property :args
+
+      # Generate a fielset with a legend
+      def render(builder, view)
+        args = eval_property(:args, builder, view)
+
+        view.content_tag(@element, args) do
+          super
+        end
+      end
+    end
+  end
+end

data/lib/form_forms/elements/field.rb

@@ -0,0 +1,32 @@
+module FormForms
+  module Elements
+    # This represents a single form field. Typically this is the most
+    # low-level part of a form. You can either return a form element with the
+    # help of the passed form builder or just return arbitrary html. The block
+    # is executed in the scope of the view where the form is rendered. You can
+    # use any helpers defined there.
+    #
+    # Note that you might need to mark your values as +html_safe+ to avoid
+    # superfluous escaping in the view.
+    #
+    # Example:
+    #
+    #   my_form = Form.new() do |form|
+    #     form.field(:subject) {|f| f.input :subject}
+    #     form.field(:link) do |f|
+    #       content_tag :p do
+    #         content_tag(:a, :href => hint_path){ "This is a hint" }
+    #       end
+    #     end
+    #   end
+    class Field
+      def initialize(&generator)
+        @generator = generator
+      end
+
+      def render(builder, view)
+        view.instance_exec(builder, &@generator)
+      end
+    end
+  end
+end

data/lib/form_forms/elements/fields.rb

@@ -0,0 +1,29 @@
+module FormForms
+  module Elements
+    class Fields < BaseElement
+      allowed_sub_element :field
+      allowed_sub_element :block
+      allowed_sub_element :fieldset
+      allowed_sub_element :fields
+      allowed_sub_element :table_fields
+
+      def initialize(association=nil, form_args={})
+        self.association association
+        self.args form_args
+        super
+      end
+
+      property :association
+      property :args
+
+      def render(builder, view)
+        association = eval_property(:association, builder, view)
+        form_args = eval_property(:args, builder, view)
+
+        builder.association(association, form_args) do |sub|
+          render_elements(sub, view)
+        end
+      end
+    end
+  end
+end

data/lib/form_forms/elements/fieldset.rb

@@ -0,0 +1,23 @@
+module FormForms
+  module Elements
+    class Fieldset < Block
+      def initialize(fieldset_args={}, &generator)
+        self.legend nil
+        super(:fieldset, fieldset_args, &generator)
+      end
+
+      property :legend
+
+      # Generate a fielset with a legend
+      def render(builder, view)
+        args = eval_property(:args, builder, view)
+        legend = eval_property(:legend, builder, view)
+
+        view.content_tag(:fieldset, args) do
+          view.concat view.content_tag(:legend, legend) unless legend.nil?
+          view.concat render_elements(builder, view)
+        end
+      end
+    end
+  end
+end

data/lib/form_forms/form_registry.rb

@@ -0,0 +1,25 @@
+module FormForms
+  class FormRegistry
+    class << self
+      def [](name)
+        forms[name.to_sym]
+      end
+
+      def []=(name, form)
+        forms[name.to_sym] = form
+      end
+
+      def delete(name)
+        forms.delete(name.to_sym)
+      end
+
+      def keys
+        forms.keys
+      end
+    protected
+      def forms
+        @forms ||= {}
+      end
+    end
+  end
+end

data/lib/form_forms/forms.rb

@@ -0,0 +1,2 @@
+require 'form_forms/forms/base_form'
+require 'form_forms/forms/form'

data/lib/form_forms/forms/base_form.rb

@@ -0,0 +1,40 @@
+module FormForms
+  module Forms
+    # The generic top-level form for building a simple_form..
+    #
+    # This class (and all its children) is only usable as a top-level form
+    # as it generates its own form builder object which is passed to its
+    # sub-elements on rendering
+    class BaseForm < FormForms::Elements::BaseElement
+      # +form_args+ are passed to the initializer of the form builder.
+      # They can be used to override its defaults.
+      def initialize(form_args = {})
+        @form_args = form_args
+        super
+      end
+
+      # Set the form_args. These are static as we don't have a form yet
+      def args(form_args=nil)
+        if form_args
+          @form_args = form_args
+        else
+          @form_args
+        end
+      end
+
+      # Render the form.
+      # Notice that forms receive an ActiveModel object as its first
+      # parameter, unlike elements which receive the form builder which is
+      # created by a form.
+      def render(model, view)
+        view.simple_form_for(model, self.args) do |builder|
+          render_elements(builder, view)
+        end
+      end
+
+      def self.register(name, form_args={}, &generator)
+        ::FormForms::FormRegistry[name] = self.new(form_args, &generator)
+      end
+    end
+  end
+end

data/lib/form_forms/forms/form.rb

@@ -0,0 +1,15 @@
+module FormForms
+  module Forms
+    # The generic form for building a simple_form..
+    #
+    # This class is only usable as a top-level form as it generates its own
+    # form builder object
+    class Form < BaseForm
+      allowed_sub_element :field
+      allowed_sub_element :block
+      allowed_sub_element :fieldset
+      allowed_sub_element :fields
+      allowed_sub_element :table_fields
+    end
+  end
+end

data/lib/form_forms/version.rb

@@ -0,0 +1,3 @@
+module Formforms
+  VERSION = "0.1.0"
+end

data/test/form_forms/elements/block_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+class FieldsetTest < ActionView::TestCase
+  test "create a block" do
+    with_form_for(@user) do |form|
+      form.block(:red_box, :div, :class => "red_box") do |block|
+        block.field(:credit_card) {|f| f.input :credit_card}
+      end
+    end
+
+    assert_select 'form > div.red_box input.string#user_credit_card'
+  end
+
+  test "allow nesting of blocks" do
+    with_form_for(@user) do |form|
+      form.block(:main, :div, :id => 'main') do |outer|
+        outer.fieldset(:payment, :id => "payment") do |inner|
+          inner.legend "These are some fields"
+          inner.field(:credit_card) {|f| f.input :credit_card}
+        end
+
+        outer.field(:name) {|f| f.input :name}
+      end
+    end
+
+    assert_no_select 'fieldset#main > legend'
+    assert_select 'form > div#main > div > input.string#user_name'
+
+    assert_select 'form > div#main > fieldset#payment > legend', "These are some fields"
+    assert_select 'form > div#main > fieldset#payment input.string#user_credit_card'
+  end
+end

data/test/form_forms/elements/field_test.rb

@@ -0,0 +1,98 @@
+require 'test_helper'
+
+class FieldTest < ActionView::TestCase
+  test "render a simple_form field" do
+    with_form_for(@user) do |form|
+      form.field(:name) {|f| f.input :name}
+      form.field(:description) {|f| f.input :description}
+    end
+
+    assert_select 'input.string#user_name'
+    assert_select 'textarea.text#user_description'
+  end
+
+  test "render a custom field" do
+    with_form_for(@user) do |form|
+      form.field(:something) {|f| '<span id="foo">Something</span>'.html_safe}
+    end
+
+    assert_select 'span#foo', "Something"
+  end
+
+  test "escape unsafe output" do
+    with_form_for(@user) do |form|
+      form.field(:something) {|f| '<span id="foo">Something</span>'}
+    end
+
+    assert_no_select 'span#foo'
+    assert_select 'form', /&lt;span id=&quot;foo&quot;&gt;Something&lt;\/span&gt;/
+  end
+
+  test "allow the usage of view helpers" do
+    with_form_for(@user) do |form|
+      form.field(:something) {|f| content_tag(:span){"Something"}}
+    end
+
+    assert_select 'span', "Something"
+  end
+
+  test "allow appending elements" do
+    with_form_for(@user) do |form|
+      form.field(:name) {|f| f.input :name}
+      form.field(:description) {|f| f.input :description}
+
+      form.field_after(:name, :credit_card) {|f| f.input :credit_card}
+      form.field_last(:active) {|f| f.input :active}
+    end
+
+    # the first div in a form contains some hidden fields
+    assert_select 'form > div:nth-of-type(2) > input.string#user_name'
+    assert_select 'form > div:nth-of-type(3) > input.string#user_credit_card'
+    assert_select 'form > div:nth-of-type(4) > textarea.text#user_description'
+    assert_select 'form > div:nth-of-type(5) > input.boolean#user_active'
+  end
+
+  test "allow prepending elements" do
+    with_form_for(@user) do |form|
+      form.field(:name) {|f| f.input :name}
+      form.field(:description) {|f| f.input :description}
+
+      form.field_first(:active) {|f| f.input :active}
+      form.field_before(:description, :credit_card) {|f| f.input :credit_card}
+    end
+
+    # the first div in a form contains some hidden fields
+    assert_select 'form > div:nth-of-type(2) > input.boolean#user_active'
+    assert_select 'form > div:nth-of-type(3) > input.string#user_name'
+    assert_select 'form > div:nth-of-type(4) > input.string#user_credit_card'
+    assert_select 'form > div:nth-of-type(5) > textarea.text#user_description'
+  end
+
+  test "check existence of elements when inserting" do
+    assert_raise ArgumentError do
+      with_form_for(@user) do |form|
+        form.field(:name) {|f| f.input :name}
+        form.field_before(:description, :credit_card) {|f| f.input :credit_card}
+      end
+    end
+
+    assert_raise ArgumentError do
+      with_form_for(@user) do |form|
+        form.field(:name) {|f| f.input :name}
+        form.field_after(:description, :credit_card) {|f| f.input :credit_card}
+      end
+    end
+  end
+
+  test "delete field" do
+    with_form_for(@user) do |form|
+      form.field(:name) {|f| f.input :name}
+      form.field(:description) {|f| f.input :description}
+
+      form.delete(:description)
+    end
+
+    assert_select 'input.string#user_name'
+    assert_no_select 'textarea.text#user_description'
+  end
+end

data/test/form_forms/elements/fields_test.rb

@@ -0,0 +1,57 @@
+require File.expand_path('../../../test_helper', __FILE__)
+
+class FieldsTest < ActionView::TestCase
+  test "render a sub-form" do
+    with_form_for(@user) do |form|
+      form.field(:name) {|f| f.input :name}
+
+      form.fields(:tags, :tags, :collection => Tag.all) do |tags|
+        tags.field(:name) {|f| f.input :name}
+      end
+    end
+
+    assert_select 'input.string#user_name'
+
+    assert_select 'input.string#user_tags_attributes_0_name'
+    assert_select 'input[type=hidden]#user_tags_attributes_0_id'
+
+    assert_select 'input.string#user_tags_attributes_2_name'
+    assert_select 'input[type=hidden]#user_tags_attributes_2_id'
+  end
+
+  test "pass the collection tag as a proc" do
+    with_form_for(@user) do |form|
+      form.field(:name) {|f| f.input :name}
+
+      args = lambda{|f| {:collection => Tag.all} }
+      form.fields(:tags, :tags, args) do |tags|
+        tags.field(:name) {|f| f.input :name}
+      end
+    end
+
+    assert_select 'input.string#user_name'
+
+    assert_select 'input.string#user_tags_attributes_0_name'
+    assert_select 'input[type=hidden]#user_tags_attributes_0_id'
+
+    assert_select 'input.string#user_tags_attributes_2_name'
+    assert_select 'input[type=hidden]#user_tags_attributes_2_id'
+  end
+
+  test "append field to sub-form" do
+    with_form_for(@user) do |form|
+      form.field(:name) {|f| f.input :name}
+
+      form.fields(:tags, :tags, :collection => Tag.all) do |tags|
+        tags.field(:name) {|f| f.input :name}
+      end
+
+      form.fields(:tags).field(:id) {|f| f.input :id}
+    end
+
+    assert_select 'input.string#user_name'
+
+    assert_select 'input.string#user_tags_attributes_0_name'
+    assert_select 'input.string#user_tags_attributes_0_id'
+  end
+end

data/test/form_forms/elements/fieldset_test.rb

@@ -0,0 +1,53 @@
+require 'test_helper'
+
+class FieldsetTest < ActionView::TestCase
+  test "create a fieldset" do
+    with_form_for(@user) do |form|
+      form.fieldset(:payment, :id => "payment") do |fieldset|
+        fieldset.legend "These are some fields"
+        fieldset.field(:credit_card) {|f| f.input :credit_card}
+      end
+    end
+
+    assert_select 'form > fieldset#payment legend', "These are some fields"
+    assert_select 'form > fieldset#payment input.string#user_credit_card'
+  end
+
+  test "allow nesting of fieldsets" do
+    with_form_for(@user) do |form|
+      form.fieldset(:main, :id => 'main') do |outer|
+        outer.fieldset(:payment, :id => "payment") do |inner|
+          inner.legend "These are some fields"
+          inner.field(:credit_card) {|f| f.input :credit_card}
+        end
+
+        outer.field(:name) {|f| f.input :name}
+      end
+    end
+
+    assert_no_select 'fieldset#main > legend'
+    assert_select 'form > fieldset#main > div > input.string#user_name'
+
+    assert_select 'form > fieldset#main > fieldset#payment > legend', "These are some fields"
+    assert_select 'form > fieldset#main > fieldset#payment input.string#user_credit_card'
+  end
+
+  test "dynamically set args and legend" do
+    with_form_for(@user) do |form|
+      form.fieldset(:main) do |fieldset|
+        # static syntax
+        fieldset.args :id => 'main'
+        fieldset.legend "These are some fields"
+      end
+
+      form.fieldset(:block) do |fieldset|
+        # dynamic block syntax
+        fieldset.args{|f| {:id => 'block'} }
+        fieldset.legend{|f| "This is a #{f.object.class.name.underscore}"}
+      end
+    end
+
+    assert_select 'form > fieldset#main > legend', 'These are some fields'
+    assert_select 'form > fieldset#block > legend', 'This is a user'
+  end
+end