Merge branch 'issues/1358' into rails-3-develop

7 files changed, 92 insertions, 11 deletions

diff --git a/app/controllers/request_controller.rb b/app/controllers/request_controller.rb
index a94461758..6445dd685 100644
--- a/app/controllers/request_controller.rb
+++ b/app/controllers/request_controller.rb
@@ -447,9 +447,9 @@ class RequestController < ApplicationController
         flash[:notice] = case info_request.calculate_status
         when 'waiting_response'
             _("<p>Thank you! Hopefully your wait isn't too long.</p> <p>By law, you should get a response promptly, and normally before the end of <strong>
-{{date_response_required_by}}</strong>.</p>",:date_response_required_by=>simple_date(info_request.date_response_required_by))
+{{date_response_required_by}}</strong>.</p>",:date_response_required_by=>view_context.simple_date(info_request.date_response_required_by))
         when 'waiting_response_overdue'
-            _("<p>Thank you! Hope you don't have to wait much longer.</p> <p>By law, you should have got a response promptly, and normally before the end of <strong>{{date_response_required_by}}</strong>.</p>",:date_response_required_by=>simple_date(info_request.date_response_required_by))
+            _("<p>Thank you! Hope you don't have to wait much longer.</p> <p>By law, you should have got a response promptly, and normally before the end of <strong>{{date_response_required_by}}</strong>.</p>",:date_response_required_by=>view_context.simple_date(info_request.date_response_required_by))
         when 'waiting_response_very_overdue'
             _("<p>Thank you! Your request is long overdue, by more than {{very_late_number_of_days}} working days. Most requests should be answered within {{late_number_of_days}} working days. You might like to complain about this, see below.</p>", :very_late_number_of_days => AlaveteliConfiguration::reply_very_late_after_days, :late_number_of_days => AlaveteliConfiguration::reply_late_after_days)
         when 'not_held'
diff --git a/app/helpers/link_to_helper.rb b/app/helpers/link_to_helper.rb
index 405886a85..bf70f9140 100755
--- a/app/helpers/link_to_helper.rb
+++ b/app/helpers/link_to_helper.rb
@@ -279,13 +279,58 @@ module LinkToHelper
         end
     end
 
-    # Basic date format
-    def simple_date(date)
+    # Public: Usually-correct format for a DateTime-ish object
+    # To define a new new format define the `simple_date_{FORMAT}` method
+    #
+    # date - a DateTime, Date or Time
+    # opts - a Hash of options (default: { format: :html})
+    #        :format - :html returns a HTML <time> tag
+    #                  :text returns a plain String
+    #
+    # Examples
+    #
+    #   simple_date(Time.now)
+    #   # => "<time>..."
+    #
+    #   simple_date(Time.now, :format => :text)
+    #   # => "March 10, 2014"
+    #
+    # Returns a String
+    # Raises ArgumentError if the format is unrecognized
+    def simple_date(date, opts = {})
+        opts = { :format => :html }.merge(opts)
+        date_formatter = "simple_date_#{ opts[:format] }"
+
+        if respond_to?(date_formatter)
+            send(date_formatter, date)
+        else
+            raise ArgumentError, "Unrecognised format :#{ opts[:format] }"
+        end
+    end
+
+    # Usually-correct HTML formatting of a DateTime-ish object
+    # Use LinkToHelper#simple_date with desired formatting options
+    #
+    # date - a DateTime, Date or Time
+    #
+    # Returns a String
+    def simple_date_html(date)
+        date = date.in_time_zone unless date.is_a? Date
+        time_tag date, simple_date_text(date), :title => date.to_s
+    end
+
+    # Usually-correct plain text formatting of a DateTime-ish object
+    # Use LinkToHelper#simple_date with desired formatting options
+    #
+    # date - a DateTime, Date or Time
+    #
+    # Returns a String
+    def simple_date_text(date)
         date = date.in_time_zone.to_date unless date.is_a? Date
 
         date_format = _("simple_date_format")
         date_format = :long if date_format == "simple_date_format"
-        return I18n.l(date, :format => date_format)
+        I18n.l(date, :format => date_format)
     end
 
     def simple_time(date)
diff --git a/app/views/comment/_single_comment.text.erb b/app/views/comment/_single_comment.text.erb
index 925e8b688..4932a7e4a 100644
--- a/app/views/comment/_single_comment.text.erb
+++ b/app/views/comment/_single_comment.text.erb
@@ -1,2 +1,2 @@
-<%= _("{{username}} left an annotation:", :username =>comment.user.name) %> (<%= simple_date(comment.created_at || Time.now) %>)
+<%= _("{{username}} left an annotation:", :username =>comment.user.name) %> (<%= simple_date((comment.created_at || Time.now), :format => :text) %>)
 <%= comment.body.strip %>
diff --git a/app/views/request/_outgoing_correspondence.text.erb b/app/views/request/_outgoing_correspondence.text.erb
index 5375ef81b..221e359e2 100644
--- a/app/views/request/_outgoing_correspondence.text.erb
+++ b/app/views/request/_outgoing_correspondence.text.erb
@@ -3,6 +3,6 @@
 <%- else %>
   <%= _('From:') %> <% if @info_request.user_name %><%= @info_request.user_name %><% else %><%= "[#{_('An anonymous user')}]"%><% end %>
   <%= _('To:') %> <%= @info_request.public_body.name %>
-  <%= _('Date:') %> <%= simple_date(info_request_event.created_at) %>
+  <%= _('Date:') %> <%= simple_date(info_request_event.created_at, :format => :text) %>
   <%= outgoing_message.get_body_for_text_display %>
 <%- end %>
diff --git a/app/views/request/_resent_outgoing_correspondence.text.erb b/app/views/request/_resent_outgoing_correspondence.text.erb
index d645e9488..d39f8395b 100644
--- a/app/views/request/_resent_outgoing_correspondence.text.erb
+++ b/app/views/request/_resent_outgoing_correspondence.text.erb
@@ -1,2 +1,2 @@
-<%= _('Date:') %> <%= simple_date(info_request_event.created_at) %>
+<%= _('Date:') %> <%= simple_date(info_request_event.created_at, :format => :text) %>
 Sent <% if outgoing_message.message_type == 'initial_request' %> request <% elsif outgoing_message.message_type == 'followup' %> a follow up <% else %> <% raise "unknown message_type" %><% end %> to <%= public_body_link(@info_request.public_body) %> again<% if not info_request_event.same_email_as_previous_send? %>, using a new contact address<% end %>.
diff --git a/app/views/track_mailer/event_digest.text.erb b/app/views/track_mailer/event_digest.text.erb
index 8dbc7fe06..b83c184f0 100644
--- a/app/views/track_mailer/event_digest.text.erb
+++ b/app/views/track_mailer/event_digest.text.erb
@@ -32,7 +32,7 @@
                 else
                     raise "unknown type in event_digest " + event.event_type
                 end
-                main_text += " (" + simple_date(event.created_at) + ")\n"
+                main_text += " (" + simple_date(event.created_at, :format => :text) + ")\n"
 
                 # Main text, wrapped, words highlighted with * and indented.
                 if event.is_outgoing_message?
diff --git a/spec/helpers/link_to_helper_spec.rb b/spec/helpers/link_to_helper_spec.rb
index 2259db6c2..4a01ec683 100644
--- a/spec/helpers/link_to_helper_spec.rb
+++ b/spec/helpers/link_to_helper_spec.rb
@@ -70,14 +70,50 @@ describe LinkToHelper do
     end
 
     describe 'simple_date' do
+
+        it 'formats a date in html by default' do
+            time = Time.utc(2012, 11, 07, 21, 30, 26)
+            self.should_receive(:simple_date_html).with(time)
+            simple_date(time)
+        end
+
+        it 'formats a date in the specified format' do
+            time = Time.utc(2012, 11, 07, 21, 30, 26)
+            self.should_receive(:simple_date_text).with(time)
+            simple_date(time, :format => :text)
+        end
+
+        it 'raises an argument error if given an unrecognized format' do
+            time = Time.utc(2012, 11, 07, 21, 30, 26)
+            expect { simple_date(time, :format => :unknown) }.to raise_error(ArgumentError)
+        end
+
+    end
+
+    describe 'simple_date_html' do
+
+        it 'formats a date in a time tag' do
+            Time.use_zone('London') do
+                time = Time.utc(2012, 11, 07, 21, 30, 26)
+                expected = "<time datetime=\"2012-11-07T21:30:26+00:00\" title=\"2012-11-07 21:30:26 +0000\">November 07, 2012</time>"
+                simple_date_html(time).should == expected
+            end
+        end
+
+    end
+
+    describe 'simple_date_text' do
+
         it 'should respect time zones' do
             Time.use_zone('Australia/Sydney') do
-                simple_date(Time.utc(2012, 11, 07, 21, 30, 26)).should == 'November 08, 2012'
+                simple_date_text(Time.utc(2012, 11, 07, 21, 30, 26)).should == 'November 08, 2012'
             end
         end
 
         it 'should handle Date objects' do
-            simple_date(Date.new(2012, 11, 21)).should == 'November 21, 2012'
+            simple_date_text(Date.new(2012, 11, 21)).should == 'November 21, 2012'
         end
+
     end
+
 end