jekyll-timeago 0.4.2 → 0.5.0

data/README.md

@@ -1,11 +1,29 @@
 Jekyll-Timeago
 ==============
-Custom and simple implementation of `timeago` date filter. Futures and personalization (level of detail) supported.
 
-In fact, `jekyll-timeago` is an extension of [Liquid](https://github.com/Shopify/liquid) filters, so you can use it in all your Liquid templates.
+Custom and simple implementation of `timeago` date filter. Main features:
+
+* Localization
+* Future time
+* Level of detail
+
+In fact, `jekyll-timeago` is an extension of [Liquid](https://github.com/Shopify/liquid) filters, so you can use it in all your Liquid templates (Octopress as well).
 
 
 ## Installation
+
+You have 3 options for installing the plugin:
+
+**Via Jekyll plugin system**
+
+In your `_config.yml` file, add a new array with the key gems and the values of the gem names of the plugins you’d like to use. In this case:
+
+```
+gems: [jekyll-timeago]
+```
+
+**Via Bundler**
+
 Add this gem to your `Gemfile` and run `bundle`:
 
 ```
@@ -18,10 +36,13 @@ To use this filter, just add the following to the top of another plugin (found u
 require 'jekyll/timeago'
 ```
 
+**Manually**
+
 Alternatively, you can simply copy [this file](https://github.com/markets/jekyll-timeago/blob/master/lib/jekyll/timeago.rb) directly into your `_plugins/` directory! :)
 
 
 ## Usage
+
 ```html
 <span>{{ page.date | timeago }}</span>
 <h2>{{ page.title }}</h2>
@@ -32,13 +53,41 @@ Alternatively, you can simply copy [this file](https://github.com/markets/jekyll
 ```
 
 ### Customization
+
 You can personalize the level of detail (from 1 up to 4, 2 by default) passing a parameter:
+
 ```html
 <span>{{ page.date | timeago: 4 }}</span>
 ```
 
+## Localization
+
+This plugin allows you to localize the strings needed to build the time ago sentences. For do this, you must add some extra keys to your `_config.yml`. You can simply copy them from [this example file](https://github.com/markets/jekyll-timeago/blob/master/_config.yml.example) and translate it to your site's language. Sample:
+
+```
+jekyll_timeago:
+  today: 'today'
+  yesterday: 'yesterday'
+  tomorrow: 'tomorrow'
+  and: 'and'
+  suffix: 'ago'
+  prefix: ''
+  suffix_future: 'in'
+  prefix_future: ''
+  years: 'years'
+  year: 'year'
+  months: 'months'
+  month: 'month'
+  weeks: 'weeks'
+  week: 'week'
+  days: 'days'
+  day: 'day'
+```
+
 ## Output Examples
+
 Default behavior:
+
 ```ruby
 > timeago(Date.today)
 => "today"
@@ -59,6 +108,7 @@ Default behavior:
 ```
 
 Change level of detail to get higher or lower granularity:
+
 ```ruby
 > timeago(Date.today - 500.days) # default
 => "1 year ago and 4 months ago"
@@ -71,4 +121,5 @@ Change level of detail to get higher or lower granularity:
 ```
 
 ## License
+
 Copyright (c) 2013 Marc Anguera. Unscoped Associations is released under the [MIT](http://opensource.org/licenses/MIT) License.

data/_config.yml.example

@@ -0,0 +1,17 @@
+jekyll_timeago:
+  today: 'today'
+  yesterday: 'yesterday'
+  tomorrow: 'tomorrow'
+  and: 'and'
+  suffix: 'ago'
+  prefix: ''
+  suffix_future: 'in'
+  prefix_future: ''
+  years: 'years'
+  year: 'year'
+  months: 'months'
+  month: 'month'
+  weeks: 'weeks'
+  week: 'week'
+  days: 'days'
+  day: 'day'

data/jekyll-timeago.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Jekyll::Timeago::VERSION
   spec.authors       = ["markets"]
   spec.email         = ["srmarc.ai@gmail.com"]
-  spec.description   = %q{Custom timeago filter for Jekyll (Liquid filter)}
-  spec.summary       = %q{Custom timeago filter for Jekyll (Liquid filter)}
+  spec.description   = %q{Custom timeago filter for Jekyll (Liquid filter). Localization and futures supported.}
+  spec.summary       = %q{Custom timeago filter for Jekyll (Liquid filter). Localization and futures supported.}
   spec.homepage      = "https://github.com/markets/jekyll-timeago"
   spec.license       = "MIT"
 

data/lib/jekyll/timeago.rb

@@ -6,8 +6,8 @@ module Jekyll
     DAYS_PER = {
       :days => 1,
       :weeks => 7,
-      :months => 31,
-      :years => 365,
+      :months => 30,
+      :years => 365
     }
 
     # Max level of detail
@@ -20,6 +20,15 @@ module Jekyll
     DEFAULT_DEPTH_LEVEL = 2
 
     def timeago(input, depth = DEFAULT_DEPTH_LEVEL)
+      validate!(input, depth)
+
+      time_ago_to_now(input, depth)
+    end
+
+    private
+
+    # Validates inputs
+    def validate!(input, depth)
       unless depth_allowed?(depth)
         raise "Invalid depth level: #{depth.inspect}"
       end
@@ -27,27 +36,55 @@ module Jekyll
       unless input.is_a?(Date) || input.is_a?(Time)
         raise "Invalid input type: #{input.inspect}"
       end
+    end
 
-      days_passed = (Date.today - Date.parse(input.to_s)).to_i
-      time_ago_to_now(days_passed, depth)
+    # Get plugin configuration from site. Returns an empty hash if not provided.
+    def config
+      @config ||= Jekyll.configuration({}).fetch('jekyll_timeago', {})
     end
 
-    private
+    def strings
+      {
+        :today         => config['day'] || 'today',
+        :yesterday     => config['yesterday'] || 'yesterday',
+        :tomorrow      => config['tomorrow'] || 'tomorrow',
+        :and           => config['and'] ||'and',
+        :suffix        => config['suffix'] || 'ago',
+        :prefix        => config['prefix'] || '',
+        :suffix_future => config['suffix_future'] || '',
+        :prefix_future => config['prefix_future'] || 'in',
+        :years         => config['years'] || 'years',
+        :year          => config['year'] || 'year',
+        :months        => config['months'] || 'months',
+        :month         => config['month'] || 'month',
+        :weeks         => config['weeks'] || 'weeks',
+        :week          => config['week'] || 'week',
+        :days          => config['days'] || 'days',
+        :day           => config['day'] || 'day'
+      }
+    end
+
+    def translate(key)
+      strings[key.to_sym]
+    end
+    alias_method :t, :translate
 
     # Days passed to time ago sentence
-    def time_ago_to_now(days_passed, depth)
-      return "today"     if days_passed == 0
-      return "yesterday" if days_passed == 1
-      return "tomorrow"  if days_passed == -1
+    def time_ago_to_now(input_date, depth)
+      days_passed = (Date.today - Date.parse(input_date.to_s)).to_i
+
+      return t(:today)     if days_passed == 0
+      return t(:yesterday) if days_passed == 1
+      return t(:tomorrow)  if days_passed == -1
 
       future   = days_passed < 0
       slots    = build_time_ago_slots(days_passed.abs, depth)
       sentence = to_sentence(slots)
 
       if future
-        "in #{sentence}"
+        "#{t(:prefix_future)} #{sentence} #{t(:suffix_future)}".strip
       else
-        "#{sentence} ago"
+        "#{t(:prefix)} #{sentence} #{t(:suffix)}".strip
       end
     end
 
@@ -62,9 +99,9 @@ module Jekyll
       days       = DAYS_PER[time_range]
       num_elems  = days_passed / days
       range_type = if num_elems == 1
-        time_range.to_s[0...-1] # singularize
+        t(time_range[0...-1]) # singularize key
       else
-        time_range.to_s
+        t(time_range)
       end
 
       current_slots << "#{num_elems} #{range_type}"
@@ -96,10 +133,10 @@ module Jekyll
       if slots.length == 1
         slots[0]
       else
-        "#{slots[0...-1].join(', ')} and #{slots[-1]}"
+        "#{slots[0...-1].join(', ')} #{t(:and)} #{slots[-1]}"
       end
     end
   end
 end
 
-Liquid::Template.register_filter(Jekyll::Timeago)
+Liquid::Template.register_filter(Jekyll::Timeago) if defined?(Liquid)

data/lib/jekyll/timeago/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Timeago
-    VERSION = "0.4.2"
+    VERSION = "0.5.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-timeago
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-11 00:00:00.000000000 Z
+date: 2014-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,7 +43,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Custom timeago filter for Jekyll (Liquid filter)
+description: Custom timeago filter for Jekyll (Liquid filter). Localization and futures
+  supported.
 email:
 - srmarc.ai@gmail.com
 executables: []
@@ -54,6 +55,7 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- _config.yml.example
 - jekyll-timeago.gemspec
 - lib/jekyll/timeago.rb
 - lib/jekyll/timeago/version.rb
@@ -70,22 +72,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1046143283
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1046143283
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Custom timeago filter for Jekyll (Liquid filter)
+summary: Custom timeago filter for Jekyll (Liquid filter). Localization and futures
+  supported.
 test_files: []