cw 0.2.4 → 0.3.0

data/example.rb

@@ -1,137 +1,203 @@
 require 'cw'
 
 cw do
-  comment 'read book feed (1 sentence)'
-  read_book(sentences: 1)
+  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 'read book feed (1 minute)'
-  read_book(duration: 1)
+  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 'read rss feed (1 article)'
-  read_rss(:reuters, 1)
+  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
-  name 'test straight alphabet'
-  alphabet
+  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 'test straight numbers'
-  numbers
+  comment 'read rss feed (quote of the day)'
+  wpm 18
+  read_rss(:quotation, 1)
 end
 
 cw do
-  wpm  18
-  ewpm 12
+  comment 'test 6 common cw abbreviations'
+  wpm  15
   load_abbreviations
   shuffle
+  word_count 6
 end
 
 cw do
-  wpm  18
-  ewpm 12
-  load_q_codes
+  comment "test 8 Q codes by ear (no keyboard test)"
+  wpm  20
+  load_codes
   shuffle
+  word_count 8
+  print_words
 end
 
-def cw_settings
+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
-  ewpm 15
-  #  use_ebook2cw
-  use_ruby_tone
-  mark_words
-  word_count 5
-  word_size 4
-  print_letters
-  puts self.to_s
-end
-
-cw do
-  comment 'test random letters'
-  random_letters(size: 4)
-  cw_settings
-end
-
-cw do
-  comment 'test random numbers'
-#  use_ebook2cw
-  cw_settings
-  random_numbers(count: 2, size: 5)
-end
-
-cw do
-  comment 'test random letters numbers'
-#  use_ebook2cw
-  cw_settings
-  random_letters_numbers(count: 2, size: 11)
-end
-
-wpm = 15
-ewpm = 12
-loop do
-
-  test = cw
-#  test.use_ebook2cw
-  test.comment 'test words beginning with b'
-  test.shuffle
-  test.wpm             wpm
-  test.effective_wpm   ewpm
-  test.beginning_with  'b'
-  test.word_size       4
-  test.word_count      4
-  puts test.to_s
-  test.test_words
-
-  test = cw
-  test.comment 'test words including ing'
-#  test.use_ebook2cw
-  test.shuffle
-  test.wpm             wpm
-  test.effective_wpm   ewpm
-  test.including       'ing'
-  test.word_count      5
-  test.test_words
-
-  #  test = cw
-  #  test.comment         'test ing'
-  #  test.use_ebook2cw
-  ##  test.shuffle
-  #  test.wpm             wpm
-  #  test.effective_wpm   ewpm
-  #  test.beginning_with ['f']
-  #  test.word_size       4
-  #  test.word_count      5
-  #  test.test_words
-  #
-  #  test = cw
-  #  test.comment         'test ing'
-  #  test.use_ruby_tone
-  ##  test.shuffle
-  #  test.wpm             wpm
-  #  test.effective_wpm   ewpm
-  #  test.beginning_with ['f']
-  #  test.word_size       4
-  #  test.word_count      5
-  #  test.test_words
-
-  #  test = cw
-  #  test.comment         'test ing'
-  #  test.shuffle
-  #  test.wpm             wpm
-  #  test.effective_wpm   ewpm
-  #  test.beginning_with ['j']
-  #  test.word_size       4
-  #  test.word_count      5
-  #  test.test_words
-  #
-  wpm += 2
-  break if wpm >= 24
+  load_text("test/my_words.txt")
+  shuffle
+  word_count 4
 end
 
+# See documentation for more details - and more commands.
+
 puts 'done'

data/lib/cw.rb

@@ -1,11 +1,14 @@
 # encoding: utf-8
 
 require_relative 'cw/file_details'
+require_relative 'cw/config'
+require_relative 'cw/os'
 require_relative 'cw/process'
 require_relative 'cw/text_helpers'
 require_relative 'cw/tone_helpers'
 require_relative 'cw/element'
 require_relative 'cw/current_word'
+require_relative 'cw/cw_encoding'
 require_relative 'cw/cw_dsl'
 require_relative 'cw/randomize'
 require_relative 'cw/sentence'
@@ -15,7 +18,6 @@ require_relative 'cw/str'
 require_relative 'cw/rss'
 require_relative 'cw/words'
 require_relative 'cw/cl'
-require_relative 'cw/params'
 require_relative 'cw/key_input'
 require_relative 'cw/cw_stream'
 require_relative 'cw/timing'
@@ -24,151 +26,33 @@ require_relative 'cw/audio_player'
 require_relative 'cw/cw_threads'
 require_relative 'cw/book_details'
 require_relative 'cw/tester'
+require_relative 'cw/play'
 require_relative 'cw/test_words'
 require_relative 'cw/test_letters'
 require_relative 'cw/repeat_word'
 require_relative 'cw/reveal'
 require_relative 'cw/book'
-require_relative 'cw/cw_encoding'
+#require_relative 'cw/tx'
 require_relative 'cw/tone_generator'
 require_relative 'cw/progress'
-require_relative 'cw/config_file'
-
-# CW provides Morse code generation functionality
+require_relative 'cw/common_words'
 
 def cw &block
   CW.new do
-    instance_eval &block
+    instance_eval(&block)
   end
 end
 
-class CW < CwDsl
+# CW provides Morse code generation functionality
+# Inherits CwDsl
 
-#FIXME dry_run
-#  attr_accessor :dry_run
+class CW < CWG::CwDsl
 
   # Initialize CW class. Eval block if passed in.
 
   def initialize(&block)
-
     super
-
-    load_common_words# unless @words.exist?
-    ConfigFile.new.apply_config self
     instance_eval(&block) if block
     run if block
   end
-
-  # Test user against letters rather than words.
-  #
-
-  def test_letters
-    Params.pause = true
-    test_letters = TestLetters.new
-    test_letters.run @words
-  end
-
-  # Test user against complete words rather than letters.
-  #
-
-  def test_words
-    Params.pause = true
-    tw = TestWords.new
-    tw.run @words
-  end
-
-  # Repeat word repeats the current word if the word is entered incorrectly (or not entered at all).
-  #
-
-  def repeat_word
-    Params.pause = true
-    repeat_word = RepeatWord.new
-    repeat_word.run @words
-  end
-
-  # Reveal words only at end of test.
-  # Useful for learning to copy `in the head'
-
-  def reveal
-    Params.pause = true
-    reveal = Reveal.new
-    reveal.run @words
-  end
-
-  # Return string containing name or comment of test.
-  # @return [String] comment / name
-
-  def to_s
-    @str.to_s
-  end
-
-  def list
-    Print.new.list self.to_s
-    puts
-  end
-
-  # Play book using provided arguments.
-  # @param [Hash] args the options to play book with.
-  # @option args [Integer] :sentences Number of sentences to play
-  # @option args [Integer] :duration  Number of minutes to play
-  # @option args [Boolean] :letter Mark by letter if true else mark by word
-
-  def read_book args = {}
-    Params.pause = true
-    details = BookDetails.new
-    details.arguments(args)
-    book = Book.new details
-    book.run @words
-  end
-
-  # Convert book to mp3.
-
-  def convert_book args = {}
-    details = BookDetails.new
-    details.arguments(args)
-    book = Book.new details
-    Params.pause = true
-    book.convert
-  end
-
-  # Reads RSS feed (requires an internet connection). Feed can be one of:
-  # - bbc:
-  # - reuters:
-  # - guardian:
-  # - quotation:
-  # @param [Symbol] source The source of the feed.
-  # @param [Integer] article_count Number of articles to play.
-
-  def read_rss(source, article_count = 3)
-    Params.pause = true
-    rss, = Rss.new
-    rss.read_rss(source, article_count)
-    loop do
-      article = rss.next_article
-      return unless article
-      @words.assign article
-      run
-    end
-  end
-
-  # Run word test
-  def run
-    return if Params.pause
-    test_words
-  end
-
-  alias_method :ewpm,                  :effective_wpm
-  alias_method :no_run,                :pause
-  alias_method :comment,               :name
-  alias_method :word_length,           :word_size
-  alias_method :word_shuffle,          :shuffle
-  alias_method :having_size_of,        :word_size
-  alias_method :number_of_words,       :word_count
-  alias_method :words_including,       :including
-  alias_method :words_ending_with,     :ending_with
-  alias_method :random_alphanumeric,   :random_letters_numbers
-  alias_method :words_beginning_with,  :beginning_with
-  alias_method :words_no_longer_than,  :no_longer_than
-  alias_method :words_no_shorter_than, :no_shorter_than
-
 end