jekyll-timeago 0.9.2 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83655f4748686c8e8eacc7a5ca7334f5a8bc0ada
-  data.tar.gz: 634b32d997525a8f06d2dd1f7fc73476b74b7608
+  metadata.gz: 19ad06f15553f22b78e77f182ba857181dbc2eb8
+  data.tar.gz: 2aa9841812c6d4d0f731bbb8ef15de6904b45454
 SHA512:
-  metadata.gz: 662a10474c372620681c94591b10f04fa6e0d7b80a600a627c81ebca387b8d8665e300979fafe172ec3b61ab7e97929e579444cf279ac71db768cc2fd9486ae4
-  data.tar.gz: 33790183dd1a4c81b13d97a2041044cb72d5d8d22fc7e86b678c353c3c20256d867c16f3e1e74c349b9164af132e4b746843dafdfc90178aa3ea2def1a114e56
+  metadata.gz: 9a07686e7c7e5085071122186ec7f88b0b687de47593edfe5655a84c73b5b86ec4a02f7e82bae56f9ee4d8bd61b9d215bdd49d2fd60e6dfc2a65b6f13ee03b65
+  data.tar.gz: 97125bca25ce2e56f0de941aa9daa19a236eb8d93b90cc24ba0afda6dee1b23e4d54848c09ce782d4cb882be8ae2fd9fb80fe3dc775dcf0143bcd58845c03814

data/.gitignore

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

data/.travis.yml

@@ -5,22 +5,29 @@ cache: bundler
 sudo: false
 
 rvm:
-  - 2.4.0
-  - 2.3.3
-  - 2.2
-  - 2.1
-  - 2.0
+  - ruby-head
+  - 2.5.1
+  - 2.4.4
+  - 2.3.7
 
 gemfile:
-  - gemfiles/jekyll_v1.gemfile
-  - gemfiles/jekyll_v2.gemfile
   - gemfiles/jekyll_v3.gemfile
+  - gemfiles/jekyll_v2.gemfile
+  - gemfiles/jekyll_v1.gemfile
 
 matrix:
   exclude:
-    - rvm: 1.9.3
-      gemfile: gemfiles/jekyll_v3.gemfile
-    - rvm: 2.4.0
+    - rvm: ruby-head
+      gemfile: gemfiles/jekyll_v2.gemfile
+    - rvm: ruby-head
+      gemfile: gemfiles/jekyll_v1.gemfile
+    - rvm: 2.5.1
+      gemfile: gemfiles/jekyll_v2.gemfile
+    - rvm: 2.5.1
       gemfile: gemfiles/jekyll_v1.gemfile
-    - rvm: 2.4.0
+    - rvm: 2.4.4
       gemfile: gemfiles/jekyll_v2.gemfile
+    - rvm: 2.4.4
+      gemfile: gemfiles/jekyll_v1.gemfile
+  allow_failures:
+    - rvm: ruby-head

data/Appraisals

@@ -4,10 +4,8 @@ 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.1'
-  gem 'listen', '< 3.1.0' if RUBY_VERSION <= '2.2'
+  gem 'jekyll', '~> 3.8'
 end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2013-2017 Marc Anguera Insa
+Copyright 2013-2018 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

@@ -1,186 +1,206 @@
 # Jekyll-Timeago
 
-[![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)
+[![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)
+[![Maintainability](https://api.codeclimate.com/v1/badges/a8be458ba0532c2d057d/maintainability)](https://codeclimate.com/github/markets/jekyll-timeago/maintainability)
 
-> A Ruby library to compute distance of dates in words. Originally built for Jekyll, as a Liquid extension.
+> A Ruby library to compute distance of dates in words, with localization support. Originally built for Jekyll.
 
 Main features:
 
-* 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.
+* 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
+* Command line utility
 
-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).
+In fact, `jekyll-timeago` started 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 on any Ruby project.
+
+Read more about the Jekyll integration [in this section](#jekyll-integration).
 
 ## Installation
 
-You have different options to install and plugging it into Jekyll projects:
+Add this line to your application's Gemfile:
 
-**Via Jekyll plugin system (recommended)**
+```ruby
+gem 'jekyll-timeago'
+```
 
-Install the `gem` to your system:
+And then execute:
 
-```
-gem install jekyll-timeago
-```
+    > bundle install
 
-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:
+Or install it yourself as:
 
-```
-gems:
-  - jekyll-timeago
-```
+    > gem install jekyll-timeago
 
-**Via Bundler**
+## Usage
 
-Add this gem to your `Gemfile` and run `bundle install`:
+The gem provides the `#timeago` method:
 
 ```ruby
-group :jekyll_plugins do
-  gem 'jekyll-timeago'
-end
+Jekyll::Timeago.timeago(from, to = Date.today, options = {})
 ```
 
-**Manually (less recommended)**
-
-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.
+Examples:
 
-## Usage
+```ruby
+>> Jekyll::Timeago.timeago(Date.today)
+=> "today"
+>> Jekyll::Timeago.timeago(Date.today.prev_day)
+=> "yesterday"
+>> Jekyll::Timeago.timeago(Date.today.prev_day(10))
+=> "1 week and 3 days ago"
+>> Jekyll::Timeago.timeago(Date.today.prev_day(100))
+=> "3 months and 1 week ago"
+>> Jekyll::Timeago.timeago(Date.today.prev_day(500))
+=> "1 year and 4 months ago"
+>> Jekyll::Timeago.timeago('2010-1-1', '2012-1-1')
+=> "2 years ago"
+>> Jekyll::Timeago.timeago(Date.today.next_day)
+=> "tomorrow"
+>> Jekyll::Timeago.timeago(Date.today.next_day(7))
+=> "in 1 week"
+>> Jekyll::Timeago.timeago(Date.today.next_day(1000))
+=> "in 2 years and 8 months"
+```
 
-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:
+**NOTE** If you have the gem installed in your system, and you're not using Bundler (probably because you're are writing a basic script), don't forget to require the library first:
 
-**Filter example**:
+```ruby
+require 'jekyll-timeago'
 
-```html
-<p>{{ page.date | timeago }}</p>
+puts Jekyll::Timeago.timeago('2030-1-1')
 ```
 
-Passing a parameter:
+### Options
 
-```html
-<p>{{ page.date | timeago: '2020-1-1' }}</p>
-```
+* `locale`
 
-**Tag example**:
+To use a different language:
 
-```html
-<p>{% timeago 2000-1-1 %}</p>
+```ruby
+>> Jekyll::Timeago.timeago(Date.today.prev_day(200), locale: :es)
+=> "hace 6 meses y 2 semanas"
+>> Jekyll::Timeago.timeago(Date.today.prev_day(200), locale: :fr)
+=> "il y a environ 6 mois et 2 semaines"
 ```
 
-Passing a second parameter:
+Read more about the localization options [here](#i18n).
 
-```html
-<p>{% timeago 2000-1-1 2010-1-1 %}</p>
+* `depth`
+
+You are able to change the level of detail (from 1 up to 4, 2 by default) to get higher or lower granularity:
+
+```ruby
+>> Jekyll::Timeago.timeago(Date.today.prev_day(2000), depth: 3)
+=> "5 years, 5 months and 3 weeks ago"
+>> Jekyll::Timeago.timeago(Date.today.prev_day(2000), depth: 4)
+=> "5 years, 5 months, 3 weeks and 4 days ago"
 ```
 
-## Localization
+## I18n
 
-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.
+By default, `jekyll-timego` already provides translations for some languages. You can check the list [here](lib/locales/). However, you are able to provide your own translations, or even override the originals, easily.
 
-English example (default):
+This project uses the [mini_i18n](https://github.com/markets/mini_i18n) gem under the hood to deal with translations. You can read further about all options in [its docs](https://github.com/markets/mini_i18n#usage). Example:
 
+```ruby
+MiniI18n.configure do |config|
+  config.load_translations('/path_to_your_translations_files/*.yml')
+  config.default_locale = :en
+end
 ```
-jekyll_timeago:
-  depth: 2 # Level of detail
-  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'
+
+If you want to contribute and support more languages by default, please feel free to send a pull request.
+
+## CLI
+
+```
+> jekyll-timeago 2016-1-1
+2 years and 6 months ago
+> jekyll-timeago 2016-1-1 --locale fr
+il y a environ 2 années et 6 mois
 ```
 
-**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`.
+### Console
 
-## Level of detail (Depth)
+Starts a custom IRB session with the `#timeago` method included:
 
-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:
+```
+> jekyll-timeago --console
+>> timeago(Date.today)
+=> "today"
+```
+
+## Jekyll integration
 
-* Depth => 1 `1 year ago`
-* Depth => 2 `1 year and 4 months ago` (default)
-* Depth => 3 `1 year, 4 months and 1 week ago`
-* Depth => 4 `1 year, 4 months, 1 week and 4 days ago`
+You have different options to install and use `jekyll-timeago` into your Jekyll project:
 
-## Usage outside Jekyll
+**Via Jekyll plugin system (recommended)**
 
-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:
+Install the `gem` to your system:
 
-```ruby
-Jekyll::Timeago::Core.timeago(from, to, options)
+```
+> gem install jekyll-timeago
 ```
 
-Note, that you can use the `options` parameter (must be a `Hash` and be passed as the last parameter) to override the default localization or the level of detail, e.g.:
+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:
 
-```ruby
-options = {
-  "depth"  => 3,
-  "prefix" => "hace",
-  "months" => "meses",
-  "and"    => "y",
-  "week"   => "semana",
-  "suffix" => nil
-}
+```yaml
+gems:
+  - jekyll-timeago
 ```
 
-Or if you have the gem installed in your system and you're not using Bundler:
+**Via Bundler**
+
+Add this gem to your `Gemfile` and run `bundle install`:
 
 ```ruby
-require 'jekyll-timeago'
-puts Jekyll::Timeago::Core.timeago(from, to, options)
+group :jekyll_plugins do
+  gem 'jekyll-timeago'
+end
 ```
 
-## CLI
+### Usage
+
+**Liquid Filter**:
 
+```html
+<p>{{ page.date | timeago }}</p>
+<p>{{ page.date | timeago: '2020-1-1' }}</p>
 ```
-$ jekyll-timeago 2016-1-1
-2 months and 6 days ago
+
+**Liquid Tag**:
+
+```html
+<p>{% timeago 2000-1-1 %}</p>
+<p>{% timeago 2000-1-1 2010-1-1 %}</p>
 ```
 
-### Console
+### Configuration
 
-Run `$ jekyll-timeago --console` to start a custom IRB session and play with the `timeago` method:
+In your `_config.yml` file:
 
-```ruby
->> timeago(Date.today)
-=> "today"
->> timeago(Date.today.prev_day)
-=> "yesterday"
->> timeago(Date.today.prev_day(10))
-=> "1 week and 3 days ago"
->> timeago(Date.today.prev_day(100))
-=> "3 months and 1 week ago"
->> timeago(Date.today.prev_day(500))
-=> "1 year and 4 months ago"
->> timeago('2010-1-1', '2012-1-1')
-=> "2 years ago"
->> timeago(Date.today.next_day)
-=> "tomorrow"
->> timeago(Date.today.next_day(7))
-=> "in 1 week"
->> timeago(Date.today.next_day(1000))
-=> "in 2 years and 8 months"
+```
+jekyll_timeago:
+  depth: 2
+  translations_path: '/path_to_your_translations/*.yaml'
+  default_locale: 'en'
+  fallbacks: true
+  available_locales:
+    - 'en'
+    - 'es'
+    - 'fr'
 ```
 
-You can modify globally, via the `configure` method, all the available options:
+Also, you can set a different language per page using the [Front Matter](https://jekyllrb.com/docs/frontmatter/) functionality:
 
-```ruby
->> configure({ "yesterday" => "ayer" })
-=> "ayer"
->> timeago(Date.today.prev_day)
-=> "ayer"
+```yaml
+---
+locale: 'es'
+---
 ```
 
 ## Development
@@ -190,10 +210,10 @@ 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
+> bundle exec appraisal rake
 ```
 
-`Appraisal` library is used to ensure compatibility with different Jekyll versions. Check out current supported versions [here](Appraisals).
+We use the `Appraisal` gem to ensure compatibility with different Jekyll versions. Check out current supported versions [here](Appraisals).
 
 ## License
 

data/bin/jekyll-timeago

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
 
-require_relative "../lib/jekyll-timeago/core"
-include Jekyll::Timeago::Core
+require "bundler/setup"
+require_relative "../lib/jekyll-timeago"
+include Jekyll::Timeago
 
 help_message = <<END
 Usage:
@@ -12,16 +13,36 @@ Notes:
         [to_date] Optional, defaults to current date
 
 Options:
-        --help, -h  Print this message
-        --console   Start an interactive session with jekyll-timeago included
+        --help, -h      Prints this message
+        --version, -v   Prints the current version
+        --console, -c   Starts an interactive IRB session with jekyll-timeago included
+        --locale, -l    Uses the provided locale
 END
 
 if ARGV.empty? || ARGV.include?("--help") || ARGV.include?("-h")
   puts help_message
-elsif ARGV.include? "--console"
+elsif ARGV.include?("--version") || ARGV.include?("-v")
+  puts "v#{Jekyll::Timeago::VERSION}"
+elsif ARGV.include?("--console") || ARGV.include?("-c")
   require "irb"
   ARGV.clear
   IRB.start
 else
-  puts timeago *ARGV
+  custom_locale = "--locale" if ARGV.include?("--locale")
+  custom_locale = "-l" if ARGV.include?("-l")
+
+  if custom_locale
+    index = ARGV.index(custom_locale)
+    locale = ARGV.delete_at(index + 1)
+    ARGV.delete_at(index)
+
+    options = { locale: locale }
+    ARGV << options
+  end
+
+  begin
+    puts timeago *ARGV
+  rescue ArgumentError => e
+    puts "ERROR! #{e}"
+  end
 end

data/gemfiles/jekyll_v2.gemfile

@@ -3,6 +3,5 @@
 source "https://rubygems.org"
 
 gem "jekyll", "~> 2.5"
-gem "listen", "< 3.1.0"
 
 gemspec :path => "../"

data/gemfiles/jekyll_v3.gemfile

@@ -2,7 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "jekyll", "~> 3.1"
-gem "listen", "< 3.1.0"
+gem "jekyll", "~> 3.8"
 
 gemspec :path => "../"

data/jekyll-timeago.gemspec

@@ -15,9 +15,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "mini_i18n", '~> 0.3.1'
+
   spec.add_development_dependency "jekyll", ">= 1.5"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "byebug"
 end

data/lib/jekyll-timeago.rb

@@ -1,10 +1,17 @@
-require 'jekyll-timeago/core'
-require 'jekyll-timeago/version'
+require 'mini_i18n'
+require_relative 'jekyll-timeago/version'
+require_relative 'jekyll-timeago/core'
 
-if defined?(Liquid)
-  require 'jekyll-timeago/filter'
-  require 'jekyll-timeago/tag'
+if defined?(Jekyll) && defined?(Liquid)
+  require_relative 'jekyll-timeago/jekyll_integration'
+end
 
-  Liquid::Template.register_filter(Jekyll::Timeago::Filter)
-  Liquid::Template.register_tag('timeago', Jekyll::Timeago::Tag)
+module Jekyll
+  module Timeago
+    include Jekyll::Timeago::Core
+  end
+end
+
+MiniI18n.configure do |config|
+  config.load_translations(__dir__ + '/locales/*.yml')
 end

data/lib/jekyll-timeago/core.rb

@@ -27,57 +27,28 @@ module Jekyll
           to = Date.today
         end
 
-        @defaults = defaults unless defined?(@defaults)
-        @options = @defaults.merge(options)
+        @options = options
 
-        from  = validate_date!(from)
-        to    = validate_date!(to)
-        depth = validate_depth!(@options["depth"])
+        from  = validate_date(from)
+        to    = validate_date(to)
+        depth = validate_depth(@options[:depth] || @options["depth"])
 
         time_ago_to_now(from, to, depth)
       end
 
-      def configure(options = {})
-        @defaults = defaults.merge(options)
-      end
-
       private
 
-      def validate_date!(date)
+      def validate_date(date)
         Date.parse(date.to_s)
       end
 
-      def validate_depth!(depth)
-        (1..MAX_DEPTH_LEVEL).include?(depth) or raise(ArgumentError, "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'
-        }
+      def validate_depth(depth)
+        (1..MAX_DEPTH_LEVEL).include?(depth) ? depth : DEFAULT_DEPTH_LEVEL
       end
 
-      def translate(key)
-        @options[key.to_s]
+      def t(key)
+        MiniI18n.translate(key, @options)
       end
-      alias_method :t, :translate
 
       # Days passed to time ago sentence
       def time_ago_to_now(from, to, depth)

data/lib/jekyll-timeago/jekyll_integration.rb

@@ -0,0 +1,59 @@
+module Jekyll
+  module Timeago
+    @@jekyll_initialized = nil
+
+    def self.jekyll_config(context)
+      @@jekyll_config ||= context.registers[:site].config['jekyll_timeago'] || {}
+    end
+
+    def self.jekyll_page_data(context)
+      options = jekyll_config(context)
+      locale = context['page']['locale']
+
+      options[:locale] = locale if locale
+
+      if !@@jekyll_initialized
+        MiniI18n.configure do |config|
+          if options['translations_path']
+            path = context.registers[:site].source + options['translations_path']
+            config.load_translations(path)
+          end
+
+          config.available_locales = options['available_locales']
+          config.default_locale = options['default_locale']
+          config.fallbacks = options['fallbacks']
+        end
+
+        @@jekyll_initialized = true
+      end
+
+      options
+    end
+
+    module Filter
+      def timeago(from, to = Date.today)
+        options = Jekyll::Timeago.jekyll_page_data(@context)
+
+        Core.timeago(from, to, options)
+      end
+    end
+
+    class Tag < Liquid::Tag
+      def initialize(tag_name, dates, tokens)
+        super
+        @dates = dates.strip.split(' ')
+      end
+
+      def render(context)
+        options = Jekyll::Timeago.jekyll_page_data(context)
+
+        from, to = @dates[0], @dates[1]
+        to = options if to.nil?
+        Core.timeago(from, to, options)
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::Timeago::Filter)
+Liquid::Template.register_tag('timeago', Jekyll::Timeago::Tag)

data/lib/jekyll-timeago/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Timeago
-    VERSION = "0.9.2"
+    VERSION = "0.10.0"
   end
 end

data/lib/{jekyll-timeago/config/_config.yml.example.en → locales/en.yml}

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

data/lib/{jekyll-timeago/config/_config.yml.example.es → locales/es.yml}

@@ -1,5 +1,4 @@
-jekyll_timeago:
-  depth: 2 # Nivel de detalle
+es:
   today: 'hoy'
   yesterday: 'ayer'
   tomorrow: 'mañana'

data/lib/{jekyll-timeago/config/_config.yml.example.fr → locales/fr.yml}

@@ -1,5 +1,4 @@
-jekyll_timeago:
-  depth: 2 # niveau de détail
+fr:
   today: "aujourd'hui"
   yesterday: "hier"
   tomorrow: "demain"
@@ -16,4 +15,3 @@ jekyll_timeago:
   week: "semaine"
   days: "jours"
   day: "jour"
-

data/lib/locales/pt.yml

@@ -0,0 +1,17 @@
+pt:
+  today: 'hoje'
+  yesterday: 'ontem'
+  tomorrow: 'amanhã'
+  and: 'e'
+  suffix: 'atrás'
+  prefix: ''
+  suffix_future: ''
+  prefix_future: 'em'
+  years: 'anos'
+  year: 'ano'
+  months: 'meses'
+  month: 'mês'
+  weeks: 'semanas'
+  week: 'semanas'
+  days: 'dias'
+  day: 'dia'

data/spec/jekyll-timeago_spec.rb

@@ -14,20 +14,20 @@ describe Jekyll::Timeago do
     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'])
+      expect(site.config['jekyll_timeago']).to eq(configuration_file['jekyll_timeago'])
     end
 
     it 'process successfully the site using filters and tags' do
       allow(Date).to receive(:today) { Date.new(2016, 1, 1) }
       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"))
+      expected =
+        "<p>2 años</p>\n"\
+        "<p>12 meses</p>\n"\
+        "<p>12 meses</p>\n"\
+        "<p>2 años</p>"
+
+      expect(contents).to eq(expected)
     end
   end
 
@@ -35,64 +35,42 @@ describe Jekyll::Timeago 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(ArgumentError)
-    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.prev_day)).to eql("yesterday")
-      expect(timeago(today)).to eql("today")
-      expect(timeago(today.next_day)).to eql("tomorrow")
+      expect(timeago(today.prev_day)).to eq("yesterday")
+      expect(timeago(today)).to eq("today")
+      expect(timeago(today.next_day)).to eq("tomorrow")
     end
 
     it 'past time' do
-      expect(timeago(sample_date.prev_day(10), sample_date)).to eql('1 week and 3 days ago')
-      expect(timeago(sample_date.prev_day(100), sample_date)).to eql('3 months and 1 week ago')
-      expect(timeago(sample_date.prev_day(500), sample_date)).to eql('1 year and 4 months ago')
+      expect(timeago(sample_date.prev_day(10), sample_date)).to eq('1 week and 3 days ago')
+      expect(timeago(sample_date.prev_day(100), sample_date)).to eq('3 months and 1 week ago')
+      expect(timeago(sample_date.prev_day(500), sample_date)).to eq('1 year and 4 months ago')
     end
 
     it 'future time' do
-      expect(timeago(sample_date.next_day(7), sample_date)).to eql('in 1 week')
-      expect(timeago(sample_date.next_day(1000), sample_date)).to eql('in 2 years and 9 months')
+      expect(timeago(sample_date.next_day(7), sample_date)).to eq('in 1 week')
+      expect(timeago(sample_date.next_day(1000), sample_date)).to eq('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('20100101', '20120101')).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.prev_day(500), sample_date)).to eql('1')
+      expect(timeago('2010-1-1', '2012-1-1')).to eq('2 years ago')
+      expect(timeago('2010/1/1', '2012/1/1')).to eq('2 years ago')
+      expect(timeago('Jan 2010, 1', 'Jan 2012, 1')).to eq('2 years ago')
+      expect(timeago('20100101', '20120101')).to eq('2 years ago')
+      expect(timeago('2014-10-06 20:00:00', '2014-10-07 20:00:00')).to eq('yesterday')
     end
 
     it 'allow to change level of detail' do
-      expect(timeago(sample_date.prev_day(500), sample_date, "depth" => 1)).to eql('1 year ago')
-      expect(timeago(sample_date.prev_day(500), sample_date, "depth" => 3)).to eql('1 year, 4 months and 2 weeks ago')
-      expect(timeago(sample_date.prev_day(500), sample_date, "depth" => 4)).to eql('1 year, 4 months, 2 weeks and 1 day ago')
+      expect(timeago(sample_date.prev_day(500), sample_date, depth: 1)).to eq('1 year ago')
+      expect(timeago(sample_date.prev_day(500), sample_date, "depth" => 1)).to eq('1 year ago')
+      expect(timeago(sample_date.prev_day(500), sample_date, depth: 2)).to eq('1 year and 4 months ago')
+      expect(timeago(sample_date.prev_day(500), sample_date, depth: 3)).to eq('1 year, 4 months and 2 weeks ago')
+      expect(timeago(sample_date.prev_day(500), sample_date, depth: 4)).to eq('1 year, 4 months, 2 weeks and 1 day ago')
+      expect(timeago(sample_date.prev_day(500), sample_date, depth: 5)).to eq('1 year and 4 months ago')
     end
 
     it 'allow localization' do
-      new_options = {
-        "prefix" => 'hace',
-        "months" => 'meses',
-        "and"    => 'y',
-        "week"   => 'semana',
-        "suffix" => nil
-      }
-
-      expect(timeago(sample_date.prev_day(100), sample_date, new_options)).to eql('hace 3 meses y 1 semana')
+      expect(timeago(sample_date.prev_day(100), sample_date, locale: :fr)).to eq('il y a environ 3 mois et 1 semaine')
     end
   end
 
@@ -102,8 +80,22 @@ describe Jekyll::Timeago do
       expect(`jekyll-timeago --help`).to match("Usage")
     end
 
+    it 'prints current version' do
+      expect(`jekyll-timeago -v`).to match("v#{Jekyll::Timeago::VERSION}")
+      expect(`jekyll-timeago --version`).to match("v#{Jekyll::Timeago::VERSION}")
+    end
+
     it 'computes distance of dates' do
       expect(`jekyll-timeago 2016-1-1 2016-1-5`).to match("4 days ago")
     end
+
+    it 'prints error with invalid date' do
+      expect(`jekyll-timeago 1`).to match("ERROR!")
+    end
+
+    it 'with custom locale' do
+      expect(`jekyll-timeago 2016-1-1 2016-1-5 -l fr`).to match("il y a environ 4 jours")
+      expect(`jekyll-timeago 2016-1-1 2016-1-5 --locale fr`).to match("il y a environ 4 jours")
+    end
   end
 end

data/spec/source/_config.yml

@@ -3,19 +3,9 @@ gems:
 
 jekyll_timeago:
   depth: 1
-  today: 'today'
-  yesterday: 'yesterday'
-  tomorrow: 'tomorrow'
-  and: 'and'
-  suffix: 'yeah'
-  prefix: ''
-  suffix_future: ''
-  prefix_future: 'in'
-  years: 'years'
-  year: 'year'
-  months: 'months'
-  month: 'month'
-  weeks: 'weeks'
-  week: 'week'
-  days: 'days'
-  day: 'day'
+  translations_path: "/_locales/*.yaml"
+  default_locale: 'en'
+  available_locales:
+    - 'en'
+    - 'es'
+    - 'fr'

data/spec/source/_locales/overrides.yaml

@@ -0,0 +1,2 @@
+es:
+  prefix: ''

data/spec/source/index.html

@@ -1,4 +1,5 @@
 ---
+locale: 'es'
 ---
 
 <p>{% timeago 2014-1-1 %}</p>

data/spec/spec_helper.rb

@@ -1,11 +1,9 @@
 require 'fileutils'
 require 'jekyll'
-require File.expand_path('lib/jekyll-timeago')
+require 'jekyll-timeago'
 
 RSpec.configure do |config|
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
-  config.order = 'random'
+  config.order = :random
 
   SOURCE_DIR = File.expand_path('../source', __FILE__)
   DEST_DIR   = File.expand_path('../_site', __FILE__)

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-timeago
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.10.0
 platform: ruby
 authors:
 - markets
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-04 00:00:00.000000000 Z
+date: 2018-07-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: mini_i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: A Ruby library to compute distance of dates in words. Originally built
   for Jekyll, as a Liquid extension. It also supports localization and futures.
 email:
@@ -102,15 +130,16 @@ files:
 - 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/jekyll_integration.rb
 - lib/jekyll-timeago/version.rb
+- lib/locales/en.yml
+- lib/locales/es.yml
+- lib/locales/fr.yml
+- lib/locales/pt.yml
 - spec/jekyll-timeago_spec.rb
 - spec/source/_config.yml
+- spec/source/_locales/overrides.yaml
 - spec/source/index.html
 - spec/spec_helper.rb
 homepage: https://github.com/markets/jekyll-timeago
@@ -133,12 +162,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A date helper to compute distance of dates in words.
 test_files:
 - spec/jekyll-timeago_spec.rb
 - spec/source/_config.yml
+- spec/source/_locales/overrides.yaml
 - spec/source/index.html
 - spec/spec_helper.rb

data/lib/jekyll-timeago/filter.rb

@@ -1,11 +0,0 @@
-module Jekyll
-  module Timeago
-    module Filter
-      def timeago(from, to = Date.today)
-        config = @context.registers[:site].config.fetch('jekyll_timeago', {})
-
-        Jekyll::Timeago::Core.timeago(from, to, config)
-      end
-    end
-  end
-end

data/lib/jekyll-timeago/tag.rb

@@ -1,21 +0,0 @@
-module Jekyll
-  module Timeago
-    class Tag < Liquid::Tag
-      def initialize(tag_name, dates, tokens)
-        super
-        @dates = dates.strip.split(' ')
-      end
-
-      def render(context)
-        from, to = @dates[0], @dates[1]
-        config = context.registers[:site].config.fetch('jekyll_timeago', {})
-
-        if to
-          Jekyll::Timeago::Core.timeago(from, to, config)
-        else
-          Jekyll::Timeago::Core.timeago(from, config)
-        end
-      end
-    end
-  end
-end