codabel 1.0.0

data/lib/codabel/record/trailer.rb

@@ -0,0 +1,73 @@
+module Codabel
+  class Record
+    class Trailer < Record
+      FOLLOWING = { when_true: '1', when_false: '2' }.freeze
+
+      column 1..1,     nil,              Type::N,                     default: 9
+      column 2..16,    nil,              Type::AN,                    default: ''
+      column 17..22,   :records_count,   Type::N,                     default: 0
+      column 23..37,   :debit,           Type::Amount,                default: 0
+      column 38..52,   :credit,          Type::Amount,                default: 0
+      column 53..127,  nil,              Type::AN,                    default: ''
+      column 128..128, :file_follows,    Type::Flag.new(**FOLLOWING), default: false
+
+      def auto_enrich(file)
+        enriched = data.merge(
+          records_count: data[:records_count] || count_records(file),
+          debit: data[:debit] || sum_debit(file),
+          credit: data[:credit] || sum_credit(file)
+        )
+        Trailer.new(enriched)
+      end
+
+      def validate!(file)
+        validate_records_count!(file)
+        validate_credit!(file)
+        validate_debit!(file)
+      end
+
+      private
+
+      def validate_records_count!(file)
+        return unless (count = data[:records_count])
+
+        expected = count_records(file)
+        check!(count == expected, "Invalid trailer record counts: expected #{expected}, got #{count}")
+      end
+
+      def validate_credit!(file)
+        return unless (credit = data[:credit])
+
+        expected = sum_credit(file)
+        check!(credit == expected, "Invalid trailer credit: expected #{expected}, got #{credit}")
+      end
+
+      def validate_debit!(file)
+        return unless (debit = data[:debit])
+
+        expected = sum_debit(file)
+        check!(debit == expected, "Invalid trailer debit: expected #{expected}, got #{debit}")
+      end
+
+      def count_records(file)
+        file.records.filter { |record| must_be_counted?(record) }.size
+      end
+
+      def must_be_counted?(record)
+        !(record.is_a?(Header) || record.is_a?(Trailer))
+      end
+
+      def sum_debit(file)
+        movements21(file).map(&:debit_amount).sum.abs
+      end
+
+      def sum_credit(file)
+        movements21(file).map(&:credit_amount).sum.abs
+      end
+
+      def movements21(file)
+        file.find_records(Movement21)
+      end
+    end
+  end
+end

data/lib/codabel/record.rb

@@ -0,0 +1,107 @@
+module Codabel
+  class Record
+    class << self
+      def header(data = {})
+        Header.new(data)
+      end
+
+      def old_balance(data = {})
+        OldBalance.new(data)
+      end
+
+      def movement(data = {})
+        Movement.new(data)
+      end
+
+      def movement21(data = {})
+        Movement21.new(data)
+      end
+
+      def movement22(data = {})
+        Movement22.new(data)
+      end
+
+      def movement23(data = {})
+        Movement23.new(data)
+      end
+
+      def new_balance(data = {})
+        NewBalance.new(data)
+      end
+
+      def trailer(data = {})
+        Trailer.new(data)
+      end
+
+      def column(range, name, type, options = {})
+        last_index = columns.last&.range&.max || 0
+        raise Error, "Wrong column range #{range}, expected #{1+last_index}.." unless range.min == 1+last_index
+        raise Error, "Wrong column range #{range}" if range.max > 128
+
+        type = type.new if type.is_a?(Class)
+        add_column Column.new(range, name, type, options)
+      end
+
+      def add_column(column)
+        columns << column
+      end
+      private :add_column
+
+      def columns
+        @columns ||= []
+      end
+
+      def for(data)
+        new(data)
+      end
+
+      def required?(data, ignore: [])
+        columns
+          .reject { |column| ignore.any? { |path| column.path_starts_with?(path) } }
+          .any? { |column| column.specifics?(data) }
+      end
+    end
+
+    def initialize(data)
+      @data = data
+    end
+    attr_reader :data
+
+    def actual_records(_file)
+      [self]
+    end
+
+    def auto_enrich(_file)
+      [self]
+    end
+
+    def validate!(file)
+    end
+
+    def to_coda
+      str = self.class.columns.each_with_object('') do |column, memo|
+        memo << column.to_coda(self)
+      end
+      return str if str.length == 128
+
+      raise Error, "128 characters expected, got #{str.length}\n#{str}"
+    end
+
+    protected
+
+    def check!(assertion, message)
+      raise ValidationError, message unless assertion
+    end
+  end
+end
+require_relative 'record/header'
+require_relative 'record/movement'
+require_relative 'record/movement21'
+require_relative 'record/movement22'
+require_relative 'record/movement23'
+require_relative 'record/movement31'
+require_relative 'record/movement32'
+require_relative 'record/movement33'
+require_relative 'record/new_balance'
+require_relative 'record/old_balance'
+require_relative 'record/trailer'

data/lib/codabel/type/account_and_currency.rb

@@ -0,0 +1,31 @@
+module Codabel
+  class Type
+    class AccountAndCurrency < Type
+      def to_coda(value, length)
+        check!(length == 37, "Expected length to be 37, got #{length}")
+        account = Model::Account.dress(value)
+
+        case account.structure
+        when Model::Account::BELGIAN_BBAN
+          str = account.number.ljust(12, ' ')   # 12 N Belgian account number
+          str << ' ' * 1                        #  1 AN blank
+          str << account.currency.ljust(3, ' ') #  3 AN ISO currency code or blank
+          str << '0'                            #  1 N qualification code or blank
+          str << 'BE'                           #  2 AN ISO country code or blank
+          str << ' ' * 3                        #  3 AN blank spaces
+          str << ' ' * 15                       #  15 AN extension zone or blank
+        when Model::Account::FOREIGN_BBAN
+          str = account.number.ljust(34, ' ')   # 34 AN foreign account number
+          str << account.currency.ljust(3, ' ') #  3 AN ISO currency code of the account
+        when Model::Account::BELGIAN_IBAN
+          str = account.number.ljust(31, ' ')   # 31 AN IBAN (Belgian number)
+          str << ' ' * 3                        # 3 AN extension zone or blank
+          str << account.currency.ljust(3, ' ') # 3 AN ISO currency code of the account
+        when Model::Account::FOREIGN_IBAN
+          str = account.number.ljust(34, ' ')   # 34 AN foreign account number
+          str << account.currency.ljust(3, ' ') #  3 AN ISO currency code of the account
+        end
+      end
+    end
+  end
+end

data/lib/codabel/type/account_description.rb

@@ -0,0 +1,10 @@
+module Codabel
+  class Type
+    class AccountDescription < Type
+      def to_coda(value, length)
+        description = Model::Account.dress(value).description
+        description.to_s.ljust(length, ' ')
+      end
+    end
+  end
+end

data/lib/codabel/type/account_structure.rb

@@ -0,0 +1,19 @@
+module Codabel
+  class Type
+    class AccountStructure < Type
+      CODES = {
+        Model::Account::BELGIAN_BBAN => '0',
+        Model::Account::FOREIGN_BBAN => '1',
+        Model::Account::BELGIAN_IBAN => '2',
+        Model::Account::FOREIGN_IBAN => '3'
+      }.freeze
+
+      def to_coda(value, length)
+        return value.to_s.rjust(length, '0') if %w[1 2 3 4].include?(value.to_s)
+
+        structure = Model::Account.dress(value).structure
+        CODES[structure].ljust(length, '0')
+      end
+    end
+  end
+end

data/lib/codabel/type/amount.rb

@@ -0,0 +1,11 @@
+module Codabel
+  class Type
+    class Amount < Type
+      def to_coda(value, length)
+        check!(value.is_a?(Integer), 'All amounts must be in cents')
+
+        (value.abs * 10).to_s.rjust(length, '0')
+      end
+    end
+  end
+end

data/lib/codabel/type/amount_sign.rb

@@ -0,0 +1,9 @@
+module Codabel
+  class Type
+    class AmountSign < Type
+      def to_coda(value, length)
+        (value >= 0.0 ? '0' : '1').rjust(length, '0')
+      end
+    end
+  end
+end

data/lib/codabel/type/an.rb

@@ -0,0 +1,12 @@
+module Codabel
+  class Type
+    class AN < Type
+      def to_coda(value, length)
+        str = value.to_s
+        check!(str.length <= length, "Value `#{value}` is too long")
+
+        str.ljust(length, ' ')
+      end
+    end
+  end
+end

data/lib/codabel/type/blank.rb

@@ -0,0 +1,9 @@
+module Codabel
+  class Type
+    class Blank < Type
+      def to_coda(_value, length)
+        ' ' * length
+      end
+    end
+  end
+end

data/lib/codabel/type/communication.rb

@@ -0,0 +1,37 @@
+module Codabel
+  class Type
+    class Communication < Type
+      DEFAULT_STRUCTURED_CODE = '110'.freeze
+
+      def to_coda(value, length)
+        communication = communication_from(value)
+        check!(communication.length <= length, "Communication `#{communication}` is too long")
+
+        communication.ljust(length, ' ')
+      end
+
+      private
+
+      def communication_from(value)
+        case value
+        when Hash
+          extract_communication_from(value)
+        when String
+          value.to_s
+        else
+          check!(false, "Unexpected communication #{value}")
+        end
+      end
+
+      def extract_communication_from(hash)
+        if hash[:structured]
+          (hash[:structured_code] || DEFAULT_STRUCTURED_CODE) + hash[:structured].to_s
+        elsif hash[:unstructured]
+          hash[:unstructured].to_s
+        else
+          ''
+        end
+      end
+    end
+  end
+end

data/lib/codabel/type/communication_type.rb

@@ -0,0 +1,43 @@
+module Codabel
+  class Type
+    class CommunicationType < Type
+      def to_coda(value, length)
+        type = type_from(value)
+        code = to_code(type)
+        code.to_s.rjust(length, '0')
+      end
+
+      private
+
+      def type_from(communication)
+        case communication
+        when Hash
+          if communication[:structured]
+            :structured
+          else
+            :unstructured
+          end
+        when Symbol
+          communication
+        when String, NilClass
+          :unstructured
+        else
+          check!(false, "Unexpected communication #{communication.inspect}")
+        end
+      end
+
+      def to_code(type)
+        case type
+        when 0, 1
+          type
+        when :unstructured
+          0
+        when :structured
+          1
+        else
+          check!(false, "Unexpected communication type #{type.inspect}")
+        end
+      end
+    end
+  end
+end

data/lib/codabel/type/date.rb

@@ -0,0 +1,14 @@
+module Codabel
+  class Type
+    class Date < Type
+      def to_coda(value, length)
+        check!(length == 6, 'Length of 6 expected')
+        return '0' * length if value.nil?
+
+        value = ::Date.parse(value) if value.is_a?(String)
+        value = value.to_date if value.respond_to?(:to_date)
+        value.strftime('%d%m%y')
+      end
+    end
+  end
+end

data/lib/codabel/type/duplicate.rb

@@ -0,0 +1,10 @@
+module Codabel
+  class Type
+    class Duplicate < Type
+      def to_coda(value, length)
+        str = value ? 'D' : ' '
+        str.rjust(length, ' ')
+      end
+    end
+  end
+end

data/lib/codabel/type/flag.rb

@@ -0,0 +1,15 @@
+module Codabel
+  class Type
+    class Flag < Type
+      def initialize(when_true: '1', when_false: '0')
+        @when_true = when_true
+        @when_false = when_false
+      end
+
+      def to_coda(value, length)
+        str = value ? @when_true : @when_false
+        str.rjust(length, ' ')
+      end
+    end
+  end
+end

data/lib/codabel/type/holder.rb

@@ -0,0 +1,15 @@
+module Codabel
+  class Type
+    class Holder < Type
+      def to_coda(value, length)
+        str = value.to_s
+        return str.ljust(length, ' ') if str.empty?
+
+        str = $1 if str =~ /^BE0(.*)/
+        check!(str.length <= length, "Value `#{value}` is too long")
+
+        str.rjust(length, '0')
+      end
+    end
+  end
+end

data/lib/codabel/type/n.rb

@@ -0,0 +1,12 @@
+module Codabel
+  class Type
+    class N < Type
+      def to_coda(value, length)
+        str = value.to_i.to_s
+        check!(str.length <= length, "Value `#{value}` is too long")
+
+        str.rjust(length, '0')
+      end
+    end
+  end
+end

data/lib/codabel/type/return_transaction_type.rb

@@ -0,0 +1,29 @@
+module Codabel
+  class Type
+    class ReturnTransactionType < Type
+      def to_coda(value, length)
+        rcode = case value
+                when '', NilClass
+                  ''
+                when 1..5
+                  value.to_s
+                when :reject
+                  '1'
+                when :return
+                  '2'
+                when :refund
+                  '3'
+                when :reversal
+                  '4'
+                when :cancellation
+                  '5'
+                when /^[1-5]$/
+                  value
+                else
+                  check!(false, "Unexpected value `#{value}`")
+                end
+        rcode.ljust(length, ' ')
+      end
+    end
+  end
+end

data/lib/codabel/type.rb

@@ -0,0 +1,28 @@
+module Codabel
+  class Type
+    def to_coda(_value, _length)
+      raise NotImplementedError, "#{self.class}#to_coda"
+    end
+
+    def check!(assertion, message)
+      return if assertion
+
+      raise TypeError, message + " for type #{self.class}"
+    end
+  end
+end
+require_relative 'type/account_structure'
+require_relative 'type/account_and_currency'
+require_relative 'type/account_description'
+require_relative 'type/an'
+require_relative 'type/amount'
+require_relative 'type/amount_sign'
+require_relative 'type/blank'
+require_relative 'type/communication_type'
+require_relative 'type/communication'
+require_relative 'type/date'
+require_relative 'type/duplicate'
+require_relative 'type/flag'
+require_relative 'type/n'
+require_relative 'type/holder'
+require_relative 'type/return_transaction_type'

data/lib/codabel/version.rb

@@ -0,0 +1,3 @@
+module Codabel
+  VERSION = '1.0.0'.freeze
+end

data/lib/codabel.rb

@@ -0,0 +1,11 @@
+require 'date'
+require 'ostruct'
+module Codabel
+end
+require_relative 'codabel/version'
+require_relative 'codabel/error'
+require_relative 'codabel/model'
+require_relative 'codabel/type'
+require_relative 'codabel/column'
+require_relative 'codabel/record'
+require_relative 'codabel/file'

data/tasks/gem.rake

@@ -0,0 +1,16 @@
+require 'rubygems/package_task'
+
+gemspec_file = File.expand_path('../codabel.gemspec', __dir__)
+gemspec      = Kernel.eval(File.read(gemspec_file))
+Gem::PackageTask.new(gemspec) do |t|
+  t.name = gemspec.name
+  t.version = gemspec.version
+  t.package_dir = 'pkg'
+  t.need_tar = false
+  t.need_tar_gz = false
+  t.need_tar_bz2 = false
+  t.need_zip = false
+  t.package_files = gemspec.files
+  t.tar_command = 'tar'
+  t.zip_command = 'zip'
+end

data/tasks/test.rake

@@ -0,0 +1,17 @@
+namespace :test do
+  require 'rspec/core/rake_task'
+
+  tests = []
+
+  desc 'Runs unit tests'
+  RSpec::Core::RakeTask.new(:unit) do |t|
+    t.pattern = 'spec/**/test_*.rb'
+    t.rspec_opts = ['-Ilib', '-Ispec', '--color', '--backtrace', '--format=progress']
+  end
+  tests << :unit
+
+  task all: tests
+end
+
+desc 'Runs all tests, unit then integration on examples'
+task test: :'test:all'

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: codabel
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Bernard Lambeau
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+description: Codabel helps generating CODA files from structured information
+email: bernard@flexio.app
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/codabel.rb
+- lib/codabel/column.rb
+- lib/codabel/error.rb
+- lib/codabel/file.rb
+- lib/codabel/model.rb
+- lib/codabel/model/account.rb
+- lib/codabel/record.rb
+- lib/codabel/record/header.rb
+- lib/codabel/record/movement.rb
+- lib/codabel/record/movement21.rb
+- lib/codabel/record/movement22.rb
+- lib/codabel/record/movement23.rb
+- lib/codabel/record/movement31.rb
+- lib/codabel/record/movement32.rb
+- lib/codabel/record/movement33.rb
+- lib/codabel/record/new_balance.rb
+- lib/codabel/record/old_balance.rb
+- lib/codabel/record/trailer.rb
+- lib/codabel/type.rb
+- lib/codabel/type/account_and_currency.rb
+- lib/codabel/type/account_description.rb
+- lib/codabel/type/account_structure.rb
+- lib/codabel/type/amount.rb
+- lib/codabel/type/amount_sign.rb
+- lib/codabel/type/an.rb
+- lib/codabel/type/blank.rb
+- lib/codabel/type/communication.rb
+- lib/codabel/type/communication_type.rb
+- lib/codabel/type/date.rb
+- lib/codabel/type/duplicate.rb
+- lib/codabel/type/flag.rb
+- lib/codabel/type/holder.rb
+- lib/codabel/type/n.rb
+- lib/codabel/type/return_transaction_type.rb
+- lib/codabel/version.rb
+- tasks/gem.rake
+- tasks/test.rake
+homepage: http://github.com/flexioapp/codabel
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Codabel, a generator of CODA financial files.
+test_files: []