flat_out 0.0.2 → 0.0.3

data/README.rdoc

@@ -18,28 +18,42 @@ Install flat_out like any other ruby gem:
   * Format this instance using various put methods based upon your input type.
   * The final result is available via the to_s method of the object.
 
+== Important note on base
+    The positions specified in flat_out are 1 based, which is what most
+    flat file specifications I am dealing with use, and not Ruby's zero based. For example,
+    the first, second, and third characters in a ruby string are considered
+    positions 0, 1, and 2 respectively. In flat_out, these would be considered
+    positions 1, 2, and 3 respectively.
+
+    You can change the base through the FlatOut.base command.
+
 == Commands
 
 Available Commands:
 
-  initialize(rec_length)
+  FlatOut.base(base)
+  FlatOut.new(rec_length)
+  put(len, pos, fld)
+  to_s
+
   reset
   reset(rec_length)
-  put_alpha(len, pos, fld)
-  put_integer(len, pos, fld)
-  put_integer_part(len, pos, fld)
-  put_digits_only(len, pos, fld)
-  put_decimal_with_point(int_dot_dec, pos, fld)
-  put_decimal_no_point(int_dot_dec, pos, fld)
-  to_s
 
+  FlatOut.digits_only(fld)
+  FlatOut.phone_squeeze(fld)
+
+Command:
+
+  FlatOut.base(base)
+
+  Description:
+    This command will change the base for position specifications. It is also useful while
+    working with layouts that are specified with an offset.
 
-== IMPORTANT NOTE
+    example:
+      FlatOut.base(0)                 # Set the base to zero.
+      FlatOut.base(1)                 # Set the base to 1(default).
 
-The positions specified in flat_out are 1 based, which is what most flat file specifications
-use, and not Ruby's zero based. For example, the first, second, and third characters in a ruby string
-are considered positions 0, 1, and 2 respectively. In flat_out, these would be considered
-positions 1, 2, and 3 respectively.
 
 Command:
 
@@ -66,137 +80,111 @@ Command:
 
 Command:
 
-  myline.put_alpha(len, pos, fld)
-
-  Description:
-    This command puts the provided string(fld) at starting position(pos) for (len) bytes.
-    If the fld is shorter than specified len, it is padded with trailing spaces.
-    If the fld is longer than specified len, it is left justified and truncated.
-
-  example:
-    myline = FlatOut.new(10)                # '          '
-                                            # '1234567890'
-    myline.put_alpha(4, 2, 'ABCD')          # ' ABCD     '
-    myline.put_alpha(4, 2, 'AB')            # ' AB       '
-    myline.put_alpha(4, 2, 'ABCDEFG')       # ' ABCD     '
-
-Command:
-
-  myline.put_integer(len, pos, fld)
-
-  Description:
-    This command puts the provided integer(fld) at starting position(pos) for (len) bytes.
-    If the fld is shorter than specified len, it is padded with leading zeroes.
-    If the fld is longer than specified len, it is right justified and truncated.
-
-  example:
-    myline = FlatOut.new(10)                # '          '
-                                            # '1234567890'
-    myline.put_integer(4, 2, 1234)          # ' 1234     '
-    myline.put_integer(4, 2, 12)            # ' 0012     '
-    myline.put_integer(4, 2, 123456)        # ' 3456     '
-
-Command:
-
-  myline.put_integer_part(len, pos, fld)
-
-  Description:
-    This command puts the provided integer part only of the provided float(fld)
-    at starting position(pos) for (len) bytes. The decimal part is dropped.
-    It is useful when only the dollar part of an amount is to be reported.
-    If the fld is shorter than specified len, it is padded with leading zeroes.
-    If the fld is longer than specified len, it is right justified and truncated.
-
-  example:
-    myline = FlatOut.new(10)                     # '          '
-                                                 # '1234567890'
-    myline.put_integer_part(4, 2, 1234.45)       # ' 1234     '
-    myline.put_integer_part(4, 2, 12.45)         # ' 0012     '
-    myline.put_integer_part(4, 2, 123456.45)     # ' 3456     '
+  myline.put(len, pos, fld)
+
+  Descriptions and examples:
+    This command puts the provided field(fld) at starting position(pos) for (len) bytes.
+
+    String fld:
+      If the fld is shorter than specified len, it is padded with trailing spaces.
+      If the fld is longer than specified len, it is left justified and truncated.
+
+      Example:
+                                              # '123456789012'
+        myline = FlatOut.new(12)                # '            '
+        myline.put(4, 2, 'ABCDEFG')             # ' ABCD       '
+        myline.put(4, 2, 'ABCD')                # ' ABCD       '
+        myline.put(4, 2, 'AB')                  # ' AB         '
+
+    Integer fld:
+      If the fld is shorter than specified len, it is padded with leading zeroes.
+      If the fld is longer than specified len, it is right justified and truncated.
+        myline = FlatOut.new(12)                # '            '
+        myline.put(4, 2, 1234)                  # ' 1234       '
+        myline.put(4, 2, 12)                    # ' 0012       '
+        myline.put(4, 2, 123456)                # ' 3456       '
+
+    Float fld with integer len:
+      The decimal part of the fld is truncated and only the integer part is processed.
+      It is useful when only the dollar part of an amount is to be reported.
+        myline = FlatOut.new(12)                # '            '
+        myline.put(4, 2, 1234.45)               # ' 1234       '
+        myline.put(4, 2, 12.45)                 # ' 0012       '
+        myline.put(4, 2, 123456.78)             # ' 3456       '
+
+    Float fld with x.y length with explicit decimal point:
+      Here x is the number of integer digits and y is the number of places after the decimal.
+      The total length of this field in the output is going to be x + y + 1.
+      If the fld is shorter than specified length, it is padded with leading and trailing zeroes.
+      If the fld is longer than specified length, it is decimal justified and truncated.
+        myline = FlatOut.new(12)                # '            '
+        myline.put(4.2, 2, 1234.56)             # ' 1234.56    '
+        myline.put(4.2, 2, 12.3)                # ' 0012.30    '
+        myline.put(4.2, 2, 123456.789)          # ' 3456.79    '
+
+    Float fld with -x.y length with implicit decimal:
+      The format of the output has be specified in -x.y format where x is the number of integer
+      digits and y is the number of places after the decimal. The total length of this field
+      in the output is going to be x + y.
+      This is the format used for decimal numbers by most legacy systems using fixed length records.
+      example:
+        myline = FlatOut.new(12)                # '            '
+        myline.put(-4.2, 2, 1234.56)            # ' 123456     '
+        myline.put(-4.2, 2, 12.3)               # ' 001230     '
+        myline.put(-4.2, 2, 123456.789)         # ' 345679     '
 
 Command:
 
-  myline.put_digits_only(len, pos, fld)
+  myline.to_s
 
   Description:
-    This command puts the provided numeric digits only from alphanumeric(fld) at
-    starting position(pos) for (len) bytes. It is useful to convert formatted
-    SSNs, EINs, Phone numbers etc to their numeric only equivalents.
-    If the fld is shorter than specified len, it is padded with trailing spaces.
-    If the fld is longer than specified len, it is left justified and truncated.
-
-  example:
-    myline = FlatOut.new(12)                            # '            '
-                                                        # '123456789012'
-    myline.put_digits_only(10, 2, '012-345-6789')       # ' 0123456789 '
-    myline.put_digits_only(10, 2, '(800) 555-1212')     # ' 8005551212 '
+    This will return the formatted fixed length record which you can write to a file.
 
 Command:
 
-  myline.put_decimal_with_point(int_dot_dec, pos, fld)
+  FlatOut.digits_only(fld)
 
   Description:
-    This command puts the provided decimal number(fld) at starting position(pos).
-    The format of the output has be specified in x.y format where x is the number of integer
-    digits and y is the number of places after the decimal. The total length of this field
-    in the output is going to be x + y + 1.
-    If the fld is shorter than specified length, it is padded with leading and trailing zeroes.
-    If the fld is longer than specified length, it is decimal justified and truncated.
+    This helper method strips all non-digits from a given string. It is useful to
+    convert formatted SSNs, EINs, Phone numbers etc to their numeric only equivalents.
 
   example:
-    myline = FlatOut.new(12)                             # '            '
-                                                         # '123456789012'
-    myline.put_decimal_with_point(4.2, 2, 1234.56)       # ' 1234.56    '
-    myline.put_decimal_with_point(4.2, 2, 12.3)          # ' 0012.30    '
-    myline.put_decimal_with_point(4.2, 2, 123456.789)    # ' 3456.79    '
+    FlatOut.digits_only('012-345-6789')       # '0123456789'
+    FlatOut.digits_only('(800) 555-1212')     # '8005551212'
 
 Command:
 
-  myline.put_decimal_no_point(int_dot_dec, pos, fld)
+  FlatOut.phone_squeeze(fld)
 
   Description:
-    This command puts the provided decimal number(fld) without the decimal at starting position(pos).
-    The format of the output has be specified in x.y format where x is the number of integer
-    digits and y is the number of places after the decimal. The total length of this field
-    in the output is going to be x + y.
-    This is the format used for decimal numbers by most legacy systems using fixed length records.
-    If the fld is shorter than specified length, it is padded with leading and trailing zeroes.
-    If the fld is longer than specified length, it is decimal justified and truncated.
+    This helper method strips the commonly used special characters and spaces from phone
+    numbers, but leaves the alphabets alone. It is useful to standardize phone numbers fields.
 
   example:
-    myline = FlatOut.new(12)                             # '            '
-                                                         # '123456789012'
-    myline.put_decimal_no_point(4.2, 2, 1234.56)         # ' 123456     '
-    myline.put_decimal_no_point(4.2, 2, 12.3)            # ' 001230     '
-    myline.put_decimal_no_point(4.2, 2, 123456.789)      # ' 345679     '
-
-Command:
-
-  myline.to_s
-
-  Description:
-    This will return the formatted fixed length record which you can write to a file.
+    FlatOut.phone_squeeze('(800) 555-1212') == "8005551212"
+    FlatOut.phone_squeeze('(800) 555-1212 Ext 234') == "8005551212Ext234"
+    FlatOut.phone_squeeze('(800) GOT-MILK') == "800GOTMILK"
 
-  full cycle example:
+== Full Cycle Example:
 
     myline = FlatOut.new(80)
-    myline.put_alpha(10, 1, Time.now.strftime("%m/%d/%Y"))
-    myline.put_alpha(30, 30, "TEST REPORT PRINTED")
-    myline.put_alpha(6, 70, "PAGE:")
-    myline.put_integer(2, 79, 1)
+    myline.put(10, 1, Time.now.strftime("%m/%d/%Y"))
+    myline.put(30, 30, "TEST REPORT PRINTED")
+    myline.put(6, 70, "PAGE:")
+    myline.put(2, 79, 1)
     puts myline.to_s
 
     users = %w[Anil Mark Jake]
 
     users.each do |user|
       myline.reset
-      myline.put_alpha(12, 4, "USERNAME :")
-      myline.put_alpha(12, 16, user)
+      myline.put(12, 4, "USERNAME :")
+      myline.put(12, 16, user)
       puts myline.to_s
     end
 
     myline.reset
-    myline.put_alpha(30, 30, "END OF REPORT")
+    myline.put(30, 30, "END OF REPORT")
     puts myline.to_s
 
 == Contributing to flat_out

data/lib/flat_out.rb

@@ -2,6 +2,7 @@ class FlatOut
   def initialize(rec_length)
     @flat_out = " " * rec_length
     @flat_length = rec_length
+    @@base ||= 1
   end
 
   def reset(rec_length=@flat_length)
@@ -9,49 +10,70 @@ class FlatOut
     @flat_length = rec_length
   end
 
+  def to_s
+    @flat_out
+  end
+
+  def self.base(base)
+    @@base = base
+  end
+
+  def self.phone_squeeze(fld)
+    fld.tr("-)( " , "")
+  end
+
+  def self.digits_only(fld)
+    fld.gsub(/[^\d]/,"")
+  end
+
+  def put len, pos, fld
+    case fld
+    when String
+      put_alpha len, pos, fld
+    when Integer
+      put_integer len, pos, fld
+    when Float
+      if len.to_s.match(/\./)
+        put_float len, pos, fld
+      else
+        put_integer len, pos, fld
+      end
+    end
+  end
+
+  private
+
+  def put_fld len, pos, fld
+    start_pos = pos - @@base ; end_pos = start_pos + len
+    @flat_out[start_pos...end_pos] = fld
+  end
+
   def put_alpha len, pos, fld
-    start_pos = pos - 1 ; end_pos = start_pos + len
     space_fill = " " * len
     val = (fld.to_s + space_fill)[0...len]
-    @flat_out[start_pos...end_pos] = val
+    put_fld len, pos, val
   end
 
   def put_integer len, pos, fld
-    data_content = fld.to_s
+    data_content = fld.to_i.to_s
     data_len = data_content.length
     zero_fill = "0" * len
     val = (zero_fill + data_content)[-len,len]
-    put_alpha len, pos, val
+    put_fld len, pos, val
   end
 
-  def put_integer_part len, pos, fld
-    val =  fld.to_i
-    put_integer len, pos, val
-  end
+  def put_float int_dot_dec, pos, fld
+    int = int_dot_dec.to_s.split(".")[0].to_i.abs
+    put_integer int, pos, fld
 
-  def put_digits_only len, pos, fld
-    val = fld.gsub(/[^\d]/,"")
-    put_alpha len, pos, val
-  end
+    pos = pos + int
+    if int_dot_dec > 0
+      put_fld 1, pos, '.'
+      pos = pos + 1
+    end
 
-  def put_decimal_with_point int_dot_dec, pos, fld
-    precision = int_dot_dec.to_s.split(".")[1].to_i
-    len = int_dot_dec.to_s.split(".")[0].to_i + precision + 1
-    val =  sprintf("%#{len}.#{precision}f", fld)[-len,len]
-    val = val.tr(" ","0")
-    put_alpha len, pos, val
-  end
-
-  def put_decimal_no_point int_dot_dec, pos, fld
-    precision = int_dot_dec.to_s.split(".")[1].to_i
-    len = int_dot_dec.to_s.split(".")[0].to_i + precision + 1
-    val =  sprintf("%#{len}.#{precision}f", fld)[-len,len]
-    val = val.tr(" ","0")
-    val = val.sub(".","")
-    put_alpha len, pos, val
-  end
-
-  def to_s
-    @flat_out
+    dec = int_dot_dec.to_s.split(".")[1].to_i
+    val =  sprintf("%0.#{dec}f", fld)[-dec,dec]
+    put_fld dec, pos, val
   end
 end

data/spec/flat_out_spec.rb

@@ -1,11 +1,5 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-#describe "FlatOut" do
-#  it "fails" do
-##    fail "hey buddy, you should probably rename this file and start specing for real"
-#  end
-#end
-
 describe "New String" do
   it "should have a blank string of correct length when initialize()" do
     f = FlatOut.new(6)
@@ -29,115 +23,133 @@ describe "Reset String with argument" do
   end
 end
 
-describe "put_alpha exact length" do
+describe "put exact length alpha" do
   it "should replace the correct space in the right spot" do
     f = FlatOut.new(6)
-    f.put_alpha(3,2,"ABC")
+    f.put(3,2,"ABC")
     f.to_s.should == " ABC  "
   end
 end
 
-describe "put_alpha short length" do
+describe "put short length alpha" do
   it "should blank fill the trailing space" do
     f = FlatOut.new(6)
-    f.put_alpha(3,2,"AB")
+    f.put(3,2,"AB")
     f.to_s.should == " AB   "
   end
 end
 
-describe "put_alpha long length" do
+describe "put long length alpha" do
   it "should truncate the extra characters on the right" do
     f = FlatOut.new(6)
-    f.put_alpha(3,2,"ABCDE")
+    f.put(3,2,"ABCDE")
     f.to_s.should == " ABC  "
   end
 end
 
-describe "put_integer exact length" do
-  it "should replace the correct space in the right spot" do
+describe "put exact length integer with default base 1" do
+  it "should replace the correct space in the right spot using base 1" do
     f = FlatOut.new(6)
-    f.put_integer(3,2,123)
+    f.put(3,2,123)
     f.to_s.should == " 123  "
   end
 end
 
-describe "put_integer short length" do
-  it "should zero fill the leading spaces" do
+describe "put exact length integer with base 0" do
+  it "should replace the correct space in the right spot using base 0" do
+    FlatOut.base(0)
     f = FlatOut.new(6)
-    f.put_integer(3,2,12)
-    f.to_s.should == " 012  "
+    f.put(3,2,123)
+    f.to_s.should == "  123 "
+    FlatOut.base(1)
   end
 end
 
-describe "put_integer long length" do
-  it "should truncate the extra characters on the right" do
+describe "put short length integer" do
+  it "should zero fill the leading spaces" do
     f = FlatOut.new(6)
-    f.put_integer(3,2,12345)
-    f.to_s.should == " 345  "
-  end
-end
-
-describe "put_digits_only" do
-  it "should remove non-digit characters" do
-    f = FlatOut.new(11)
-    f.put_digits_only(9,2,'01(2)-3ABC4-5^678')
-    f.to_s.should == " 012345678 "
+    f.put(3,2,12)
+    f.to_s.should == " 012  "
   end
 end
 
-describe "put_integer_part of an integer" do
-  it "should act like put_integer" do
+describe "put long length integer" do
+  it "should truncate the extra most dignificant digits on left" do
     f = FlatOut.new(6)
-    f.put_integer_part(3,2,12345)
+    f.put(3,2,12345)
     f.to_s.should == " 345  "
   end
 end
 
-describe "put_integer_part of a float" do
-  it "should remove the decimal part" do
+describe "put float with short length integer only" do
+  it "should remove the decimal part and truncate the left digits" do
     f = FlatOut.new(6)
-    f.put_integer_part(3,2,12345.67)
+    f.put(3,2,12345.67)
     f.to_s.should == " 345  "
   end
 end
 
-describe "put_decimal_with_point for a float" do
+describe "put float with decimal part and full length" do
   it "should include the decimal in result for exact size" do
     f = FlatOut.new(12)
-    f.put_decimal_with_point(5.3, 2, 12345.678)
+    f.put(5.3, 2, 12345.678)
     f.to_s.should == " 12345.678  "
   end
 end
 
-describe "put_decimal_with_point for a float" do
+describe "put float with decimal part with shorter length on both ends" do
   it "should truncate the result for smaller size" do
     f = FlatOut.new(12)
-    f.put_decimal_with_point(4.2, 2, 12345.643)
+    f.put(4.2, 2, 12345.643)
     f.to_s.should == " 2345.64    "
   end
 end
 
-describe "put_decimal_with_point for a float" do
+describe "put float with decimal part with shorter length on both ends with rounding" do
   it "should truncate the result for smaller size(rounded)" do
     f = FlatOut.new(12)
-    f.put_decimal_with_point(4.2, 2, 12345.678)
+    f.put(4.2, 2, 12345.678)
     f.to_s.should == " 2345.68    "
   end
 end
 
-describe "put_decimal_with_point for a float" do
+describe "put float with longer length on both ends" do
   it "should zero fill both sides" do
     f = FlatOut.new(12)
-    f.put_decimal_with_point(4.2, 2, 1.2)
+    f.put(4.2, 2, 1.2)
     f.to_s.should == " 0001.20    "
   end
 end
 
-describe "put_decimal_no_point for a float" do
+describe "put float with negative length" do
   it "should not have a decimal" do
     f = FlatOut.new(12)
-    f.put_decimal_no_point(4.2, 2, 1.2)
+    f.put(-4.2, 2, 1.2)
     f.to_s.should == " 000120     "
   end
 end
 
+describe "digits_only" do
+  it "should remove non-digit characters" do
+    FlatOut.digits_only('01(2)-3ABC4-5^678').should == "012345678"
+  end
+end
+
+describe "phone_squeeze" do
+  it "should remove phone punctuation characters" do
+    FlatOut.phone_squeeze('(800) 555-1212').should == "8005551212"
+  end
+end
+
+describe "phone_squeeze" do
+  it "should remove phone punctuation characters and maintain extensions" do
+    FlatOut.phone_squeeze('(800) 555-1212 Ext 234').should == "8005551212Ext234"
+  end
+end
+
+describe "phone_squeeze" do
+  it "should remove phone punctuation characters and maintain extensions" do
+    FlatOut.phone_squeeze('(800) GOT-MILK').should == "800GOTMILK"
+  end
+end
+

metadata

@@ -2,7 +2,7 @@
 name: flat_out
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Anil Sharma
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-27 00:00:00 -04:00
+date: 2012-05-28 00:00:00 -04:00
 default_executable: 
 dependencies: []