vail 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

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

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem "beep", "~> 0.0.1"
+gem "trollop"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,32 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    beep (0.0.1)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.1)
+    rcov (0.9.9)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.3)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    trollop (1.16.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  beep (~> 0.0.1)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.2)
+  rcov
+  rspec (~> 2.6.0)
+  trollop

data/LICENSE.txt

@@ -0,0 +1,20 @@
+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,82 @@
+= vail
+
+vail converts text into audible Morse code. It currently uses the beep gem to interact with the PC speaker - so this means it is restricted to Linux distros that have the beep commandline utility available. 
+
+== Installation
+
+Due to vail's reliance on beep, prior to installing the vail gem (or running the executable after cloning the repo), you will need the beep utility to be installed. AFAIK, this would restrict usage to Linux distros or related systems that have the beep utility available. After that, it is as simple as:
+
+  gem install vail
+
+== Customisable Settings
+
+* duration - this can be set for a dot or a dash and the units are milliseconds
+* pause - this is the time in milliseconds that vail will pause for before proceeding to the next set of instructions, This can be applied to a dot, a dash, a letter or a group of letters (Vail uses spaces to distinguish groups of letters)
+* frequency - of the sound generated, in Hz. It is applied to both dots and dashes
+* repetitions - the number of times the provided string will be repeated
+
+== Usage - executable
+
+The vail executable can be run to output Morse code from the commandline. Executing is as simple as:
+
+  vail
+
+You will be prompted to enter the text and you sould be rewarded with a sequence of beeps representing the dots and dashes for the various letters. To exit, simply hit Ctrl-C.
+
+There are currently two commandline options available. These allow you to export the current default settings for the gem and import settings from a specified file. A brief description of these two options can also be found by running:
+
+  vail --help
+
+=== Export settings
+
+The settings are dumped as YAML, and the output can be redirected to a file of your choice to server as a template for a custom settings file:
+
+  vail -e > current_settings.yaml
+
+When the export parameter is provided, vail exits after outputting the settings.
+
+=== Importing settings
+
+Settings may be imported to override the default settings for the gem. An exported file may be used as a template for the import file. The settings imported will only be used for that execution of the binary and they will temporarily override the default settings. Currently, there is no user-friendly way to do this permanenently.
+
+  vail -i /path/to/custom/settings
+
+== Usage - in Ruby code
+
+To use the vail module in Ruby code is reasonably simple - just bear in mind that it is subject to the same restrictions as the executable (linux only, requires the beep utility):
+
+  require 'rubygems'
+  require 'vail'
+
+  Vail::Generator.new.to_morse("E")
+
+=== Providing custom settings
+
+The default settings can be overridden by passing a hash of custom settings - in the code below, only the repetitions are optional. Excluding any of the other options will result in Vail puking horribly :)
+
+  @settings = { 
+    "dot" => { "duration" => 100, "pause" => 200 },
+    "dash" => { "duration" => 300, "pause" => 400 },
+    "frequency" => 250,
+    "letter" => { "pause" => 100 },
+    "group" => { "pause" => 200 }, 
+    "repetitions" => 2
+  }
+
+  Vail::Generator.new(@settings).to_morse("T")
+
+== Contributing to vail
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Rory McKinley. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "vail"
+  gem.homepage = "http://github.com/rorymckinley/vail"
+  gem.license = "MIT"
+  gem.summary = %Q{A simple gem to generate audible morse code}
+  gem.description = %Q{Vail generates audible morse code. Currently it only works on Linux distros that have hte beep utility installed. This is hopefully a temporary limitation}
+  gem.email = "rorymckinley@gmail.com"
+  gem.authors = ["Rory McKinley"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "vail #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/vail

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+require 'rubygems'
+require 'trollop'
+require 'vail'
+
+trap("INT") do
+  puts "\nExiting......."
+  exit
+end
+
+opts = Trollop::options do
+  opt :export, "Output current default settings"
+  opt :import, "Run with settings in provided YAML file", :type => String
+end
+
+if opts[:export]
+  puts YAML::dump(Vail::Generator.new.settings)
+else
+  settings = {}
+
+  settings = opts[:import] ? YAML::load(IO.read(opts[:import])) : {}
+
+  while true
+    puts "Please enter the text for conversion:"
+    text = gets.strip
+    Vail::Generator.new(settings).to_morse(text)
+  end
+end

data/config/default.yaml

@@ -0,0 +1,11 @@
+dot:
+  duration: 100
+  pause: 100
+dash:
+  duration: 300
+  pause: 100
+letter:
+  pause: 350
+group:
+  pause: 500
+frequency: 250

data/lib/vail/config.rb

@@ -0,0 +1,4 @@
+module Vail
+  class Config
+  end
+end

data/lib/vail/dot_dash.rb

@@ -0,0 +1,4 @@
+module Vail
+  class Dot; end
+  class Dash; end
+end

data/lib/vail/generator.rb

@@ -0,0 +1,58 @@
+module Vail
+  class Generator
+    def initialize(config={})
+      config = YAML.load(IO.read(ConfigPath)) if config.empty?
+      
+      @config = config.merge (
+        {
+          Dot => { "duration" => config["dot"]["duration"], "pause" => config["dot"]["pause"] },
+          Dash => { "duration" => config["dash"]["duration"], "pause" => config["dash"]["pause"]}
+        }
+      )
+      @config["repetitions"] ||= 1
+    end
+
+    def to_morse(phrase)
+      instructions = build_instructions(phrase)
+
+      (@config["repetitions"].times.inject([]) { |r,i| r << instructions }).each do |instruction_set|
+        instruction_set.each do |i|
+          execute_instruction(i)
+        end
+      end
+    end
+
+    def settings
+      @config.reject { |key, value| [Dot,Dash].include? key }
+    end
+
+    private
+
+    def build_instructions(phrase)
+      instructions = []
+
+      phrase.each_char do |char|
+        if char == " "
+          instructions << { :command => :sleep, :instruction => @config["group"]["pause"].to_f/1000.0}
+        else
+          morse = Translate.to_morse(char)
+          instructions << { 
+            :command => :sound, 
+            :instruction => morse.map { |dotdash| { :duration => @config[dotdash]["duration"], :pause => @config[dotdash]["pause"], :frequency => @config["frequency"] }}
+          }
+          instructions << { :command => :sleep, :instruction => @config["letter"]["pause"].to_f/1000.0}
+        end
+      end
+
+      instructions
+    end
+
+    def execute_instruction(instruction)
+      if instruction[:command] == :sound
+        Beep::Sound.generate(instruction[:instruction])
+      else
+        sleep(instruction[:instruction])
+      end
+    end
+  end
+end

data/lib/vail/translate.rb

@@ -0,0 +1,35 @@
+module Vail
+  class Translate
+    Morse = {
+      "a" => [Dot, Dash],
+      "b" => [Dash, Dot, Dot, Dot],
+      "c" => [Dash, Dot, Dash, Dot],
+      "d" => [Dash, Dot, Dot],
+      "e" => [Dot],
+      "f" => [Dot, Dot, Dash, Dot],
+      "g" => [Dash, Dash, Dot],
+      "h" => [Dot, Dot, Dot, Dot],
+      "i" => [Dot, Dot],
+      "j" => [Dot, Dash, Dash, Dash ],
+      "k" => [Dash, Dot, Dash ],
+      "l" => [Dot, Dash, Dot, Dot],
+      "m" => [Dash, Dash],
+      "n" => [Dash, Dot],
+      "o" => [Dash, Dash, Dash],
+      "p" => [Dot, Dash, Dash, Dot],
+      "q" => [Dash, Dash, Dot, Dash],
+      "r" => [Dot, Dash, Dot],
+      "s" => [Dot, Dot, Dot], 
+      "t" => [Dash], 
+      "u" => [Dot, Dot, Dash], 
+      "v" => [Dot, Dot, Dot, Dash], 
+      "w" => [Dot, Dash, Dash],
+      "x" => [Dash, Dot, Dot, Dash],
+      "y" => [Dash, Dot, Dash, Dash],
+      "z" => [Dash, Dash, Dot, Dot]
+    }
+    def self.to_morse(letter)
+      Morse[letter.downcase] || []
+    end
+  end
+end

data/lib/vail.rb

@@ -0,0 +1,10 @@
+require 'beep'
+require 'yaml'
+
+['vail/config', 'vail/dot_dash', 'vail/translate', 'vail/generator'].each do |f|
+  require File.join(File.dirname(__FILE__), f)
+end
+
+module Vail
+  ConfigPath = File.join(File.dirname(__FILE__), '..', 'config', 'default.yaml')
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'vail'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/vail/generator_spec.rb

@@ -0,0 +1,102 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Vail::Generator do
+  before(:each) do
+    @settings = { 
+      "dot" => { "duration" => 100, "pause" => 200 },
+      "dash" => { "duration" => 300, "pause" => 400 },
+      "frequency" => 250,
+      "letter" => { "pause" => 100 },
+      "group" => { "pause" => 200 }
+    }
+  end
+  it "should load default settings upon initialisation if none are provided" do
+    IO.should_receive(:read).with(Vail::ConfigPath).and_return('blah')
+    YAML.should_receive(:load).with('blah').and_return(@settings)
+    Vail::Generator.new
+  end
+  it "should generate the sound for a letter with a single dot" do
+    Vail::Translate.should_receive(:to_morse).with('E').and_return([Vail::Dot])
+    Beep::Sound.should_receive(:generate).with([{ :duration => 100, :pause => 200, :frequency => 250 }])
+
+    Vail::Generator.new(@settings).to_morse("E")
+  end
+  it "should generate the sound for a letter with a single dash" do
+    Vail::Translate.should_receive(:to_morse).with('T').and_return([Vail::Dash])
+    Beep::Sound.should_receive(:generate).with([{ :duration => 300, :pause => 400, :frequency => 250 }])
+
+    Vail::Generator.new(@settings).to_morse("T")
+  end
+  it "should generate morse for a letter that has a multiple dots and dashes" do
+    sound_parameters = [
+      { :duration => 300, :pause => 400, :frequency => 250 },
+      { :duration => 300, :pause => 400, :frequency => 250 },
+      { :duration => 100, :pause => 200, :frequency => 250 }
+    ]
+    Vail::Translate.should_receive(:to_morse).with('G').and_return([Vail::Dash, Vail::Dash, Vail::Dot])
+    Beep::Sound.should_receive(:generate).with(sound_parameters)
+
+    Vail::Generator.new(@settings).to_morse("G")
+  end
+
+  it "should provide an additional pause after a letter is completed" do
+    Vail::Translate.stub!(:to_morse).and_return([Vail::Dash, Vail::Dash, Vail::Dot])
+    Beep::Sound.should_receive(:generate)
+
+    g = Vail::Generator.new(@settings)  
+    g.should_receive(:sleep).with(@settings["letter"]["pause"].to_f/1000.0)
+    g.to_morse("G")
+  end
+
+  it "should generate morse for a group of letters" do
+    sound_parameters_G = [
+      { :duration => 300, :pause => 400, :frequency => 250 },
+      { :duration => 300, :pause => 400, :frequency => 250 },
+      { :duration => 100, :pause => 200, :frequency => 250 }
+    ]
+    sound_parameters_O = [
+      { :duration => 300, :pause => 400, :frequency => 250 },
+      { :duration => 300, :pause => 400, :frequency => 250 },
+      { :duration => 300, :pause => 400, :frequency => 250 },
+    ]
+    Vail::Translate.stub!(:to_morse).with('G').and_return([Vail::Dash, Vail::Dash, Vail::Dot])
+    Vail::Translate.stub!(:to_morse).with('O').and_return([Vail::Dash, Vail::Dash, Vail::Dash])
+
+    Beep::Sound.should_receive(:generate).with(sound_parameters_G).ordered
+    Beep::Sound.should_receive(:generate).with(sound_parameters_O).ordered
+
+    g = Vail::Generator.new(@settings)
+    g.should_receive(:sleep).with(@settings["letter"]["pause"].to_f/1000.0).twice
+    g.to_morse("GO")
+  end
+
+  it "should pause between groups of words" do
+    Vail::Translate.stub!(:to_morse).with('G').and_return([Vail::Dash, Vail::Dash, Vail::Dot])
+    Vail::Translate.stub!(:to_morse).with('O').and_return([Vail::Dash, Vail::Dash, Vail::Dash])
+
+    Beep::Sound.stub!(:generate)
+
+    g = Vail::Generator.new(@settings)
+    g.should_receive(:sleep).with(@settings["letter"]["pause"].to_f/1000.0).twice.ordered
+    g.should_receive(:sleep).with(@settings["group"]["pause"].to_f/1000.0).ordered
+    g.should_receive(:sleep).with(@settings["letter"]["pause"].to_f/1000.0).twice.ordered
+    g.to_morse("GO GO")
+  end
+
+  it "should allow a phrase to be repeated" do
+    Vail::Translate.stub!(:to_morse).with('G').and_return([Vail::Dash, Vail::Dash, Vail::Dot])
+    Vail::Translate.stub!(:to_morse).with('O').and_return([Vail::Dash, Vail::Dash, Vail::Dash])
+
+    Beep::Sound.stub!(:generate)
+
+    g = Vail::Generator.new(@settings.merge("repetitions" => 2))
+    g.should_receive(:sleep).with(@settings["letter"]["pause"].to_f/1000.0).exactly(8).times
+    g.should_receive(:sleep).with(@settings["group"]["pause"].to_f/1000.0).twice
+    g.to_morse("GO GO")
+  end
+
+  it "should be able to return the current settings object including any defaults applied" do
+    Vail::Generator.new(@settings).settings.should == @settings.merge("repetitions" => 1)
+  end
+end
+

data/spec/vail/translate_spec.rb

@@ -0,0 +1,14 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Vail::Translate do
+  it "should return a morse representation of a letter" do
+    ("a".."z").each do |l|
+      Vail::Translate.to_morse(l).should_not be_empty
+    end
+  end
+  it "should not be case-sensitive" do
+    ("A".."Z").each do |l|
+      Vail::Translate.to_morse(l).should_not be_empty
+    end
+  end
+end

data/spec/vail_spec.rb

@@ -0,0 +1,4 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Vail" do
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification 
+name: vail
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Rory McKinley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-13 00:00:00 +02:00
+default_executable: vail
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: beep
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 1
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        - 2
+        version: 1.6.2
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+description: Vail generates audible morse code. Currently it only works on Linux distros that have hte beep utility installed. This is hopefully a temporary limitation
+email: rorymckinley@gmail.com
+executables: 
+- vail
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/vail
+- config/default.yaml
+- lib/vail.rb
+- lib/vail/config.rb
+- lib/vail/dot_dash.rb
+- lib/vail/generator.rb
+- lib/vail/translate.rb
+- spec/spec_helper.rb
+- spec/vail/generator_spec.rb
+- spec/vail/translate_spec.rb
+- spec/vail_spec.rb
+has_rdoc: true
+homepage: http://github.com/rorymckinley/vail
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 2418559716878960855
+      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: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A simple gem to generate audible morse code
+test_files: []
+