cw 0.2.4 → 0.3.0

data/test/my_words.txt

@@ -0,0 +1 @@
+one two three four five six seven eignt nine ten

data/test/test_common_words.rb

@@ -0,0 +1,71 @@
+require 'simplecov'
+$VERBOSE = nil #FIXME
+SimpleCov.start
+
+require 'minitest/autorun'
+require 'minitest/pride'
+require_relative '../lib/cw'
+
+class TestCommonWords < MiniTest::Test
+
+  ROOT = File.expand_path File.dirname(__FILE__) + '/../'
+
+  def setup
+    @words = CWG::CommonWords.new
+  end
+
+  def teardown
+    @words = nil
+  end
+
+  def test_parse_quantity_for_1
+    assert_equal [0], @words.parse_quantity(1)
+  end
+
+  def test_parse_quantity_for_2
+    assert_equal [0,1], @words.parse_quantity(2)
+  end
+
+  def test_parse_quantity_for_range_1_2
+    assert_equal [0,1], @words.parse_quantity(1..2)
+  end
+
+  def test_parse_quantity_for_range_2_3
+    assert_equal [1,2], @words.parse_quantity(2..3)
+  end
+
+  def test_parse_quantity_for_no_argument
+    assert_equal [0, 999], @words.parse_quantity()
+  end
+
+  def test_read_returns_the_with_argument_1
+    assert_equal ['the'], @words.read(1)
+  end
+
+  def test_read_returns_the_with_argument_2
+    assert_equal ['the','of'], @words.read(2)
+  end
+
+  def test_read_returns_the_with_range_2_3
+    assert_equal ['of','and'], @words.read(2..3)
+  end
+
+  def test_read_returns_100_words_for_no_argument
+    assert_equal 1000, @words.read().size
+  end
+
+  def test_read_returns_500_words_for_range_100_to_1600
+    words = @words.read(100...1600)
+    assert_equal 1500, words.size
+    assert_equal 'find',words[0]
+    assert_equal 'phentermine',words[-1]
+  end
+
+  def test_all_returns_all_words
+    words = @words.read(:all)
+    assert_equal 10000, words.size
+    assert_equal 'the',words[0]
+    assert_equal 'poison',words[-1]
+  end
+
+end

data/test/test_config.rb

@@ -0,0 +1,98 @@
+require 'simplecov'
+$VERBOSE = nil #FIXME
+SimpleCov.start
+
+require 'minitest/autorun'
+require 'minitest/pride'
+require_relative '../lib/cw/config'
+
+class TestConfig < MiniTest::Test
+
+  CONFIG_METHODS = [
+    :name,:wpm,:effective_wpm,:frequency,:audio_filename,:audio_dir,
+    :book_name,:book_dir,:play_command,:size,:run_default,:word_spacing,
+    :command_line,:author,:title,:quality,:ebook2cw_path,:noise,:no_noise,
+    :tone,:word_count,:volume,:list_colour,:success_colour,:fail_colour,
+    :no_run,:run,:print_letters,:no_print,:use_ebook2cw,:use_ruby_tone,
+    :dictionary,:containing,:begin,:end,:including,:word_filename,:max,:min,
+    :exit
+  ]
+
+  def setup
+    CWG::Cfg.reset
+  end
+
+  def test_params_rewrite
+    CWG::Cfg::CONFIG_METHODS.each_with_index do |label,idx|
+      CWG::Cfg.config.params[label] = idx
+    end
+    0.upto CWG::Cfg::CONFIG_METHODS.size - 1 do |idx|
+      assert_equal(idx, CWG::Cfg.config.params[CWG::Cfg::CONFIG_METHODS[idx]])
+    end
+  end
+
+  def test_wpm_default
+    assert_equal "25", CWG::Cfg.config["wpm"]
+  end
+
+  def test_book_name_default
+    assert_equal "book.txt", CWG::Cfg.config["book_name"]
+  end
+
+  def test_book_dir_default
+    assert_equal "data/text/", CWG::Cfg.config["book_dir"]
+  end
+
+#  def test_play_command_default
+#    assert_equal "/usr/bin/afplay", CWG::Cfg.config["play_command"]
+#  end
+
+  def test_success_colour_default
+    assert_equal "green", CWG::Cfg.config["success_colour"]
+  end
+
+  def test_fail_colour_default
+    assert_equal "red", CWG::Cfg.config["fail_colour"]
+  end
+
+  def test_list_colour_default
+    assert_equal "default", CWG::Cfg.config["list_colour"]
+  end
+
+  def test_ebook2cw_path_default
+    assert_equal "/usr/bin/ebook2cw", CWG::Cfg.config["ebook2cw_path"]
+  end
+
+  def test_run_default_default
+    assert_equal "test_letters", CWG::Cfg.config["run_default"]
+  end
+
+  def test_dictionary_dir_default
+    assert_equal "data/text/", CWG::Cfg.config["dictionary_dir"]
+  end
+
+  def test_dictionary_name_default
+    assert_equal "english.txt", CWG::Cfg.config["dictionary_name"]
+  end
+
+  def test_accessing_unknown_method_returns_nil
+    refute CWG::Cfg.config["unknown"]
+  end
+
+  def test_setting_unknown_method_returns_nil
+    CWG::Cfg.config.params["unknown"] = "something"
+    assert_equal "something", CWG::Cfg.config["unknown"]
+  end
+
+  def test_an_existing_setting_works
+    refute CWG::Cfg.config["exit"]
+    CWG::Cfg.config.params["exit"] = true
+    assert CWG::Cfg.config["exit"]
+  end
+
+  def test_frequency
+    CWG::Cfg.config.params["frequency"] = 400
+    assert_equal 400, CWG::Cfg.config["frequency"]
+  end
+end
+

data/test/test_current_word.rb

@@ -0,0 +1,62 @@
+require 'simplecov'
+$VERBOSE = nil #FIXME
+SimpleCov.start
+
+require 'minitest/autorun'
+require 'minitest/pride'
+require_relative '../lib/cw'
+
+class TestCurrentWord < MiniTest::Test
+
+  ROOT = File.expand_path File.dirname(__FILE__) + '/../'
+
+  def setup
+    @word = CWG::CurrentWord.new
+  end
+
+  def teardown
+    @word = nil
+  end
+
+  def test_initialize
+    assert_equal '', @word.to_s
+  end
+
+  def test_current_word
+  end
+
+  def test_push_letter
+    @word.push_letter 'a'
+    assert_equal 'a', @word.to_s
+    @word.push_letter '0'
+    assert_equal 'a0', @word.to_s
+  end
+
+  def test_to_s
+    @word.push_letter '-'
+    assert_equal '-', @word.to_s
+  end
+
+  def test_clear
+    @word.push_letter '.'
+    assert_equal '.', @word.to_s
+    @word.clear
+    assert_equal '', @word.to_s
+  end
+
+  def test_strip
+    @word.push_letter ' a '
+    assert_equal ' a ', @word.to_s
+    @word.strip
+    assert_equal 'a', @word.to_s
+  end
+
+  def test_process_letter
+    @word.process_letter 'A'
+    assert_equal 'a', @word.to_s
+    @word.process_letter 'z'
+    assert_equal 'az', @word.to_s
+    @word.process_letter ','
+    assert_equal 'az,', @word.to_s
+  end
+end

data/test/test_cw.rb

@@ -12,7 +12,7 @@ class TestCW < MiniTest::Test
 
   def setup
     @cw = CW.new
-    @cw.pause
+    @cw.no_run
   end
 
   def teardown
@@ -23,12 +23,17 @@ class TestCW < MiniTest::Test
     assert true
   end
 
+  def test_os_play_command
+    obj = CWG::AudioPlayer.new
+    assert ('afplay' == obj.os_play_command) || ('ossplay' == obj.os_play_command)
+  end
+
   def test_cw_class
     assert_equal CW, @cw.class
   end
 
-  def test_name_is_unnamed_if_unnamed
-    assert_equal 'unnamed', @cw.name
+  def test_name_is_nil_if_unnamed
+    refute @cw.name
   end
 
   def test_name_can_be_set
@@ -37,41 +42,25 @@ class TestCW < MiniTest::Test
   end
 
   def test_loads_words_by_default
-    assert_equal ["the", "of", "and", "a", "to"] , @cw.words.first(5)
-  end
-
-  def test_dictionary_defaults_to_COMMON_WORDS
-    temp = nil
-    CW.new {
-      pause
-      temp = Params.dictionary
-    }
-    assert_equal File.expand_path(ROOT + '/data/text/common_words.txt'), File.expand_path(temp)
+    assert_equal ["the", "of", "and", "to", "a"] , @cw.words.first(5)
   end
 
   def test_CW_takes_a_block
     CW.new {
-      pause
+      no_run
     }
   end
 
-  def test_dont_load_common_words_if_passed_in_block
+  def test_words_loads_words
     cw = CW.new {
-      pause
+      no_run
     }
+    assert_equal 1000, cw.words.size
     cw.words = ["some", "words"]
     assert_equal ["some", "words"], cw.words
   end
 
-  def test_word_filename_defaults_to_words
-    cw = CW.new {
-      pause
-    }
-    cw.words = ["some", "words"]
-    assert_equal ["some","words"], cw.words
-  end
-
-  def test_no_run_aliases_pause
+  def test_no_run_aliases_no_run
     time = Time.now
     cw = CW.new {
       no_run
@@ -80,70 +69,44 @@ class TestCW < MiniTest::Test
     assert (Time.now - time) < 1
   end
 
-  def test_reload_reloads_dictionary
-    cw = CW.new {
-      pause
-    }
-    cw.words = ["some", "words"]
-    assert_equal ["some", "words"], cw.words
-    cw.reload
-    assert_equal ["the", "of", "and", "a", "to"] , cw.words.first(5)
-  end
-
   def test_load_common_words_loads_common_words
     cw = CW.new {
-      pause
+      no_run
     }
     cw.words = ["some", "words"]
     assert_equal ["some", "words"], cw.words
     cw.load_common_words
-    assert_equal ["the", "of", "and", "a", "to"] , cw.words.first(5)
+    assert_equal ["the", "of", "and", "to", "a"] , cw.words.first(5)
   end
 
   def test_load_words_loads_passed_filename
     temp = Tempfile.new("words.tmp")
     temp << "some words"
     temp.close
-    @cw.load_words(temp)
+    @cw.load_text temp
     assert_equal ["some", "words"], @cw.words
   end
 
-  def test_reload_reuploads_new_words_ie_dictionary_updated
-    temp = Tempfile.new("words.tmp")
-    temp << "some more words"
-    temp.close
-    @cw.load_words(temp)
-    assert_equal ["some", "more", "words"], @cw.words
-    @cw.words = ''
-    @cw.reload
-    assert_equal ["some", "more", "words"], @cw.words
-    @cw.load_common_words
-    assert_equal ["the", "of", "and", "a", "to"] , @cw.words.first(5)
-  end
-
-   def test_to_s_outputs_test_run_header_if_paused
+   def test_to_s_outputs_test_run_header_if_no_run
      temp =
-       %q(unnamed
-=======
+       %q(========
 WPM:        25
-=======
+Word count: 16
+========
 )
      assert_equal temp, @cw.to_s
    end
 
   def test_to_s_outputs_relevant_params_if_set
     temp =
-      %q(unnamed
-=======
+      %q(========
 WPM:        25
-Shuffle:    yes
 Word count: 2
 Word size:  3
 Beginning:  l
 Ending:     x
-=======
+========
 )
-    @cw.shuffle
     @cw.word_count 2
     @cw.word_size 3
     @cw.ending_with('x')
@@ -167,51 +130,48 @@ Ending:     x
 
   def test_effective_wpm_is_settable
     effective_wpm = rand(50)
-    @cw.effective_wpm effective_wpm
-    assert_equal effective_wpm, @cw.effective_wpm
+    @cw.effective_wpm(effective_wpm)
+    assert_equal(effective_wpm, @cw.effective_wpm)
   end
 
-  def test_word_spacing_is_settable_and_readable
-    word_spacing = rand(50)
-    @cw.word_spacing word_spacing
-    assert_equal word_spacing, @cw.word_spacing
-  end
+#todo  def test_word_spacing_is_settable_and_readable
+#    word_spacing = rand(50)
+#    @cw.word_spacing(word_spacing)
+#    assert_equal(word_spacing, @cw.word_spacing)
+#  end
 
   def test_shuffle_shuffles_words
     @cw.shuffle
-    refute_equal ["the", "of", "and", "a", "to"] , @cw.words.first(5)
-  end
-
-  def test_no_shuffle_doesnt_shuffle
-    @cw.no_shuffle
-    assert_equal ["the", "of", "and", "a", "to"] , @cw.words.first(5)
+    refute_equal ["the", "of", "and", "to", "a"], @cw.words.first(5)
   end
 
   def test_word_size_returns_words_of_such_size
     @cw.word_size 2
-    assert_equal ["of", "to", "in", "is", "it"] , @cw.words.first(5)
+    assert_equal ["of", "to", "in", "is", "on"] , @cw.words.first(5)
   end
   
   def test_beginning_with_returns_words_beginning_with_letter
     @cw.beginning_with 'l'
-    assert_equal ["like", "look", "long", "little", "large"] , @cw.words.first(5)
+    assert_equal ["like", "list", "last", "links", "life"], @cw.words.first(5)
   end
 
   def test_beginning_with_will_take_two_letters
-    @cw.beginning_with 'q','b'
-    assert_equal ["question", "quickly", "quite", "quiet", "be", "by"] ,
+    @cw.load_words(1500)
+    @cw.beginning_with 'x','q'
+    assert_equal ["x", "xml", "quality", "questions", "q", "quote"],
     @cw.words.first(6)
   end
 
   def test_ending_with_returns_words_ending_with_letter
     @cw.ending_with 'l'
-    assert_equal ["all", "will", "call", "oil", "well"] , @cw.words.first(5)
+    assert_equal ["all", "will", "email", "well", "school"], @cw.words.first(5)
   end
 
   def test_ending_with_will_take_two_letters
+    @cw.load_words 200
     @cw.ending_with 'x', 'a'
-    assert_equal ["box", "six", "suffix", "a", "America", "sea"] ,
-    @cw.words.first(6)
+    assert_equal ["x", "sex", "a", "data"],
+    @cw.words
   end
 
   def test_word_count_returns_x_words
@@ -221,22 +181,23 @@ Ending:     x
 
   def test_including_returns_words_including_letter
     @cw.including 'l'
-    assert_equal ["all", "will", "would", "like", "look"] , @cw.words.first(5)
+    assert_equal ["all", "will", "only", "also", "help"], @cw.words.first(5)
   end
 
   def test_including_will_take_two_letters
-    @cw.including 'q', 'a'
-    assert_equal ["question", "quickly", "equation", "square", "quite", "quiet", "equal", "and"] ,@cw.words.first(8)
+    @cw.load_words(100)
+    @cw.including 'p','b'
+    assert_equal ["page", "up", "help", "pm", "by", "be", "about", "but"],@cw.words.first(8)
   end
 
   def test_no_longer_than_will_return_words_no_longer_than_x
     @cw.no_longer_than 4
-    assert_equal ["the", "of", "and", "a", "to"] , @cw.words.first(5)
+    assert_equal ["the", "of", "and", "to", "a"] , @cw.words.first(5)
   end
 
   def test_no_shorter_than_will_return_words_no_shorter_than_x
     @cw.no_shorter_than 4
-    assert_equal ["that", "with", "they", "this", "have"] , @cw.words.first(5)
+    assert_equal ["that", "this", "with", "from", "your"], @cw.words.first(5)
   end
 
   def test_words_fn_adds_words
@@ -356,7 +317,7 @@ Ending:     x
     assert_equal 567, @cw.frequency(567)
     @cw.frequency 456
     assert_equal 456, @cw.frequency
-  end
+    end
 
   def test_play_command_returns_play_command
     assert_equal 567, @cw.play_command(567)
@@ -392,111 +353,117 @@ Ending:     x
     assert @cw.method(:words_no_shorter_than), @cw.method(:no_shorter_than)
     assert @cw.method(:random_alphanumeric),   @cw.method(:random_letters_numbers)
     assert @cw.method(:comment),               @cw.method(:name)
-    assert @cw.method(:no_run),                @cw.method(:pause)
   end
 
   def test_set_wpm_param
-    @cw.wpm 33
-    assert @cw.cl.cl_wpm == '-w 33 ', 'wpm param invalid'
+    @cw.wpm 35
+    assert_equal 35, @cw.wpm
+    assert @cw.instance_variable_get('@cl').cl_wpm == '-w 35 ', 'wpm param invalid'
   end
 
   def test_set_ewpm_param
     @cw.effective_wpm 33
-    assert @cw.cl.cl_effective_wpm == '-e 33 ', 'effective_wpm param invalid'
+    assert @cw.instance_variable_get('@cl').cl_effective_wpm == '-e 33 ', 'effective_wpm param invalid'
   end
 
   def test_set_word_spacing_W_param
     @cw.word_spacing 2
-    assert @cw.cl.cl_word_spacing == '-W 2 ', 'word_spacing param invalid'
+    assert @cw.instance_variable_get('@cl').cl_word_spacing == '-W 2 ', 'word_spacing param invalid'
   end
 
   def test_set_freq_f_param
     @cw.frequency 800
-    assert @cw.cl.cl_frequency == '-f 800 ', 'frequency param invalid'
+    assert @cw.instance_variable_get('@cl').cl_frequency == '-f 800 ', 'frequency param invalid'
   end
 
-  def test_set_squarewave_param
-    @cw.set_tone_type :squarewave
-    assert @cw.cl.cl_squarewave == '-T 2 ', 'squarewave param invalid'
+  def test_tone_squarewave_param
+    @cw.tone :squarewave
+    assert @cw.instance_variable_get('@cl').cl_squarewave == '-T 2 ', 'squarewave param invalid'
   end
 
-  def test_set_sawtooth_param
-    @cw.set_tone_type :sawtooth
-    assert @cw.cl.cl_sawtooth == '-T 1 ', 'sawtooth param invalid'
+  def test_tone_sawtooth_param
+    @cw.tone :sawtooth
+    assert @cw.instance_variable_get('@cl').cl_sawtooth == '-T 1 ', 'sawtooth param invalid'
   end
 
-  def test_set_sinewave_param
-    @cw.set_tone_type :sinewave
-    assert @cw.cl.cl_sinewave == '-T 0 ', 'sinewave param invalid'
+  def test_tone_sinewave_param
+    @cw.tone :sinewave
+    assert @cw.instance_variable_get('@cl').cl_sinewave == '-T 0 ', 'sinewave param invalid'
   end
 
   def test_build_build_cl_ignores_invalid_tone_type
-    @cw.set_tone_type :sinewave
-    @cw.set_tone_type :invalid
-    assert @cw.cl.cl_sinewave == '-T 0 ', 'not ignoring invalid tone type'
+    @cw.tone :invalid
+    assert @cw.instance_variable_get('@cl').cl_sinewave == '', 'not ignoring invalid tone type'
   end
 
   def test_set_author_param
     @cw.author 'some author'
-    assert @cw.cl.cl_author == '-a "some author" ', 'author param invalid'
+    assert @cw.instance_variable_get('@cl').cl_author == '-a "some author" ', 'author param invalid'
   end
 
   def test_set_title_param
     @cw.title 'some title'
-    assert @cw.cl.cl_title == '-t "some title" ', 'title param invalid'
+    assert @cw.instance_variable_get('@cl').cl_title == '-t "some title" ', 'title param invalid'
   end
 
   def test_set_N_param_in_noise_mode
     @cw.noise
-    assert @cw.cl.cl_noise.include?('-N 5 '), 'noise N param invalid'
+    assert @cw.instance_variable_get('@cl').cl_noise.include?('-N 5 '), 'noise N param invalid'
   end
 
   def test_set_B_param_in_noise_mode
     @cw.noise
-    assert @cw.cl.cl_noise.include?('-B 1000 '), 'noise B param invalid'
+    assert @cw.instance_variable_get('@cl').cl_noise.include?('-B 1000 '), 'noise B param invalid'
   end
 
   def test_set_default_filename
-    assert @cw.cl.cl_audio_filename.include?('audio_output'), 'default audio output filename invalid'
+    assert @cw.instance_variable_get('@cl').cl_audio_filename.
+      include?('audio_output'), 'default audio output filename invalid'
   end
 
   def test_set_audio_filename_to_given_name
     @cw.audio_filename('some name')
-    assert @cw.cl.cl_audio_filename.include?("some name"), 'default audio filename invalid'
+    assert @cw.instance_variable_get('@cl').cl_audio_filename.
+      include?("some name"), 'default audio filename invalid'
   end
 
   def test_set_q_param_when_numeric_quality
     @cw.quality 5
-    assert @cw.cl.cl_quality.include?('-q 5 '), 'audio quality invalid'
+    assert @cw.instance_variable_get('@cl').cl_quality.
+      include?('-q 5 '), 'audio quality invalid'
   end
 
   def test_set_low_quality
     @cw.quality :low
-    assert @cw.cl.cl_quality.include?('-q 9 '), 'audio low quality invalid'
+    assert @cw.instance_variable_get('@cl').cl_quality.
+      include?('-q 9 '), 'audio low quality invalid'
   end
 
   def test_set_medium_quality
     @cw.quality :medium
-    assert @cw.cl.cl_quality.include?('-q 5 '), 'audio medium quality invalid'
+    assert @cw.instance_variable_get('@cl').cl_quality.
+      include?('-q 5 '), 'audio medium quality invalid'
   end
 
   def test_set_high_quality
     @cw.quality :high
-    assert @cw.cl.cl_quality.include?('-q 1 '), 'audio high quality invalid'
+    assert @cw.instance_variable_get('@cl').cl_quality.
+      include?('-q 1 '), 'audio high quality invalid'
   end
 
   def test_build_command_includes_custom_commands_via_build_cl
     @cw.command_line '-x "some custom command"'
-    assert @cw.cl.cl_command_line.include?( '-x "some custom command"'), 'custom command invalid'
+    assert @cw.instance_variable_get('@cl').cl_command_line.
+      include?( '-x "some custom command"'), 'custom command invalid'
   end
 
   def test_cl_echo_returns_correct_string
     str = ''
     CW.new do
       str = @cl.cl_echo('some words')
-      pause
+      no_run
     end
-    assert str.include?('echo some words | ebook2cw -w 25')
+    assert str.include?('some words')
   end
 
   def test_words_exist
@@ -504,19 +471,19 @@ Ending:     x
     CW.new do
       words = 'some words added here'
       temp = words
-      pause
+      no_run
     end
     assert_equal(4, temp.split.size)
     CW.new do
       @words.add 'a couple of words'
       temp = words
-      pause
+      no_run
     end
     assert_equal(4, temp.split.size)
     CW.new do
       @words.add nil
       temp = words
-      pause
+      no_run
     end
     assert_nil(temp)
   end