jekyll-timeago 0.12.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6e0b337ab84b9a0877f22bf5f4c442d6f44daace
-  data.tar.gz: c26bd56160a5effaf76a2968a96d9ee127ca4b86
+SHA256:
+  metadata.gz: 9650395244a487a5c4fb18cca3eb55076a65f2050c6d1537a54fb3202a8338ad
+  data.tar.gz: 471232c523d47eb6d7eb09cbced7e5f497bb5ed32d0382361c3d37efc2489938
 SHA512:
-  metadata.gz: e78fdab222809a2afd8d64504418bc8e620663b7bd23adad641b6f8acab3c9c4e4e7028379a6419fae924a7b131bb44b3183262e5ae6c93d466acd07ec10953a
-  data.tar.gz: 3d7932fd4153e82fa8f47b817832d01054169c70102170e086d138d148b674fe96a493200098af41cb44c62cbf701751b561478386c1cbd1b5c8ccac7d4c9b27
+  metadata.gz: 3f832ed979255fe23c548ce3cd1a6999cc8ec0518ac5acb7ae6569f99e3c105a341c13ab94ab5d681707f4018b9176dff366189c61d9748ec3388298e32a21f3
+  data.tar.gz: 56775c9e6256fa76fa214583e14cc642e2123e53d963523486391c6665a5513fc5ba4c14ecea2fcd03a9a771b7bee0998a2223ef63b80aeaf803003c4cb79e28

data/.travis.yml

@@ -1,33 +1,16 @@
 language: ruby
-
 cache: bundler
-
-sudo: false
-
 rvm:
   - ruby-head
-  - 2.5.1
-  - 2.4.4
-  - 2.3.7
+  - 2.7.2
+  - 2.6.3
+  - 2.5.5
+  - 2.4.5
 
 gemfile:
   - gemfiles/jekyll_v3.gemfile
-  - gemfiles/jekyll_v2.gemfile
-  - gemfiles/jekyll_v1.gemfile
+  - gemfiles/jekyll_v4.gemfile
 
 matrix:
-  exclude:
-    - 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.4
-      gemfile: gemfiles/jekyll_v2.gemfile
-    - rvm: 2.4.4
-      gemfile: gemfiles/jekyll_v1.gemfile
   allow_failures:
     - rvm: ruby-head

data/Appraisals

@@ -1,11 +1,7 @@
-appraise 'jekyll-v1' do
-  gem 'jekyll', '~> 1.5'
+appraise 'jekyll-v3' do
+  gem 'jekyll', '~> 3.8'
 end
 
-appraise 'jekyll-v2' do
-  gem 'jekyll', '~> 2.5'
+appraise 'jekyll-v4' do
+  gem 'jekyll', '~> 4.2'
 end
-
-appraise 'jekyll-v3' do
-  gem 'jekyll', '~> 3.8'
-end

data/Gemfile

@@ -1,3 +1,5 @@
 source 'https://rubygems.org'
 
-gemspec
+gemspec
+
+gem 'byebug', group: [:development, :test]

data/LICENSE

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

@@ -14,8 +14,9 @@ Main features:
 - Localization
 - Level of detail customization
 - Command line utility
+- Approximate distance, with customizable threshold, ie: `366 days` becomes `1 year ago` instead of `1 year and 1 day ago`
 
-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.
+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 on any Ruby project and even as a tool from the [terminal](#cli)!
 
 Read more about the `Jekyll` integration [in this section](#jekyll-integration).
 
@@ -107,6 +108,15 @@ You are able to change the level of detail (from 1 up to 4, 2 by default) to get
 => "5 years, 5 months, 3 weeks and 4 days ago"
 ```
 
+- `threshold`
+
+The next component in the time must at least match this threshold to be picked. Set to 0 by default, so you don't get any approximations. Can be used to drop "straggling" values which are too low to be of any use (`in 7 months and 2 days` is as good as saying `in 7 months`).
+
+```ruby
+>> timeago(Date.today.prev_day(366), depth: 2, threshold: 0.05)
+=> "1 year ago"
+```
+
 ## 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.
@@ -124,7 +134,7 @@ If you want to contribute and support more default languages, please feel free t
 
 ## CLI
 
-You can also `jekyll-timeago` from the command line:
+You can also use `jekyll-timeago` from the command line:
 
 ```
 > jekyll-timeago --help
@@ -159,7 +169,7 @@ Install the `gem` to your system:
 In your `_config.yml` file, add a new array with the key gems and the values of the gem names of the plugins you’d like to use. In this case:
 
 ```yaml
-gems:
+plugins:
   - jekyll-timeago
 ```
 

data/bin/jekyll-timeago

@@ -1,22 +1,21 @@
 #!/usr/bin/env ruby
 
-require "mini_i18n"
 require_relative "../lib/jekyll-timeago"
 
-help_message = <<END
-Usage:
+help_message = <<~HELP_MESSAGE
+  Usage:
 
-  jekyll-timeago <from_date> [to_date]
+    jekyll-timeago <from_date> [to_date]
 
-Notes:
-        [to_date] Optional, defaults to current date
+  Notes:
+          [to_date] Optional, defaults to current date
 
-Options:
-        --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
+  Options:
+          --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
+HELP_MESSAGE
 
 if ARGV.empty? || ARGV.include?("--help") || ARGV.include?("-h")
   puts help_message

data/gemfiles/jekyll_v3.gemfile

@@ -2,6 +2,7 @@
 
 source "https://rubygems.org"
 
+gem "byebug", group: [:development, :test]
 gem "jekyll", "~> 3.8"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/jekyll_v4.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "byebug", group: [:development, :test]
+gem "jekyll", "~> 4.2"
+
+gemspec path: "../"

data/jekyll-timeago.gemspec

@@ -5,8 +5,8 @@ Gem::Specification.new do |spec|
   spec.version       = Jekyll::Timeago::VERSION
   spec.authors       = ["markets"]
   spec.email         = ["srmarc.ai@gmail.com"]
-  spec.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."
   spec.summary       = "A date helper to compute distance of dates in words."
+  spec.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."
   spec.homepage      = "https://github.com/markets/jekyll-timeago"
   spec.license       = "MIT"
 
@@ -18,9 +18,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "mini_i18n", '>= 0.8.0'
 
   spec.add_development_dependency "jekyll", ">= 1.5"
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler"
   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

@@ -18,4 +18,16 @@ end
 
 MiniI18n.configure do |config|
   config.load_translations(__dir__ + '/locales/*.yml')
-end
+  config.pluralization_rules = {
+    ru: -> (n) {
+      r = n % 10
+      if n != 11 && r == 1
+        'one'
+      elsif !(12..14).include?(n) && (2..4).include?(r)
+        'few'
+      else
+        'other'
+      end
+    }
+  }
+end

data/lib/jekyll-timeago/core.rb

@@ -11,6 +11,9 @@ module Jekyll
       # Default level of detail
       DEFAULT_DEPTH_LEVEL = 2
 
+      # Default threshold
+      DEFAULT_THRESHOLD = 0
+
       def timeago(from, to = Date.today, options = {})
         if to.is_a?(Hash)
           options = to
@@ -19,11 +22,12 @@ module Jekyll
 
         @options = options
 
-        from  = validate_date(from)
-        to    = validate_date(to)
-        depth = validate_depth(@options[:depth] || @options["depth"])
+        from      = validate_date(from)
+        to        = validate_date(to)
+        depth     = validate_depth(@options[:depth] || @options["depth"])
+        threshold = validate_threshold(@options[:threshold] || @options["threshold"])
 
-        time_ago_to_now(from, to, depth)
+        time_ago_to_now(from, to, depth, threshold)
       end
 
       private
@@ -32,11 +36,15 @@ module Jekyll
         Date.parse(date.to_s)
       end
 
+      def validate_threshold(threshold)
+        (0.0..1.0).include?(threshold) ? threshold : DEFAULT_THRESHOLD
+      end
+
       def validate_depth(depth)
         (1..MAX_DEPTH_LEVEL).include?(depth) ? depth : DEFAULT_DEPTH_LEVEL
       end
 
-      def time_ago_to_now(from, to, depth)
+      def time_ago_to_now(from, to, depth, threshold)
         days_passed = (to - from).to_i
 
         return t(:today)     if days_passed == 0
@@ -44,7 +52,7 @@ module Jekyll
         return t(:tomorrow)  if days_passed == -1
 
         past_or_future = from < to ? :past : :future
-        slots = build_time_ago_slots(days_passed.abs, depth)
+        slots = build_time_ago_slots(days_passed.abs, depth, threshold)
 
         t(past_or_future, date_range: to_sentence(slots))
       end
@@ -56,8 +64,9 @@ module Jekyll
       # Builds time ranges: ['1 month', '5 days']
       # - days_passed: integer in absolute
       # - depth: level of detail
+      # - threshold: minimum fractional difference to keep for next slot
       # - current_slots: built time slots
-      def build_time_ago_slots(days_passed, depth, current_slots = [])
+      def build_time_ago_slots(days_passed, depth, threshold, current_slots = [])
         return current_slots if depth == 0 || days_passed == 0
 
         range     = days_to_range(days_passed)
@@ -67,7 +76,12 @@ module Jekyll
         current_slots << t(range, count: num_elems)
 
         pending_days = days_passed - (num_elems * days)
-        build_time_ago_slots(pending_days, depth - 1, current_slots)
+
+        if pending_days >= (days_passed * threshold).floor
+          build_time_ago_slots(pending_days, depth - 1, threshold, current_slots)
+        else
+          current_slots
+        end
       end
 
       def days_to_range(days)

data/lib/jekyll-timeago/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Timeago
-    VERSION = "0.12.1"
+    VERSION = "0.14.0"
   end
 end

data/lib/locales/ca.yml

@@ -0,0 +1,20 @@
+ca:
+  today: 'avui'
+  yesterday: 'ahir'
+  tomorrow: 'demà'
+  past: 'fa %{date_range}'
+  future: "d'aquí %{date_range}"
+  last_word_connector: 'i'
+  words_connector: ', '
+  years:
+    one: '1 any'
+    other: '%{count} anys'
+  months:
+    one: '1 mes'
+    other: '%{count} mesos'
+  weeks:
+    one: '1 setmana'
+    other: '%{count} setmanes'
+  days:
+    one: '1 dia'
+    other: '%{count} dies'

data/lib/locales/de.yml

@@ -8,7 +8,7 @@ de:
   words_connector: ', '
   years:
     one: '1 Jahr'
-    other: "%{count} Jahre"
+    other: '%{count} Jahre'
   months:
     one: '1 Monat'
     other: '%{count} Monate'

data/lib/locales/en.yml

@@ -8,7 +8,7 @@ en:
   words_connector: ', '
   years:
     one: '1 year'
-    other: "%{count} years"
+    other: '%{count} years'
   months:
     one: '1 month'
     other: '%{count} months'

data/lib/locales/es.yml

@@ -8,7 +8,7 @@ es:
   words_connector: ', '
   years:
     one: '1 año'
-    other: "%{count} años"
+    other: '%{count} años'
   months:
     one: '1 mes'
     other: '%{count} meses'

data/lib/locales/fr.yml

@@ -8,7 +8,7 @@ fr:
   words_connector: ', '
   years:
     one: '1 année'
-    other: "%{count} années"
+    other: '%{count} années'
   months:
     one: '1 mois'
     other: '%{count} mois'

data/lib/locales/it.yml

@@ -8,7 +8,7 @@ it:
   words_connector: ', '
   years:
     one: '1 anno'
-    other: "%{count} anni"
+    other: '%{count} anni'
   months:
     one: '1 mese'
     other: '%{count} mesi'

data/lib/locales/ja.yaml

@@ -0,0 +1,20 @@
+ja:
+  today: '今日'
+  yesterday: '昨日'
+  tomorrow: '明日'
+  past: '%{date_range}前'
+  future: '%{date_range}後'
+  last_word_connector: ''
+  words_connector: ''
+  years:
+    one: '1年'
+    other: '%{count}年'
+  months:
+    one: '1ヶ月'
+    other: '%{count}个月'
+  weeks:
+    one: '1週間'
+    other: '%{count}週間'
+  days:
+    one: '1日'
+    other: '%{count}日'

data/lib/locales/pt.yml

@@ -8,7 +8,7 @@ pt:
   words_connector: ', '
   years:
     one: '1 ano'
-    other: "%{count} anos"
+    other: '%{count} anos'
   months:
     one: '1 mês'
     other: '%{count} meses'

data/lib/locales/ru.yml

@@ -0,0 +1,24 @@
+ru:
+  today: 'сегодня'
+  yesterday: 'вчера'
+  tomorrow: 'завтра'
+  past: '%{date_range} назад'
+  future: 'через %{date_range}'
+  last_word_connector: 'и'
+  words_connector: ', '
+  years:
+    one: 'год'
+    few: '%{count} года'
+    other: '%{count} лет'
+  months:
+    one: 'месяц'
+    few: '%{count} месяца'
+    other: '%{count} месяцев'
+  weeks:
+    one: 'неделю'
+    few: '%{count} недели'
+    other: '%{count} недель'
+  days:
+    one: 'день'
+    few: '%{count} дня'
+    other: '%{count} дней'

data/lib/locales/zh_hans.yml

@@ -0,0 +1,20 @@
+zh_hans:
+  today: '今天'
+  yesterday: '昨天'
+  tomorrow: '明天'
+  past: '%{date_range}以前'
+  future: '%{date_range}以后'
+  last_word_connector: ''
+  words_connector: ''
+  years:
+    one: '1年'
+    other: '%{count}年'
+  months:
+    one: '1个月'
+    other: '%{count}个月'
+  weeks:
+    one: '1周'
+    other: '%{count}周'
+  days:
+    one: '1天'
+    other: '%{count}天'

data/spec/jekyll-timeago_spec.rb

@@ -25,7 +25,8 @@ describe Jekyll::Timeago do
         "<p>2 años</p>\n"\
         "<p>12 meses</p>\n"\
         "<p>12 meses</p>\n"\
-        "<p>2 años</p>"
+        "<p>2 años</p>\n"\
+        "<p>en 1 año</p>\n"
 
       expect(contents).to eq(expected)
     end
@@ -50,6 +51,8 @@ describe Jekyll::Timeago do
     it 'future time' do
       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')
+      expect(timeago(sample_date.next_day(7), sample_date, locale: :ru)).to eq('через неделю')
+      expect(timeago(sample_date.next_day(1000), sample_date, locale: :ru)).to eq('через 2 года и 9 месяцев')
     end
 
     it 'allow different date formats' do
@@ -69,8 +72,13 @@ describe Jekyll::Timeago do
       expect(timeago(sample_date.prev_day(500), sample_date, depth: 5)).to eq('1 year and 4 months ago')
     end
 
+    it 'allow threshold configuration' do
+      expect(timeago(sample_date.prev_day(366), sample_date, threshold: 0.05)).to eq('1 year ago')
+    end
+
     it 'allow localization' do
       expect(timeago(sample_date.prev_day(100), sample_date, locale: :fr)).to eq('il y a environ 3 mois et 1 semaine')
+      expect(timeago(sample_date.prev_day(100), sample_date, locale: :ru)).to eq('3 месяца и неделю назад')
     end
   end
 
@@ -96,6 +104,7 @@ describe Jekyll::Timeago do
     it 'with custom locale' do
       expect(`bin/jekyll-timeago 2016-1-1 2016-1-5 -l fr`).to match("il y a environ 4 jours")
       expect(`bin/jekyll-timeago 2016-1-1 2016-1-5 --locale fr`).to match("il y a environ 4 jours")
+      expect(`bin/jekyll-timeago 2016-1-1 2016-1-5 --locale ru`).to match("4 дня назад")
     end
   end
-end
+end

data/spec/source/_config.yml

@@ -1,11 +1,13 @@
-gems:
+plugins:
   - jekyll-timeago
 
 jekyll_timeago:
-  depth: 1
+  depth: 2
+  threshold: 0.05
   translations_path: "/_locales/*.yaml"
   default_locale: 'en'
   available_locales:
     - 'en'
     - 'es'
-    - 'fr'
+    - 'fr'
+    - 'ru'

data/spec/source/index.html

@@ -5,4 +5,5 @@ locale: 'es'
 <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>{{ '2014-1-1' | timeago }}</p>
+<p>{{ '2014-1-1' | timeago: '2012-12-31' }}</p>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-timeago
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.14.0
 platform: ruby
 authors:
 - markets
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-17 00:00:00.000000000 Z
+date: 2021-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_i18n
@@ -40,20 +40,6 @@ dependencies:
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -125,20 +111,23 @@ files:
 - README.md
 - Rakefile
 - bin/jekyll-timeago
-- gemfiles/jekyll_v1.gemfile
-- gemfiles/jekyll_v2.gemfile
 - gemfiles/jekyll_v3.gemfile
+- gemfiles/jekyll_v4.gemfile
 - jekyll-timeago.gemspec
 - lib/jekyll-timeago.rb
 - lib/jekyll-timeago/core.rb
 - lib/jekyll-timeago/jekyll_integration.rb
 - lib/jekyll-timeago/version.rb
+- lib/locales/ca.yml
 - lib/locales/de.yml
 - lib/locales/en.yml
 - lib/locales/es.yml
 - lib/locales/fr.yml
 - lib/locales/it.yml
+- lib/locales/ja.yaml
 - lib/locales/pt.yml
+- lib/locales/ru.yml
+- lib/locales/zh_hans.yml
 - spec/jekyll-timeago_spec.rb
 - spec/source/_config.yml
 - spec/source/_locales/overrides.yaml
@@ -163,8 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A date helper to compute distance of dates in words.

data/gemfiles/jekyll_v1.gemfile

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

data/gemfiles/jekyll_v2.gemfile

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