cw 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09025bf62e23f145015ed647348560e166c13640
-  data.tar.gz: 20c42fe062a63d93af07612f55de735082abdbc9
+  metadata.gz: 4e1587225798871292fb766303aa33e8aa488d72
+  data.tar.gz: 7d75a4190163a579f8cc88f9287e579c1657facd
 SHA512:
-  metadata.gz: 08ed885767204c62256304b8da186936e1ff5d139c3e3e4e4e2779d28a3942f70b37886827970770c52fd4d29a0686d6617864fa06112937f2e706b4a1e2d19c
-  data.tar.gz: 830654b291168f7e33174b2e34e3004b5a4f308557d871b4838d170bd793cac3ed71e68da54b7e84e36ad2544c26b7870f6cfdd8fcec1d31be975a2ac6aa7a1a
+  metadata.gz: 85ec2d8ab4291cae6fa85f3e02700a080e4bdba7e634378de4d445c656b0b39375805978a80ce4e93fa1388c128815d96d6a4fcfab0302b451766d57661e790d
+  data.tar.gz: 4e61d5b90e40004359ae53751555c3de33a135f02c333ce9d15fc842b0b227b09a77e84846b26841cc1bc4dff77c30f15aae1e1eb0639c130a9e799a9a9ad9cd

data/.gitignore

@@ -8,7 +8,7 @@ Gemfile.lock
 *.gem
 *.rbc
 .bundle
-.config
+.cw_config
 coverage
 InstalledFiles
 lib/bundler/man
@@ -18,13 +18,13 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-
+books/
 # YARD artifacts
 .yardoc
 _yardoc
 doc/
 /.ruby_version/
-
+/data/text/progress.txt
 audio/audio_output.wav
 /audio/dash.wav
 /audio/audio_output.wav

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 rvm:
-  - "1.9.3"
   - "2.0.0"
+  - "2.1.0"
   - "2.2.3"
 script:
   - rake test

data/README.md

@@ -3,70 +3,67 @@
 [![Code Climate](https://codeclimate.com/github/mjago/CW/badges/gpa.svg)](https://codeclimate.com/github/mjago/CW)
 [![Dependency Status](https://gemnasium.com/badges/github.com/mjago/CW.svg)](https://gemnasium.com/github.com/mjago/CW)
 
+# Documentation:
+
+**[CW Documentation](http://mjago.github.io/CW/)**
+
 ## CW
 
-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** is a program for learning and practicing Morse Code (CW). It is written in the form of a [DSL](https://en.wikipedia.org/wiki/Domain-specific_language/) in the [Ruby](https://www.ruby-lang.org/en/downloads/) language.
 
-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** 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).
+**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).
 
+**CW** is thoroughly [documented](http://mjago.github.io/CW/), and includes a [hands-on tutorial](http://mjago.github.io/CW/mydoc_five_common_words/).
 
 # Installation:
 
 ```sh
-
 gem install cw
 ruby example.rb
-
 ```
 
  * Note: Currently only tested on OS X, and Ruby v1.9.3 and later.
 
-# Documentation:
-
-[CW Documentation](http://mjago.github.io/CW/)
-
 # Example test-script
 
 ```ruby
 
-  # example.rb (example script)
+# example.rb (example script)
 
   require 'cw'
 
-  CW.new do
+  cw do
     wpm 18
     comment 'read book (1 sentence)'
     play_book(sentences: 1)
   end
 
-  CW.new do
+  cw do
     wpm 18
     ewpm 12
     comment 'read book (2 minutes)'
     play_book(duration: 2)
   end
 
-  CW.new do
+  cw do
     comment 'read rss feed (1 article)'
     read_rss(:reuters, 1)
   end
 
-  CW.new do
+  cw do
     name 'test straight alphabet'
     alphabet
   end
 
-  CW.new do
+  cw do
     comment 'test straight numbers'
     numbers
   end
 
-  CW.new do
+  cw do
     wpm  18
     ewpm 12
     load_abbreviations
@@ -129,27 +126,6 @@ test.test_letters
 
 ```
 
-# Options:
-
-  Command / Alias
-  ---------------
- -  ewpm                  / effective_wpm
- -  no_run                / pause
- -  comment               / name
- -  repeat_word           / double_words
- -  word_length           / word_size
- -  word_shuffle          / shuffle
- -  random_letters
- -  random_numbers
- -  having_size_of        / word_size
- -  number_of_words       / word_count
- -  words_including       / including
- -  words_ending_with     / ending_with
- -  random_alphanumeric   / random_letters_numbers
- -  words_beginning_with  / beginning_with
- -  words_no_longer_than  / no_longer_than
- -  words_no_shorter_than / no_shorter_than
-
 # License
 
 [MIT License](https://raw.githubusercontent.com/mjago/CW/master/LICENSE)

data/Rakefile

@@ -1,6 +1,10 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 
+require 'rake/version_task'
+Rake::VersionTask.new
+
 Rake::TestTask.new do |t|
   t.pattern = "test/test_*.rb"
+#  t.pattern = "test/test_tester.rb"
 end

data/VERSION

@@ -0,0 +1 @@
+0.2.4

data/bin/cw

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+iterate = nil
+count   = 1
+def number_or_nil(string)
+  Integer(string || '')
+rescue ArgumentError
+  nil
+end
+
+def iterate?
+  number_or_nil ARGV[ARGV.size - 1]
+end
+
+if iterate?
+  count = ARGV.pop.to_i
+  iterate = true
+end
+
+def check_file_exists? file
+  File.exists? file
+end
+
+def check_sans_extension file
+  File.exists?("#{file}.rb")
+end
+
+def get_filename file
+  return_val = nil
+  if check_file_exists?(file)
+    return_val = file
+  elsif check_sans_extension(file)
+    return_val = "#{file}.rb"
+  end
+  return_val
+end
+
+count.times do |iter|
+  print "Iteration: #{iter + 1}   " if iterate
+  ARGV.each do |arg|
+    file = get_filename(arg)
+    system("ruby #{file}") if file
+  end
+end

data/cw.gemspec

@@ -4,19 +4,21 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name        = 'cw'
-  spec.version     = '0.2.2'
+  spec.version     = File.read('VERSION')
   spec.date        = '2016-05-21'
   spec.authors     = ["Martyn Jago"]
   spec.email       = ["martyn.jago@btinternet.com"]
   spec.description = "A ruby library to help learn and practice morse code"
   spec.summary     = "CW tutor / exerciser"
-  spec.homepage    = 'http://github.com/mjago/cw'
+  spec.homepage    = 'http://martynjago.co.uk/CW/'
   spec.files       = `git ls-files`.split($/)
+  spec.executables = "cw"
+  spec.bindir      = 'bin'
   spec.license     = 'MIT'
 
   spec.require_paths = ["lib", "audio", "data/text", "test"]
 
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_ruby_version = '>= 2.0.0'
   spec.add_runtime_dependency 'feedjira', '>= 2.0.0'
   spec.add_runtime_dependency 'htmlentities', '>= 4.3.4'
   spec.add_runtime_dependency 'paint', '>= 1.0.1'
@@ -25,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'sanitize', '>= 4.0.1'
   spec.add_runtime_dependency 'wavefile', '>= 0.7.0'
 
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency 'version', '>= 1.0.0'
+  spec.add_development_dependency 'minitest',  '>= 5.8.4'
+  spec.add_development_dependency 'simplecov', '>= 0.12.0'
 end

data/data/text/{adv_of_sh_holmes.txt → book.txt}

@@ -2185,8 +2185,8 @@ I smiled and shook my head. I can quite understand your thinking
 so. I said. Of course, in your position of unofficial adviser and
 helper to everybody who is absolutely puzzled, throughout three
 continents, you are brought in contact with all that is strange and
-bizarre. But hereI picked up the morning paper from the
-groundlet us put it to a practical test. Here is the first heading
+bizarre. But here I picked up the morning paper from the
+ground let us put it to a practical test. Here is the first heading
 upon which I come. A husbands cruelty to his wife. There is half a
 column of print, but I know without reading it that it is all
 perfectly familiar to me. There is, of course, the other woman, the
@@ -9033,7 +9033,7 @@ inquiry on hand and that you disliked the intrusion of other
 matters.
 
 Oh, you mean the little problem of the Grosvenor Square furniture
-van. That is quite cleared up nowthough, indeed, it was obvious
+van. That is quite cleared up now though, indeed, it was obvious
 from the first. Pray give me the results of your newspaper
 selections.
 
@@ -9081,7 +9081,7 @@ say that the marriage would be an absolutely quiet one, that it would
 be at St. Georges, Hanover Square, that only half a dozen intimate
 friends would be invited, and that the party would return to the
 furnished house at Lancaster Gate which has been taken by Mr.
-Aloysius Doran. Two days laterthat is, on Wednesday lastthere is
+Aloysius Doran. Two days later that is, on Wednesday lastthere is
 a curt announcement that the wedding had taken place, and that the
 honeymoon would be passed at Lord Backwaters place, near
 Petersfield. Those are all the notices which appeared before the

data/example.rb

@@ -1,38 +1,38 @@
 require 'cw'
 
-CW.new do
+cw do
   comment 'read book feed (1 sentence)'
-  play_book(sentences: 1)
+  read_book(sentences: 1)
 end
 
-CW.new do
+cw do
   comment 'read book feed (1 minute)'
-  play_book(duration: 1)
+  read_book(duration: 1)
 end
 
-CW.new do
+cw do
   comment 'read rss feed (1 article)'
   read_rss(:reuters, 1)
 end
 
-CW.new do
+cw do
   name 'test straight alphabet'
   alphabet
 end
 
-CW.new do
+cw do
   comment 'test straight numbers'
   numbers
 end
 
-CW.new do
+cw do
   wpm  18
   ewpm 12
   load_abbreviations
   shuffle
 end
 
-CW.new do
+cw do
   wpm  18
   ewpm 12
   load_q_codes
@@ -52,20 +52,20 @@ def cw_settings
   puts self.to_s
 end
 
-CW.new do
+cw do
   comment 'test random letters'
   random_letters(size: 4)
   cw_settings
 end
 
-CW.new do
+cw do
   comment 'test random numbers'
 #  use_ebook2cw
   cw_settings
   random_numbers(count: 2, size: 5)
 end
 
-CW.new do
+cw do
   comment 'test random letters numbers'
 #  use_ebook2cw
   cw_settings
@@ -76,7 +76,7 @@ wpm = 15
 ewpm = 12
 loop do
 
-  test = CW.new
+  test = cw
 #  test.use_ebook2cw
   test.comment 'test words beginning with b'
   test.shuffle
@@ -88,7 +88,7 @@ loop do
   puts test.to_s
   test.test_words
 
-  test = CW.new
+  test = cw
   test.comment 'test words including ing'
 #  test.use_ebook2cw
   test.shuffle
@@ -98,7 +98,7 @@ loop do
   test.word_count      5
   test.test_words
 
-  #  test = CW.new
+  #  test = cw
   #  test.comment         'test ing'
   #  test.use_ebook2cw
   ##  test.shuffle
@@ -109,7 +109,7 @@ loop do
   #  test.word_count      5
   #  test.test_words
   #
-  #  test = CW.new
+  #  test = cw
   #  test.comment         'test ing'
   #  test.use_ruby_tone
   ##  test.shuffle
@@ -120,7 +120,7 @@ loop do
   #  test.word_count      5
   #  test.test_words
 
-  #  test = CW.new
+  #  test = cw
   #  test.comment         'test ing'
   #  test.shuffle
   #  test.wpm             wpm

data/lib/cw.rb

@@ -15,7 +15,7 @@ require_relative 'cw/str'
 require_relative 'cw/rss'
 require_relative 'cw/words'
 require_relative 'cw/cl'
-require_relative 'cw/cw_params'
+require_relative 'cw/params'
 require_relative 'cw/key_input'
 require_relative 'cw/cw_stream'
 require_relative 'cw/timing'
@@ -27,23 +27,43 @@ require_relative 'cw/tester'
 require_relative 'cw/test_words'
 require_relative 'cw/test_letters'
 require_relative 'cw/repeat_word'
+require_relative 'cw/reveal'
 require_relative 'cw/book'
 require_relative 'cw/cw_encoding'
-require_relative 'cw/tone_generator.rb'
+require_relative 'cw/tone_generator'
 require_relative 'cw/progress'
+require_relative 'cw/config_file'
 
 # CW provides Morse code generation functionality
 
+def cw &block
+  CW.new do
+    instance_eval &block
+  end
+end
+
 class CW < CwDsl
 
 #FIXME dry_run
 #  attr_accessor :dry_run
 
+  # Initialize CW class. Eval block if passed in.
+
+  def initialize(&block)
+
+    super
+
+    load_common_words# unless @words.exist?
+    ConfigFile.new.apply_config self
+    instance_eval(&block) if block
+    run if block
+  end
+
   # Test user against letters rather than words.
   #
 
   def test_letters
-    @inhibit_block_run = true
+    Params.pause = true
     test_letters = TestLetters.new
     test_letters.run @words
   end
@@ -52,6 +72,7 @@ class CW < CwDsl
   #
 
   def test_words
+    Params.pause = true
     tw = TestWords.new
     tw.run @words
   end
@@ -60,21 +81,18 @@ class CW < CwDsl
   #
 
   def repeat_word
-    @inhibit_block_run = true
+    Params.pause = true
     repeat_word = RepeatWord.new
     repeat_word.run @words
   end
 
-  # Initialize CW class. Eval block if passed in.
-
+  # Reveal words only at end of test.
+  # Useful for learning to copy `in the head'
 
-  def initialize(&block)
-
-    super
-
-    load_common_words# unless @words.exist?
-    instance_eval(&block) if block
-    run unless Params.pause if (block && ! @inhibit_block_run)
+  def reveal
+    Params.pause = true
+    reveal = Reveal.new
+    reveal.run @words
   end
 
   # Return string containing name or comment of test.
@@ -84,20 +102,35 @@ class CW < CwDsl
     @str.to_s
   end
 
+  def list
+    Print.new.list self.to_s
+    puts
+  end
+
   # Play book using provided arguments.
   # @param [Hash] args the options to play book with.
   # @option args [Integer] :sentences Number of sentences to play
   # @option args [Integer] :duration  Number of minutes to play
   # @option args [Boolean] :letter Mark by letter if true else mark by word
 
-  def play_book args = {}
-    @inhibit_block_run = true
+  def read_book args = {}
+    Params.pause = true
     details = BookDetails.new
     details.arguments(args)
     book = Book.new details
     book.run @words
   end
 
+  # Convert book to mp3.
+
+  def convert_book args = {}
+    details = BookDetails.new
+    details.arguments(args)
+    book = Book.new details
+    Params.pause = true
+    book.convert
+  end
+
   # Reads RSS feed (requires an internet connection). Feed can be one of:
   # - bbc:
   # - reuters:
@@ -107,7 +140,7 @@ class CW < CwDsl
   # @param [Integer] article_count Number of articles to play.
 
   def read_rss(source, article_count = 3)
-    @inhibit_block_run = true
+    Params.pause = true
     rss, = Rss.new
     rss.read_rss(source, article_count)
     loop do
@@ -119,12 +152,14 @@ class CW < CwDsl
   end
 
   # Run word test
-  def run ; test_words ; end
+  def run
+    return if Params.pause
+    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