time_to_read 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83657e2ca796b3347edddaa6b0d1b61bc27041a6
-  data.tar.gz: 6a0b8cda9be1437afcb66bdf396698a2b5923536
+  metadata.gz: 24b42f86eeff5b2e17481a8942b60c6614851f78
+  data.tar.gz: 79e95a32883bcf93799fbcc35839ef36ca79338a
 SHA512:
-  metadata.gz: 887391409c223276f1763e278a138f00032b8ade8c3fe76ec9666fd5a9ce35329f170b537193a377820973e06eb562a0ce2b7d55c4b68542f3a71cdb4862cb4c
-  data.tar.gz: ffc0c5143754d472fa01799f7013996abc7d8171a3e976526ff96662c20524c752b59657dc01016d70596f8ae04e0cca530c0f7e8f126fe0cbd2f12198a1b7ce
+  metadata.gz: ab93072243f14cbd48cb1b9024605249a34f54c926dce8a87ff57a18e285245f1f8e7a40301f98b8f097985ecf45aab74027f812b891a5d2291f4f388f07cc51
+  data.tar.gz: 38b9bb09e4d0f12349f2e00199356505b8b5b3a3e43ec1c099d5386d61c94dcbbcc3faf501dd11e446881b988495795e95aba5e86dc46c2c0c0f1a05b87de354

data/README.md

@@ -1,4 +1,4 @@
-# ReadTimeEstimator
+# TimeToRead
 
 Estimates the time to read a string of text. The gem assumes a reading speed of 250 words per minute.
 
@@ -6,7 +6,7 @@ Estimates the time to read a string of text. The gem assumes a reading speed of
 
 Add this line to your application's Gemfile:
 
-    gem 'read_time_estimator'
+    gem 'time_to_read'
 
 And then execute:
 
@@ -14,21 +14,23 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install read_time_estimator
+    $ gem install time_to_read
 
 ## Usage
 
-To use the gem on a string, call `read_time_words` on it.
+To use the gem on a string, call `time_to_read` on it passing through the desired reading speed as an argument.
 
 Example:
-`some_string.read_time_words`
+`some_string.read_time_words(250)`
 
 will output
-`2 minutes and 30 seconds to read`
+`2 minutes`
+
+Note: Times are purposly fuzzy stating Less than a minute, and only incrementing at minute increments.  Please take with a grain of salt :)
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/read_time_estimator/fork )
+1. Fork it ( http://github.com/<my-github-username>/time_to_read/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/time_to_read/version.rb

@@ -1,3 +1,3 @@
 module TimeToRead
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/time_to_read.rb

@@ -1,14 +1,10 @@
-require "time_to_read/version"
+# require "time_to_read/version"
 
 module TimeToRead
   module String
-    def minutes_to_read
-      self.split(' ').count/250.0
-    end
 
-    def time_to_read
-      time = minutes_to_read
-      answer = ''
+    def time_to_read(words_per_minute)
+      time = minutes_to_read(words_per_minute)
       if time >= 60
         hours = read_time_hours(time).to_s
         minutes = read_time_minutes(time - hours.to_i * 60).to_s
@@ -23,22 +19,25 @@ module TimeToRead
       answer.strip
     end
 
-    def read_time_hours(time)
-      hours = (time / 60).to_i
-      hours_in_words(hours)
+    private
+
+    def minutes_to_read(words_per_minute)
+      self.split(' ').count/words_per_minute.to_i
     end
 
-    def hours_in_words(hours)
-      hours == 1 ? "#{hours} hour" : "#{hours} hours"
+    def read_time_hours(time)
+      hours = (time / 60).to_i
+      time_in_words(hours, 'hour')
     end
 
     def read_time_minutes(time)
       minutes = time.to_i
-      minutes_in_words(minutes) unless minutes == 0
+      time_in_words(minutes, 'minute') unless minutes == 0
     end
 
-    def minutes_in_words(minutes)
-      minutes == 1 ? " #{minutes} minute" : " #{minutes} minutes"
+    def time_in_words(time_value, time_context)
+      time_context.to_s
+      time_value == 1 ? " #{time_value} #{time_context}" : " #{time_value} #{time_context}s"
     end
   end
 end

data/spec/time_to_read_spec.rb

@@ -2,39 +2,32 @@ require "time_to_read"
 require 'rspec'
 
 describe "TimeToRead" do
-  describe "minutes_to_read" do
-    it "should output an amount of time given the length of a word" do
-      text = "word " * 250
-      expect(text.minutes_to_read).to eql 1.0
-    end
-  end
-
   describe "time_to_read" do
     it "returns the reading time in phrase form when there is an even number of minutes" do
       text = "word " * 500
-      expect(text.time_to_read).to eql "2 minutes"
+      expect(text.time_to_read(250)).to eql "2 minutes"
     end
 
     it "returns the reading time in phrase form when there are seconds" do
       text = "word " * 625
-      expect(text.time_to_read).to eql "2 minutes"
+      expect(text.time_to_read(250)).to eql "2 minutes"
     end
 
     it "returns the reading time in phrase form when read time is an hour" do
       text = "word " * 15000
-      expect(text.time_to_read).to eql "1 hour"
+      expect(text.time_to_read(250)).to eql "1 hour"
     end
 
     it "returns the reading time in phrase form when read time include an hour, minutes, and seconds" do
       text = "word " * 22550
-      expect(text.time_to_read).to eql "1 hour 30 minutes"
+      expect(text.time_to_read(250)).to eql "1 hour 30 minutes"
     end
   end
 
   describe "hours_in_words" do
     it "correctly pluralizes 'hour' when hours to read is greater than one" do
       text = "word " * 30000
-      expect(text.time_to_read).to eql "2 hours"
+      expect(text.time_to_read(250)).to eql "2 hours"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: time_to_read
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Abby Ihrig