cw 0.3.1 → 0.3.2

data/lib/cw/winkey.rb

@@ -0,0 +1,121 @@
+require 'rubyserial'
+
+module CWG
+
+  class Winkey
+
+    def initialize
+      @print = Print.new
+      STDERR.puts "Attempting to open winkey connection"
+      port_str = "/dev/cu.usbserial-AD01XY9H"  #may be different for you
+      baud_rate = 1200
+      data_bits = 8
+      begin
+        @serial = Serial.new(port_str, baud_rate, data_bits)
+        @serial.closed?
+      rescue => e
+        p e
+        p @serial
+        STDERR.puts "Failed to open serial port - Exiting!"
+        exit 1
+      end
+    end
+
+    def write data
+      @serial.write data
+    end
+
+    def getbyte
+      @serial.getbyte
+    end
+
+    def close
+      puts 'Closing'
+      @serial.close
+    end
+
+    def check_status byte
+      status = byte & 192
+      if status == 192
+#        puts "status"
+        true
+      elsif status == 128
+#        puts "wpm"
+        true
+      else
+#        puts "byte 0x#{byte.to_s()}"
+        false
+      end
+    end
+
+    def string str
+#      puts str
+      write str
+      str.split('').each do |ip|
+#        puts "ip = #{ip}"
+        read ip.ord, "sent and received #{ip.chr}"
+      end
+    end
+
+    def read match, match_msg
+      loop_delay = 0.05
+      count = 1
+      25.times do
+        byte = getbyte
+        unless byte.nil?
+          unless check_status(byte)
+#            puts "count is, #{count}, byte is #{byte.inspect}, match is #{match.inspect}"
+            if byte == match
+#              print byte.ord
+#              puts match_msg
+              return
+            end
+          end
+        end
+        count += 1
+        sleep loop_delay
+      end
+    end
+
+    def command cmd
+      {
+        on: "\x00\x02",
+        no_weighting: "\x03\x32",
+        echo: "\x00\x04\x5A"
+      }[cmd]
+    end
+
+    def on
+      puts 'host on'
+      write command :on
+      read 23, "on ack"
+    end
+
+    def no_weighting
+      puts 'no weighting'
+      write command :no_weighting
+    end
+
+    def echo
+      puts 'echo test'
+      write command :echo
+      read 'Z'.ord, "echo success"
+    end
+
+    def wpm wpm
+      puts "set wpm to #{wpm}"
+      write "\x02"
+      write [wpm].pack('U')
+    end
+
+    def sent?
+      true
+    end
+
+    def wait_while_sending
+      until sent?
+        sleep 0.01
+      end
+    end
+  end
+end

data/lib/cw/words.rb

@@ -88,7 +88,7 @@ module CWG
       end.flatten
     end
 
-    def count word_count
+    def count(word_count)
       @words = @words.take(word_count.to_i)
     end
 

data/test/test_cw.rb

@@ -42,7 +42,7 @@ class TestCW < MiniTest::Test
   end
 
   def test_loads_words_by_default
-    assert_equal ["the", "of", "and", "to", "a"] , @cw.words.first(5)
+    assert_equal %w(the of and to a), @cw.words.first(5)
   end
 
   def test_CW_takes_a_block
@@ -56,8 +56,8 @@ class TestCW < MiniTest::Test
       no_run
     }
     assert_equal 1000, cw.words.size
-    cw.words = ["some", "words"]
-    assert_equal ["some", "words"], cw.words
+    cw.words = %w(some words)
+    assert_equal %w(some words), cw.words
   end
 
   def test_no_run_aliases_no_run
@@ -65,7 +65,7 @@ class TestCW < MiniTest::Test
     cw = CW.new {
       no_run
     }
-    cw.words = ["some", " words"]
+    cw.words = %w(some words)
     assert (Time.now - time) < 1
   end
 
@@ -73,10 +73,10 @@ class TestCW < MiniTest::Test
     cw = CW.new {
       no_run
     }
-    cw.words = ["some", "words"]
-    assert_equal ["some", "words"], cw.words
+    cw.words =  %w(some words)
+    assert_equal  %w(some words), cw.words
     cw.load_common_words
-    assert_equal ["the", "of", "and", "to", "a"] , cw.words.first(5)
+    assert_equal  %w(the of and to a), cw.words.first(5)
   end
 
   def test_load_words_loads_passed_filename
@@ -84,14 +84,14 @@ class TestCW < MiniTest::Test
     temp << "some words"
     temp.close
     @cw.load_text temp
-    assert_equal ["some", "words"], @cw.words
+    assert_equal %w(some words), @cw.words
   end
 
    def test_to_s_outputs_test_run_header_if_no_run
      temp =
        %q(========
 WPM:        25
-Word count: 16
+Word count: 9999
 ========
 )
      assert_equal temp, @cw.to_s
@@ -142,35 +142,35 @@ Ending:     x
 
   def test_shuffle_shuffles_words
     @cw.shuffle
-    refute_equal ["the", "of", "and", "to", "a"], @cw.words.first(5)
+    refute_equal  %w(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", "on"] , @cw.words.first(5)
+    assert_equal  %w(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", "list", "last", "links", "life"], @cw.words.first(5)
+    assert_equal %w(like list last links life), @cw.words.first(5)
   end
 
   def test_beginning_with_will_take_two_letters
     @cw.load_words(1500)
     @cw.beginning_with 'x','q'
-    assert_equal ["x", "xml", "quality", "questions", "q", "quote"],
+    assert_equal  %w(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", "email", "well", "school"], @cw.words.first(5)
+    assert_equal %w(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 ["x", "sex", "a", "data"],
+    assert_equal %w(x sex a data),
     @cw.words
   end
 
@@ -181,23 +181,23 @@ Ending:     x
 
   def test_including_returns_words_including_letter
     @cw.including 'l'
-    assert_equal ["all", "will", "only", "also", "help"], @cw.words.first(5)
+    assert_equal %w(all will only also help), @cw.words.first(5)
   end
 
   def test_including_will_take_two_letters
     @cw.load_words(100)
     @cw.including 'p','b'
-    assert_equal ["page", "up", "help", "pm", "by", "be", "about", "but"],@cw.words.first(8)
+    assert_equal %w(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", "to", "a"] , @cw.words.first(5)
+    assert_equal %w(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", "this", "with", "from", "your"], @cw.words.first(5)
+    assert_equal %w(that this with from your), @cw.words.first(5)
   end
 
   def test_words_fn_adds_words
@@ -206,13 +206,13 @@ Ending:     x
   end
 
   def test_words_fn_passes_in_an_array_of_words_as_is
-    @cw.words = ["one", "two", "three", "four"]
-    assert_equal ["one", "two", "three", "four"] , @cw.words
+    @cw.words = %w(one two three four)
+    assert_equal  %w(one two three four), @cw.words
   end
 
   def test_random_letters_returns_words_of_size_4_by_default
     @cw.random_letters
-    @cw.words.each { |w| assert_equal 4, w.length}
+    @cw.words.each { |w| assert_equal 4, w.length }
   end
 
   def test_random_letters_returns_word_count_of_50_by_default
@@ -222,7 +222,7 @@ Ending:     x
 
   def test_random_letters_can_take_size_option
     @cw.random_letters(size: 5)
-    @cw.words.each { |w| assert_equal 5, w.length}
+    @cw.words.each { |w| assert_equal 5, w.length }
   end
 
   def test_random_letters_can_take_count_option
@@ -233,7 +233,7 @@ Ending:     x
   def test_random_letters_can_take_size_and_count_option
     @cw.random_letters(count: 3, size: 4)
     assert_equal 3, @cw.words.size
-    @cw.words.each { |w| assert_equal 4, w.length}
+    @cw.words.each { |w| assert_equal 4, w.length }
   end
 
   def test_random_letters_returns_random_letters
@@ -246,7 +246,7 @@ Ending:     x
   def test_random_numbers_can_take_size_and_count_option
     @cw.random_numbers(count: 3, size: 4)
     assert_equal 3, @cw.words.size
-    @cw.words.each { |w| assert_equal 4, w.length}
+    @cw.words.each { |w| assert_equal 4, w.length }
   end
 
   def test_random_numbers_returns_random_numbers
@@ -280,7 +280,7 @@ Ending:     x
 
   def test_alphabet_generates_alphabet
     @cw.alphabet
-    assert_equal ["a b c d e f g h i j k l m n o p q r s t u v w x y z"], @cw.words
+    assert_equal ['a b c d e f g h i j k l m n o p q r s t u v w x y z'], @cw.words
   end
 
   def test_alphabet_generates_reversed_alphabet
@@ -290,7 +290,7 @@ Ending:     x
 
   def test_alphabet_shuffles_alphabet
     @cw.alphabet(shuffle: true)
-    refute_equal ["a b c d e f g h i j k l m n o p q r s t u v w x y z"], @cw.words
+    refute_equal ['a b c d e f g h i j k l m n o p q r s t u v w x y z'], @cw.words
     assert_equal "abcdefghijklmnopqrstuvwxyz", @cw.words.first.chars.sort.join.strip
   end
 
@@ -353,6 +353,7 @@ 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(:comment),               @cw.method(:name)
   end
 
   def test_set_wpm_param

data/test/test_tone_generator.rb

@@ -0,0 +1,141 @@
+require 'simplecov'
+$VERBOSE = nil #FIXME
+SimpleCov.start
+
+require 'minitest/autorun'
+require 'minitest/pride'
+require_relative '../lib/cw'
+
+class TestToneGenerator < MiniTest::Test
+
+  ROOT = File.expand_path File.dirname(__FILE__) + '/../'
+
+  def setup
+    CWG::Cfg.reset
+    @tg = CWG::ToneGenerator.new
+  end
+
+  def teardown
+    @tg = nil
+  end
+
+  def test_assert
+    assert 1
+  end
+
+  def test_refute
+    refute nil
+  end
+
+  def test_code_filename
+    assert_equal File.join(ROOT, '.cw', 'audio', 'dot.wav'), @tg.code.filename(:dot)
+    assert_equal File.join(ROOT, '.cw', 'audio', 'dash.wav'), @tg.code.filename(:dash)
+    assert_equal File.join(ROOT, '.cw', 'audio', 'space.wav'), @tg.code.filename(:space)
+    assert_equal File.join(ROOT, '.cw', 'audio', 'e_space.wav'), @tg.code.filename(:e_space)
+  end
+
+  def test_code_spb_for_15_wpm
+    CWG::Cfg.config.params['wpm'] = 15
+    tg = CWG::ToneGenerator.new
+    element = 192
+    assert_equal element * 1, tg.code.spb(:dot)
+    assert_equal element * 3, tg.code.spb(:dash)
+    assert_equal element * 1, tg.code.spb(:space)
+    assert_equal element * 1, tg.code.spb(:e_space)
+  end
+
+  def test_code_spb_for_25_wpm
+    CWG::Cfg.config.params['wpm'] = 25
+    tg = CWG::ToneGenerator.new
+    element = 115
+    assert_equal element * 1, tg.code.spb(:dot)
+    assert_equal element * 3, tg.code.spb(:dash)
+    assert_equal element * 1, tg.code.spb(:space)
+    assert_equal element * 1, tg.code.spb(:e_space)
+  end
+
+  def test_code_spb_for_40_wpm
+    CWG::Cfg.config.params['wpm'] = 40
+    tg = CWG::ToneGenerator.new
+    element = 72
+    assert_equal element * 1, tg.code.spb(:dot)
+    assert_equal element * 3, tg.code.spb(:dash)
+    assert_equal element * 1, tg.code.spb(:space)
+    assert_equal element * 1, tg.code.spb(:e_space)
+  end
+
+  def test_code_spb_for_20_wpm
+    CWG::Cfg.config.params['wpm'] = 20
+    tg = CWG::ToneGenerator.new
+    element = 144
+    assert_equal element * 1, tg.code.spb(:dot)
+    assert_equal element * 3, tg.code.spb(:dash)
+    assert_equal element * 1, tg.code.spb(:space)
+    assert_equal element * 1, tg.code.spb(:e_space)
+  end
+
+  def test_elements
+    assert_equal :dot,     @tg.elements.first
+    assert_equal :dash,    @tg.elements.fetch(1)
+    assert_equal :space,   @tg.elements.fetch(2)
+    assert_equal :e_space, @tg.elements.last
+    assert_equal 4,        @tg.elements.size
+  end
+
+  def test_generate_samples
+    CWG::Cfg.config.params['wpm'] = 40
+    tg = CWG::ToneGenerator.new
+    samples = tg.generate_samples(:dot)
+    assert_equal Array, samples.class
+    assert_equal 72, samples.size
+    assert_equal samples.size, tg.generate_samples(:space).size
+    assert_equal samples.size * 3, tg.generate_samples(:dash).size
+  end
+
+  def test_space_or_espace_method_when_no_wpm_equals_ewpm
+    assert_equal({ name: :space }, @tg.space_or_espace)
+  end
+
+  def test_space_or_espace_method_when_ewpm_active
+    @tg.instance_variable_set :@effective_wpm, 10
+    assert_equal({ name: :e_space }, @tg.space_or_espace)
+  end
+
+  def test_play_filename
+    assert_equal File.join(ROOT, 'audio', 'audio_output.wav'), @tg.play_filename
+  end
+
+  def test_cw_encoding_returns_a_cw_encoding_object
+    assert_equal CWG::CwEncoding, @tg.cw_encoding.class
+  end
+
+  def test_cw_encoding_responds_to_fetch
+    assert_equal(true, @tg.cw_encoding.respond_to?(:fetch))
+  end
+
+  def test_cw_encoding_fetch_returns_dot_dash_given_the_letter_a
+    assert_equal [:dot, :dash], @tg.cw_encoding.fetch('a')
+    assert_equal [:dash, :dot], @tg.cw_encoding.fetch('n')
+  end
+
+  def test_push_enc_does_something
+#    p @tg.push_enc([nil]).class
+#    p @tg.push_enc(['a','b'])
+    assert_equal 4, @tg.push_enc([nil]).size
+    assert_equal 4, @tg.push_enc(['a']).size
+    assert_equal 6, @tg.push_enc(['a','b']).size
+    assert_equal 8, @tg.push_enc(['a','b','c']).size
+    assert_equal 'a', @tg.push_enc(['a','b']).first
+    assert_equal Hash, @tg.push_enc(['a','b']).fetch(1).class
+    assert_equal 'b', @tg.push_enc(['a','b']).fetch(2)
+    assert_equal Hash, @tg.push_enc(['a','b']).last.class
+    assert_equal :space, @tg.push_enc(['a','b']).last[:name] = :space
+    assert_equal 'b', @tg.push_enc(['a','b']).fetch(2)
+    assert_equal Array, @tg.push_enc(['a','b']).class
+  end
+
+  def test_word_space_returns_space_if_not_ewpm
+#    assert_equal '', @tg.word_space
+  end
+
+end