feep 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad44164b261eb318f20f3e1fc3c44528f5f18552
-  data.tar.gz: 3f0905a2d7fc561454920e73d911d20f15cc25d5
+  metadata.gz: e87c34f7d21c5d23b2669158b25ce0fc0fd1bf60
+  data.tar.gz: edf55481d50da651ffd4d48e907ba1e8e310660a
 SHA512:
-  metadata.gz: af5021622f750a39e7609645ff117bcf30bbd85d0d63b88cc956fab9b6cce185522f74a92588e0ac898b81f1a24a2a766ce71fc14ac66900d0a036cdcf5a62e0
-  data.tar.gz: a8c86f5474b26d368d1dd633749d5f9416969ecbf2bd109c2566e8c099601bc51a609c2437bbbb86afbc0b6a0a68bce1336a5515af2709fcfce9305e10bf2b56
+  metadata.gz: cb7e7b72212d937917828282e0523133e9b1ef38d61d6c47e42a3b860a9d9270444ebc5ec08483e547cc84e8532277ca0b8a6e2617ac56771722bed82c13236c
+  data.tar.gz: 985dab8e5d8b3e4aafd0547bfeeddaaed048448f0d50b5f18c85f5eda8aa2e33a5bd8f6fd873790a675444805811991641daf4c6c3e703b83aa298950e9c0cdb

data/README.md

@@ -2,9 +2,9 @@
 [![Gem Version](https://badge.fury.io/rb/feep.svg)](http://badge.fury.io/rb/feep)
 
 ## Wha?
-Use the power of Ruby gems to make your computer [feep](http://dictionary.reference.com/browse/feep) (except more musically) using sweet [WAV-file-writing technology](http://wavefilegem.com) from [Joel Strait](https://github.com/jstrait). Works on both Windows and *nix (including OS X) as it uses the standard WAV format to do its bidding.
+Use the power of Ruby gems to make your computer [feep](http://dictionary.reference.com/browse/feep) (except more musically) using sweet [WAV-file-writing technology](http://wavefilegem.com) from [Joel Strait](https://github.com/jstrait). Works on both Windows and \*nix (including OS X) as it uses the standard WAV format to do its bidding.
 
-_Note:_ In order for the sound-playing magic to work on Windows, you will need [sounder](http://www.elifulkerson.com/projects/commandline-wav-player.php), a free command-line WAV file player on your system and in your path. Mac and *nix uses `afplay`, which should be built-in, but feel free to change either to something you already have or desire to install.
+_Note:_ In order for the sound-playing magic to work on Windows, you will need [sounder](http://www.elifulkerson.com/projects/commandline-wav-player.php), a free command-line WAV file player on your system and in your path. Mac and \*nix uses `afplay`, which should be built-in, but feel free to change either to something you already have or desire to install.
 
 ## Why?
 
@@ -18,7 +18,7 @@ Feep doesn't require any parameters, as it will play a 440Hz/A4 sine wave at 50%
 
 The full usage looks like this:
 
-`feep [-f, --frequency FREQUENCY] [-n, --note NOTE_NAME] [-s, --scale SCALE_ID] [--degrees SCALE_DEGREES] [-w, --waveform WAVEFORM_ID] [-a, --amplitude MAX_AMPLITUDE] [-d, --duration DURATION] [--save] [--loud]`
+`feep [-f, --frequency FREQUENCY] [-n, --note NOTE_NAME] [-s, --scale SCALE_ID] [--degrees SCALE_DEGREES] [-w, --waveform WAVEFORM_ID] [-a, --amplitude MAX_AMPLITUDE] [-d, --duration DURATION] [--save] [--verbose] [--visual_cue]`
 
 `-f, --frequency, -n, --note`: a number from 0 to 20000, or a valid note name from C0 to B9 (including sharps and flats). Both `-f|--frequency` and `-n|--note` parameters can take either kind; they're both supported mainly for ease of use. You can try a frequency outside of this range, but you may get odd results. You may also enter some combination of these with commas between them and it'll play all of them together in a chord.
 
@@ -34,7 +34,9 @@ The full usage looks like this:
 
 `--save`: switch to save the resulting WAV file in the current directory. Will create it in the format of `waveform_frequency-in-Hz_volume_duration.wav`.
 
-`--loud`: switch that displays note and file-making information.
+`--verbose`: switch that displays note and file-making information.
+
+`--visual_cue`: switch that display a cute "Feep!" message, the length of which determined by the duration of the feep.
 
 ## Examples
 

data/bin/feep

@@ -13,14 +13,14 @@ def parse_options
     :volume => 0.5,
     :duration => 100,
     :save => false,
-    :loud => false,
-    :notext => false,
+    :verbose => false,
+    :visual_cue => false,
     :usage => nil
   }
 
   optparse = OptionParser.new do |opts|
     opts.banner = "Play sounds on the command line\n"
-    opts.banner += "usage: feep [-f, -n, --frequency, --note FREQUENCY|NOTE_NAME] [-s, --scale SCALE_ID] [-sd, --degrees NUMBER_OF_SCALE_DEGREES] [-w, --waveform WAVEFORM_ID] [-a, --amplitude MAX_AMPLITUDE] [-d, --duration DURATION] [--save] [--loud] [--notext]\n\n"
+    opts.banner += "usage: feep [-f, -n, --frequency, --note FREQUENCY|NOTE_NAME] [-s, --scale SCALE_ID] [-sd, --degrees NUMBER_OF_SCALE_DEGREES] [-w, --waveform WAVEFORM_ID] [-a, --amplitude MAX_AMPLITUDE] [-d, --duration DURATION] [--save] [--verbose] [--visual_cue]\n\n"
 
     opts.on('-f', '--frequency FREQUENCY', 'One or more frequencies or to play at once, e.g. 440 or 220,440,880') do |frequency|
       options[:freq_or_note] = frequency
@@ -54,12 +54,12 @@ def parse_options
       options[:save] = true
     end
 
-    opts.on('--loud', 'Displays information about note(s) being played') do
-      options[:loud] = true
+    opts.on('--verbose', 'Displays information about note(s) being played') do
+      options[:verbose] = true
     end
 
-    opts.on('--notext', 'No "Feeep!" text on play') do
-      options[:notext] = true
+    opts.on('--visual_cue', 'Display "Feeep!" text on play') do
+      options[:visual_cue] = true
     end
 
     opts.on('-v', '--version', 'Display version number and exit') do

data/lib/feep/scale.rb

@@ -27,18 +27,18 @@ module Feep
           :volume => options[:volume], 
           :duration => options[:duration], 
           :save => options[:save], 
-          :loud => options[:loud]
+          :verbose => options[:verbose]
         }
 
         # play number of degrees of scale supplied or one octave by default
         degrees = options[:degrees] || steps.length
 
-        if options[:loud]
+        if options[:verbose]
           puts "Playing a #{options[:scale]} scale..."
         end
 
         1.upto(degrees.to_i) {|deg|
-          if options[:loud]
+          if options[:verbose]
             puts "note: #{NOTE_FREQ.key(freq)}, freq: #{freq}"
           end
           

data/lib/feep/sound_player.rb

@@ -7,22 +7,22 @@ module Feep
   
     # main function that creates, plays, and removes note
     def play_note(frequency, output_filename, samples_to_write, options)
-      if options[:loud]
+      if options[:verbose]
         puts 'Playing note'
         puts "  frequency:    #{frequency.to_f.abs}"
         puts "  midi:         #{Utils.freq_to_midi(frequency)}"
         puts "  duration:     #{options[:duration]}"
       end
       SoundFile.new.create_sound(frequency, samples_to_write, output_filename, options)
-      play_wav_file(output_filename, options[:duration], options[:notext])
+      play_wav_file(output_filename, options[:duration], options[:visual_cue])
       remove_sound(output_filename, options)
     end
   
     # use command line app to play wav file
-    def play_wav_file(file, duration, notext)
+    def play_wav_file(file, duration, visual_cue)
       if OS.windows?
         if command_exists?(SNDPLAYER_WIN)
-          display_text_beep(duration) unless notext
+          display_text_beep(duration) if visual_cue
           system("#{SNDPLAYER_WIN} #{file}")
         else
           puts "couldn't find #{SNDPLAYER_WIN}"
@@ -31,7 +31,7 @@ module Feep
 
       if OS.mac? || OS.linux?
         if command_exists?(SNDPLAYER_UNIX)
-          display_text_beep(duration) unless notext
+          display_text_beep(duration) if visual_cue
           system("#{SNDPLAYER_UNIX} #{file}")
         else
           puts "couldn't find #{SNDPLAYER_UNIX}"
@@ -50,7 +50,7 @@ module Feep
       puts 'ep!'
     end
 
-    # removes the sound, unless marked to save, 
+    # removes the sound, unless marked to save,
     # and optionally display info about file
     def remove_sound(file, options)
       unless options[:save]
@@ -60,7 +60,7 @@ module Feep
           system("rm #{file}")
         end
       else
-        if options[:loud]
+        if options[:verbose]
           info = WaveFile::Reader.info(file)
           duration = info.duration
           formatted_duration = duration.minutes.to_s.rjust(2, '0') << ':' <<

data/lib/feep/version.rb

@@ -1,3 +1,3 @@
 module Feep
-  VERSION = '0.1.4'
+  VERSION = '0.2.0'
 end

data/spec/feep_spec.rb

@@ -10,7 +10,7 @@ describe Feep do
       :volume => 0.5, 
       :duration => 100, 
       :save => false, 
-      :loud => false, 
+      :verbose => false, 
       :usage => nil
     }
   

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feep
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Michael Chadwick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-23 00:00:00.000000000 Z
+date: 2017-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wavefile
@@ -159,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Make your computer feep with Ruby