cw 0.0.1

data/example.rb

@@ -0,0 +1,139 @@
+require_relative 'lib/cw'
+
+CW.new do
+  comment 'read book feed (1 sentence)'
+  play_book(sentences: 1)
+end
+
+CW.new do
+  comment 'read book feed (1 minute)'
+  play_book(duration: 1)
+end
+
+CW.new do
+  comment 'read rss feed (1 article)'
+  read_rss(:reuters, 1)
+end
+
+CW.new do
+  name 'test straight alphabet'
+  alphabet
+end
+
+CW.new do
+  comment 'test straight numbers'
+  numbers
+end
+
+CW.new do
+  wpm  18
+  ewpm 12
+  load_abbreviations
+  shuffle
+end
+
+CW.new do
+  wpm  18
+  ewpm 12
+  load_q_codes
+  shuffle
+end
+
+def cw_settings
+  shuffle
+  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.new do
+  comment 'test random letters'
+  random_letters(size: 4)
+  cw_settings
+end
+
+CW.new do
+  comment 'test random numbers'
+#  use_ebook2cw
+  cw_settings
+  random_numbers(count: 2, size: 5)
+end
+
+CW.new 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.new
+#  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 = nil
+
+  test = CW.new
+  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 = nil
+
+  #  test = CW.new
+  #  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.new
+  #  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.new
+  #  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
+end
+
+puts 'done'

data/lib/cw.rb

@@ -0,0 +1,111 @@
+# encoding: utf-8
+
+require_relative 'cw/version'
+require_relative 'cw/file_details'
+require_relative 'cw/process'
+require_relative 'cw/cw_dsl'
+require_relative 'cw/randomize'
+require_relative 'cw/sentence'
+require_relative 'cw/alphabet'
+require_relative 'cw/numbers'
+require_relative 'cw/str'
+require_relative 'cw/rss'
+require_relative 'cw/words'
+require_relative 'cw/cl'
+require_relative 'cw/cw_params'
+require_relative 'cw/key_input'
+require_relative 'cw/stream'
+require_relative 'cw/timing'
+require_relative 'cw/print'
+require_relative 'cw/audio_player'
+require_relative 'cw/cw_threads'
+require_relative 'cw/book_details'
+require_relative 'cw/tester'
+require_relative 'cw/test_words'
+require_relative 'cw/test_letters'
+require_relative 'cw/repeat_word'
+require_relative 'cw/book'
+require_relative 'cw/cw_encoding'
+require_relative 'cw/tone_generator.rb'
+require_relative 'cw/progress'
+
+# class CW provides Morse code generation functionality
+
+class CW < CwDsl
+
+  attr_accessor :dry_run
+  attr_accessor :quit
+
+  def test_letters
+    @inhibit_block_run = true
+    test_letters = TestLetters.new
+    test_letters.run @words
+  end
+
+  def repeat_word
+    @inhibit_block_run = true
+    repeat_word = RepeatWord.new
+    repeat_word.run @words
+  end
+
+  def initialize(&block)
+
+    super
+
+    load_common_words# unless @words.exist?
+    instance_eval(&block) if block
+    run unless Params.pause if (block && ! @inhibit_block_run)
+  end
+
+  def to_s
+    @str.to_s
+  end
+
+  def run_word_test
+    test_words = TestWords.new
+    test_words.run @words
+  end
+
+  def test_words
+    run_word_test
+  end
+
+  def play_book args = {}
+    @inhibit_block_run = true
+    details = BookDetails.new
+    details.arguments(args)
+    book = Book.new details
+    book.run @words
+  end
+
+  def read_rss(source, show_count = 3)
+    @inhibit_block_run = true
+    rss, = Rss.new
+    rss.read_rss(source, show_count)
+    loop do
+      article = rss.next_article
+      return unless article
+      test_words = TestWords.new
+      @words.assign article
+      test_words.run @words
+    end
+  end
+
+  def run ; test_words ; end
+
+  alias_method :ewpm,                  :effective_wpm
+  alias_method :no_run,                :pause
+  alias_method :comment,               :name
+#  alias_method :repeat_word,           :double_words
+  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

data/lib/cw/alphabet.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+#class Alphabet provides alphabet generation functionality
+
+class Alphabet
+
+  def initialize(options = {})
+    @options = options
+  end
+
+  def alphabet
+    'abcdefghijklmnopqrstuvwxyz'
+  end
+
+  def reverse_alphabet_maybe
+    @letters.reverse! if @options[:reverse]
+  end
+
+  def shuffle_alphabet_maybe
+    @letters = @letters.split('').shuffle.join if @options[:shuffle]
+  end
+
+  def generate
+    @letters = alphabet
+    shuffle_alphabet_maybe
+    reverse_alphabet_maybe
+    @letters.split('').join(' ')
+  end
+end

data/lib/cw/audio_player.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+
+class AudioPlayer
+
+  def tone
+    @tone ||= ToneGenerator.new
+  end
+
+  def play_command
+    @play_command ||= 'afplay'
+  end
+
+  def play_filename_for_ebook2cw
+    @play_filename ||= "#{Params.audio_dir}/#{Params.audio_filename}0000.mp3"
+  end
+
+  def convert_words_with_ebook2cw words
+    words = words.gsub("\n","")
+    cl = Cl.new.cl_echo(words)
+    ! @dry_run ? `#{cl}` : cl
+  end
+
+  def convert_words words
+    tone.generate words           unless Params.use_ebook2cw
+    convert_words_with_ebook2cw words if Params.use_ebook2cw
+  end
+
+  def play_filename
+    return play_filename_for_ebook2cw if Params.use_ebook2cw
+    tone.play_filename
+  end
+
+  def play
+    cmd = play_command + ' ' + play_filename
+    @pid = ! @dry_run ? Process.spawn(cmd) : cmd
+  end
+
+  def stop
+    begin
+      Process.kill(:TERM, @pid)
+      Process.wait(@pid)
+    rescue
+    end
+  end
+
+  def play_tone tone
+    `#{play_command + ' ' + tone}`
+  end
+
+  def play_cmd_for_ps
+    '[' << play_command[0] << ']' << play_command[1..-1]
+  end
+
+  def still_playing?
+    ps = `ps -ewwo pid,args | grep #{play_cmd_for_ps}`
+    return ps.include? "#{play_filename_for_ebook2cw}" if Params.use_ebook2cw
+    return ps.include? tone.play_filename unless Params.use_ebook2cw
+  end
+
+  def startup_delay
+    0.2
+  end
+end

data/lib/cw/book.rb

@@ -0,0 +1,239 @@
+# encoding: utf-8
+
+class Book < FileDetails
+
+  include Tester
+
+  def initialize book_details
+#    prn.print_advice('Test Words')
+    @book_details = book_details
+    @print_letters = Params.print_letters
+    super()
+    read_book book_location
+    find_sentences
+
+#    print_book_advice
+  end
+
+  def sentence             ; @sentence ||= Sentence.new        ; end
+  def find_sentences       ; sentence.find_all                 ; end
+  def raw_text             ; sentence.text                     ; end
+  def read_book(book)      ; sentence.read_book(book)          ; end
+  def next_sentence        ; sentence.next                     ; end
+  def change_sentence      ; sentence.change                   ; end
+  def change_sentence?     ; sentence.change?                  ; end
+  def repeat_sentence?     ; sentence.repeat?                  ; end
+  def current_sentence     ; sentence.current                  ; end
+  def current_sentence_ary ; sentence.current_to_array         ; end
+  def sentence_index       ; sentence.index                    ; end
+  def play_repeat_tone     ; audio_play_tone @repeat_tone      ; end
+  def audio_play_tone t    ; audio.play_tone(t)                ; end
+  def play_r_tone          ; audio_play_tone @r_tone           ; end
+  def complete_word?       ; get_word_last_char == space       ; end
+  def audio_stop           ; audio.stop if audio_still_playing?; end
+  def book_location        ; @book_details.book_location       ; end
+  def print_letters?       ; @print_letters && ! quit?         ; end
+  def reset_sentence_flags ; sentence.reset_flags              ; end
+  def audio_play_sentence  ; audio.play                        ; end
+  def print_book_advice    ; print.print_advice('Play Book')     ; end
+
+  def change_or_repeat_sentence?
+    sentence.change_or_repeat?
+  end
+
+  def change_repeat_or_quit?
+    change_or_repeat_sentence? || quit?
+  end
+
+  def check_sentence_navigation chr
+    sentence.check_sentence_navigation chr
+  end
+
+  def progress_file
+    File.expand_path(@progress_file, @text_folder)
+  end
+
+  def get_book_progress
+    sentence.read_progress progress_file
+    @current_sentence_index = sentence_index
+  end
+
+  def write_book_progress
+    sentence.write_progress progress_file
+  end
+
+  def audio_play_repeat_tone_maybe
+    play_repeat_tone if repeat_sentence?
+  end
+
+  def monitor_keys
+    loop do
+      get_key_input
+      check_quit_key_input
+      break if quit?
+      check_sentence_navigation key_chr
+      build_word_maybe
+    end
+  end
+
+  def process_input_word_maybe
+    if @word_to_process
+      if @book_details.args[:output] == :letter
+        stream.match_first_active_element @process_input_word # .strip #todo
+      else
+        stream.match_last_active_element @process_input_word.strip #todo
+      end
+      @process_input_word = @word_to_process = nil
+    end
+  end
+
+  def build_word_maybe
+    @input_word ||= empty_string
+    @input_word << key_chr if is_relevant_char?
+    if @book_details.args[:output] == :letter
+      move_word_to_process if is_relevant_char? #todo
+    else
+      move_word_to_process if complete_word?
+    end
+  end
+
+  def add_space sentence
+    sentence + space
+  end
+
+  def compile_sentence
+    audio.convert_words add_space current_sentence
+  end
+
+  def compile_and_play
+    compile_sentence
+    audio_play_sentence
+    start_sync
+  end
+
+  def change_and_kill_audio
+    change_sentence
+    audio_stop
+  end
+
+  def next_sentence_or_quit?
+    playing = audio_still_playing?
+    next_sentence unless playing
+    sleep 0.01         if playing
+    if change_repeat_or_quit?
+      change_and_kill_audio
+#todo      prn.newline unless quit?
+      true
+    end
+  end
+
+  def await_next_sentence_or_quit
+    loop do
+      break if next_sentence_or_quit?
+    end
+  end
+
+  def quit_or_process_input?
+    quit? || @word_to_process
+  end
+
+  def process_letter letr
+    current_word.process_letter letr
+    sleep_char_delay letr
+  end
+
+  def print_marked_maybe
+    @popped = stream.pop_next_marked
+    if @book_details.args[:output] == :letter
+      print.char_result(@popped) if(@popped && ! print_letters?) #todo
+    else
+      print.results(@popped) if(@popped && ! print_letters?)
+    end
+  end
+
+  def print_words words
+    timing.init_char_timer
+    (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
+      print.prn letr if print_letters?
+      break if change_repeat_or_quit?
+    end
+  end
+
+  def print_words_for_current_sentence
+#    puts current_sentence
+    print_words current_sentence
+  end
+
+  def make_sentence_index_current
+    @current_sentence_index = sentence_index
+  end
+
+  def sentence_index_current?
+    @current_sentence_index && (@current_sentence_index == sentence_index)
+  end
+
+  def play_sentences_until_quit
+    get_book_progress
+    loop do
+      check_sentence_count :play
+      sync_with_print
+      audio_play_repeat_tone_maybe
+      reset_sentence_flags
+      compile_and_play
+      await_next_sentence_or_quit
+      break if quit?
+    end
+    print_words_exit unless @print_letters
+  end
+
+  def check_sentence_count source
+    if @book_details.session_finished? source
+      audio_stop
+      quit
+      reset_stdin
+      kill_threads
+    end
+  end
+
+  def print_sentences_until_quit
+    loop do
+      check_sentence_count :print
+      sync_with_play
+      break if quit?
+      sync_with_audio_player
+      print_words_for_current_sentence
+      print.reset
+      puts
+    end
+  end
+
+  def play_sentences_thread
+    play_sentences_until_quit
+    write_book_progress
+    #    kill_threads
+    print "\n\rplay has quit " if @debug
+  end
+
+  def print_sentences_thread
+    print_sentences_until_quit
+    kill_threads
+    print "\n\rprint has quit " if @debug
+  end
+
+  def thread_processes
+    [:monitor_keys_thread,
+     :play_sentences_thread,
+     :print_sentences_thread]
+  end
+
+end