jekyll-timeago 0.12.3 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a7f64001d4339005b10a76ade11cbd172de94b04cf612df66cdb854cd4ddb10
-  data.tar.gz: b76814cbbc3aafa0f418fa13b1ebdab98d7d8cda3e49bd25404ae5de1b304301
+  metadata.gz: e0d0a282e371c82c7a78ec06daf099ab43248b2164f4eeb2f3ccb99936e266dd
+  data.tar.gz: c0b57570ebd40598b83b62e9cb46cae40b7922923382bc03bc11359680ff7964
 SHA512:
-  metadata.gz: 5164c7ffbfd45f036a692249d98a9ef5af101f2789b62fb46fbabb60468185f9e7556a9936268cf7939524f516361feba8651fe3a0de641893bf4c63bf919d1f
-  data.tar.gz: e7c74022476314a128f510c7e8ae34af8dd0b57b5689273c9c293bc636ad5c4b9618b05a57976670396c510234fe43680ae29d0deab9772a942be6131974d9e8
+  metadata.gz: dcfd9bc02249b9ae0309130506b4cd13b05b13a1cf3777fa4059c3610d6121c4fa62043a4efd2dbabbe51f2c3796973006846853a2a65fc6aa56e78d0eecba95
+  data.tar.gz: 9e7ab93694539ab08bd0df48289c784ae08d41726589af4a5e9d9f72df7a325a950eb07aed2c228af613a8f45b05c369fa765e2fade737c8d55ba8c8dd0ffba0

data/.travis.yml

@@ -1,33 +1,20 @@
 language: ruby
-
 cache: bundler
-
-sudo: false
-
 rvm:
   - ruby-head
-  - 2.5.3
+  - 2.6.3
+  - 2.5.5
   - 2.4.5
   - 2.3.8
 
 gemfile:
   - gemfiles/jekyll_v3.gemfile
-  - gemfiles/jekyll_v2.gemfile
-  - gemfiles/jekyll_v1.gemfile
 
 matrix:
-  exclude:
-    - rvm: ruby-head
-      gemfile: gemfiles/jekyll_v2.gemfile
-    - rvm: ruby-head
-      gemfile: gemfiles/jekyll_v1.gemfile
-    - rvm: 2.5.3
-      gemfile: gemfiles/jekyll_v2.gemfile
-    - rvm: 2.5.3
-      gemfile: gemfiles/jekyll_v1.gemfile
-    - rvm: 2.4.5
+  include:
+    - rvm: 2.3.8
       gemfile: gemfiles/jekyll_v2.gemfile
-    - rvm: 2.4.5
+    - rvm: 2.3.8
       gemfile: gemfiles/jekyll_v1.gemfile
   allow_failures:
     - rvm: ruby-head

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,6 +14,7 @@ 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 on any Ruby project and even as a tool from the [terminal](#cli)!
 
@@ -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.

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/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])
 
-        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.3"
+    VERSION = "0.13.0"
   end
 end

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
@@ -71,6 +72,10 @@ 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 месяца и неделю назад')

data/spec/source/_config.yml

@@ -3,6 +3,7 @@ plugins:
 
 jekyll_timeago:
   depth: 1
+  threshold: 0.01
   translations_path: "/_locales/*.yaml"
   default_locale: 'en'
   available_locales:

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.3
+  version: 0.13.0
 platform: ruby
 authors:
 - markets
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-17 00:00:00.000000000 Z
+date: 2019-05-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:
     - - ">="
@@ -165,8 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A date helper to compute distance of dates in words.