rails-timeago 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails-timeago.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jan Graichen
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# rails-timeago
+
+*rails-timeago* provides a timeago_tag helper to create time tags usable for 
+[jQuery Timeago](https://github.com/rmm5t/jquery-timeago) plugin.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails-timeago'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails-timeago
+
+To use bundled jQuery Timeago plugin add this require statement to your application.js file:
+
+    //=require rails-timeago
+
+## Usage
+
+Use the timeago_tag helper like any other regular tag helper:
+
+    <%= timeago_tag Time.zone.now, :nojs => true, :limit => 10.days.ago %>
+
+
+### 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. (default: 4.days.ago) 
+
+* force
+  Force time ago tag ignoring limit option. (default: false)
+
+All other options will be given as options to the time tag helper.
+
+## License
+
+[MIT License](http://www.opensource.org/licenses/mit-license.php)
+
+Copyright (c) 2012, Jan Graichen

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/assets/javascripts/rails-timeago.js

@@ -0,0 +1,8 @@
+//
+// jQuery Timeago bootstrap for rails-timeago helper
+//
+//= require jquery.timeago
+
+jQuery(document).ready(function() {
+  $('time[data-time-ago]').timeago();
+});

data/lib/rails-timeago.rb

@@ -0,0 +1,18 @@
+require "rails-timeago/version"
+require "rails-timeago/helper"
+
+module Rails
+  module Timeago 
+    class Engine < ::Rails::Engine # :nodoc:
+      initializer 'rails-timeago' do |app|
+        ActiveSupport.on_load(:action_controller) do
+          include Rails::Timeago::Helper
+        end
+
+        ActiveSupport.on_load(:action_view) do
+          include Rails::Timeago::Helper
+        end
+      end
+    end
+  end
+end

data/lib/rails-timeago/helper.rb

@@ -0,0 +1,57 @@
+module Rails
+  module Timeago
+    module Helper
+      # Create a time tag usable for jQuery timeago plugin.
+      #
+      #   timeago_tag Time.zone.now
+      #   => ""
+      #
+      # Available options:
+      # [:+nojs+]
+      #   Add time ago in words as time tag content instead of absolute time.
+      #
+      # [:+date_only+]
+      #   Only print date as tag content instead of full time.
+      #
+      # [:+format+]
+      #   A time format for localize method used to format static time.
+      # 
+      # [:+limit+]
+      #   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.
+      #
+      # 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.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)
+
+          time_tag time, timeago_tag_content(time, time_options), html_options
+        else
+          time_tag time, timeago_tag_content(time, time_options), html_options
+        end
+      end
+
+      def timeago_tag_content(time, time_options = {}) # :nodoc:
+        time = time.to_date            if time_options[:date_only]
+        return time_ago_in_words(time) if time_options[:nojs]
+
+        I18n.l time, :format => time_options[:format]
+      end
+    end
+  end
+end

data/lib/rails-timeago/version.rb

@@ -0,0 +1,13 @@
+module Rails
+  module Timeago
+    module VERSION
+      MAJOR = 1
+      MINOR = 0
+      PATCH = 0
+
+      def self.to_s
+        [MAJOR, MINOR, PATCH].join '.'
+      end
+    end
+  end
+end

data/rails-timeago.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rails-timeago/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jan Graichen"]
+  gem.email         = ["jan.graichen@altimos.de"]
+  gem.description   = %q{jQuery Timeago helper for Rails 3}
+  gem.summary       = %q{A Rails Helper to create time tags usable for jQuery Timeago plugin}
+  gem.homepage      = "https://github.com/jgraichen/rails-timeago"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "rails-timeago"
+  gem.require_paths = ["lib"]
+  gem.version       = Rails::Timeago::VERSION
+
+  gem.add_dependency "activesupport", ">= 3.1"
+  gem.add_dependency "actionpack", ">= 3.1"
+  gem.add_development_dependency "rspec"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+
+require 'active_support/core_ext'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

data/spec/support/stub.rb

@@ -0,0 +1,12 @@
+class TimeagoStub 
+  include Rails::Timeago::Helper
+
+  def time_tag(time, content, options = {})
+    options = options.map { |k,v| "#{k}=\"#{v}\""}
+    "<time datetime=\"#{time.iso8601}\" #{options.join ' '}>#{content}</time>"
+  end
+
+  def time_ago_in_words(time)
+    "%time_ago_in_words%"
+  end
+end

data/spec/timeago_spec.rb

@@ -0,0 +1,64 @@
+
+require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/../lib/rails-timeago/helper.rb'
+require File.dirname(__FILE__) + '/support/stub.rb'
+
+describe Rails::Timeago::Helper do
+  before { @stub = TimeagoStub.new }
+
+  it 'should create a time tag' do
+    @stub.timeago_tag(Time.now).should =~ /<time.*>.*<\/time>/
+  end
+
+  it 'should have title attribute' do
+    @stub.timeago_tag(Time.now).should =~ /<time.*title=".*".*>.*<\/time>/
+  end
+
+  it 'should have data-time-ago attribute' do
+    @stub.timeago_tag(Time.now).should =~ /<time.*data-time-ago=".*".*>.*<\/time>/
+  end
+
+  it 'should not have data-time-ago attribute for times before limit' do
+    @stub.timeago_tag(5.days.ago).should_not =~ /<time.*data-time-ago=".*".*>.*<\/time>/
+  end
+
+  it 'should have data-time-ago attribute for times after given limit' do
+    @stub.timeago_tag(5.days.ago, :limit => 6.days.ago).
+      should =~ /<time.*data-time-ago=".*".*>.*<\/time>/
+  end
+
+  it 'should have not data-time-ago attribute for times before given limit' do
+    @stub.timeago_tag(6.days.ago, :limit => 5.days.ago).
+      should_not =~ /<time.*data-time-ago=".*".*>.*<\/time>/
+  end
+
+  it 'should have data-time-ago attribute for times before limit if forced' do
+    @stub.timeago_tag(6.days.ago, :force => true).
+      should =~ /<time.*data-time-ago=".*".*>.*<\/time>/
+  end
+
+  it 'should have localized date as content' do
+    time = 3.days.ago
+    @stub.timeago_tag(time).should include(">#{I18n.l time.to_date}<")
+  end
+
+  it 'should have localized time as content date_only is false' do
+    time = 3.days.ago
+    @stub.timeago_tag(time, :date_only => false).should include(">#{I18n.l time}<")
+  end
+
+  it 'should have time ago in words as content if nojs is true' do
+    time = 3.days.ago
+    @stub.timeago_tag(time, :nojs => true).should =~ /<time.*>%time_ago_in_words%<\/time>/
+  end
+
+  it 'should pass format option to localize method' do
+    time = 3.days.ago
+    @stub.timeago_tag(time, :format => :short).
+      should include(">#{I18n.l time.to_date, :format => :short}<")
+  end
+
+  it 'should pass html option to tag helper' do
+    @stub.timeago_tag(Time.now, :myattr => 'abc').should =~ /<time.*myattr="abc".*>.*<\/time>/
+  end
+end

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

@@ -0,0 +1,146 @@
+/**
+* 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)
+*/
+(function($) {
+  $.timeago = function(timestamp) {
+    if (timestamp instanceof Date) {
+      return inWords(timestamp);
+    } else if (typeof timestamp === "string") {
+      return inWords($.timeago.parse(timestamp));
+    } else {
+      return inWords($.timeago.datetime(timestamp));
+    }
+  };
+  var $t = $.timeago;
+
+  $.extend($.timeago, {
+    settings: {
+      refreshMillis: 60000,
+      allowFuture: false,
+      strings: {
+        prefixAgo: null,
+        prefixFromNow: null,
+        suffixAgo: "ago",
+        suffixFromNow: "from now",
+        seconds: "less than a minute",
+        minute: "about a minute",
+        minutes: "%d minutes",
+        hour: "about an hour",
+        hours: "about %d hours",
+        day: "a day",
+        days: "%d days",
+        month: "about a month",
+        months: "%d months",
+        year: "about a year",
+        years: "%d years",
+        numbers: []
+      }
+    },
+    inWords: function(distanceMillis) {
+      var $l = this.settings.strings;
+      var prefix = $l.prefixAgo;
+      var suffix = $l.suffixAgo;
+      if (this.settings.allowFuture) {
+        if (distanceMillis < 0) {
+          prefix = $l.prefixFromNow;
+          suffix = $l.suffixFromNow;
+        }
+      }
+
+      var seconds = Math.abs(distanceMillis) / 1000;
+      var minutes = seconds / 60;
+      var hours = minutes / 60;
+      var days = hours / 24;
+      var years = days / 365;
+
+      function substitute(stringOrFunction, number) {
+        var string = $.isFunction(stringOrFunction) ? stringOrFunction(number, distanceMillis) : stringOrFunction;
+        var value = ($l.numbers && $l.numbers[number]) || number;
+        return string.replace(/%d/i, value);
+      }
+
+      var words = seconds < 45 && substitute($l.seconds, Math.round(seconds)) ||
+        seconds < 90 && substitute($l.minute, 1) ||
+        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));
+
+      return $.trim([prefix, words, suffix].join(" "));
+    },
+    parse: function(iso8601) {
+      var s = $.trim(iso8601);
+      s = s.replace(/\.\d\d\d+/,""); // remove milliseconds
+      s = s.replace(/-/,"/").replace(/-/,"/");
+      s = s.replace(/T/," ").replace(/Z/," UTC");
+      s = s.replace(/([\+\-]\d\d)\:?(\d\d)/," $1$2"); // -04:00 -> -0400
+      return new Date(s);
+    },
+    datetime: function(elem) {
+      // jQuery's `is()` doesn't play well with HTML5 in IE
+      var isTime = $(elem).get(0).tagName.toLowerCase() === "time"; // $(elem).is("time");
+      var iso8601 = isTime ? $(elem).attr("datetime") : $(elem).attr("title");
+      return $t.parse(iso8601);
+    }
+  });
+
+  $.fn.timeago = function() {
+    var self = this;
+    self.each(refresh);
+
+    var $s = $t.settings;
+    if ($s.refreshMillis > 0) {
+      setInterval(function() { self.each(refresh); }, $s.refreshMillis);
+    }
+    return self;
+  };
+
+  function refresh() {
+    var data = prepareData(this);
+    if (!isNaN(data.datetime)) {
+      $(this).text(inWords(data.datetime));
+    }
+    return this;
+  }
+
+  function prepareData(element) {
+    element = $(element);
+    if (!element.data("timeago")) {
+      element.data("timeago", { datetime: $t.datetime(element) });
+      var text = $.trim(element.text());
+      if (text.length > 0) {
+        element.attr("title", text);
+      }
+    }
+    return element.data("timeago");
+  }
+
+  function inWords(date) {
+    return $t.inWords(distance(date));
+  }
+
+  function distance(date) {
+    return (new Date().getTime() - date.getTime());
+  }
+
+  // fix for IE6 suckage
+  document.createElement("abbr");
+  document.createElement("time");
+}(jQuery));

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: rails-timeago
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jan Graichen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &7622620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *7622620
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: &7621840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *7621840
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &7621400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7621400
+description: jQuery Timeago helper for Rails 3
+email:
+- jan.graichen@altimos.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/assets/javascripts/rails-timeago.js
+- lib/rails-timeago.rb
+- lib/rails-timeago/helper.rb
+- lib/rails-timeago/version.rb
+- rails-timeago.gemspec
+- spec/spec_helper.rb
+- spec/support/stub.rb
+- spec/timeago_spec.rb
+- vendor/assets/javascripts/jquery.timeago.js
+homepage: https://github.com/jgraichen/rails-timeago
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A Rails Helper to create time tags usable for jQuery Timeago plugin
+test_files: []