readingtime 0.0.3

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in readingtime.gemspec
+gemspec

data/README.md

@@ -0,0 +1,18 @@
+# Estimate Reading Time
+
+[![Build Status](https://secure.travis-ci.org/garethrees/readingtime.png)](http://travis-ci.org/garethrees/readingtime)
+
+
+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.
+
+### Example
+
+	@words = "Lorem ipsum dolor sit amet"
+	@words.reading_time
+		=> "0:01"

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+
+task :default do
+  exec('rspec spec/.')
+end

data/lib/readingtime/core_ext.rb

@@ -0,0 +1,16 @@
+String.class_eval do
+  def reading_time
+    word_size = self.calculate_size
+    
+    minutes = Readingtime.minutes(word_size)
+    seconds = Readingtime.seconds(word_size)
+    
+    return Readingtime.format_seconds((minutes + seconds))
+    
+  end
+
+  def calculate_size
+    self.scan(/(\w|-)+/).size
+  end
+
+end

data/lib/readingtime/version.rb

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

data/lib/readingtime.rb

@@ -0,0 +1,18 @@
+require "readingtime/version"
+require "readingtime/core_ext"
+
+module Readingtime
+
+  def self.minutes(words)
+    (words / 200).floor
+  end
+
+  def self.seconds(words)
+    (words % 200 / (200 / 60)).floor
+  end
+
+  def self.format_seconds(seconds)
+    '%d:%02d' % seconds.divmod(60)
+  end
+
+end

data/readingtime.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "readingtime/version"
+
+Gem::Specification.new do |s|
+  s.name        = "readingtime"
+  s.version     = Readingtime::VERSION
+  s.authors     = ["Gareth Rees"]
+  s.email       = ["gareth@garethrees.co.uk"]
+  s.homepage    = "http://github.com/garethrees/readingtime"
+  s.summary     = %q{Estimates reading time}
+  s.description = %q{Estimates reading time of a Ruby String object}
+
+  s.rubyforge_project = "readingtime"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency "rspec", "~>2.6"
+
+end

data/spec/readingtime_spec.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+path = File.expand_path(File.dirname(__FILE__) + "/../lib/")
+$LOAD_PATH.unshift(path) unless $LOAD_PATH.include?(path)
+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) }
+
+
+  it "should calculate the length of the string input" do
+    short_text.calculate_size.should == short_text.scan(/(\w|-)+/).size
+  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
+  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
+  end
+
+  it "should format the reading time in an HH:MM 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"
+  end
+
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: readingtime
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.3
+platform: ruby
+authors: 
+- Gareth Rees
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-27 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    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 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.6"
+  type: :development
+  version_requirements: *id002
+description: Estimates reading time of a Ruby String object
+email: 
+- gareth@garethrees.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/readingtime.rb
+- lib/readingtime/core_ext.rb
+- lib/readingtime/version.rb
+- readingtime.gemspec
+- spec/readingtime_spec.rb
+homepage: http://github.com/garethrees/readingtime
+licenses: []
+
+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.10
+signing_key: 
+specification_version: 3
+summary: Estimates reading time
+test_files: 
+- spec/readingtime_spec.rb