jekyll-timeago 0.11.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0cb1b9580a2bff4f79b9aaa8800cd9ef82d0f654
-  data.tar.gz: '0931603a4e01b5e7e3a2d77c4d15366513260017'
+  metadata.gz: f57c4e0c53276d82a61f42b10703c7231c0bb6ab
+  data.tar.gz: 4a3df430759408fe8838463d1264557e9080ec66
 SHA512:
-  metadata.gz: 344bba34a825cc5441184f09ea54631718e660e14dad850fd140b25afdac0b3cbac0f874ca05def93cecbc9eac9ae8a3a41fdefa3d6a1af4fa6a5d7baac8cd12
-  data.tar.gz: 025c1ea71723a06f2e00bda1b4efbd879bb7d117a60cd54ca0a76381d01af2b5c8293504aefd0874181c3ffde9dbbbc9f2d6f22b4444a9803dbaf8bb34040846
+  metadata.gz: ed67ca75b17804ca091d0f41731cb526622653c3a9a363ce7a9d0edb507b4648fec872ff5b5effa067330b248a0e7cb5688c24d308a4de8751aea369e9606ee5
+  data.tar.gz: db9204fdae404fd4e5ebb4f90ebd357cb18621e4f8275ffd147abefd32a008200d375996da4ea6fba82f42068fffbefa2a4ee149eb662fe8c5786bb77dd48e08

data/README.md

@@ -10,9 +10,9 @@ 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
+- Out of the box support for `Jekyll` projects, available as a Liquid Filter and as a Liquid Tag
+- Localization
+- Level of detail customization
 - Command line utility
 
 In fact, `jekyll-timeago` started as an extension for the [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.
@@ -37,41 +37,48 @@ Or install it yourself as:
 
 ## Usage
 
-The gem provides the `#timeago` method:
+The gem provides the `timeago` method:
 
 ```ruby
 Jekyll::Timeago.timeago(from, to = Date.today, options = {})
 ```
 
+You can include the method in the current context by including the module (so you can call directly the `timeago` method without using the whole scope):
+
+```ruby
+include Jekyll::Timeago
+```
+
 Examples:
 
 ```ruby
->> Jekyll::Timeago.timeago(Date.today)
+>> timeago(Date.today)
 => "today"
->> Jekyll::Timeago.timeago(Date.today.prev_day)
+>> timeago(Date.today.prev_day)
 => "yesterday"
->> Jekyll::Timeago.timeago(Date.today.prev_day(10))
+>> timeago(Date.today.prev_day(10))
 => "1 week and 3 days ago"
->> Jekyll::Timeago.timeago(Date.today.prev_day(100))
+>> timeago(Date.today.prev_day(100))
 => "3 months and 1 week ago"
->> Jekyll::Timeago.timeago(Date.today.prev_day(500))
+>> timeago(Date.today.prev_day(500))
 => "1 year and 4 months ago"
->> Jekyll::Timeago.timeago('2010-1-1', '2012-1-1')
+>> timeago('2010-1-1', '2012-1-1')
 => "2 years ago"
->> Jekyll::Timeago.timeago(Date.today.next_day)
+>> timeago(Date.today.next_day)
 => "tomorrow"
->> Jekyll::Timeago.timeago(Date.today.next_day(7))
+>> timeago(Date.today.next_day(7))
 => "in 1 week"
->> Jekyll::Timeago.timeago(Date.today.next_day(1000))
+>> timeago(Date.today.next_day(1000))
 => "in 2 years and 8 months"
 ```
 
-**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:
+**NOTE** If you have the gem installed in your system globally, and you're not using Bundler (probably because you're are writing a basic script), don't forget to require the library first:
 
 ```ruby
 require 'jekyll-timeago'
+include Jekyll::Timeago
 
-puts Jekyll::Timeago.timeago('2030-1-1')
+puts timeago('2030-1-1')
 ```
 
 ### Options
@@ -81,26 +88,26 @@ puts Jekyll::Timeago.timeago('2030-1-1')
 To use a different language:
 
 ```ruby
->> Jekyll::Timeago.timeago(Date.today.prev_day(200), locale: :es)
+>> timeago(Date.today.prev_day(200), locale: :es)
 => "hace 6 meses y 2 semanas"
->> Jekyll::Timeago.timeago(Date.today.prev_day(200), locale: :fr)
+>> timeago(Date.today.prev_day(200), locale: :fr)
 => "il y a environ 6 mois et 2 semaines"
 ```
 
-Read more about the localization options [here](#i18n).
+Read more about the localization options [here](#localization).
 
 * `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)
+>> 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)
+>> timeago(Date.today.prev_day(2000), depth: 4)
 => "5 years, 5 months, 3 weeks and 4 days ago"
 ```
 
-## I18n
+## Localization
 
 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.
 
@@ -109,14 +116,16 @@ This project uses the [mini_i18n](https://github.com/markets/mini_i18n) gem unde
 ```ruby
 MiniI18n.configure do |config|
   config.load_translations('/path_to_your_translations_files/*.yml')
-  config.default_locale = :en
+  config.default_locale = :es
 end
 ```
 
-If you want to contribute and support more languages by default, please feel free to send a pull request.
+If you want to contribute and support more default languages, please feel free to send a pull request.
 
 ## CLI
 
+You can also `jekyll-timeago` from the command line:
+
 ```
 > jekyll-timeago --help
 > jekyll-timeago 2016-1-1
@@ -127,7 +136,7 @@ il y a environ 2 années et 6 mois
 
 ### Console
 
-Starts a custom IRB session with the `#timeago` method included:
+Starts a custom IRB session with the `timeago` method included:
 
 ```
 > jekyll-timeago --console

data/jekyll-timeago.gemspec

@@ -15,7 +15,7 @@ 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.4.0'
+  spec.add_dependency "mini_i18n", '>= 0.8.0'
 
   spec.add_development_dependency "jekyll", ">= 1.5"
   spec.add_development_dependency "bundler", "~> 1.3"

data/lib/jekyll-timeago/core.rb

@@ -46,10 +46,6 @@ module Jekyll
         (1..MAX_DEPTH_LEVEL).include?(depth) ? depth : DEFAULT_DEPTH_LEVEL
       end
 
-      def t(key, options = {})
-        MiniI18n.translate(key, @options.merge(options))
-      end
-
       # Days passed to time ago sentence
       def time_ago_to_now(from, to, depth)
         days_passed = (to - from).to_i
@@ -63,12 +59,16 @@ module Jekyll
         sentence = to_sentence(slots)
 
         if future
-          "#{t(:prefix_future)} #{sentence} #{t(:suffix_future)}".strip
+          t(:future, date_range: sentence)
         else
-          "#{t(:prefix)} #{sentence} #{t(:suffix)}".strip
+          t(:past, date_range: sentence)
         end
       end
 
+      def t(key, options = {})
+        MiniI18n.translate(key, @options.merge(options))
+      end
+
       # Builds time ranges: ['1 month', '5 days']
       # - days_passed: integer in absolute
       # - depth: level of detail

data/lib/jekyll-timeago/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Timeago
-    VERSION = "0.11.1"
+    VERSION = "0.12.0"
   end
 end

data/lib/locales/de.yml

@@ -2,21 +2,19 @@ de:
   today: 'heute'
   yesterday: 'gestern'
   tomorrow: 'morgen'
+  past: '%{date_range} zuvor'
+  future: 'in %{date_range}'
   last_word_connector: 'und'
   words_connector: ', '
-  suffix: 'zuvor'
-  prefix: ''
-  suffix_future: ''
-  prefix_future: 'in'
   years:
     one: '1 Jahr'
-    many: "%{count} Jahre"
+    other: "%{count} Jahre"
   months:
     one: '1 Monat'
-    many: '%{count} Monate'
+    other: '%{count} Monate'
   weeks:
     one: '1 Woche'
-    many: '%{count} Wochen'
+    other: '%{count} Wochen'
   days:
     one: '1 Tag'
-    many: '%{count} Tage'
+    other: '%{count} Tage'

data/lib/locales/en.yml

@@ -2,21 +2,19 @@ en:
   today: 'today'
   yesterday: 'yesterday'
   tomorrow: 'tomorrow'
+  past: '%{date_range} ago'
+  future: 'in %{date_range}'
   last_word_connector: 'and'
   words_connector: ', '
-  suffix: 'ago'
-  prefix: ''
-  suffix_future: ''
-  prefix_future: 'in'
   years:
     one: '1 year'
-    many: "%{count} years"
+    other: "%{count} years"
   months:
     one: '1 month'
-    many: '%{count} months'
+    other: '%{count} months'
   weeks:
     one: '1 week'
-    many: '%{count} weeks'
+    other: '%{count} weeks'
   days:
     one: '1 day'
-    many: '%{count} days'
+    other: '%{count} days'

data/lib/locales/es.yml

@@ -2,21 +2,19 @@ es:
   today: 'hoy'
   yesterday: 'ayer'
   tomorrow: 'mañana'
+  past: 'hace %{date_range}'
+  future: 'en %{date_range}'
   last_word_connector: 'y'
   words_connector: ', '
-  suffix: ''
-  prefix: 'hace'
-  suffix_future: ''
-  prefix_future: 'en'
   years:
     one: '1 año'
-    many: "%{count} años"
+    other: "%{count} años"
   months:
     one: '1 mes'
-    many: '%{count} meses'
+    other: '%{count} meses'
   weeks:
     one: '1 semana'
-    many: '%{count} semanas'
+    other: '%{count} semanas'
   days:
     one: '1 día'
-    many: '%{count} días'
+    other: '%{count} días'

data/lib/locales/fr.yml

@@ -2,21 +2,19 @@ fr:
   today: "aujourd'hui"
   yesterday: 'hier'
   tomorrow: 'demain'
+  past: 'il y a environ %{date_range}'
+  future: 'dans %{date_range}'
   last_word_connector: 'et'
   words_connector: ', '
-  suffix: ''
-  prefix: 'il y a environ'
-  suffix_future: ''
-  prefix_future: 'dans'
   years:
     one: '1 année'
-    many: "%{count} années"
+    other: "%{count} années"
   months:
     one: '1 mois'
-    many: '%{count} mois'
+    other: '%{count} mois'
   weeks:
     one: '1 semaine'
-    many: '%{count} semaines'
+    other: '%{count} semaines'
   days:
     one: '1 jour'
-    many: '%{count} jours'
+    other: '%{count} jours'

data/lib/locales/it.yml

@@ -2,21 +2,19 @@ it:
   today: 'oggi'
   yesterday: 'ieri'
   tomorrow: 'domani'
+  past: '%{date_range} fa'
+  future: 'fra %{date_range}'
   last_word_connector: 'e'
   words_connector: ', '
-  suffix: 'fa'
-  prefix: ''
-  suffix_future: ''
-  prefix_future: 'fra'
   years:
     one: '1 anno'
-    many: "%{count} anni"
+    other: "%{count} anni"
   months:
     one: '1 mese'
-    many: '%{count} mesi'
+    other: '%{count} mesi'
   weeks:
     one: '1 settimana'
-    many: '%{count} settimane'
+    other: '%{count} settimane'
   days:
     one: '1 giorno'
-    many: '%{count} giorni'
+    other: '%{count} giorni'

data/lib/locales/pt.yml

@@ -2,21 +2,19 @@ pt:
   today: 'hoje'
   yesterday: 'ontem'
   tomorrow: 'amanhã'
+  past: '%{date_range} atrás'
+  future: 'em %{date_range}'
   last_word_connector: 'e'
   words_connector: ', '
-  suffix: 'atrás'
-  prefix: ''
-  suffix_future: ''
-  prefix_future: 'em'
   years:
     one: '1 ano'
-    many: "%{count} anos"
+    other: "%{count} anos"
   months:
     one: '1 mês'
-    many: '%{count} meses'
+    other: '%{count} meses'
   weeks:
     one: '1 semana'
-    many: '%{count} semanas'
+    other: '%{count} semanas'
   days:
     one: '1 dia'
-    many: '%{count} dias'
+    other: '%{count} dias'

data/spec/source/_locales/overrides.yaml

@@ -1,2 +1,2 @@
 es:
-  prefix: ''
+  past: '%{date_range}'

data/spec/spec_helper.rb

@@ -4,6 +4,7 @@ require 'jekyll-timeago'
 
 RSpec.configure do |config|
   config.order = :random
+  config.include Jekyll::Timeago
 
   SOURCE_DIR = File.expand_path('../source', __FILE__)
   DEST_DIR   = File.expand_path('../_site', __FILE__)
@@ -21,8 +22,4 @@ RSpec.configure do |config|
   def configuration_file
     YAML.load_file(File.join(SOURCE_DIR, '_config.yml'))
   end
-
-  def timeago(from, to = Date.today, options = {})
-    Jekyll::Timeago.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.11.1
+  version: 0.12.0
 platform: ruby
 authors:
 - markets
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-04 00:00:00.000000000 Z
+date: 2018-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_i18n
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement