local_time 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0bfe22e485d89d3b8b8ef64db29d82d4d4f518c
-  data.tar.gz: 7d662d650e07542e16b13b98315ce589992bf397
+  metadata.gz: c2499d2a165c030164525b49b02920c90c4b4953
+  data.tar.gz: 41e33a6cbb60e66d98aba1a9089b82e324207314
 SHA512:
-  metadata.gz: 840814649a2e4c03f7b8b9592ff696c7d5b7516a088a270fe2bdb4fb96e1a29221d455c31bbc31fdaa2a2dc0a38fe3718144c4c2dfe8ced9cbbc1d7ee76f425b
-  data.tar.gz: 2ed6f4bd924c469c23fd1134a53e4818ac1f5de1fd9cf9060859726bb47429176a8e5421f07c48d18303502c288ea38ccf74fff70ce55134f2e6b8fc110d23a4
+  metadata.gz: a03eda21f6d818690cf468931e43f832afdf5fc27a5adaac2d6af551b48b5f2fff3b0990e98d5ef2d49edd3ff361a4776c2e10a691a8598f69940844108c984f
+  data.tar.gz: d9843bb2c0f6a8f892a99218a1e95c25ea88f55ddef92be471ceac46ce25d352974947219c08de3e0cfe96b28fb4081cde6b7ebe09432673628db4e6e963a53f

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"
@@ -67,6 +65,11 @@ The included JavaScript does not depend on any frameworks or libraries, and list
 
 #### Version History
 
+**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

@@ -171,6 +171,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,7 +181,7 @@ 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

data/app/helpers/local_time_helper.rb

@@ -14,9 +14,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('%B %e, %Y %l:%M%P'), options
   end
 
   def utc_time(time_or_date)

data/test/helpers/local_time_helper_test.rb

@@ -4,7 +4,7 @@ require 'action_view'
 require 'minitest/autorun'
 
 
-class LocalTimeHelperTest < Minitest::Test
+class LocalTimeHelperTest < MiniTest::Unit::TestCase
   include ActionView::Helpers::DateHelper, ActionView::Helpers::TagHelper
   include LocalTimeHelper
 
@@ -65,4 +65,9 @@ class LocalTimeHelperTest < Minitest::Test
     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

@@ -12,6 +12,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/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

@@ -46,4 +46,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.2.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: 2013-12-11 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: []
@@ -67,7 +81,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