ita2 0.1.1 → 0.1.2

data/lib/ita2.rb

@@ -1,33 +1,35 @@
 # ita2.rb -- string to ita2 converter. Written by Oemuer Oezkir.
-# Usage: require this file, it automatically adds 2 new methods to String:
+# Usage: require "ita2", it automatically adds 3 new methods to String:
+
 # String#to_ita2      => returns the ita2 codes for the string in an array
 # String#to_punchcode => returns the string as ita2 5 bit punchcodes
+# String#invalid_letters? => returns number of unconvertable letters or false
 module Ita2
   private
 
   LTRS = "\x00e\na\ssiu\rdrjnfcktzlwhypqobg\x1bmxv\x1f".split(//)
   FIGS = "\x003\n-\s'87\r\x054\a,!:(5+)2$6019?&\x1b./;\x1f".split(//)
-  
+
   # Ita2.pretty_string(text, on, off) => text in a "punched tape" style. on and off characters are optional.
   def pretty_string(text, on = "#", off = "\s")
-    convert(text, on, off).map{ |a| a.to_s }.join("\n")
+    convert(text, on, off).map{ |str| str.to_s }.join("\n")
   end
-  
+
   def convert(text, on = "#", off = "\s")
     converted = codes(text)
-    a = Array.new(5) {Array.new(converted.size)}
+    matrix = Array.new(5) {Array.new(converted.size)}
     converted.each_with_index do |char, i|
       j = 0
       sprintf("%5b", char).gsub(/\s/, "0").reverse.each_char do |bin|
-        a[j][i] = on if bin == "1"
-        a[j][i] = off if bin == "0"
+        matrix[j][i] = on if bin == "1"
+        matrix[j][i] = off if bin == "0"
         j += 1
       end
     end
-    a
+    matrix
   end
-  
-  # Ita2.codes(text) => returns the ita2 codes for text in an array. Skips any unknown letters.  
+
+  # Ita2.codes(text) => returns the ita2 codes for text in an array. Skips any unknown letters.
   def codes(text)
     figs = false
     converted = []
@@ -41,7 +43,7 @@ module Ita2
           converted << 0x1b << is_figs?(char)
           figs = true
         end
-      
+
       else # we are in FIGS mode
         if is_figs?(char)
           converted << is_figs?(char)
@@ -51,13 +53,13 @@ module Ita2
         end
       end
     end
-    
+
     converted
   end
-  
-  
+
+
   def is_ltrs?(char)
-    if l = LTRS.index(char)
+    if ( l = LTRS.index(char) )
       return l
     else
       false
@@ -65,27 +67,30 @@ module Ita2
   end
 
   def is_figs?(char)
-    if l = FIGS.index(char)
+    if ( l = FIGS.index(char) )
       return l
     else
       false
     end
   end
-  
+
 end
 
 # mixin => String
 class String
   include Ita2
 
+  # returns an array of letters converted to ITA2 codes
   def to_ita2
     codes(self)
   end
-  
+
+  # returns a string showing the ITA2 codes in a 5bit punchcode ASCII graphic
   def to_punchcode(on = "#", off = "\s")
     pretty_string(self, on, off)
   end
 
+  # returns the number of letters that can't be converted to ITA2 or false if every letter can be converted
   def invalid_letters?
     invalid = 0
     self.downcase.each_char do |char|

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - !binary |
@@ -16,11 +16,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-21 00:00:00 +01:00
+date: 2010-03-30 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
-description: Converts strings to ita2 codes or to a punchcode ascii graphic in 5bit ita2
+description: Converts strings to ITA2 codes or to a punchcode ASCII graphic in 5-bit ITA2
 email: darkoem@gmail.com
 executables: []