Merge pull request #876 from opf/fix/error_message_accessibility_4087

[FIX] Error message accessibility 4087
pull/904/head
cratz 11 years ago
commit 1ecb3b620a
  1. 32
      app/assets/javascripts/activate_error_messages.js
  2. 16
      app/assets/javascripts/application.js.erb
  3. 2
      app/assets/stylesheets/content/_flash_messages.css.sass
  4. 35
      app/assets/stylesheets/global/_accessibility.css.sass
  5. 1
      app/assets/stylesheets/global/all.sass
  6. 2
      app/controllers/project_types_controller.rb
  7. 33
      app/helpers/application_helper.rb
  8. 38
      app/views/common/_validation_error.html.erb
  9. 2
      app/views/members/_member_form_impaired.html.erb
  10. 1
      app/views/members/_member_form_non_impaired.html.erb
  11. 1
      app/views/project_associations/_form.html.erb
  12. 2
      app/views/project_associations/edit.html.erb
  13. 2
      app/views/project_associations/new.html.erb
  14. 4
      app/views/project_types/_form.html.erb
  15. 2
      app/views/reportings/edit.html.erb
  16. 2
      app/views/reportings/new.html.erb
  17. 2
      app/views/work_packages/_relations.html.erb
  18. 4
      app/views/work_packages/index.html.erb
  19. 4
      config/locales/de.yml
  20. 3
      config/locales/en.yml
  21. 2
      features/project_types/project_types_administration.feature
  22. 20
      lib/plugins/dynamic_form/MIT-LICENSE
  23. 13
      lib/plugins/dynamic_form/README
  24. 10
      lib/plugins/dynamic_form/Rakefile
  25. 12
      lib/plugins/dynamic_form/dynamic_form.gemspec
  26. 1
      lib/plugins/dynamic_form/init.rb
  27. 300
      lib/plugins/dynamic_form/lib/action_view/helpers/dynamic_form.rb
  28. 36
      lib/plugins/dynamic_form/lib/action_view/locale/en.yml
  29. 5
      lib/plugins/dynamic_form/lib/dynamic_form.rb
  30. 42
      lib/plugins/dynamic_form/test/dynamic_form_i18n_test.rb
  31. 370
      lib/plugins/dynamic_form/test/dynamic_form_test.rb
  32. 9
      lib/plugins/dynamic_form/test/test_helper.rb

@ -0,0 +1,32 @@
//-- copyright
// OpenProject is a project management system.
// Copyright (C) 2012-2013 the OpenProject Foundation (OPF)
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License version 3.
//
// OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
// Copyright (C) 2006-2013 Jean-Philippe Lang
// Copyright (C) 2010-2013 the ChiliProject Team
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
// See doc/COPYRIGHT.rdoc for more details.
//++
jQuery(document).ajaxComplete(function() {
activateError();
});

@ -1263,6 +1263,22 @@ var I18nForms = (function ($) {
jQuery(document).ready(I18nForms.init); jQuery(document).ready(I18nForms.init);
var activateError = function() {
var errorHeader = jQuery('.errorExplanation h2[role="alert"]');
errorHeader.show();
}
var activateFlash = function() {
var flashMessage = jQuery('.flash');
flashMessage.hide();
flashMessage.show();
}
jQuery(document).ready(activateError);
jQuery(document).ready(activateFlash);
var SubmitConfirm = (function($) { var SubmitConfirm = (function($) {
var init; var init;

@ -43,6 +43,8 @@ div.flash.error a:hover, div.flash.warning a:hover, div.flash.notice a:hover, #e
font-size: 0.9em font-size: 0.9em
margin-left: 30px margin-left: 30px
h2, p h2, p
@include hidden_for_sighted
h2
display: none display: none
div.flash.error, #errorExplanation div.flash.error, #errorExplanation

@ -0,0 +1,35 @@
/*-- copyright
* OpenProject is a project management system.
* Copyright (C) 2012-2013 the OpenProject Foundation (OPF)
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License version 3.
*
* OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
* Copyright (C) 2006-2013 Jean-Philippe Lang
* Copyright (C) 2010-2013 the ChiliProject Team
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* See doc/COPYRIGHT.rdoc for more details. ++
*/
@mixin hidden_for_sighted
position: absolute
left: -10000px
top: auto
width: 1px
height: 1px
overflow: hidden

@ -26,5 +26,6 @@
* See doc/COPYRIGHT.rdoc for more details. ++ * See doc/COPYRIGHT.rdoc for more details. ++
*/ */
@import global/accessibility
@import global/variables @import global/variables
@import global/mixins @import global/mixins

@ -59,7 +59,6 @@ class ProjectTypesController < ApplicationController
flash[:notice] = l(:notice_successful_create) flash[:notice] = l(:notice_successful_create)
redirect_to project_types_path redirect_to project_types_path
else else
flash.now[:error] = l('timelines.project_type_could_not_be_saved')
render :action => 'new' render :action => 'new'
end end
end end
@ -84,7 +83,6 @@ class ProjectTypesController < ApplicationController
flash[:notice] = l(:notice_successful_update) flash[:notice] = l(:notice_successful_update)
redirect_to project_types_path redirect_to project_types_path
else else
flash.now[:error] = l('timelines.project_type_could_not_be_saved')
render :action => :edit render :action => :edit
end end
end end

@ -267,6 +267,37 @@ module ApplicationHelper
end end
end end
def error_messages_for(*params)
objects, options = extract_objects_from_params(params)
error_messages = objects.map{ |o| o.errors.full_messages }.flatten
unless error_messages.empty?
render partial: 'common/validation_error', locals: { error_messages: error_messages,
object_name: options[:object_name].to_s.gsub('_', '') }
end
end
# Taken from Dynamic Form
#
# lib/action_view/helpers/dynamic_form.rb:187-198
def extract_objects_from_params(params)
options = params.extract_options!.symbolize_keys
objects = Array.wrap(options.delete(:object) || params).map do |object|
object = instance_variable_get("@#{object}") unless object.respond_to?(:to_model)
object = convert_to_model(object)
if object.class.respond_to?(:model_name)
options[:object_name] ||= object.class.model_name.human.downcase
end
object
end
[objects.compact, options]
end
# Renders flash messages # Renders flash messages
def render_flash_messages def render_flash_messages
flash.map { |k,v| render_flash_message(k, v) }.join.html_safe flash.map { |k,v| render_flash_message(k, v) }.join.html_safe
@ -281,7 +312,7 @@ module ApplicationHelper
end end
def render_flash_message(type, message, html_options = {}) def render_flash_message(type, message, html_options = {})
html_options = {:class => "flash #{type} icon icon-#{type}"}.merge(html_options) html_options = { :class => "flash #{type} icon icon-#{type}", role: "alert" }.merge(html_options)
if User.current.impaired? if User.current.impaired?
content_tag('div', content_tag('a', join_flash_messages(message), :href => 'javascript:;'), html_options) content_tag('div', content_tag('a', join_flash_messages(message), :href => 'javascript:;'), html_options)
else else

@ -0,0 +1,38 @@
<%#-- copyright
OpenProject is a project management system.
Copyright (C) 2012-2013 the OpenProject Foundation (OPF)
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License version 3.
OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
Copyright (C) 2006-2013 Jean-Philippe Lang
Copyright (C) 2010-2013 the ChiliProject Team
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
See doc/COPYRIGHT.rdoc for more details.
++#%>
<div class="errorExplanation" id="errorExplanation">
<h2 role="alert"><%= l("activerecord.errors.template.header.#{(error_messages.count == 1) ? 'one' : 'other'}", count: error_messages.count, model: object_name) %></h2>
<p><%= l("errors.header_invalid_fields") %></p>
<ul>
<% error_messages.each do |message| %>
<li><%= message %></li>
<% end %>
</ul>
</div>

@ -32,7 +32,7 @@ See doc/COPYRIGHT.rdoc for more details.
:method => :post, :method => :post,
:remote => true, :remote => true,
:loading => '$(\'member-add-submit\').disable();', :loading => '$(\'member-add-submit\').disable();',
:complete => 'if($(\'member-add-submit\')) $(\'member-add-submit\').enable();', :complete => 'if($(\'member-add-submit\')) $(\'member-add-submit\').enable(); activateError();',
:html => {:id => "members_add_form"}) do |f| %> :html => {:id => "members_add_form"}) do |f| %>
<fieldset> <fieldset>
<legend><%=l(:label_member_new)%></legend> <legend><%=l(:label_member_new)%></legend>

@ -28,6 +28,7 @@ See doc/COPYRIGHT.rdoc for more details.
++#%> ++#%>
<%= javascript_include_tag "members_select_boxes.js" %> <%= javascript_include_tag "members_select_boxes.js" %>
<%= javascript_include_tag "activate_error_messages" %>
<%= form_for(:member, :url => {:controller => 'members', :action => 'create', :project_id => project}, <%= form_for(:member, :url => {:controller => 'members', :action => 'create', :project_id => project},
:remote => true, :remote => true,

@ -27,7 +27,6 @@ See doc/COPYRIGHT.rdoc for more details.
++#%> ++#%>
<%= f.error_messages %>
<label for="project_association_description"> <label for="project_association_description">
<%= ProjectAssociation.human_attribute_name(:description)%>: <%= ProjectAssociation.human_attribute_name(:description)%>:
</label> </label>

@ -42,6 +42,8 @@ See doc/COPYRIGHT.rdoc for more details.
<h2><%= title.tap { |t| html_title t } %></h2> <h2><%= title.tap { |t| html_title t } %></h2>
<%= error_messages_for 'project_association' %>
<%= render :partial => 'form', :locals => {:f => f, :project => @project} %> <%= render :partial => 'form', :locals => {:f => f, :project => @project} %>
<%= f.submit l(:button_update), :name => nil %> <%= f.submit l(:button_update), :name => nil %>

@ -47,6 +47,8 @@ See doc/COPYRIGHT.rdoc for more details.
:project_b => '?') %> :project_b => '?') %>
<h2><%= title.tap { |t| html_title t } %></h2> <h2><%= title.tap { |t| html_title t } %></h2>
<%= error_messages_for 'project_association' %>
<%= label_tag 'project_association_select_project_b_id', l('timelines.project_association_new_for_with', <%= label_tag 'project_association_select_project_b_id', l('timelines.project_association_new_for_with',
:project_a => h(@project.name)) %> :project_a => h(@project.name)) %>

@ -35,8 +35,6 @@ See doc/COPYRIGHT.rdoc for more details.
:project_type => ProjectType :project_type => ProjectType
%> %>
<%= error_messages_for 'project_type' %>
<h2> <h2>
<% if project_type.new_record? %> <% if project_type.new_record? %>
<% html_title l("timelines.new_project_type") %> <% html_title l("timelines.new_project_type") %>
@ -47,6 +45,8 @@ See doc/COPYRIGHT.rdoc for more details.
<% end %> <% end %>
</h2> </h2>
<%= error_messages_for 'project_type' %>
<div class="box"> <div class="box">
<p><%= f.text_field :name, :required => true %></p> <p><%= f.text_field :name, :required => true %></p>
<p><%= f.check_box :allows_association %></p> <p><%= f.check_box :allows_association %></p>

@ -48,7 +48,7 @@ See doc/COPYRIGHT.rdoc for more details.
:url => project_reporting_path(@project, @reporting), :url => project_reporting_path(@project, @reporting),
:html => {:method => 'put'} do |f| %> :html => {:method => 'put'} do |f| %>
<%= f.error_messages %> <%= error_messages_for 'project' %>
<fieldset class="timelines-reporting-properties"> <fieldset class="timelines-reporting-properties">
<legend><%= l('timelines.properties') %></legend> <legend><%= l('timelines.properties') %></legend>

@ -43,7 +43,7 @@ See doc/COPYRIGHT.rdoc for more details.
:url => project_reportings_path(@project), :url => project_reportings_path(@project),
:html => {:method => 'post'} do |f| %> :html => {:method => 'post'} do |f| %>
<%= f.error_messages %> <%= error_messages_for 'project' %>
<fieldset class="timelines-reporting-properties"> <fieldset class="timelines-reporting-properties">
<legend><%= l('timelines.properties') %></legend> <legend><%= l('timelines.properties') %></legend>

@ -27,6 +27,8 @@ See doc/COPYRIGHT.rdoc for more details.
++#%> ++#%>
<%= javascript_include_tag "activate_error_messages" %>
<p> <p>
<strong><%=l(:label_related_work_packages)%></strong> <strong><%=l(:label_related_work_packages)%></strong>
<% if authorize_for('work_package_relations', 'create') %> <% if authorize_for('work_package_relations', 'create') %>

@ -50,6 +50,8 @@ See doc/COPYRIGHT.rdoc for more details.
<%= render :partial => 'layouts/action_menu_specific' %> <%= render :partial => 'layouts/action_menu_specific' %>
<%= error_messages_for 'query' %>
<div class="title-bar"> <div class="title-bar">
<div class="title-bar-extras"> <div class="title-bar-extras">
@ -118,8 +120,6 @@ See doc/COPYRIGHT.rdoc for more details.
</div><!-- .title-bar-extras --> </div><!-- .title-bar-extras -->
</div><!-- .title-bar --> </div><!-- .title-bar -->
<%= error_messages_for 'query' %>
<% if query.valid? %> <% if query.valid? %>
<% if work_packages.empty? %> <% if work_packages.empty? %>
<p class="nodata"><%= l(:label_no_data) %></p> <p class="nodata"><%= l(:label_no_data) %></p>

@ -268,6 +268,10 @@ de:
wiki: "Wiki" wiki: "Wiki"
wiki_page: "Wiki-Seite" wiki_page: "Wiki-Seite"
workflow: "Workflow" workflow: "Workflow"
work_package: "Arbeitspaket"
errors:
header_invalid_fields: "Bei den folgenden Feldern traten Fehler auf:"
activity: activity:
created: "Erstellt: %{title}" created: "Erstellt: %{title}"

@ -267,6 +267,9 @@ en:
wiki_page: "Wiki page" wiki_page: "Wiki page"
workflow: "Workflow" workflow: "Workflow"
errors:
header_invalid_fields: "There were problems with the following fields:"
activity: activity:
created: "Created: %{title}" created: "Created: %{title}"
updated: "Updated: %{title}" updated: "Updated: %{title}"

@ -123,7 +123,6 @@ Feature:
And I follow "New project type" And I follow "New project type"
And I fill in "" for "Name" And I fill in "" for "Name"
And I press "Save" And I press "Save"
Then I should see an error flash stating "Project type could not be saved"
And I should see an error explanation stating "Name can't be blank" And I should see an error explanation stating "Name can't be blank"
When I fill in "Some other Project" for "Name" When I fill in "Some other Project" for "Name"
@ -137,7 +136,6 @@ Feature:
And I follow the edit link of the project type "Extraordinary Project" And I follow the edit link of the project type "Extraordinary Project"
And I fill in "" for "Name" And I fill in "" for "Name"
And I press "Save" And I press "Save"
Then I should see an error flash stating "Project type could not be saved"
Then I should see an error explanation stating "Name can't be blank" Then I should see an error explanation stating "Name can't be blank"
When I fill in "Super-Extraordinary Project" for "Name" When I fill in "Super-Extraordinary Project" for "Name"

@ -1,20 +0,0 @@
Copyright (c) 2010 David Heinemeier Hansson
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.

@ -1,13 +0,0 @@
DynamicForm
===========
DynamicForm holds a few helpers method to help you deal with your models, they are:
* input(record, method, options = {})
* form(record, options = {})
* error_message_on(object, method, options={})
* error_messages_for(record, options={})
It also adds f.error_messages and f.error_messages_on to your form builders.
Copyright (c) 2010 David Heinemeier Hansson, released under the MIT license

@ -1,10 +0,0 @@
require 'rake/testtask'
desc 'Default: run unit tests.'
task :default => :test
desc 'Test the active_model_helper plugin.'
Rake::TestTask.new(:test) do |t|
t.libs << 'test'
t.pattern = 'test/**/*_test.rb'
end

@ -1,12 +0,0 @@
Gem::Specification.new do |s|
s.name = 'dynamic_form'
s.version = '1.0.0'
s.author = 'David Heinemeier Hansson'
s.email = 'david@loudthinking.com'
s.summary = 'Deprecated dynamic form helpers: input, form, error_messages_for, error_messages_on'
s.add_dependency('rails', '>= 3.0.0')
s.files = Dir['lib/**/*']
s.require_path = 'lib'
end

@ -1 +0,0 @@
require 'dynamic_form'

@ -1,300 +0,0 @@
require 'action_view/helpers'
require 'active_support/i18n'
require 'active_support/core_ext/enumerable'
require 'active_support/core_ext/object/blank'
module ActionView
module Helpers
# The Active Record Helper makes it easier to create forms for records kept in instance variables. The most far-reaching is the +form+
# method that creates a complete form for all the basic content types of the record (not associations or aggregations, though). This
# is a great way of making the record quickly available for editing, but likely to prove lackluster for a complicated real-world form.
# In that case, it's better to use the +input+ method and the specialized +form+ methods in link:classes/ActionView/Helpers/FormHelper.html
module DynamicForm
# Returns a default input tag for the type of object returned by the method. For example, if <tt>@post</tt>
# has an attribute +title+ mapped to a +VARCHAR+ column that holds "Hello World":
#
# input("post", "title")
# # => <input id="post_title" name="post[title]" size="30" type="text" value="Hello World" />
def input(record_name, method, options = {})
InstanceTag.new(record_name, method, self).to_tag(options)
end
# Returns an entire form with all needed input tags for a specified Active Record object. For example, if <tt>@post</tt>
# has attributes named +title+ of type +VARCHAR+ and +body+ of type +TEXT+ then
#
# form("post")
#
# would yield a form like the following (modulus formatting):
#
# <form action='/posts/create' method='post'>
# <p>
# <label for="post_title">Title</label><br />
# <input id="post_title" name="post[title]" size="30" type="text" value="Hello World" />
# </p>
# <p>
# <label for="post_body">Body</label><br />
# <textarea cols="40" id="post_body" name="post[body]" rows="20"></textarea>
# </p>
# <input name="commit" type="submit" value="Create" />
# </form>
#
# It's possible to specialize the form builder by using a different action name and by supplying another
# block renderer. For example, if <tt>@entry</tt> has an attribute +message+ of type +VARCHAR+ then
#
# form("entry",
# :action => "sign",
# :input_block => Proc.new { |record, column|
# "#{column.human_name}: #{input(record, column.name)}<br />"
# })
#
# would yield a form like the following (modulus formatting):
#
# <form action="/entries/sign" method="post">
# Message:
# <input id="entry_message" name="entry[message]" size="30" type="text" /><br />
# <input name="commit" type="submit" value="Sign" />
# </form>
#
# It's also possible to add additional content to the form by giving it a block, such as:
#
# form("entry", :action => "sign") do |form|
# form << content_tag("b", "Department")
# form << collection_select("department", "id", @departments, "id", "name")
# end
#
# The following options are available:
#
# * <tt>:action</tt> - The action used when submitting the form (default: +create+ if a new record, otherwise +update+).
# * <tt>:input_block</tt> - Specialize the output using a different block, see above.
# * <tt>:method</tt> - The method used when submitting the form (default: +post+).
# * <tt>:multipart</tt> - Whether to change the enctype of the form to "multipart/form-data", used when uploading a file (default: +false+).
# * <tt>:submit_value</tt> - The text of the submit button (default: "Create" if a new record, otherwise "Update").
def form(record_name, options = {})
record = instance_variable_get("@#{record_name}")
record = convert_to_model(record)
options = options.symbolize_keys
options[:action] ||= record.persisted? ? "update" : "create"
action = url_for(:action => options[:action], :id => record)
submit_value = options[:submit_value] || options[:action].gsub(/[^\w]/, '').capitalize
contents = form_tag({:action => action}, :method =>(options[:method] || 'post'), :enctype => options[:multipart] ? 'multipart/form-data': nil)
contents.safe_concat hidden_field(record_name, :id) if record.persisted?
contents.safe_concat all_input_tags(record, record_name, options)
yield contents if block_given?
contents.safe_concat submit_tag(submit_value)
contents.safe_concat('</form>')
end
# Returns a string containing the error message attached to the +method+ on the +object+ if one exists.
# This error message is wrapped in a <tt>DIV</tt> tag by default or with <tt>:html_tag</tt> if specified,
# which can be extended to include a <tt>:prepend_text</tt> and/or <tt>:append_text</tt> (to properly explain
# the error), and a <tt>:css_class</tt> to style it accordingly. +object+ should either be the name of an
# instance variable or the actual object. The method can be passed in either as a string or a symbol.
# As an example, let's say you have a model <tt>@post</tt> that has an error message on the +title+ attribute:
#
# <%= error_message_on "post", "title" %>
# # => <div class="formError">can't be empty</div>
#
# <%= error_message_on @post, :title %>
# # => <div class="formError">can't be empty</div>
#
# <%= error_message_on "post", "title",
# :prepend_text => "Title simply ",
# :append_text => " (or it won't work).",
# :html_tag => "span",
# :css_class => "inputError" %>
# # => <span class="inputError">Title simply can't be empty (or it won't work).</span>
def error_message_on(object, method, *args)
options = args.extract_options!
unless args.empty?
ActiveSupport::Deprecation.warn('error_message_on takes an option hash instead of separate ' +
'prepend_text, append_text, html_tag, and css_class arguments', caller)
options[:prepend_text] = args[0] || ''
options[:append_text] = args[1] || ''
options[:html_tag] = args[2] || 'div'
options[:css_class] = args[3] || 'formError'
end
options.reverse_merge!(:prepend_text => '', :append_text => '', :html_tag => 'div', :css_class => 'formError')
object = convert_to_model(object)
if (obj = (object.respond_to?(:errors) ? object : instance_variable_get("@#{object}"))) &&
(errors = obj.errors[method]).presence
content_tag(options[:html_tag],
(options[:prepend_text].html_safe << errors.first).safe_concat(options[:append_text]),
:class => options[:css_class]
)
else
''
end
end
# Returns a string with a <tt>DIV</tt> containing all of the error messages for the objects located as instance variables by the names
# given. If more than one object is specified, the errors for the objects are displayed in the order that the object names are
# provided.
#
# This <tt>DIV</tt> can be tailored by the following options:
#
# * <tt>:header_tag</tt> - Used for the header of the error div (default: "h2").
# * <tt>:id</tt> - The id of the error div (default: "errorExplanation").
# * <tt>:class</tt> - The class of the error div (default: "errorExplanation").
# * <tt>:object</tt> - The object (or array of objects) for which to display errors,
# if you need to escape the instance variable convention.
# * <tt>:object_name</tt> - The object name to use in the header, or any text that you prefer.
# If <tt>:object_name</tt> is not set, the name of the first object will be used.
# * <tt>:header_message</tt> - The message in the header of the error div. Pass +nil+
# or an empty string to avoid the header message altogether. (Default: "X errors
# prohibited this object from being saved").
# * <tt>:message</tt> - The explanation message after the header message and before
# the error list. Pass +nil+ or an empty string to avoid the explanation message
# altogether. (Default: "There were problems with the following fields:").
#
# To specify the display for one object, you simply provide its name as a parameter.
# For example, for the <tt>@user</tt> model:
#
# error_messages_for 'user'
#
# You can also supply an object:
#
# error_messages_for @user
#
# This will use the last part of the model name in the presentation. For instance, if
# this is a MyKlass::User object, this will use "user" as the name in the String. This
# is taken from MyKlass::User.model_name.human, which can be overridden.
#
# To specify more than one object, you simply list them; optionally, you can add an extra <tt>:object_name</tt> parameter, which
# will be the name used in the header message:
#
# error_messages_for 'user_common', 'user', :object_name => 'user'
#
# You can also use a number of objects, which will have the same naming semantics
# as a single object.
#
# error_messages_for @user, @post
#
# If the objects cannot be located as instance variables, you can add an extra <tt>:object</tt> parameter which gives the actual
# object (or array of objects to use):
#
# error_messages_for 'user', :object => @question.user
#
# NOTE: This is a pre-packaged presentation of the errors with embedded strings and a certain HTML structure. If what
# you need is significantly different from the default presentation, it makes plenty of sense to access the <tt>object.errors</tt>
# instance yourself and set it up. View the source of this method to see how easy it is.
def error_messages_for(*params)
options = params.extract_options!.symbolize_keys
objects = Array.wrap(options.delete(:object) || params).map do |object|
object = instance_variable_get("@#{object}") unless object.respond_to?(:to_model)
object = convert_to_model(object)
if object.class.respond_to?(:model_name)
options[:object_name] ||= object.class.model_name.human.downcase
end
object
end
objects.compact!
count = objects.inject(0) {|sum, object| sum + object.errors.count }
unless count.zero?
html = {}
[:id, :class].each do |key|
if options.include?(key)
value = options[key]
html[key] = value unless value.blank?
else
html[key] = 'errorExplanation'
end
end
options[:object_name] ||= params.first
I18n.with_options :locale => options[:locale], :scope => [:errors, :template] do |locale|
header_message = if options.include?(:header_message)
options[:header_message]
else
locale.t :header, :count => count, :model => options[:object_name].to_s.gsub('_', ' ')
end
message = options.include?(:message) ? options[:message] : locale.t(:body)
error_messages = objects.sum do |object|
object.errors.full_messages.map do |msg|
content_tag(:li, msg)
end
end.join.html_safe
contents = ''
contents << content_tag(options[:header_tag] || :h2, header_message) unless header_message.blank?
contents << content_tag(:p, message) unless message.blank?
contents << content_tag(:ul, error_messages)
content_tag(:div, contents.html_safe, html)
end
else
''
end
end
private
def all_input_tags(record, record_name, options)
input_block = options[:input_block] || default_input_block
record.class.content_columns.collect{ |column| input_block.call(record_name, column) }.join("\n")
end
def default_input_block
Proc.new { |record, column| %(<p><label for="#{record}_#{column.name}">#{column.human_name}</label><br />#{input(record, column.name)}</p>) }
end
module InstanceTagMethods
def to_tag(options = {})
case column_type
when :string
field_type = @method_name.include?("password") ? "password" : "text"
to_input_field_tag(field_type, options)
when :text
to_text_area_tag(options)
when :integer, :float, :decimal
to_input_field_tag("text", options)
when :date
to_date_select_tag(options)
when :datetime, :timestamp
to_datetime_select_tag(options)
when :time
to_time_select_tag(options)
when :boolean
to_boolean_select_tag(options)
end
end
def column_type
object.send(:column_for_attribute, @method_name).type
end
end
module FormBuilderMethods
def error_message_on(method, *args)
@template.error_message_on(@object || @object_name, method, *args)
end
def error_messages(options = {})
@template.error_messages_for(@object_name, objectify_options(options))
end
end
end
class InstanceTag
include DynamicForm::InstanceTagMethods
end
class FormBuilder
include DynamicForm::FormBuilderMethods
end
end
end
I18n.load_path << File.expand_path("../../locale/en.yml", __FILE__)

@ -1,36 +0,0 @@
#-- copyright
# OpenProject is a project management system.
# Copyright (C) 2012-2013 the OpenProject Foundation (OPF)
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License version 3.
#
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
# Copyright (C) 2006-2013 Jean-Philippe Lang
# Copyright (C) 2010-2013 the ChiliProject Team
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
# See doc/COPYRIGHT.rdoc for more details.
#++
en:
errors:
template:
header:
one: "1 error prohibited this %{model} from being saved"
other: "%{count} errors prohibited this %{model} from being saved"
# The variable :count is also available
body: "There were problems with the following fields:"

@ -1,5 +0,0 @@
require 'action_view/helpers/dynamic_form'
class ActionView::Base
include DynamicForm
end

@ -1,42 +0,0 @@
require 'test_helper'
class DynamicFormI18nTest < Test::Unit::TestCase
include ActionView::Context
include ActionView::Helpers::DynamicForm
attr_reader :request
def setup
@object = stub :errors => stub(:count => 1, :full_messages => ['full_messages'])
@object.stub :to_model => @object
@object.stub :class => stub(:model_name => stub(:human => ""))
@object_name = 'book_seller'
@object_name_without_underscore = 'book seller'
stub(:content_tag).and_return 'content_tag'
I18n.stub(:t).with(:'header', :locale => 'en', :scope => [:errors, :template], :count => 1, :model => '').and_return "1 error prohibited this from being saved"
I18n.stub(:t).with(:'body', :locale => 'en', :scope => [:errors, :template]).and_return 'There were problems with the following fields:'
end
def test_error_messages_for_given_a_header_option_it_does_not_translate_header_message
I18n.should_receive(:t).with(:'header', :locale => 'en', :scope => [:errors, :template], :count => 1, :model => '').never
error_messages_for(:object => @object, :header_message => 'header message', :locale => 'en')
end
def test_error_messages_for_given_no_header_option_it_translates_header_message
I18n.should_receive(:t).with(:'header', :locale => 'en', :scope => [:errors, :template], :count => 1, :model => '').and_return 'header message'
error_messages_for(:object => @object, :locale => 'en')
end
def test_error_messages_for_given_a_message_option_it_does_not_translate_message
I18n.should_receive(:t).with(:'body', :locale => 'en', :scope => [:errors, :template]).never
error_messages_for(:object => @object, :message => 'message', :locale => 'en')
end
def test_error_messages_for_given_no_message_option_it_translates_message
I18n.should_receive(:t).with(:'body', :locale => 'en', :scope => [:errors, :template]).and_return 'There were problems with the following fields:'
error_messages_for(:object => @object, :locale => 'en')
end
end

File diff suppressed because one or more lines are too long

@ -1,9 +0,0 @@
require 'rubygems'
require 'test/unit'
require 'active_support'
require 'active_support/core_ext'
require 'action_view'
require 'action_controller'
require 'action_controller/test_case'
require 'active_model'
require 'action_view/helpers/dynamic_form'
Loading…
Cancel
Save