readingtime 0.1.2 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01c44cb3bfde84a62cb226ff37d727a9842cc28f
+  data.tar.gz: ed919fb05b30d745a486d0f7a685248b038c1a2f
+SHA512:
+  metadata.gz: 1a77483f0233efda41152c352cb7979399d3c9f97a2c6d7a93dac307e092750dde8055a70a1509eaefc129b2ce2be769edcd3256b8a079fbc7ceb448a8e1cbf1
+  data.tar.gz: 12a9e3694359349b3b7247adff6e3c04605279907973ac3898ee8cff3dc9ebe40e73666be6b78291a4c700000c40a085e346cb1d3d347de2e4cb44f9065694b3

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 1.9.3
+  - 1.8.7

data/README.md

@@ -1,7 +1,6 @@
 # Estimate Reading Time
 
-[![Build Status](https://secure.travis-ci.org/garethrees/readingtime.png)](http://travis-ci.org/garethrees/readingtime)
-
+[![Build Status](https://secure.travis-ci.org/garethrees/readingtime.png)](http://travis-ci.org/garethrees/readingtime) [![Code Climate](https://codeclimate.com/github/garethrees/coderwall_ruby.png)](https://codeclimate.com/github/garethrees/coderwall_ruby)
 
 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.
 
@@ -11,29 +10,29 @@ I use [iA Writer](http://iawriter.com "iA Writer") and find the *estimated readi
 
 ### Install
 
-	gem install readingtime
+    gem install readingtime
 
 ### In irb
 
-	$ irb
-	> require 'readingtime'
-		=> true
-	> @words = "Lorem ipsum dolor sit amet"
-	> @words.reading_time
-		=> "00:01"
+    $ irb
+    > require 'readingtime'
+    => true
+    > @words = "Lorem ipsum dolor sit amet"
+    > @words.reading_time
+    => "00:01"
 
 ### In Your App
 
-	<article>
+    <article>
 
-		<header>
-			<h1><%= @article.title %></h1>
-			<span class="readingtime">Estimated reading time – <%= @article.body.reading_time %></span>
-		</header>
+      <header>
+        <h1><%= @article.title %></h1>
+        <span class="readingtime">Estimated reading time – <%= @article.body.reading_time %></span>
+      </header>
 
-		<%= @article.body %>
+      <%= @article.body %>
 
-	</article>
+    </article>
 
 And voila!
 
@@ -43,14 +42,22 @@ And voila!
 
 You can also send in options to modify the formatting.
 
-	# Default output
-	@article.body.reading_time :format => :basic
-	=> "03:36"
-	
-	# Longer text output
-	@article.body.reading_time :format => :long
-	=> "3 minutes and 36 seconds"
+    # Default output
+    @article.body.reading_time :format => :basic
+    => "03:36"
+
+    # Longer text output
+    @article.body.reading_time :format => :long
+    => "3 minutes and 36 seconds"
+
+    # Full text output
+    @article.body.reading_time :format => :full
+    => "1 hr 3 mins 36 secs"
+
+    # Raw output [hours, minutes, seconds]
+    @article.body.reading_time :format => :raw
+    => [1, 12, 23]
 
 ## Thanks
 
-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.
+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

@@ -1,8 +1,18 @@
-require "readingtime/version"
-require "readingtime/core_ext"
+Dir[File.dirname(__FILE__) + '/readingtime/*.rb'].each do |file|
+  require file
+end
 
 module Readingtime
 
+  def self.hms(secs)
+    h, m, s = 0, 0, 0
+    h = secs / 3600
+    secs -= h * 3600
+    m = secs / 60
+    secs -= m * 60
+    [h, m, secs]
+  end
+
   def self.minutes_in_seconds(words)
     (words / 200).floor * 60
   end
@@ -28,4 +38,12 @@ module Readingtime
     end
   end
 
+  def self.format_full(hms)
+    r, h, m, s = [], hms[0], hms[1], hms[2]
+    r << "#{h} #{h == 1 ? 'hr' : 'hrs'}" if h > 0
+    r << "#{m} #{m == 1 ? 'min' : 'mins'}" if m > 0
+    r << "#{s} #{s == 1 ? 'sec' : 'secs'}" if s > 0
+    r.join(" ")
+  end
+
 end

data/lib/readingtime/core_ext.rb

@@ -5,7 +5,7 @@ String.class_eval do
     word_size = self.calculate_size
     minutes = Readingtime.minutes_in_seconds(word_size)
     seconds = Readingtime.seconds(word_size)
-    
+
     case format_options
     when :basic
       Readingtime.format_seconds((minutes + seconds))
@@ -13,12 +13,17 @@ String.class_eval do
       Readingtime.format_words((minutes + seconds))
     when :approx
       Readingtime.format_approx((minutes + seconds))
+    when :full
+      hms = Readingtime.hms(minutes + seconds)
+      Readingtime.format_full(hms)
+    when :raw
+      Readingtime.hms(minutes + seconds)
     end
-    
+
   end
 
   def calculate_size
     self.scan(/(\w|-)+/).size
   end
 
-end
+end

data/lib/readingtime/version.rb

@@ -1,3 +1,3 @@
 module Readingtime
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/spec/readingtime_spec.rb

@@ -35,6 +35,22 @@ describe Readingtime do
     Readingtime.format_seconds(1).should == "00:01"
   end
 
+  it "should format the reading time in words" do
+    Readingtime.format_full([1, 0, 0]).should == "1 hr"
+    Readingtime.format_full([2, 0, 0]).should == "2 hrs"
+    Readingtime.format_full([1, 1, 0]).should == "1 hr 1 min"
+    Readingtime.format_full([2, 2, 0]).should == "2 hrs 2 mins"
+    Readingtime.format_full([1, 1, 1]).should == "1 hr 1 min 1 sec"
+    Readingtime.format_full([2, 2, 2]).should == "2 hrs 2 mins 2 secs"
+  end
+
+  it "should format the reading time in an array of hours, minutes, seconds" do
+    Readingtime.hms(3600).should == [1, 0, 0]
+    Readingtime.hms(60).should == [0, 1, 0]
+    Readingtime.hms(10).should == [0, 0, 10]
+    Readingtime.hms(1).should == [0, 0, 1]
+  end
+
   it "should accept an options hash to format the output" do
     two_hundred_words.reading_time(:format => :basic).should == "01:00"
     two_hundred_words.reading_time(:format => :long).should == "1 minutes and 0 seconds"
@@ -45,6 +61,8 @@ describe Readingtime do
 
   it "should return a time in seconds when using approx with time less than 1 minute" do
     ten_words.reading_time(:format => :approx).should == "3 seconds"
+    three_hundred_words.reading_time(:format => :full).should == '1 min 33 secs'
+    two_hundred_words.reading_time(:format => :raw).should == [0, 1, 0]
   end
 
 end

metadata

@@ -1,38 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: readingtime
 version: !ruby/object:Gem::Version
-  version: 0.1.2
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Gareth Rees
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-02 00:00:00.000000000 Z
+date: 2014-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70347145149640 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70347145149640
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70347145149140 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70347145149140
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
 description: Estimates reading time of a Ruby String object
 email:
 - gareth@garethrees.co.uk
@@ -40,7 +45,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - README.md
 - Rakefile
@@ -51,27 +57,26 @@ files:
 - spec/readingtime_spec.rb
 homepage: http://github.com/garethrees/readingtime
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: readingtime
-rubygems_version: 1.8.15
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Estimates reading time
 test_files:
 - spec/readingtime_spec.rb