flat_out 0.0.1 → 0.0.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Anil Sharma
+
+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,215 @@
+= flat_out
+
+Create fixed length records with fixed length data fields to write a flat file.
+
+== Install
+
+Install flat_out like any other ruby gem:
+
+    gem install flat_out
+
+== Overview of usage
+
+  flat_out creates a fixed length record with desired formatting of variable fields.
+  It was created to export a fixed length format file to send to an organization
+  using legacy computers and softwares.
+
+  * Create a new FlatOut object of desired length using FlatOut.new.
+  * 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.
+
+== Commands
+
+Available Commands:
+
+  initialize(rec_length)
+  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
+
+
+== IMPORTANT NOTE
+
+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:
+
+  FlatOut.new(length)
+
+  Description:
+    This command will create a blank string of specified length.
+    example:
+      myline = FlatOut.new(80)             # initializes an 80 character blank string in myline.
+
+Command:
+
+  myline.reset
+  myline.reset(new_length)
+
+  Description:
+    This command will blank out the string in the myline object. If no length is provided, the string's
+    length remains unchanged. You can change the length of the string in myline by specifying it here.
+
+    example:
+      myline = FlatOut.new(80)             # initializes an 80 character blank string in myline.
+      myline.reset                         # re-initializes an 80 character blank string in myline.
+      myline.reset(132)                    # myline now has a 132 character blank string.
+
+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     '
+
+Command:
+
+  myline.put_digits_only(len, pos, fld)
+
+  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 '
+
+Command:
+
+  myline.put_decimal_with_point(int_dot_dec, pos, 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.
+
+  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    '
+
+Command:
+
+  myline.put_decimal_no_point(int_dot_dec, pos, 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.
+
+  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.
+
+  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)
+    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)
+      puts myline.to_s
+    end
+
+    myline.reset
+    myline.put_alpha(30, 30, "END OF REPORT")
+    puts myline.to_s
+
+== Contributing to flat_out
+ 
+* 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) 2012 Anil Sharma. See LICENSE for further details.
+

data/lib/flat_out.rb

@@ -0,0 +1,57 @@
+class FlatOut
+  def initialize(rec_length)
+    @flat_out = " " * rec_length
+    @flat_length = rec_length
+  end
+
+  def reset(rec_length=@flat_length)
+    @flat_out = " " * rec_length
+    @flat_length = rec_length
+  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
+  end
+
+  def put_integer len, pos, fld
+    data_content = fld.to_s
+    data_len = data_content.length
+    zero_fill = "0" * len
+    val = (zero_fill + data_content)[-len,len]
+    put_alpha len, pos, val
+  end
+
+  def put_integer_part len, pos, fld
+    val =  fld.to_i
+    put_integer len, pos, val
+  end
+
+  def put_digits_only len, pos, fld
+    val = fld.gsub(/[^\d]/,"")
+    put_alpha len, pos, val
+  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
+  end
+end

data/spec/flat_out_spec.rb

@@ -0,0 +1,143 @@
+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)
+    f.to_s.should == "      "
+  end
+end
+
+describe "Reset String without argument" do
+  it "should have a blank string of unchanged length when reset()" do
+    f = FlatOut.new(6)
+    f.reset
+    f.to_s.should == "      "
+  end
+end
+
+describe "Reset String with argument" do
+  it "should have a blank string of new length when reset()" do
+    f = FlatOut.new(6)
+    f.reset(4)
+    f.to_s.should == "    "
+  end
+end
+
+describe "put_alpha exact length" do
+  it "should replace the correct space in the right spot" do
+    f = FlatOut.new(6)
+    f.put_alpha(3,2,"ABC")
+    f.to_s.should == " ABC  "
+  end
+end
+
+describe "put_alpha short length" do
+  it "should blank fill the trailing space" do
+    f = FlatOut.new(6)
+    f.put_alpha(3,2,"AB")
+    f.to_s.should == " AB   "
+  end
+end
+
+describe "put_alpha long length" do
+  it "should truncate the extra characters on the right" do
+    f = FlatOut.new(6)
+    f.put_alpha(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
+    f = FlatOut.new(6)
+    f.put_integer(3,2,123)
+    f.to_s.should == " 123  "
+  end
+end
+
+describe "put_integer short length" do
+  it "should zero fill the leading spaces" do
+    f = FlatOut.new(6)
+    f.put_integer(3,2,12)
+    f.to_s.should == " 012  "
+  end
+end
+
+describe "put_integer long length" do
+  it "should truncate the extra characters on the right" 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 "
+  end
+end
+
+describe "put_integer_part of an integer" do
+  it "should act like put_integer" do
+    f = FlatOut.new(6)
+    f.put_integer_part(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
+    f = FlatOut.new(6)
+    f.put_integer_part(3,2,12345.67)
+    f.to_s.should == " 345  "
+  end
+end
+
+describe "put_decimal_with_point for a float" 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.to_s.should == " 12345.678  "
+  end
+end
+
+describe "put_decimal_with_point for a float" 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.to_s.should == " 2345.64    "
+  end
+end
+
+describe "put_decimal_with_point for a float" 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.to_s.should == " 2345.68    "
+  end
+end
+
+describe "put_decimal_with_point for a float" do
+  it "should zero fill both sides" do
+    f = FlatOut.new(12)
+    f.put_decimal_with_point(4.2, 2, 1.2)
+    f.to_s.should == " 0001.20    "
+  end
+end
+
+describe "put_decimal_no_point for a float" do
+  it "should not have a decimal" do
+    f = FlatOut.new(12)
+    f.put_decimal_no_point(4.2, 2, 1.2)
+    f.to_s.should == " 000120     "
+  end
+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 'flat_out'
+
+# 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

metadata

@@ -2,7 +2,7 @@
 name: flat_out
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Anil Sharma
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-26 00:00:00 -04:00
+date: 2012-05-27 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -24,6 +24,11 @@ extra_rdoc_files: []
 
 files: 
 - lib/flat_out.rb
+- spec/spec_helper.rb
+- spec/flat_out_spec.rb
+- README.rdoc
+- LICENSE
+- spec//spec_helper.rb
 has_rdoc: true
 homepage: http://rubygems.org/gems/flat_out
 licenses: []
@@ -52,5 +57,6 @@ rubygems_version: 1.5.3
 signing_key: 
 specification_version: 3
 summary: Create fixed length records to write to a flat file.
-test_files: []
-
+test_files: 
+- spec//spec_helper.rb
+- spec/flat_out_spec.rb