cw 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e1587225798871292fb766303aa33e8aa488d72
-  data.tar.gz: 7d75a4190163a579f8cc88f9287e579c1657facd
+  metadata.gz: 7e3d3d2ac3c6f0d0768543c4140ca14035c23c65
+  data.tar.gz: c110606d40f04c564262883c565fe38c99fed9f3
 SHA512:
-  metadata.gz: 85ec2d8ab4291cae6fa85f3e02700a080e4bdba7e634378de4d445c656b0b39375805978a80ce4e93fa1388c128815d96d6a4fcfab0302b451766d57661e790d
-  data.tar.gz: 4e61d5b90e40004359ae53751555c3de33a135f02c333ce9d15fc842b0b227b09a77e84846b26841cc1bc4dff77c30f15aae1e1eb0639c130a9e799a9a9ad9cd
+  metadata.gz: 4794a516a4b8881d24d1bebc9f0c9bc63921b8a4eca97a8ce551ac111055d9afbd86fc290502ba36f8bec78f20ef2f6036303060c1b826430137725d03d6c7b4
+  data.tar.gz: 20cf42901391040da1865eb6cf6092e8ba22e707578b7fc7ae19d8df091a8f1c23a47741f27670883ebd8e93973e0374b2cb928195cf55eef7f8f0aea70709b0

data/.cw_config

@@ -0,0 +1,18 @@
+wpm             = 25
+frequency       = 450
+volume          = 1
+book_name       = book.txt
+book_dir        = data/text/
+success_colour  = green
+fail_colour     = red
+list_colour     = default
+ebook2cw_path   = /usr/bin/ebook2cw
+run_default     = test_letters
+dictionary_dir  = data/text/
+dictionary_name = english.txt
+audio_filename  = audio_output
+audio_dir       = audio
+book_name       = book.txt
+book_dir        = data/text/
+run_default     = test_letters
+word_count      = 16

data/.gitignore

@@ -8,7 +8,8 @@ Gemfile.lock
 *.gem
 *.rbc
 .bundle
-.cw_config
+# .cw_config
+test.sqlite
 coverage
 InstalledFiles
 lib/bundler/man
@@ -32,3 +33,11 @@ audio/audio_output.wav
 /audio/e_space.wav
 /audio/space.wav
 /audio/audio_output.wav0000.mp3
+/_audio/
+/_books/
+/audio/audio_output
+/audio/audio_output.mp30000.mp3
+/data/text/book3.txt
+/.yardoc/
+/.yardoc/
+/.yardoc/

data/LICENSE

@@ -1,5 +1,6 @@
 CW
-Copyright (c) 2015 Martyn Jago <martyn.jago@btinternet.com>
+
+Copyright (c) 2016 Martyn Jago <martyn.jago@btinternet.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to

data/README.md

@@ -16,113 +16,229 @@ addition to generating random words, letters, and numbers that possibly match so
 
 **CW** also allows for real-time progress marking by indicating correct and incorrect characters and words copied in real-time. A follow mode also exists which prints the output just after it has played it (for `in head' practice).
 
-**CW** is thoroughly [documented](http://mjago.github.io/CW/), and includes a [hands-on tutorial](http://mjago.github.io/CW/mydoc_five_common_words/).
+**CW** is thoroughly [documented](http://mjago.github.io/CW/), and includes a [hands-on tutorial](http://martynjago.co.uk/CW/mydoc_learning_the_alphabet/).
 
 # Installation:
 
 ```sh
 gem install cw
-ruby example.rb
+cw example.rb
 ```
 
- * Note: Currently only tested on OS X, and Ruby v1.9.3 and later.
+### Note:
 
-# Example test-script
+ - Requires Ruby 2+
+ - Tested on OS X, and Linux.
+
+# Example CW Script
 
 ```ruby
 
-# example.rb (example script)
-
-  require 'cw'
-
-  cw do
-    wpm 18
-    comment 'read book (1 sentence)'
-    play_book(sentences: 1)
-  end
-
-  cw do
-    wpm 18
-    ewpm 12
-    comment 'read book (2 minutes)'
-    play_book(duration: 2)
-  end
-
-  cw do
-    comment 'read rss feed (1 article)'
-    read_rss(:reuters, 1)
-  end
-
-  cw do
-    name 'test straight alphabet'
-    alphabet
-  end
-
-  cw do
-    comment 'test straight numbers'
-    numbers
-  end
-
-  cw do
-    wpm  18
-    ewpm 12
-    load_abbreviations
-    shuffle
-  end
-
-
-# ...or instantiate CW...
-
-wpm = 16
-
-test = CW.new
-test.comment 'test words beginning with "b" (repeat word)'
-test.shuffle
-test.wpm             wpm
-test.beginning_with  'b'
-test.word_size        4
-test.word_count       2
-puts test.to_s
-test.repeat_word
-
-test = CW.new
-test.comment 'test words ending with "ing" (test letters)'
-test.shuffle
-test.wpm             wpm
-test.ending_with     'e'
-test.word_size        4
-test.word_count       2
-puts test.to_s
-test.test_letters
-
-test = CW.new
-test.comment 'test words including "th" (test words)'
-test.shuffle
-test.wpm             wpm
-test.including       'th'
-test.word_size        4
-test.word_count       2
-puts test.to_s
-test.test_words
-
-test = CW.new
-test.comment 'test words no longer than 6 letters (test letters)'
-test.shuffle
-test.wpm             wpm
-test.no_longer_than   6
-test.word_count       2
-puts test.to_s
-test.test_letters
-
-test = CW.new
-test.comment 'test words no shorter than 6 letters (print letters)'
-test.shuffle
-test.wpm             wpm
-test.no_shorter_than  6
-test.word_count       2
-puts test.to_s
-test.print_letters
-test.test_letters
+# example.rb
+
+require 'cw'
+
+cw do
+  comment 'test single element letters'
+  wpm 15
+  load_alphabet :size, 1
+  shuffle
+end
+
+cw do
+  comment 'test 2 element letters'
+  wpm 15
+  load_alphabet :size, 2
+  shuffle
+end
+
+cw do
+  comment 'test less than 3 element letters'
+  wpm 15
+  load_alphabet :less_than, 3
+  shuffle
+end
+
+cw do
+  comment 'test 3 element letters'
+  wpm 15
+  load_alphabet :size, 3
+  shuffle
+end
+
+cw do
+  comment 'test less than 4 element letters'
+  wpm 15
+  load_alphabet :less_than, 4
+  shuffle
+end
+
+cw do
+  comment 'test 4 element letters'
+  wpm 15
+  load_alphabet :size, 4
+  shuffle
+end
+
+cw do
+  comment 'test alphabet vowels'
+  wpm 15
+  load_vowels
+  shuffle
+end
+
+cw do
+  comment 'test letters a..m'
+  wpm 18
+  load_alphabet("a".."m")
+  shuffle
+end
+
+cw do
+  comment 'test 8 words made with letters a..m - test by letter'
+  wpm 18
+  containing('a'..'m')
+  shuffle
+  word_count 8
+end
+
+cw do
+  comment 'test letters n..z'
+  wpm 18
+  load_letters('n'..'z')
+  shuffle
+end
+
+cw do
+  comment 'test 8 words made with letters n..z - test by word'
+  wpm 18
+  containing('n'..'z')
+  shuffle
+  word_count 8
+  test_words
+end
+
+cw do
+  comment 'test numbers'
+  wpm 20
+  load_numbers
+  shuffle
+end
+
+cw do
+  comment 'test alphabet - repeat until correct'
+  wpm 25
+  load_alphabet
+  shuffle
+  repeat_word
+end
+
+cw do
+  comment 'test 8 most common words no longer than 4 letters'
+  wpm 20
+  load_most_common_words
+  shuffle
+  no_longer_than 4
+  word_count 8
+end
+
+cw do
+  comment 'test 4 most common words no shorter than 4 letters'
+  wpm 20
+  load_most_common_words
+  shuffle
+  no_shorter_than 4
+  word_count 8
+end
+
+cw do
+  comment 'test 8 words including letter sequence "ing"'
+  shuffle
+  including('ing')
+  word_size 6
+end
+
+cw do
+  comment 'test 8 words having 6 letters - play each word twice'
+  shuffle
+  word_size 6
+  word_count 8
+  double_words
+end
+
+cw do
+  comment 'test 8 words beginning with "qu" - repeat whole sequence once'
+  wpm 20
+  shuffle
+  beginning_with 'qu'
+  word_count 8
+  repeat 1
+end
+
+cw do
+  comment 'test 8 words ending with "tion" - test by word'
+  wpm 15
+  shuffle
+  ending_with 'tion'
+  word_count 8
+  test_words
+end
+
+cw do
+  comment 'read one sentence of book'
+  wpm 20
+  read_book(sentences: 1)
+end
+
+cw do
+  comment 'read rss feed (quote of the day)'
+  wpm 18
+  read_rss(:quotation, 1)
+end
+
+cw do
+  comment 'test 6 common cw abbreviations'
+  wpm  15
+  load_abbreviations
+  shuffle
+  word_count 6
+end
+
+cw do
+  comment "test 8 Q codes by ear (no keyboard test)"
+  wpm  20
+  load_codes
+  shuffle
+  word_count 8
+  print_words
+end
+
+cw do
+  comment "test 8 words by ear - reveal words at end of test"
+  wpm  20
+  shuffle
+  word_count 8
+  reveal
+end
+
+cw do
+  comment "reverse alphabet"
+  wpm 20
+  load_alphabet
+  reverse
+end
+
+cw do
+  comment "load my own word set"
+  wpm 20
+  load_text("test/my_words.txt")
+  shuffle
+  word_count 4
+end
+
+# See documentation for more details - and more commands.
+
+puts 'done'
 
 ```
 

data/Rakefile

@@ -1,10 +1,23 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
-
 require 'rake/version_task'
+require 'yard'
+
 Rake::VersionTask.new
 
 Rake::TestTask.new do |t|
+
   t.pattern = "test/test_*.rb"
-#  t.pattern = "test/test_tester.rb"
+#  t.pattern = "test/test_play.rb"
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']   # optional
+  t.options = ['--any', '--extra', '--opts'] # optional
+end
+
+desc "Test cw_scripts and check timings"
+task :test_scripts do
+  system "bundle exec ruby run_script_tests.rb"
+  puts "done"
 end

data/VERSION

@@ -1 +1 @@
-0.2.4
+0.3.0

data/Vagrantfile

@@ -0,0 +1,45 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure("2") do |config|
+  config.ssh.forward_x11 = true # useful since some audio testing programs use x11
+  config.vm.box = "precise64"
+  config.vm.box_url = "http://files.vagrantup.com/precise64.box"
+  config.vm.provision :shell, :inline => $BOOTSTRAP_SCRIPT # see below
+
+  # enable audio drivers on VM settings
+  config.vm.provider :virtualbox do |vb|
+    if RUBY_PLATFORM =~ /darwin/
+      vb.customize ["modifyvm", :id, '--audio', 'coreaudio', '--audiocontroller', 'hda'] # choices: hda sb16 ac97
+    elsif RUBY_PLATFORM =~ /mingw|mswin|bccwin|cygwin|emx/
+      vb.customize ["modifyvm", :id, '--audio', 'dsound', '--audiocontroller', 'ac97']
+    end
+  end
+
+end
+
+$BOOTSTRAP_SCRIPT = <<EOF
+  set -e # Stop on any error
+
+  # --------------- SETTINGS ----------------
+  # Other settings
+  export DEBIAN_FRONTEND=noninteractive
+
+  sudo apt-get update
+
+  # ---- OSS AUDIO
+  sudo usermod -a -G audio vagrant
+  sudo apt-get install -y oss4-base oss4-dkms oss4-source oss4-gtk linux-headers-3.2.0-23 debconf-utils
+  sudo ln -s /usr/src/linux-headers-$(uname -r)/ /lib/modules/$(uname -r)/source || echo ALREADY SYMLINKED
+  sudo module-assistant prepare
+  sudo module-assistant auto-install -i oss4 # this can take 2 minutes
+  sudo debconf-set-selections <<< "linux-sound-base linux-sound-base/sound_system select  OSS"
+  echo READY.
+
+  # have to reboot for drivers to kick in, but only the first time of course
+  if [ ! -f ~/runonce ]
+  then
+    sudo reboot
+    touch ~/runonce
+  fi
+EOF