time_to_read 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 83657e2ca796b3347edddaa6b0d1b61bc27041a6
+  data.tar.gz: 6a0b8cda9be1437afcb66bdf396698a2b5923536
+SHA512:
+  metadata.gz: 887391409c223276f1763e278a138f00032b8ade8c3fe76ec9666fd5a9ce35329f170b537193a377820973e06eb562a0ce2b7d55c4b68542f3a71cdb4862cb4c
+  data.tar.gz: ffc0c5143754d472fa01799f7013996abc7d8171a3e976526ff96662c20524c752b59657dc01016d70596f8ae04e0cca530c0f7e8f126fe0cbd2f12198a1b7ce

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/

data/.rbenv-gemsets

@@ -0,0 +1 @@
+time-to-read

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Abby Ihrig
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# ReadTimeEstimator
+
+Estimates the time to read a string of text. The gem assumes a reading speed of 250 words per minute.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'read_time_estimator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install read_time_estimator
+
+## Usage
+
+To use the gem on a string, call `read_time_words` on it.
+
+Example:
+`some_string.read_time_words`
+
+will output
+`2 minutes and 30 seconds to read`
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/read_time_estimator/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`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/time_to_read.rb

@@ -0,0 +1,49 @@
+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 = ''
+      if time >= 60
+        hours = read_time_hours(time).to_s
+        minutes = read_time_minutes(time - hours.to_i * 60).to_s
+        answer = hours + minutes
+      elsif time < 60 && time > 1
+        minutes = read_time_minutes(time).to_s
+        answer = minutes
+      else
+        answer = 'Less than a minute'
+      end
+
+      answer.strip
+    end
+
+    def read_time_hours(time)
+      hours = (time / 60).to_i
+      hours_in_words(hours)
+    end
+
+    def hours_in_words(hours)
+      hours == 1 ? "#{hours} hour" : "#{hours} hours"
+    end
+
+    def read_time_minutes(time)
+      minutes = time.to_i
+      minutes_in_words(minutes) unless minutes == 0
+    end
+
+    def minutes_in_words(minutes)
+      minutes == 1 ? " #{minutes} minute" : " #{minutes} minutes"
+    end
+  end
+end
+
+class String
+  include TimeToRead::String
+end
+

data/lib/time_to_read/version.rb

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

data/spec/time_to_read_spec.rb

@@ -0,0 +1,40 @@
+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"
+    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"
+    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"
+    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"
+    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"
+    end
+  end
+end

data/time_to_read.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'time_to_read/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "time_to_read"
+  spec.version       = TimeToRead::VERSION
+  spec.authors       = ["Abby Ihrig", "Ana Tighe", "Patrick Mounts"]
+  spec.email         = ["abby@planetargon.com", "ana@planetargon.com", "patrick@planetargon.com"]
+  spec.summary       = %q{Estimates amount of time required to read given content.}
+  spec.description   = %q{Estimates amount of time required to read given content.}
+  spec.homepage      = "https://github.com/planetargon/time_to_read.git"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: time_to_read
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Abby Ihrig
+- Ana Tighe
+- Patrick Mounts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: Estimates amount of time required to read given content.
+email:
+- abby@planetargon.com
+- ana@planetargon.com
+- patrick@planetargon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rbenv-gemsets
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/time_to_read.rb
+- lib/time_to_read/version.rb
+- spec/time_to_read_spec.rb
+- time_to_read.gemspec
+homepage: https://github.com/planetargon/time_to_read.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Estimates amount of time required to read given content.
+test_files:
+- spec/time_to_read_spec.rb