jekyll-timeago 0.7.0 → 0.8.0

data/.gitignore

@@ -1,3 +1,5 @@
 pkg
 .rvmrc
-Gemfile.lock
+Gemfile.lock
+spec/_site
+.rpsec

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.0
+  - 1.9.3

data/README.md

@@ -1,6 +1,6 @@
 # Jekyll-Timeago
 
-[![Gem Version](https://badge.fury.io/rb/jekyll-timeago.svg)](http://badge.fury.io/rb/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)
 
 Custom and simple implementation of `timeago` date filter. Main features:
 
@@ -12,8 +12,8 @@ Custom and simple implementation of `timeago` date filter. 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).
 
-
 ## Installation
+
 You have 3 options to install the plugin:
 
 **Via Jekyll plugin system**
@@ -51,25 +51,20 @@ Bundler.require(:default)
 
 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!
 
-
 ## 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.
 
 **Filter example**:
 
 ```html
-<span>{{ page.date | timeago }}</span>
-<h2>{{ page.title }}</h2>
-
-<div class="post">
-  {{ content }}
-</div>
+<p>{{ page.date | timeago }}</p>
 ```
 
 Passing a parameter:
 
 ```html
-<span>{{ page.date | timeago: '2020-1-1' }}</span>
+<p>{{ page.date | timeago: '2020-1-1' }}</p>
 ```
 
 **Tag example**:
@@ -81,11 +76,11 @@ Passing a parameter:
 Passing a second parameter:
 
 ```html
-<p>{% timeago 2000-1-1 20010-1-1 %}</p>
+<p>{% timeago 2000-1-1 2010-1-1 %}</p>
 ```
 
-
 ## 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:
 
 ```
@@ -109,8 +104,8 @@ jekyll_timeago:
   day: 'day'
 ```
 
-
 ## Level of detail (Depth)
+
 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:
 
 * Depht => 1 `1 year ago`
@@ -118,8 +113,8 @@ 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
+
 Run `script/console` to start a custom IRB session and play with `timeago` method:
 
 ```ruby
@@ -143,5 +138,15 @@ Run `script/console` to start a custom IRB session and play with `timeago` metho
 => "in 2 years and 8 months"
 ```
 
+Play with `options`:
+
+```ruby
+>> options[:yesterday] = "ayer"
+=> "ayer"
+>> timeago(Date.today - 1.day)
+=> "ayer"
+```
+
 ## License
+
 Copyright (c) 2013-2014 Marc Anguera. Jekyll-Timeago is released under the [MIT](LICENSE) License.

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/jekyll-timeago.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Jekyll::Timeago::VERSION
   spec.authors       = ["markets"]
   spec.email         = ["srmarc.ai@gmail.com"]
-  spec.description   = %q{Custom timeago filter for Jekyll (Liquid filter). Localization and futures supported.}
-  spec.summary       = %q{Custom timeago filter for Jekyll (Liquid filter). Localization and futures supported.}
+  spec.description   = "Custom timeago filter for Jekyll (Liquid Filter and Tag). Localization and futures supported."
+  spec.summary       = "Custom timeago filter for Jekyll (Liquid Filter and Tag). Localization and futures supported."
   spec.homepage      = "https://github.com/markets/jekyll-timeago"
   spec.license       = "MIT"
 
@@ -18,6 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  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 "activesupport"
 end

data/lib/jekyll-timeago/filter.rb

@@ -3,6 +3,7 @@ require 'date'
 module Jekyll
   module Timeago
     module Filter
+      extend self
 
       DAYS_PER = {
         :days => 1,
@@ -28,6 +29,15 @@ module Jekyll
         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)
@@ -39,30 +49,31 @@ module Jekyll
         depth
       end
 
-      # Get plugin configuration from site. Returns an empty hash if not provided.
-      def config
-        @config ||= Jekyll.configuration({}).fetch('jekyll_timeago', {}) rescue {}
+      # Load settings from Jekyll configuration
+      def jekyll_config
+        @jekyll_config ||= Jekyll.configuration({}).fetch('jekyll_timeago', {}) rescue {}
       end
 
-      def options
-        @options ||= {
-          :depth         => config['depth'] || DEFAULT_DEPTH_LEVEL,
-          :today         => config['day'] || 'today',
-          :yesterday     => config['yesterday'] || 'yesterday',
-          :tomorrow      => config['tomorrow'] || 'tomorrow',
-          :and           => config['and'] ||'and',
-          :suffix        => config['suffix'] || 'ago',
-          :prefix        => config['prefix'] || '',
-          :suffix_future => config['suffix_future'] || '',
-          :prefix_future => config['prefix_future'] || 'in',
-          :years         => config['years'] || 'years',
-          :year          => config['year'] || 'year',
-          :months        => config['months'] || 'months',
-          :month         => config['month'] || 'month',
-          :weeks         => config['weeks'] || 'weeks',
-          :week          => config['week'] || 'week',
-          :days          => config['days'] || 'days',
-          :day           => config['day'] || 'day'
+      # Configure plugin options with defaults
+      def setup
+        @options = {
+          :depth         => jekyll_config['depth'] || DEFAULT_DEPTH_LEVEL,
+          :today         => jekyll_config['day'] || '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
 
@@ -99,7 +110,8 @@ module Jekyll
 
         time_range = days_to_time_range(days_passed)
         days       = DAYS_PER[time_range]
-        num_elems  = days_passed / days
+        num_elems  = (days_passed / days).to_i
+
         range_type = if num_elems == 1
           t(time_range[0...-1]) # singularize key
         else
@@ -107,18 +119,18 @@ module Jekyll
         end
 
         current_slots << "#{num_elems} #{range_type}"
-        pending_days  = days_passed - (num_elems*days)
+        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 0...7
+        when 1..6
           :days
-        when 7...31
+        when 7..30
           :weeks
-        when 31...365
+        when 31..365
           :months
         else
           :years

data/lib/jekyll-timeago/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Timeago
-    VERSION = "0.7.0"
+    VERSION = "0.8.0"
   end
 end

data/spec/jekyll_timeago_spec.rb

@@ -0,0 +1,81 @@
+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')
+    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

data/spec/source/_config.yml

@@ -0,0 +1,21 @@
+gems:
+  - jekyll-timeago
+
+jekyll_timeago:
+  depth: 3
+  today: 'today'
+  yesterday: 'yesterday'
+  tomorrow: 'tomorrow'
+  and: 'and'
+  suffix: 'ago'
+  prefix: ''
+  suffix_future: 'in'
+  prefix_future: ''
+  years: 'years'
+  year: 'year'
+  months: 'months'
+  month: 'month'
+  weeks: 'weeks'
+  week: 'week'
+  days: 'days'
+  day: 'day'

data/spec/source/index.html

@@ -0,0 +1,8 @@
+---
+---
+
+<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>

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+require 'fileutils'
+require 'active_support'
+require 'active_support/core_ext'
+require 'jekyll'
+require File.expand_path('lib/jekyll-timeago/filter')
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+
+  SOURCE_DIR = File.expand_path('../source', __FILE__)
+  DEST_DIR   = File.expand_path('../_site', __FILE__)
+  FileUtils.rm_rf(DEST_DIR)
+  FileUtils.mkdir_p(DEST_DIR)
+
+  def source_dir(*files)
+    File.join(SOURCE_DIR, *files)
+  end
+
+  def dest_dir(*files)
+    File.join(DEST_DIR, *files)
+  end
+
+  def configuration_file
+    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
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-timeago
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-02 00:00:00.000000000 Z
+date: 2014-07-31 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -43,8 +59,40 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Custom timeago filter for Jekyll (Liquid filter). Localization and futures
-  supported.
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    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: []
@@ -52,6 +100,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -63,6 +112,10 @@ files:
 - lib/jekyll-timeago/tag.rb
 - lib/jekyll-timeago/version.rb
 - script/console
+- spec/jekyll_timeago_spec.rb
+- spec/source/_config.yml
+- spec/source/index.html
+- spec/spec_helper.rb
 homepage: https://github.com/markets/jekyll-timeago
 licenses:
 - MIT
@@ -76,17 +129,27 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3767954602793850700
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3767954602793850700
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Custom timeago filter for Jekyll (Liquid filter). Localization and futures
-  supported.
-test_files: []
+summary: Custom timeago filter for Jekyll (Liquid Filter and Tag). Localization and
+  futures supported.
+test_files:
+- spec/jekyll_timeago_spec.rb
+- spec/source/_config.yml
+- spec/source/index.html
+- spec/spec_helper.rb