Skip to content

Commit

Permalink
Return unmapped operation_details in "details.unknown" object
Browse files Browse the repository at this point in the history
  • Loading branch information
joanabertoldi committed Nov 28, 2024
1 parent c44da38 commit a7b4757
Show file tree
Hide file tree
Showing 9 changed files with 59 additions and 3 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,9 @@ gem 'cfonb'
Below is the list of additional details available for each operation.

These details can be accessed through `operation.details`, which will provide all the attributes. To fetch a specific attribute, you can use `operation.details.attribute`. For example, `operation.details.unstructured_label`. Ultimately, you can also access the 70 characters of the detail by using its code like `operation.details.mmo`
All unmapped details can be accessed via `details.unknown` which will return the codes and the corresponding line details.

If you encounter new ones, please open an issue or a pull request with the appropriate implementation.
If you encounter new and relevant ones, please open an issue or a pull request with the appropriate implementation.
We aimed at making it as easy as possible to add new details. You just need to do the following on initialization:

```ruby
Expand Down
2 changes: 1 addition & 1 deletion cfonb.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Gem::Specification.new do |s|
s.name = 'cfonb'
s.version = '1.0.0'
s.version = '1.1.0'
s.required_ruby_version = '>= 3.2'
s.summary = 'CFONB parser'
s.description = 'An easy to use CFONB format parser'
Expand Down
1 change: 1 addition & 0 deletions lib/cfonb.rb
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
require_relative 'cfonb/operation_details/ibe'
require_relative 'cfonb/operation_details/npo'
require_relative 'cfonb/operation_details/nbu'
require_relative 'cfonb/operation_details/unknown'

module CFONB
def self.parse(input, optimistic: false)
Expand Down
3 changes: 2 additions & 1 deletion lib/cfonb/operation.rb
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,9 @@ def initialize(line)

def merge_detail(line)
self.raw += "\n#{line.body}"
operation_details = OperationDetails.for(line) || OperationDetails::Unknown

OperationDetails.for(line)&.apply(details, line)
operation_details.apply(details, line)
end

def type_code
Expand Down
1 change: 1 addition & 0 deletions lib/cfonb/operation_details/base.rb
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ def apply(details, line)
details.instance_variable_set(:"@#{line.detail_code}", new_instance)

super
return if attributes.include?(:unknown)

include_duplicated_code_details(current_details, details)
end
Expand Down
20 changes: 20 additions & 0 deletions lib/cfonb/operation_details/unknown.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# frozen_string_literal: true

module CFONB
module OperationDetails
class Unknown < Base
ATTRIBUTES = %i[unknown].freeze

def self.apply(details, line)
return unless line.respond_to?(:detail)

details.unknown ||= {}
code = line.detail_code

details.unknown[code] = merge_details(details.unknown[code], line.detail)
end

CFONB::OperationDetails.register('Unknown', self)
end
end
end
23 changes: 23 additions & 0 deletions spec/cfonb/operation_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,29 @@
expect(operation.details.ultimate_creditor).to eq('Patrick')
end
end

context 'with an unknown detail' do
let(:detail) do
OpenStruct.new(
body: '0530004411001871EUR2 0001016255614090823 AAAEUR200000000000740',
detail_code: 'AAA',
detail: 'EUR200000000000740',
)
end

it 'adds the detail to the unknown details hash' do
operation.merge_detail(detail)

expect(operation.details.unknown).to eq({ 'AAA' => 'EUR200000000000740' })
end

it 'updates the current details in case of duplicated codes' do
operation.merge_detail(detail)
operation.merge_detail(detail)

expect(operation.details.unknown).to eq({ 'AAA' => "EUR200000000000740\nEUR200000000000740" })
end
end
end

describe '#type_code' do
Expand Down
5 changes: 5 additions & 0 deletions spec/cfonb/parser_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,11 @@
exchange_rate: nil,
purpose: 'PURPOSE',
debtor: 'INTERNET SFR',
unknown: {
'AAA' => "INTERNETA AAA\nINTERNETA ABB",
'BBB' => 'INTERNETE BBB',
'CCC' => 'INTERNETI CCC',
},
)

expect(statements[0].operations[1]).to have_attributes(
Expand Down
4 changes: 4 additions & 0 deletions spec/files/example.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
0515589916200000EUR2 98765432100B1160519 REFREFERENCE
0515589916200000EUR2 98765432100B1160519 RCNOTHER REFERENCE PURPOSE
0515589916200000EUR2 98765432100B1160519 NPYINTERNET SFR
0515589916200000EUR2 98765432100B1160519 AAAINTERNETA AAA
0515589916200000EUR2 98765432100B1160519 AAAINTERNETA ABB
0515589916200000EUR2 98765432100B1160519 BBBINTERNETE BBB
0515589916200000EUR2 98765432100B1160519 CCCINTERNETI CCC

0415589916200000EUR2 98765432100B1160519 160519VIR SEPA DEMONSTRATION 0000000000000000000107}REFERENCE
0515589916200000EUR2 98765432100B1160519 NPYELEC ERDF
Expand Down

0 comments on commit a7b4757

Please sign in to comment.