jekyll-timeago 0.3.1 → 0.4.0

data/README.md

@@ -1,22 +1,28 @@
 Jekyll-Timeago
 ==============
-Custom and simple implementation of `timeago` date filter. Futures supported.
+Custom and simple implementation of `timeago` date filter. Futures and personalization are also supported.
 
 In fact, `jekyll-timeago` is an extension of [Liquid](https://github.com/Shopify/liquid) filters, so you can use it in all your Liquid templates.
 
+
 ## Installation
-Add this gem to your Gemfile and run bundle:
+Add this gem to your `Gemfile` and run `bundle`:
+
 ```
 gem 'jekyll-timeago'
 ```
-To enable the extension add the following statement to a file in your plugin directory (_plugins/ext.rb):
-```
+
+To use this filter, just add the following to the top of another plugin (found under `_plugins/`):
+
+```ruby
 require 'jekyll/timeago'
 ```
-You can copy this [file](https://github.com/markets/jekyll-timeago/blob/master/lib/jekyll/timeago.rb) directly in your plugin directory (_plugins/) as well :)
+
+Alternatively, you can simply copy [this file](https://github.com/markets/jekyll-timeago/blob/master/lib/jekyll/timeago.rb) directly into your `_plugins/` directory! :)
+
 
 ## Usage
-```
+```html
 <span>{{ page.date | timeago }}</span>
 <h2>{{ page.title }}</h2>
 
@@ -25,23 +31,42 @@ You can copy this [file](https://github.com/markets/jekyll-timeago/blob/master/l
 </div>
 ```
 
-## Output samples
+### Customization
+You can personalize the level of detail (from 1 up to 4, 2 by default) passing a parameter:
+```html
+<span>{{ page.date | timeago: 4 }}</span>
 ```
+
+## Output Examples
+Default behavior:
+```ruby
 > timeago(Date.today)
 => "today"
 > timeago(Date.today - 1.day)
 => "yesterday"
 > timeago(Date.today - 10.days)
-=> "1 week ago"
+=> "1 week and 3 days ago"
 > timeago(Date.today - 100.days)
-=> "3 months ago"
-> timeago(Date.today - 400.days)
-=> "1 year ago"
+=> "3 months and 1 week ago"
+> timeago(Date.today - 500.days)
+=> "1 year ago and 4 months ago"
 > timeago(Date.today + 1.days)
 => "tomorrow"
-> timeago(Date.today + 10.days)
+> timeago(Date.today + 7.days)
 => "in 1 week"
 ```
 
+Change level of detail to get higher or lower granularity:
+```ruby
+> timeago(Date.today - 500.days) # default
+=> "1 year ago and 4 months ago"
+> timeago(Date.today - 500.days, 3)
+=> "1 year and 4 months and 1 week ago"
+> timeago(Date.today - 500.days, 4)
+=> "1 year and 4 months and 1 week and 4 days ago"
+> timeago(Date.today - 500.days, 1)
+=> "1 year ago"
+```
+
 ## License
-Copyright (c) 2013 Marc Anguera. Unscoped Associations is released under the [MIT](http://opensource.org/licenses/MIT) License.
+Copyright (c) 2013 Marc Anguera. Unscoped Associations is released under the [MIT](http://opensource.org/licenses/MIT) License.

data/jekyll-timeago.gemspec

@@ -20,5 +20,4 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_dependency "activesupport"
 end

data/lib/jekyll/timeago.rb

@@ -1,60 +1,88 @@
 require "jekyll/timeago/version"
-require "active_support/inflector"
 
 module Jekyll
   module Timeago
 
-    DAYS_IN = {
+    DAYS_PER = {
       :days => 1,
       :weeks => 7,
       :months => 31,
       :years => 365,
     }
 
-    def timeago(input)
-      time_ago_to_now(input)
+    # Max level of detail
+    # years > months > weeks > days
+    # 1 year and 7 months and 2 weeks and 6 days
+    MAX_DEPTH_LEVEL = 4
+
+    # Default level of detail
+    # 1 month and 5 days, 3 weeks and 2 days, 2 years and 6 months
+    DEFAULT_DEPTH_LEVEL = 2
+
+    def timeago(input, depth = DEFAULT_DEPTH_LEVEL)
+      unless depth_allowed?(depth)
+        raise "Invalid depth level: #{depth.inspect}"
+      end
+
+      unless input.is_a?(Date) || input.is_a?(Time)
+        raise "Invalid input type: #{input.inspect}"
+      end
+
+      days_passed = (Date.today - Date.parse(input.to_s)).to_i
+      time_ago_to_now(days_passed, depth)
     end
 
     private
 
-    def time_ago_to_now(date)
-      unless date.is_a?(Date) || date.is_a?(Time)
-        raise "Invalid input: #{date.inspect}"
-      end
+    def time_ago_to_now(days_passed, depth)
+      return "today"     if days_passed == 0
+      return "yesterday" if days_passed == 1
+      return "tomorrow"  if days_passed == -1
 
-      days_passed = (Date.today - Date.parse(date.to_s)).to_i
+      future     = days_passed < 0
+      slots      = build_time_ago_slots(days_passed, depth)
 
-      case days_passed.abs
-      when 0 .. 7
-        time_ago_to_s(days_passed, :days)
-      when 8 .. 31
-        time_ago_to_s(days_passed, :weeks)
-      when 32 .. 365
-        time_ago_to_s(days_passed, :months)
+      if future
+        "in #{slots.join(' and ')}"
       else
-        time_ago_to_s(days_passed, :years)
+        "#{slots.join(' and ')} ago"
       end
     end
 
-    def time_ago_to_s(days_passed, grouped_by)
-      return "today" if days_passed == 0
-      return "yesterday" if days_passed == 1
-      return "tomorrow" if days_passed == -1
+    # Builds time ranges: ['1 month', '5 days']
+    def build_time_ago_slots(days_passed, depth, current_slots = [])
+      return current_slots if depth == 0 || days_passed == 0
 
-      future = days_passed < 0
-      computed_range = days_passed.abs / Jekyll::Timeago::DAYS_IN[grouped_by]
-      grouped_by = if computed_range == 1
-        ActiveSupport::Inflector.singularize(grouped_by.to_s)
+      time_range = days_to_time_range(days_passed)
+      days       = DAYS_PER[time_range]
+      num_elems  = days_passed.abs / days
+      range_type = if num_elems == 1
+        time_range.to_s[0...-1] # singularize
       else
-        grouped_by.to_s
+        time_range.to_s
       end
 
-      if future
-        "in #{computed_range} #{grouped_by}"
+      current_slots << "#{num_elems} #{range_type}"
+      pending_days  = days_passed - (num_elems*days)
+      build_time_ago_slots(pending_days, depth - 1, current_slots)
+    end
+
+    def days_to_time_range(days_passed)
+      case days_passed.abs
+      when 0...7
+        :days
+      when 7...31
+        :weeks
+      when 31...365
+        :months
       else
-        "#{computed_range} #{grouped_by} ago"
+        :years
       end
     end
+
+    def depth_allowed?(depth)
+      (1..MAX_DEPTH_LEVEL).include?(depth)
+    end
   end
 end
 

data/lib/jekyll/timeago/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Timeago
-    VERSION = "0.3.1"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-timeago
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-03 00:00:00.000000000 Z
+date: 2013-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,22 +43,6 @@ dependencies:
     - - ! '>='
       - !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: :runtime
-  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)
 email:
 - srmarc.ai@gmail.com
@@ -88,7 +72,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -598090419
+      hash: 284869011
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -97,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -598090419
+      hash: 284869011
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24