read_time_estimator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2353f2fd643db245a883f9a380c6a741de9f0352
+  data.tar.gz: 290ffab835538aeabdd2ebd80a4cb7d77aeff0d2
+SHA512:
+  metadata.gz: 2c17e0e77b44480ee21e3e2a8e32e6702d1adfcd827ab8aa66e15b98987a1738e3cbfda19b6a58e3a5b394c8eb3bb173671f5fa290e7929680df7293835cb748
+  data.tar.gz: 6420f523562c0a9a7cce8aa7a39503c37693dc8aa7c67e3bc9feabb6804f969bc6f5c59c827358ac36ce57e04fb26073df6cf127fd2f54b02b474f208fe3f4de

data/.gitignore

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

data/.rbenv-gemsets

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

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,29 @@
+# ReadTimeEstimator
+
+TODO: Write a gem description
+
+## 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
+
+TODO: Write usage instructions here
+
+## 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/read_time_estimator.rb

@@ -0,0 +1,62 @@
+require "read_time_estimator/version"
+
+module ReadTimeEstimator
+  module String
+    def minutes_to_read
+      self.split(' ').count/250.0
+    end
+
+    def read_time_words
+      time = minutes_to_read
+      words = []
+      if read_time_hours(time)
+        words << read_time_hours(time)
+        time = time % 60
+      end
+      if read_time_minutes(time)
+        words << read_time_minutes(time)
+        time = time % 1
+      end
+      if read_time_seconds(time)
+        words << read_time_seconds(time)
+      end
+      words << "1 second" if words.empty?
+      words = words.reverse
+      words.insert(2, ", ") if words[2]
+      words.insert(1, " and ") if words[1]
+      words = words.reverse
+      words.join + " to read"
+    end
+
+    def read_time_hours(time)
+      hours = (time/60).to_i
+      hours >= 1 ? hours_in_words(hours) : nil
+    end
+
+    def hours_in_words(hours)
+      hours == 1 ? "#{hours} hour" : "#{hours} hours"
+    end
+
+    def read_time_minutes(time)
+      minutes = time.to_i
+      minutes > 1 ? minutes_in_words(minutes) : nil
+    end
+
+    def minutes_in_words(minutes)
+      minutes == 1 ? "#{minutes} minute" : "#{minutes} minutes"
+    end
+
+    def read_time_seconds(time)
+      seconds = (time * 60).to_i
+      seconds > 1 ? seconds_in_words(seconds) : nil
+    end
+
+    def seconds_in_words(seconds)
+      seconds == 1 ? "#{seconds} second" : "#{seconds} seconds"
+    end
+  end
+end
+
+class String
+  include ReadTimeEstimator::String
+end

data/lib/read_time_estimator/version.rb

@@ -0,0 +1,3 @@
+module ReadTimeEstimator
+  VERSION = "0.0.1"
+end

data/read_time_estimator.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'read_time_estimator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "read_time_estimator"
+  spec.version       = ReadTimeEstimator::VERSION
+  spec.authors       = ["Abby Ihrig", "Ana Tighe"]
+  spec.email         = ["abby@planetargon.com", "ana@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      = ""
+  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

data/spec/read_time_estimator_spec.rb

@@ -0,0 +1,45 @@
+require "read_time_estimator"
+require 'rspec'
+
+describe "ReadTimeEstimator" 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 "read_time_words" do
+    it "returns the reading time in phrase form when there is an even number of minutes" do
+      text = "word " * 500
+      expect(text.read_time_words).to eql "2 minutes to read"
+    end
+
+    it "returns the reading time in phrase form when there are seconds" do
+      text = "word " * 625
+      expect(text.read_time_words).to eql "2 minutes and 30 seconds to read"
+    end
+
+    it "returns the reading time in phrase form when read time is an hour" do
+      text = "word " * 15000
+      expect(text.read_time_words).to eql "1 hour to read"
+    end
+
+    it "returns the reading time in phrase form when read time include an hour, minutes, and seconds" do
+      text = "word " * 22550
+      expect(text.read_time_words).to eql "1 hour, 30 minutes and 12 seconds to read"
+    end
+
+    it "returns a minimum read time if the calculation is less than a second" do
+      text = "word"
+      expect(text.read_time_words).to eql "1 second to read"
+    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.read_time_words).to eql "2 hours to read"
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: read_time_estimator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Abby Ihrig
+- Ana Tighe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-01 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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rbenv-gemsets
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/read_time_estimator.rb
+- lib/read_time_estimator/version.rb
+- read_time_estimator.gemspec
+- spec/read_time_estimator_spec.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Estimates amount of time required to read given content.
+test_files:
+- spec/read_time_estimator_spec.rb