local_time 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0bfe22e485d89d3b8b8ef64db29d82d4d4f518c
-  data.tar.gz: 7d662d650e07542e16b13b98315ce589992bf397
+  metadata.gz: 84f0f9773b1e9bfac34c2e579af56d6c784a8d23
+  data.tar.gz: a1606c79f356e6e09b67f5b2adca382e38366a9f
 SHA512:
-  metadata.gz: 840814649a2e4c03f7b8b9592ff696c7d5b7516a088a270fe2bdb4fb96e1a29221d455c31bbc31fdaa2a2dc0a38fe3718144c4c2dfe8ced9cbbc1d7ee76f425b
-  data.tar.gz: 2ed6f4bd924c469c23fd1134a53e4818ac1f5de1fd9cf9060859726bb47429176a8e5421f07c48d18303502c288ea38ccf74fff70ce55134f2e6b8fc110d23a4
+  metadata.gz: 88db2bd3c1a77268ef0e8a59a18c81bed59c9f3b837bd3f9d2e555862228ded216dc7a2cf8e2d19a1c06fc262ada3ca319e4b2538eeae3ea826c3ecbe65c113f
+  data.tar.gz: 71e7a980c10839bc5e81dda212a9a99f1dd9a5ec68cbd3a082e754126de0dfccad334e3efc28bb01a1c416b71c31bc7bdece4a9c848a2de60e7d771513de9121

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2013 Javan Makhmali
+Copyright 2014 Javan Makhmali
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -4,13 +4,11 @@ Local Time is a Rails engine with helpers and JavaScript for displaying times an
 
 ####Example
 
-Assuming the time zone is EST and `Time.now` is `2013-11-27 18:43:22 -0500`:
-
 ```erb
-<%= local_time(Time.now) # index.html.erb %>
+<%= local_time(comment.created_at) # comment.created_at => Wed, 27 Nov 2013 18:43:22 EST -0500 %>
 ```
 
-Renders in UTC time:
+Renders:
 
 ```html
 <time data-format="%B %e, %Y %l:%M%P"
@@ -18,7 +16,7 @@ Renders in UTC time:
       datetime="2013-11-27T23:43:22Z">November 27, 2013 11:43pm</time>
 ```
 
-Then immediately converts to local time and strftime formats with JavaScript:
+When the DOM loads, the content is immediately replaced with a local, formatted time:
 
 ```html
 <time data-format="%B %e, %Y %l:%M%P"
@@ -39,6 +37,13 @@ Alias for local_time with a month-formatted default
 <%= local_date(time, format: '%B %e, %Y') %>
 ```
 
+To use a strftime format already defined in your app, pass a symbol as the format.
+```erb
+<%= local_time(date, format: :long) %>
+```
+
+`I18n.t("time.formats.#{format}")`, `I18n.t("date.formats.#{format}")`, `Time::DATE_FORMATS[format]`, and `Date::DATE_FORMATS[format]` will be scanned (in that order) for your format.
+
 Note: The included strftime JavaScript implementation is not 100% complete. It supports the following directives: `%a %A %b %B %c %d %e %H %I %l %m %M %p %P %S %w %y %Y`
 
 #### Time ago helper
@@ -65,8 +70,30 @@ Displays the relative amount of time passed. With age, the descriptions transiti
 
 The included JavaScript does not depend on any frameworks or libraries, and listens for a `DOMContentLoaded` event to run initially. It also listens on `document` for `page:update` if you're using Turbolinks and `ajaxSuccess` if you're using jQuery. This should catch most cases where new `<time>` elements have been added to the DOM and process them automatically. If you're adding new elements in another context, trigger `time:elapse` to process them.
 
+#### JavaScript API
+
+`strftime` and `relativeTimeAgo` are available via the global `LocalTime` object.
+
+```js
+> LocalTime.strftime(new Date, "%B %e, %Y %l:%M%P")
+"February 9, 2014 12:55pm"
+
+> LocalTime.relativeTimeAgo(new Date(new Date - 60 * 1000 * 5))
+"5 minutes ago"
+```
+
 #### Version History
 
+**0.3.0** (February 9, 2014)
+
+* Allow :format option lookup in I18n or DATE_FORMATS hashes [Paul Dobbins]
+* Expose public API to JavaScript helpers
+
+**0.2.0** (December 10, 2013)
+
+* Prefer `textContent` over `innerText` for Firefox compatibility
+* Added `options` argument to `local_time_ago` helper
+
 **0.1.0** (November 29, 2013)
 
 * Initial release.

data/app/assets/javascripts/local_time.js.coffee

@@ -83,9 +83,6 @@ class CalendarDate
 
 
 class RelativeTimeAgo
-  @generate: (date) ->
-    new this(date).toString()
-
   constructor: (@date) ->
     @calendarDate = CalendarDate.fromDate @date
 
@@ -146,6 +143,8 @@ class RelativeTimeAgo
   formatTime: ->
     strftime @date, '%l:%M%P'
 
+relativeTimeAgo = (date) ->
+  new RelativeTimeAgo(date).toString()
 
 domLoaded = false
 
@@ -171,6 +170,7 @@ process = (selector, callback) ->
 
 document.addEventListener "DOMContentLoaded", ->
   domLoaded = true
+  textProperty = if "textContent" of document.body then "textContent" else "innerText"
 
   process "time[data-local]:not([data-localized])", (element) ->
     datetime = element.getAttribute "datetime"
@@ -180,16 +180,19 @@ document.addEventListener "DOMContentLoaded", ->
     time = new Date Date.parse datetime
     return if isNaN time
 
-    element.innerText =
+    element[textProperty] =
       switch local
         when "time"
           element.setAttribute "data-localized", true
           strftime time, format
         when "time-ago"
-          RelativeTimeAgo.generate time
+          relativeTimeAgo time
 
   setInterval ->
     event = document.createEvent "Events"
     event.initEvent "time:elapse", true, true
     document.dispatchEvent event
   , 60 * 1000
+
+# Public API
+@LocalTime = {strftime, relativeTimeAgo}

data/app/helpers/local_time_helper.rb

@@ -1,7 +1,9 @@
 module LocalTimeHelper
+  DEFAULT_FORMAT = '%B %e, %Y %l:%M%P'
+
   def local_time(time, options = {})
     time   = utc_time(time)
-    format = options.delete(:format).presence || '%B %e, %Y %l:%M%P'
+    format = time_format(options.delete(:format))
 
     options[:data] ||= {}
     options[:data].merge! local: :time, format: format
@@ -14,9 +16,13 @@ module LocalTimeHelper
     local_time time, options
   end
 
-  def local_time_ago(time)
+  def local_time_ago(time, options = {})
     time = utc_time(time)
-    time_tag time, time.strftime('%B %e, %Y %l:%M%P'), data: { local: 'time-ago' }
+
+    options[:data] ||= {}
+    options[:data].merge! local: 'time-ago'
+
+    time_tag time, time.strftime(DEFAULT_FORMAT), options
   end
 
   def utc_time(time_or_date)
@@ -26,4 +32,19 @@ module LocalTimeHelper
       time_or_date.to_time.utc
     end
   end
+
+  private
+    def time_format(format)
+      if format.is_a?(Symbol)
+        if (i18n_format = I18n.t("time.formats.#{format}", default: [:"date.formats.#{format}", ''])).present?
+          i18n_format
+        elsif (date_format = Time::DATE_FORMATS[format] || Date::DATE_FORMATS[format])
+          date_format.is_a?(Proc) ? DEFAULT_FORMAT : date_format
+        else
+          DEFAULT_FORMAT
+        end
+      else
+        format.presence || DEFAULT_FORMAT
+      end
+    end
 end

data/test/helpers/local_time_helper_test.rb

@@ -3,14 +3,20 @@ require 'active_support/all'
 require 'action_view'
 require 'minitest/autorun'
 
+I18n.enforce_available_locales = false
 
-class LocalTimeHelperTest < Minitest::Test
+class LocalTimeHelperTest < MiniTest::Unit::TestCase
   include ActionView::Helpers::DateHelper, ActionView::Helpers::TagHelper
   include LocalTimeHelper
 
   def setup
     @original_zone = Time.zone
     Time.zone = ActiveSupport::TimeZone["Central Time (US & Canada)"]
+    I18n.backend.store_translations(:en, {
+      time: { formats: { simple_time: "%b %e" } },
+      date: { formats: { simple_date: "%b %e" } } })
+    Time::DATE_FORMATS[:time_formats_simple_time] = '%b %e'
+    Date::DATE_FORMATS[:date_formats_simple_date] = '%b %e'
 
     @date = "2013-11-21"
     @time = Time.zone.parse(@date)
@@ -45,6 +51,27 @@ class LocalTimeHelperTest < Minitest::Test
     assert_equal expected, local_time(@time, format: '%b %e')
   end
 
+  def test_local_time_with_i18n_format
+    expected = %Q(<time data-format="%b %e" data-local="time" datetime="#{@time_js}">Nov 21</time>)
+    assert_equal expected, local_time(@time, format: :simple_time)
+  end
+
+  def test_local_time_with_date_formats_format
+    expected = %Q(<time data-format="%b %e" data-local="time" datetime="#{@time_js}">Nov 21</time>)
+    assert_equal expected, local_time(@time, format: :time_formats_simple_time)
+  end
+
+  def test_local_time_with_missing_i18n_and_date_formats_format
+    expected = %Q(<time data-format="%B %e, %Y %l:%M%P" data-local="time" datetime="#{@time_js}">November 21, 2013  6:00am</time>)
+    assert_equal expected, local_time(@time, format: :missing_format)
+  end
+
+  def test_local_time_with_date_formats_proc_format
+    Time::DATE_FORMATS[:proc] = proc { |time| "nope" }
+    expected = %Q(<time data-format="%B %e, %Y %l:%M%P" data-local="time" datetime="#{@time_js}">November 21, 2013  6:00am</time>)
+    assert_equal expected, local_time(@time, format: :proc)
+  end
+
   def test_local_time_with_options
     expected = %Q(<time data-format="%b %e" data-local="time" datetime="#{@time_js}" style="display:none">Nov 21</time>)
     assert_equal expected, local_time(@time, format: '%b %e', style: 'display:none')
@@ -58,11 +85,31 @@ class LocalTimeHelperTest < Minitest::Test
 
   def test_local_date_with_format
     expected = %Q(<time data-format="%b %e" data-local="time" datetime="#{@time_js}">Nov 21</time>)
-    assert_equal expected, local_date(@time, format: '%b %e')
+    assert_equal expected, local_date(@time.to_date, format: '%b %e')
+  end
+
+  def test_local_date_with_i18n_format
+    expected = %Q(<time data-format="%b %e" data-local="time" datetime="#{@time_js}">Nov 21</time>)
+    assert_equal expected, local_date(@time.to_date, format: :simple_date)
+  end
+
+  def test_local_date_with_date_formats_format
+    expected = %Q(<time data-format="%b %e" data-local="time" datetime="#{@time_js}">Nov 21</time>)
+    assert_equal expected, local_date(@time.to_date, format: :date_formats_simple_date)
+  end
+
+  def test_local_date_with_missing_i18n_and_date_formats_format
+    expected = %Q(<time data-format="%B %e, %Y %l:%M%P" data-local="time" datetime="#{@time_js}">November 21, 2013  6:00am</time>)
+    assert_equal expected, local_date(@time.to_date, format: :missing_date_format)
   end
 
   def test_local_time_ago
     expected = %Q(<time data-local="time-ago" datetime="#{@time_js}">November 21, 2013  6:00am</time>)
     assert_equal expected, local_time_ago(@time)
   end
+
+  def test_local_time_ago_with_options
+    expected = %Q(<time class="date-time" data-local="time-ago" datetime="#{@time_js}">November 21, 2013  6:00am</time>)
+    assert_equal expected, local_time_ago(@time, class: "date-time")
+  end
 end

data/test/javascripts/index.js.coffee

@@ -1,5 +1,6 @@
 #= require qunit
 #= require moment
+#= require sinon-timers
 #= require local_time
 #= require_directory ./unit
 #= require_self
@@ -12,6 +13,15 @@
   document.body.appendChild el
   el
 
+@setText = (el, text) ->
+  textProperty = if "textContent" of el then "textContent" else "innerText"
+  el[textProperty] = text
+
+@getText = (el) ->
+  # innerHTML works in all browsers so using it ensures we're
+  # reading the text content, not a potentially arbitrary property.
+  el.innerHTML
+
 @triggerEvent = (name, el = document) ->
   event = document.createEvent "Events"
   event.initEvent name, true, true

data/test/javascripts/unit/local_time_test.js.coffee

@@ -9,9 +9,9 @@ test "date", ->
 
 test "unparseable time", ->
   el = addTimeEl "%Y", ":("
-  el.innerText = "2013"
+  setText el, "2013"
   run()
-  equal el.innerText, "2013"
+  equal getText(el), "2013"
 
 
 assertLocalized = (id, type = "time") ->
@@ -26,7 +26,7 @@ assertLocalized = (id, type = "time") ->
   el = document.getElementById id
 
   ok datetime = el.getAttribute "datetime"
-  ok local = el.innerText
+  ok local = getText el
 
   datetimeParsed = moment datetime
   localParsed = moment local, momentFormat

data/test/javascripts/unit/page_events_test.js.coffee

@@ -3,28 +3,28 @@ module "page events"
 test "document DOMContentLoaded", ->
   el = addTimeEl()
   triggerEvent "DOMContentLoaded"
-  ok el.innerText
+  ok getText el
 
 test "document time:elapse", ->
   el = addTimeEl()
   triggerEvent "time:elapse"
-  ok el.innerText
+  ok getText el
 
 test "window popstate", ->
   el = addTimeEl()
   triggerEvent "popstate", window
-  ok el.innerText
+  ok getText el
 
 test "document page:update with Turbolinks on", ->
   el = addTimeEl()
   triggerEvent "page:update"
-  ok not el.innerText
+  ok not getText el
 
   original = window.Turbolinks
   window.Turbolinks = { supported: true }
 
   triggerEvent "DOMContentLoaded"
   triggerEvent "page:update"
-  ok el.innerText
+  ok getText el
 
   window.Turbolinks = original

data/test/javascripts/unit/public_api_test.js.coffee

@@ -0,0 +1,21 @@
+module "public API"
+
+test "strftime", ->
+  datetime = "2013-11-12T12:13:00Z"
+  time = new Date Date.parse datetime
+  format = "%B %e, %Y %l:%M%P"
+  results = LocalTime.strftime time, format
+
+  ok results
+
+  datetimeParsed = moment datetime
+  localParsed = moment results, "MMMM D, YYYY h:mma"
+
+  ok datetimeParsed.isValid()
+  ok localParsed.isValid()
+  equal datetimeParsed.toString(), localParsed.toString()
+
+test "relativeTimeAgo", ->
+  time = moment().subtract("minutes", 42).toDate()
+  results = LocalTime.relativeTimeAgo(time)
+  equal results, "42 minutes ago"

data/test/javascripts/unit/strftime_test.js.coffee

@@ -32,7 +32,7 @@ for day in [0..30] by 6
               el  = addTimeEl format, now.toISOString()
               run()
 
-              equal el.innerText,
+              equal getText(el),
                 if func = momentFormat.match(/(\w+)\(\)/)?[1]
                   now.toDate()[func]()
                 else

data/test/javascripts/unit/time_ago_test.js.coffee

@@ -30,12 +30,11 @@ test "last week", ->
   assertTimeAgo "#{day} at #{time}", "days", 5
 
 test "this year", ->
-  # This will fail on the first 7 days of the year.
-  # Not sure how to test without somehow stubbing Date.
-  if moment().dayOfYear() > 7
-    date = moment().subtract("days", 7).format "MMM D"
-    assertTimeAgo "on #{date}", "days", 7
-
+  clock = sinon.useFakeTimers(new Date(2013,11,11,11,11).getTime(), "Date")
+  date = moment().subtract("days", 7).format "MMM D"
+  assertTimeAgo "on #{date}", "days", 7
+  clock.restore()
+  
 test "last year", ->
   date = moment().subtract("days", 366).format "MMM D, YYYY"
   assertTimeAgo "on #{date}", "days", 366
@@ -46,4 +45,4 @@ assertTimeAgo = (string, unit, amount) ->
   el.setAttribute "data-local", "time-ago"
   el.setAttribute "datetime", moment().subtract(unit, amount).utc().toISOString()
   run()
-  equal el.innerText, string
+  equal getText(el), string

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: local_time
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Javan Makhmali
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-29 00:00:00.000000000 Z
+date: 2014-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-rails
@@ -25,6 +25,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: javan@37signals.com
 executables: []
@@ -42,6 +56,7 @@ files:
 - test/javascripts/index.js.coffee
 - test/javascripts/unit/local_time_test.js.coffee
 - test/javascripts/unit/page_events_test.js.coffee
+- test/javascripts/unit/public_api_test.js.coffee
 - test/javascripts/unit/strftime_test.js.coffee
 - test/javascripts/unit/time_ago_test.js.coffee
 homepage: 
@@ -67,7 +82,7 @@ rubyforge_project:
 rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
-summary: Rails engine for displaying local times using JavaScript
+summary: Rails engine for client-side local time
 test_files:
 - test/helpers/local_time_helper_test.rb
 - test/javascripts/config.ru
@@ -75,5 +90,6 @@ test_files:
 - test/javascripts/index.js.coffee
 - test/javascripts/unit/local_time_test.js.coffee
 - test/javascripts/unit/page_events_test.js.coffee
+- test/javascripts/unit/public_api_test.js.coffee
 - test/javascripts/unit/strftime_test.js.coffee
 - test/javascripts/unit/time_ago_test.js.coffee