cw 0.0.11 → 0.0.12

data/doc/monitor.html

@@ -426,7 +426,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon May 23 21:20:17 2016 by
+  Generated on Wed May 25 15:00:25 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.0).
 </div>

data/doc/top-level-namespace.html

@@ -105,7 +105,7 @@
 </div>
 
     <div id="footer">
-  Generated on Mon May 23 21:20:15 2016 by
+  Generated on Wed May 25 15:00:24 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.2.0).
 </div>

data/lib/cw.rb

@@ -28,25 +28,42 @@ require_relative 'cw/cw_encoding'
 require_relative 'cw/tone_generator.rb'
 require_relative 'cw/progress'
 
-# class CW provides Morse code generation functionality
+# CW provides Morse code generation functionality
 
 class CW < CwDsl
 
   attr_accessor :dry_run
   attr_accessor :quit
 
+  # Test user against letters rather than words.
+  #
+
   def test_letters
     @inhibit_block_run = true
     test_letters = TestLetters.new
     test_letters.run @words
   end
 
+  # Test user against complete words rather than letters.
+  #
+
+  def test_words
+    tw = TestWords.new
+    tw.run @words
+  end
+
+  # Repeat word repeats the current word if the word is entered incorrectly (or not entered at all).
+  #
+
   def repeat_word
     @inhibit_block_run = true
     repeat_word = RepeatWord.new
     repeat_word.run @words
   end
 
+  # Initialize CW class. Eval block if passed in.
+
+
   def initialize(&block)
 
     super
@@ -56,18 +73,18 @@ class CW < CwDsl
     run unless Params.pause if (block && ! @inhibit_block_run)
   end
 
+  # Return string containing name or comment of test.
+  # @return [String] comment / name
+
   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
+  # 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
@@ -77,19 +94,27 @@ class CW < CwDsl
     book.run @words
   end
 
-  def read_rss(source, show_count = 3)
+  # Reads RSS feed (requires an internet connection). Feed can be one of:
+  # - bbc:
+  # - reuters:
+  # - guardian:
+  # - quotation:
+  # @param [Symbol] source The source of the feed.
+  # @param [Integer] article_count Number of articles to play.
+
+  def read_rss(source, article_count = 3)
     @inhibit_block_run = true
     rss, = Rss.new
-    rss.read_rss(source, show_count)
+    rss.read_rss(source, article_count)
     loop do
       article = rss.next_article
       return unless article
-      test_words = TestWords.new
       @words.assign article
-      test_words.run @words
+      run
     end
   end
 
+  # Run word test
   def run ; test_words ; end
 
   alias_method :ewpm,                  :effective_wpm

data/lib/cw/cw_dsl.rb

@@ -4,6 +4,8 @@
 
 class CwDsl
 
+  attr_accessor :cl
+
   HERE = File.dirname(__FILE__) + '/'
   TEXT = HERE + '../../data/text/'
   COMMON_WORDS      = TEXT + 'common_words.txt'

data/lib/cw/rss.rb

@@ -9,24 +9,25 @@ class Rss
       bbc:        'http://feeds.bbci.co.uk/news/rss.xml',
       reuters:    'http://feeds.reuters.com/Reuters/worldNews?format=xml',
       guardian:   'http://www.theguardian.com/world/rss',
-      quotations: 'http://feeds.feedburner.com/quotationspage/qotd'
+      quotation: 'http://feeds.feedburner.com/quotationspage/qotd'
     }
   end
 
   def source src
-    sources.has_key?(src) ? sources[src] : sources[:quotations]
+    sources.has_key?(src) ? sources[src] : sources[:quotation]
   end
 
-  def read_rss(src, show_count = 3)
+  def read_rss(src, article_count = 3)
     require 'feedjira'
     require "htmlentities"
     require 'sanitize'
     coder = HTMLEntities.new
     url   = source(src)
-    feed  = Feedjira::Feed.fetch_and_parse url # returns a Hash, with each url having a Feedjira::Feed object
+    # return a Hash - each url having a Feedjira::Feed object
+    feed  = Feedjira::Feed.fetch_and_parse url
     entry_count = 0
     @rss_articles = []
-    entry = feed.entries.each do |entry|
+    feed.entries.each do |entry|
       title = entry.title
       unless(title.include?('VIDEO:') ||
              title.include?('In pictures:') ||
@@ -35,7 +36,7 @@ class Rss
         entry_count += 1
       end
       @rss_articles << (Sanitize.clean coder.decode words).split(',')
-      break if entry_count >= show_count
+      break if entry_count >= article_count
     end
     @rss_flag = true
   end

data/lib/cw/str.rb

@@ -10,16 +10,17 @@ class Str
 
   def to_s
     delim  = delim_std_str
-    ["\n#{Params.name}\r",
-     "\n#{delim}",
-     "#{wpm_str}\n",
-     shuffle_str,
-     word_count_str,
-     word_size_str,
-     beginning_str,
-     ending_str,
-     delim].
-      collect{ |prm| prm.to_s }.join
+    [
+      "#{Params.name}\n",
+      "#{delim}",
+      "#{wpm_str}",
+      shuffle_str,
+      word_count_str,
+      word_size_str,
+      beginning_str,
+      ending_str,
+      delim
+    ].collect{ |prm| prm.to_s }.join
   end
 
   def stringify ary
@@ -27,7 +28,7 @@ class Str
   end
 
   def delim_str size
-    "#{'=' * size}\n\r"
+    "#{'=' * size}\n"
   end
 
   def delim_std_str
@@ -37,31 +38,31 @@ class Str
 
   def shuffle_str
     shuffle =  Params.shuffle
-    shuffle ? "Shuffle:    #{shuffle ? 'yes' : 'no'}\n\r" : nil
+    shuffle ? "Shuffle:    #{shuffle ? 'yes' : 'no'}\n" : nil
   end
 
   def word_count_str
     wc = Params.word_count
-    wc ? "Word count: #{wc}\n\r" : nil
+    wc ? "Word count: #{wc}\n" : nil
   end
 
   def word_size_str
     size = Params.size
-    size ? "Word size:  #{size}\n\r" : nil
+    size ? "Word size:  #{size}\n" : nil
   end
 
   def beginning_str
     beginning = Params.begin
-    beginning ? "Beginning:  #{stringify beginning}\n\r" : nil
+    beginning ? "Beginning:  #{stringify beginning}\n" : nil
   end
 
   def ending_str
     ending = Params.end
-    ending ? "Ending:     #{stringify ending}\n\r" : nil
+    ending ? "Ending:     #{stringify ending}\n" : nil
   end
 
   def wpm_str
-    "WPM:        #{Params.wpm}\n\r"
+    "WPM:        #{Params.wpm}\n"
   end
 
 end

data/test/test_cw.rb

@@ -136,7 +136,8 @@ class TestCW < MiniTest::Test
        %q(unnamed
 =======
 WPM:        25
-=======)
+=======
+)
      assert_equal temp, @cw.to_s
    end
 
@@ -150,13 +151,14 @@ Word count: 2
 Word size:  3
 Beginning:  l
 Ending:     x
-=======)
+=======
+)
     @cw.shuffle
     @cw.word_count 2
     @cw.word_size 3
     @cw.ending_with('x')
     @cw.beginning_with('l')
-    assert_equal temp, @cw.to_s.strip()
+    assert_equal temp, @cw.to_s
   end
 
   def test_wpm_defaults_to_25_if_unset

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cw
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - Martyn Jago
@@ -281,3 +281,4 @@ signing_key:
 specification_version: 4
 summary: CW tutor / exerciser
 test_files: []
+has_rdoc: