wiser_date 0.1.2 → 0.1.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MzhhYzA5MWQzYTE1NmYxNzhlNjhjMWZlYTljNWVlMjM2NDQ4ODE1YQ==
+    NGE0MThiYjFiMzE2MWNlY2M4NzdmZGEzZTdjZmJlNThiMDUxZDM4MA==
   data.tar.gz: !binary |-
-    OWUyNjdlZDQ0YjVkYzk1ZTNlYTRlYThmZjEyMTJjODg3ZGM0M2U4Ng==
+    NDJjMWFkMDk2M2M3NDRlMmU1ZTVjNzUwNWY2ZTI1OTUyYWUwNmU0Yg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YTU4YTY3ZGY2OTFmYjEzZDBmZDg4ZDFiYTI1ZDljYTU4NGNiNTAxYjE5NTdj
-    ZGNkMTViMTI1MGZkYTM2N2QyZDY3NzgwZGVjN2ZiM2ExN2FjMDgxMDY1ZDBl
-    OTliYWE1OTAwM2U1NzQ3MDhjMWZlNzk4ZmZmMjRlYzNkYjU1ZjQ=
+    Y2MxMDZjNGYyNzU3YzdjNDc1YWQ3YzlmNDljOTFiZjczMDNhODFmYTkxMzNm
+    NGJjMWYwYjEzY2FlMmU3NDk2MWJiOTk0NzJhYzkwMDQxNDIyZTQ4MGY5NjUw
+    ODc5MTFkYThhZmQ2ZWI3OWZkMGQ4MGE0NWMyNmVmMDFjZDMzNzg=
   data.tar.gz: !binary |-
-    YzJmYTA5ZjA5YzFmNDZiOWQyOTk1ZTE1OWU2ODkyODM0ODU0YmJkMDY3ZjI1
-    MzFhYTRkNTJiNzhiZTcxNmU4MWFhZGRhMTA5ZGIzM2ZlZjdjZmUwOWY0ODUx
-    MzYxYzAyYjYzMGEzYzZhYzZlOWI2M2JmNDU3YWU4ZGU5MjFhNGQ=
+    NDc4MTk3NTNhYjRlMmRmNTU3Mzg4YzljMTI5NzRiY2Q3ZGI5YWI3MmJjYWMz
+    MWE5Y2ZiYmEwYmI1ODczMjY2OGM0ZmZjMzM4ZWZkMDIyOTAxZTBhODk5N2Ey
+    YWE5YTVlYzM3MWE2MGEwN2RmZmExMTc4Zjg5YjBhZjVkOWQ3ZDI=

data/README.rdoc

@@ -0,0 +1,104 @@
+= Wiser Date for Rails
+
+WiserDate is a date formatting plugin written by Kenneth John Balgos (https://github.com/kennethjohnbalgos). Wiser Date features dynamic presentation of feed timestamps. Right now, it only displays the date statically. I'm writing the jQuery scripts to update the displayed dates in real-time and dynamic.
+
+
+== Installing Gem
+
+    gem "wiser_date"
+    
+    
+
+== Dependency
+
+The Rails application should have jQuery to make the real-time feature work.
+
+
+== Using the javascripts - Not Yet Available
+
+Require jquery.wiser_date in your app/assets/application.js file.
+
+    //= require jquery.wiser_date
+
+
+== Usage
+
+Use the wiser_date function in your views.
+
+    <%= wiser_date @user.last_login_at %>
+    # Sample display within few seconds: just now
+    # Sample display within few minutes: about 30 minutes ago
+    # Sample display within the day: about 15 hours ago
+    # Sample display after the day: yesterday 12:21pm
+    # Sample display after 2 days: Sept 10, 2013 12:21pm
+    
+@user.last_login_at can be any timestamp you want to display.
+
+Assume that the value is "Mon, 10 Sept 2012 12:21:16 UTC +00:00".
+
+
+== Options & Examples
+
+You can customize the behavior of the date display by using the following options:
+
+* *date_format* - overrides the default date format [default: "%b %d, %Y"]
+    
+    <%= wiser_date @user.last_login_at, :date_format => "%Y-%m-%d" %>
+    # Sample display within few seconds: just now
+    # Sample display within few minutes: about 30 minutes ago
+    # Sample display within the day: about 15 hours ago
+    # Sample display after the day: yesterday 12:21pm
+    # Sample display after 2 days: 2012-09-10 12:21pm
+
+* *time_format* - overrides the default time format [default: "%l:%M%P"]
+    
+    <%= wiser_date @user.last_login_at, :time_format => "%H:%M:%S" %>
+    # Sample display within few seconds: just now
+    # Sample display within few minutes: about 30 minutes ago
+    # Sample display within the day: about 15 hours ago
+    # Sample display after the day: yesterday 12:21:16
+    # Sample display after 2 days: Sept 10, 2013 12:21:16
+
+* *humanize* - converts date to more readable string [default: true]
+    
+    <%= wiser_date @user.last_login_at, :humanize => false %>
+    # Sample display within few seconds: Sept 10, 2013 12:21pm
+    # Sample display within few minutes: Sept 10, 2013 12:21pm
+    # Sample display within the day: Sept 10, 2013 12:21pm
+    # Sample display after the day: Sept 10, 2013 12:21pm
+    # Sample display after 2 days: Sept 10, 2013 12:21pm
+
+* *time_first* - displays time first instead of date [default: false]
+    
+    <%= wiser_date @user.last_login_at, :time_first => true %>
+    # Sample display within few seconds: just now
+    # Sample display within few minutes: about 30 minutes ago
+    # Sample display within the day: about 15 hours ago
+    # Sample display after the day: 12:21pm yesterday 
+    # Sample display after 2 days: 12:21pm Sept 10, 2013
+
+* *hide_same_year* - will not display the year if the it is the same with the present year [default: false]
+    
+    <%= wiser_date @user.last_login_at, :hide_same_year => true %>
+    # Sample display within few seconds: just now
+    # Sample display within few minutes: about 30 minutes ago
+    # Sample display within the day: about 15 hours ago
+    # Sample display after the day: yesterday 12:21pm
+    # Sample display after 2 days: Sept 10, 12:21pm 
+
+* *capitalize* - capitalizes the first letter of the date displayed [default: true]
+    
+    <%= wiser_date @user.last_login_at, :capitalize => true %>
+    # Sample display within few seconds: Just now
+    # Sample display within few minutes: About 30 minutes ago
+    # Sample display within the day: About 15 hours ago
+    # Sample display after the day: Yesterday 12:21pm
+    # Sample display after 2 days: Sept 10, 12:21pm 
+
+
+== Thanks
+Thanks to me for writing an awesome real-time date display plugin :p
+
+
+== Support
+Open an issue in https://github.com/kennethjohnbalgos/wiser_date if you need further support or want to report a bug.

data/lib/wiser_date/view_helpers.rb

@@ -2,12 +2,12 @@ require 'date'
 
 module WiserDate
   module ViewHelpers
-    
+  
     include ActionView::Helpers::JavaScriptHelper
     include ActionView::Helpers::TagHelper
     include ActionView::Helpers::DateHelper
     include ActionView::Context    
-  
+
     def wiser_date(timestamp, options = {})
       # Options
       date_format = options.has_key?(:date_format) ? options[:date_format] : "%b %d, %Y"
@@ -16,51 +16,62 @@ module WiserDate
       time_first = options.has_key?(:time_first) ? options[:time_first] : false
       hide_same_year = options.has_key?(:hide_same_year) ? options[:hide_same_year] : false
       capitalize = options.has_key?(:capitalize) ? options[:capitalize] : true
-    
-  
-      # Now
-      time_now = Time.now
-  
+      custom_class = options.has_key?(:custom_class) ? options[:custom_class] : nil
+      time_now = options.has_key?(:time_now) ? options[:time_now].to_datetime : Time.now
+
       # Formats
       flat_format = "%Y%m%d%H%M%S"
       plain_format = "%Y-%m-%d %H:%M:%S"
       custom_format = time_first ? "#{time_format} #{date_format}" : "#{date_format} #{time_format}"
-  
+
       # Timestamps
       custom_timestamp = timestamp.strftime(custom_format)
       plain_timestamp = timestamp.strftime(plain_format)
-  
+
       # Humanize Display
       if humanize
         time_diff_in_seconds = (time_now - timestamp.to_time).ceil
-        time_diff = (time_diff_in_seconds / (60*60*24))
-        if time_diff_in_seconds <= 15
+        time_diff_in_days = (time_diff_in_seconds / (60*60*24))
+        if time_diff_in_seconds <= 30 && time_diff_in_seconds >= 0
           custom_timestamp = "just now"
         elsif time_now.to_date - 1.day == timestamp.to_date 
           date_value = "yesterday"
           time_value = timestamp.strftime(time_format)
           custom_timestamp = time_first ? "#{time_value} #{date_value}" : "#{date_value} #{time_value}"
-        elsif time_diff < 1.0
+        elsif time_diff_in_days <= 1.0 && time_diff_in_days >= 0
           custom_timestamp = "#{distance_of_time_in_words(Time.now, timestamp.to_time)} ago"
         elsif hide_same_year && time_now.year == timestamp.year 
           custom_timestamp = custom_timestamp.gsub(", #{time_now.year.to_s}", '')
         end
       end
-    
+  
       # Capitalize
       if capitalize
         custom_timestamp = custom_timestamp.to_s.capitalize
       end
-  
+
+    
       uniq_id = Digest::SHA1.hexdigest([Time.now, rand].join)
       html = content_tag(:span, custom_timestamp, 
         "id" => uniq_id,
-        "class" => "wiser_date", 
+        "class" => "wiser_date #{custom_class if custom_class.present?}", 
         "data-plain-timestamp" => plain_timestamp, 
         "data-custom-timestamp" => custom_timestamp,
         "data-new-custom-timestamp" => custom_timestamp
       )
-      html += javascript_tag("jQuery(document).ready(function(){if(jQuery('body meta#wiser_date').size() == 0){$('body').prepend('<meta id=\"wiser_date\" data-value=\"#"+uniq_id+"\"/>')}else{$('meta#wiser_date').attr('data-value',$('meta#wiser_date').attr('data-value')+', #"+uniq_id+"')}});")
+    
+      meta_vars = []
+      meta_vars << "data-value=\"#"+uniq_id+"\""
+      meta_vars << "data-custom-format=\""+custom_format+"\""
+      meta_vars << "data-date-format=\""+date_format+"\""
+      meta_vars << "data-time-format=\""+time_format+"\""
+      meta_vars << "data-humanize=\""+humanize.to_s+"\""
+      meta_vars << "data-hide-same-year=\""+hide_same_year.to_s+"\""
+      meta_vars << "data-time-first=\""+time_first.to_s+"\""
+      meta_vars << "data-capitalize=\""+capitalize.to_s+"\""
+      meta_vars << "id=\"wiser_date\""
+    
+      html += javascript_tag("jQuery(document).ready(function(){if(jQuery('body meta#wiser_date').size() == 0){$('body').prepend('<meta "+meta_vars.join(' ')+" />')}else{$('meta#wiser_date').attr('data-value',$('meta#wiser_date').attr('data-value')+', #"+uniq_id+"')}});")
       html.html_safe
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wiser_date
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Kenneth John Balgos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-24 00:00:00.000000000 Z
+date: 2012-05-25 00:00:00.000000000 Z
 dependencies: []
 description: Display dates in the coolest format.
 email: kennethjohnbalgos@gmail.com
@@ -19,6 +19,7 @@ files:
 - lib/wiser_date/view_helpers.rb
 - lib/wiser_date/railtie.rb
 - lib/wiser_date.rb
+- README.rdoc
 homepage: https://github.com/kennethjohnbalgos/wiser_date
 licenses:
 - MIT