active_form 0.0.1

data/tasks/deployment.rake

@@ -0,0 +1,34 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/website.rake

@@ -0,0 +1,17 @@
+desc 'Generate website files'
+task :website_generate => :ruby_env do
+  (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
+    sh %{ #{RUBY_APP} script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]

data/test/elements/test_base_element.rb

@@ -0,0 +1,159 @@
+require 'test_helper'
+
+ActiveForm::Element::Base::create :sample_input do
+ 
+  def render_element(builder = create_builder)
+    builder.input(element_attributes)
+    builder.input(element_attributes)
+    builder.input(element_attributes)
+  end
+  
+end
+
+ActiveForm::Element::modify :sample_input do
+  
+  def render_element(builder = create_builder)
+    builder.textarea(formatted_value, element_attributes)
+  end
+  
+end
+
+class TestBaseElement < Test::Unit::TestCase
+  
+  def test_standard_attributes
+    assert ActiveForm::Element::Base.element_attribute_names.include?(:title)
+    assert ActiveForm::Element::Base.element_attribute_names.include?(:lang)
+    elem = ActiveForm::Element::Base.new :elem
+    assert elem.respond_to?(:title=)
+    assert elem.respond_to?(:style=)
+    assert elem.respond_to?(:class=)
+    assert elem.respond_to?(:lang=)
+    assert_equal Hash.new, elem.attributes    
+    expected = {"name"=>"elem", "class"=>"elem_base", "id"=>"elem"}
+    assert_equal expected, elem.element_attributes
+  end
+  
+  def test_set_standard_attributes
+    elem = ActiveForm::Element::Base.new :elem, :title => 'My Element', :lang => 'nl-nl', :unknown => 'will be skipped'
+    expected = {"title"=>"My Element", "lang"=>"nl-nl"}
+    assert_equal expected, elem.attributes
+    expected = {"name"=>"elem", "class"=>"elem_base", "title"=>"My Element", "id"=>"elem", "lang"=>"nl-nl"}
+    assert_equal expected, elem.element_attributes
+  end
+  
+  def test_set_custom_attributes
+    elem = ActiveForm::Element::Base.new :elem, :unknown => 'will be skipped'
+    expected = {}
+    assert_equal expected, elem.attributes
+    elem.attributes[:custom] = 'attribute'
+    expected = {"custom"=>"attribute"}
+    assert_equal expected, elem.attributes
+  end
+  
+  def test_standard_option_flags
+    elem = ActiveForm::Element::Base.new :elem
+    [:frozen, :hidden, :disabled, :readonly, :required].each do |method|
+      assert ActiveForm::Element::Base.element_option_flag_names.include?(method)
+      assert elem.respond_to?("#{method}") 
+      assert elem.respond_to?("#{method}=")
+      assert elem.respond_to?("#{method}?")
+    end
+  end
+  
+  def test_option_flags_in_css_class
+    elem = ActiveForm::Element::Base.new :elem, :frozen => true, :hidden => true, :disabled => true, :readonly => true, :required => true
+    elem.css_class += "special"
+    assert_equal "elem_base special", elem.css_class.to_s
+    assert_equal "frozen hidden disabled readonly required", elem.runtime_css_class.to_s
+    assert_equal "elem_base special frozen hidden disabled readonly required", elem.css
+  end
+  
+  def test_option_flags_in_css_style
+    elem = ActiveForm::Element::Base.new :elem, :frozen => true, :hidden => true, :disabled => true, :required => true
+    assert_equal "", elem.css_style.to_s
+    assert_equal "display: none", elem.style
+    assert_equal elem.runtime_css_style.to_s, elem.style
+  end
+  
+  def test_label_css
+    elem = ActiveForm::Element::Base.new :elem, :hidden => true
+    assert_equal "hidden", elem.label_css
+    elem = ActiveForm::Element::Base.new :elem, :hidden => true, :required => true
+    assert_equal "hidden required", elem.label_css
+    [:frozen, :readonly, :disabled].each do |flag|
+      elem = ActiveForm::Element::Base.new :elem, flag => true
+      assert_equal "inactive", elem.label_css
+    end
+  end
+  
+  def test_frozen_flag_inheritance
+    form = ActiveForm::compose :form
+    elem = form.text_element :elem
+    section = form.section :section, :frozen => true
+    nested = section.text_element :nested
+    assert !form.frozen?; assert !elem.frozen?; assert section.frozen?; assert nested.frozen?
+    elem.frozen = true
+    assert !form.frozen?; assert elem.frozen?;  assert section.frozen?; assert nested.frozen?
+    elem.frozen = false
+    assert !form.frozen?; assert !elem.frozen?; assert section.frozen?; assert nested.frozen?
+    form.frozen = true
+    assert form.frozen?;  assert elem.frozen?;  assert section.frozen?; assert nested.frozen?
+  end
+  
+  def test_render_label
+    elem = ActiveForm::Element::Base.new :elem, :label => 'My Element'
+    assert elem.labelled?
+    assert_equal %|<label for="elem">My Element</label>\n|, elem.render_label
+    elem.hidden = true
+    assert_equal %|<label class="hidden" for="elem">My Element</label>\n|, elem.render_label
+    elem.hidden = false; elem.required = true; elem.frozen = true
+    assert_equal %|<label class="inactive required" for="elem">My Element</label>\n|, elem.render_label
+  end
+  
+  def test_frozen_element
+    elem = ActiveForm::Element::Base.new :elem, :frozen => true
+    assert elem.frozen?
+    assert_equal "elem_base", elem.css_class.to_s
+    assert_equal "frozen", elem.runtime_css_class.to_s
+    assert_equal "elem_base frozen", elem.css
+    assert_equal %|<label class="inactive" for="elem">Elem</label>\n|, elem.render_label 
+    elem.frozen = false
+    assert !elem.frozen?
+    assert_equal "elem_base", elem.css
+    assert_equal %|<label for="elem">Elem</label>\n|, elem.render_label
+  end
+  
+  def test_render_input
+    elem = ActiveForm::Element::Base.new :elem
+    assert_equal elem.render_element, elem.render_input
+    elem = ActiveForm::Element::Base.new :elem, :frozen => true
+    assert elem.frozen?
+    assert_equal elem.render_frozen, elem.render_input
+  end
+  
+  def test_element_to_html
+    elem = ActiveForm::Element::Base.new :elem
+    expected = %|<span class="elem_base" id="elem">Elem</span>\n|
+    assert_equal expected, elem.to_html    
+  end
+  
+  def test_to_label
+    elem = ActiveForm::Element::Base.new :elem, :label => 'My Element'
+    assert_equal elem.render_label, elem.to_label
+  end
+  
+  def test_to_input
+    elem = ActiveForm::Element::Base.new :elem
+    assert_equal elem.render_element, elem.to_input
+    elem = ActiveForm::Element::Base.new :elem, :frozen => true
+    assert elem.frozen?
+    assert_equal elem.render_frozen, elem.to_input
+  end
+  
+  def test_modified_element_class_definition
+    elem = ActiveForm::Element::SampleInput.new :elem, :value => 'Some text...'
+    expected = %|<textarea class="elem_sample_input" id="elem" name="elem">Some text...</textarea>\n|
+    assert_equal expected, elem.to_html 
+  end
+  
+end

data/test/elements/test_builder_element.rb

@@ -0,0 +1,81 @@
+require 'test_helper'
+
+ActiveForm::Element::Builder::create :some_snippet do |builder, elem|
+
+  builder.h1('A preset element')
+  builder.p('Just an example of what you can do...')
+  
+end
+
+class TestBuilderElement < Test::Unit::TestCase
+  
+  def test_element_to_html
+    elem = ActiveForm::Element::Builder.new :elem, :html => 'raw html string'
+    assert_equal %|raw html string\n|, elem.to_html
+    
+    elem = ActiveForm::Element::Builder.new :elem do |builder, e|
+      builder.div('built with block')
+    end
+    assert_equal %|<div>built with block</div>\n|, elem.to_html
+    
+    elem = ActiveForm::Element::Builder.new :elem, :html => 'raw html string and builder block' do |builder, e|
+      builder.div(e.value)
+    end
+    assert_equal %|<div>raw html string and builder block</div>\n|, elem.to_html   
+  end
+  
+  def test_build_html
+    form = ActiveForm::compose :form do |f|
+      f.html :named do |builder, e|
+        builder.h1('My Pretty form')
+        builder.dl {
+          e.container.get_elements_of_type(:text).each do |e|
+            builder.dt(e.label)
+            builder.dd(e.value)
+          end
+        }
+      end
+      f.text_element :name
+      f.text_element :city
+      f.html { |builder, e| builder.hr }
+    end
+    form.values = { :name => 'Fred', :city => 'Bedrock' }
+    expected = %|<form action="#form" class="active_form" id="form" method="post">
+  <h1>My Pretty form</h1>
+  <dl>
+    <dt>Name</dt>
+    <dd>Fred</dd>
+    <dt>City</dt>
+    <dd>Bedrock</dd>
+  </dl>
+  <input class="elem_text" id="form_name" name="form[name]" size="30" type="text" value="Fred"/>
+  <input class="elem_text" id="form_city" name="form[city]" size="30" type="text" value="Bedrock"/>
+  <hr/>
+</form>\n|
+    assert_equal expected, form.to_html
+  end
+  
+  def test_add_raw_string
+    form = ActiveForm::compose :form
+    form << '<h1>My Form</h1>'
+    form.text_element :name
+    form << '<hr />'
+    expected = %|<form action="#form" class="active_form" id="form" method="post">
+<h1>My Form</h1>
+  <input class="elem_text" id="form_name" name="form[name]" size="30" type="text"/>
+<hr />
+</form>\n|
+    assert_equal expected, form.to_html
+  end
+  
+  def test_add_predefined_html_snippet_element
+    form = ActiveForm::compose :form
+    form.some_snippet_element
+    expected = %|<form action="#form" class="active_form" id="form" method="post">
+  <h1>A preset element</h1>
+  <p>Just an example of what you can do...</p>
+</form>\n|
+    assert_equal expected, form.to_html
+  end
+  
+end

data/test/elements/test_button_element.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+
+class TestButtonElement < Test::Unit::TestCase
+  
+  def test_element_to_html
+    elem = ActiveForm::Element::Button.new :elem, :label => 'Do it!'
+    assert !elem.labelled?
+    expected = %|<input class="elem_button" id="elem" name="elem" type="button" value="Do it!"/>\n|
+    assert_equal expected, elem.to_html    
+  end
+  
+end

data/test/elements/test_checkbox_element.rb

@@ -0,0 +1,233 @@
+require 'test_helper'
+
+class TestCheckboxElement < Test::Unit::TestCase
+  
+  def test_standard_values
+    elem = ActiveForm::Element::Checkbox.new :elem
+    assert_equal nil, elem.fallback_value
+    assert_equal 1, elem.checked_value
+    assert_equal nil, elem.export_value
+    elem.checked = true
+    assert_equal 1, elem.export_value
+    expected = %|<input checked="checked" class="elem_checkbox" id="elem" name="elem" type="checkbox" value="1"/>\n|
+    assert_equal expected, elem.to_html 
+  end
+  
+  def test_element_to_html    
+    elem = ActiveForm::Element::Checkbox.new :elem, :option => 'yes'
+    assert !elem.checked?
+    assert_equal nil, elem.value
+    expected = %|<input class="elem_checkbox" id="elem" name="elem" type="checkbox" value="yes"/>\n|
+    assert_equal expected, elem.to_html  
+    
+    elem = ActiveForm::Element::Checkbox.new :elem, :option => 'yes', :checked => true
+    assert elem.checked?
+    assert_equal 'yes', elem.value
+    expected = %|<input checked="checked" class="elem_checkbox" id="elem" name="elem" type="checkbox" value="yes"/>\n|
+    assert_equal expected, elem.to_html   
+  end
+  
+  def test_set_options
+    elem = ActiveForm::Element::Checkbox.new :elem, :options => ['yes', 'no']
+    assert !elem.checked?
+    expected = %|<input class="elem_checkbox" id="elem" name="elem" type="checkbox" value="yes"/>\n|
+    assert_equal expected, elem.to_html  
+    
+    elem.value = 'yes'
+    assert elem.checked?
+    expected = %|<input checked="checked" class="elem_checkbox" id="elem" name="elem" type="checkbox" value="yes"/>\n|
+    assert_equal expected, elem.to_html  
+  end 
+  
+  def test_unknown_value
+    elem = ActiveForm::Element::Checkbox.new :elem, :option => 'yes'
+    elem.value = 'unknown'
+    assert !elem.checked?
+    assert_equal nil, elem.element_value
+    
+    elem.value = 'yes' 
+    assert elem.checked?
+    assert_equal 'yes', elem.element_value
+    
+    elem = ActiveForm::Element::Checkbox.new :elem, :options => ['yes', 'no']
+    elem.value = 'unknown'
+    assert !elem.checked?
+    assert_equal 'no', elem.element_value
+    
+    elem.value = 'yes'
+    assert elem.checked?
+    assert_equal 'yes', elem.element_value
+  end
+  
+  def test_set_checked
+    elem = ActiveForm::Element::Checkbox.new :elem, :options => ['yes', 'no'], :checked => true
+    assert elem.checked?
+    assert_equal 'yes', elem.checked_value
+    assert_equal 'no', elem.fallback_value
+    assert_equal 'yes', elem.export_value
+    assert_equal 'yes', elem.element_value
+    
+    elem.checked = false 
+    assert !elem.checked?
+    assert_equal 'yes', elem.checked_value
+    assert_equal 'no', elem.fallback_value
+    assert_equal 'no', elem.export_value
+    assert_equal 'no', elem.element_value 
+    
+    elem.checked = true
+    assert elem.checked?
+    assert_equal 'yes', elem.checked_value
+    assert_equal 'no', elem.fallback_value
+    assert_equal 'yes', elem.export_value
+    assert_equal 'yes', elem.element_value 
+  end
+  
+  def test_on_off_value
+    elem = ActiveForm::Element::Checkbox.new :elem, :options => ['yes', 'no']
+    assert !elem.checked?
+    assert_equal 'yes', elem.checked_value
+    assert_equal 'no', elem.fallback_value
+    assert_equal 'no', elem.export_value
+    assert_equal 'no', elem.element_value    
+    
+    elem.update_from_params('yes')
+    assert elem.checked?
+    assert_equal 'yes', elem.element_value
+    
+    elem.update_from_params('no')
+    assert !elem.checked?
+    assert_equal 'no', elem.element_value
+    
+    elem.update_from_params(nil)
+    assert !elem.checked?
+    assert_equal 'no', elem.element_value
+  end
+  
+  def test_update_from_params
+    form = ActiveForm::compose :myform do |f|
+      f.text_element :first_name
+      f.text_element :last_name
+      f.checkbox_element :confirm, :options => ['yes', 'no'], :value => 'yes'
+      f.submit_element :send
+    end  
+    assert form[:confirm].checked?
+    
+    params = { :myform => { :first_name => 'Fred', :last_name => 'Flintstone', :confirm => 'yes' } }   
+    form.update_from_params(params)
+    assert form[:confirm].checked?
+    
+    params = { :myform => { :first_name => 'Fred', :last_name => 'Flintstone', :confirm => 'no' } }   
+    form.update_from_params(params)
+    assert !form[:confirm].checked?
+    form[:confirm].checked = true
+    
+    params = { :myform => { :first_name => 'Fred', :last_name => 'Flintstone', :confirm => nil } }   
+    form.update_from_params(params)
+    assert !form[:confirm].checked?
+    form[:confirm].checked = true
+    
+    params = { :myform => { :first_name => 'Fred', :last_name => 'Flintstone', :confirm => nil } }   
+    form.update_from_params(params)
+    assert !form[:confirm].checked?
+    form[:confirm].checked = true
+    
+    params = { :myform => { :first_name => 'Fred', :last_name => 'Flintstone' } } 
+    form.update_from_params(params)
+    assert !form[:confirm].checked?
+  end
+  
+  def test_if_checked
+    elem = ActiveForm::Element::Checkbox.new :elem, :option => 'yes'
+    assert_equal 'yes', elem.checked_value
+    assert_equal nil, elem.fallback_value
+    assert_equal nil, elem.export_value
+    assert_equal nil, elem.element_value 
+    assert !elem.active?
+    assert !elem.checked?
+    assert !elem.selected?
+    
+    elem.update_from_params('yes')
+    assert elem.active?
+    assert elem.checked?
+    assert elem.selected?
+    assert_equal 'yes', elem.element_value
+    
+    elem.update_from_params('no')
+    assert !elem.checked?
+    assert_equal nil, elem.element_value
+    
+    elem.update_from_params(nil)
+    assert !elem.checked?
+    assert_equal nil, elem.element_value 
+  end
+  
+  def test_required_validation
+    form = ActiveForm::compose :myform do |f|
+      f.text_element :first_name
+      f.text_element :last_name
+      f.checkbox_element :confirm, :options => ['yes', 'no'], :required => true
+      f.submit_element :send
+    end
+    
+    assert_equal 0, form[:confirm].element_errors.length
+    assert_equal '', form[:confirm].validation_advice
+    
+    validator = form[:confirm].validators.detect { |v| v.code == 'required' }
+    assert_kind_of ActiveForm::Validator::Proc, validator
+    assert !form.validate
+    expected = %|<div class="validation-advice advice-confirm" id="advice-validate-confirm-myform_confirm">Confirm: validation failed</div>\n|
+    assert_equal expected, form[:confirm].validation_advice
+     
+    form[:confirm].value = 'no'
+    assert !form.validate
+    assert_equal expected, form[:confirm].validation_advice
+    
+    form[:confirm].value = 'yes'
+    assert form.validate
+    assert_equal '', form[:confirm].validation_advice
+    
+    form[:confirm].required_message = 'you need to confirm this'
+    assert_equal 'you need to confirm this', validator.message
+    
+    form[:confirm].required = false
+    validator = form[:confirm].validators.detect { |v| v.code == 'required' }
+    assert_equal nil, validator
+  end
+  
+  def test_set_values_beforehand
+    person = { :first_name => 'Fred', :last_name => 'Flintstone', :confirm => 'yes' }
+    
+    form = ActiveForm::compose :myform, :values => person do |f|
+      f.text_element :first_name, :required => true
+      f.text_element :last_name, :required => true
+      f.checkbox_element :confirm, :options => ['yes', 'no'], :required => true
+      f.submit_element :send
+    end
+    
+    assert form[:confirm].checked?
+    expected = %|<input checked="checked" class="elem_checkbox required" id="myform_confirm" name="myform[confirm]" type="checkbox" value="yes"/>\n|
+    assert_equal expected, form[:confirm].to_html
+  end
+  
+    def test_add_multiple_radio_elements
+    form = ActiveForm::compose :myform do |f|
+      f.checkbox_element :elem_a, :option => 'A', :group => :choice
+      f.checkbox_element :elem_b, :option => 'B', :group => :choice, :checked => true
+    end
+    assert !form[:elem_a].checked?
+    assert form[:elem_b].checked?
+    
+    assert_equal 'A', form[:elem_a].checked_value
+    assert_equal 'B', form[:elem_b].checked_value
+    
+    assert_equal 'myform[choice][]', form[:elem_a].element_name
+    assert_equal 'myform[choice][]', form[:elem_b].element_name
+    
+    assert_equal 'myform_elem_a', form[:elem_a].identifier
+    assert_equal 'myform_elem_b', form[:elem_b].identifier
+    
+    expected = { "choice" => ["B"] }
+    assert_equal expected, form.export_values 
+  end
+  
+end