aba_generator 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f585bf13dfeebd002a78a696ea567080c319aa9fa303ac9c7f207d6d6c097d11
-  data.tar.gz: 9bad38677f88453966d928493d49328e6c59c4748ca906f662b486351394c919
+  metadata.gz: a4ae57548c24971d2f8663b37074f196e43a6b0907253bb26bc939fe92d4ef71
+  data.tar.gz: 6fecbc8f643baecc95472091eff95ae4c8300a5a8eb849f6b223cfc55e84f496
 SHA512:
-  metadata.gz: eb4183cffed0f03b43c96897e9361db30464cc1fe9b75becbac11442b48c86de2d4eff5f32a15ccd7d53f0ecfb52b773954df8ffaf69b957da3f9057a1ded972
-  data.tar.gz: 6fd7ddf3f04f5d6f91afdcf18f1faa7f6e72ebac8e671641cf2fac3b6612377b152ac510fb504386772a03a8228256d2ceeedc456b13f9b0f9582326a98fd3cc
+  metadata.gz: 652181f14e1716ab1c45d4be01ba7cb7f66efdf9528bf2bacd40ae3d84938b1082e50d17864248ecdef87ed373ef2134be6ba6064e797b216b4733cc5bdcc086
+  data.tar.gz: 7a54c370356480de890668e3b1b18b59c7d630ac17059f7eccb0b4b62cf2ae824ff3ff1d89a7e54b221a5b1076d5be2db9492ec67205ff919308ee62205631f3

data/README.md

@@ -22,7 +22,28 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Usage instructions to be written.
+```ruby
+aba = AbaGenerator.new(
+    instutition_code: "CBA",
+    description: "PAYROLL",
+    source_bsb: "123-456",
+    source_account_number: "123456789",
+    remitter_name: "TEST",
+    include_balancing_line: true # defaults to false
+)
+
+@payments.each do |payment|
+    aba.add_row(
+        bsb: '123-456',
+        account_number: '1234567',
+        account_name: 'J E SMITH',
+        amount: 100.00,
+        reference: "Payroll #{Time.new.strftime('%m-%d')}"
+    )
+end
+
+output = aba.generate
+```
 
 ## Development
 

data/lib/aba_generator.rb

@@ -2,9 +2,102 @@ require 'aba_generator/version'
 require 'ostruct'
 require 'aba_generator/core_ext/symbol'
 require 'aba_generator/fixed_width_generator'
+require 'aba_generator/fixed_width/column'
+require 'aba_generator/fixed_width/definition'
+require 'aba_generator/fixed_width/generator'
+require 'aba_generator/fixed_width/parser'
+require 'aba_generator/fixed_width/section'
+require 'aba_generator/header'
+require 'aba_generator/row'
+require 'aba_generator/balancing_line'
+require 'aba_generator/footer'
 
 module AbaGenerator
   class Error < StandardError; end
   
-  
+  def initialize(options = {})
+    # OPTIONS
+    # institution_code
+    # user_name
+    # user_id
+    # description
+    # source_bsb
+    # source_account_number
+    # remitter_name
+    # include_balancing_line
+    
+    @options = options
+    AbaGenerator::Definition.define_fixed_width(@options)
+
+    results = {}
+
+    # Define the Header
+    results[:header] = AbaGenerator::Header.new(@options)
+    results[:body] = []
+  end
+
+  def generate(records)
+    AbaGenerator::Definition.define_fixed_width
+
+    # Create totals
+    total = 0
+
+    # # Create the record rows
+    # records.each do |p|
+    #   results[:body] << {
+    #     :record_type => 1,
+    #     :bsb => p.bank_account.bsb_sep,
+    #     :account_number => ('%9.9s' % p.bank_account.full_account_number),
+    #     :txcode => 53,
+    #     :amount => sprintf("%0.10d", (p.amount * 100).to_i),
+    #     :account_name => p.bank_account.account_name.truncate(32, omission: '').upcase,
+    #     :reference => "PRIZE #{p.prize.prize_number}",
+    #     :source_bsb => @options[:source_bsb],
+    #     :source_account_number => ('%9.9s' % @options[:source_account_number]),
+    #     :remitter_name => @options[:remitter_name].truncate(16, omission: '')
+    #   }
+    #   total += p.amount
+    # end
+
+    # if @options[:include_balancing_line]
+    #   results[:body] << {
+    #     :record_type => 1,
+    #     :bsb => @options[:source_bsb],
+    #     :account_number => ('%9.9s' % @options[:source_account_number]),
+    #     :txcode => 13,
+    #     :amount => sprintf("%0.10d", (total*100).to_i),
+    #     :account_name => @options[:remitter_name].truncate(16, omission: ''),
+    #     :reference => @options[:description],
+    #     :source_bsb => @options[:source_bsb],
+    #     :source_account_number => ('%9.9s' % @options[:source_account_number]),
+    #     :remitter_name => @options[:remitter_name].truncate(16, omission: '')
+    #   }
+    # end
+
+    # # Create the footer, with totals
+    # if @options[:include_balancing_line]
+    #   results[:footer] = [{
+    #     :record_type => 7,
+    #     :bsb_filler => "999-999",
+    #     :net_total => 0,
+    #     :credit_total => sprintf("%0.10d", (total*100).to_i),
+    #     :debit_total => sprintf("%0.10d", (total*100).to_i),
+    #     :records_count => (records.count + 1)
+    #   }]
+    # else
+    #   results[:footer] = [{
+    #     :record_type => 7,
+    #     :bsb_filler => "999-999",
+    #     :net_total => sprintf("%0.10d", (total*100).to_i),
+    #     :credit_total => sprintf("%0.10d", (total*100).to_i),
+    #     :debit_total => 0,
+    #     :records_count => records.count
+    #   }]        
+    # end
+
+    # Render the output as a string
+    FixedWidthGenerator.generate(:aba, results)
+
+  end  
+
 end

data/lib/aba_generator/balancing_line.rb

@@ -0,0 +1,9 @@
+class AbaGenerator
+  class BalancingLine
+
+    def initialize(options = {})
+      @options = options
+    end
+    
+  end
+end

data/lib/aba_generator/core_ext/symbol.rb

@@ -0,0 +1,17 @@
+#
+# Taken from ActiveSupport 2.3.5 lib/active_support/core_ext/symbol.rb
+#
+unless :to_proc.respond_to?(:to_proc)
+  class Symbol
+    # Turns the symbol into a simple proc, which is especially useful for enumerations. Examples:
+    #
+    #   # The same as people.collect { |p| p.name }
+    #   people.collect(&:name)
+    #
+    #   # The same as people.select { |p| p.manager? }.collect { |p| p.salary }
+    #   people.select(&:manager?).collect(&:salary)
+    def to_proc
+      Proc.new { |*args| args.shift.__send__(self, *args) }
+    end
+  end
+end

data/lib/aba_generator/definition.rb

@@ -0,0 +1,51 @@
+class AbaGenerator
+  class Definition
+
+    def self.define_fixed_width(options={})
+      # Create a FixedWidthGenerator::Defintion to describe ABA file format
+      FixedWidthGenerator.define :aba do |d|
+        # Create the ABA DESCRIPTION line
+        d.header(:align => :left) do |header|
+          header.column :record_type, 1, :parser => :to_i
+          header.spacer 17
+          header.column :reel_sequence_number, 2
+          header.column :institution_code, 3
+          header.spacer 7
+          header.column :user_name, 26
+          header.column :user_id, 6, :padding => "0"
+          header.column :description, 12
+          header.column :process_date, 6
+          header.spacer 40
+        end
+
+        d.body(:align => :left) do |body|
+          body.column :record_type, 1, :parser => :to_i
+          body.column :bsb, 7
+          body.column :account_number, 9
+          body.column :indicator, 1
+          body.column :txcode, 2
+          body.column :amount, 10
+          body.column :account_name, 32
+          body.column :reference, 18
+          body.column :source_bsb, 7
+          body.column :source_account_number, 9
+          body.column :remitter_name, 16
+          body.column :withholding_tax_amt, 8, padding: "0"
+        end
+
+        d.footer(:align => :right) do |footer|
+          footer.column :record_type, 1, :parser => :to_i
+          footer.column :bsb_filler, 7
+          footer.spacer 12
+          footer.column :net_total, 10, :padding => "0"
+          footer.column :credit_total, 10, :padding => "0"
+          footer.column :debit_total, 10, :padding => "0"
+          footer.spacer 24
+          footer.column :records_count, 6, :padding => "0"
+          footer.spacer 40
+        end
+      end
+    end
+    
+  end
+end

data/lib/aba_generator/fixed_width/column.rb

@@ -0,0 +1,85 @@
+class FixedWidthGenerator
+  class Column
+    DEFAULT_PADDING   = ' '
+    DEFAULT_ALIGNMENT = :right
+    DEFAULT_TRUNCATE  = false
+    DEFAULT_FORMATTER = :to_s
+
+    attr_reader :name, :length, :alignment, :padding, :truncate, :group, :unpacker
+
+    def initialize(name, length, options={})
+      assert_valid_options(options)
+      @name      = name
+      @length    = length
+      @alignment = options[:align]    || DEFAULT_ALIGNMENT
+      @padding   = options[:padding]  || DEFAULT_PADDING
+      @truncate  = options[:truncate] || DEFAULT_TRUNCATE
+
+      @group     = options[:group]
+
+      @unpacker  = "A#{@length}"
+
+      @parser    = options[:parser]
+      @parser    ||= case @alignment
+                when :right then :lstrip
+                when :left  then :rstrip
+                end
+      @parser    = @parser.to_proc if @parser.is_a?(Symbol)
+
+      @formatter = options[:formatter]
+      @formatter ||= DEFAULT_FORMATTER
+      @formatter = @formatter.to_proc if @formatter.is_a?(Symbol)
+
+      @nil_blank = options[:nil_blank]
+    end
+
+    def parse(value)
+      if @nil_blank && blank?(value)
+        return nil
+      else
+        @parser.call(value)
+      end
+    rescue
+      raise ParserError.new("The value '#{value}' could not be parsed: #{$!}")
+    end
+
+    def format(value)
+      pad(
+        validate_size(
+          @formatter.call(value)
+        )
+      )
+    end
+
+    private
+    BLANK_REGEX = /^\s*$/
+    def blank?(value)
+      value =~ BLANK_REGEX
+    end
+
+    def pad(value)
+      case @alignment
+      when :left
+        value.ljust(@length, @padding)
+      when :right
+        value.rjust(@length, @padding)
+      end
+    end
+
+    def assert_valid_options(options)
+      unless options[:align].nil? || [:left, :right].include?(options[:align])
+        raise ArgumentError.new("Option :align only accepts :right (default) or :left")
+      end
+    end
+
+    def validate_size(result)
+      return result if result.length <= @length
+      raise FixedWidthGenerator::FormattedStringExceedsLengthError.new(
+        "The formatted value '#{result}' in column '#{@name}' exceeds the allowed length of #{@length} chararacters.") unless @truncate
+      case @alignment
+      when :right then result[-@length,@length]
+      when :left  then result[0,@length]
+      end
+    end
+  end
+end

data/lib/aba_generator/fixed_width/definition.rb

@@ -0,0 +1,31 @@
+class FixedWidthGenerator
+  class Definition
+    attr_reader :sections, :templates, :options
+
+    def initialize(options={})
+      @sections  = []
+      @templates = {}
+      @options   = { :align => :right }.merge(options)
+    end
+
+    def section(name, options={}, &block)
+      raise DuplicateSectionNameError.new("Duplicate section name: '#{name}'") if @sections.detect{|s| s.name == name }
+
+      section = FixedWidthGenerator::Section.new(name, @options.merge(options))
+      section.definition = self
+      yield(section)
+      @sections << section
+      section
+    end
+
+    def template(name, options={}, &block)
+      section = FixedWidthGenerator::Section.new(name, @options.merge(options))
+      yield(section)
+      @templates[name] = section
+    end
+
+    def method_missing(method, *args, &block)
+      section(method, *args, &block)
+    end
+  end
+end

data/lib/aba_generator/fixed_width/generator.rb

@@ -0,0 +1,20 @@
+class FixedWidthGenerator
+  class Generator
+
+    def initialize(definition)
+      @definition = definition
+    end
+
+    def generate(data)
+      @builder = []
+      @definition.sections.each do |section|
+        content = data[section.name]
+        arrayed_content = content.is_a?(Array) ? content : [content]
+        raise FixedWidthGenerator::RequiredSectionEmptyError.new("Required section '#{section.name}' was empty.") if (content.nil? || content.empty?) && !section.optional
+        arrayed_content.each {|row| @builder << section.format(row) }
+      end
+      @builder.join("\n")
+    end
+
+  end
+end

data/lib/aba_generator/fixed_width/parser.rb

@@ -0,0 +1,47 @@
+class FixedWidthGenerator
+  class Parser
+    def initialize(definition, file)
+      @definition = definition
+      @file       = file
+    end
+
+    def parse
+      @parsed = {}
+      @content = read_file
+      unless @content.empty?
+        @definition.sections.each do |section|
+          rows = fill_content(section)
+          raise FixedWidthGenerator::RequiredSectionNotFoundError.new("Required section '#{section.name}' was not found.") unless rows > 0 || section.optional
+        end
+      end
+      @parsed
+    end
+
+    private
+
+    def read_file
+      @file.readlines.map(&:chomp)
+    end
+
+    def fill_content(section)
+      matches = 0
+      loop do
+        line = @content.first
+        break unless section.match(line)
+        add_to_section(section, line)
+        matches += 1
+        @content.shift
+      end
+      matches
+    end
+
+    def add_to_section(section, line)
+      if section.singular
+        @parsed[section.name] = section.parse(line)
+      else
+        @parsed[section.name] ||= []
+        @parsed[section.name] << section.parse(line)
+      end
+    end
+  end
+end

data/lib/aba_generator/fixed_width/section.rb

@@ -0,0 +1,91 @@
+class FixedWidthGenerator
+  class Section
+    attr_accessor :definition, :optional, :singular
+    attr_reader :name, :columns, :options
+
+    def initialize(name, options={})
+      @name     = name
+      @options  = options
+      @columns  = []
+      @trap     = options[:trap]
+      @optional = options[:optional] || false
+      @singular = options[:singular] || false
+    end
+
+    def column(name, length, options={})
+      if column_names_by_group(options[:group]).include?(name)
+        raise FixedWidthGenerator::DuplicateColumnNameError.new("You have already defined a column named '#{name}' in the '#{options[:group].inspect}' group.")
+      end
+      if column_names_by_group(nil).include?(options[:group])
+        raise FixedWidthGenerator::DuplicateGroupNameError.new("You have already defined a column named '#{options[:group]}'; you cannot have a group and column of the same name.")
+      end
+      if group_names.include?(name)
+        raise FixedWidthGenerator::DuplicateGroupNameError.new("You have already defined a group named '#{name}'; you cannot have a group and column of the same name.")
+      end
+
+      col = Column.new(name, length, @options.merge(options))
+      @columns << col
+      col
+    end
+
+    def spacer(length, spacer=nil)
+      options           = {}
+      options[:padding] = spacer if spacer
+      column(:spacer, length, options)
+    end
+
+    def trap(&block)
+      @trap = block
+    end
+
+    def template(name)
+      template = @definition.templates[name]
+      raise ArgumentError.new("Template '#{name}' not found as a known template.") unless template
+      @columns += template.columns
+      # Section options should trump template options
+      @options = template.options.merge(@options)
+    end
+
+    def format(data)
+      @columns.map do |c|
+        hash = c.group ? data[c.group] : data
+        c.format(hash[c.name])
+      end.join
+    end
+
+    def parse(line)
+      line_data = line.unpack(unpacker)
+      row       = group_names.inject({}) {|h,g| h[g] = {}; h }
+
+      @columns.each_with_index do |c, i|
+        next if c.name == :spacer
+        assignee         = c.group ? row[c.group] : row
+        assignee[c.name] = c.parse(line_data[i])
+      end
+
+      row
+    end
+
+    def match(raw_line)
+      raw_line.nil? ? false : @trap.call(raw_line)
+    end
+
+    def method_missing(method, *args)
+      column(method, *args)
+    end
+
+    private
+
+    def column_names_by_group(group)
+      @columns.select{|c| c.group == group }.map(&:name) - [:spacer]
+    end
+
+    def group_names
+      @columns.map(&:group).compact.uniq
+    end
+
+    def unpacker
+      @unpacker ||= @columns.map(&:unpacker).join
+    end
+  end
+end

data/lib/aba_generator/fixed_width_generator.rb

@@ -0,0 +1,71 @@
+class FixedWidthGenerator
+  class ParserError < RuntimeError; end
+  class DuplicateColumnNameError < StandardError; end
+  class DuplicateGroupNameError < StandardError; end
+  class DuplicateSectionNameError < StandardError; end
+  class RequiredSectionNotFoundError < StandardError; end
+  class RequiredSectionEmptyError < StandardError; end
+  class FormattedStringExceedsLengthError < StandardError; end
+  class ColumnMismatchError < StandardError; end
+
+  #
+  # [name]   a symbol to reference this file definition later
+  # [option] a hash of default options for all sub-elements
+  # and a block that defines the sections of the file.
+  #
+  # returns: +Definition+ instance for this file description.
+  #
+  def self.define(name, options={}) # yields definition
+    definition = Definition.new(options)
+    yield(definition)
+    definitions[name] = definition
+    definition
+  end
+
+  #
+  # [data]            nested hash describing the contents of the sections
+  # [definition_name] symbol +name+ used in +define+
+  #
+  # returns: string of the transformed +data+ (into fixed-width records).
+  #
+  def self.generate(definition_name, data)
+    definition = definition(definition_name)
+    raise ArgumentError.new("Definition name '#{name}' was not found.") unless definition
+    generator = Generator.new(definition)
+    generator.generate(data)
+  end
+
+  #
+  # [file]            IO object to write the +generate+d data
+  # [definition_name] symbol +name+ used in +define+
+  # [data]            nested hash describing the contents of the sections
+  #
+  # writes transformed data to +file+ object as fixed-width records.
+  #
+  def self.write(file, definition_name, data)
+    file.write(generate(definition_name, data))
+  end
+
+  #
+  # [file]            IO object from which to read the fixed-width text records
+  # [definition_name] symbol +name+ used in +define+
+  #
+  # returns: parsed text records in a nested hash.
+  #
+  def self.parse(file, definition_name)
+    definition = definition(definition_name)
+    raise ArgumentError.new("Definition name '#{definition_name}' was not found.") unless definition
+    parser = Parser.new(definition, file)
+    parser.parse
+  end
+
+  private
+
+  def self.definitions
+    @@definitions ||= {}
+  end
+
+  def self.definition(name)
+    definitions[name]
+  end
+end

data/lib/aba_generator/footer.rb

@@ -0,0 +1,9 @@
+class AbaGenerator
+  class Footer
+
+    def initialize(options = {})
+      @options = options
+    end
+    
+  end
+end

data/lib/aba_generator/header.rb

@@ -0,0 +1,17 @@
+class AbaGenerator
+  class Header
+
+    def initialize(options = {})
+      [{
+        :record_type => 0,
+        :reel_sequence_number => "01",
+        :institution_code => options[:institution_code],
+        :user_name => options[:user_name],
+        :user_id => (options[:user_id] || '000000'),
+        :description => options[:description],
+        :process_date => Time.new.strftime("%d%m%y")
+      }]
+    end
+    
+  end
+end

data/lib/aba_generator/row.rb

@@ -0,0 +1,9 @@
+class AbaGenerator
+  class Row
+
+    def initialize(options = {})
+      @options = options
+    end
+    
+  end
+end

data/lib/aba_generator/version.rb

@@ -1,3 +1,3 @@
 module AbaGenerator
-  VERSION = "0.3.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aba_generator
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Keegan Bakker
@@ -27,6 +27,18 @@ files:
 - bin/console
 - bin/setup
 - lib/aba_generator.rb
+- lib/aba_generator/balancing_line.rb
+- lib/aba_generator/core_ext/symbol.rb
+- lib/aba_generator/definition.rb
+- lib/aba_generator/fixed_width/column.rb
+- lib/aba_generator/fixed_width/definition.rb
+- lib/aba_generator/fixed_width/generator.rb
+- lib/aba_generator/fixed_width/parser.rb
+- lib/aba_generator/fixed_width/section.rb
+- lib/aba_generator/fixed_width_generator.rb
+- lib/aba_generator/footer.rb
+- lib/aba_generator/header.rb
+- lib/aba_generator/row.rb
 - lib/aba_generator/version.rb
 homepage: https://github.com/audata/aba_generator
 licenses: