presenting 1.0.0

data/test/form_test.rb

@@ -0,0 +1,287 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class FormTest < Presenting::Test
+  def setup
+    @f = Presentation::Form.new
+  end
+  
+  def test_method_for_new_record
+    @f.presentable = stub('record', :new_record? => true)
+    assert_equal :post, @f.method
+  end
+  
+  def test_method_for_existing_record
+    @f.presentable = stub('record', :new_record? => false)
+    assert_equal :put, @f.method
+  end
+  
+  def test_button_for_new_record
+    @f.presentable = stub('record', :new_record? => true)
+    assert_equal 'Create', @f.button
+  end
+  
+  def test_button_for_existing_record
+    @f.presentable = stub('record', :new_record? => false)
+    assert_equal 'Update', @f.button
+  end
+  
+  def test_adding_a_field_by_name
+    @f.fields = [:a]
+    
+    assert_equal :a, @f.fields.first.name
+    assert_equal 'A', @f.fields.first.label
+    assert_equal :string, @f.fields.first.type
+  end
+  
+  def test_adding_a_field_by_name_and_type
+    @f.fields = [{:b => :boolean}]
+    
+    assert_equal :b, @f.fields.first.name
+    assert_equal 'B', @f.fields.first.label
+    assert_equal :boolean, @f.fields.first.type
+  end
+  
+  def test_adding_a_field_by_name_and_options
+    @f.fields = [{:foo => {:label => "Foo Bar", :type => :select}}]
+
+    assert_equal :foo, @f.fields.first.name
+    assert_equal 'Foo Bar', @f.fields.first.label
+    assert_equal :select, @f.fields.first.type
+  end
+  
+  def test_fields_accessors_are_shortcuts_to_first_group
+    @f.fields = [:a]
+    assert_equal :a, @f.groups.first.fields.first.name
+    assert_equal @f.fields, @f.groups.first.fields
+  end
+  
+  def test_adding_an_unnamed_group_of_fields
+    @f.groups = [[:a]]
+    
+    assert_nil @f.groups.first.name
+    assert_equal :a, @f.groups.first.fields.first.name
+  end
+  
+  def test_adding_a_named_group_of_fields
+    @f.groups = [{"foo" => [:a]}]
+    
+    assert_equal "foo", @f.groups.first.name
+    assert_equal :a, @f.groups.first.fields.first.name
+  end
+end
+
+class FormFieldTest < Presenting::Test
+  def setup
+    @f = Presentation::Form::Field.new
+  end
+  
+  def test_default_value
+    @f.name = 'foo'
+    assert_equal :foo, @f.value
+  end
+  
+  def test_symbol_value
+    @f.value = :foo
+    assert_equal 'bar', @f.value_from(stub('record', :foo => 'bar'))
+  end
+  
+  def test_string_value
+    @f.value = 'foo'
+    assert_equal 'foo', @f.value_from(stub('record', :foo => 'bar'))
+  end
+  
+  def test_proc_value
+    @f.value = proc{|r| r.foo }
+    assert_equal 'bar', @f.value_from(stub('record', :foo => 'bar'))
+  end
+end
+
+class FormRenderingTest < Presentation::RenderTest
+  def setup
+    @presentation = Presentation::Form.new
+    @presentation.controller = TestController.new
+  end
+  
+  def test_rendering_a_string_field
+    @presentation.presentable = User.new(:name => 'bob smith')
+    @presentation.fields = [:name]
+
+    assert_select 'form div.field' do
+      assert_select 'label', 'Name'
+      assert_select "input[type=text][name='user[name]'][value='bob smith']"
+    end
+  end
+  
+  def test_rendering_a_string_field_with_a_custom_value
+    @presentation.presentable = User.new(:name => 'bob smith')
+    @presentation.fields << {:name => {:value => 'test'}}
+    
+    assert_select 'form div.field' do
+      assert_select "input[type=text][name='user[name]'][value='test']"
+    end
+  end
+  
+  def test_rendering_a_text_field
+    @presentation.presentable = User.new(:name => 'bob smith')
+    @presentation.fields = [{:name => :text}]
+    
+    assert_select 'form div.field' do
+      assert_select 'label', 'Name'
+      assert_select "textarea[name='user[name]']", 'bob smith'
+    end
+  end
+  
+  def test_rendering_a_text_field_with_a_custom_value
+    @presentation.presentable = User.new(:name => 'bob smith')
+    @presentation.fields << {:name => {:type => :text, :value => 'test'}}
+    
+    assert_select 'form div.field' do
+      assert_select "textarea[name='user[name]']", 'test'
+    end
+  end
+  
+  def test_rendering_a_readonly_field
+    @presentation.presentable = User.new(:name => 'bob smith')
+    @presentation.fields = [{:name => :readonly}]
+    
+    assert_select 'form div.field' do
+      assert_select 'label', 'Name'
+      assert_select "input[type=text][disabled=disabled][name='user[name]'][value='bob smith']"
+    end
+  end
+  
+  def test_rendering_a_readonly_field_with_a_custom_value
+    @presentation.presentable = User.new(:name => 'bob smith')
+    @presentation.fields << {:name => {:type => :readonly, :value => 'test'}}
+    
+    assert_select 'form div.field' do
+      assert_select "input[type=text][disabled=disabled][name='user[name]'][value='test']"
+    end
+  end
+  
+  def test_rendering_a_password_field
+    @presentation.presentable = User.new(:name => 'bob smith')
+    @presentation.fields = [{:name => :password}]
+    
+    assert_select 'form div.field' do
+      assert_select 'label', 'Name'
+      assert_select "input[type=password][name='user[name]'][value='bob smith']"
+    end
+  end
+  
+  def test_rendering_a_boolean_field
+    @presentation.presentable = User.new(:suspended => false, :registered => true)
+    @presentation.fields = [{:suspended => :boolean}, {:registered => :boolean}]
+
+    assert_select 'form div.field:nth-of-type(1)' do
+      assert_select 'label', 'Suspended'
+      assert_select "input[type=checkbox][name='user[suspended]']"
+    end
+    assert_select 'form div.field:nth-of-type(2)' do
+      assert_select 'label', 'Registered'
+      assert_select "input[type=checkbox][name='user[registered]'][checked=checked]"
+    end
+  end
+  
+  def test_rendering_a_hidden_field
+    @presentation.presentable = User.new(:suspended => false)
+    @presentation.fields = [{:suspended => :hidden}]
+    
+    assert_select 'form' do
+      assert_select 'label', {:text => 'Suspended', :count => 0}
+      assert_select "input[type=hidden][name='user[suspended]']"
+    end
+  end
+  
+  def test_rendering_a_dropdown_field
+    @presentation.presentable = User.new(:prefix => 'mr')
+    @presentation.fields = [{:prefix => {:type => :dropdown, :type_options => [['Mr.', 'mr'], ['Mrs.', 'mrs']]}}]
+    
+    assert_select 'form div.field' do
+      assert_select 'label', 'Prefix'
+      assert_select "select[name='user[prefix]']" do
+        assert_select "option[value=mr][selected=selected]", "Mr."
+        assert_select "option[value=mrs]", "Mrs."
+      end
+    end
+  end
+
+  def test_rendering_a_radios_field
+    @presentation.presentable = User.new(:prefix => 'mr')
+    @presentation.fields = [{:prefix => {:type => :radios, :type_options => [['Mr.', 'mr'], ['Mrs.', 'mrs']]}}]
+    
+    assert_select 'form div.field' do
+      assert_select 'label', 'Prefix'
+      assert_select "label[for=user_prefix_mr]", "Mr."
+      assert_select "input[type=radio][name='user[prefix]'][value=mr][checked=checked]"
+      assert_select "label[for=user_prefix_mrs]", "Mrs."
+      assert_select "input[type=radio][name='user[prefix]'][value=mrs]"
+    end
+  end
+
+  def test_rendering_a_multi_select_field
+    @presentation.presentable = User.new(:role_ids => [1,3])
+    @presentation.fields = [{:role_ids => {:type => :multi_select, :type_options => [['A', 1], ['B', 2], ['C', 3]], :label => "Roles"}}]
+    
+    assert_select 'form div.field' do
+      assert_select 'label', 'Roles'
+      assert_select "select[name='user[role_ids][]'][multiple=multiple]" do
+        assert_select "option[value=1][selected=selected]", "A"
+        assert_select "option[value=2]", "B"
+        assert_select "option[value=3][selected=selected]", "C"
+      end
+    end
+  end
+  
+  def test_rendering_a_group_of_fields
+    @presentation.presentable = User.new
+    @presentation.groups = [
+      [:name, :email],
+      {"flags" => [:registered, :suspended]}
+    ]
+
+    assert_select "form fieldset:nth-of-type(1)" do
+      assert_select "legend", false
+      assert_select "div.field input[name='user[name]']"
+      assert_select "div.field input[name='user[email]']"
+    end
+    assert_select "form fieldset:nth-of-type(2)" do
+      assert_select "legend", "flags"
+      assert_select "div.field input[name='user[registered]']"
+      assert_select "div.field input[name='user[suspended]']"
+    end
+  end
+  
+  class User
+    include Presenting::Configurable
+    
+    attr_accessor :prefix
+    attr_accessor :name
+    attr_accessor :email
+    attr_accessor :registered
+    attr_accessor :suspended
+    attr_accessor :role_ids
+    
+    ##
+    ## duck typing
+    ##
+    
+    def new_record=(val)
+      @new_record = val
+    end
+    
+    def new_record?
+      !! @new_record
+    end
+
+    def id
+      @id ||= new_record? ? nil : '12345'
+    end
+    
+    def to_param
+      id
+    end
+    
+    def self.name; 'User' end
+  end
+end

data/test/grid_test.rb

@@ -0,0 +1,219 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class GridTest < Presenting::Test
+  def setup
+    @g = Presentation::Grid.new
+  end
+  
+  def test_default_title
+    @g.id = "something_or_other"
+    assert_equal "Something Or Other", @g.title
+  end
+
+  def test_adding_a_field_by_name
+    @g.fields = ["foo"]
+    assert_equal "foo", @g.fields.first.name, "name is stringified"
+    assert_equal "foo", @g.fields.first.value, "value is assumed to be a method"
+  end
+  
+  def test_adding_a_field_by_name_and_value
+    @g.fields = [{"foo" => :bar}]
+    assert_equal "foo", @g.fields.first.name, "key is name"
+    assert_equal :bar, @g.fields.first.value, "value is value"
+  end
+  
+  def test_adding_a_field_by_name_and_options
+    @g.fields = [{"foo" => {:value => :bar}}]
+    assert_equal "foo", @g.fields.first.name, "key is name"
+    assert_equal :bar, @g.fields.first.value, "value is found and saved"
+  end
+  
+  def test_adding_links_as_strings
+    @g.links = ['<a href="/foo">foo</a>']
+    assert_equal 1, @g.links.size
+  end
+  
+  def test_adding_links_as_procs
+    assert_raises ArgumentError do
+      @g.links = [proc{|record| link_to(record.name, record)}]
+    end
+  end
+  
+  def test_adding_record_links_as_procs
+    @g.record_links = [proc{|record| link_to(record.name, record)}]
+    assert_equal 1, @g.record_links.size
+  end
+
+  def test_adding_nil_record_links
+    assert_nothing_raised do
+      # this would happen if a link sometimes did not appear
+      @g.record_links = [nil]
+    end
+    assert @g.record_links.empty?
+  end
+  
+  def test_adding_record_links_as_strings
+    assert_raises ArgumentError do
+      @g.record_links = ['<a href="/foo">foo</a>']
+    end
+  end
+  
+  def test_arrays_do_not_paginate
+    @g.presentable = []
+    assert !@g.paginate?
+  end
+  
+  def test_paginated_collections_will_paginate
+    @g.presentable = WillPaginate::Collection.new(1, 1)
+    assert @g.paginate?
+  end
+end
+
+class GridFieldTest < Presenting::Test
+  def setup
+    @f = Presentation::Grid::Field.new
+  end
+  
+  def test_default_sorting_for_field
+    @f.name = "First Name"
+    assert @f.sortable?
+    assert_equal "first_name", @f.sort_name
+  end
+  
+  def test_sortable_field
+    @f.name = "First Name"
+    @f.sortable = true
+    assert @f.sortable?
+    assert_equal "first_name", @f.sort_name
+  end
+  
+  def test_specified_sort_name
+    @f.name = "First Name"
+    @f.sortable = "foo"
+    assert @f.sortable?
+    assert_equal "foo", @f.sort_name
+  end
+  
+  def test_unsortable_field
+    @f.sortable = false
+    assert !@f.sortable?
+  end
+end
+
+class GridRenderTest < Presentation::RenderTest
+  def setup
+    @presentation = Presentation::Grid.new(:id => "users", :fields => [:name, :email])
+    @records = [
+      stub('user', :name => 'foo', :email => 'foo@example.com'),
+      stub('user', :name => 'bar', :email => 'bar@example.com')
+    ]
+    @presentation.presentable = @records
+    @presentation.controller = TestController.new
+    @presentation.controller.params = {:controller => 'users', :action => 'index'} # WillPaginate reuses existing params
+  end
+
+  def test_rendering_the_title
+    assert_select "#users table caption", 'Users'
+  end
+  
+  def test_rendering_links
+    @presentation.links = ['<a href="/foo" class="foo">bar</a>']
+
+    assert_select '#users caption ul.actions' do
+      assert_select 'li a.foo', 'bar'
+    end
+  end
+  
+  def test_rendering_record_links
+    @presentation.record_links = [proc{|r| "<a href='/foo' class='record-link'>#{r.name}</a>"}]
+    
+    assert_select '#users tbody tr td ul.actions' do
+      assert_select 'li a.record-link', 'foo'
+      assert_select 'li a.record-link', 'bar'
+    end
+  end
+
+  def test_rendering_column_headers
+    assert_select "#users" do
+      assert_select "thead" do
+        assert_select "th.name", "Name"
+        assert_select "th.email", "Email"
+      end
+    end
+  end
+
+  def test_rendering_rows
+    assert_select "#users tbody" do
+      assert_select "tr:nth-child(1)" do
+        assert_select 'td.name', 'foo'
+        assert_select 'td.email', 'foo@example.com'
+      end
+      assert_select "tr:nth-child(2)" do
+        assert_select 'td.name', 'bar'
+        assert_select 'td.email', 'bar@example.com'
+      end
+    end
+  end
+  
+  def test_rendering_no_rows
+    @presentation.presentable = []
+    assert_select "#users tbody" do
+      assert_select "tr", 1
+      assert_select "tr td", "No records found."
+    end
+  end
+
+  def test_rendering_sanitized_data
+    @presentation.fields['Name'].sanitize = true
+    @presentation.fields['Email'].sanitize = false
+    @records << stub('row', :name => '&', :email => '&')
+    
+    assert_select "#users tbody tr" do
+      assert_select 'td.name', '&amp;'
+      assert_select 'td.email', '&'
+    end
+  end
+  
+  def test_rendering_sanitized_arrays
+    @records << stub('row', :name => ['bob', '&', 'lucy'], :email => '')
+    
+    assert_select "#users tbody tr" do
+      assert_select 'td.name' do
+        assert_select 'ol li:nth-child(2)', '&amp;'
+      end
+    end
+  end
+  
+  def test_rendering_with_pagination
+    @presentation.presentable = WillPaginate::Collection.new(1, 1, 2)
+    assert_select '#users tfoot .pagination'
+  end
+  
+  def test_rendering_sortable_columns
+    @presentation.fields.each{|f| f.sortable = true}
+    
+    assert_select "#users thead" do
+      assert_select "th a.sortable", "Name"
+      assert_select "th a.sortable", "Email"
+    end
+  end
+  
+  def test_rendering_unsortable_columns
+    @presentation.fields.each{|f| f.sortable = false}
+    
+    assert_select "#users thead" do
+      assert_select "th", "Name"
+      assert_select "th", "Email"
+    end
+  end
+  
+  def test_rendering_a_sorted_column
+    @presentation.fields.each{|f| f.sortable = true}
+    @presentation.controller.request.query_parameters = {"sort" => {'name' => 'desc'}}
+    
+    assert_select "#users thead" do
+      assert_select "th a.sortable[href='/?sort%5Bname%5D=asc']", "Name"
+    end
+  end
+end
+

data/test/helpers_test.rb

@@ -0,0 +1,72 @@
+require File.dirname(__FILE__) + '/test_helper'
+require 'action_view/test_case'
+
+class Presenting::HelpersTest < ActionView::TestCase
+  
+  def test_presenting_a_boolean
+    assert_equal 'False', present(false)
+    assert_equal 'True', present(true)
+  end
+  
+  def test_presenting_a_nil
+    assert_equal "", present(nil)
+  end
+  
+  def test_presenting_an_array_creates_an_ordered_list
+    assert present(['hello', 'world']) =~ %r|^<ol>.*</ol>$|
+  end
+  
+  def test_presenting_an_array_presents_the_members
+    assert present([true]).include?("<li>True</li>")
+  end
+  
+  def test_presenting_a_hash_creates_a_definition_list
+    assert present({1 => 'a'}) =~ %r|^<dl>.*</dl>$|
+  end
+  
+  def test_presenting_a_hash_sorts_by_hash_keys
+    assert present({1 => 'a', 4 => 'd', 3 => 'c', 2 => 'b'}) =~ /^.*a.*b.*c.*d.*$/
+  end
+  
+  def test_presenting_a_hash_presents_the_values
+    assert present({1 => true}).include?("<dd>True</dd>")
+  end
+  
+  def test_presenting_a_time
+    assert_equal 'Fri, 13 Feb 2009 02:31:00 -0800', present(Time.parse('02/13/2009 02:31 AM').to_time)
+  end
+  
+  def test_presenting_a_date
+    assert_equal '2009-02-13', present(Time.parse('02/13/2009 02:31 AM').to_date)
+  end
+  
+  def test_presenting_a_string
+    assert_equal "hello world", present("hello world")
+  end
+  
+  def test_presenting_a_named_method
+    assert_equal "<span>hello world</span>", present('hello world', :in_a_span)
+  end
+
+  def test_presenting_a_symbol
+    assert_equal "<span></span>", present(:in_a_span)
+  end
+
+  def test_presenting_a_named_presentation
+    self.expects(:controller).returns(TestController.new)
+    Presentation::Grid.any_instance.expects(:render)
+    present('hello', :grid)
+  end
+  
+  def test_presenting_an_unknown_presentation
+    assert_raises ArgumentError do
+      present(@users, :unknown)
+    end
+  end
+  
+  protected
+  
+  def present_in_a_span(str, options = {})
+    "<span>#{str}</span>"
+  end
+end

data/test/presenting_test.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class PresentationTest < Test::Unit::TestCase
+  
+  def test_rendering
+    # TODO: create a "hello world" test-only setup so i can test rendering
+    @p = Presentation::Grid.new(:id => "hello_world")
+    @p.presentable = []
+    @p.controller = TestController.new
+    assert_nothing_raised do
+      assert @p.render
+    end
+  end
+  
+end

data/test/rails/app/controllers/application_controller.rb

@@ -0,0 +1,15 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+
+  # See ActionController::RequestForgeryProtection for details
+  # Uncomment the :secret if you're not using the cookie session store
+  protect_from_forgery # :secret => '0ede37e7d2f6d8445f151b0a38ee0539'
+  
+  # See ActionController::Base for details 
+  # Uncomment this to filter the contents of submitted sensitive data parameters
+  # from your application log (in this case, all fields with names like "password"). 
+  # filter_parameter_logging :password
+end

data/test/rails/app/controllers/users_controller.rb

@@ -0,0 +1,36 @@
+class UsersController < ApplicationController
+  def index
+    @users = User.paginate(
+      :page => params[:page],
+      :per_page => 2,
+      :conditions => Presenting::Search.new(:fields => {
+        'first_name' => :equals,
+        'last_name' => :begins_with,
+        'email' => :not_null
+      }).to_sql(params[:search], :field),
+      :order => Presenting::Sorting.new(:fields => [
+        :prefix,
+        :first_name,
+        :last_name,
+        :email
+      ]).to_sql(params[:sort])
+    )
+  end
+  
+  def new
+    @user = User.new
+  end
+  
+  def create
+    @user = User.new(params[:user])
+    @user.save!
+    
+    redirect_to users_path
+  rescue ActiveRecord::RecordInvalid
+    render :action => :new
+  end
+  
+  def show
+    @user = User.find(params[:id])
+  end
+end

data/test/rails/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/test/rails/app/helpers/users_helper.rb

@@ -0,0 +1,2 @@
+module UsersHelper
+end

data/test/rails/app/models/user.rb

@@ -0,0 +1,2 @@
+class User < ActiveRecord::Base
+end

data/test/rails/app/views/layouts/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html lang='en' xml:lang='en' xmlns='http://www.w3.org/1999/xhtml'>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <title>Demo Application</title>
+    <%= javascript_include_tag "http://ajax.googleapis.com/ajax/libs/jquery/1.2.6/jquery.min.js" %>
+    <%= javascript_include_tag 'jquery.livequery.min' %>
+    <%= presentation_stylesheets('grid', 'search', 'details', 'grid-color', 'search-color', 'details-color') %>
+    <%= presentation_javascript('search') %>
+  <head>
+  <body>
+    <%= yield %>
+  </body>
+</html>
+

data/test/rails/app/views/users/index.html.erb

@@ -0,0 +1,10 @@
+<%= present :field_search, :fields => [:first_name, :last_name, {:email => :checkbox}] %>
+<%= present @users, :grid, :id => "users",
+  :fields => [:prefix, :first_name, :last_name, :email],
+  :links => [link_to('add', new_user_path)],
+  :record_links => [
+    proc{|r| link_to 'edit', edit_user_path(r)},
+    proc{|r| link_to 'delete', user_path(r), :method => :destroy},
+    proc{|r| link_to 'show', user_path(r)}
+  ]
+%>

data/test/rails/app/views/users/new.html.erb

@@ -0,0 +1,2 @@
+<h2>New User</h2>
+<%= present @user, :form, :groups => [{"Name" => [:prefix, :first_name, :last_name]}, [:email]] %>

data/test/rails/app/views/users/show.html.erb

@@ -0,0 +1 @@
+<%= present @user, :details, :title => "User ##{@user.id}", :fields => [:prefix, :first_name, :last_name, :email] %>