speed_read 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 68eab501d2fbfe6779d2d9114b0c2cbe0a34b671
+  data.tar.gz: df2088a97800293b28070ec6ba04f2b119540866
+SHA512:
+  metadata.gz: d8bb2ec82f771c73da8e28c788624cddfed66b0a22cb18013da366d4d3da85c2e67687f3191b1c28e6e95605a1a494ac041e53a8de05e5db8577259210538767
+  data.tar.gz: 4fcd316b424c64e4f06f0558fa34f772b3745bb47279f2b8fff95d66c6258b68d5fe4a3e305f421da838032198a9723ed967dc43444f2d51cb031be2a5e79983

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/Gemfile

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

data/History.txt

@@ -0,0 +1,2 @@
+== 0.0.1 / 2014-03-03
+  * Birthday!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Thomas Arni
+
+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,42 @@
+# SpeedRead
+
+This is a yet simplistic implementation in ruby of [Pasky's Perl version](https://github.com/pasky/speedread).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'speed_read'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install speed_read
+
+## Usage
+speed_read reads from standard input. Thus, 
+you can use the usual unix suspects.
+
+    $ echo "one two tree" | speed_read
+    $ speed_read < your_text_file.txt
+    $ cat your_text_file.txt | speed_read
+
+To set the words per minute use
+
+    $ echo "one two tree" | speed_read -w 500
+
+## Test
+In order to test the gem locally, use:
+    
+    bundle exec rake test
+
+## Contributing
+
+1. Fork it ( http://github.com/sunsations/speed_read/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,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/*_test.rb'
+end
+
+desc "Run tests"
+task default: :test

data/bin/speed_read

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require 'colorize'
+require 'optparse'
+require 'speed_read'
+
+options = {}
+optparse = OptionParser.new do|opts|
+  opts.banner = "Usage: speed_read [options] file1 file2 ..."
+  options[:wpm] = 250
+  opts.on('-w', '--wpm WPM', 'Sets words per minute to WPM') do |wpm|
+    options[:wpm] = wpm.to_i
+  end
+end
+optparse.parse!
+
+SpeedRead.start(options[:wpm])

data/lib/speed_read/version.rb

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

data/lib/speed_read.rb

@@ -0,0 +1,45 @@
+require "speed_read/version"
+require "colorize"
+
+module SpeedRead
+
+  ORP_VISUAL_POS = 20;
+
+  class << self
+    trap("INT") { puts "\nGoodbye!"; exit;}
+
+    def start(words_per_minute)
+      puts " " * ORP_VISUAL_POS + "v".colorize(:red)
+      ARGF.each do |line|
+         words = line.chomp.split(/(?:-|\s)+/).compact.reject{|e| e.empty?}
+         words.each do |w|
+           word = w.chomp.strip
+           # pad the end of your lines with spaces if they might be shorter than the previous line.
+           i = find_ORP(word);
+           output = " " * (ORP_VISUAL_POS-i) + colorize_word(word,i)
+           print output.ljust(80, " ") + "#{words_per_minute} wpm\r"
+           $stdout.flush
+           sleep (60.0 / words_per_minute.to_i)
+         end
+      end
+      puts
+    end
+
+    # ORP: Optical Recognition Point (the red-colored alignment pilot),
+    # # the way Spritz probably does it.
+    def find_ORP(word)
+      return 0 if word.nil?
+      return 4 if word.length > 13
+      return [0, 0, 1, 1, 1, 1, 2, 2, 2, 2, 3, 3, 3, 3][word.size];
+    end
+
+    def colorize_word(word, i)
+      return "" unless word
+      pre    = word[0...i]
+      pivot  = word[i] ? word[i].colorize(:red) : ""
+      suffix = word[i+1..-1]
+      "#{pre}#{pivot}#{suffix}"
+    end
+
+  end
+end

data/scripts/build_install_test.sh

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+gem build speed_read.gemspec && gem install ./speed_read-0.0.1.gem && head -n 21 tea.txt | speed_read

data/speed_read.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'speed_read/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "speed_read"
+  spec.version       = SpeedRead::VERSION
+  spec.authors       = ["Thomas Arni"]
+  spec.email         = ["thomas.arni@gmail.com"]
+  spec.summary       = %q{A simple terminal-based open source spritz-alike.}
+  spec.description   = %q{A simple terminal-based open source spritz-alike. Allows you to read at a much more rapid pace.}
+  #TODO set correct homepage
+  spec.homepage      = "https://github.com/sunsations"
+  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.4"
+  spec.add_development_dependency "rake", '~> 0'
+  spec.add_dependency 'colorize', '~> 0.6'
+end

data/tea.txt

@@ -0,0 +1,113 @@
+                            A Nice Cup of Tea
+
+                             By George Orwell
+
+                    Evening Standard, 12 January 1946.
+
+If you look up 'tea' in the first cookery book that comes to hand you will
+probably find that it is unmentioned; or at most you will find a few lines
+of sketchy instructions which give no ruling on several of the most
+important points.
+
+This is curious, not only because tea is one of the main stays of
+civilization in this country, as well as in Eire, Australia and New
+Zealand, but because the best manner of making it is the subject of
+violent disputes.
+
+When I look through my own recipe for the perfect cup of tea, I find no
+fewer than eleven outstanding points. On perhaps two of them there would
+be pretty general agreement, but at least four others are acutely
+controversial. Here are my own eleven rules, every one of which I regard
+as golden:
+
+  * First of all, one should use Indian or Ceylonese tea. China tea has
+    virtues which are not to be despised nowadays — it is economical, and
+    one can drink it without milk — but there is not much stimulation in
+    it. One does not feel wiser, braver or more optimistic after drinking
+    it. Anyone who has used that comforting phrase 'a nice cup of tea'
+    invariably means Indian tea.
+
+  * Secondly, tea should be made in small quantities — that is, in a
+    teapot. Tea out of an urn is always tasteless, while army tea, made in
+    a cauldron, tastes of grease and whitewash. The teapot should be made
+    of china or earthenware. Silver or Britanniaware teapots produce
+    inferior tea and enamel pots are worse; though curiously enough a
+    pewter teapot (a rarity nowadays) is not so bad.
+
+  * Thirdly, the pot should be warmed beforehand. This is better done by
+    placing it on the hob than by the usual method of swilling it out with
+    hot water.
+
+  * Fourthly, the tea should be strong. For a pot holding a quart, if you
+    are going to fill it nearly to the brim, six heaped teaspoons would be
+    about right. In a time of rationing, this is not an idea that can be
+    realized on every day of the week, but I maintain that one strong cup
+    of tea is better than twenty weak ones. All true tea lovers not only
+    like their tea strong, but like it a little stronger with each year
+    that passes — a fact which is recognized in the extra ration issued to
+    old-age pensioners.
+
+  * Fifthly, the tea should be put straight into the pot. No strainers,
+    muslin bags or other devices to imprison the tea. In some countries
+    teapots are fitted with little dangling baskets under the spout to
+    catch the stray leaves, which are supposed to be harmful. Actually one
+    can swallow tea-leaves in considerable quantities without ill effect,
+    and if the tea is not loose in the pot it never infuses properly.
+
+  * Sixthly, one should take the teapot to the kettle and not the other
+    way about. The water should be actually boiling at the moment of
+    impact, which means that one should keep it on the flame while one
+    pours. Some people add that one should only use water that has been
+    freshly brought to the boil, but I have never noticed that it makes
+    any difference.
+
+  * Seventhly, after making the tea, one should stir it, or better, give
+    the pot a good shake, afterwards allowing the leaves to settle.
+
+  * Eighthly, one should drink out of a good breakfast cup — that is, the
+    cylindrical type of cup, not the flat, shallow type. The breakfast cup
+    holds more, and with the other kind one's tea is always half cold
+    before one has well started on it.
+
+  * Ninthly, one should pour the cream off the milk before using it for
+    tea. Milk that is too creamy always gives tea a sickly taste.
+
+  * Tenthly, one should pour tea into the cup first. This is one of the
+    most controversial points of all; indeed in every family in Britain
+    there are probably two schools of thought on the subject. The
+    milk-first school can bring forward some fairly strong arguments, but
+    I maintain that my own argument is unanswerable. This is that, by
+    putting the tea in first and stirring as one pours, one can exactly
+    regulate the amount of milk whereas one is liable to put in too much
+    milk if one does it the other way round.
+
+  * Lastly, tea — unless one is drinking it in the Russian style — should
+    be drunk without sugar. I know very well that I am in a minority here.
+    But still, how can you call yourself a true tealover if you destroy
+    the flavour of your tea by putting sugar in it? It would be equally
+    reasonable to put in pepper or salt. Tea is meant to be bitter, just
+    as beer is meant to be bitter. If you sweeten it, you are no longer
+    tasting the tea, you are merely tasting the sugar; you could make a
+    very similar drink by dissolving sugar in plain hot water.
+
+    Some people would answer that they don't like tea in itself, that they
+    only drink it in order to be warmed and stimulated, and they need
+    sugar to take the taste away. To those misguided people I would say:
+    Try drinking tea without sugar for, say, a fortnight and it is very
+    unlikely that you will ever want to ruin your tea by sweetening it
+    again.
+
+These are not the only controversial points to arise in connexion with tea
+drinking, but they are sufficient to show how subtilized the whole
+business has become. There is also the mysterious social etiquette
+surrounding the teapot (why is it considered vulgar to drink out of your
+saucer, for instance?) and much might be written about the subsidiary uses
+of tealeaves, such as telling fortunes, predicting the arrival of
+visitors, feeding rabbits, healing burns and sweeping the carpet. It is
+worth paying attention to such details as warming the pot and using water
+that is really boiling, so as to make quite sure of wringing out of one's
+ration the twenty good, strong cups of that two ounces, properly handled,
+ought to represent.
+
+(taken from The Collected Essays, Journalism and Letters of George Orwell,
+Volume 3, 1943-45, Penguin ISBN, 0-14-00-3153-7)

data/test/speed_read_test.rb

@@ -0,0 +1,27 @@
+require_relative 'test_helper'
+
+require 'minitest/autorun'
+
+class SpeedReadTest < Minitest::Unit::TestCase
+
+  def test_find_correct_orp
+    assert_equal 0, SpeedRead.find_ORP("")
+    assert_equal 0, SpeedRead.find_ORP("1")
+    assert_equal 1, SpeedRead.find_ORP("12")
+    assert_equal 1, SpeedRead.find_ORP("12345")
+    assert_equal 2, SpeedRead.find_ORP("123456")
+    assert_equal 2, SpeedRead.find_ORP("123456789")
+    assert_equal 3, SpeedRead.find_ORP("1234567890")
+    assert_equal 4, SpeedRead.find_ORP("123456789012345678")
+  end
+
+  def test_word_colorize
+    assert_equal "a\e[0;31;49mb\e[0mc", SpeedRead.colorize_word("abc", 1)
+    assert_equal "12\e[0;31;49m3\e[0m456789", SpeedRead.colorize_word("123456789", 2)
+  end
+
+  def test_word_colorize_with_invalid_input
+    assert_equal "", SpeedRead.colorize_word(nil, 0)
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'minitest/unit'
+
+Dir[File.dirname(__FILE__) + '/../lib/**/*.rb'].each do |rb_file|                                                   
+   require rb_file
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: speed_read
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Thomas Arni
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !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: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: A simple terminal-based open source spritz-alike. Allows you to read
+  at a much more rapid pace.
+email:
+- thomas.arni@gmail.com
+executables:
+- speed_read
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- History.txt
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/speed_read
+- lib/speed_read.rb
+- lib/speed_read/version.rb
+- scripts/build_install_test.sh
+- speed_read.gemspec
+- tea.txt
+- test/speed_read_test.rb
+- test/test_helper.rb
+homepage: https://github.com/sunsations
+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: A simple terminal-based open source spritz-alike.
+test_files:
+- test/speed_read_test.rb
+- test/test_helper.rb
+has_rdoc: