readingtime 0.3.1 → 0.4.0

data/.travis.yml

@@ -4,3 +4,5 @@ rvm:
   - 2.1.0
   - 1.9.3
   - 1.8.7
+before_install:
+  - gem install bundler

data/lib/readingtime/calculator.rb

@@ -0,0 +1,86 @@
+# encoding: utf-8
+module Readingtime
+  class Calculator
+    attr_reader :reading_speed
+
+    def initialize(opts = {})
+      @reading_speed = opts[:reading_speed] || 200
+    end
+
+    def reading_time(words, opts = {})
+      format_options = opts[:format] || :basic
+
+      word_size = calculate_size(words)
+      minutes = Readingtime.minutes_in_seconds(word_size)
+      seconds = Readingtime.seconds(word_size)
+
+      case format_options
+      when :basic
+        format_seconds((minutes + seconds))
+      when :long
+        format_words((minutes + seconds))
+      when :approx
+        format_approx((minutes + seconds))
+      when :full
+        hms = hms(minutes + seconds)
+        format_full(hms)
+      when :raw
+        hms(minutes + seconds)
+      end
+    end
+
+    # Calculations
+
+    def minutes_in_seconds(words)
+      (words / reading_speed).floor * 60
+    end
+
+    def seconds(words)
+      (words % reading_speed / (reading_speed / 60)).floor
+    end
+
+    def calculate_size(words)
+      words.scan(/(\w|-)+/).size
+    end
+
+    # Formatting
+
+    def hms(secs)
+      h, m, s = 0, 0, 0
+      h = secs / 3600
+      secs -= h * 3600
+      m = secs / 60
+      secs -= m * 60
+      [h, m, secs]
+    end
+
+    # TODO: Account for HH:MM:00
+    def format_seconds(seconds)
+      '%02d:%02d' % seconds.divmod(60)
+    end
+
+    def format_words(seconds)
+      if seconds >= 60
+        '%d minutes and %d seconds' % seconds.divmod(60)
+      else
+        "#{ seconds } seconds"
+      end
+    end
+
+    def format_approx(seconds)
+      if seconds > 59
+        '%d minutes' % (seconds.to_f/60).round
+      else
+        '%d seconds' % seconds
+      end
+    end
+
+    def 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
+end

data/lib/readingtime/configuration.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+module Readingtime
+  class Configuration
+    attr_accessor :reading_speed
+
+    def initialize
+      @reading_speed = 200
+    end
+  end
+end

data/lib/readingtime/core_ext.rb

@@ -1,29 +1,12 @@
+# encoding: utf-8
 String.class_eval do
   def reading_time(options = {})
+    calculator = options[:calculator] || Readingtime::Calculator.new
     format_options = options[:format] || :basic
-
-    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))
-    when :long
-      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
-
+    calculator.reading_time(self, :format => format_options)
   end
 
   def calculate_size
     self.scan(/(\w|-)+/).size
   end
-
 end

data/lib/readingtime/version.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module Readingtime
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/readingtime.rb

@@ -1,58 +1,58 @@
+# encoding: utf-8
 Dir[File.dirname(__FILE__) + '/readingtime/*.rb'].each do |file|
   require file
 end
 
 module Readingtime
-  #TODO: move this to a configuration object
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
   def self.reading_speed
-    200
+    configuration.reading_speed
   end
 
   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]
+    calculator = Calculator.new(:reading_speed => self.reading_speed)
+    calculator.hms(secs)
   end
 
   def self.minutes_in_seconds(words)
-    (words / self.reading_speed).floor * 60
+    calculator = Calculator.new(:reading_speed => self.reading_speed)
+    calculator.minutes_in_seconds(words)
   end
 
   def self.seconds(words)
-    (words % self.reading_speed / (self.reading_speed / 60)).floor
+    calculator = Calculator.new(:reading_speed => self.reading_speed)
+    calculator.seconds(words)
   end
 
   # TODO: Account for HH:MM:00
   def self.format_seconds(seconds)
-    '%02d:%02d' % seconds.divmod(60)
+    calculator = Calculator.new(:reading_speed => self.reading_speed)
+    calculator.format_seconds(seconds)
   end
 
   def self.format_words(seconds)
-    if seconds >= 60
-      '%d minutes and %d seconds' % seconds.divmod(60)
-    else
-      "#{ seconds } seconds"
-    end
-    
+    calculator = Calculator.new(:reading_speed => self.reading_speed)
+    calculator.format_words(seconds)
   end
 
   def self.format_approx(seconds)
-    if seconds > 59
-      '%d minutes' % (seconds.to_f/60).round
-    else 
-      '%d seconds' % seconds
-    end
+    calculator = Calculator.new(:reading_speed => self.reading_speed)
+    calculator.format_approx(seconds)
   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(" ")
+    calculator = Calculator.new(:reading_speed => self.reading_speed)
+    calculator.format_full(hms)
   end
-
 end

data/readingtime.gemspec

@@ -18,7 +18,8 @@ Gem::Specification.new do |s|
   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 'rake', '~> 10.5.0' if RUBY_VERSION < '1.9.3' # see: https://github.com/travis-ci/travis.rb/issues/380
+  s.add_development_dependency 'rake'              unless RUBY_VERSION < '1.9.3'
   s.add_development_dependency "rspec", "~>2.6"
 
 end

data/spec/readingtime/calculator_spec.rb

@@ -0,0 +1,102 @@
+# encoding: utf-8
+path = File.expand_path(File.dirname(__FILE__) + "/../../lib/")
+$LOAD_PATH.unshift(path) unless $LOAD_PATH.include?(path)
+require "readingtime"
+
+describe Readingtime::Calculator do
+  let(:two_hundred_words) { ("Lorem " * 200) }
+  let(:three_hundred_words) { ("Lorem " * 300) }
+  let(:ten_words) { ("Lorem " * 10) }
+
+  describe '.new' do
+    it 'sets a default reading_speed' do
+      subject.reading_speed.should eq(200)
+    end
+
+    it 'allows a custom reading speed' do
+      subject = described_class.new(:reading_speed => 250)
+      subject.reading_speed.should eq(250)
+    end
+  end
+
+  describe '#reading_time' do
+    it "should calculate the reading time of some text" do
+      subject.reading_time(two_hundred_words).should == "01:00"
+      subject.reading_time(three_hundred_words).should == "01:33"
+    end
+
+    it "should accept an options hash to format the output" do
+      subject.reading_time(ten_words, :format => :long).should == "3 seconds"
+      subject.reading_time(two_hundred_words, :format => :basic).should == "01:00"
+      subject.reading_time(two_hundred_words, :format => :long).should == "1 minutes and 0 seconds"
+      subject.reading_time(two_hundred_words, :format => :approx).should == "1 minutes"
+      subject.reading_time(three_hundred_words, :format => :long).should == "1 minutes and 33 seconds"
+      subject.reading_time(three_hundred_words,:format => :approx).should == "2 minutes"
+    end
+
+    it "should return a time in seconds when using approx with time less than 1 minute" do
+      subject.reading_time(ten_words, :format => :approx).should == "3 seconds"
+      subject.reading_time(three_hundred_words, :format => :full).should == '1 min 33 secs'
+      subject.reading_time(two_hundred_words, :format => :raw).should == [0, 1, 0]
+    end
+  end
+
+  describe '#calculate_size' do
+    it "should calculate the length of the string input" do
+      subject.calculate_size(two_hundred_words).should == 200
+    end
+  end
+
+  describe '#minutes_in_seconds' do
+    it "should calculate the number of minutes the reading should take" do
+      words = subject.calculate_size(two_hundred_words)
+      subject.minutes_in_seconds(words).should == 60
+    end
+  end
+
+  describe '#seconds' do
+    it "should calculate the remaining seconds the reading should take" do
+      words = subject.calculate_size(two_hundred_words)
+      subject.seconds(words).should == 0
+    end
+  end
+
+  describe '#format_seconds' do
+    it "should format the reading time in an MM:SS format" do
+      subject.format_seconds(3600).should == "60:00"
+      subject.format_seconds(60).should == "01:00"
+      subject.format_seconds(10).should == "00:10"
+      subject.format_seconds(1).should == "00:01"
+    end
+  end
+
+  describe '#format_full' do
+    it "should format the reading time in words" do
+      subject.format_full([1, 0, 0]).should == "1 hr"
+      subject.format_full([2, 0, 0]).should == "2 hrs"
+      subject.format_full([1, 1, 0]).should == "1 hr 1 min"
+      subject.format_full([2, 2, 0]).should == "2 hrs 2 mins"
+      subject.format_full([1, 1, 1]).should == "1 hr 1 min 1 sec"
+      subject.format_full([2, 2, 2]).should == "2 hrs 2 mins 2 secs"
+    end
+  end
+
+  describe '#format_approx' do
+    it "should format the reading time to the nearest minute" do
+      subject.format_approx(3600).should == "60 minutes"
+      subject.format_approx(119).should == "2 minutes"
+      subject.format_approx(61).should == "1 minutes"
+      subject.format_approx(60).should == "1 minutes"
+      subject.format_approx(59).should == "59 seconds"
+    end
+  end
+
+  describe '#hms' do
+    it "should format the reading time in an array of hours, minutes, seconds" do
+      subject.hms(3600).should == [1, 0, 0]
+      subject.hms(60).should == [0, 1, 0]
+      subject.hms(10).should == [0, 0, 10]
+      subject.hms(1).should == [0, 0, 1]
+    end
+  end
+end

data/spec/readingtime/configuration_spec.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+path = File.expand_path(File.dirname(__FILE__) + "/../../lib/")
+$LOAD_PATH.unshift(path) unless $LOAD_PATH.include?(path)
+require "readingtime"
+
+describe Readingtime::Configuration do
+
+  describe '.new' do
+    it 'sets the default reading_speed' do
+      subject.reading_speed.should == 200
+    end
+  end
+
+  describe '#reading_speed' do
+    it 'returns the reading_speed' do
+      subject.reading_speed.should == 200
+    end
+  end
+
+  describe '#reading_speed=' do
+    it 'sets the reading_speed' do
+      subject.reading_speed = 250
+      subject.reading_speed.should == 250
+    end
+  end
+
+end

data/spec/readingtime_spec.rb

@@ -3,7 +3,6 @@ path = File.expand_path(File.dirname(__FILE__) + "/../lib/")
 $LOAD_PATH.unshift(path) unless $LOAD_PATH.include?(path)
 require "readingtime"
 
-
 describe Readingtime do
   let(:two_hundred_words) { ("Lorem " * 200) }
   let(:three_hundred_words) { ("Lorem " * 300) }
@@ -66,4 +65,20 @@ describe Readingtime do
     two_hundred_words.reading_time(:format => :raw).should == [0, 1, 0]
   end
 
+  it 'should use the default reading speed from configuration' do
+    Readingtime.reading_speed.should == 200
+  end
+
+  it "should use reading speed from configuration" do
+    Readingtime.configure do |config|
+      config.reading_speed = 250
+    end
+
+    Readingtime.reading_speed.should == 250
+
+    Readingtime.configure do |config|
+      config.reading_speed = 200
+    end
+  end
+
 end

metadata

@@ -1,32 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: readingtime
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
+  prerelease: 
 platform: ruby
 authors:
 - Gareth Rees
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-20 00:00:00.000000000 Z
+date: 2016-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -52,31 +57,36 @@ files:
 - README.md
 - Rakefile
 - lib/readingtime.rb
+- lib/readingtime/calculator.rb
+- lib/readingtime/configuration.rb
 - lib/readingtime/core_ext.rb
 - lib/readingtime/version.rb
 - readingtime.gemspec
+- spec/readingtime/calculator_spec.rb
+- spec/readingtime/configuration_spec.rb
 - 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: 2.0.14
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Estimates reading time
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 55e652795450d840f9f5418723cb5300bf354650
-  data.tar.gz: 1a50232ab4d76f943c88df5e236839c6872807ee
-SHA512:
-  metadata.gz: cb518c3509e13c6d2c6129c1dab95b32d36c58f8aa128ab629a8ad79ccf6ada92e49b1dc498627e6134278b409e350d8973503947f56295c199847e1b9179497
-  data.tar.gz: 420dfceb1c1dd449cd5ce7d69b3401cffceb2c4e69bfeebab085ed1a9f083ce4afbdefb4292f5ff2a7b12d720d32fd475a8863f85d7e2636f229d58a9a7e64bf