From 27128cd0d9a4ae69c8f2cfadd52e0ab078acffec Mon Sep 17 00:00:00 2001
From: Gareth Rees <gareth@mysociety.org>
Date: Mon, 10 Mar 2014 17:46:39 +0000
Subject: Add formatting options to LinkToHelper#simple_date

---
 app/helpers/link_to_helper.rb | 51 ++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 48 insertions(+), 3 deletions(-)

(limited to 'app/helpers/link_to_helper.rb')

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)
-- 
cgit v1.2.3