cw 0.2.4 → 0.3.0

data/lib/cw/alphabet.rb

@@ -1,66 +1,73 @@
 # encoding: utf-8
 
-#class Alphabet provides alphabet generation functionality
+module CWG
 
-class Alphabet
+  #class Alphabet provides alphabet generation functionality
 
-  # initialize class Alphabet
-  # == Parameters:
-  # options::
-  #   An optional hash containg options:
-  # :reverse - reverse alphabet
-  # :shuffle - shuffle alphabet
-  # :include - include only these letters of the alphabet
-  # :exclude - exclude these letters from the alphabet
+  class Alphabet
 
-  def initialize(options = {})
-    @options = options
-  end
+    # initialize class Alphabet
+    # == Parameters:
+    # options::
+    #   An optional hash containg options:
+    # :reverse - reverse alphabet
+    # :shuffle - shuffle alphabet
+    # :include - include only these letters of the alphabet
+    # :exclude - exclude these letters from the alphabet
 
-  # return string containing alphabet
+    def initialize(options = {})
+      @options = options
+    end
 
-  def alphabet
-    'abcdefghijklmnopqrstuvwxyz'
-  end
+    # return string containing alphabet
 
-  # reverse alphabet if :reverse option defined
+    def alphabet
+      'abcdefghijklmnopqrstuvwxyz'
+    end
 
-  def reverse_alphabet_maybe
-    @letters.reverse! if @options[:reverse]
-  end
+    # reverse alphabet if :reverse option defined
 
-  # shuffle alphabet if :shuffle option defined
+    def reverse_alphabet_maybe
+      @letters.reverse! if @options[:reverse]
+    end
 
-  def shuffle_alphabet_maybe
-    @letters = @letters.split('').shuffle.join if @options[:shuffle]
-  end
+    # shuffle alphabet if :shuffle option defined
 
-  # include letters passed in as string if :include defined
+    def shuffle_alphabet_maybe
+      unless(ENV["CW_ENV"] == "test")
+        @letters = @letters.split('').shuffle.join if @options[:shuffle]
+      end
+    end
+
+    # include letters passed in as string if :include defined
 
-  def include_letters
-    if @options[:include]
-      @letters = @options[:include]
+    def include_letters
+      if @options[:include]
+        @letters = @options[:include]
+      end
     end
-  end
 
-  # exclude letters passed in as string if :exclude defined
+    # exclude letters passed in as string if :exclude defined
 
-  def exclude_letters
-    if @options[:exclude]
-      @letters.tr!(@options[:exclude],'')
+    def exclude_letters
+      if @options[:exclude]
+        @letters.tr!(@options[:exclude],'')
+      end
+    end
+
+    # generate alphabet with options acted upon
+    # == Returns:
+    # alphabet or filtered alphabet
+
+    def generate
+      @letters = alphabet
+      include_letters
+      exclude_letters
+      shuffle_alphabet_maybe
+      reverse_alphabet_maybe
+      @letters.split('').join(' ')
     end
-  end
 
-  # generate alphabet with options acted upon
-  # == Returns:
-  # alphabet or filtered alphabet
-
-  def generate
-    @letters = alphabet
-    include_letters
-    exclude_letters
-    shuffle_alphabet_maybe
-    reverse_alphabet_maybe
-    @letters.split('').join(' ')
   end
+
 end

data/lib/cw/audio_player.rb

@@ -1,95 +1,106 @@
 # encoding: utf-8
 
-class AudioPlayer
+require 'timeout'
+require 'os'
 
-  AFPLAY = '/usr/bin/afplay'
+module CWG
 
-#todo  def initialize
-#todo    if Params.play_command
-#todo      @play_command = Params.play_command
-#todo    end
-#todo  end
+  class AudioPlayer
 
-  def tone
-    @tone ||= ToneGenerator.new
-  end
+    include CWG::OStest
 
-  def play_command
-    @play_command ||= AFPLAY
-  end
+    def tone
+      @tone ||= ToneGenerator.new
+    end
 
-  def play_filename_for_ebook2cw
-    @play_filename ||= File.expand_path(Params.audio_filename, audio_dir)
-  end
+    def os_play_command
+      if is_mac?
+        'afplay'
+      elsif is_posix?
+        'ossplay'
+      else
+        puts 'Error - play_command required in .cw_config'
+        exit 1
+      end
+    end
 
-  def audio_dir
-    Params.audio_dir ||= './audio'
-  end
+    def play_command
+      if Cfg.config["play_command"].nil?
+        Cfg.config.params["play_command"] =
+          os_play_command
+      end
+      Cfg.config["play_command"]
+    end
 
-  def temp_filename_for_ebook2cw
-    File.expand_path("tempxxxx.txt", audio_dir)
-  end
+    def play_filename_for_ebook2cw
+      @play_filename ||= File.expand_path(Cfg.config["audio_filename"], audio_dir)
+    end
 
-  def convert_book words
-    words = words.delete("\n")
-    File.open(temp_filename_for_ebook2cw, 'w') do |file|
-      file.print words
+    def audio_dir
+      Cfg.config["audio_dir"]
     end
-    cl = Cl.new.cl_full(temp_filename_for_ebook2cw)
-    ! @dry_run ? `#{cl}` : cl
-    File.delete(temp_filename_for_ebook2cw)
-    File.rename(play_filename_for_ebook2cw + '0000.mp3', play_filename_for_ebook2cw)
-  end
 
-#FIXME dry_run
-  def convert_words_with_ebook2cw words
-    words = words.delete("\n")
-    cl = Cl.new.cl_echo(words)
-    ! @dry_run ? `#{cl}` : cl
-    File.rename(play_filename + '0000.mp3', play_filename)
-  end
+    def temp_filename_for_ebook2cw
+      File.expand_path("tempxxxx.txt", audio_dir)
+    end
 
-  def convert_words words
-    tone.generate words           unless Params.use_ebook2cw
-    convert_words_with_ebook2cw words if Params.use_ebook2cw
-  end
+    def convert_book words
+      words = words.delete("\n")
+      File.open(temp_filename_for_ebook2cw, 'w') do |file|
+        file.print words
+      end
+      cl = Cl.new.cl_full(temp_filename_for_ebook2cw)
+      ! @dry_run ? `#{cl}` : cl
+      File.delete(temp_filename_for_ebook2cw)
+      File.rename(play_filename_for_ebook2cw + '0000.mp3', play_filename_for_ebook2cw)
+    end
 
-  def play_filename
-    return play_filename_for_ebook2cw if Params.use_ebook2cw
-    tone.play_filename
-  end
+    #FIXME dry_run
+    def convert_words_with_ebook2cw words
+      words = words.delete("\n")
+      cl = Cl.new.cl_echo(words)
+      ! @dry_run ? `#{cl}` : cl
+      File.rename(play_filename + '0000.mp3', play_filename)
+    end
 
-#FIXME dry_run
-  def play
-    cmd = play_command + ' ' + play_filename
-    @pid = ! @dry_run ? Process.spawn(cmd) : cmd
-  end
+    def convert_words words
+      tone.generate words unless Cfg.config["use_ebook2cw"]
+      convert_words_with_ebook2cw words if Cfg.config["use_ebook2cw"]
+    end
 
-  def stop
-    begin
-      Process.kill(:TERM, @pid)
-      Process.wait(@pid)
-    rescue
-#      puts 'Error: Failed to kill pid ' + @pid.to_s
-      exit 1
+    def play_filename
+      return play_filename_for_ebook2cw if Cfg.config["use_ebook2cw"]
+      tone.play_filename
     end
-  end
 
-  def play_tone tone
-    `#{play_command + ' ' + tone}`
-  end
+    #FIXME dry_run
+    def play
+      cmd = play_command + ' ' + play_filename
+      @pid = ! @dry_run ? Process.spawn(cmd) : cmd
+      Process.waitpid(@pid)
+    end
 
-  def play_cmd_for_ps
-    '[' << play_command[0] << ']' << play_command[1..-1]
-  end
+    def stop
+      begin
+        Process.kill(:TERM, @pid)
+        Process.wait(@pid)
+      rescue
+      end
+    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 play_tone tone
+      `#{play_command + ' ' + tone}`
+    end
 
-  def startup_delay
-    0.2
+    def play_cmd_for_ps
+      '[' << play_command[0] << ']' << play_command[1..-1]
+    end
+
+    def still_playing?
+      cl = "ps -eo  pid,args | grep #{play_cmd_for_ps}"
+      ps = `#{cl}`
+      return ps.include?("#{play_filename_for_ebook2cw}") if Cfg.config["use_ebook2cw"]
+      return ps.include?(tone.play_filename) unless Cfg.config["use_ebook2cw"]
+    end
   end
 end

data/lib/cw/book.rb

@@ -1,227 +1,202 @@
 # 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
+module CWG
 
-  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 convert
-    book = @sentence.all.join
-    audio.convert_book(book)
-  end
+  class Book < Tester
 
-  def change_or_repeat_sentence?
-    sentence.change_or_repeat?
-  end
+    include FileDetails
 
-  def change_repeat_or_quit?
-    if(change_or_repeat_sentence? || quit?)
-      sentence.index += 1
-      write_book_progress
-      return true
+    def initialize book_details
+      init_filenames
+      @book_details = book_details
+      read_book book_location
+      find_sentences
     end
-    false
-  end
 
-  def check_sentence_navigation chr
-    sentence.check_sentence_navigation chr
-  end
+    def sentence             ; @sentence ||= Sentence.new        ; end
+    def find_sentences       ; sentence.find_all                 ; end
+    def read_book(book)      ; sentence.read_book(book)          ; end
+    def play_repeat_tone     ; play.audio.play_tone @repeat_tone ; end
+    def complete_word?       ; get_word_last_char == ' '         ; end
+    def book_location        ; @book_details.book_location       ; end
+    def print_book_advice    ; print.print_advice('Play Book')   ; end
+
+    def convert
+      book = @sentence.all.join
+      play.audio.convert_book(book)
+    end
 
-  def progress_file
-    File.expand_path(@progress_file, @text_folder)
-  end
+    def change_or_repeat_sentence?
+      sentence.change_or_repeat?
+    end
 
-  def get_book_progress
-    sentence.read_progress progress_file
-    @current_sentence_index = sentence_index
-  end
+    def change_repeat_or_quit?
+      if(change_or_repeat_sentence? || quit?)
+        sentence.index += 1
+        write_book_progress
+        return true
+      end
+      false
+    end
 
-  def write_book_progress
-    sentence.write_progress progress_file
-  end
+    def check_sentence_navigation chr
+      sentence.check_sentence_navigation chr
+    end
 
-  def audio_play_repeat_tone_maybe
-    play_repeat_tone if repeat_sentence?
-  end
+    def progress_file
+      File.expand_path(@progress_file, @text_folder)
+    end
 
-  def monitor_keys
-    loop do
-      get_key_input
-      check_quit_key_input
-      break if quit?
-      check_sentence_navigation key_chr
-      build_word_maybe
+    def get_book_progress
+      sentence.read_progress progress_file
+      @current_sentence_index = sentence.index
     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
+    def write_book_progress
+      sentence.write_progress progress_file
     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?
+    def audio_play_repeat_tone_maybe
+      play_repeat_tone if sentence.repeat?
     end
-  end
 
-  def add_space sentence
-    sentence + space
-  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 compile_sentence
-    audio.convert_words(add_space(current_sentence))
-  end
+    def build_word_maybe
+      @input_word ||= ''
+      @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 compile_and_play
-    compile_sentence
-    audio_play_sentence
-    start_sync
-  end
+    def compile_sentence
+      play.audio.convert_words(sentence.current + ' ')
+    end
 
-  def change_and_kill_audio
-    change_sentence
-    audio_stop
-  end
+    def compile_and_play
+      compile_sentence
+      play.start_sync()
+      play.audio.play
+    end
 
-  def next_sentence_or_quit?
-    playing = audio_still_playing?
-    sleep 0.01 if playing
-    next_sentence unless playing
-    if change_repeat_or_quit?
-      change_and_kill_audio
-#todo      prn.newline unless quit?
-      return true
+#    def change_and_kill_audio
+#      sentence.change
+#      play.stop
+#    end
+
+    def next_sentence_or_quit?
+      sleep 0.01 if play.still_playing?
+      sentence.next unless play.still_playing?
+      if change_repeat_or_quit?
+        play.stop
+#        quit #todo
+        sentence.change unless quit?
+        #        change_and_kill_audio
+        #todo      prn.newline unless quit?
+        return true
+      end
     end
-  end
 
-  def await_next_sentence_or_quit
-    loop do
-      break if next_sentence_or_quit?
+    def await_next_sentence_or_quit
+      loop do
+        break if next_sentence_or_quit?
+        sleep 0.01
+      end
     end
-  end
 
-  def quit_or_process_input?
-    quit? || @word_to_process
-  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 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?)
+    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
-  end
 
-  def print_words_for_current_sentence
-    print_words current_sentence
-  end
+    def print_words_for_current_sentence
+      print_words(sentence.current)
+    end
 
-  def make_sentence_index_current
-    @current_sentence_index = sentence_index
-  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 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
-      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 play_sentences_until_quit
+      get_book_progress
+
+      loop do
+        check_sentence_count
+        sync_with_print
+        audio_play_repeat_tone_maybe
+        sentence.reset_flags
+        compile_and_play
+        await_next_sentence_or_quit
+        break if quit?
+      end
+      print_words_exit
+    end
 
-  def check_sentence_count
-    if @book_details.session_finished?
-      audio_stop
-      quit
-      reset_stdin
-      kill_threads
+    def check_sentence_count
+      if @book_details.session_finished?
+        play.stop
+        quit
+        #      reset_stdin
+        #     kill_threads
+      end
     end
-  end
 
-  def print_sentences_until_quit
-    loop do
-      check_sentence_count
-      sync_with_play
-      break if quit?
-      sync_with_audio_player
-      print_words_for_current_sentence
-      print.reset
+    def print_sentences_until_quit
+      loop do
+        check_sentence_count
+        sync_with_play
+        break if quit?
+        sync_with_audio_player
+        print_words_for_current_sentence
+      end
     end
-  end
 
-  def play_sentences_thread
-    play_sentences_until_quit
-    #    kill_threads
-    print "\n\rplay has quit " if @debug
-  end
+    def play_sentences_thread
+      play_sentences_until_quit
+      print "\n\rplay has quit " if @debug
+      exit!
+    end
 
-  def print_sentences_thread
-    print_sentences_until_quit
-    kill_threads
-    print "\n\rprint has quit " if @debug
-  end
+    def print_sentences_thread
+      print_sentences_until_quit
+      print "\n\rprint has quit " if @debug
+      exit!
+    end
 
-  def thread_processes
-    [:monitor_keys_thread,
-     :play_sentences_thread,
-     :print_sentences_thread]
+    def thread_processes
+      [:monitor_keys_thread,
+       :play_sentences_thread,
+       :print_sentences_thread
+      ]
+    end
   end
-
 end