flat_out 0.0.5 → 0.0.6

data/README.rdoc

@@ -88,7 +88,7 @@ Command:
       If the fld is longer than specified len, it is left justified and truncated.
 
       Example:
-                                              # '123456789012'
+                                                # '123456789012'
         myline = FlatOut.new(12)                # '            '
         myline.put(4, 2, 'ABCDEFG')             # ' ABCD       '
         myline.put(4, 2, 'ABCD')                # ' ABCD       '
@@ -131,13 +131,34 @@ Command:
         myline.put(-4.2, 2, 12.3)               # ' 001230     '
         myline.put(-4.2, 2, 123456.789)         # ' 345679     '
 
+    Entire record in an array:
+      To specify the entire record in a single array, you have to use option :len_fld or :fld_len,
+      and the array should contain the fields in strict sequence. Also see 'Working With Templates'.
+      example 1:
+        myline = FlatOut.new(21, :format => :len_fld)
+        val = [5, 'ABCD',
+               5,  10,
+               4.2, 10.23,
+               3, 'EFG']
+        myline.put(val)                         # 'ABCD 000100010.23EFG '
+
+      example 2:
+        myline = FlatOut.new(21, :format => :fld_len)
+        val = ['ABCD', 5,
+                10,    5,
+               10.23,  4.2,
+               'EFG',  3]
+        myline.put(val)                         # 'ABCD 000100010.23EFG '
+
+
 Command:
 
   myline.to_s
 
   Description:
     This will return the formatted fixed length record which you can write to a file.
-    It will blank fill or truncate the output to the correct length.
+    It will blank fill or truncate the output to the correct length. Reset and put also
+    return myline.to_s.
 
 Command:
 
@@ -167,13 +188,20 @@ Command:
 == Working with Templates
 
    You can also specify a template during initialization, and then put values in the template
-   with an array.
+   with an array. Templates can have length and positions as follows:
 
   example:
     f = FlatOut.new(18, :template => [[5,1],[5,6],[4.2,11]])    #  '123456789012345678'
     val = ['ABCD',10,10.23]
     f.put(val)                                                  #  'ABCD 000100010.23 '
 
+   You can also skip the position specification if the fields are specified in strict sequence
+   in the template.
+  example:
+    f = FlatOut.new(18, :template => [5,5,4.2])                 #  '123456789012345678'
+    val = ['ABCD',10,10.23]
+    f.put(val)                                                  #  'ABCD 000100010.23 '
+
 == Full Cycle Example:
 
     myline = FlatOut.new(80)
@@ -196,8 +224,15 @@ Command:
     myline.put(30, 30, "END OF REPORT")
     puts myline.to_s
 
+== Issues, Suggestions
+
+* https://github.com/aksharma/flat_out/issues/
+* or email me directly at (sharma.rubyonrails)
+*     this address        (    @             )
+*                         (sharmail_dot_com  )
+
 == 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.

data/lib/flat_out.rb

@@ -1,14 +1,18 @@
 class FlatOut
+
+  #attr_accessor :flat_out, :flat_length, :base, :format, :template
+
   def initialize(rec_length, options={})
     self.reset(rec_length, options)
   end
 
   def reset(rec_length=@flat_length, options={})
-    @flat_out = " " * rec_length
-    @flat_length = rec_length
     @base = options[:base] ||= @base ||= 1
     @format = options[:format] ||= @format ||= :len_pos_fld
     @template = options[:template] ||= @template ||= []
+    @flat_length = rec_length
+    @flat_out = " " * rec_length
+    return @flat_out
   end
 
   def to_s
@@ -34,16 +38,45 @@ class FlatOut
       when :pos_fld_len then (pos = p1; fld = p2; len = p3)
       when :fld_pos_len then (fld = p1; pos = p2; len = p3)
       when :fld_len_pos then (fld = p1; len = p2; pos = p3)
+      when :fld_len     then (fld = p1)
+      when :len_fld     then (fld = p1)
       else                   (len = p1; pos = p2; fld = p3)
       end
     end
 
     case fld
     when Array
-      fld.each_with_index do |field,idx|
-        len = @template[idx][0]
-        pos = @template[idx][1]
-        put len, pos, field
+      if @template.size > 0 and @template[0].class == Array    # :template => [[5,1],[5,6],[4.2,11]]
+        fld.each_with_index do |field,idx|
+          len = @template[idx][0]
+          pos = @template[idx][1]
+          put len, pos, field
+        end
+      elsif @template.size > 0                                 # :template => [5,5,4.2,3]
+        pos = @base
+        fld.each_with_index do |field, idx|
+          len = @template[idx]
+          put len, pos, field
+          pos = pos + real_len(len)
+        end
+      elsif @format == :fld_len                                # val = ['ABCD', 5, 10, 5]
+        @format = :len_pos_fld
+        pos = @base
+        fld.each_slice(2) do |arr|
+          field = arr[0]
+          len = arr[1]
+          put len, pos, field
+          pos = pos + real_len(len)
+        end
+      elsif @format == :len_fld                                # val = [5, 'ABCD', 4.2, 10.23]
+        @format = :len_pos_fld
+        pos = @base
+        fld.each_slice(2) do |arr|
+          len = arr[0]
+          field = arr[1]
+          put len, pos, field
+          pos = pos + real_len(len)
+        end
       end
     when String
       put_alpha len, pos, fld
@@ -56,6 +89,7 @@ class FlatOut
         put_integer len, pos, fld
       end
     end
+    return self.to_s
   end
 
   private
@@ -93,4 +127,16 @@ class FlatOut
     val =  sprintf("%0.#{dec}f", fld)[-dec,dec]
     put_fld dec, pos, val
   end
+
+  def real_len(len)
+    return len if len.integer?
+
+    int = len.to_s.split(".")[0].to_i.abs
+    dec = len.to_s.split(".")[1].to_i
+    if len > 0
+      return int + 1 + dec
+    else
+      return int + dec
+    end
+  end
 end

data/spec/flat_out_spec.rb

@@ -48,6 +48,30 @@ describe "put exact length alpha with fld_pos_len format" do
   end
 end
 
+describe "put whole record specified in an array with fld_len format" do
+  it "should build the format sequentially" do
+    f = FlatOut.new(21, :format => :fld_len)
+    val = ['ABCD', 5,
+            10,    5,
+           10.23,  4.2,
+           'EFG',  3]
+    f.put(val)
+    f.to_s.should == 'ABCD 000100010.23EFG '
+  end
+end
+
+describe "put whole record specified in an array with len_fld format" do
+  it "should build the format sequentially" do
+    f = FlatOut.new(21, :format => :len_fld)
+    val = [5, 'ABCD',
+           5,  10,
+           4.2, 10.23,
+           3, 'EFG']
+    f.put(val)
+    f.to_s.should == 'ABCD 000100010.23EFG '
+  end
+end
+
 describe "put short length alpha" do
   it "should blank fill the trailing space" do
     f = FlatOut.new(6)
@@ -144,7 +168,7 @@ describe "put float with negative length" do
   end
 end
 
-describe "put with a template" do
+describe "put with a template specifying len and pos" do
   it "should put multiple fields" do
     f = FlatOut.new(18, :template => [[5,1],[5,6],[4.2,11]])
     val = ['ABCD',10,10.23]
@@ -153,6 +177,15 @@ describe "put with a template" do
   end
 end
 
+describe "put with a template specifying len only" do
+  it "should build the format sequentially" do
+    f = FlatOut.new(21, :template => [5,5,4.2,3])
+    val = ['ABCD',10,10.23,'EFG']
+    f.put(val)
+    f.to_s.should == 'ABCD 000100010.23EFG '
+  end
+end
+
 describe "digits_only" do
   it "should remove non-digit characters" do
     FlatOut.digits_only('01(2)-3ABC4-5^678').should == "012345678"

metadata

@@ -2,7 +2,7 @@
 name: flat_out
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - Anil Sharma