cw 0.0.12 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f96c63ebcba919ae57d460aae5e40a871af17ad1
-  data.tar.gz: 4df1a6780ff5ae0b2e1f0966171735156061f409
+  metadata.gz: 72ccadeafd51d75edae90d0f494a0ccfe735ab1a
+  data.tar.gz: 1a975942e7a54e6db6745b2d5b5cd5a3fae176a1
 SHA512:
-  metadata.gz: 8d601393c438cb66221a8e427dbb0f723daea1a24db7084435f494903925b444efaaeeb972341f051b501fdb50a3c4ee2b30c55b3eca1269e8444a3cc9e94e77
-  data.tar.gz: 4ac510de739832dd440d8cbb94dd6937660bd5ed63a2bce83622d0c12bddf814b44973b395d7e75fbb902ac308657e28f68153b3da106a0b9f25e32ba8f402ef
+  metadata.gz: 025e1005cadcac8a29d9f31b2c50498c757749982ee32d78045dd1a71ada9b3a005b403076c49c91f2a87fd15734d87c9d4b848a871cb4d2ca2d4cfc1a1177a5
+  data.tar.gz: 6aadbbecd1d18c43a864e29c12a066491bba27443ef411db412a2a92afe30ce9fefa55f3fa6279f8e76df461599c0bfb422a072bfee717cb5d3b2c14a41e9902

data/.codeclimate.yml

@@ -0,0 +1,15 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+      - javascript
+ratings:
+  paths:
+  - lib/**
+  - "**.rb"
+  - "**.go"
+exclude_paths:
+- test/**/*

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "2.0.0"
+  - "2.2.0"
+script:
+  - ruby test/test_cw.rb

data/README.md

@@ -1,14 +1,19 @@
-# CW
+[![Gem Version](https://badge.fury.io/rb/cw.svg)](https://badge.fury.io/rb/cw)
+[![Build Status](https://travis-ci.org/mjago/CW.svg?branch=master)](https://travis-ci.org/mjago/CW)
+[![Code Climate](https://codeclimate.com/github/mjago/CW/badges/gpa.svg)](https://codeclimate.com/github/mjago/CW)
 
-CW is a DSL written in Ruby for generating audible morse, allowing for
-real-time learning and testing of Morse Code.
+## CW
 
-CW can read books, rss feeds, common phrases, QSO codes etc, in
-addition to generating random words that match some required pattern
-(i.e. words_beginning_with 'v')
+CW is a DSL written in the [Ruby](https://www.ruby-lang.org/en/downloads/) language for generating audible morse - allowing for
+real-time learning and testing of Morse Code. Great emphasis is placed on enabling tests to use fresh material each test run, rather than the constant repetition of old material.
 
-CW also allows for real-time marking by indicating correct and
-incorrect characters and words typed in real-time.
+CW can read books (and remember where you are), rss feeds (your daily quotation for instance), common phrases, QSO codes etc, in
+addition to generating random words, letters, and numbers that possibly match some required pattern
+(i.e. words_beginning_with 'v').
+
+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).
+
+Documentation to follow...
 
 # Installation:
 
@@ -27,7 +32,7 @@ ruby test/test_cw.rb
 
 ```
 
- - Note: Currently only tested on OS X, and Ruby v2.0.0 and greater.
+ * Note: Currently only tested on OS X, and Ruby v2.0.0 and greater.
 
 ```ruby
 
@@ -70,6 +75,52 @@ ruby test/test_cw.rb
     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 beginning with b (test letters)'
+test.shuffle
+test.wpm             wpm
+test.beginning_with  'b'
+test.word_size        4
+test.word_count       2
+puts test.to_s
+test.test_letters
+
+test = CW.new
+test.comment 'test words beginning with b (test words)'
+test.shuffle
+test.wpm             wpm
+test.beginning_with  'b'
+test.word_size        4
+test.word_count       2
+puts test.to_s
+test.test_words
+
+test = CW.new
+test.comment 'test words beginning with b (print letters)'
+test.shuffle
+test.wpm             wpm
+test.beginning_with  'b'
+test.word_size        4
+test.word_count       2
+puts test.to_s
+test.print_letters
+test.test_letters
+
 ```
 
 # Options:

data/cw.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name        = 'cw'
-  spec.version     = '0.0.12'
+  spec.version     = '0.1.0'
   spec.date        = '2016-05-21'
   spec.authors     = ["Martyn Jago"]
   spec.email       = ["martyn.jago@btinternet.com"]

data/daily.rb

@@ -16,7 +16,7 @@ end
 
 CW.new do
   shuffle
-  wpm  speed
+  wpm speed
   word_count 15
   test_letters
 end
@@ -90,7 +90,7 @@ speed -= 10
 
 CW.new do
   load_words 'data/text/cw_conversation.txt'
-  wpm  speed
+  wpm speed
   print_letters
 end
 

data/example.rb

@@ -87,7 +87,6 @@ loop do
   test.word_count      4
   puts test.to_s
   test.test_words
-  test = nil
 
   test = CW.new
   test.comment 'test words including ing'
@@ -98,7 +97,6 @@ loop do
   test.including       'ing'
   test.word_count      5
   test.test_words
-  test = nil
 
   #  test = CW.new
   #  test.comment         'test ing'

data/lib/cw/audio_player.rb

@@ -15,7 +15,7 @@ class AudioPlayer
   end
 
   def convert_words_with_ebook2cw words
-    words = words.gsub("\n","")
+    words = words.delete("\n")
     cl = Cl.new.cl_echo(words)
     ! @dry_run ? `#{cl}` : cl
   end
@@ -40,6 +40,8 @@ class AudioPlayer
       Process.kill(:TERM, @pid)
       Process.wait(@pid)
     rescue
+      puts 'Error: Failed to kill pid ' + @pid
+      exit 1
     end
   end
 

data/lib/cw/book.rb

@@ -151,24 +151,32 @@ class Book < FileDetails
     end
   end
 
-  def print_words words
-    timing.init_char_timer
+  def process_letters letr
+    loop do
+      process_space_maybe(letr) unless @book_details.args[:output] == :letter
+      process_word_maybe
+      if change_repeat_or_quit?
+        break
+      end
+      break if timing.char_delay_timeout?
+    end
+  end
+
+  def process_words words
     (words + space).each_char do |letr|
       process_letter letr
       stream.add_char(letr) if @book_details.args[:output] == :letter
-      loop do
-        process_space_maybe(letr) unless @book_details.args[:output] == :letter
-        process_word_maybe
-        if change_repeat_or_quit?
-          break
-        end
-        break if timing.char_delay_timeout?
-      end
+      process_letters letr
       print.prn letr if print_letters?
       break if change_repeat_or_quit?
     end
   end
 
+  def print_words words
+    timing.init_char_timer
+    process_words words
+  end
+
   def print_words_for_current_sentence
 #    puts current_sentence
     print_words current_sentence
@@ -185,7 +193,7 @@ class Book < FileDetails
   def play_sentences_until_quit
     get_book_progress
     loop do
-      check_sentence_count :play
+      check_sentence_count
       sync_with_print
       audio_play_repeat_tone_maybe
       reset_sentence_flags
@@ -196,8 +204,8 @@ class Book < FileDetails
     print_words_exit unless @print_letters
   end
 
-  def check_sentence_count source
-    if @book_details.session_finished? source
+  def check_sentence_count
+    if @book_details.session_finished?
       audio_stop
       quit
       reset_stdin
@@ -207,7 +215,7 @@ class Book < FileDetails
 
   def print_sentences_until_quit
     loop do
-      check_sentence_count :print
+      check_sentence_count
       sync_with_play
       break if quit?
       sync_with_audio_player

data/lib/cw/book_details.rb

@@ -25,11 +25,11 @@ class BookDetails
     end
   end
 
-  def session_finished? source
-    sentences_complete?(source) || book_timeout?
+  def session_finished?
+    sentences_complete? || book_timeout?
   end
 
-  def sentences_complete? source
+  def sentences_complete?
     if @args.has_key?(:sentences) &&  @args[:sentences].is_a?(Fixnum)
       if @sentence_count_source
         @sentence_count_source = nil

data/lib/cw/cw_encoding.rb

@@ -1,56 +1,72 @@
-# encoding: utf-8
+  # encoding: utf-8
 
-class CwEncoding
+  class CwEncoding
 
-  def fetch char
-    encode[char]
-  end
+    def fetch char
+      encode(char)
+    end
+
+    def encode char
+      e = encode_a_n().merge!(encode_0_2);
+      (e.merge(encode_3_space))[char]
+    end
+
+    def encode_a_n
+      {
+        'a' => [:dot, :dash],
+        'b' => [:dash, :dot, :dot, :dot],
+        'c' => [:dash, :dot, :dash, :dot],
+        'd' => [:dash, :dot, :dot],
+        'e' => [:dot],
+        'f' => [:dot, :dot, :dash, :dot],
+        'g' => [:dash, :dash, :dot],
+        'h' => [:dot, :dot, :dot, :dot],
+        'i' => [:dot, :dot],
+        'j' => [:dot, :dash, :dash, :dash],
+        'k' => [:dash, :dot, :dash],
+        'l' => [:dot, :dash, :dot, :dot],
+        'm' => [:dash, :dash],
+        'n' => [:dash, :dot]
+      }
+    end
 
-  def encode
+    def encode_0_2
       {
-      'a' => [:dot, :dash],
-      'b' => [:dash, :dot, :dot, :dot],
-      'c' => [:dash, :dot, :dash, :dot],
-      'd' => [:dash, :dot, :dot],
-      'e' => [:dot],
-      'f' => [:dot, :dot, :dash, :dot],
-      'g' => [:dash, :dash, :dot],
-      'h' => [:dot, :dot, :dot, :dot],
-      'i' => [:dot, :dot],
-      'j' => [:dot, :dash, :dash, :dash],
-      'k' => [:dash, :dot, :dash],
-      'l' => [:dot, :dash, :dot, :dot],
-      'm' => [:dash, :dash],
-      'n' => [:dash, :dot],
-      'o' => [:dash, :dash, :dash],
-      'p' => [:dot, :dash, :dash, :dot],
-      'q' => [:dash, :dash, :dot, :dash],
-      'r' => [:dot, :dash, :dot],
-      's' => [:dot, :dot, :dot],
-      't' => [:dash],
-      'u' => [:dot, :dot, :dash],
-      'v' => [:dot, :dot, :dot, :dash],
-      'w' => [:dot, :dash, :dash],
-      'x' => [:dash, :dot, :dot, :dash],
-      'y' => [:dash, :dot, :dash, :dash],
-      'z' => [:dash, :dash, :dot, :dot],
-      '1' => [:dot, :dash, :dash, :dash, :dash],
-      '2' => [:dot, :dot, :dash, :dash, :dash],
-      '3' => [:dot, :dot, :dot, :dash, :dash],
-      '4' => [:dot, :dot, :dot, :dot, :dash],
-      '5' => [:dot, :dot, :dot, :dot, :dot],
-      '6' => [:dash, :dot, :dot, :dot, :dot],
-      '7' => [:dash, :dash, :dot, :dot, :dot],
-      '8' => [:dash, :dash, :dash, :dot, :dot],
-      '9' => [:dash, :dash, :dash, :dash, :dot],
-      '0' => [:dash, :dash, :dash, :dash, :dash],
-      '.' => [:dot, :dash, :dot, :dash, :dot, :dash],
-      ',' => [:dash, :dash, :dot, :dot, :dash, :dash],
-      '=' => [:dash, :dot, :dot,:dot, :dash],
-      '!' => [:dot, :dot, :dash, :dash, :dot],
-      '/' => [:dash, :dot, :dot, :dash, :dot],
-      '?' => [:dot, :dot, :dash, :dash, :dot, :dot],
-      ' ' => []
-    }
+        'o' => [:dash, :dash, :dash],
+        'p' => [:dot, :dash, :dash, :dot],
+        'q' => [:dash, :dash, :dot, :dash],
+        'r' => [:dot, :dash, :dot],
+        's' => [:dot, :dot, :dot],
+        't' => [:dash],
+        'u' => [:dot, :dot, :dash],
+        'v' => [:dot, :dot, :dot, :dash],
+        'w' => [:dot, :dash, :dash],
+        'x' => [:dash, :dot, :dot, :dash],
+        'y' => [:dash, :dot, :dash, :dash],
+        'z' => [:dash, :dash, :dot, :dot],
+        '1' => [:dot, :dash, :dash, :dash, :dash],
+        '2' => [:dot, :dot, :dash, :dash, :dash]
+      }
+    end
+
+    def encode_3_space
+      {
+        '3' => [:dot, :dot, :dot, :dash, :dash],
+        '4' => [:dot, :dot, :dot, :dot, :dash],
+        '5' => [:dot, :dot, :dot, :dot, :dot],
+        '6' => [:dash, :dot, :dot, :dot, :dot],
+        '7' => [:dash, :dash, :dot, :dot, :dot],
+        '8' => [:dash, :dash, :dash, :dot, :dot],
+        '9' => [:dash, :dash, :dash, :dash, :dot],
+        '0' => [:dash, :dash, :dash, :dash, :dash],
+        '.' => [:dot, :dash, :dot, :dash, :dot, :dash],
+        ',' => [:dash, :dash, :dot, :dot, :dash, :dash],
+        '=' => [:dash, :dot, :dot,:dot, :dash],
+        '!' => [:dot, :dot, :dash, :dash, :dot],
+        '/' => [:dash, :dot, :dot, :dash, :dot],
+        '?' => [:dot, :dot, :dash, :dash, :dot, :dot],
+        ' ' => []
+      }
+    end
+
   end
-end

data/lib/cw/print.rb

@@ -81,57 +81,62 @@ class Print
     end
   end
 
-  def char_result popped
-    if popped
-      value = popped[:value]
-      success = popped[:success]
+  def paint(value, colour)
+    Paint[value, colour]
+  end
 
-      unless newline_maybe value
-        #return if @print_count == 0 && value == ' '
-        value = '_' if((value == ' ') && (success != true))
-        print Paint["#{value}", :blue]     if success
-        print Paint["#{value}", :red ] unless success
-        return true
-      end
+  def paint_success_failure(popped)
+    print paint(popped[:value], :blue) if popped[:success]
+    print paint(popped[:value], :red ) unless popped[:success]
+  end
+
+  def char_result popped
+    unless newline_maybe popped[:value]
+      popped[:value] = '_' if((popped[:value] == ' ') && (popped[:success] != true))
+      paint_success_failure(popped)
+      return true
     end
   end
 
   def heading
-    puts ("*" * "Current Sentence is     duration:    secs".length) + "\r"
+    "Current Sentence is     duration:    secs".length.times do
+      print '*'
+      puts
+    end
   end
 
   def print_blue(word)
-    print Paint[word, :blue]
+    print paint(word, :blue)
     cursor_pos = word.size
     (12 - cursor_pos).times{print ' '}
   end
 
   def print_green(word)
     print_blue(word)
-    print Paint["#{word} \r\n", :green]
+    print paint("#{word} \r\n", :green)
   end
 
   def print_red word
-    print Paint["#{word }\r\n", :red]
+    print paint("#{word }\r\n", :red)
   end
 
   def prn_red word
-    print Paint["#{word}", :red]
+    print paint("#{word}", :red)
   end
 
   def print_fail(word, attempt)
     print_blue(word)
-    print Paint["#{attempt }\r\n", :red]
+    print paint("#{attempt }\r\n", :red)
   end
 
   def prn(word)
     newline_maybe word
     return if(@print_count == 0 && word == ' ')
-    print Paint["#{word}", :blue]
+    print paint("#{word}", :blue)
   end
 
   def print_advice name
-    puts "#{name.to_s}: Press Q 4 times to Exit"
+    puts "#{name}: Press Q 4 times to Exit"
   end
 
 end