aboutsummaryrefslogtreecommitdiffstats
path: root/app/helpers/date_time_helper.rb
diff options
context:
space:
mode:
authorGareth Rees <gareth@mysociety.org>2014-06-03 11:35:55 +0100
committerGareth Rees <gareth@mysociety.org>2014-06-05 10:56:04 +0100
commit77ce9b795c62d8241b22878cf60ca688fa4b44a1 (patch)
tree88fced6ead005e58e9ea089da34f1cce328d0cff /app/helpers/date_time_helper.rb
parent6bd0bfe7599aee4e55bdd63196d1e2c5cc80129c (diff)
Move date helpers to DateTimeHelper
Diffstat (limited to 'app/helpers/date_time_helper.rb')
-rw-r--r--app/helpers/date_time_helper.rb63
1 files changed, 63 insertions, 0 deletions
diff --git a/app/helpers/date_time_helper.rb b/app/helpers/date_time_helper.rb
new file mode 100644
index 000000000..831006e29
--- /dev/null
+++ b/app/helpers/date_time_helper.rb
@@ -0,0 +1,63 @@
+module DateTimeHelper
+ # 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"
+ I18n.l(date, :format => date_format)
+ end
+
+ def simple_time(date)
+ return date.strftime("%H:%M:%S").strip
+ end
+
+ def year_from_date(date)
+ return date.strftime("%Y").strip
+ end
+end