cmxl 1.5.0 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 661a3296bdc88ce9874f07cb4a1cf4220bf1a60ea559e289edc5c5c34774764b
-  data.tar.gz: 4f0217f656646bd14540e5993f6419354641f30d901e8b7afc884b46fc5ac69e
+  metadata.gz: 1c172d6b56767a8860f57c4b802c7ed2ed2bae3658f6db104f44795a377bf067
+  data.tar.gz: ececb262e0d6a40c97e7ca54dcac08208e1942792c5f493be179ba3c81ece6b7
 SHA512:
-  metadata.gz: 407ecb157601f8cc767ddb7699edbadc66582041cdcd8d1de3b3e169a41865d3f81ffdb794b7b9f8add8a55ecea1e16e4048f30a117cfe2401b05b487d2e1bcf
-  data.tar.gz: 4cbfe3e46cc9a00527bfa1a4d465f5e0ad4311d915449b45a81b172e1a653ee3ec2605778bb1241aca752016651b8f54dad0daf00769349a6a80cb679cff0dcf
+  metadata.gz: f0f673453d6bbbc39313ed7ae86ff574c4c9d60a0ea5543283f38d1f3bf4f7477625e2bc87a1fbdc62714c86461735a7e16796edd54cd361d52d49d2eb05d8db
+  data.tar.gz: a197094a3ccd4235f8811a456dbd54c43bc3b49a47062a72f7b9ee53610ddbb4e79ce97e53e0f90670a0c5e3cb5f08ef490792506dc6cc1202d5442c4f724710

data/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version:
+          - 3.3
+          - 3.2
+          - 3.1
+          - "3.0"
+          - jruby-9.4
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rake

data/.github/workflows/release.yml

@@ -0,0 +1,26 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  push:
+    name: Push gem to RubyGems.org
+    runs-on: ubuntu-latest
+
+    permissions:
+      id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
+      contents: write # IMPORTANT: this permission is required for `rake release` to push the release tag
+
+    steps:
+      # Set up
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+
+      # Release
+      - uses: rubygems/release-gem@v1

data/.rspec

@@ -1 +1 @@
---color
+--color

data/CHANGELOG.mdown

@@ -1,5 +1,10 @@
 # NEXT release
 
+# 2.0
+- `[REFACTOR]` **DEPRECATED:** `storno?` and related methods `storno_credit`, `storno_debit`. Use `reversal?` and related methods `reversal_credit?`, `reversal_debit?` instead
+- `[BUGFIX]` **DEPRECATED:** `funds_code` method returns the `credit_debit_indicator` from the SWIFT definition. Therefore the method is deprecated in favor of `credit_debit_indicator` method
+- `[HOUSEKEEPING]` [Replace Travis CI with github actions](https://github.com/railslove/cmxl/pull/57)
+
 # 1.5.0
 
 - `[BUGFIX]` fix potential bug when generation_date is not provided in field 20 and 13 (issue: [#35](https://github.com/railslove/cmxl/issues/35) PR: [#36](https://github.com/railslove/cmxl/pull/36))

data/README.md

@@ -1,5 +1,5 @@
-[![Build Status](https://travis-ci.org/railslove/cmxl.svg?branch=master)](https://travis-ci.org/railslove/cmxl)
-[![Gem Version](https://badge.fury.io/rb/cmxl.svg)](http://badge.fury.io/rb/cmxl)
+[![CI](https://github.com/railslove/cmxl/actions/workflows/ci.yml/badge.svg)](https://github.com/railslove/cmxl/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/cmxl.svg)](https://rubygems.org/gems/cmxl)
 
 # Cmxl - your friendly ruby MT940 parser
 
@@ -16,7 +16,7 @@ For more information have a look at the different [SWIFT message types](http://e
 
 At some point in the future MT940 file should be exchanged with newer XML documents - but banking institutions are slow, so MT940 will stick around for a while.
 
-## Reqirements
+## Requirements
 
 Cmxl is a pure ruby parser and has no dependency on native extensions.
 
@@ -68,7 +68,7 @@ statements.each do |s|
     puts t.information
     puts t.description
     puts t.entry_date
-    puts t.funds_code
+    puts t.credit_debit_indicator
     puts t.credit?
     puts t.debit?
     puts t.sign # -1 if it's a debit; 1 if it's a credit
@@ -96,7 +96,7 @@ If that fails, try to modify the file before you pass it to the parser - and ple
 ### MT940 SWIFT header data
 
 Cmxl currently does not support parsing of the SWIFT headers (like {1:F01AXISINBBA ....)
-If your file comes with these headers try the `strip_headers` configuration option to strip data execpt the actual MT940 fields.
+If your file comes with these headers try the `strip_headers` configuration option to strip data except the actual MT940 fields.
 
 ```ruby
 Cmxl.config[:strip_headers] = true
@@ -187,6 +187,6 @@ other parsers:
 
 ---
 built with love by [Railslove](http://railslove.com) and some [amazing people](https://github.com/railslove/cmxl/graphs/contributors).  
-Released under the MIT-Licence. 
+Released under the MIT-License. 
 
 Railslove builds FinTech products, if you need support for your project we are happy to help. Please contact us at team@railslove.com.

data/cmxl.gemspec

@@ -19,11 +19,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'rchardet'
+
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~>3.0'
   spec.add_development_dependency 'simplecov'
-
-  spec.add_dependency 'rchardet19'
 end

data/lib/cmxl/field.rb

@@ -13,7 +13,7 @@ module Cmxl
 
     # The parser class variable is the registry of all available parser.
     # It is a hash with the tag (MT940 field number/tag) as key and the class as value
-    # When parsing a statment line we look for a matching entry or use the Unknown class as default
+    # When parsing a statement line we look for a matching entry or use the Unknown class as default
     @@parsers = {}
     @@parsers.default = Unknown
     def self.parsers

data/lib/cmxl/fields/transaction.rb

@@ -2,7 +2,7 @@ module Cmxl
   module Fields
     class Transaction < Field
       self.tag = 61
-      self.parser = %r{^(?<date>\d{6})(?<entry_date>\d{4})?(?<storno_flag>R?)(?<funds_code>[CD]{1})(?<currency_letter>[a-zA-Z])?(?<amount>\d{1,12},\d{0,2})(?<swift_code>(?:N|F|S).{3})(?<reference>NONREF|(.(?!\/\/)){,16}([^\/]){,1})((?:\/\/)(?<bank_reference>[^\n]{,16}))?((?:\n)(?<supplementary>.{,34}))?$}
+      self.parser = %r{^(?<date>\d{6})(?<entry_date>\d{4})?(?<credit_debit_indicator>D|C|RD|RC|ED|EC)(?<currency_letter>[a-zA-Z])?(?<amount>\d{1,12},\d{0,2})(?<swift_code>(?:N|F|S).{3})(?<reference>NONREF|(.(?!\/\/)){,16}([^\/]){,1})((?:\/\/)(?<bank_reference>[^\n]{,16}))?((?:\n)(?<supplementary>.{,34}))?$}
 
       attr_accessor :details
 
@@ -15,31 +15,63 @@ module Cmxl
       end
 
       def credit?
-        data['funds_code'].to_s.casecmp('C').zero?
+        credit_debit_indicator.include?('C')
       end
 
       def debit?
-        data['funds_code'].to_s.casecmp('D').zero?
+        credit_debit_indicator.include?('D')
       end
 
       def storno_credit?
+        warn "[DEPRECATION] `storno_credit?` is deprecated.  Please use `reversal_credit?` instead. It will be removed in version 3.0."
+        reversal_credit?
+      end
+
+      def reversal_credit?
         credit? && storno?
       end
 
       def storno_debit?
+        warn "[DEPRECATION] `storno_debit?` is deprecated.  Please use `reversal_debit?` instead. It will be removed in version 3.0."
+        reversal_debit?
+      end
+
+      def reversal_debit?
         debit? && storno?
       end
 
       def storno?
-        !storno_flag.empty?
+        warn "[DEPRECATION] `storno?` is deprecated.  Please use `reversal?` instead. It will be removed in version 3.0."
+        reversal?
+      end
+
+      def reversal?
+        credit_debit_indicator.include?('R')
+      end
+
+      def expected_credit?
+        credit? && expected?
+      end
+
+      def expected_debit?
+        debit? && expected?
+      end
+
+      def expected?
+        credit_debit_indicator.include?('E')
+      end
+
+      def credit_debit_indicator
+        data['credit_debit_indicator'].to_s
       end
 
       def funds_code
-        data.values_at('storno_flag', 'funds_code').join
+        warn "[DEPRECATION] `funds_code` is deprecated.  Please use `credit_debit_indicator` instead. It will be removed in version 3.0."
+        data['credit_debit_indicator'].to_s
       end
 
       def storno_flag
-        data['storno_flag']
+        reversal? ? 'R' : ''
       end
 
       def sign
@@ -140,8 +172,11 @@ module Cmxl
           'sign' => sign,
           'debit' => debit?,
           'credit' => credit?,
-          'storno' => storno?,
-          'funds_code' => funds_code,
+          'storno' => reversal?,
+          'reversal' => reversal?,
+          'expected' => expected?,
+          'funds_code' => credit_debit_indicator,
+          'credit_debit_indicator' => credit_debit_indicator,
           'swift_code' => swift_code,
           'reference' => reference,
           'bank_reference' => bank_reference,

data/lib/cmxl/version.rb

@@ -1,3 +1,3 @@
 module Cmxl
-  VERSION = '1.5.0'.freeze
+  VERSION = '2.0'.freeze
 end

data/lib/cmxl.rb

@@ -1,6 +1,6 @@
 require 'cmxl/version'
 
-require 'rchardet19'
+require 'rchardet'
 
 require 'cmxl/field'
 require 'cmxl/statement'
@@ -31,8 +31,8 @@ module Cmxl
   def self.parse(data, options = {})
     options[:statement_separator] ||= config[:statement_separator]
     # if no encoding is provided we try to guess using CharDet
-    if options[:encoding].nil? && cd = CharDet.detect(data, silent: true)
-      options[:encoding] = cd.encoding
+    if options[:encoding].nil? && cd = CharDet.detect(data)
+      options[:encoding] = cd['encoding']
     end
 
     if options[:encoding]

data/spec/fields/transaction_spec.rb

@@ -7,7 +7,7 @@ describe Cmxl::Fields::Transaction do
   subject(:ocmt_cghs_transaction) { Cmxl::Fields::Transaction.parse(fixture_line(:statement_ocmt_chgs)) }
   subject(:supplementary_transaction) { Cmxl::Fields::Transaction.parse(fixture_line(:statement_supplementary_plain)) }
   subject(:complex_supplementary_transaction) { Cmxl::Fields::Transaction.parse(fixture_line(:statement_supplementary_complex)) }
-  subject(:valuta_after_enty_date) { Cmxl::Fields::Transaction.parse(fixture[3]) }
+  subject(:valuta_after_entry_date) { Cmxl::Fields::Transaction.parse(fixture[3]) }
   subject(:entry_before_valuta_transaction) { Cmxl::Fields::Transaction.parse(fixture[2]) }
   subject(:transaction_type_swift) { Cmxl::Fields::Transaction.parse(fixture[4]) }
 
@@ -70,6 +70,11 @@ describe Cmxl::Fields::Transaction do
   end
 
   context 'statement with complex supplementary' do
+    it 'future reference' do
+      result = Cmxl::Fields::Transaction.parse(':61:2412121212ED162,57NDDTNONREF//950\n')
+      expect(result.amount).to eql(162.57)
+    end
+
     it { expect(complex_supplementary_transaction.initial_amount_in_cents).to eql(nil) }
     it { expect(complex_supplementary_transaction.initial_currency).to eql(nil) }
 
@@ -82,14 +87,14 @@ describe Cmxl::Fields::Transaction do
   end
 
   context 'valuta and entry-date assumptions' do
-    it 'entry_date before valuta is recognized correclty when including year-change' do
+    it 'entry_date before valuta is recognized correctly when including year-change' do
       expect(entry_before_valuta_transaction.date).to eql(Date.new(2014, 1, 10))
       expect(entry_before_valuta_transaction.entry_date).to eql(Date.new(2013, 12, 24))
     end
 
     it 'entry_date after valuta is recognized correctly when including year-change' do
-      expect(valuta_after_enty_date.date).to eql(Date.new(2014, 12, 24))
-      expect(valuta_after_enty_date.entry_date).to eql(Date.new(2015, 1, 2))
+      expect(valuta_after_entry_date.date).to eql(Date.new(2014, 12, 24))
+      expect(valuta_after_entry_date.entry_date).to eql(Date.new(2015, 1, 2))
     end
   end
 
@@ -107,4 +112,77 @@ describe Cmxl::Fields::Transaction do
     it { expect(transaction_type_swift).not_to be_storno }
     it { expect(transaction_type_swift.sign).to eql(1) }
   end
+
+  describe '#credit_debit_indicator' do
+    it 'returns the credit_debit_indicator as debit' do
+      result = Cmxl::Fields::Transaction.parse(':61:1409010902DR000000000001,62NTRF0000549855700010//025498557/000001')
+      expect(result.credit_debit_indicator).to eql('D')
+    end
+
+    it 'returns the credit_debit_indicator as credit' do
+      result = Cmxl::Fields::Transaction.parse(':61:1409010902CR000000000001,62NTRF0000549855700010//025498557/000001')
+      expect(result.credit_debit_indicator).to eql('C')
+    end
+
+    it 'returns the credit_debit_indicator as reversal credit' do
+      result = Cmxl::Fields::Transaction.parse(':61:1409010902RC000000000001,62NTRF0000549855700010//025498557/000001')
+      expect(result.credit_debit_indicator).to eql('RC')
+    end
+
+    it 'returns the credit_debit_indicator as reversal debit' do
+      result = Cmxl::Fields::Transaction.parse(':61:1409010902RD000000000001,62NTRF0000549855700010//025498557/000001')
+      expect(result.credit_debit_indicator).to eql('RD')
+    end
+
+    it 'returns the credit_debit_indicator as expected credit' do
+      result = Cmxl::Fields::Transaction.parse(':61:1409010902EC000000000001,62NTRF0000549855700010//025498557/000001')
+      expect(result.credit_debit_indicator).to eql('EC')
+    end
+  end
+
+  describe '#expected?' do
+    it 'returns true if the transaction is expected' do
+      result = Cmxl::Fields::Transaction.parse(':61:1409010902EC000000000001,62NTRF0000549855700010//025498557/000001')
+      expect(result).to be_expected
+    end
+
+    it 'returns false if the transaction is not expected' do
+      result = Cmxl::Fields::Transaction.parse(':61:1409010902RD000000000001,62NTRF0000549855700010//025498557/000001')
+      expect(result).not_to be_expected
+    end
+  end
+
+  describe '#expected_credit?' do
+    it 'returns true if the transaction is expected and credit' do
+      result = Cmxl::Fields::Transaction.parse(':61:1409010902EC000000000001,62NTRF0000549855700010//025498557/000001')
+      expect(result).to be_expected_credit
+    end
+
+    it 'returns false if the transaction is not expected and credit' do
+      result = Cmxl::Fields::Transaction.parse(':61:1409010902RC000000000001,62NTRF0000549855700010//025498557/000001')
+      expect(result).not_to be_expected_credit
+    end
+
+    it 'returns false if the transaction is expected and debit' do
+      result = Cmxl::Fields::Transaction.parse(':61:1409010902ED000000000001,62NTRF0000549855700010//025498557/000001')
+      expect(result).not_to be_expected_credit
+    end
+  end
+
+  describe '#expected_debit?' do
+    it 'returns true if the transaction is expected and debit' do
+      result = Cmxl::Fields::Transaction.parse(':61:1409010902ED000000000001,62NTRF0000549855700010//025498557/000001')
+      expect(result).to be_expected_debit
+    end
+
+    it 'returns false if the transaction is not expected and debit' do
+      result = Cmxl::Fields::Transaction.parse(':61:1409010902RD000000000001,62NTRF0000549855700010//025498557/000001')
+      expect(result).not_to be_expected_debit
+    end
+
+    it 'returns false if the transaction is expected and credit' do
+      result = Cmxl::Fields::Transaction.parse(':61:1409010902EC000000000001,62NTRF0000549855700010//025498557/000001')
+      expect(result).not_to be_expected_debit
+    end
+  end
 end

data/spec/statement_spec.rb

@@ -27,9 +27,12 @@ describe Cmxl do
           'bank_reference' => '025498557/000001',
           'amount_in_cents' => 162,
           'sign' => -1,
+          'credit_debit_indicator' => 'D',
           'debit' => true,
           'credit' => false,
           'storno' => false,
+          'reversal' => false,
+          'expected' => false,
           'bic' => 'HYVEDEMMXXX',
           'iban' => 'HUkkbbbsssskcccccccccccccccx',
           'name' => 'Peter Pan',
@@ -81,6 +84,7 @@ describe Cmxl do
           'sha' => '3c5e65aa3d3878b06b58b6f1ae2f3693004dfb04e3ab7119a1c1244e612293da',
           'entry_date' => Date.new(2014, 9, 2),
           'funds_code' => 'D',
+          'credit_debit_indicator' => 'D',
           'currency_letter' => 'R',
           'amount' => 1.62,
           'swift_code' => 'NTRF',
@@ -90,7 +94,9 @@ describe Cmxl do
           'sign' => -1,
           'debit' => true,
           'credit' => false,
-          'storno' => false
+          'storno' => false,
+          'reversal' => false,
+          'expected' => false,
         )
       end
     end

metadata

@@ -1,15 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: cmxl
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: '2.0'
 platform: ruby
 authors:
 - Michael Bumann
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-10 00:00:00.000000000 Z
+date: 2025-01-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rchardet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +93,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rchardet19
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Cmxl provides an friendly, extensible and customizable parser for the
   MT940 bank statement format.
 email:
@@ -102,9 +101,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.mdown
 - Gemfile
 - LICENSE.txt
@@ -198,8 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Cmxl is your friendly MT940 bank statement parser
 test_files:

data/.travis.yml

@@ -1,9 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4.10
-  - 2.5.8
-  - 2.6.6
-  - 2.7.1
-  - jruby-9.1.17.0
-  - jruby-9.2.11.1