beep 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.swp

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in beep.gemspec
+gemspec
+gem "rspec"

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2011 Rory McKinley
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.rdoc

@@ -0,0 +1,48 @@
+= beep
+
+Currently, beep is a very simple wrapper around the beep utility of Linux. It handles a small subset of the functionality provided by the utility.
+
+== Installing beep
+
+Install beep (the utility) using your package management  app of choice. If you type in `beep` at the command prompt, you should be rewarded with, well, pretty much just a beep.
+Note: In some recent Ubuntu versions, the pcspkr module is blacklisted, so you will need to comment out the relevant line in /etc/modprobe.d/blacklistif you want the pcspkr permanently enabled (it can be quite annoying) or manually load it using `sudo modprobe pcspkr`
+
+And then, install the gem.
+
+  gem install beep
+
+== Usage
+
+In your Ruby code:
+
+  require 'beep'
+
+=== Issuing the default beep
+
+  Beep::Sound.generate 
+
+=== Passing through a sequence of beeps
+
+  sounds = [
+    {:frequency => 100, :duration => 200, :pause => 300},
+    {:frequency => 400, :duration => 500, :pause => 600},
+    {:frequency => 700, :duration => 800, :pause => 900},
+  ]
+
+  Beep::Sound.generate(sounds)
+
+The duration and pause sounds are in milliseconds. Frequency is in MHz.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2011 Rory McKinley. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = ['--color']
+end

data/beep.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "beep/version"
+
+Gem::Specification.new do |s|
+  s.name        = "beep"
+  s.version     = Beep::VERSION
+  s.authors     = ["Rory McKinley"]
+  s.email       = ["rorymckinley@gmail.com"]
+  s.homepage    = "https://github.com/rorymckinley/beep"
+  s.summary     = %q{A small gem to manipulate the Linux beep utility}
+  s.description = %q{This gem provides a very simple wrapper around the Linux beep utility}
+
+  s.rubyforge_project = "beep"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/beep.rb

@@ -0,0 +1,6 @@
+require "beep/version"
+require "beep/sound"
+
+module Beep
+  # Your code goes here...
+end

data/lib/beep/sound.rb

@@ -0,0 +1,25 @@
+module Beep
+  class Sound
+    def self.generate(instructions=[])
+      basic_command = 'beep%s' % create_arguments(instructions)
+      system(basic_command)
+    end
+
+    private
+
+    def self.create_arguments(instructions)
+      instructions_to_args = {
+        :frequency => ' -f %s', 
+        :duration => ' -l %s',
+        :pause => ' -D %s'
+      }
+      (instructions.map do |instruction|
+        arguments = ''
+        instruction.each do |name,value|
+          arguments += instructions_to_args[name] % value
+        end
+        arguments
+      end).join(" -n")
+    end
+  end
+end

data/lib/beep/version.rb

@@ -0,0 +1,3 @@
+module Beep
+  VERSION = "0.0.1"
+end

data/spec/beep/sound_spec.rb

@@ -0,0 +1,29 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Beep::Sound do
+  it "should be able to call the default beep command without arguments" do
+    Beep::Sound.should_receive(:system).with('beep')
+    Beep::Sound.generate
+  end
+  it "should allow a beep to be generated with a given frequency" do
+    Beep::Sound.should_receive(:system).with('beep -f 100')
+    Beep::Sound.generate([{:frequency => 100}])
+  end
+  it "should allow a beep to be generated with a given duration in milliseconds" do
+    Beep::Sound.should_receive(:system).with('beep -l 1000')
+    Beep::Sound.generate([{:duration => 1000}])
+  end
+  it "should allow a beep to be generated with a given pause after the beep" do
+    Beep::Sound.should_receive(:system).with('beep -D 1000')
+    Beep::Sound.generate([{:pause => 1000}])
+  end
+  it "should be able to handle multiple beeps with a single command" do
+    sounds = [
+      {:frequency => 100, :duration => 200, :pause => 300},
+      {:frequency => 400, :duration => 500, :pause => 600},
+      {:frequency => 700, :duration => 800, :pause => 900},
+    ]
+    Beep::Sound.should_receive(:system).with('beep -f 100 -l 200 -D 300 -n -f 400 -l 500 -D 600 -n -f 700 -l 800 -D 900')
+    Beep::Sound.generate(sounds)
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'beep'
+require 'rspec'
+

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: beep
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Rory McKinley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-02 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: This gem provides a very simple wrapper around the Linux beep utility
+email: 
+- rorymckinley@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- beep.gemspec
+- lib/beep.rb
+- lib/beep/sound.rb
+- lib/beep/version.rb
+- spec/beep/sound_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/rorymckinley/beep
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: beep
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A small gem to manipulate the Linux beep utility
+test_files: []
+