cw 0.2.2 → 0.2.4

data/lib/cw/alphabet.rb

@@ -4,24 +4,61 @@
 
 class Alphabet
 
+  # 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
+
   def initialize(options = {})
     @options = options
   end
 
+  # return string containing alphabet
+
   def alphabet
     'abcdefghijklmnopqrstuvwxyz'
   end
 
+  # reverse alphabet if :reverse option defined
+
   def reverse_alphabet_maybe
     @letters.reverse! if @options[:reverse]
   end
 
+  # shuffle alphabet if :shuffle option defined
+
   def shuffle_alphabet_maybe
     @letters = @letters.split('').shuffle.join if @options[:shuffle]
   end
 
+  # include letters passed in as string if :include defined
+
+  def include_letters
+    if @options[:include]
+      @letters = @options[:include]
+    end
+  end
+
+  # exclude letters passed in as string if :exclude defined
+
+  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(' ')

data/lib/cw/audio_player.rb

@@ -2,16 +2,43 @@
 
 class AudioPlayer
 
+  AFPLAY = '/usr/bin/afplay'
+
+#todo  def initialize
+#todo    if Params.play_command
+#todo      @play_command = Params.play_command
+#todo    end
+#todo  end
+
   def tone
     @tone ||= ToneGenerator.new
   end
 
   def play_command
-    @play_command ||= 'afplay'
+    @play_command ||= AFPLAY
   end
 
   def play_filename_for_ebook2cw
-    @play_filename ||= "#{Params.audio_dir}/#{Params.audio_filename}0000.mp3"
+    @play_filename ||= File.expand_path(Params.audio_filename, audio_dir)
+  end
+
+  def audio_dir
+    Params.audio_dir ||= './audio'
+  end
+
+  def temp_filename_for_ebook2cw
+    File.expand_path("tempxxxx.txt", audio_dir)
+  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
 
 #FIXME dry_run
@@ -19,6 +46,7 @@ class AudioPlayer
     words = words.delete("\n")
     cl = Cl.new.cl_echo(words)
     ! @dry_run ? `#{cl}` : cl
+    File.rename(play_filename + '0000.mp3', play_filename)
   end
 
   def convert_words words
@@ -42,7 +70,7 @@ class AudioPlayer
       Process.kill(:TERM, @pid)
       Process.wait(@pid)
     rescue
-      puts 'Error: Failed to kill pid ' + @pid.to_s
+#      puts 'Error: Failed to kill pid ' + @pid.to_s
       exit 1
     end
   end

data/lib/cw/book.rb

@@ -11,7 +11,6 @@ class Book < FileDetails
     super()
     read_book book_location
     find_sentences
-
 #    print_book_advice
   end
 
@@ -37,12 +36,22 @@ class Book < FileDetails
   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
+
   def change_or_repeat_sentence?
     sentence.change_or_repeat?
   end
 
   def change_repeat_or_quit?
-    change_or_repeat_sentence? || quit?
+    if(change_or_repeat_sentence? || quit?)
+      sentence.index += 1
+      write_book_progress
+      return true
+    end
+    false
   end
 
   def check_sentence_navigation chr
@@ -102,7 +111,7 @@ class Book < FileDetails
   end
 
   def compile_sentence
-    audio.convert_words add_space current_sentence
+    audio.convert_words(add_space(current_sentence))
   end
 
   def compile_and_play
@@ -118,12 +127,12 @@ class Book < FileDetails
 
   def next_sentence_or_quit?
     playing = audio_still_playing?
+    sleep 0.01 if 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
+      return true
     end
   end
 
@@ -194,13 +203,11 @@ class Book < FileDetails
       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

data/lib/cw/book_details.rb

@@ -6,7 +6,7 @@ class BookDetails
 
   HERE = File.dirname(__FILE__) + '/'
   GEM_BOOK_DIRECTORY     = HERE + '../../data/text/'
-  GEM_BOOK_NAME          = 'adv_of_sh_holmes.txt'
+  GEM_BOOK_NAME          = 'book.txt'
   DEFAULT_BOOK_DIRECTORY = 'books'
 
   def initialize
@@ -36,7 +36,7 @@ class BookDetails
   end
 
   def book_location
-    File.expand_path(File.join Params.book_dir, Params.book_name)
+    File.expand_path(Params.book_name, Params.book_dir)
   end
 
   def arguments args

data/lib/cw/cl.rb

@@ -63,7 +63,7 @@ class Cl
   end
 
   def cl_audio_filename
-    "-o \"#{Params.audio_dir}/#{Params.audio_filename}\" "
+    "-o \"#{File.expand_path(Params.audio_filename, Params.audio_dir)}\" "
   end
 
   def coarse_quality(quality)
@@ -105,8 +105,17 @@ class Cl
     ].collect{|param| param}.join
   end
 
+  def ebook2cw_path
+    Params.ebook2cw_path ||= 'ebook2cw'
+    Params.ebook2cw_path
+  end
+
   def cl_echo words
-    "echo #{words} | ebook2cw #{build_command_line}"
+    "echo #{words} | #{ebook2cw_path} #{build_command_line}"
+  end
+
+  def cl_full input
+    "#{ebook2cw_path} #{build_command_line} #{input}"
   end
 
 end

data/lib/cw/config_file.rb

@@ -0,0 +1,69 @@
+class ConfigFile
+
+  CONFIG  = ".cw_config"
+  HERE    = File.dirname(__FILE__) + '/'
+  CONFIGS = ['wpm', 'book_name', 'book_dir',
+            'play_command', 'success_colour', 'fail_colour',
+            'list_colour', 'ebook2cw_path']
+
+  attr_reader :config
+
+  def config
+    @config ||= Hash.new
+  end
+
+  def readlines f
+    f.readlines
+  end
+
+  def write_config(cfg, line)
+    config[cfg.to_sym] = line.gsub(cfg + ':', '').strip
+  end
+
+  def match_config?(line, cfg)
+    if line
+      tmp = line.strip()[0, cfg.length]
+      return true if(tmp == cfg)
+    end
+    false
+  end
+
+  def extract_config line
+    CONFIGS.each do |cfg|
+      if match_config?(line, cfg + ':')
+        write_config(cfg, line)
+        return
+      end
+    end
+  end
+
+  def read_config
+    File.open(CONFIG,'r') do |f|
+      lines = readlines(f)
+      lines.each do |line|
+        extract_config line
+      end
+    end
+  end
+
+  def read_config_maybe
+    if File.exist?(CONFIG)
+      puts 'Loading config.'
+      read_config
+      config
+    end
+  end
+
+  def apply_config(sf)
+    cfg = read_config_maybe
+    if cfg
+      cfg.each_pair do |method, arg|
+        begin
+          sf.send("#{method}", arg)
+        rescue
+        end
+        Params.send("#{method}=", arg)
+      end
+    end
+  end
+end

data/lib/cw/cw_dsl.rb

@@ -2,8 +2,12 @@
 
 # class Cw_dsl provides CW's commands
 
+require_relative 'params'
+
 class CwDsl
 
+  include Params::ParamsSetup
+
   attr_accessor :cl
 
   HERE = File.dirname(__FILE__) + '/'
@@ -16,55 +20,7 @@ class CwDsl
   def initialize
     @words, @cl, @str =
       Words.new, Cl.new, Str.new
-    init_config
-  end
-
-  [:name,          :wpm,
-   :effective_wpm, :word_spacing,
-   :command_line,  :frequency,
-   :author,        :title,
-   :quality,       :audio_filename,
-   :pause,         :noise,
-   :shuffle,       :mark_words,
-   :double_words,  :single_words,
-   :audio_dir,     :def_word_count,
-   :book_name,     :book_dir
-  ].each do |method|
-    define_method method do |arg = nil|
-      arg ? Params.send("#{method}=", arg) : Params.send("#{method}")
-    end
-  end
-
-  [[:pause, :pause, true],
-   [:un_pause, :pause, nil],
-   [:print_letters, :print_letters, true],
-   [:mark_words, :print_letters, nil],
-   [:noise, :noise, true],
-   [:no_noise, :noise, nil],
-   [:shuffle, :shuffle, true],
-   [:no_shuffle, :shuffle, nil],
-   [:double_words, :double_words, true],
-   [:single_words, :double_words, nil],
-   [:use_ebook2cw, :use_ebook2cw, true],
-   [:use_ruby_tone, :use_ebook2cw, nil],
-  ].each do |bool|
-    define_method bool[0] do
-      Params.send("#{bool[1]}=", bool[2])
-      @words.shuffle if((bool[1] == :shuffle) && (bool[2]))
-    end
-  end
-
-  def init_config
-    Params.config do
-      param :name, :wpm,
-      :dictionary, :command_line, :audio_filename, :tone, :pause,
-      :print_letters, :double_words,
-      :word_filename, :author, :title, :quality, :frequency, :shuffle, :effective_wpm,
-      :max, :min, :word_spacing, :noise, :begin, :end, :word_count, :including,
-      :word_size, :size, :beginning_with, :ending_with, :mark_words, :audio_dir,
-      :use_ebook2cw, :def_word_count, :book_dir, :book_name
-    end
-
+    Params.init_config
     config_defaults
     config_files
   end
@@ -75,14 +31,13 @@ class CwDsl
       wpm            25
       frequency      500
       dictionary     COMMON_WORDS
-#      def_word_count 100
     }
   end
 
   def config_files
     Params.config {
       audio_dir      'audio'
-      audio_filename 'audio_output.wav'
+      audio_filename 'audio_output'
       word_filename  'words.txt'
     }
   end
@@ -123,6 +78,10 @@ class CwDsl
     @words.including letters
   end
 
+  def containing(* letters)
+    @words.containing letters
+  end
+
   def no_longer_than(max)
     Params.max = max
     @words.no_longer_than max
@@ -165,9 +124,9 @@ class CwDsl
   def numbers_spoken()
   end
 
-#  def add_noise
-#    Params.noise = true
-#  end
+  #  def add_noise
+  #    Params.noise = true
+  #  end
 
   def reload
     load_words(Params.dictionary)
@@ -191,9 +150,12 @@ class CwDsl
 
   #todo refactor
 
-  def load_alphabet
-    @words.assign '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 '
-  end
+  def alpha ; 'a'.upto('z').collect{|ch| ch} ; end
+
+  def vowels          ; ['a','e','i','o','u']        ; end
+  def load_vowels     ; @words.assign vowels         ; end
+  def load_alphabet   ; @words.assign alpha          ; end
+  def load_consonants ; @words.assign alpha - vowels ; end
 
   def load_numbers
     @words.assign '1 2 3 4 5 6 7 8 9 0 '

data/lib/cw/monitor_keys.rb

@@ -24,7 +24,7 @@ class MonitorKeys
   def monitor_keys
     loop do
       get_key_input
-      break if check_quit_key_input?
+      break if check_quit_key_input
       if @cw.quit
         key_input.reset
         break

data/lib/cw/params.rb

@@ -0,0 +1,104 @@
+# encoding: utf-8
+
+module Params
+
+  module ParamsSetup
+
+    [:name,          :wpm,
+     :effective_wpm, :word_spacing,
+     :command_line,  :frequency,
+     :author,        :title,
+     :quality,       :audio_filename,
+     :pause,         :noise,
+     :shuffle,       :mark_words,
+     :double_words,  :single_words,
+     :audio_dir,     :def_word_count,
+     :book_name,     :book_dir,
+     :play_command,  :success_colour,
+     :fail_colour,   :list_colour,
+     :ebook2cw_path
+    ].each do |method|
+      define_method method do |arg = nil|
+        arg ? Params.send("#{method}=", arg) : Params.send("#{method}")
+      end
+    end
+
+    [[:pause, :pause, true],
+     [:un_pause, :pause, nil],
+     [:print_letters, :print_letters, true],
+     [:mark_words, :print_letters, nil],
+     [:noise, :noise, true],
+     [:no_noise, :noise, nil],
+     [:shuffle, :shuffle, true],
+     [:no_shuffle, :shuffle, nil],
+     [:double_words, :double_words, true],
+     [:single_words, :double_words, nil],
+     [:use_ebook2cw, :use_ebook2cw, true],
+     [:use_ruby_tone, :use_ebook2cw, nil],
+    ].each do |bool|
+      define_method bool[0] do
+        Params.send("#{bool[1]}=", bool[2])
+        @words.shuffle if((bool[1] == :shuffle) && (bool[2]))
+      end
+    end
+
+  end
+
+  extend self
+
+  def init_config
+    config do
+      param :name, :wpm, :dictionary, :command_line, :audio_filename, :tone, :pause,
+            :print_letters, :double_words, :word_filename, :author, :title, :quality,
+            :frequency, :shuffle, :effective_wpm, :max, :min, :word_spacing, :noise,
+            :begin, :end, :word_count, :including, :word_size, :size, :beginning_with,
+            :ending_with, :mark_words, :audio_dir, :use_ebook2cw, :def_word_count,
+            :book_dir, :book_name, :play_command, :success_colour, :fail_colour,
+            :list_colour, :ebook2cw_path
+    end
+  end
+
+  def param_method values, name
+    value = values.first
+    value ? self.send("#{name}=", value) : instance_variable_get("@#{name}")
+  end
+
+  def param_internal name
+    attr_accessor name
+    instance_variable_set("@#{name}", nil)
+    define_method name do | * values|
+      param_method values, name
+    end
+  end
+
+  def param( * names)
+    names.each do |name|
+      param_internal name
+    end
+  end
+
+  def config( & block)
+    instance_eval( & block)
+  end
+
+  def shuffle_str
+    shuffle ? "Shuffle:    #{shuffle ? 'yes' : 'no'}\n" : nil
+  end
+
+  def word_count_str
+    word_count ? "Word count: #{word_count}\n" : nil
+  end
+
+  def wpm_str
+    "WPM:        #{wpm}\n"
+  end
+
+  def word_size_str
+    size ? "Word size:  #{size}\n" : nil
+  end
+
+  def delim_str
+    "#{'=' * Params.name.size}\n"
+  end
+
+end