telegraph 1.0

data/MIT-LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Juanjo Bazán
+
+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,64 @@
+= Telegraph
+
+Telegraph is a Ruby gem that provides straightforward text-to-morse and morse-to-text translators
+
+It uses as reference the document 'RECOMMENDATION ITU-R M.1677' from the International Telecommunication Union, Radiocommunication Sector (ITU-R), the United Nations agency for information and communication technology issues.
+
+== Getting started
+
+Install the gem: 
+    $ [sudo] gem install telegraph
+
+Then depending on your project you may:
+
+require the gem (if a ruby project):  
+    require 'telegraph'
+or add it to your Gemfile (if you're on Rails): 
+    gem 'telegraph', :git => 'git://github.com/xuanxu/telegraph.git'
+  
+
+== Usage
+
+The simplest way to read or write morse code is using directly the two methods defined in Telegraph:
+    
+    # Converts text to morse characters:
+    Telegraph.text_to_morse("Hello world")  #=> ".... . .-.. .-.. ---        .-- --- .-. .-.. -.."
+    
+    # Reads morse characters into text:
+    Telegraph.morse_to_text(".... . .-.. .-.. ---        .-- --- .-. .-.. -..")  #=> hello world"
+    
+In the Telegraph module you will find defined also the most commonly used prosigns:
+
+    # Error sign:
+    Telegraph::Error    #=> "........"
+    
+    #The complete list of prosigns:
+    Telegraph::Error
+    Telegraph::Understood
+    Telegraph::Invitation_to_transmit
+    Telegraph::Wait
+    Telegraph::End_of_work
+    Telegraph::Starting_signal
+    
+All the generated morse code will use the character '.' as short signal (aka dot) and the character '-' as long signal (aka dash).
+
+If you need to write or read using different characters as short and long signals you can do it instantiating your own Telegraph::MorseTransmission class:
+
+    # User defined dot & dash (:short and :long defaults to '.' and '-')
+    morser = Telegraph::MorseTransmission.new(:short =>'x', :long => '3')
+    
+and then using the methods to read/write:
+
+    # write morse code with custom signals 
+    morser.text_to_morse("Hello world")  #=> "xxxx x x3xx x3xx 333        x33 333 x3x x3xx 3xx"
+    
+    # read morse code with custom signals 
+    morser.morse_to_text("xxxx x x3xx x3xx 333        x33 333 x3x x3xx 3xx")  #=> hello world"
+    morser.error    #=> "xxxxxxxx"
+
+== Credits
+
+Author:: Juanjo Bazán 
+Copyright:: Copyright (c) 2010 Juanjo Bazán
+License:: Released under the MIT license.
+

data/lib/morse_characters.rb

@@ -0,0 +1,130 @@
+# encoding: UTF-8
+module MorseCharacters
+  
+  # Official characters from the RECOMMENDATION ITU-R M.1677: International Morse code.
+  ITU_Morse = {
+    "a" => ".-",
+    "b" => "-...",
+    "c" => "-.-.",
+    "d" => "-..",
+    "e" => ".",
+    "f" => "..-.",
+    "g" => "--.",
+    "h" => "....",
+    "i" => "..",
+    "j" => ".---",
+    "k" => "-.-",
+    "l" => ".-..",
+    "m" => "--",
+    "n" => "-.",
+    "o" => "---",
+    "p" => ".--.",
+    "q" => "--.-",
+    "r" => ".-.",
+    "s" => "...",
+    "t" => "-",
+    "u" => "..-",
+    "v" => "...-",
+    "w" => ".--",
+    "x" => "-..-",
+    "y" => "-.--",
+    "z" => "--..",
+    "0" => "-----",
+    "1" => ".----",
+    "2" => "..---",
+    "3" => "...--",
+    "4" => "....-",
+    "5" => ".....",
+    "6" => "-....",
+    "7" => "--...",
+    "8" => "---..",
+    "9" => "----.",
+    "." => ".-.-.-",
+    "," => "--..--",
+    ":" => "---...",
+    "?" => "..--..",
+    "’" => ".----.",
+    "–" => "-....-",
+    "-" => "-....-",
+    "/" => "-..-.",
+    "(" => "-.--.",
+    ")" => "-.--.-",
+    "“" => ".-..-.",
+    "”" => ".-..-.",
+    "\""=> ".-..-.",
+    "=" => "-...-",
+    "+" => ".-.-.",
+    "@" => ".--.-."}
+  
+  # Some international characters not included in the ITU-R specification.
+  International_extensions = {
+    "ä" => ".-.-",
+    "æ" => ".-.-",
+    "ą" => ".-.-",
+    "à" => ".--.-",
+    "å" => ".--.-",
+    "ç" => "-.-..",
+    "ĉ" => "-.-..",
+    "ć" => "-.-..",
+    "š" => "----",
+    "ĥ" => "----",
+    "ð" => "..--.",
+    "ś" => "...-...",
+    "è" => ".-..-",
+    "ł" => ".-..-",
+    "é" => "..-..",
+    "đ" => "..-..",
+    "ę" => "..-..",
+    "ĝ" => "--.-.",
+    "ĵ" => ".---.",
+    "ź" => "--..-.",
+    "ñ" => "--.--",
+    "Ñ" => "--.--",
+    "ń" => "--.--",
+    "ö" => "---.",
+    "ø" => "---.",
+    "ó" => "---.",
+    "ŝ" => "...-.",
+    "þ" => ".--..",
+    "ü" => "..--",
+    "ŭ" => "..--",
+    "ż" => "--..-"
+  }
+
+  # The space between morse words is seven spaces.
+  Space_between_words = {" " => "       "}
+
+  # Default dot signal: '.'
+  DOT = '.'
+  
+  # Default dot signal: '-'
+  DASH = '-'
+  
+  # Character mapping to write morse code.
+  LETTERS_TO_MORSE = Space_between_words.merge(International_extensions).merge(ITU_Morse)
+  
+  # Character mapping to read morse code.
+  MORSE_TO_LETTERS = (Space_between_words.merge(ITU_Morse)).invert
+  
+  MORSE_TO_LETTERS.default = ""
+  LETTERS_TO_MORSE.default = ""
+  
+  # Prosign for 'Error'
+  Error = "........"
+  
+  # Prosign for 'Understood'
+  Understood = "...-."
+  
+  # Prosign for 'Invitation to transmit'
+  Invitation_to_transmit = "-.-"
+  
+  # Prosign for 'Wait'
+  Wait = ".-..."
+  
+  # Prosign for 'End of work'
+  End_of_work = "...-.-"
+  
+  # Prosign for 'Starting signal'
+  Starting_signal = "-.-.-"
+  
+end

data/lib/telegraph.rb

@@ -0,0 +1,134 @@
+# encoding: UTF-8
+
+# Telegraph module provides a simple text-to-morse, morse-to-text translator.
+# 
+# It uses as reference the document <t>RECOMMENDATION ITU-R M.1677</t> from the 
+# International Telecommunication Union, Radiocommunication Sector (ITU-R), the United 
+# Nations agency for information and communication technology issues.
+#
+module Telegraph
+  include MorseCharacters
+  
+  # Transforms a string of plain text into a string of morse code 
+  # using the character '.' as the short signal and the character '-' as the long signal.
+  # The encode is made following the official RECOMMENDATION ITU-R M.1677.
+  # The returned string uses a single space as letter separator and a seven spaces gap as word separator.
+  #
+  #   Telegraph.text_to_morse("Hello world")  #=> ".... . .-.. .-.. ---        .-- --- .-. .-.. -.."
+  #
+  def self.text_to_morse(text)
+    text.strip.downcase.split(" ").inject([]){|morse_words, word| 
+      morse_words << word.chars.inject(""){|morse_word, character| [morse_word, LETTERS_TO_MORSE[character]].join(" ").strip}
+    }.join(LETTERS_TO_MORSE[" "]).strip
+  end
+  
+  # Transforms a string of morse code into a string of text decoding using the RECOMMENDATION ITU-R M.1677.
+  #
+  # It expects the character '.' as the short signal, the character '-' as the long signal,
+  # a space as separation between letters and seven spaces as separation between words.
+  #
+  # The returned string is completly downcased.
+  #
+  #   Telegraph.morse_to_text(".... . .-.. .-.. ---        .-- --- .-. .-.. -..")  #=> hello world"
+  #
+  def self.morse_to_text(morse)
+    morse.split(LETTERS_TO_MORSE[" "]).inject([]){|words, morse_word|
+      words << morse_word.split(" ").inject(""){|word, morse_char| word + MORSE_TO_LETTERS[morse_char]}
+    }.join(" ")
+  end
+
+  # Telegraph::MorseTransmission class provides a simple text-to-morse, morse-to-text translator using 
+  # user defined characters for short and long signals (defaults to '.' and '-').
+  # 
+  # It uses as reference the document <t>RECOMMENDATION ITU-R M.1677</t> from the 
+  # International Telecommunication Union, Radiocommunication Sector (ITU-R), the United 
+  # Nations agency for information and communication technology issues.
+  #
+  class MorseTransmission
+    attr_accessor(:short, :long)
+    
+    # When instantiating the class two options can be provided to set the signals
+    # to use by the new instance when reading and writing morse code:
+    # 
+    # * <tt>:short</tt> - The character to use as dot or short signal. Default: '.'
+    # * <tt>:long</tt> - The character to use as dash or long signal. Default: '-'
+    #
+    def initialize(signals={})
+      @short = signals[:short] || Telegraph::DOT
+      @long = signals[:long] || Telegraph::DASH
+    end
+    
+    # Transforms a string of plain text into a string of morse code 
+    # using as short and long signals the characters defined by the user when the class was instantiated.
+    # 
+    # The returned string uses a single space as letter separator and a seven spaces gap as word separator.
+    #
+    #   morser = Telegraph::MorseTransmission.new(:short =>'x', :long => '3')
+    #   morser.text_to_morse("Hello world")  #=> "xxxx x x3xx x3xx 333        x33 333 x3x x3xx 3xx"
+    #
+    def text_to_morse(text)
+      morse = Telegraph.text_to_morse(text)
+      dot_dash(morse)
+    end
+    
+    # Transforms a string of morse code into a string of text decoding using the RECOMMENDATION ITU-R M.1677.
+    # 
+    # It expects as short and long signals the characters defined by the user when the class was instantiated,
+    # a space as separation between letters and seven spaces as separation between words.
+    # 
+    # The returned string is completly downcased.
+    #
+    #   morser = Telegraph::MorseTransmission.new(:short =>'x', :long => '3')
+    #   morser.morse_to_text("xxxx x x3xx x3xx 333        x33 333 x3x x3xx 3xx")  #=> hello world"
+    #
+    def morse_to_text(morse)
+      morse = undo_dot_dash(morse.strip)
+      Telegraph.morse_to_text(morse)
+    end
+    
+    # Returns the 'Error' sign using the signal characters defined for this instance.
+    def error
+      dot_dash(Telegraph::Error)
+    end
+    
+    # Returns the 'Understood' sign using the signal characters defined for this instance.
+    def understood
+      dot_dash(Telegraph::Understood)
+    end
+    
+    # Returns the 'Invitation to transmit' sign using the signal characters defined for this instance.
+    def invitation_to_transmit
+      dot_dash(Telegraph::Invitation_to_transmit)
+    end
+    
+    # Returns the 'Wait' sign using the signal characters defined for this instance.
+    def wait
+      dot_dash(Telegraph::Wait)
+    end
+    
+    # Returns the 'End of work' sign using the signal characters defined for this instance.
+    def end_of_work
+      dot_dash(Telegraph::End_of_work)
+    end
+    
+    # Returns the 'Starting signal' sign using the signal characters defined for this instance.
+    def starting_signal
+      dot_dash(Telegraph::Starting_signal)
+    end
+  
+    private
+    
+    def dot_dash(text) #:nodoc:
+      text = text.gsub(Telegraph::DOT, @short) unless @short == Telegraph::DOT
+      text = text.gsub(Telegraph::DASH, @long) unless @long == Telegraph::DASH
+      text  
+    end
+    
+    def undo_dot_dash(morse) #:nodoc:
+      morse = morse.gsub(@short, Telegraph::DOT) unless @short == Telegraph::DOT
+      morse = morse.gsub(@long, Telegraph::DASH) unless @long == Telegraph::DASH
+      morse
+    end
+  end
+
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: telegraph
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- "Juanjo Baz\xC3\xA1n"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-09 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :development
+  version_requirements: *id001
+description: Telegraph provides a simple text-to-morse, morse-to-text translator.
+email: jjbazan@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE.txt
+- README.rdoc
+- lib/morse_characters.rb
+- lib/telegraph.rb
+has_rdoc: true
+homepage: http://github.com/xuanxu/telegraph
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby gem to read and write Morse code
+test_files: []
+