jekyll-timeago 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3e837b2ed5dcbda0f670f70fff6b3fb452cfcbd
-  data.tar.gz: 2ee469fdc89b8ff0d59523e8194b4ae9e442b0fc
+  metadata.gz: 9d4b2b6bddb90157fb80c3c7fecd1154856803d8
+  data.tar.gz: 430dbea158d988267bc00b3ea9c5c5708e030355
 SHA512:
-  metadata.gz: 79a66d9cd557b7e65812ece1a6f05a6aba977bb8ec1eda548ddce07686b86fe428da0c66d2fa83caba844355d70bcc165fda5a82d17e612b941e65502b4cf94a
-  data.tar.gz: e1e6cd96779c0a83dc23e00c4b10b5260e8578ed73ae891e5d2446f23d672abf2e3feb1ce783142347df1444c3fe2d01ed1b1a93c651926b71621a2294c90e94
+  metadata.gz: fb56e09b24cbf51da1efab5f62d55f95149093e9d2e5efddd30906db6be23a6e69c7062d715eb0e21a43a6a1dc9972815827594d2f46f231c68690a53f13955f
+  data.tar.gz: 144e8ca11755ec40da5ac4ce3e2dfd83a071fe569247f0c3fca6a0153dead5cdda6c0c5f5bfc56fccda6f46d2979242f50bdbf79afedfc75e5601c81ddf9cfce

data/.gitignore

@@ -2,4 +2,5 @@ pkg
 .rvmrc
 Gemfile.lock
 spec/_site
-.rpsec
+.rpsec
+*.gemfile.lock

data/.travis.yml

@@ -1,5 +1,21 @@
 language: ruby
+
+cache: bundler
+
+sudo: false
+
 rvm:
+  - 2.2
   - 2.1
   - 2.0
   - 1.9.3
+
+gemfile:
+  - gemfiles/jekyll_v1.gemfile
+  - gemfiles/jekyll_v2.gemfile
+  - gemfiles/jekyll_v3.gemfile
+
+matrix:
+  exclude:
+    - rvm: 1.9.3
+      gemfile: gemfiles/jekyll_v3.gemfile

data/Appraisals

@@ -0,0 +1,13 @@
+appraise 'jekyll-v1' do
+  gem 'jekyll', '~> 1.5'
+end
+
+appraise 'jekyll-v2' do
+  gem 'jekyll', '~> 2.5'
+  gem 'listen', '< 3.1.0' if RUBY_VERSION <= "2.2"
+end
+
+appraise 'jekyll-v3' do
+  gem 'jekyll', '~> 3.0'
+  gem 'listen', '< 3.1.0' if RUBY_VERSION <= "2.2"
+end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2013-2014 Marc Anguera Insa
+Copyright 2013-2016 Marc Anguera Insa
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -2,21 +2,24 @@
 
 [![Gem Version](https://badge.fury.io/rb/jekyll-timeago.svg)](http://badge.fury.io/rb/jekyll-timeago) [![Build Status](https://travis-ci.org/markets/jekyll-timeago.svg?branch=master)](https://travis-ci.org/markets/jekyll-timeago)
 
-Custom and simple implementation of `timeago` date filter. Main features:
+> A Ruby library to compute distance of dates in words. Originally built for Jekyll, as a Liquid extension.
 
-* Distance of dates in words
-* Future time
-* Usage via Filter or Tag
-* Localization
-* Level of detail
+Main features:
 
-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).
+* Compute distance of dates in words, ie: `1 week and 2 days ago`, `5 months ago`, `in 1 year`
+* Future times.
+* Out of the box support for `Jekyll` (v1, v2 and v3) projects, available as a Liquid Filter and as a Liquid Tag.
+* Localization (i18n).
+* Level of detail.
+* Available via the command line.
+
+In fact, `jekyll-timeago` started just as an extension for [Liquid](https://github.com/Shopify/liquid) template engine, to be used in Jekyll and Octopress backed sites. But actually, you can use it easily in any Ruby project. Read more about usage outside Jekyll [in this section](#usage-outside-jekyll).
 
 ## Installation
 
-You have 3 options to install the plugin:
+You have different options to install and plugging it into Jekyll projects:
 
-**Via Jekyll plugin system**
+**Via Jekyll plugin system (recommended)**
 
 Install the `gem` to your system:
 
@@ -27,33 +30,27 @@ 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**
 
-Add this gem to your `Gemfile` and run `bundle`:
-
-```
-gem 'jekyll-timeago'
-```
-
-Then load the plugin adding the following into some file under `_plugins/` folder:
+Add this gem to your `Gemfile` and run `bundle install`:
 
 ```ruby
-# _plugins/ext.rb
-require 'rubygems'
-require 'bundler/setup'
-Bundler.require(:default)
+group :jekyll_plugins do
+  gem 'jekyll-timeago'
+end
 ```
 
-**Manually**
+**Manually (less recommended)**
 
-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!
+Alternatively, you can simply copy the files under [lib/jekyll-timeago](lib/jekyll-timeago/) directly into your `_plugins/` directory. All those files will be loaded by Jekyll.
 
 ## 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.
+By default, the `timeago` helper computes distance of dates from passed date to current date (using `Date.today`). But you are able to modify this range by passing a second argument. Examples:
 
 **Filter example**:
 
@@ -81,7 +78,9 @@ Passing a second parameter:
 
 ## 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:
+This plugin allows you to localize the strings needed to build the sentences. To do this, you just need to add some extra keys in your `_config.yml`. You can simply copy them from one of the [provided examples](lib/jekyll-timeago/config/). Or even, translate it to your site's language just overriding it.
+
+English example (default):
 
 ```
 jekyll_timeago:
@@ -104,7 +103,7 @@ jekyll_timeago:
   day: 'day'
 ```
 
-**NOTE** You also can use suffixes and prefixes to modify the sentences. For example, set `suffix: nil` and you'll get only the distance of dates: `1 year, 4 months and 1 week`.
+**NOTE** You also can play with suffixes and prefixes to modify the sentences. For example, set `suffix: nil` and you'll get only the distance of dates: `1 year, 4 months and 1 week`.
 
 ## Level of detail (Depth)
 
@@ -115,9 +114,33 @@ You are able to change the level of detail (from 1 up to 4, 2 by default) to get
 * Depht => 3 `1 year, 4 months and 1 week ago`
 * Depht => 4 `1 year, 4 months, 1 week and 4 days ago`
 
-## Output Examples
+## Usage outside Jekyll
+
+You just need to install the gem to your application (add `gem 'jekyll-timeago'` to your Gemfile). From now on, you can use the provided method by calling:
 
-Run `script/console` to start a custom IRB session and play with `timeago` method:
+```ruby
+Jekyll::Timeago::Core.timeago(from, to, options)
+```
+
+Note, that you can use the `options` parameter to override the default localization or the level of detail.
+
+Or if you have the gem installed in your system and you're not using Bundler:
+
+```ruby
+require 'jekyll-timeago'
+puts Jekyll::Timeago::Core.timeago(from, to, options)
+```
+
+## CLI
+
+```
+$ jekyll-timeago 2016-1-1
+2 months and 6 days ago
+```
+
+### Console
+
+Run `$ jekyll-timeago --console` to start a custom IRB session and play with the `timeago` method:
 
 ```ruby
 >> timeago(Date.today)
@@ -143,12 +166,24 @@ Run `script/console` to start a custom IRB session and play with `timeago` metho
 Play with `options`:
 
 ```ruby
->> options[:yesterday] = "ayer"
+>> configure "yesterday" => "ayer"
 => "ayer"
 >> timeago(Date.today - 1.day)
 => "ayer"
 ```
 
+## Development
+
+Any kind of feedback, bug report, idea or enhancement are really appreciated.
+
+To contribute, just fork the repo, hack on it and send a pull request. Don't forget to add specs for behaviour changes and run the test suite:
+
+```
+bundle exec appraisal rake
+```
+
+`Appraisal` library is used to ensure compatibility with different Jekyll versions. Check out current supported versions [here](Appraisals).
+
 ## License
 
-Copyright (c) 2013-2014 Marc Anguera. Jekyll-Timeago is released under the [MIT](LICENSE) License.
+Copyright (c) 2013-2016 Marc Anguera. Jekyll-Timeago is released under the [MIT](LICENSE) License.

data/bin/jekyll-timeago

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/jekyll-timeago/core"
+include Jekyll::Timeago::Core
+
+help_message = <<END
+Usage:
+
+  jekyll-timeago <from_date> [to_date]
+
+Notes:
+        [to_date] Optional, defaults to current date
+
+Options:
+        --help, -h  Print this message
+        --console   Start an interactive session with jekyll-timeago included
+END
+
+if ARGV.empty? || ARGV.include?("--help") || ARGV.include?("-h")
+  puts help_message
+elsif ARGV.include? "--console"
+  require "irb"
+  ARGV.clear
+  IRB.start
+else
+  puts timeago *ARGV
+end

data/gemfiles/jekyll_v1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jekyll", "~> 1.5"
+
+gemspec :path => "../"

data/gemfiles/jekyll_v2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jekyll", "~> 2.5"
+gem "listen", "< 3.1.0"
+
+gemspec :path => "../"

data/gemfiles/jekyll_v3.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "jekyll", "~> 3.0"
+gem "listen", "< 3.1.0"
+
+gemspec :path => "../"

data/jekyll-timeago.gemspec

@@ -1,7 +1,4 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'jekyll-timeago/version'
+require './lib/jekyll-timeago/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-timeago"
@@ -23,4 +20,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "appraisal"
 end

data/lib/jekyll-timeago/config/_config.yml.example.es

@@ -0,0 +1,18 @@
+jekyll_timeago:
+  depth: 2 # Nivel de detalle
+  today: 'hoy'
+  yesterday: 'ayer'
+  tomorrow: 'mañana'
+  and: 'y'
+  suffix: ''
+  prefix: 'hace'
+  suffix_future: ''
+  prefix_future: 'en'
+  years: 'años'
+  year: 'año'
+  months: 'meses'
+  month: 'mes'
+  weeks: 'semanas'
+  week: 'semana'
+  days: 'días'
+  day: 'día'

data/lib/jekyll-timeago/config/_config.yml.example.fr

@@ -0,0 +1,19 @@
+jekyll_timeago:
+  depth: 2 # niveau de détail
+  today: "aujourd'hui"
+  yesterday: "hier"
+  tomorrow: "demain"
+  and: "et"
+  suffix: ""
+  prefix: "il y a environ"
+  suffix_future: ""
+  prefix_future: "dans"
+  years: "années"
+  year: "année"
+  months: "mois"
+  month: "mois"
+  weeks: "semaines"
+  week: "semaine"
+  days: "jours"
+  day: "jour"
+

data/lib/jekyll-timeago/core.rb

@@ -0,0 +1,147 @@
+require 'date'
+
+module Jekyll
+  module Timeago
+    module Core
+      extend self
+
+      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, options = {})
+        if to.is_a?(Hash)
+          options = to
+          to = Date.today
+        end
+
+        @defaults = defaults unless defined?(@defaults)
+        @options = @defaults.merge(options)
+
+        from  = validate_date!(from)
+        to    = validate_date!(to)
+        depth = validate_depth!(@options["depth"])
+
+        time_ago_to_now(from, to, depth)
+      end
+
+      def configure(options = {})
+        @defaults = defaults.merge(options)
+      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
+
+      def defaults
+        {
+          "depth"         => DEFAULT_DEPTH_LEVEL,
+          "today"         => 'today',
+          "yesterday"     => 'yesterday',
+          "tomorrow"      => 'tomorrow',
+          "and"           => 'and',
+          "suffix"        => 'ago',
+          "prefix"        => '',
+          "suffix_future" => '',
+          "prefix_future" => 'in',
+          "years"         => 'years',
+          "year"          => 'year',
+          "months"        => 'months',
+          "month"         => 'month',
+          "weeks"         => 'weeks',
+          "week"          => 'week',
+          "days"          => 'days',
+          "day"           => 'day'
+        }
+      end
+
+      def translate(key)
+        @options[key.to_s]
+      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).to_i
+
+        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 1..6
+          :days
+        when 7..30
+          :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

data/lib/jekyll-timeago/filter.rb

@@ -1,152 +1,11 @@
-require 'date'
-
 module Jekyll
   module Timeago
     module Filter
-      extend self
-
-      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
-
-      def options
-        @options ||= setup
-      end
-
-      # Restore default configuration
-      def reset!
-        setup
-      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
-
-      # Load settings from Jekyll configuration
-      def jekyll_config
-        @jekyll_config ||= Jekyll.configuration({}).fetch('jekyll_timeago', {}) rescue {}
-      end
+        config = @context.registers[:site].config.fetch('jekyll_timeago', {})
 
-      # Configure plugin options with defaults
-      def setup
-        @options = {
-          :depth         => jekyll_config['depth'] || DEFAULT_DEPTH_LEVEL,
-          :today         => jekyll_config['today'] || 'today',
-          :yesterday     => jekyll_config['yesterday'] || 'yesterday',
-          :tomorrow      => jekyll_config['tomorrow'] || 'tomorrow',
-          :and           => jekyll_config['and'] ||'and',
-          :suffix        => jekyll_config['suffix'] || 'ago',
-          :prefix        => jekyll_config['prefix'] || '',
-          :suffix_future => jekyll_config['suffix_future'] || '',
-          :prefix_future => jekyll_config['prefix_future'] || 'in',
-          :years         => jekyll_config['years'] || 'years',
-          :year          => jekyll_config['year'] || 'year',
-          :months        => jekyll_config['months'] || 'months',
-          :month         => jekyll_config['month'] || 'month',
-          :weeks         => jekyll_config['weeks'] || 'weeks',
-          :week          => jekyll_config['week'] || 'week',
-          :days          => jekyll_config['days'] || 'days',
-          :day           => jekyll_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).to_i
-
-        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 1..6
-          :days
-        when 7..30
-          :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
+        Jekyll::Timeago::Core.timeago(from, to, config)
       end
     end
   end
 end
-
-Liquid::Template.register_filter(Jekyll::Timeago::Filter) if defined?(Liquid)

data/lib/jekyll-timeago/tag.rb

@@ -1,8 +1,6 @@
 module Jekyll
   module Timeago
     class Tag < Liquid::Tag
-      include Jekyll::Timeago::Filter
-
       def initialize(tag_name, dates, tokens)
         super
         @dates = dates.strip.split(' ')
@@ -10,15 +8,14 @@ module Jekyll
 
       def render(context)
         from, to = @dates[0], @dates[1]
+        config = context.registers[:site].config.fetch('jekyll_timeago', {})
 
         if to
-          timeago(from, to)
+          Jekyll::Timeago::Core.timeago(from, to, config)
         else
-          timeago(from)
+          Jekyll::Timeago::Core.timeago(from, config)
         end
       end
     end
   end
 end
-
-Liquid::Template.register_tag('timeago', Jekyll::Timeago::Tag) if defined?(Liquid)

data/lib/jekyll-timeago/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Timeago
-    VERSION = "0.8.2"
+    VERSION = "0.9.0"
   end
 end

data/lib/jekyll-timeago.rb

@@ -1,3 +1,10 @@
-require 'jekyll-timeago/filter'
-require 'jekyll-timeago/tag'
+require 'jekyll-timeago/core'
 require 'jekyll-timeago/version'
+
+if defined?(Liquid)
+  require 'jekyll-timeago/filter'
+  require 'jekyll-timeago/tag'
+
+  Liquid::Template.register_filter(Jekyll::Timeago::Filter)
+  Liquid::Template.register_tag('timeago', Jekyll::Timeago::Tag)
+end

data/spec/jekyll-timeago_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+describe Jekyll::Timeago do
+  context 'Jekyll integration' do
+    let(:overrides) do
+      {
+        "source"      => source_dir,
+        "destination" => dest_dir,
+        "url"         => "http://example.org",
+      }
+    end
+    let(:config)   { Jekyll.configuration(overrides) }
+    let(:site)     { Jekyll::Site.new(config) }
+    let(:contents) { File.read(dest_dir("index.html")) }
+
+    it 'setup from Jekyll configuration' do
+      expect(site.config['jekyll_timeago']).to eql(configuration_file['jekyll_timeago'])
+    end
+
+    it 'process successfully the site using filters and tags' do
+      expect { site.process }.to_not raise_error
+
+      lines = [
+        "<p>2 years yeah</p>",
+        "<p>12 months yeah</p>",
+        "<p>12 months yeah</p>",
+        "<p>2 years yeah</p>"
+      ]
+      expect(contents).to eq(lines.join("\n"))
+    end
+  end
+
+  context 'Core' do
+    let (:sample_date) { Date.new(2014, 7, 30) }
+    let (:today) { Date.today }
+
+    before do
+      Jekyll::Timeago::Core.configure
+    end
+
+    it 'does not accept invalid depth' do
+      expect { timeago(today, sample_date, "depth" => 5) }.to raise_error
+    end
+
+    it 'accepts a hash (options) as a second parameter (implicit "to")' do
+      expect(timeago(today, "today" => "during the day")).to eq("during the day")
+    end
+
+    it 'yesterday, today and tomorrow' do
+      expect(timeago(today - 1.day)).to eql("yesterday")
+      expect(timeago(today)).to eql("today")
+      expect(timeago(today + 1.day)).to eql("tomorrow")
+    end
+
+    it 'past time' do
+      expect(timeago(sample_date - 10.days, sample_date)).to eql('1 week and 3 days ago')
+      expect(timeago(sample_date - 100.days, sample_date)).to eql('3 months and 1 week ago')
+      expect(timeago(sample_date - 500.days, sample_date)).to eql('1 year and 4 months ago')
+    end
+
+    it 'future time' do
+      expect(timeago(sample_date + 7.days, sample_date)).to eql('in 1 week')
+      expect(timeago(sample_date + 1000.days, sample_date)).to eql('in 2 years and 9 months')
+    end
+
+    it 'allow different date formats' do
+      expect(timeago('2010-1-1', '2012-1-1')).to eql('2 years ago')
+      expect(timeago('2010/1/1', '2012/1/1')).to eql('2 years ago')
+      expect(timeago('Jan 2010, 1', 'Jan 2012, 1')).to eql('2 years ago')
+      expect(timeago('2014-10-06 20:00:00', '2014-10-07 20:00:00')).to eql('yesterday')
+    end
+
+    it 'allow to change defaults at global level' do
+      Jekyll::Timeago::Core.configure("year" => nil, "depth" => 1, "suffix" => nil)
+      expect(timeago(sample_date - 500.days, sample_date)).to eql('1')
+    end
+
+    it 'allow to change level of detail' do
+      expect(timeago(sample_date - 500.days, sample_date, "depth" => 1)).to eql('1 year ago')
+      expect(timeago(sample_date - 500.days, sample_date, "depth" => 3)).to eql('1 year, 4 months and 2 weeks ago')
+      expect(timeago(sample_date - 500.days, sample_date, "depth" => 4)).to eql('1 year, 4 months, 2 weeks and 1 day ago')
+    end
+
+    it 'allow localization' do
+      new_options = {
+        "prefix" => 'hace',
+        "months" => 'meses',
+        "and"    => 'y',
+        "week"   => 'semana',
+        "suffix" => nil
+      }
+
+      expect(timeago(sample_date - 100.days, sample_date, new_options)).to eql('hace 3 meses y 1 semana')
+    end
+  end
+
+  context 'CLI' do
+    it 'prints help message if called with no params or --help' do
+      expect(`jekyll-timeago`).to match("Usage")
+      expect(`jekyll-timeago --help`).to match("Usage")
+    end
+
+    it 'computes distance of dates' do
+      expect(`jekyll-timeago 2016-1-1 2016-1-5`).to match("4 days ago")
+    end
+  end
+end

data/spec/source/_config.yml

@@ -2,12 +2,12 @@ gems:
   - jekyll-timeago
 
 jekyll_timeago:
-  depth: 3
+  depth: 1
   today: 'today'
   yesterday: 'yesterday'
   tomorrow: 'tomorrow'
   and: 'and'
-  suffix: 'ago'
+  suffix: 'yeah'
   prefix: ''
   suffix_future: ''
   prefix_future: 'in'

data/spec/source/index.html

@@ -4,5 +4,4 @@
 <p>{% timeago 2014-1-1 %}</p>
 <p>{% timeago 2014-1-1 2015-1-1 %}</p>
 <p>{{ '2014-1-1' | timeago: '2015-1-1' }}</p>
-<p>{{ '2014-1-1' | timeago }}</p>
-<p>{{ 'Aug 2014, 15' | timeago }}</p>
+<p>{{ '2014-1-1' | timeago }}</p>

data/spec/spec_helper.rb

@@ -1,8 +1,7 @@
 require 'fileutils'
-require 'active_support'
-require 'active_support/core_ext'
+require 'active_support/all'
 require 'jekyll'
-require File.expand_path('lib/jekyll-timeago/filter')
+require File.expand_path('lib/jekyll-timeago')
 
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
@@ -26,18 +25,7 @@ RSpec.configure do |config|
     YAML.load_file(File.join(SOURCE_DIR, '_config.yml'))
   end
 
-  def site_configuration(overrides = {})
-    Jekyll.configuration(overrides.merge({
-      'source'      => source_dir,
-      'destination' => dest_dir
-    }))
-  end
-
-  def timeago(from, to = Date.today)
-    Jekyll::Timeago::Filter.timeago(from, to)
-  end
-
-  def options
-    @options ||= Jekyll::Timeago::Filter.options
+  def timeago(from, to = Date.today, options = {})
+    Jekyll::Timeago::Core.timeago(from, to, options)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-timeago
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - markets
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-06 00:00:00.000000000 Z
+date: 2016-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -80,28 +80,50 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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: Custom timeago filter for Jekyll (Liquid Filter and Tag). Localization
   and futures supported.
 email:
 - srmarc.ai@gmail.com
-executables: []
+executables:
+- jekyll-timeago
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- Appraisals
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- _config.yml.example
+- bin/jekyll-timeago
+- gemfiles/jekyll_v1.gemfile
+- gemfiles/jekyll_v2.gemfile
+- gemfiles/jekyll_v3.gemfile
 - jekyll-timeago.gemspec
 - lib/jekyll-timeago.rb
+- lib/jekyll-timeago/config/_config.yml.example.en
+- lib/jekyll-timeago/config/_config.yml.example.es
+- lib/jekyll-timeago/config/_config.yml.example.fr
+- lib/jekyll-timeago/core.rb
 - lib/jekyll-timeago/filter.rb
 - lib/jekyll-timeago/tag.rb
 - lib/jekyll-timeago/version.rb
-- script/console
-- spec/jekyll_timeago_spec.rb
+- spec/jekyll-timeago_spec.rb
 - spec/source/_config.yml
 - spec/source/index.html
 - spec/spec_helper.rb
@@ -125,13 +147,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Custom timeago filter for Jekyll (Liquid Filter and Tag). Localization and
   futures supported.
 test_files:
-- spec/jekyll_timeago_spec.rb
+- spec/jekyll-timeago_spec.rb
 - spec/source/_config.yml
 - spec/source/index.html
 - spec/spec_helper.rb

data/script/console

@@ -1,13 +0,0 @@
-#!/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

data/spec/jekyll_timeago_spec.rb

@@ -1,82 +0,0 @@
-require 'spec_helper'
-
-describe Jekyll::Timeago do
-  context 'Jekyll integration' do
-    let(:site) do
-      Jekyll::Site.new(site_configuration)
-    end
-
-    it 'setup from Jekyll configuration' do
-      expect(site.config['jekyll_timeago']).to eql(configuration_file['jekyll_timeago'])
-    end
-
-    it 'process successfully the site using filters and tags' do
-      expect { site.process }.to_not raise_error
-    end
-  end
-
-  context 'Timeago calculations' do
-    let (:sample_date) { Date.new(2014, 7, 30) }
-
-    before(:each) do
-      Jekyll::Timeago::Filter.reset!
-    end
-
-    it 'does not accept invalid depth' do
-      options[:depth] = 5
-
-      expect { timeago(today) }.to raise_error
-    end
-
-    it 'yesterday, today and tomorrow' do
-      today = Date.today
-
-      expect(timeago(today - 1.day)).to eql(options[:yesterday])
-      expect(timeago(today)).to eql(options[:today])
-      expect(timeago(today + 1.day)).to eql(options[:tomorrow])
-    end
-
-    context 'past time' do
-      it 'should process distances' do
-        expect(timeago(sample_date - 10.days, sample_date)).to eql('1 week and 3 days ago')
-        expect(timeago(sample_date - 100.days, sample_date)).to eql('3 months and 1 week ago')
-        expect(timeago(sample_date - 500.days, sample_date)).to eql('1 year and 4 months ago')
-      end
-    end
-
-    context 'future time' do
-      it 'should process distances' do
-        expect(timeago(sample_date + 7.days, sample_date)).to eql('in 1 week')
-        expect(timeago(sample_date + 1000.days, sample_date)).to eql('in 2 years and 9 months')
-      end
-    end
-
-    it 'allow different date inputs' do
-      expect(timeago('2010-1-1', '2012-1-1')).to eql('2 years ago')
-      expect(timeago('2010/1/1', '2012/1/1')).to eql('2 years ago')
-      expect(timeago('Jan 2010, 1', 'Jan 2012, 1')).to eql('2 years ago')
-      expect(timeago('2014-10-06 20:00:00', '2014-10-07 20:00:00')).to eql('yesterday')
-    end
-
-    it 'allow to change level of detail' do
-      options[:depth] = 1
-      expect(timeago(sample_date - 500.days, sample_date)).to eql('1 year ago')
-
-      options[:depth] = 3
-      expect(timeago(sample_date - 500.days, sample_date)).to eql('1 year, 4 months and 2 weeks ago')
-
-      options[:depth] = 4
-      expect(timeago(sample_date - 500.days, sample_date)).to eql('1 year, 4 months, 2 weeks and 1 day ago')
-    end
-
-    it 'allow localization' do
-      options[:prefix] = 'hace'
-      options[:months] = 'meses'
-      options[:and]    = 'y'
-      options[:week]   = 'semana'
-      options[:suffix] = nil
-
-      expect(timeago(sample_date - 100.days, sample_date)).to eql('hace 3 meses y 1 semana')
-    end
-  end
-end