cw 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 510af3ccb73cc14f18cb494a0f4c794d4b9ff730
-  data.tar.gz: 228dd1eeb2d9c85325fdcb417a3a5e649bab4618
+  metadata.gz: 989e1bb7fa13915779b903aaefd8167e0afda345
+  data.tar.gz: 8e473d0a5adfec8808ba0d2fd4255dc4cbc22df1
 SHA512:
-  metadata.gz: 4b70df1d2f3102eee3d8a084599d483b35e34bce6c0a8fa68a74418ec06f16c0e37e0096950445a9a0597c79f4cba53f3d437c034fbdce078fc58aa87eb897a0
-  data.tar.gz: bfa85117733d22a8a9627398676522d7195069fc6b445a3de6f0c4f2e9de9bb76f6cf9897cb6745986d9d4cb2b41ffbd8e6067c17664bfc270cb1ff8e1fbc2a9
+  metadata.gz: fa0bbd224e8b08c6b67241df869fc41b3b8f857c8b9baf4d337007d56acfaacd31f73f7def2434f8f1b56acb922989aaebba7461814cb3fed3b97472ceea8407
+  data.tar.gz: b2c18e86a87c71948a0d9aa0e416f7c935cbe0c0113374afe871c20034c1b5c4549f182ef8c9bd283f44679a2f98090bc4ca4c22cb3f5cf5b6b0db6e04a0b137

data/Gemfile

@@ -1,11 +1,4 @@
 # CW Gemfile
 
 source "https://rubygems.org"
-
-gem 'wavefile'
-gem 'paint'
-gem 'feedjira'
-gem 'htmlentities'
-gem 'sanitize'
-gem 'ruby-progressbar'
-gem 'rake'
+gemspec

data/README.md

@@ -18,8 +18,16 @@ gem install cw
 ruby example.rb
 
 ```
+# Run tests
 
- - Note: Currently only tested on OS X (uses afplay by default).
+```sh
+
+gem install --dev cw
+ruby test/test_cw.rb
+
+```
+
+ - Note: Currently only tested on OS X, and Ruby v2.0.0 and greater.
 
 ```ruby
 
@@ -68,22 +76,22 @@ ruby example.rb
 
   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
+ -  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
 

data/cw.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name        = 'cw'
-  spec.version     = '0.0.10'
+  spec.version     = '0.0.11'
   spec.date        = '2016-05-21'
   spec.authors     = ["Martyn Jago"]
   spec.email       = ["martyn.jago@btinternet.com"]
@@ -14,4 +14,15 @@ Gem::Specification.new do |spec|
   spec.files       = `git ls-files`.split($/)
   spec.license     = 'MIT'
   spec.require_paths = ["lib", "audio", "data/text", "test"]
+
+  spec.add_dependency('wavefile')
+  spec.add_dependency('paint')
+  spec.add_dependency('feedjira')
+  spec.add_dependency('htmlentities')
+  spec.add_dependency('sanitize')
+  spec.add_dependency('ruby-progressbar')
+  spec.add_dependency('rake')
+
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "simplecov"
 end

data/test/test_cw.rb

@@ -30,12 +30,12 @@ class TestCW < MiniTest::Test
 
   def test_name_is_unnamed_if_unnamed
     assert_equal 'unnamed', @cw.name
-    end
+  end
 
   def test_name_can_be_set
     @cw.name 'testing'
     assert_equal 'testing', @cw.name
-    end
+  end
 
   def test_loads_words_by_default
     assert_equal ["the", "of", "and", "a", "to"] , @cw.words.first(5)
@@ -47,7 +47,7 @@ class TestCW < MiniTest::Test
       pause
       temp = Params.dictionary
     }
-    assert_equal File.expand_path(ROOT + '/txt/common_words.txt'), File.expand_path(temp)
+    assert_equal File.expand_path(ROOT + '/data/text/common_words.txt'), File.expand_path(temp)
   end
 
   def test_CW_takes_a_block
@@ -85,9 +85,9 @@ class TestCW < MiniTest::Test
     temp = nil
     cw = CW.new {
       no_run
-      temp = Params.mp3_filename
+      temp = Params.audio_filename
     }
-    assert_equal "mp3_output", temp
+    assert_equal "audio_output.wav", temp
   end
 
   def test_reload_reloads_dictionary
@@ -131,19 +131,18 @@ class TestCW < MiniTest::Test
     assert_equal ["the", "of", "and", "a", "to"] , @cw.words.first(5)
   end
 
-  def test_to_s_outputs_test_run_header_if_paused
-    temp = %q(
-unnamed
+   def test_to_s_outputs_test_run_header_if_paused
+     temp =
+       %q(unnamed
 =======
 WPM:        25
-=======
-)
-    assert_equal temp, @cw.to_s
-  end
+=======)
+     assert_equal temp, @cw.to_s
+   end
 
   def test_to_s_outputs_relevant_params_if_set
-    temp = %q(
-unnamed
+    temp =
+      %q(unnamed
 =======
 WPM:        25
 Shuffle:    yes
@@ -151,14 +150,13 @@ 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
+    assert_equal temp, @cw.to_s.strip()
   end
 
   def test_wpm_defaults_to_25_if_unset
@@ -201,7 +199,7 @@ Ending:     x
     @cw.word_size 2
     assert_equal ["of", "to", "in", "is", "it"] , @cw.words.first(5)
   end
-
+  
   def test_beginning_with_returns_words_beginning_with_letter
     @cw.beginning_with 'l'
     assert_equal ["like", "look", "long", "little", "large"] , @cw.words.first(5)
@@ -249,13 +247,13 @@ Ending:     x
     assert_equal ["that", "with", "they", "this", "have"] , @cw.words.first(5)
   end
 
-  def test_assign_words_converts_space_seperated_string_to_array
-    @cw.assign_words "one two\nthree  \tfour"
-    assert_equal ["one", "two", "three", "four"] , @cw.words
+  def test_words_fn_adds_words
+    @cw.words = "one two three four"
+    assert_equal "one two three four", @cw.words
   end
 
-  def test_assign_words_passes_in_an_array_of_words_as_is
-    @cw.assign_words ["one", "two", "three", "four"]
+  def test_words_fn_passes_in_an_array_of_words_as_is
+    @cw.words = ["one", "two", "three", "four"]
     assert_equal ["one", "two", "three", "four"] , @cw.words
   end
 
@@ -296,10 +294,10 @@ Ending:     x
     @cw.words.each { |w| assert_equal 4, w.length}
   end
 
-#  def test_random_numbers_returns_random_numbers
-#    @cw.random_numbers
-#    @cw.words.each { |w| assert_match /\A[-+]?\d+\z/ , w }
-#  end
+  def test_random_numbers_returns_random_numbers
+    @cw.random_numbers
+    @cw.words.each { |w| assert_match /\A[-+]?\d+\z/ , w }
+  end
 
   def test_random_letters_numbers_can_take_size_and_count_option
     @cw.random_letters_numbers(count: 3, size: 4)
@@ -321,45 +319,38 @@ Ending:     x
 
   def test_alphabet_generates_alphabet
     @cw.alphabet
-    assert_equal ["abcdefghijklmnopqrstuvwxyz"], @cw.words
+    assert_equal ["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"], @cw.words
   end
 
   def test_alphabet_generates_reversed_alphabet
     @cw.alphabet(reverse: true)
-    assert_equal ['zyxwvutsrqponmlkjihgfedcba'], @cw.words
+    assert_equal ['z y x w v u t s r q p o n m l k j i h g f e d c b a'], @cw.words
   end
 
   def test_alphabet_shuffles_alphabet
     @cw.alphabet(shuffle: true)
-    refute_equal ["abcdefghijklmnopqrstuvwxyz"], @cw.words
-    assert_equal "abcdefghijklmnopqrstuvwxyz", @cw.words.first.chars.sort.join
+    refute_equal ["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"], @cw.words
+    assert_equal "abcdefghijklmnopqrstuvwxyz", @cw.words.first.chars.sort.join.strip
   end
 
   def test_reverse_reverses_words
-    @cw.assign_words ['first', 'then', 'last']
+    @cw.words = 'first then last'
     @cw.reverse
-    assert_equal ['last', 'then', 'first'], @cw.words.first(4)
+    assert_equal 'tsal neht tsrif', @cw.words
   end
 
-  def test_save_word_file_saves_word_file
-    temp = Tempfile.new("saved.tmp")
-    @cw.assign_words ['the', 'of', 'and', 'a']
-    @cw.save_word_file(temp)
-    assert_equal "the of and a", temp.read
-    temp.close
-  end
+  #todo
+  #      def test_convert_generates_correct_command_for_default
+  #        @cw.dry_run = true
+  #        @cw.words = "some words"
+  #        assert_equal "echo some words | ebook2cw -w 25 -o \"mp3_output\" ", @cw.convert
+  #      end
 
-  def test_convert_generates_correct_command_for_default
-    @cw.dry_run = true
-    @cw.assign_words "some words"
-    assert_equal "echo some words | ebook2cw -w 25 -o \"mp3_output\" ", @cw.convert
-  end
-
-  def test_run_converts_and_plays
-    @cw.dry_run = true
-    @cw.assign_words "some words"
-    assert_equal 'played', @cw.run
-  end
+  #     def test_run_converts_and_plays
+  #       @cw.dry_run = true
+  #       @cw.words = ["some", "words"]
+  #       assert_equal 'played', @cw.run
+  #     end
 
   def test_frequency_returns_frequency
     assert_equal 567, @cw.frequency(567)
@@ -367,19 +358,21 @@ Ending:     x
     assert_equal 456, @cw.frequency
   end
 
-  def test_play_builds_correct_command_for_default
-    @cw.assign_words "some words"
-    @cw.dry_run = true
-    assert_equal "afplay mp3_output0000.mp3", @cw.play
-  end
+  #todo
+  #  def test_play_builds_correct_command_for_default
+  #    @cw.words = "some words"
+  #    @cw.dry_run = true
+  #    assert_equal "afplay mp3_output0000.mp3", @cw.play
+  #  end
 
-#  def test_dot_ms_returns_correct_time_in_milliseconds
-#    assert_in_delta(0.1, @cw.dot_ms(12), 0.001)
-#  end
-#
-#  def test_space_ms_returns_correct_time_in_milliseconds
-#    assert_in_delta(0.3, @cw.space_ms(12), 0.001)
-#  end
+  #todo
+  ##  def test_dot_ms_returns_correct_time_in_milliseconds
+  ##    assert_in_delta(0.1, @cw.dot_ms(12), 0.001)
+  ##  end
+  ##
+  ##  def test_space_ms_returns_correct_time_in_milliseconds
+  ##    assert_in_delta(0.3, @cw.space_ms(12), 0.001)
+  ##  end
 
   def test_method_aliases
     assert @cw.method(:word_length),           @cw.method(:word_size)
@@ -396,132 +389,129 @@ Ending:     x
     assert @cw.method(:no_run),                @cw.method(:pause) 
   end
 
-  def test_build_command_line_sets_w_param
+  def test_set_wpm_param
     @cw.wpm 33
-    assert @cw.build_cl.include?('-w 33 '), 'wpm param invalid'
+    assert @cw.cl.cl_wpm == '-w 33 ', 'wpm param invalid'
   end
 
-  def test_build_build_cl_sets_e_param
+  def test_set_ewpm_param
     @cw.effective_wpm 33
-    assert @cw.build_cl.include?('-e 33 '), 'effective_wpm param invalid'
+    assert @cw.cl.cl_effective_wpm == '-e 33 ', 'effective_wpm param invalid'
   end
 
-  def test_build_build_cl_sets_W_param
+  def test_set_word_spacing_W_param
     @cw.word_spacing 2
-    assert @cw.build_cl.include?('-W 2 '), 'word_spacing param invalid'
+    assert @cw.cl.cl_word_spacing == '-W 2 ', 'word_spacing param invalid'
   end
 
-  def test_build_build_cl_sets_f_param
+  def test_set_freq_f_param
     @cw.frequency 800
-    assert @cw.build_cl.include?('-f 800 '), 'frequency param invalid'
+    assert @cw.cl.cl_frequency == '-f 800 ', 'frequency param invalid'
   end
 
-  def test_build_build_cl_sets_squarewave_param
+  def test_set_squarewave_param
     @cw.set_tone_type :squarewave
-    assert @cw.build_cl.include?('-T 2 '), 'squarewave param invalid'
+    assert @cw.cl.cl_squarewave == '-T 2 ', 'squarewave param invalid'
   end
 
-  def test_build_build_cl_sets_sawtooth_param
+  def test_set_sawtooth_param
     @cw.set_tone_type :sawtooth
-    assert @cw.build_cl.include?('-T 1 '), 'sawtooth param invalid'
+    assert @cw.cl.cl_sawtooth == '-T 1 ', 'sawtooth param invalid'
   end
 
-  def test_build_build_cl_sets_sinewave_param
+  def test_set_sinewave_param
     @cw.set_tone_type :sinewave
-    assert @cw.build_cl.include?('-T 0 '), 'sinewave param invalid'
+    assert @cw.cl.cl_sinewave == '-T 0 ', 'sinewave param invalid'
   end
 
   def test_build_build_cl_ignores_invalid_tone_type
     @cw.set_tone_type :sinewave
     @cw.set_tone_type :invalid
-    assert @cw.build_cl.include?('-T 0 '), 'not ignoring invalid tone type'
+    assert @cw.cl.cl_sinewave == '-T 0 ', 'not ignoring invalid tone type'
   end
 
-  def test_build_build_cl_sets_author_param
+  def test_set_author_param
     @cw.author 'some author'
-    assert @cw.build_cl.include?('-a "some author" '), 'author param invalid'
+    assert @cw.cl.cl_author == '-a "some author" ', 'author param invalid'
   end
 
-  def test_build_build_cl_sets_title_param
+  def test_set_title_param
     @cw.title 'some title'
-    assert @cw.build_cl.include?('-t "some title" '), 'title param invalid'
+    assert @cw.cl.cl_title == '-t "some title" ', 'title param invalid'
   end
 
-  def test_build_build_cl_sets_N_param_in_noise_mode
+  def test_set_N_param_in_noise_mode
     @cw.noise
-    assert @cw.build_cl.include?('-N 5 '), 'noise N param invalid'
+    assert @cw.cl.cl_noise.include?('-N 5 '), 'noise N param invalid'
   end
 
-  def test_build_build_cl_sets_B_param_in_noise_mode
+  def test_set_B_param_in_noise_mode
     @cw.noise
-    assert @cw.build_cl.include?('-B 1000 '), 'noise B param invalid'
+    assert @cw.cl.cl_noise.include?('-B 1000 '), 'noise B param invalid'
   end
 
-  def test_build_build_cl_sets_default_mp3_filename
-    assert @cw.build_cl.include?('-o "mp3_output" '), 'default mp3 filename invalid'
+  def test_set_default_filename
+    assert @cw.cl.cl_audio_filename.include?('audio_output.wav'), 'default audio output filename invalid'
   end
 
-  def test_build_build_cl_sets_mp3_filename_to_given_name
-    @cw.mp3_filename 'some name'
-    assert @cw.build_cl.include?('-o "some name" '), 'default mp3 filename invalid'
+  def test_set_audio_filename_to_given_name
+    @cw.audio_filename('some name')
+    assert @cw.cl.cl_audio_filename.include?("some name"), 'default audio filename invalid'
   end
 
-#  def test_build_build_cl_sets_mp3_filename_to_name_prefix
-#    cl = Cl.new(mp3_filename: "some name")
-#    cw = CW.new do
-#      name 'some name'
-#      no_run
-#    end
-#    assert cw.build_build_cl.include?('-o "some name" '), 'prefix mp3 filename invalid'
-#  end
-
-  def test_build_build_cl_sets_q_param_when_numeric_quality
+  def test_set_q_param_when_numeric_quality
     @cw.quality 5
-    assert @cw.build_cl.include?('-q 5 '), 'mp3 quality invalid'
+    assert @cw.cl.cl_quality.include?('-q 5 '), 'audio quality invalid'
   end
 
-  def test_build_build_cl_sets_low_quality
+  def test_set_low_quality
     @cw.quality :low
-    assert @cw.build_cl.include?('-q 9 '), 'mp3 low quality invalid'
+    assert @cw.cl.cl_quality.include?('-q 9 '), 'audio low quality invalid'
   end
 
-  def test_build_build_cl_sets_medium_quality
+  def test_set_medium_quality
     @cw.quality :medium
-    assert @cw.build_cl.include?('-q 5 '), 'mp3 medium quality invalid'
+    assert @cw.cl.cl_quality.include?('-q 5 '), 'audio medium quality invalid'
   end
 
-  def test_build_build_cl_sets_high_quality
+  def test_set_high_quality
     @cw.quality :high
-    assert @cw.build_cl.include?('-q 1 '), 'mp3 high quality invalid'
+    assert @cw.cl.cl_quality.include?('-q 1 '), 'audio high quality invalid'
   end
 
   def test_build_command_includes_custom_commands_via_build_cl
     @cw.command_line '-x "some custom command"'
-    assert @cw.build_cl.include?( '-x "some custom command"'), 'custom command invalid'
+    assert @cw.cl.cl_command_line.include?( '-x "some custom command"'), 'custom command invalid'
   end
 
   def test_cl_echo_returns_correct_string
     str = ''
     CW.new do
-      str = @cl.cl_echo ['some','words']
+      str = @cl.cl_echo('some words')
       pause
     end
-    assert_equal 'echo some words | ebook2cw -w 25 -o "mp3_output" ', str
+    assert str.include?('echo some words | ebook2cw -w 25')
   end
 
   def test_words_exist
     temp = nil
     CW.new do
-      assign_words 'some words'
-      temp = @words.exist?
+      words = 'some words added here'
+      temp = words
+      pause
+    end
+    assert_equal(4, temp.split.size)
+    CW.new do
+      @words.add 'a couple of words'
+      temp = words
       pause
     end
-    assert temp, "Words#exist? should be true"
+    assert_equal(4, temp.split.size)
     CW.new do
       @words.add nil
-      temp = @words.exist?
+      temp = words
       pause
     end
-    refute temp, "Words#exist? should be nil"
+    assert_nil(temp)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cw
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Martyn Jago
@@ -9,7 +9,133 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2016-05-21 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: wavefile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: feedjira
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: htmlentities
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sanitize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A ruby library to help learn and practice morse code
 email:
 - martyn.jago@btinternet.com