feep 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e59eb850a3b66b00df0a1f7e42523e7f1d7f6974
-  data.tar.gz: e032678907f285574b847199f530cd66a8eaa734
+  metadata.gz: 4c9ade110c0c083ad59f6732c2474d8f0aaabfb3
+  data.tar.gz: ea1319e91994705a44a70a8c0d0124a5e6e9703e
 SHA512:
-  metadata.gz: 69e83b10a38ed0b4a7a3378fe874fc5054b57a4bb8ec38ec02eec736c4fb8a36e3958d2e6973a092f141e32b9300857b7e92f402a3c085a37f2308402c9f5de2
-  data.tar.gz: 545f7debf3dc9801a85a27fdba7f2531d1a682b78a22cf681add3674eda27a80dd3207dabc3c978c4fa4cf716d44e2284ca4cfecde8dd0b72c3ede03c125bcda
+  metadata.gz: 0cf79e2486d896848f42add1472d5eee509f1aa657a3a33099459fac90479ff5f66612c39124693471c3e795c1268ffe784b09ee71233c068d2957236a0c1827
+  data.tar.gz: a9f0d7edf48f2940a3e90f2e46fd45378dce2e46beb062b0cabb523ffb1b7d7d42bb4ad632a9f25a3bb63eeb5fb7129cdec5fab304837dfe3c5e310b98a6279e

data/Gemfile

@@ -1,2 +1,2 @@
 source 'https://rubygems.org'
-gemspec
+gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    feep (0.0.1)
+    feep (0.0.2)
       os (~> 0.9, >= 0.9.6)
       wavefile (= 0.6.0)
 

data/README.md

@@ -7,32 +7,33 @@ _Note:_ In order for the sound-playing magic to work on Windows, you will need [
 
 ## Why?
 
-Besides a quick way to make some kind of noise, which I always appreciate, this could be used to tie into another Ruby script for an alert tone or maybe even some wicked cool command-line game that needs musical note sound effects. The opportunities are essentially endless.
+Besides a quick way to make some kind of noise for fun or testing your speakers, which I always appreciate, `feep` could be used to tie into another Ruby script for an alert tone or maybe even some wicked cool command-line game that needs musical note sound effects. The opportunities are essentially endless.
 
 ## How?
 
-For now:
-1. `git clone git@github.com:michaelchadwick/feep` 
-2. `cd feep` 
-3. `gem build feep.gemspec` 
-4. `gem install feep-0.0.1.gem` 
-5. `bundle install` 
-6. `feep` 
+* `gem install feep`
 
-Feep doesn't require any parameters, as it will play a 440Hz/A4 sine wave at 50% full volume for 1000 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 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.
 
 The full usage looks like this:
 
-`feep [-fn frequency|note_name|comma-delimited_frequencies_or_note_names] [-w waveform] [-v volume] [-d duration] [-save] [-loud]`
+`feep [-f, -n, --freq-or-note FREQUENCY|NOTE_NAME] [-w, --waveform WAVEFORM] [-a, --amplitude MAX_AMPLITUDE] [-d, --duration DURATION] [-save] [-loud]`
 
-`-frequency|note_name|commad-delimted_frequences_or_note_names`: a number from 0 to 20000. You can try something bigger or smaller, but you may get odd results. You may also enter any note name from C0 to B9 (or even flats and sharps like C#6 or Eb5). You may also also enter some combination of these with commas between them and it'll play all of them together in a chord.
+`-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.
 
-`-waveform`: a string equal to "sine", "square", "saw", "triangle", or "noise".
+`-w, --waveform`: a string equal to "sine", "square", "saw", "triangle", or "noise".
 
-`-volume`: a number from 0.0 (silence (why would you do this?)) to 1.0 (blast it)
+`-a, --amplitude`: a number from 0.0 (silence (why would you do this?)) to 1.0 (blast it)
 
-`-duration`: number of milliseconds for the sound to last
+`-d, --duration`: number of milliseconds for the sound to last
 
-`-save`: 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`: 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 -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

data/Rakefile

@@ -1,3 +1,3 @@
 require "bundler/gem_tasks"
 
-Dir.glob('tasks/**/*.rake').each(&method(:import))
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/bin/feep

@@ -6,16 +6,16 @@ require 'feep'
 USAGE_INSTRUCTIONS = ''
 
 def parse_options
-  options = {:freq_or_note => '440.000', :waveform => 'sine', :volume => 0.5, :duration => 1000, :save => false, :loud => false}
+  options = {:freq_or_note => '440.000', :waveform => 'sine', :volume => 0.5, :duration => 200, :save => false, :loud => false}
 
   optparse = OptionParser.new do |opts|
-    opts.banner = 'usage: feep [frequency|note_name|list_of_frequencies_or_note_names] [waveform] [volume] [duration] [save] [-loud]'
+    opts.banner = 'usage: feep [-f, -n, --freq-or-note FREQUENCY|NOTE_NAME] [-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('-w', '--wave WAVE_FORM_NAME', 'Waveform type to use for the sound') do |w|
+    opts.on('-w', '--wave WAVEFORM', 'Waveform type to use for the sound') do |w|
       options[:waveform] = w
     end
 
@@ -36,11 +36,11 @@ def parse_options
     end
 
     opts.on('-v', '--version', 'Display version number and exit') do
-      puts "#{$0} #{Feep::VERSION}"
+      puts "#{$PROGRAM_NAME} #{Feep::VERSION}"
       exit
     end
 
-    opts.on( '-h', '--help', 'Display this screen and exit') do
+    opts.on('-h', '--help', 'Display this screen and exit') do
       puts opts
       exit
     end
@@ -55,19 +55,19 @@ end
 def print_error(error)
   case error
   when OptionParser::InvalidOption
-    puts "feep: illegal option #{error.args.join(' ')}"
+    puts "#{$PROGRAM_NAME}: illegal option #{error.args.join(' ')}"
     puts USAGE_INSTRUCTIONS
   else
-    puts 'An unexpected error occurred while running Feep:'
+    puts "An unexpected error occurred while running #{$PROGRAM_NAME}:"
     puts "  #{error}\n"
   end
 end
 
 begin
-  options = parse_options()
+  options = parse_options
 
   Feep.new(options)
 rescue => error
   print_error(error)
   exit(false)
-end
+end

data/feep.gemspec

@@ -1,29 +1,29 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "feep/version"
+require 'feep/version'
 
 Gem::Specification.new do |spec|
   spec.name            = 'feep'
   spec.version         = Feep::VERSION
   spec.platform        = Gem::Platform::RUBY
-  spec.authors         = ["Michael Chadwick"]
+  spec.authors         = ['Michael Chadwick']
   spec.email           = 'mike@codana.me'
-  spec.homepage        = "http://rubygemspec.org/gems/feep"
-  spec.summary         = %q{Make your computer feep with Ruby}
-  spec.description     = %q{Use Ruby to make your computer beep at a certain frequency for a certain duration. Do it for fun, or add it to other programs for easy alert sounds.}
+  spec.homepage        = 'http://rubygems.org/gems/feep'
+  spec.summary         = 'Make your computer feep with Ruby'
+  spec.description     = 'Use Ruby to make your computer beep at a certain frequency for a certain duration. Do it for fun, or add it to other programs for easy alert sounds.'
 
   spec.files           = `git ls-files`.split("\n")
   spec.test_files      = `git ls-files -- {test,spec,features}/*`.split("\n")
-  spec.executables     = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  spec.require_paths   = ["lib"]
+  spec.executables     = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  spec.require_paths   = ['lib']
   spec.license         = 'MIT'
-  
+
   spec.add_runtime_dependency 'wavefile', '= 0.6.0'
   spec.add_runtime_dependency 'os', '~> 0.9', '>= 0.9.6'
-  
+
   spec.add_development_dependency 'pry-byebug', '~> 3.0'
   spec.add_development_dependency 'bundler', '~> 1.8'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '>= 3.0'
-end
+end

data/lib/feep.rb

@@ -12,19 +12,19 @@ class Feep
   
   # convert midi notes to frequencies
   def midi_to_freq(midi_note)
-    return 440.0 * (2.0 ** ((midi_note.to_f-69)/12))
+    440.0 * (2.0 ** ((midi_note.to_f-69)/12))
   end
 
   # convert frequencies to midi notes
   def freq_to_midi(freq)
-    return (69 + 12 * (Math.log2(freq.to_i.abs / 440.0))).round
+    (69 + 12 * (Math.log2(freq.to_i.abs / 440.0))).round
   end
 
   # makes sure that whatever kind of sound was entered on the CLI
   # it is now a frequency to feed into the sample data generator
   def convert_note_to_freq(freq_or_note)
     if freq_or_note.match(/[A-Za-z]/)
-      if NOTE_FREQ.has_key?(freq_or_note)
+      if NOTE_FREQ.key?(freq_or_note)
         frequency = NOTE_FREQ[freq_or_note]
       else
         app_error(ERROR_MSG[:note_name])
@@ -58,7 +58,7 @@ class Feep
       threads = []
       options[:freq_or_note].split(',').each do |note|
         sound_to_play = convert_note_to_freq(note)
-        output_filename = "#{options[:waveform]}_#{sound_to_play}Hz_#{options[:volume].to_f}_#{options[:duration].to_s}.wav"
+        output_filename = "#{options[:waveform]}_#{sound_to_play}Hz_#{options[:volume].to_f}_#{options[:duration]}.wav"
         threads << Thread.new {
           play_note(sound_to_play.to_f, options[:waveform], options[:volume].to_f, options[:duration].to_i, samples_to_write, output_filename) 
         }
@@ -67,7 +67,7 @@ class Feep
     else
       # no, it's a single note
       sound_to_play = convert_note_to_freq(options[:freq_or_note])
-      output_filename = "#{options[:waveform]}_#{sound_to_play}Hz_#{options[:volume].to_f}_#{options[:duration].to_s}.wav"
+      output_filename = "#{options[:waveform]}_#{sound_to_play}Hz_#{options[:volume].to_f}_#{options[:duration]}.wav"
       play_note(sound_to_play, options[:waveform], options[:volume].to_f, options[:duration].to_i, samples_to_write, output_filename)
     end
   end
@@ -76,7 +76,7 @@ class Feep
   def play_sound(file, duration)
     delimiter = OS.windows? ? ';' : ':'
 
-    system_apps = ENV['PATH'].split(delimiter).collect {|d| Dir.entries d if Dir.exists? d}.flatten
+    system_apps = ENV['PATH'].split(delimiter).collect { |d| Dir.entries d if Dir.exist? d }.flatten
 
     if OS.windows?
       if system_apps.include? SNDPLAYER_WIN
@@ -123,9 +123,9 @@ class Feep
         formatted_duration = duration.minutes.to_s.rjust(2, '0') << ':' <<
                            duration.seconds.to_s.rjust(2, '0') << ':' <<
                            duration.milliseconds.to_s.rjust(3, '0')
-        puts ""
+        puts ''
         puts "Created #{file}"
-        puts "---"
+        puts '---'
         puts "Length:      #{formatted_duration}"
         puts "Format:      #{info.audio_format}"
         puts "Channels:    #{info.channels}"
@@ -205,9 +205,9 @@ class Feep
 
   # displays error, usage, and exits
   def app_error(msg)
-    puts "#{File.basename($0).split(".")[0]}: #{msg}"
+    puts "#{File.basename($PROGRAM_NAME).split('.')[0]}: #{msg}"
     puts 'usage: feep [frequency|note_name|list_of_frequencies_or_note_names] [sine|square|saw|triangle|noise] [volume] [duration] [save]'
     exit
   end
 
-end
+end

data/lib/feep/constants.rb

@@ -183,4 +183,4 @@ class Feep
     :note_name => 'Note name argument is invalid.',
     :wave_form => 'Wave form type is invalid.'
   ]
-end
+end

data/lib/feep/version.rb

@@ -1,3 +1,3 @@
 class Feep
-  VERSION = "0.0.1"
+  VERSION = '0.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feep
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Michael Chadwick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-03 00:00:00.000000000 Z
+date: 2015-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wavefile
@@ -121,7 +121,7 @@ files:
 - spec/feep_spec.rb
 - spec/spec_helper.rb
 - tasks/rspec.rake
-homepage: http://rubygemspec.org/gems/feep
+homepage: http://rubygems.org/gems/feep
 licenses:
 - MIT
 metadata: {}
@@ -141,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Make your computer feep with Ruby