vail 0.1.2 → 0.2.0

data/README.rdoc

@@ -11,7 +11,14 @@ Due to vail's reliance on beep, prior to installing the vail gem (or running the
 == 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)
+* pause - this is the time in milliseconds that vail will pause for before proceeding to the next set of instructions. A pause can be applied after the following elements:
+  * a dot
+  * a dash
+  * a letter
+  * a group of letters (separated by a space)
+  * a line
+  * a repetition
+
 * 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
 
@@ -21,11 +28,13 @@ The vail executable can be run to output Morse code from the commandline. Execut
 
   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:
+You will be prompted to enter the text and you should be rewarded with a sequence of beeps representing the dots and dashes for the various letters. To exit, simply hit Ctrl-C.
 
-  vail --help
+The following options can be passed when running the executable from the commandline:
+* --export, -e : Export settings
+* --import, -i : Import settings
+* --text, -t : Load a file containing text to be converted to Morse
+* --help, -h : Help 
 
 === Export settings
 
@@ -41,6 +50,14 @@ Settings may be imported to override the default settings for the gem. An export
 
   vail -i /path/to/custom/settings
 
+=== Load text from file
+
+Text can be loaded from a file and then converted into Morse. vail will treat each line as a seperate set of instructions. Therefore if repeptitions have been applied each line will be repeated for the given number of repetitions before proceeding on to the next line.
+
+  vail -t /path/to/input/file
+
+Vail will wait the number of milliseconds provided for in the line pause before proceeding to the next line.
+
 == 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):
@@ -52,7 +69,7 @@ To use the vail module in Ruby code is reasonably simple - just bear in mind tha
 
 === 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 :)
+The default settings can be overridden by passing a hash of custom settings - in the code below, only the repetitions element is optional. Excluding any of the other options will result in Vail puking horribly :)
 
   @settings = { 
     "dot" => { "duration" => 100, "pause" => 200 },
@@ -60,11 +77,14 @@ The default settings can be overridden by passing a hash of custom settings - in
     "frequency" => 250,
     "letter" => { "pause" => 100 },
     "group" => { "pause" => 200 }, 
-    "repetitions" => 2
+    "line" => { "pause" => 1200 }, 
+    "repetitions" =>  { "pause" => 800, "repeat" => 2 }
   }
 
   Vail::Generator.new(@settings).to_morse("T")
 
+If the value of @settings["repetitions"]["repeat"] is 0, vail will run through the text provided once. In addition, to allow backwards compatibility, vail will allow the repetitions element to be an integer. In this case, due to poor reasoning by the developer :), the number of repetitions is the total number of times it will run (repetitions => 1 means it will run once) - so, far better to go with the new settings format if you can.
+
 == 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

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/bin/vail

@@ -12,6 +12,7 @@ end
 opts = Trollop::options do
   opt :export, "Output current default settings"
   opt :import, "Run with settings in provided YAML file", :type => String
+  opt :text, "File containing text for conversion to morse", :type => String
 end
 
 if opts[:export]
@@ -21,9 +22,15 @@ else
 
   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)
+  generator = Vail::Generator.new(settings)
+
+  if opts[:text]
+    generator.to_morse(IO.read(opts[:text]))
+  else
+    while true
+      puts "Please enter the text for conversion:"
+      text = gets.strip
+      generator.to_morse(text)
+    end
   end
 end

data/config/default.yaml

@@ -8,4 +8,6 @@ letter:
   pause: 350
 group:
   pause: 500
+line:
+  pause: 1000
 frequency: 250

data/lib/vail.rb

@@ -1,7 +1,7 @@
 require 'beep'
 require 'yaml'
 
-['vail/config', 'vail/dot_dash', 'vail/translate', 'vail/generator'].each do |f|
+['vail/config', 'vail/dot_dash', 'vail/translate', 'vail/generator', 'vail/command/sound', 'vail/command/pause'].each do |f|
   require File.join(File.dirname(__FILE__), f)
 end
 

data/lib/vail/command/pause.rb

@@ -0,0 +1,12 @@
+module Vail
+  module Command
+    class Pause
+      def initialize(type)
+        @type = type
+      end
+      def execute(config)
+        sleep(config[@type]["pause"].to_f/1000.0)
+      end
+    end
+  end
+end

data/lib/vail/command/sound.rb

@@ -0,0 +1,14 @@
+module Vail
+  module Command
+    class Sound
+      def initialize(morse)
+        @morse = morse
+      end
+
+      def execute(config)
+        Beep::Sound.generate(@morse.map { |dotdash| { :duration => config[dotdash]["duration"], :pause => config[dotdash]["pause"], :frequency => config["frequency"] }})
+      end
+    end
+  end
+end
+

data/lib/vail/generator.rb

@@ -9,13 +9,21 @@ module Vail
           Dash => { "duration" => config["dash"]["duration"], "pause" => config["dash"]["pause"]}
         }
       )
-      @config["repetitions"] ||= 1
-    end
 
-    def to_morse(phrase)
-      instructions = build_instructions(phrase)
+      @config.merge! (
+        case @config["repetitions"]
+        when Hash
+          {}
+        when Fixnum
+          { "repetitions" => { "repeat" => (@config["repetitions"] - 1), "pause" => 800 } }
+        when NilClass
+          { "repetitions" => { "repeat" => 0, "pause" => 800 } }
+        end
+      )
+    end
 
-      (@config["repetitions"].times.inject([]) { |r,i| r << instructions }).each do |instruction_set|
+    def to_morse(text)
+      convert_to_instructions(text).each do |instruction_set|
         instruction_set.each do |i|
           execute_instruction(i)
         end
@@ -28,30 +36,46 @@ module Vail
 
     private
 
+    def convert_to_instructions(text)
+      lines = text.split("\n")
+
+      # the last line does not get a line pause - so handle it first
+      
+      last_line = repeat(build_instructions(lines.pop))
+
+      lines.inject([]) do |store,line|
+        store + (repeat(build_instructions(line)) << [Command::Pause.new('line')])
+      end + last_line
+    end
+
     def build_instructions(phrase)
       instructions = []
 
       phrase.each_char do |char|
         if char == " "
-          instructions << { :command => :sleep, :instruction => @config["group"]["pause"].to_f/1000.0}
+          instructions << Command::Pause.new('group')
         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}
+          instructions << Command::Sound.new(morse)
+          instructions << Command::Pause.new('letter')
         end
       end
 
       instructions
     end
 
+    def repeat(instructions)
+      # Add a repetition pause for the repeats only
+      (@config["repetitions"]["repeat"]).times.inject([]) do 
+        |r,i| r << (instructions +[Command::Pause.new("repetitions")])
+      end << instructions
+    end
+
     def execute_instruction(instruction)
-      if instruction[:command] == :sound
-        Beep::Sound.generate(instruction[:instruction])
-      else
+      if instruction.is_a? Hash
         sleep(instruction[:instruction])
+      else
+        instruction.execute(@config)
       end
     end
   end

data/spec/vail/command/pause_spec.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Vail::Command::Pause do
+  it "should pause for the number of milliseconds specified in the config for the relevant type of pause" do
+    p = Vail::Command::Pause.new('blah')
+    p.should_receive(:sleep).with(0.50)
+    p.execute({'blah' => { 'pause' => 500 }})
+  end
+end
+

data/spec/vail/command/sound_spec.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Vail::Command::Sound do
+  it "should generate sound with the correct settings for a dot or dash" do
+    s = Vail::Command::Sound.new([Vail::Dot, Vail::Dash])
+    Beep::Sound.should_receive(:generate).with([{ :duration => 100, :pause => 200, :frequency => 500 }, { :duration => 300, :pause => 400, :frequency => 500 }])
+    s.execute({ Vail::Dot => { "duration" => 100, "pause" => 200 }, Vail::Dash => { "duration" => 300, "pause" => 400 }, "frequency" => 500 })
+  end
+end
+

data/spec/vail/generator_spec.rb

@@ -7,8 +7,10 @@ describe Vail::Generator do
       "dash" => { "duration" => 300, "pause" => 400 },
       "frequency" => 250,
       "letter" => { "pause" => 100 },
-      "group" => { "pause" => 200 }
+      "group" => { "pause" => 200 }, 
+      "line" => { "pause" => 400 }
     }
+    @mock_pause = double(Vail::Command::Pause)
   end
   it "should load default settings upon initialisation if none are provided" do
     IO.should_receive(:read).with(Vail::ConfigPath).and_return('blah')
@@ -41,10 +43,11 @@ describe Vail::Generator do
 
   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)
+    Vail::Command::Pause.any_instance.should_receive(:sleep).with(@settings["letter"]["pause"].to_f/1000.0)
     g.to_morse("G")
   end
 
@@ -62,11 +65,13 @@ describe Vail::Generator 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])
 
+    @mock_pause.should_receive(:execute).twice
+    Vail::Command::Pause.should_receive(:new).with('letter').twice.and_return(@mock_pause)
+
     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
 
@@ -76,10 +81,11 @@ describe Vail::Generator do
 
     Beep::Sound.stub!(:generate)
 
+    @mock_pause.should_receive(:execute).exactly(5).times
+    Vail::Command::Pause.should_receive(:new).with('letter').exactly(4).times.and_return(@mock_pause)
+    Vail::Command::Pause.should_receive(:new).with('group').and_return(@mock_pause)
+
     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
 
@@ -89,14 +95,44 @@ describe Vail::Generator do
 
     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
+    @mock_pause.should_receive(:execute).exactly(8).times
+
+    mock_pause_group = double(Vail::Command::Pause)
+    mock_pause_group.should_receive(:execute).twice
+
+    mock_pause_rep = double(Vail::Command::Pause)
+    mock_pause_rep.should_receive(:execute)
+
+    Vail::Command::Pause.should_receive(:new).with('letter').exactly(4).times.and_return(@mock_pause)
+    Vail::Command::Pause.should_receive(:new).with('group').and_return(mock_pause_group)
+    Vail::Command::Pause.should_receive(:new).with('repetitions').and_return(mock_pause_rep)
+
+    settings = @settings.merge("repetitions" => { 'repeat' => 1, 'pause' => 800 })
+
+    g = Vail::Generator.new(settings)
     g.to_morse("GO GO")
   end
 
+  it "should accept a scalar value (old settings format) for the repetitions settings key and set a default repetition pause" do
+    Vail::Generator.new(@settings.merge("repetitions" => 5)).settings.should == @settings.merge({"repetitions" => { "repeat" => 4, "pause" => 800}})
+  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)
+    Vail::Generator.new(@settings).settings.should == @settings.merge("repetitions" => { "repeat" => 0, "pause" => 800})
+  end
+
+  it "should split input text on newlines and treat each newline as a separate set of instructions with defined pause between each set" do
+    Vail::Translate.should_receive(:to_morse).with("G").twice.and_return([Vail::Dash, Vail::Dash, Vail::Dot])
+    Vail::Translate.should_receive(:to_morse).with('O').twice.and_return([Vail::Dash, Vail::Dash, Vail::Dash])
+
+    Beep::Sound.stub!(:generate)
+
+    @mock_pause.should_receive(:execute).exactly(5).times
+    Vail::Command::Pause.should_receive(:new).with('letter').exactly(4).times.and_return(@mock_pause)
+    Vail::Command::Pause.should_receive(:new).with('line').and_return(@mock_pause)
+
+    g = Vail::Generator.new(@settings)
+    g.to_morse("GO\nGO\n")
   end
 end
 

data/vail.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{vail}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rory McKinley"]
-  s.date = %q{2011-06-14}
+  s.date = %q{2011-07-04}
   s.default_executable = %q{vail}
   s.description = %q{Vail generates audible morse code. Currently it only works on Linux distros that have the beep utility installed. This is hopefully a temporary limitation}
   s.email = %q{rorymckinley@gmail.com}
@@ -30,11 +30,15 @@ Gem::Specification.new do |s|
     "bin/vail",
     "config/default.yaml",
     "lib/vail.rb",
+    "lib/vail/command/pause.rb",
+    "lib/vail/command/sound.rb",
     "lib/vail/config.rb",
     "lib/vail/dot_dash.rb",
     "lib/vail/generator.rb",
     "lib/vail/translate.rb",
     "spec/spec_helper.rb",
+    "spec/vail/command/pause_spec.rb",
+    "spec/vail/command/sound_spec.rb",
     "spec/vail/generator_spec.rb",
     "spec/vail/translate_spec.rb",
     "spec/vail_spec.rb",

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Rory McKinley
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-14 00:00:00 +02:00
+date: 2011-07-04 00:00:00 +02:00
 default_executable: vail
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -124,11 +124,15 @@ files:
 - bin/vail
 - config/default.yaml
 - lib/vail.rb
+- lib/vail/command/pause.rb
+- lib/vail/command/sound.rb
 - lib/vail/config.rb
 - lib/vail/dot_dash.rb
 - lib/vail/generator.rb
 - lib/vail/translate.rb
 - spec/spec_helper.rb
+- spec/vail/command/pause_spec.rb
+- spec/vail/command/sound_spec.rb
 - spec/vail/generator_spec.rb
 - spec/vail/translate_spec.rb
 - spec/vail_spec.rb
@@ -147,7 +151,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -35729697720693374
+      hash: 1129571700412978294
       segments: 
       - 0
       version: "0"