rails-timeago 1.0.0 → 1.1.0

data/README.md

@@ -21,6 +21,8 @@ To use bundled jQuery Timeago plugin add this require statement to your applicat
 
     //=require rails-timeago
 
+This will also convert all matching time tags on page load. 
+
 ## Usage
 
 Use the timeago_tag helper like any other regular tag helper:
@@ -31,22 +33,45 @@ Use the timeago_tag helper like any other regular tag helper:
 ### Available options:
 
 * nojs
-  Add time ago in words as time tag content instead of absolute time. (default: false)
+
+  Add time ago in words as time tag content instead of absolute time. 
+  (default: false)
 
 * date_only
-  Only print date as tag content instead of full time. (default: true)
+
+  Only print date as tag content instead of full time. 
+  (default: true)
 
 * format
-  A time format for localize method used to format static time. (default: default)
+
+  A time format for localize method used to format static time. 
+  (default: default)
  
 * limit
-  Set a limit for time ago tags. All dates before given limit will not be converted. (default: 4.days.ago) 
+
+  Set a limit for time ago tags. All dates before given limit will not be converted. 
+  (default: 4.days.ago) 
 
 * force
-  Force time ago tag ignoring limit option. (default: false)
+
+  Force time ago tag ignoring limit option. 
+  (default: false)
+
+* default
+
+  String that will be returned if time is nil.
+  (default: '-')
 
 All other options will be given as options to the time tag helper.
 
+The above options can be assigned globally as defaults using
+
+    Rails::Timeago.default_options :limit => proc { 20.days.ago }, :nojs => true
+
+A global limit should always be given as a block that will be evaluated each time
+the rails timeago_tag helper is called. That avoids the limit becoming smaller the
+longer the application runs.
+
 ## License
 
 [MIT License](http://www.opensource.org/licenses/mit-license.php)

data/lib/rails-timeago/helper.rb

@@ -4,17 +4,20 @@ module Rails
       # Create a time tag usable for jQuery timeago plugin.
       #
       #   timeago_tag Time.zone.now
-      #   => ""
+      #   => "<time datetime="2012-03-10T12:07:07+01:00" title="Sat, 10 Mar 2012 12:07:07 +0100" data-time-ago="2012-03-10T12:07:07+01:00">2012-03-10</time>"
       #
       # Available options:
       # [:+nojs+]
       #   Add time ago in words as time tag content instead of absolute time.
+      #   (default: false)
       #
       # [:+date_only+]
       #   Only print date as tag content instead of full time.
+      #   (default: true)
       #
       # [:+format+]
       #   A time format for localize method used to format static time.
+      #   (default: :default)
       # 
       # [:+limit+]
       #   Set a limit for time ago tags. All dates before given limit will not be converted. 
@@ -22,28 +25,28 @@ module Rails
       #
       # [:+force+]
       #   Force time ago tag ignoring limit option.
+      #   (default: false)
+      #
+      # [:+default+]
+      #   String that will be returned if time is nil.
+      #   (default: '-')
       #
       # All other options will be given as options to tag helper.
       #
       def timeago_tag(time, html_options = {})
-        time_options = {
-          :nojs      => false, 
-          :force     => false, 
-          :format    => :default, 
-          :limit     => 4.days.ago,
-          :date_only => true
-        }
+        time_options = Rails::Timeago.default_options
 
-        time_options.merge! html_options.extract!(*time_options.keys.select{|k| html_options.include?(k)})
+        time_options = time_options.merge html_options.extract!(*time_options.keys.select{|k| html_options.include?(k)})
         html_options.merge! :title => I18n.l(time, :format => time_options[:format])
 
-        if time_options[:force] or time_options[:limit].nil? or time_options[:limit] < time
-          html_options.reverse_merge!('data-time-ago' => time.iso8601)
+        return time_options[:default] if time.nil?
 
-          time_tag time, timeago_tag_content(time, time_options), html_options
-        else
-          time_tag time, timeago_tag_content(time, time_options), html_options
+        time_options[:limit] = time_options[:limit].call if time_options[:limit].is_a?(Proc)
+
+        if time_options[:force] or time_options[:limit].nil? or time_options[:limit] < time
+          html_options.merge!('data-time-ago' => time.iso8601)
         end
+        time_tag time, timeago_tag_content(time, time_options), html_options
       end
 
       def timeago_tag_content(time, time_options = {}) # :nodoc:
@@ -53,5 +56,50 @@ module Rails
         I18n.l time, :format => time_options[:format]
       end
     end
+
+    # Read or write global rails-timeago default options. If no options are given
+    # the current defaults will be returned.
+    # 
+    # Available options:
+    # [:+nojs+]
+    #   Add time ago in words as time tag content instead of absolute time.
+    #   (default: false)
+    #
+    # [:+date_only+]
+    #   Only print date as tag content instead of full time.
+    #   (default: true)
+    #
+    # [:+format+]
+    #   A time format for localize method used to format static time.
+    #   (default: :default)
+    # 
+    # [:+limit+]
+    #   Set a limit for time ago tags. All dates before given limit will not be converted. 
+    #   Global limit should be given as a block to reevaluate limit each time timeago_tag is called.
+    #   (default: proc { 4.days.ago }) 
+    #
+    # [:+force+]
+    #   Force time ago tag ignoring limit option.
+    #   (default: false)
+    #
+    # [:+default+]
+    #   String that will be returned if time is nil.
+    #   (default: '-')
+    #
+    def self.default_options(opts = nil)
+      @defaults ||= {
+        :nojs      => false, 
+        :force     => false, 
+        :format    => :default, 
+        :limit     => proc { 4.days.ago },
+        :date_only => true,
+        :default   => '-'
+      }
+      if opts
+        @defaults.merge! opts.extract!(*@defaults.keys.select{|k| opts.include?(k)})
+      else
+        @defaults
+      end
+    end
   end
 end

data/lib/rails-timeago/version.rb

@@ -2,7 +2,7 @@ module Rails
   module Timeago
     module VERSION
       MAJOR = 1
-      MINOR = 0
+      MINOR = 1
       PATCH = 0
 
       def self.to_s

data/spec/timeago_spec.rb

@@ -61,4 +61,24 @@ describe Rails::Timeago::Helper do
   it 'should pass html option to tag helper' do
     @stub.timeago_tag(Time.now, :myattr => 'abc').should =~ /<time.*myattr="abc".*>.*<\/time>/
   end
+
+  it "should allow to set global options" do
+    Rails::Timeago.default_options :format => :short, :limit => proc { 8.days.ago }
+    time = 7.days.ago
+
+    @stub.timeago_tag(time).
+      should include(">#{I18n.l time.to_date, :format => :short}<")
+    @stub.timeago_tag(time).
+      should =~ /<time.*data-time-ago=".*".*>.*<\/time>/
+  end
+
+  it "should allow to override global options" do
+    Rails::Timeago.default_options :format => :short, :limit => proc { 8.days.ago }
+    time = 7.days.ago
+
+    @stub.timeago_tag(time, :format => :long).
+      should include(">#{I18n.l time.to_date, :format => :long}<")
+    @stub.timeago_tag(time, :limit => 4.days.ago).
+      should_not =~ /<time.*data-time-ago=".*".*>.*<\/time>/
+  end
 end

data/vendor/assets/javascripts/jquery.timeago.js

@@ -1,18 +1,18 @@
 /**
-* Timeago is a jQuery plugin that makes it easy to support automatically
-* updating fuzzy timestamps (e.g. "4 minutes ago" or "about 1 day ago").
-*
-* @name timeago
-* @version 0.10.0
-* @requires jQuery v1.2.3+
-* @author Ryan McGeary
-* @license MIT License - http://www.opensource.org/licenses/mit-license.php
-*
-* For usage and examples, visit:
-* http://timeago.yarp.com/
-*
-* Copyright (c) 2008-2011, Ryan McGeary (ryanonjavascript -[at]- mcgeary [*dot*] org)
-*/
+ * Timeago is a jQuery plugin that makes it easy to support automatically
+ * updating fuzzy timestamps (e.g. "4 minutes ago" or "about 1 day ago").
+ *
+ * @name timeago
+ * @version 0.11
+ * @requires jQuery v1.2.3+
+ * @author Ryan McGeary
+ * @license MIT License - http://www.opensource.org/licenses/mit-license.php
+ *
+ * For usage and examples, visit:
+ * http://timeago.yarp.com/
+ *
+ * Copyright (c) 2008-2011, Ryan McGeary (ryanonjavascript -[at]- mcgeary [*dot*] org)
+ */
 (function($) {
   $.timeago = function(timestamp) {
     if (timestamp instanceof Date) {
@@ -45,6 +45,7 @@
         months: "%d months",
         year: "about a year",
         years: "%d years",
+        wordSeparator: " ",
         numbers: []
       }
     },
@@ -76,14 +77,14 @@
         minutes < 45 && substitute($l.minutes, Math.round(minutes)) ||
         minutes < 90 && substitute($l.hour, 1) ||
         hours < 24 && substitute($l.hours, Math.round(hours)) ||
-        hours < 48 && substitute($l.day, 1) ||
-        days < 30 && substitute($l.days, Math.floor(days)) ||
-        days < 60 && substitute($l.month, 1) ||
-        days < 365 && substitute($l.months, Math.floor(days / 30)) ||
-        years < 2 && substitute($l.year, 1) ||
-        substitute($l.years, Math.floor(years));
+        hours < 42 && substitute($l.day, 1) ||
+        days < 30 && substitute($l.days, Math.round(days)) ||
+        days < 45 && substitute($l.month, 1) ||
+        days < 365 && substitute($l.months, Math.round(days / 30)) ||
+        years < 1.5 && substitute($l.year, 1) ||
+        substitute($l.years, Math.round(years));
 
-      return $.trim([prefix, words, suffix].join(" "));
+      return $.trim([prefix, words, suffix].join($l.wordSeparator));
     },
     parse: function(iso8601) {
       var s = $.trim(iso8601);
@@ -143,4 +144,4 @@
   // fix for IE6 suckage
   document.createElement("abbr");
   document.createElement("time");
-}(jQuery));
+}(jQuery));

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-timeago
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-22 00:00:00.000000000 Z
+date: 2012-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &7622620 !ruby/object:Gem::Requirement
+  requirement: &15835140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *7622620
+  version_requirements: *15835140
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &7621840 !ruby/object:Gem::Requirement
+  requirement: &15834280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *7621840
+  version_requirements: *15834280
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &7621400 !ruby/object:Gem::Requirement
+  requirement: &15833840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7621400
+  version_requirements: *15833840
 description: jQuery Timeago helper for Rails 3
 email:
 - jan.graichen@altimos.de