time_sentence 0.0.4 → 1.0.0

data/Readme.md

@@ -5,46 +5,49 @@ into joy.
 
 ## Basic Usage
 
-You can use the `time_sentence` method on any number or the Time.sentence class method to get the same result
+You can use the `to_time_sentence` method on any number or the `Time.to_sentence` class method to get the same result
 
 ```ruby
-    1.hour.time_sentence #=> "1 hour"
-    168.hours.time_sentence #=> "1 week"
-    9999.seconds.time_sentence #=> "2 hours, 46 minutes, 39 seconds"
-    123456876543.seconds.time_sentence #=> "4 millennia, 25 decades, 2 years"
-
-    Time.sentence(1.hour) #=> "1 hour"
-    Time.sentence(168.hours) #=> "1 week"
-    Time.sentence(9999.seconds) #=> "2 hours, 46 minutes, 39 seconds"
-    Time.sentence(123456876543.seconds) #=> "4 millennia, 25 decades, 2 years"
+    1.hour.to_time_sentence #=> "1 hour"
+    168.hours.to_time_sentence #=> "1 week"
+    525600.minutes.to_time_sentence #=> "1 year, 1 month, 1 day"
+    9999.seconds.to_time_sentence #=> "2 hours, 46 minutes, 39 seconds"
+    123456876543.seconds.to_time_sentence #=> "4 millennia, 25 decades, 2 years"
+
+    Time.to_sentence(1.hour) #=> "1 hour"
+    Time.to_sentence(168.hours) #=> "1 week"
+    Time.to_sentence(525600.minutes) #=> "1 year, 1 month, 1 day"
+    Time.to_sentence(9999.seconds) #=> "2 hours, 46 minutes, 39 seconds"
+    Time.to_sentence(123456876543.seconds) #=> "4 millennia, 25 decades, 2 years"
 ```
 
 ## Advanced Usage
 
 ### Specificity
 
-Time_Sentence assumes that you won't want more than 3 terms in your sentence, so it chooses the largest unit it can,
+`time_sentence` assumes that you won't want more than 3 terms in your sentence, so it chooses the largest unit it can,
 then displays the next smaller 2 (that don't equal 0) as well. For example:
 
 ```ruby
-    123456877.seconds.time_sentence #=> "4 years, 3 months, 21 hours"
+    123456877.seconds.to_time_sentence #=> "4 years, 3 months, 21 hours"
 ```
 
 Normally if you have a number on the scale of years, it doesn't matter how many, say, seconds there are. The number
-above represents 4 years, 3 months, 0 weeks, 0 days, 21 hours, and probably some number if minutes and seconds.
+above represents 4 years, 3 months, 0 weeks, 0 days, 21 hours, and probably some number of minutes and seconds.
 
 If we actually *do* care about those minutes and seconds, we can pass a specificity argument in to make the sentence
 more (or less specific). For example:
 
 ```ruby
-    123456877.seconds.time_sentence #=> "4 years, 3 months, 21 hours"
-    123456877.seconds.time_sentence(1) #=> "4 years"
-    123456877.seconds.time_sentence(2) #=> "4 years, 3 months"
-    123456877.seconds.time_sentence(3) #=> "4 years, 3 months, 21 hours"
-    123456877.seconds.time_sentence(4) #=> "4 years, 3 months, 21 hours, 34 minutes"
-    123456877.seconds.time_sentence(5) #=> "4 years, 3 months, 21 hours, 34 minutes, 37 seconds"
-
-    Time.sentence(123456877.seconds, 5) #=> "4 years, 3 months, 21 hours, 34 minutes, 37 seconds"
+    123456877.seconds.to_time_sentence    #=> "4 years, 3 months, 21 hours"
+    123456877.seconds.to_time_sentence(1) #=> "4 years"
+    123456877.seconds.to_time_sentence(2) #=> "4 years, 3 months"
+    123456877.seconds.to_time_sentence(3) #=> "4 years, 3 months, 21 hours"
+    123456877.seconds.to_time_sentence(4) #=> "4 years, 3 months, 21 hours, 34 minutes"
+    123456877.seconds.to_time_sentence(5) #=> "4 years, 3 months, 21 hours, 34 minutes, 37 seconds"
+
+    # Works the same way by calling Time.to_sentence
+    Time.to_sentence(123456877.seconds, 5) #=> "4 years, 3 months, 21 hours, 34 minutes, 37 seconds"
 ```
 
 ### Past Times
@@ -52,7 +55,7 @@ more (or less specific). For example:
 Passing a negative number into the method will generate a sentence about the past:
 
 ```ruby
-    -123456877.seconds.time_sentence(5) #=> "4 years, 3 months, 21 hours, 34 minutes, 37 seconds ago"
+    -123456877.seconds.to_time_sentence(5) #=> "4 years, 3 months, 21 hours, 34 minutes, 37 seconds ago"
 ```
 
 ### Now
@@ -60,12 +63,12 @@ Passing a negative number into the method will generate a sentence about the pas
 Passing 0 into the method will simply return "now"
 
 ```ruby
-    0.seconds.time_sentence #=> "now"
+    0.seconds.to_time_sentence #=> "now"
 ```
 
 # Contributors
 
-time_sentence is solely Pete Michaud's (me@petermichaud.com) fault, so blame him for everything.
+`time_sentence` is solely Pete Michaud's (me@petermichaud.com) fault, so blame him for everything.
 
 # License
 

data/lib/ext/ts_numeric.rb

@@ -1,5 +1,6 @@
 class Numeric
-  def time_sentence specificity = 3
-    Time.sentence(self, specificity)
+  def to_time_sentence specificity = 3
+    Time.to_sentence(self, specificity)
   end
+  alias_method :to_ts, :to_time_sentence
 end

data/lib/ext/ts_time.rb

@@ -4,17 +4,17 @@ class Time
   #
   # == Examples
   #
-  #   Time.sentence(1.hour) #=> "1 hour"
-  #   Time.sentence(168.hours) #=> "1 week"
-  #   Time.sentence(9999.seconds) #=> "2 hours, 46 minutes, 39 seconds"
-  #   Time.sentence(123456876543.seconds) #=> "4 millennia, 25 decades, 2 years"
+  #   Time.to_sentence(1.hour) #=> "1 hour"
+  #   Time.to_sentence(168.hours) #=> "1 week"
+  #   Time.to_sentence(9999.seconds) #=> "2 hours, 46 minutes, 39 seconds"
+  #   Time.to_sentence(123456876543.seconds) #=> "4 millennia, 25 decades, 2 years"
   #
   # == Params
   #
   # @param [Numeric] Number of seconds to convert to a sentence
   # @param [Integer] Specificity of the sentence (how many clauses are included)
   # @return [String] Generated sentence
-  def self.sentence seconds, specificity = 3
+  def self.to_sentence seconds, specificity = 3
 
     return 'now' if seconds == 0
 

data/lib/time_sentence/version.rb

@@ -1,3 +1,3 @@
 module TimeSentence
-  VERSION = '0.0.4'
+  VERSION = '1.0.0'
 end

data/spec/time_sentence/sentence_spec.rb

@@ -1,39 +1,39 @@
 require 'spec_helper'
 
-describe 'Time.sentence' do
+describe 'Time.to_sentence' do
 
   it "should accept a positive integer" do
-    Time.sentence(100000000).should eql "3 years, 5 months, 1 week"
-    100000000.time_sentence.should eql "3 years, 5 months, 1 week"
+    Time.to_sentence(100000000).should eql "3 years, 5 months, 1 week"
+    100000000.to_time_sentence.should eql "3 years, 5 months, 1 week"
   end
 
   it "should accept a negative integer" do
-    Time.sentence(-3600).should eql "1 hour ago"
-    -3600.time_sentence.should eql "1 hour ago"
+    Time.to_sentence(-3600).should eql "1 hour ago"
+    -3600.to_time_sentence.should eql "1 hour ago"
   end
 
   it "should accept 0" do
-    Time.sentence(0).should eql "now"
-    0.time_sentence.should eql "now"
+    Time.to_sentence(0).should eql "now"
+    0.to_time_sentence.should eql "now"
   end
 
   it "should accept a very large number" do
-    Time.sentence(100000000000000000000000).should be_kind_of String
-    100000000000000000000000.time_sentence.should be_kind_of String
+    Time.to_sentence(100000000000000000000000).should be_kind_of String
+    100000000000000000000000.to_time_sentence.should be_kind_of String
   end
 
   it "should accept specificity" do
     (1..10).each do |specificity|
-      Time.sentence(123456789123456789, specificity).should be_kind_of String
-      123456789123456789.time_sentence(specificity).should be_kind_of String
+      Time.to_sentence(123456789123456789, specificity).should be_kind_of String
+      123456789123456789.to_time_sentence(specificity).should be_kind_of String
     end
   end
 
   it "should ignore a specificity that is out of range" do
-      Time.sentence(123456789123456789, -5).should be_kind_of String
-      123456789123456789.time_sentence(-5).should be_kind_of String
-      Time.sentence(123456789123456789, 20).should be_kind_of String
-      123456789123456789.time_sentence(20).should be_kind_of String
+      Time.to_sentence(123456789123456789, -5).should be_kind_of String
+      123456789123456789.to_time_sentence(-5).should be_kind_of String
+      Time.to_sentence(123456789123456789, 20).should be_kind_of String
+      123456789123456789.to_time_sentence(20).should be_kind_of String
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: time_sentence
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-14 00:00:00.000000000 Z
+date: 2012-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake