readingtime 0.0.3 → 0.0.5

data/README.md

@@ -5,14 +5,40 @@
 
 I use [iA Writer](http://iawriter.com "iA Writer") and find the *estimated reading time* feature pretty handy. I thought it would be cool to add at the top of my blog articles on the web as [others](http://nicepaul.com "The personal blog of @nicepaul") do.
 
-Full credit goes to [Brian Cray](http://briancray.com/2010/04/09/estimated-reading-time-web-design "Brian Cray - Estimated Reading Time in Web Design") for explaining how to do it in PHP.
-
 ## How to Use
 
-[readingtime](http://github.com/garethrees/readingtime "Gem to estimate reading time") extends the Ruby String class, so you can call `reading_time` on any string object.
+[readingtime](http://github.com/garethrees/readingtime "Gem to estimate reading time") extends the Ruby String class, so you can call `reading_time` on any `String` object.
+
+### Install
+
+	gem install readingtime
+
+### In irb
+
+	$ irb
+	> require 'readingtime'
+		=> true
+	> @words = "Lorem ipsum dolor sit amet"
+	> @words.reading_time
+		=> "0:01"
+
+### In Your App
+
+	<article>
+
+		<header>
+			<h1><%= @article.title %></h1>
+			<span class="readingtime">Estimated reading time – <%= @article.body.reading_time %></span>
+		</header>
+
+		<%= @article.body %>
+
+	</article>
+
+And voila!
+
+![Screenshot of readingtime in use](https://github-screenshots.s3.amazonaws.com/readingtime-view.png "Screenshot of readingtime in use")
 
-### Example
+## Thanks
 
-	@words = "Lorem ipsum dolor sit amet"
-	@words.reading_time
-		=> "0:01"
+Credit goes to [Brian Cray](http://briancray.com/2010/04/09/estimated-reading-time-web-design "Brian Cray - Estimated Reading Time in Web Design") for explaining how to do it in PHP.

data/lib/readingtime.rb

@@ -3,16 +3,17 @@ require "readingtime/core_ext"
 
 module Readingtime
 
-  def self.minutes(words)
-    (words / 200).floor
+  def self.minutes_in_seconds(words)
+    (words / 200).floor * 60
   end
 
   def self.seconds(words)
     (words % 200 / (200 / 60)).floor
   end
 
+  # TODO: Account for HH:MM:00
   def self.format_seconds(seconds)
-    '%d:%02d' % seconds.divmod(60)
+    '%02d:%02d' % seconds.divmod(60)
   end
 
 end

data/lib/readingtime/core_ext.rb

@@ -2,7 +2,7 @@ String.class_eval do
   def reading_time
     word_size = self.calculate_size
     
-    minutes = Readingtime.minutes(word_size)
+    minutes = Readingtime.minutes_in_seconds(word_size)
     seconds = Readingtime.seconds(word_size)
     
     return Readingtime.format_seconds((minutes + seconds))

data/lib/readingtime/version.rb

@@ -1,3 +1,3 @@
 module Readingtime
-  VERSION = "0.0.3"
+  VERSION = "0.0.5"
 end

data/spec/readingtime_spec.rb

@@ -5,30 +5,37 @@ require "readingtime"
 
 
 describe Readingtime do
-  let(:short_text) { "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum." }
-  let(:long_text)  { ("Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum." * 100) }
+  let(:two_hundred_words) { ("Lorem " * 200) }
 
+  it "should calculate the reading time of some text" do
+    two_hundred_words.reading_time.should == "01:00"
+  end
 
   it "should calculate the length of the string input" do
-    short_text.calculate_size.should == short_text.scan(/(\w|-)+/).size
+    two_hundred_words.calculate_size.should == 200
   end
 
-
   it "should calculate the number of minutes the reading should take" do
-    words = short_text.calculate_size
-    Readingtime.minutes(words).should == (words / 200).floor
+    words = two_hundred_words.calculate_size
+    Readingtime.minutes_in_seconds(words).should == 60
   end
 
   it "should calculate the remaining seconds the reading should take" do
-    words = short_text.calculate_size
-    Readingtime.seconds(words).should == (words % 200 / (200 / 60)).floor
+    words = two_hundred_words.calculate_size
+    Readingtime.seconds(words).should == 0
   end
 
-  it "should format the reading time in an HH:MM format" do
+  it "should format the reading time in an MM:SS format" do
     Readingtime.format_seconds(3600).should == "60:00"
-    Readingtime.format_seconds(60).should == "1:00"
-    Readingtime.format_seconds(10).should == "0:10"
-    Readingtime.format_seconds(1).should == "0:01"
+    Readingtime.format_seconds(60).should == "01:00"
+    Readingtime.format_seconds(10).should == "00:10"
+    Readingtime.format_seconds(1).should == "00:01"
   end
 
+  # it "should accept an options hash to format the output" do
+  #   short_text.reading_time(:format => :basic).should == "0:23"
+  #   short_text.reading_time(:format => :short).should == "23 seconds"
+  #   short_text.reading_time(:format => :long).should == "0 minutes and 23 seconds"
+  # end
+
 end

metadata

@@ -1,49 +1,45 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: readingtime
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.0.5
   prerelease: 
-  version: 0.0.3
 platform: ruby
-authors: 
+authors:
 - Gareth Rees
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-27 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-09-30 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &4992650 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *4992650
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &4992330 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "2.6"
+      - !ruby/object:Gem::Version
+        version: '2.6'
   type: :development
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *4992330
 description: Estimates reading time of a Ruby String object
-email: 
+email:
 - gareth@garethrees.co.uk
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - README.md
@@ -55,30 +51,27 @@ files:
 - spec/readingtime_spec.rb
 homepage: http://github.com/garethrees/readingtime
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: readingtime
-rubygems_version: 1.8.10
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Estimates reading time
-test_files: 
+test_files:
 - spec/readingtime_spec.rb