caring_form 1.2.3

data/spec/caring_form/field_container_spec.rb

@@ -0,0 +1,85 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+require 'caring_form'
+
+describe CaringForm::FieldContainer do
+  let(:form_class) do
+    Class.new(CaringForm::Model) do
+      def self.model_name
+        ActiveModel::Name.new(self, nil, 'ZeForm')
+      end
+    end
+  end
+
+  context ".field_names" do
+    it "returns the list of field names" do
+      klass = Class.new(form_class) do
+        string      :name
+        check_boxes :choices
+      end
+      klass.field_names.must_equal ['name', 'choices']
+    end
+
+    it "doesn't include :submit as submit being a field is just an implementation choice" do
+      klass = Class.new(form_class) do
+        string :name
+        submit
+      end
+      klass.field_names.must_equal ['name']
+    end
+
+    it "can filter the list of field names by passing a block" do
+      klass = Class.new(form_class) do
+        string :name
+        string :not_me, :ancillary => true
+        submit :primary => true
+      end
+      names = klass.field_names { |name, field| !field.ancillary }
+      names.must_equal ['name']
+    end
+  end
+
+  context "#field_names" do
+    it "delegates #field_names to its class" do
+      klass = Class.new(form_class) do
+        string      :name
+        check_boxes :choices
+      end
+      form = klass.new
+      form.field_names.must_equal ['name', 'choices']
+    end
+  end
+
+  context "#field_id" do
+    it "returns the field id specified" do
+      klass = Class.new(form_class) do
+        string :with_id, :input_html => {:id => "defined"}
+      end
+      form = klass.new
+      form.field_id(:with_id).must_equal "defined"
+    end
+
+    it "returns the default id if none was specified" do
+      klass = Class.new(form_class) do
+        string :default
+      end
+      form = klass.new
+      form.field_id(:default).must_equal "ze_form_default"
+    end
+
+    it "returns the default id if none was specified (using form index)" do
+      klass = Class.new(form_class) do
+        index_on :foo
+        def foo; 'bar'; end
+        string :default
+      end
+      form = klass.new
+      form.field_id(:default).must_equal "ze_form_bar_default"
+    end
+
+    it "returns nil if the field doesn't exist" do
+      form = form_class.new
+      form.field_id(:doesnt_exist).must_equal nil
+    end
+  end
+end

data/spec/caring_form/form_builder_spec.rb

@@ -0,0 +1,113 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+require 'caring_form'
+
+class BuilderTestForm < CaringForm::Model
+  id 'my-id'
+  classes 'my-class your-class'
+  url '/my/pretty/url'
+
+  protect_from_bots
+
+  metadata :form_name
+  string   :age, :hint => "Enter your age"
+  submit   :label => "Continue"
+end
+
+MiniTest::Spec.register_spec_type(/CaringForm::FormBuilder$/, ControllerSpec)
+
+describe CaringForm::FormBuilder do
+  include SimpleForm::ActionViewExtensions::FormHelper
+  include CaringForm::ActionViewExtensions::FormHelper
+
+  let(:ze_form) { BuilderTestForm.new }
+
+  context "rendering the form tag" do
+    it "renders a form with appropriate HTML classes" do
+      html_matcher(
+        'form.caring-form.form-text.simple_form'
+      ).must_be :matching, caring_form_for(ze_form)
+    end
+
+    it "sets the form tag action to the form url" do
+      html_matcher(
+        'form[action="/my/pretty/url"]'
+      ).must_be :matching, caring_form_for(ze_form)
+    end
+
+    it "sets the form tag id to the form id" do
+      html_matcher('form#my-id').must_be :matching, caring_form_for(ze_form)
+    end
+
+    it "sets the form tag class to the form classes" do
+      html_matcher(
+        'form.my-class.your-class'
+      ).must_be :matching, caring_form_for(ze_form)
+    end
+  end
+
+  context "metadata: render metadata and dummy fields" do
+    it "renders metadata fields" do
+      view = caring_form_for(ze_form) do |f|
+        f.metadata +
+        f.fields do
+          f.field :age
+        end
+      end
+      html_matcher(
+        'input', :with => {:name => 'builder_test_form[form_name]', :type => 'hidden'}
+      ).must_be :matching, view
+    end
+
+    it "renders dummy fields" do
+      view = caring_form_for(ze_form) do |f|
+        f.metadata
+      end
+      html_matcher(
+        'div.form_add > input', :with => {:name => 'reference', :type => 'text'}
+      ).must_be :matching, view
+    end
+  end
+
+  context "fields: render a field wrapper" do
+    it "renders a ol tag wrapper by default" do
+      view = caring_form_for(ze_form) do |f|
+        f.fields do
+          f.field :age
+        end
+      end
+      html_matcher(
+        'ol > li.field > input', :with => {:name => 'builder_test_form[age]', :type => 'text'}
+      ).must_be :matching, view
+    end
+
+    it "can render a customized wrapper tag through options" do
+      view = caring_form_for(ze_form) do |f|
+        f.fields :tag => :ul, :class => 'my-class', :id => 'blah' do
+          f.field :age
+        end
+      end
+      html_matcher(
+        'ul#blah.my-class > li > input[name="builder_test_form[age]"]'
+      ).must_be :matching, view
+    end
+    
+    it "can render all fields with :all" do
+      view = caring_form_for(ze_form) do |f|
+        f.field :all
+      end
+      html_matcher(
+        'input', :with => {:name => 'builder_test_form[form_name]', :type => 'hidden'}
+      ).must_be :matching, view
+      html_matcher(
+        'input', :with => {:name => 'reference', :type => 'text'}
+      ).must_be :matching, view
+      html_matcher(
+        'input', :with => {:name => 'builder_test_form[age]', :type => 'text'}
+      ).must_be :matching, view
+      html_matcher(
+        'input', :with => {:name => 'commit', :type => 'submit'}
+      ).must_be :matching, view
+    end
+  end
+end

data/spec/caring_form/model_spec.rb

@@ -0,0 +1,235 @@
+require File.expand_path('../../spec_helper', __FILE__)
+require 'active_support/hash_with_indifferent_access'
+
+require 'caring_form'
+
+describe CaringForm::Model do
+  let(:form_class) do
+    Class.new(CaringForm::Model) do
+      def self.model_name
+        ActiveModel::Name.new(self, nil, 'ZeForm')
+      end
+    end
+  end
+
+  context ".field: common declarations" do
+    it "can declare fields" do
+      form_class.instance_eval { string :user_name }
+      form = form_class.new(:user_name => "John Zorn")
+      form.user_name.must_equal "John Zorn"
+    end
+
+    it "defaults to required fields" do
+      form_class.instance_eval { string :user_name }
+      form = form_class.new
+      form.wont_be :valid?
+      form.errors[:user_name].must_equal ["Enter the user name"]
+    end
+
+    it "can declare an optional field" do
+      form_class.instance_eval { string :user_lang, :optional => true }
+      form = form_class.new
+      form.must_be :valid?
+    end
+
+    it "can declare an optional field that uses a rule" do
+      form_class.instance_eval do
+        string :confirmation, :optional => {:absent => :require_confirmation}
+        string :require_confirmation, :optional => true
+      end
+      form = form_class.new
+      form.must_be :valid?
+
+      form.require_confirmation = 'yes'
+      form.wont_be :valid?
+
+      form.confirmation = 'confirmed'
+      form.must_be :valid?
+    end
+
+    it "can declare if the field should be handled for a form instance" do
+      form_class.instance_eval do
+        metadata :relevant, :optional => true
+        string   :maybe, :if => :maybe_is_relevant
+      end
+      form_class.send(:define_method, :maybe_is_relevant) { relevant }
+
+      form = form_class.new(:relevant => false)
+      form.must_be :valid?
+      form.relevant = true
+      form.wont_be :valid?
+    end
+  end
+
+  context ".field: different field types" do
+    it "can declare a collection field" do
+      form_class.instance_eval { collection :gender, :collection => %w(male female) }
+      form = form_class.new(:gender => "female")
+      form.must_be :valid?
+    end
+
+    it "can declare a collection field represented as check boxes" do
+      form_class.instance_eval { check_boxes :skills }
+      form = form_class.new(:skills => ['code', 'design'])
+      form.must_be :valid?
+    end
+
+    it "can declare a single value field represented as a check box" do
+      form_class.instance_eval do
+        check_box :chat_source,
+                  :optional => true,
+                  :value => {:checked => "true", :label => "By chat"}
+      end
+      form = form_class.new(:chat_source => ['', 'true'])
+      form.must_be :valid?
+      form.chat_source.must_equal "true"
+      form = form_class.new(:chat_source => [''])
+      form.must_be :valid?
+      form.chat_source.must_equal ""
+    end
+
+    it "can declare a dummy field" do
+      form_class.instance_eval { dummy :reference }
+      form = form_class.new(:reference => "I am a spammer")
+      form.must_be :valid?
+    end
+
+    it "can declare an email field" do
+      form_class.instance_eval { email :email_address }
+      form = form_class.new(:email_address => "invalid@address")
+      form.wont_be :valid?
+      form.errors[:email_address].must_equal ["Enter a valid email address"]
+      form.email_address = "valid@email.com"
+      form.must_be :valid?
+    end
+
+    it "can declare a full name field" do
+      form_class.instance_eval { full_name :name }
+      form = form_class.new(:name => "M")
+      form.wont_be :valid?
+      form.errors[:name].must_equal ["Enter your first and last name"]
+      form.name = "John Zorn"
+      form.must_be :valid?
+    end
+
+    it "can declare a looking for field" do
+      form_class.instance_eval { looking_for :inquiry_for }
+      form = form_class.new(:inquiry_for => "Unsupported Value")
+      form.wont_be :valid?
+      form.errors[:inquiry_for].must_equal ["Tell us for whom you are seeking care"]
+      form.inquiry_for = "Parent(s)"
+      form.must_be :valid?
+    end
+
+    it "can declare a metadata field" do
+      form_class.instance_eval { metadata :form_name }
+      form = form_class.new(:form_name => "right_rail")
+      form.must_be :valid?
+    end
+
+    it "can declare a collection field represented as caring radio buttons" do
+      form_class.instance_eval { radio_buttons :choice }
+      form = form_class.new(:choice => 'good')
+      form.must_be :valid?
+    end
+
+    it "can declare a string field" do
+      form_class.instance_eval { string :user_name }
+      form = form_class.new(:user_name => "John Zorn")
+      form.must_be :valid?
+    end
+
+    it "can declare a submit field" do
+      proc {
+        form_class.instance_eval { submit }
+        form = form_class.new
+      }.must_be_silent
+    end
+
+    it "can declare a tel field" do
+      form_class.instance_eval { tel :number }
+      form = form_class.new(:number => "123")
+      form.wont_be :valid?
+      form.errors[:number].must_equal ["Enter your phone number with area code like this: XXX-XXX-XXXX"]
+      form.number = "650-622-9294"
+      form.must_be :valid?
+    end
+
+    it "can declare a US zip code field" do
+      form_class.instance_eval { us_zip_code :zip }
+      form = form_class.new(:zip => "3")
+      form.wont_be :valid?
+      form.errors[:zip].must_equal ["Enter a valid U.S. zip code"]
+      form.zip = "94002"
+      form.must_be :valid?
+    end
+
+    it "can declare a text field" do
+      form_class.instance_eval { text :notes }
+      form = form_class.new(:notes => "blah blah")
+      form.must_be :valid?
+    end
+  end
+
+  context ".protect_from_bots: help with protecting from spammers" do
+    it "declares a dummy field to trap spam bots" do
+      form_class.instance_eval { protect_from_bots }
+      form = form_class.new
+      form.must_be :valid?
+    end
+
+    it "tells if a spam bot got trapped with #spam?" do
+      form_class.instance_eval { protect_from_bots }
+      form = form_class.new(:reference => "caught...")
+      form.must_be :spam?
+      form.reference = ""
+      form.wont_be :spam?
+    end
+  end
+
+  context ".index_on: scope to a field value" do
+    before(:each) do
+      form_class.instance_eval do
+        index_on :location
+        string :location, :ancillary => true
+        string :band
+      end
+    end
+
+    it "loads attributes using the index defined" do
+      form = form_class.new(HashWithIndifferentAccess.new(
+        "location" => "right",
+        "ze_form" => {
+          "right" => {
+            "band" => "Nightmares on Wax"
+          }
+        }
+      ))
+      form.location.must_equal "right"
+      form.band.must_equal "Nightmares on Wax"
+    end
+
+    it "only loads ancillary attributes if no index value" do
+      form = form_class.new(HashWithIndifferentAccess.new(
+        "ze_form" => {
+          "right" => {
+            "band" => "Nightmares on Wax"
+          }
+        }
+      ))
+      form.band.must_equal nil
+    end
+
+    it "only loads ancillary attributes if nothing at the index value" do
+      form = form_class.new(HashWithIndifferentAccess.new(
+        "location" => "right",
+        "ze_form" => {
+          "left" => {
+            "band" => "Nightmares on Wax"
+          }
+        }
+      ))
+      form.band.must_equal nil
+    end
+  end
+end

data/spec/caring_form/tools/referee_spec.rb

@@ -0,0 +1,86 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+require 'ostruct'
+
+require 'caring_form/tools/referee'
+
+describe CaringForm::Tools::Referee do
+  let(:field)   { OpenStruct.new }
+  let(:referee) { CaringForm::Tools::Referee.new(field) }
+
+  context "#is_rule?" do
+    it "returns true if the delegate property is a rule" do
+      field.optional = {:absent => :optional_if_empty}
+      referee.is_rule?(:optional).must_equal true
+    end
+
+    it "returns false if the delegate property isn't a rule" do
+      field.optional = true
+      referee.is_rule?(:optional).must_equal false
+      referee.is_rule?(:doesnt_exist).must_equal false
+    end
+  end
+
+  context "#decide" do
+    let(:form) { OpenStruct.new }
+
+    it "returns true if the delegate property is true" do
+      field.optional = true
+      referee.decide(:optional, form).must_equal true
+    end
+
+    it "returns false if the delegate property is false" do
+      field.optional = false
+      referee.decide(:optional, form).must_equal false
+    end
+
+    it "checks if the target is absent if the delegate property an :absent rule " do
+      field.optional = {:absent => :optional_if_empty}
+
+      form.optional_if_empty = ''
+      referee.decide(:optional, form).must_equal true
+
+      form.optional_if_empty = 'present'
+      referee.decide(:optional, form).must_equal false
+    end
+
+    it "checks if the target is present if the delegate property an :present rule " do
+      field.mandatory = {:present => :is_required}
+
+      form.is_required = 'yes'
+      referee.decide(:mandatory, form).must_equal true
+
+      form.is_required = ''
+      referee.decide(:mandatory, form).must_equal false
+    end
+
+    it "defaults to false if the rule is invalid" do
+      def form.doesnt_exist
+        raise "I shouldn't be called!"
+      end
+      field.nonsense = {:blah => :doesnt_exist}
+      referee.decide(:nonsense, form).must_equal false
+    end
+  end
+
+  context "#rule_as_data_attribute" do
+    let(:form) { MiniTest::Mock.new }
+
+    it "returns an attribute key/value pair for a :present rule" do
+      field.mandatory = {:present => :is_required}
+      form.expect(:field_id, 'mandatory_id', [:is_required])
+      attribute = referee.rule_as_data_attribute(:mandatory, form)
+      attribute.must_equal(:"data-mandatory-if-present" => '#mandatory_id')
+    end
+
+    it "returns an attribute key/value pair for an :absent rule" do
+      field.optional = {:absent => :optional_if_empty}
+      form.expect(:field_id, 'optional_id', [:optional_if_empty])
+      attribute = referee.rule_as_data_attribute(:optional, form)
+      attribute.must_equal(:"data-optional-if-absent" => '#optional_id')
+    end
+
+    it "returns an empty array if the property value is not a rule" do
+      referee.rule_as_data_attribute(:doesnt_exist, form).must_equal({})
+    end
+  end
+end