creative_rails_utilities 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16788059b4280282619b0f310bb6da722d07f820
-  data.tar.gz: 6e22528cd792c29dd49f5999e4ea2cc20af0b3eb
+  metadata.gz: c11e2d81b41c9250fa934fe3351ff2b91f27d1e1
+  data.tar.gz: 10374464c1ed042a4ac75fb91c8cceb3f1d5082f
 SHA512:
-  metadata.gz: 38370d59cbabb4955f92864fb297097ac8648a0668b929a59f48dd0886b5c9b13b5fed9a7fbd5a57be784701f29ae63df82811c87476bc0a54ccea4b8c9b6c9c
-  data.tar.gz: e4a5e8ef2d4f928f8679c277b9390744c0b8325b2542f2309e411b0afb298cd3745f3c1855a8cfd06993ce2cf9e7660378de7de1faf173ac59b94ddb5074b901
+  metadata.gz: 0290b96140235311179d75a50df9b9b21691c37c344ec5f70a320ff6257526756696a3a15f1b5dc20794e15e33856cebcad2f03231840440a78a6989d9f2bbb9
+  data.tar.gz: 760f094be9e34f0aae9a76bf811a4f077c7dc81b76132df2279673bd4bc9d08b62a7ff2232dec252a9cfdfb6a9b5118980b8f8fd7ef5709b409ee3b63851fb35

data/.rspec

@@ -1,2 +1,3 @@
 --format documentation
+--require spec_helper
 --color

data/CHANGELOG.md

@@ -2,11 +2,16 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [Release candidate][0.2.3-alpha.1]
+## [Release candidate][0.3.1-alpha.1]
 ### Added
 -
 
-## [Release candidate][0.2.2]
+## [0.3.0] - 2015-12-10
+### Added
+- ViewHelper module for Rails
+- helper#relative_time_parse(earlier_time, later_time=optional)
+
+## [0.2.3] - 2015-11-20
 ### Added
 - Added Integer#safe_part
 - Documented Date#array_with_pre_churn_limit(limit_day_count)

data/README.md

@@ -10,7 +10,68 @@ Intended for Rails > 4.0.0, but will probably also work for older projects with
 
 ## Usage
 
-Feel free to read the source under `/lib/creative_rails_utilities/`  
+Feel free to read the source under `/lib/creative_rails_utilities/` and peruse the method "it" lines under `/spec`
+
+#### View Helpers
+Rails-only (via railtie) view helpers have been added, they are automagically loaded and usable upon gem inclusion.
+
+##### relative_time_parse(earlier_time, later_time=optional)
+turns a timestamp into "time ago" format.  
+Examples:
+
+```ruby
+# If used with only one argument, will default the second argument to Time.now
+# at "2015-01-15 12:00".to_datetime
+
+relative_time_parse("2015-01-15 12:00".to_datetime)
+#=> {key: "now", count: nil}
+relative_time_parse("2015-01-15 11:59:59".to_datetime)
+#=> {key: "second", count: nil}
+relative_time_parse("2015-01-15 11:59:58".to_datetime)
+#=> {key: "seconds", count: "1"}
+relative_time_parse("2015-01-15 11:59:00".to_datetime)
+#=> {key: "minute", count: nil}
+relative_time_parse("2015-01-15 11:58:00".to_datetime)
+#=> {key: "minutes", count: "2"}
+relative_time_parse("2015-01-15 11:00".to_datetime)
+#=> {key: "hour", count: nil}
+relative_time_parse("2015-01-15 09:00".to_datetime)
+#=> {key: "hours", count: "3"}
+relative_time_parse("2015-01-14 11:00".to_datetime)
+#=> {key: "day", count: nil}
+relative_time_parse("2015-01-10 09:00".to_datetime)
+#=> {key: "days", count: 5}
+
+# if used with both arguments, expects the second to be later than the first and will calculate relative time between them
+relative_time_parse("2015-01-01 12:00".to_datetime, "2015-01-01 12:02".to_datetime)
+#=> {key: "minutes", count: "2"}
+```
+
+The keys are intended to be used together with `I18n.t`  
+Sample yaml for English
+
+```yml
+en:
+  time:
+    now: "just now"
+    second: "a second ago"
+    seconds: "%{count} seconds ago"
+    minute: "a minute ago"
+    minutes: "%{count} minutes ago"
+    hour: "an hour ago"
+    hours: "%{count} hours ago"
+    day: "a day ago"
+    days: "%{count} days ago"
+```
+
+Then you can write a simple helper that specifies localication key location and returns the correct value based on the hash returned by `relative_time_parse`
+```ruby
+def relative_short_time(t1, t2=nil)
+  hash = relative_time_parse(t1, t2)
+  count_hash = hash.count.present? ? hash.except(:key): {}
+  return I18n.t("time.#{hash[:key]}", count_hash)
+end
+```
 
 ##### Date
 

data/lib/creative_rails_utilities.rb

@@ -10,5 +10,7 @@ require "creative_rails_utilities/numeric"
 require "creative_rails_utilities/string"
 require "creative_rails_utilities/version"
 
+require 'creative_rails_utilities/railtie' if defined?(Rails)
+
 module CreativeRailsUtilities
 end

data/lib/creative_rails_utilities/railtie.rb

@@ -0,0 +1,10 @@
+require 'creative_rails_utilities/view_helpers'
+
+module CreativeRailsUtilities
+  class Railtie < Rails::Railtie
+    initializer "creative_rails_utilities.view_helpers" do
+      ActiveSupport.on_load( :action_view ){ include CreativeRailsUtilities::ViewHelpers }
+      # ActionView::Base.send :include, ViewHelpers
+    end
+  end
+end

data/lib/creative_rails_utilities/version.rb

@@ -1,3 +1,3 @@
 module CreativeRailsUtilities
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/lib/creative_rails_utilities/view_helpers.rb

@@ -0,0 +1,35 @@
+module CreativeRailsUtilities
+  module ViewHelpers   
+
+    def relative_time_parse(earlier_time, later_time=nil)
+      later_time ||= Time.now
+      difference = (later_time.to_i - earlier_time.to_i).to_i
+
+      case difference
+      when 0
+        return {key: "now", count: nil}
+      when 1
+        return {key: "second", count: nil}
+      when 2..59
+        return {key: "seconds", count: difference.to_s}
+      when 60..119
+        return {key: "minute", count: nil}
+      when 120..3540
+        return {key: "minutes", count: (difference/60).to_i.to_s}
+      when 3541..7100
+        return {key: "hour", count: nil}
+      when 7101..82800
+        return {key: "hours", count: ((difference+99)/3600).to_i.to_s}
+      when 82801..172000
+        return {key: "day", count: nil}
+      else
+        if difference < 0
+          return {key: "now", count: nil}
+        else
+          return {key: "days", count: ((difference+800)/(60*60*24)).to_i.to_s}
+        end
+      end
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: creative_rails_utilities
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Creative
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-20 00:00:00.000000000 Z
+date: 2015-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -160,8 +160,10 @@ files:
 - lib/creative_rails_utilities/error_helper.rb
 - lib/creative_rails_utilities/hash.rb
 - lib/creative_rails_utilities/numeric.rb
+- lib/creative_rails_utilities/railtie.rb
 - lib/creative_rails_utilities/string.rb
 - lib/creative_rails_utilities/version.rb
+- lib/creative_rails_utilities/view_helpers.rb
 homepage: https://github.com/CreativePublisher/rails_utilities
 licenses:
 - MIT