hflr 0.10.1 → 0.11.0

data/History.txt

@@ -1,4 +1,4 @@
-== 1.0.0 / 2009-08-03
+== 0.11.0 / 2009-08-04
 
-* 1 major enhancement
-  * Birthday!
+*  Removed useless files 
+  * Corrected version number 

data/Rakefile

@@ -6,6 +6,7 @@ begin
   require 'bones'
   Bones.setup
 rescue LoadError
+
   begin
     load 'tasks/setup.rb'
   rescue LoadError

data/hflr.gemspec

@@ -2,12 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hflr}
-  s.version = "1.0.0"
+  s.version = "0.11.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Colin Davis"]
-  s.date = %q{2009-08-03}
-  s.default_executable = %q{hflr}
+  s.date = %q{2009-08-04}
   s.description = %q{HFLR -- Hierarchical Fixed Length Records
 
 Allows you to read and write files of fixed width records when the file contains one or more
@@ -17,9 +16,8 @@ Install with 'gem install hflr'
 
 See the tests and examples bundled with this gem.}
   s.email = %q{colin.c.davis@gmail.com}
-  s.executables = ["hflr"]
-  s.extra_rdoc_files = ["History.txt", "README.txt", "bin/hflr"]
-  s.files = ["History.txt", "README.txt", "Rakefile", "bin/hflr", "lib/hflr.rb", "lib/hflr/fl_record_file.rb", "lib/hflr/hflr.rb", "lib/hflr/record_template.rb", "sample2_out.dat", "spec/hflr_spec.rb", "spec/spec_helper.rb", "test/customer_orders.dat", "test/customers.dat", "test/examples.rb", "test/fixed_length_record_file_test.rb", "test/record_template_test.rb", "test/sample.dat", "test/sample2_out.dat", "test/sample_activities.dat", "test/sample_out.dat", "test/test_helper.rb", "test/test_hflr.rb"]
+  s.extra_rdoc_files = ["History.txt", "README.txt"]
+  s.files = ["History.txt", "README.txt", "Rakefile", "hflr.gemspec", "lib/hflr.rb", "lib/hflr/fl_record_file.rb", "lib/hflr/hflr.rb", "lib/hflr/record_template.rb", "spec/hflr_spec.rb", "spec/spec_helper.rb", "test/customer_orders.dat", "test/customers.dat", "test/examples.rb", "test/fixed_length_record_file_test.rb", "test/record_template_test.rb", "test/sample.dat", "test/sample2_out.dat", "test/sample_activities.dat", "test/sample_out.dat", "test/test_helper.rb", "test/test_hflr.rb"]
   s.homepage = %q{http://ruff.rubyforge.org}
   s.rdoc_options = ["--main", "README.txt"]
   s.require_paths = ["lib"]

data/lib/hflr.rb

@@ -2,7 +2,7 @@
 module Hflr
 
   # :stopdoc:
-  VERSION = '0.10.1'
+  VERSION = '0.11.0'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:

data/lib/hflr/fl_record_file.rb

@@ -1,10 +1,10 @@
+require File.expand_path(File.dirname(__FILE__) + '/record_template')
 
 
-require File.expand_path(File.dirname(__FILE__) + "/record_template")
 
 
 
-class FixedLengthRecordFile  
+class FLRFile  
 
   include Enumerable
   
@@ -22,8 +22,7 @@ class FixedLengthRecordFile
       @record_template = HFLR::RecordTemplate.create(record_layouts, @record_type_symbols, logical_first_column, extra_columns)   
     else
         @record_template = HFLR::RecordTemplate.create(record_layouts, @record_type_symbols, logical_first_column)   
-    end
-        
+    end        
   end
 
 def finished?
@@ -59,12 +58,15 @@ def line_type(line)
   return record_type ? record_type : :unknown
 end
 
-def get_next_known_line_type
-  line = @file.gets       
-  while line_type(line) == :unknown and (not finished?)  
-    line = @file.gets 
-    end
-return line
+def get_next_known_line_type  
+  line = @file.gets 
+  record_type = line_type(line)
+  while record_type == :unknown and (not finished?)
+    line = @file.gets
+    record_type = line_type(line)
+  end
+  record_type == :unknown ? nil : line
+    
 end
 
 def each
@@ -77,16 +79,19 @@ def each
   end 
 end
 
- # This will take a Hash or Struct orArray;  if an Array the record type must be the last element
+ # This will take a Hash or Struct orArray;  if an Array the record type must be the last element when 
+ # the record layout  has more than one record type.
   def <<(record)         
     if record.is_a? Array
-      @file.puts @record_template[record.last].build_line(record)
+    record_type = @record_type_symbols == :none ? @record_template.keys.first : record.last     
+      @file.puts @record_template[record_type].build_line(record)
     else
+      record_type = @record_type_symbols == :none ?@record_template.keys.first : record[:record_type]
       if @record_template[record[:record_type]] == nil then
         raise "Record type problem in output: #{record[:record_type].to_s} type on record, #{@record_template.keys.join(",")} types of templates"
       end
       
-      @file.puts @record_template[record[:record_type]].build_line(record)      
+      @file.puts @record_template[record_type].build_line(record)      
     end
   end
 

data/lib/hflr/record_template.rb

@@ -2,8 +2,8 @@
 module HFLR
 
 class RecordTemplate
-  UnfilledChar = ' '
-  MissingOutput = "ZZZZZZZZZZZZZZZZZZZZZ"
+    UnfilledChar = ' '
+    MissingOutput = "ZZZZZZZZZZZZZZZZZZZZZ"
   
   attr_reader :record_structure, :field_pattern,:record_type,:record_type_label
   attr_accessor :strip_whitespace
@@ -36,7 +36,7 @@ def self.create(record_layouts, record_type_symbols, first_column_location, extr
   return templates  
 end
 
-
+private
   # If the name exists already do not replace it, but add extra columns not to be mapped by the unpack field patterns
   # and ensure the record_type variable is added.
   # Since 'record_type' may not be in the metadata we don't want to map it to a 
@@ -53,12 +53,12 @@ end
     return new_names
   end
   
-  def self.get_pattern(layout, first_column_location=0)
-      
-
+  def self.get_pattern(layout, first_column_location=0)     
     layout.map {|l| '@' + (l.start - first_column_location).to_s + 'A' + l.len.to_s}.to_s
   end
-    
+
+public
+
   def build_record(line)    
     rec = line.unpack(@field_pattern)            
     rec.map{|f| f.strip!} if @strip_whitespace

data/test/examples.rb

@@ -1,4 +1,4 @@
-require '../lib/fl_record_file'
+require File.dirname(__FILE__) + "/../lib/hflr"
 
 
 # Read a file with only one record type (no record type markers)
@@ -10,8 +10,10 @@ Column.new("name",1,25),
 Column.new("zip",26,5),
 Column.new("balance",31,5)]}
   
-customer_file = FixedLengthRecordFile.new(File.new("customers.dat"), :customer, columns, 1, [:line_number])
+customer_file = FLRFile.new(File.new("customers.dat"), :customer, columns, 1, [:line_number])
 
+
+# You can read through the file and access the fields with methods named after the columns:
 customer_file.each do |record|
   puts "Customer #{customer_file.line_number.to_s} #{record.name} #{record.zip} "
 end
@@ -32,7 +34,7 @@ layouts = {:customer=>[
   Column.new("date",9,10),]}
   
   
-customer_orders_file = FixedLengthRecordFile.new(
+customer_orders_file = FLRFile.new(
   File.new("customer_orders.dat"), 
   {"C"=>:customer,"O"=>:order},# Use these characters as record type markers 
   layouts, 

data/test/{fixed_length_record_file_test.rb → flrfile_test.rb}

@@ -1,7 +1,7 @@
 
 
 
-class FixedLengthRecordFileTest < Test::Unit::TestCase 
+class FLRFileTest < Test::Unit::TestCase 
   
   
 
@@ -24,7 +24,7 @@ class FixedLengthRecordFileTest < Test::Unit::TestCase
   
   def test_initialize
   sample_data_path = File.dirname(__FILE__) 
-  fwf = FixedLengthRecordFile.new(
+  fwf = FLRFile.new(
         File.new("#{sample_data_path}/sample.dat"),
         @record_types, # Record types to read from the file, all others will be ignored 
         @layouts,# metadata for all record types
@@ -40,7 +40,7 @@ class FixedLengthRecordFileTest < Test::Unit::TestCase
      assert p_struct.respond_to?(:record_type),"Should have record_type method"
    
   
-  fwf = FixedLengthRecordFile.new(
+  fwf = FLRFile.new(
           File.new("#{sample_data_path}/sample.dat"),
           @record_types, # Record types to read from the file, all others will be ignored 
           @layouts,# metadata for all record types
@@ -54,7 +54,7 @@ class FixedLengthRecordFileTest < Test::Unit::TestCase
   
   def test_get_record_type
       sample_data_path = File.dirname(__FILE__) 
-        fwf = FixedLengthRecordFile.new(
+        fwf = FLRFile.new(
           File.new("#{sample_data_path}/sample.dat"),
           @record_types, # Record types to read from the file, all others will be ignored 
           @layouts,# metadata for all record types
@@ -73,7 +73,7 @@ class FixedLengthRecordFileTest < Test::Unit::TestCase
   
   def test_build_record
     sample_data_path = File.dirname(__FILE__) 
-      fwf = FixedLengthRecordFile.new(
+      fwf = FLRFile.new(
       File.new("#{sample_data_path}/sample.dat"),
       @record_types, # Record types to read from the file, all others will be ignored 
       @layouts,# metadata for all record types
@@ -94,7 +94,7 @@ class FixedLengthRecordFileTest < Test::Unit::TestCase
   
   def test_each
     sample_data_path = File.dirname(__FILE__) 
-     fwf = FixedLengthRecordFile.new(
+     fwf = FLRFile.new(
        File.new("#{sample_data_path}/sample.dat"),
         @record_types, 
         @layouts,
@@ -115,7 +115,7 @@ class FixedLengthRecordFileTest < Test::Unit::TestCase
   
   def test_next_record
     sample_data_path = File.dirname(__FILE__) 
-    fwf = FixedLengthRecordFile.new(
+    fwf = FLRFile.new(
       File.new("#{sample_data_path}/sample.dat"), # data is in this file
       @record_types, # Records of different types have these labels 
       @layouts, # metadata for creating record structs
@@ -125,6 +125,7 @@ class FixedLengthRecordFileTest < Test::Unit::TestCase
       records = []
       while rec = fwf.next_record do 
         records << rec
+
       end
       
       assert_equal :household, records.first.record_type 
@@ -147,13 +148,13 @@ class FixedLengthRecordFileTest < Test::Unit::TestCase
     record = Struct.new(:rectypeh,:phone,:mortgage,:record_type)
     
     sample_data_path = File.dirname(__FILE__) 
-     FixedLengthRecordFile.open(
+     FLRFile.open(
     "#{sample_data_path}/sample_out.dat", # data is in this file
     "w",# open file for writing
           @record_types, # Records of different types have these labels 
           @layouts, # metadata for creating record structs
           1)  do |fwf|# All metadata starting column locations are to be shifted 1 left            
-          assert_equal FixedLengthRecordFile, fwf.class
+          assert_equal FLRFile, fwf.class
           fwf << record.new("H",1,2,:household)
           fwf << ["H",1,3,:household]
           end
@@ -162,7 +163,7 @@ class FixedLengthRecordFileTest < Test::Unit::TestCase
      
      var = Struct.new(:name,:start,:len)
      l = {:customer=>[var.new("name",1,25),var.new("age",26,3)]}
-     fwf = FixedLengthRecordFile.new(File.new("sample2_out.dat","w"),
+     fwf = FLRFile.new(File.new("sample2_out.dat","w"),
          :customer, l,1) 
      
      fwf << ["joe",25,:customer]
@@ -173,7 +174,7 @@ class FixedLengthRecordFileTest < Test::Unit::TestCase
 
 def test_line_type
       sample_data_path = File.dirname(__FILE__) 
-      fwf = FixedLengthRecordFile.new(
+      fwf = FLRFile.new(
         File.new("#{sample_data_path}/sample.dat"),
         @record_types, # Record types to read from the file, all others will be ignored 
         @layouts,# metadata for all record types
@@ -189,7 +190,7 @@ end
   
   def test_get_next_known_line_type
     sample_data_path = File.dirname(__FILE__) 
-      fwf = FixedLengthRecordFile.new(
+      fwf = FLRFile.new(
           File.new("#{sample_data_path}/sample_activities.dat"),
           @record_types, # Record types to read from the file, all others will be ignored 
           @layouts,# metadata for all record types

data/test/sample.dat

@@ -4,3 +4,4 @@ P02326
 P01916
 H010599999999
 P02516
+

data/test/test_hflr.rb

@@ -1,4 +1,4 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
 require File.dirname(__FILE__) + "/record_template_test"
-require File.dirname(__FILE__) + "/fixed_length_record_file_test"
+require File.dirname(__FILE__) + "/flrfile_test"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hflr
 version: !ruby/object:Gem::Version 
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors: 
 - Colin Davis
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-03 00:00:00 -05:00
+date: 2009-08-04 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,27 +32,23 @@ description: |-
   
   See the tests and examples bundled with this gem.
 email: colin.c.davis@gmail.com
-executables: 
-- hflr
+executables: []
+
 extensions: []
 
 extra_rdoc_files: 
 - History.txt
 - README.txt
-- bin/hflr
 files: 
 - History.txt
 - README.txt
 - Rakefile
-- bin/hflr
 - hflr.gemspec
 - lib/hflr.rb
 - lib/hflr/fl_record_file.rb
 - lib/hflr/hflr.rb
 - lib/hflr/record_template.rb
 - sample2_out.dat
-- spec/hflr_spec.rb
-- spec/spec_helper.rb
 - tasks/ann.rake
 - tasks/bones.rake
 - tasks/gem.rake
@@ -69,7 +65,7 @@ files:
 - test/customer_orders.dat
 - test/customers.dat
 - test/examples.rb
-- test/fixed_length_record_file_test.rb
+- test/flrfile_test.rb
 - test/record_template_test.rb
 - test/sample.dat
 - test/sample2_out.dat

data/bin/hflr

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-
-require File.expand_path(
-    File.join(File.dirname(__FILE__), %w[.. lib hflr]))
-
-# Put your code here
-
-# EOF

data/spec/hflr_spec.rb

@@ -1,7 +0,0 @@
-
-require File.join(File.dirname(__FILE__), %w[spec_helper])
-
-describe Hflr do
-end
-
-# EOF

data/spec/spec_helper.rb

@@ -1,16 +0,0 @@
-
-require File.expand_path(
-    File.join(File.dirname(__FILE__), %w[.. lib hflr]))
-
-Spec::Runner.configure do |config|
-  # == Mock Framework
-  #
-  # RSpec uses it's own mocking framework by default. If you prefer to
-  # use mocha, flexmock or RR, uncomment the appropriate line:
-  #
-  # config.mock_with :mocha
-  # config.mock_with :flexmock
-  # config.mock_with :rr
-end
-
-# EOF