jekyll-timeago 0.5.2 → 0.7.0

data/README.md

@@ -1,20 +1,20 @@
-Jekyll-Timeago
-==============
+# Jekyll-Timeago
 
 [![Gem Version](https://badge.fury.io/rb/jekyll-timeago.svg)](http://badge.fury.io/rb/jekyll-timeago)
 
 Custom and simple implementation of `timeago` date filter. Main features:
 
-* Localization
+* Distance of dates in words
 * Future time
+* Usage via Filter or Tag
+* Localization
 * 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).
+In fact, `jekyll-timeago` is an extension of [Liquid](https://github.com/Shopify/liquid) Filters and Tags, so you can use it in other Liquid templates (like Octopress).
 
 
 ## Installation
-
-You have 3 options for installing the plugin:
+You have 3 options to install the plugin:
 
 **Via Jekyll plugin system**
 
@@ -27,7 +27,7 @@ gem install jekyll-timeago
 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]
+gems: [jekyll-timeago]
 ```
 
 **Via Bundler**
@@ -38,18 +38,24 @@ Add this gem to your `Gemfile` and run `bundle`:
 gem 'jekyll-timeago'
 ```
 
-To use this filter, just add the following to the top of another plugin (found under `_plugins/`):
+Then load the plugin adding the following into some file under `_plugins/` folder:
 
 ```ruby
-require 'jekyll/timeago'
+# _plugins/ext.rb
+require 'rubygems'
+require 'bundler/setup'
+Bundler.require(:default)
 ```
 
 **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! :)
+Alternatively, you can simply copy [this file](lib/jekyll-timeago/filter.rb) and [this file](lib/jekyll-timeago/tag.rb) directly into your `_plugins/` directory!
 
 
 ## Usage
+By default `timeago` computes distance of dates from passed date to current date (using `Date.today`). But you are able to modify this range passing a second argument in order to compute the distance of these dates in words.
+
+**Filter example**:
 
 ```html
 <span>{{ page.date | timeago }}</span>
@@ -60,20 +66,31 @@ Alternatively, you can simply copy [this file](https://github.com/markets/jekyll
 </div>
 ```
 
-### Customization
+Passing a parameter:
+
+```html
+<span>{{ page.date | timeago: '2020-1-1' }}</span>
+```
+
+**Tag example**:
+
+```html
+<p>{% timeago 2000-1-1 %}</p>
+```
 
-You can personalize the level of detail (from 1 up to 4, 2 by default) passing a parameter:
+Passing a second parameter:
 
 ```html
-<span>{{ page.date | timeago: 4 }}</span>
+<p>{% timeago 2000-1-1 20010-1-1 %}</p>
 ```
 
-## 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:
+## Localization
+The 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](_config.yml.example) and translate it to your site's language. Sample:
 
 ```
 jekyll_timeago:
+  depth: 2 # Level of detail
   today: 'today'
   yesterday: 'yesterday'
   tomorrow: 'tomorrow'
@@ -92,42 +109,39 @@ jekyll_timeago:
   day: 'day'
 ```
 
-## Output Examples
 
-Default behavior:
+## Level of detail (Depth)
+You are able to change the level of detail (from 1 up to 4, 2 by default) to get higher or lower granularity. This option is setted via the `config` file (see sample in previous section). Examples:
+
+* Depht => 1 `1 year ago`
+* Depht => 2 `1 year and 4 months ago` (default)
+* Depht => 3 `1 year, 4 months and 1 week ago`
+* Depht => 4 `1 year, 4 months, 1 week and 4 days ago`
+
+
+## Output Examples
+Run `script/console` to start a custom IRB session and play with `timeago` method:
 
 ```ruby
-> timeago(Date.today)
+>> timeago(Date.today)
 => "today"
-> timeago(Date.today - 1.day)
+>> timeago(Date.today - 1.day)
 => "yesterday"
-> timeago(Date.today - 10.days)
+>> timeago(Date.today - 10.days)
 => "1 week and 3 days ago"
-> timeago(Date.today - 100.days)
+>> timeago(Date.today - 100.days)
 => "3 months and 1 week ago"
-> timeago(Date.today - 500.days)
+>> timeago(Date.today - 500.days)
 => "1 year and 4 months ago"
-> timeago(Date.today + 1.days)
+>> timeago('2010-1-1', '2012-1-1')
+=> "2 years ago"
+>> timeago(Date.today + 1.days)
 => "tomorrow"
-> timeago(Date.today + 7.days)
+>> timeago(Date.today + 7.days)
 => "in 1 week"
-> timeago(Date.today + 1000.days)
+>> timeago(Date.today + 1000.days)
 => "in 2 years and 8 months"
 ```
 
-Change level of detail to get higher or lower granularity:
-
-```ruby
-> timeago(Date.today - 500.days) # default
-=> "1 year and 4 months ago"
-> timeago(Date.today - 500.days, 3)
-=> "1 year, 4 months and 1 week ago"
-> timeago(Date.today - 500.days, 4)
-=> "1 year, 4 months, 1 week and 4 days ago"
-> timeago(Date.today - 500.days, 1)
-=> "1 year ago"
-```
-
 ## License
-
 Copyright (c) 2013-2014 Marc Anguera. Jekyll-Timeago is released under the [MIT](LICENSE) License.

data/_config.yml.example

@@ -1,4 +1,5 @@
 jekyll_timeago:
+  depth: 2 # Level of detail
   today: 'today'
   yesterday: 'yesterday'
   tomorrow: 'tomorrow'

data/jekyll-timeago.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'jekyll/timeago/version'
+require 'jekyll-timeago/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-timeago"

data/lib/jekyll-timeago/filter.rb

@@ -0,0 +1,140 @@
+require 'date'
+
+module Jekyll
+  module Timeago
+    module Filter
+
+      DAYS_PER = {
+        :days => 1,
+        :weeks => 7,
+        :months => 30,
+        :years => 365
+      }
+
+      # Max level of detail
+      # years > months > weeks > days
+      # 1 year and 7 months and 2 weeks and 6 days
+      MAX_DEPTH_LEVEL = 4
+
+      # Default level of detail
+      # 1 month and 5 days, 3 weeks and 2 days, 2 years and 6 months
+      DEFAULT_DEPTH_LEVEL = 2
+
+      def timeago(from, to = Date.today)
+        from  = validate_date!(from)
+        to    = validate_date!(to)
+        depth = validate_depth!(options[:depth])
+
+        time_ago_to_now(from, to, depth)
+      end
+
+      private
+
+      def validate_date!(date)
+        Date.parse(date.to_s)
+      end
+
+      def validate_depth!(depth)
+        (1..MAX_DEPTH_LEVEL).include?(depth) or raise("Invalid depth level: #{depth.inspect}")
+        depth
+      end
+
+      # Get plugin configuration from site. Returns an empty hash if not provided.
+      def config
+        @config ||= Jekyll.configuration({}).fetch('jekyll_timeago', {}) rescue {}
+      end
+
+      def options
+        @options ||= {
+          :depth         => config['depth'] || DEFAULT_DEPTH_LEVEL,
+          :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)
+        options[key.to_sym]
+      end
+      alias_method :t, :translate
+
+      # Days passed to time ago sentence
+      def time_ago_to_now(from, to, depth)
+        days_passed = (to - from).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
+          "#{t(:prefix_future)} #{sentence} #{t(:suffix_future)}".strip
+        else
+          "#{t(:prefix)} #{sentence} #{t(:suffix)}".strip
+        end
+      end
+
+      # Builds time ranges: ['1 month', '5 days']
+      # - days_passed: integer in absolute
+      # - depth: level of detail
+      # - current_slots: built time slots
+      def build_time_ago_slots(days_passed, depth, current_slots = [])
+        return current_slots if depth == 0 || days_passed == 0
+
+        time_range = days_to_time_range(days_passed)
+        days       = DAYS_PER[time_range]
+        num_elems  = days_passed / days
+        range_type = if num_elems == 1
+          t(time_range[0...-1]) # singularize key
+        else
+          t(time_range)
+        end
+
+        current_slots << "#{num_elems} #{range_type}"
+        pending_days  = days_passed - (num_elems*days)
+        build_time_ago_slots(pending_days, depth - 1, current_slots)
+      end
+
+      # Number of days to minimum period time which can be grouped
+      def days_to_time_range(days_passed)
+        case days_passed.abs
+        when 0...7
+          :days
+        when 7...31
+          :weeks
+        when 31...365
+          :months
+        else
+          :years
+        end
+      end
+
+      # Array to sentence: ['1 month', '1 week', '5 days'] => "1 month, 1 week and 5 days"
+      def to_sentence(slots)
+        if slots.length == 1
+          slots[0]
+        else
+          "#{slots[0...-1].join(', ')} #{t(:and)} #{slots[-1]}"
+        end
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::Timeago::Filter) if defined?(Liquid)

data/lib/jekyll-timeago/tag.rb

@@ -0,0 +1,24 @@
+module Jekyll
+  module Timeago
+    class Tag < Liquid::Tag
+      include Jekyll::Timeago::Filter
+
+      def initialize(tag_name, dates, tokens)
+        super
+        @dates = dates.strip.split(' ')
+      end
+
+      def render(context)
+        from, to = @dates[0], @dates[1]
+
+        if to
+          timeago(from, to)
+        else
+          timeago(from)
+        end
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('timeago', Jekyll::Timeago::Tag) if defined?(Liquid)

data/lib/{jekyll/timeago → jekyll-timeago}/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Timeago
-    VERSION = "0.5.2"
+    VERSION = "0.7.0"
   end
 end

data/lib/jekyll-timeago.rb

@@ -0,0 +1,3 @@
+require 'jekyll-timeago/filter'
+require 'jekyll-timeago/tag'
+require 'jekyll-timeago/version'

data/script/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'jekyll-timeago/filter'
+include Jekyll::Timeago::Filter
+
+require 'active_support/core_ext'
+
+require 'irb'
+ARGV.clear
+IRB.start

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-timeago
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-22 00:00:00.000000000 Z
+date: 2014-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,8 +58,11 @@ files:
 - Rakefile
 - _config.yml.example
 - jekyll-timeago.gemspec
-- lib/jekyll/timeago.rb
-- lib/jekyll/timeago/version.rb
+- lib/jekyll-timeago.rb
+- lib/jekyll-timeago/filter.rb
+- lib/jekyll-timeago/tag.rb
+- lib/jekyll-timeago/version.rb
+- script/console
 homepage: https://github.com/markets/jekyll-timeago
 licenses:
 - MIT

data/lib/jekyll/timeago.rb

@@ -1,142 +0,0 @@
-begin; require "jekyll/timeago/version"; rescue LoadError; end
-
-module Jekyll
-  module Timeago
-
-    DAYS_PER = {
-      :days => 1,
-      :weeks => 7,
-      :months => 30,
-      :years => 365
-    }
-
-    # Max level of detail
-    # years > months > weeks > days
-    # 1 year and 7 months and 2 weeks and 6 days
-    MAX_DEPTH_LEVEL = 4
-
-    # Default level of detail
-    # 1 month and 5 days, 3 weeks and 2 days, 2 years and 6 months
-    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
-
-      unless input.is_a?(Date) || input.is_a?(Time)
-        raise "Invalid input type: #{input.inspect}"
-      end
-    end
-
-    # Get plugin configuration from site. Returns an empty hash if not provided.
-    def config
-      @config ||= Jekyll.configuration({}).fetch('jekyll_timeago', {})
-    end
-
-    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(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
-        "#{t(:prefix_future)} #{sentence} #{t(:suffix_future)}".strip
-      else
-        "#{t(:prefix)} #{sentence} #{t(:suffix)}".strip
-      end
-    end
-
-    # Builds time ranges: ['1 month', '5 days']
-    # - days_passed: integer in absolute
-    # - depth: level of detail
-    # - current_slots: built time slots
-    def build_time_ago_slots(days_passed, depth, current_slots = [])
-      return current_slots if depth == 0 || days_passed == 0
-
-      time_range = days_to_time_range(days_passed)
-      days       = DAYS_PER[time_range]
-      num_elems  = days_passed / days
-      range_type = if num_elems == 1
-        t(time_range[0...-1]) # singularize key
-      else
-        t(time_range)
-      end
-
-      current_slots << "#{num_elems} #{range_type}"
-      pending_days  = days_passed - (num_elems*days)
-      build_time_ago_slots(pending_days, depth - 1, current_slots)
-    end
-
-    # Number of days to minimum period time which can be grouped
-    def days_to_time_range(days_passed)
-      case days_passed.abs
-      when 0...7
-        :days
-      when 7...31
-        :weeks
-      when 31...365
-        :months
-      else
-        :years
-      end
-    end
-
-    # Validate if allowed level of detail
-    def depth_allowed?(depth)
-      (1..MAX_DEPTH_LEVEL).include?(depth)
-    end
-
-    # Array to sentence: ['1 month', '1 week', '5 days'] => "1 month, 1 week and 5 days"
-    def to_sentence(slots)
-      if slots.length == 1
-        slots[0]
-      else
-        "#{slots[0...-1].join(', ')} #{t(:and)} #{slots[-1]}"
-      end
-    end
-  end
-end
-
-Liquid::Template.register_filter(Jekyll::Timeago) if defined?(Liquid)