feep 0.0.6 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f430501b6debcb58be0850a447ee61b16d4852c0
-  data.tar.gz: 5825fb85483442fc7139ba75d4ccc9eb3d08ed53
+  metadata.gz: 3fbfa4b1a2f1ad90c662578b40edd7bbf4b7730a
+  data.tar.gz: 618b77c63ea478dbb25da2d7f434bb6756ff8c0a
 SHA512:
-  metadata.gz: 676926fc0c7627b599b358a338d4c6a745fc60bb2f126c0cb08ba4c13ef32619cc5aa4faa7624d083635cfb29db99ed120801e1d0fb44c4f103aa3fd63918dba
-  data.tar.gz: 4dff04f0fdb00e2a93f9f7e8798802bd3d8d729d3cc2c14e1f0c0315cce7c728b8234d778d33218af83b35f2c55303d962c753fa1da8c6eb9692c93e00339c15
+  metadata.gz: f6bf0d4aef97bc23668c7ba56de50be3bab94bee3e848ebe3ab124b25e395010e5bccd06570ed154003292ada9881f8b0457854043c35df3c0c3335e619f74f9
+  data.tar.gz: 9a12ac8131c8957682042f3af6ff30ff0ccd6a1568accf43d3cfc3ce1f387330217e2bb60008e7b82d4cb18b3f44343491e21c03c48eefc53e65f12dd4f1f946

data/README.md

@@ -14,17 +14,17 @@ Besides a quick way to make some kind of noise for fun or testing your speakers,
 
 * `gem install feep`
 
-Feep doesn't require any parameters, as it will play a 440Hz/A4 sine wave at 50% full volume for 200 milliseconds unless you supply one of the below options. Feep will only save the resulting WAV file it creates if you specify the `-save` parameter.
+Feep doesn't require any parameters, as it will play a 440Hz/A4 sine wave at 50% full volume for 100 milliseconds unless you supply one of the below options. Feep will only save the resulting WAV file(s) it creates if you specify the `--save` parameter.
 
 The full usage looks like this:
 
-`feep [-f, -n, --freq-or-note FREQUENCY|NOTE_NAME] [-s, --scale SCALE_ID] [-d, --degrees NUMBER_OF_SCALE_DEGREES] [-w, --waveform WAVEFORM] [-a, --amplitude MAX_AMPLITUDE] [-d, --duration DURATION] [-save] [-loud]`
+`feep [-f, -n, --freq-or-note FREQUENCY|NOTE_NAME] [-s, --scale SCALE_ID] [-sd, --degrees SCALE_DEGREES] [-w, --waveform WAVEFORM_ID] [-a, --amplitude MAX_AMPLITUDE] [-d, --duration DURATION] [--save] [--loud]`
 
 `-f, -n, --freq-or-note`: a number from 0 to 20000, or a valid note name from C0 to B9 (including sharps and flats). 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.
 
-`-s, -scale`: a scale ID that is part of the list that the gem understands (currently). If you put in an invalid one, it will list the valid ones.
+`-s, -scale`: a scale ID that is part of the list that the gem understands. If you put in an invalid one, it will list the valid ones.
 
-`-d, --degrees`: the number of degrees of a scale you want to play. By default, the scale will play one octave.
+`-sd, --degrees`: the number of degrees of a scale you want to play. By default, the scale will play one octave.
 
 `-w, --waveform`: a string equal to "sine", "square", "saw", "triangle", or "noise".
 
@@ -32,14 +32,15 @@ The full usage looks like this:
 
 `-d, --duration`: number of milliseconds for the sound to last.
 
-`-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`.
+`--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.
+`--loud`: switch that displays note and file-making information.
 
 ## Examples
 
-* `feep` - play a C4 sine wave note at 50% full volume for 200 ms
+* `feep` - play a C4 sine wave note at 50% full volume for 100 ms
 * `feep -n Ab6 -w saw` - play a Ab6 sawtooth wave note at 50% full volume for 200 ms
 * `feep -n C#5 -w square -a 0.4 -d 500` - play a C#5 square wave note at 40% full volume for 500 ms
 * `feep -n 2000 -w triangle -a 0.8 -d 2000` - play a 2000Hz triangle wave note at 80% full volume for 2000 ms
 * `feep -n C3 -s major` - play a major scale with C3 as the root note
+* `feep -n D#5 -s whole_note -d 20` - play 20 degrees of a whole note scale with D#5 as the root note

data/bin/feep

@@ -1,78 +1,79 @@
-#!/usr/bin/env ruby
-
-require 'optparse'
-require_relative '../lib/feep'
-
-def parse_options
-  options = {:freq_or_note => '440.000', :scale => nil, :waveform => 'sine', :volume => 0.5, :duration => 100, :save => false, :loud => false, :usage => nil}
-
-  optparse = OptionParser.new do |opts|
-    opts.banner = 'usage: feep [-f, -n, --freq-or-note FREQUENCY|NOTE_NAME] [-s, --scale SCALE_ID] [-d, --degrees NUMBER_OF_SCALE_DEGREES] [-w, --waveform WAVEFORM] [-a, --amplitude MAX_AMPLITUDE] [-d, --duration DURATION] [-save] [-loud]'
-
-    opts.on('-f', '-n', '--freq-or-note FREQUENCY|NOTE_NAME', 'One or more frequencies or note names to play at once, e.g. 440 or A4 or 220,440,880') do |f_or_n|
-      options[:freq_or_note] = f_or_n
-    end
-    
-    opts.on('-s', '--scale SCALE_ID', 'Name of a scale to play') do |s|
-      options[:scale] = s
-    end
-    
-    opts.on('-d', '--degrees NUMBER_OF_DEGREES', 'Number of degrees of the scale to play') do |d|
-      options[:degrees] = d
-    end
-    
-    opts.on('-w', '--wave WAVEFORM', 'Waveform type to use for the sound') do |w|
-      options[:waveform] = w
-    end
-
-    opts.on('-a', '--amplitude MAX_AMPLITUDE', 'Amplitude/volume (0.0 - 1.0) to play the sound(s) at') do |a|
-      options[:volume] = a.to_f
-    end
-    
-    opts.on('-d', '--duration DURATION', 'Duration in ms to play the sound(s)') do |d|
-      options[:duration] = d.to_i
-    end
-
-    opts.on('--save', 'Save the resulting WAV file in the current directory') do
-      options[:save] = true
-    end
-    
-    opts.on('--loud', 'Displays information about note(s) being played') do
-      options[:loud] = true
-    end
-
-    opts.on('-v', '--version', 'Display version number and exit') do
-      puts "#{$PROGRAM_NAME} #{Feep::VERSION}"
-      exit
-    end
-
-    opts.on('-h', '--help', 'Display this screen and exit') do
-      puts opts
-      exit
-    end
-  end
-
-  options[:usage] = optparse.to_s
-  optparse.parse!()
-
-  return options
-end
-
-def print_error(error)
-  case error
-  when OptionParser::InvalidOption
-    puts "#{$PROGRAM_NAME}: illegal option #{error.args.join(' ')}"
-  else
-    puts "An unexpected error occurred while running #{$PROGRAM_NAME}:"
-    puts "  #{error}\n"
-  end
-end
-
-begin
-  options = parse_options
-
-  Feep::Base.new(options)
-rescue => error
-  print_error(error)
-  exit(false)
-end
+#!/usr/bin/env ruby
+
+require 'optparse'
+require_relative '../lib/feep'
+require_relative '../lib/feep/version'
+
+def parse_options
+  options = {:freq_or_note => '440.000', :scale => nil, :waveform => 'sine', :volume => 0.5, :duration => 100, :save => false, :loud => false, :usage => nil}
+
+  optparse = OptionParser.new do |opts|
+    opts.banner = 'usage: feep [-f, -n, --freq-or-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]'
+
+    opts.on('-f', '-n', '--freq-or-note FREQUENCY|NOTE_NAME', 'One or more frequencies or note names to play at once, e.g. 440 or A4 or 220,440,880') do |f_or_n|
+      options[:freq_or_note] = f_or_n
+    end
+    
+    opts.on('-s', '--scale SCALE_ID', 'Name of a scale to play') do |s|
+      options[:scale] = s
+    end
+    
+    opts.on('-sd', '--degrees SCALE_DEGREES', 'Number of degrees of the scale to play') do |sd|
+      options[:degrees] = sd
+    end
+    
+    opts.on('-w', '--waveform WAVEFORM', 'Waveform type to use for the sound') do |w|
+      options[:waveform] = w
+    end
+
+    opts.on('-a', '--amplitude MAX_AMPLITUDE', 'Amplitude/volume (0.0 - 1.0) to play the sound(s) at') do |a|
+      options[:volume] = a.to_f
+    end
+    
+    opts.on('-d', '--duration DURATION', 'Duration in ms to play the sound(s)') do |d|
+      options[:duration] = d.to_i
+    end
+
+    opts.on('--save', 'Save the resulting WAV file in the current directory') do
+      options[:save] = true
+    end
+    
+    opts.on('--loud', 'Displays information about note(s) being played') do
+      options[:loud] = true
+    end
+
+    opts.on('-v', '--version', 'Display version number and exit') do
+      puts "feep #{Feep::VERSION}"
+      exit
+    end
+
+    opts.on('-h', '--help', 'Display this screen and exit') do
+      puts opts
+      exit
+    end
+  end
+
+  options[:usage] = optparse.to_s
+  optparse.parse!()
+
+  return options
+end
+
+def print_error(error)
+  case error
+  when OptionParser::InvalidOption
+    puts "#{$PROGRAM_NAME}: illegal option #{error.args.join(' ')}"
+  else
+    puts "An unexpected error occurred while running #{$PROGRAM_NAME}:"
+    puts "  #{error}\n"
+  end
+end
+
+begin
+  options = parse_options
+
+  Feep::Base.new(options)
+rescue => error
+  print_error(error)
+  exit(false)
+end

data/lib/feep/constants.rb

@@ -250,7 +250,7 @@ module Feep
   ERROR_MSG = Hash[
     :invalid_note => 'Note name argument is invalid.',
     :invalid_scale => "Scale ID is invalid. Valid IDs are: #{SCALES.keys}",
-    :invalid_waveform => 'Wave form type is invalid.',
+    :invalid_waveform => "Waveform type is invalid. Valid waveform types are: #{WAVE_TYPES}",
     :scale_needs_note => 'You need to enter a valid note (-n) if you want to play a scale.'
   ]
 end

data/lib/feep/version.rb

@@ -1,3 +1,3 @@
-class Feep
-  VERSION = '0.0.6'
+module Feep
+  VERSION = '0.0.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feep
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.8
 platform: ruby
 authors:
 - Michael Chadwick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-18 00:00:00.000000000 Z
+date: 2015-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wavefile
@@ -163,4 +163,7 @@ rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Make your computer feep with Ruby
-test_files: []
+test_files:
+- spec/feep_spec.rb
+- spec/spec_helper.rb
+has_rdoc: