norma43_parser 1.0.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4efe95db38bc547fc36d8f649c83f65a90a078b2
-  data.tar.gz: 04d5b299d47f187c907aa2b15725a9adf96fe20b
+SHA256:
+  metadata.gz: 6ccff4e77819687eda82453ce15f9c206e748eacf51f691a56744483280bd884
+  data.tar.gz: e6fcfc73c153129b7039bf9d129cf03bceb4ef0fd3652d49cf1a11cfac551a80
 SHA512:
-  metadata.gz: 972ca63a8512c51a2dd6100cf5570d942bf39ed5bb4d97856231ece753a8dcf1de916505ac3019aa163c1fe581ea59a69256d9a3f9ea927354c13dc4338f0147
-  data.tar.gz: 4893dd41e41ccd78f47f63fa10007b989576be1826fad09f9eb017a3604667ebb3dc33ea5a7a2f0b047638eab360e7c42535029bfaa3c0e085bf110f93f20a31
+  metadata.gz: 4ab4404a3c79574525fe743e5d794b8db610ab64b4a9581c839ca1c58fa8b80084c321a4b1e4d4dbe836834d8083de6f28c228e0edd3ff615ef2af290d532583
+  data.tar.gz: 4558ce5f03fda4bda0d267163d5aea24a3b21c11afee7ed7acef0de6e9f2a96d22b781092ff660b714585358b1859963743a854bf9b6a079d7e7933ecd7f13b1

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,13 @@
+## Expected Behavior
+
+## Actual Behavior
+
+## Steps to Reproduce the Problem
+
+1.
+
+## Specifications
+
+- Version:
+- Platform:
+- Subsystem:

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,5 @@
+Fixes #
+
+## Proposed Changes
+
+-

data/.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: Ruby CI
+
+on: [ pull_request, push ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ["3.0", "2.7", "2.6", "jruby-head"]
+
+    steps:
+      - uses: actions/checkout@v2
+      - 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 rspec

data/.rubocop.yml

@@ -0,0 +1,234 @@
+require:
+  - rubocop-performance
+
+AllCops:
+  TargetRubyVersion: 2.4
+  # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
+  # to ignore them, so only the ones explicitly set in this file are enabled.
+  DisabledByDefault: true
+  Exclude:
+    - "**/tmp/**/*"
+    - "**/templates/**/*"
+    - "**/vendor/**/*"
+
+Performance:
+  Exclude:
+    - "**/test/**/*"
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+# Align `when` with `case`.
+Layout/CaseIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/ElseAlignment:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+  AutoCorrect: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+Layout/EmptyLinesAroundAccessModifier:
+  Enabled: true
+  EnforcedStyle: only_before
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+
+Layout/IndentFirstArgument:
+  Enabled: true
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: indented_internal_methods
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/LeadingCommentSpace:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAfterSemicolon:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceBeforeComma:
+  Enabled: true
+
+Layout/SpaceBeforeComment:
+  Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+  Enabled: true
+
+Style/DefWithParentheses:
+  Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+  Exclude:
+    - "actionview/test/**/*.builder"
+    - "actionview/test/**/*.ruby"
+    - "actionpack/test/**/*.builder"
+    - "actionpack/test/**/*.ruby"
+    - "activestorage/db/migrate/**/*.rb"
+    - "activestorage/db/update_migrate/**/*.rb"
+    - "actionmailbox/db/migrate/**/*.rb"
+    - "actiontext/db/migrate/**/*.rb"
+
+Style/RedundantFreeze:
+  Enabled: true
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+  EnforcedStyleForEmptyBraces: space
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+# Detect hard tabs, no hard tabs.
+Layout/Tab:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Layout/TrailingBlankLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: true
+
+# Use quotes for string literals when they are enough.
+Style/UnneededPercentQ:
+  Enabled: true
+
+Lint/AmbiguousOperator:
+  Enabled: true
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: true
+
+Lint/ErbNewArguments:
+  Enabled: true
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true
+
+Lint/ShadowingOuterLocalVariable:
+  Enabled: true
+
+Lint/StringConversionInInterpolation:
+  Enabled: true
+
+Lint/UriEscapeUnescape:
+  Enabled: true
+
+Lint/UselessAssignment:
+  Enabled: true
+
+Lint/DeprecatedClassMethods:
+  Enabled: true
+
+Style/ParenthesesAroundCondition:
+  Enabled: true
+
+Style/RedundantBegin:
+  Enabled: true
+
+Style/RedundantReturn:
+  Enabled: true
+  AllowMultipleReturnValues: true
+
+Style/Semicolon:
+  Enabled: true
+  AllowAsExpressionSeparator: true
+
+# Prefer Foo.method over Foo::method
+Style/ColonMethodCall:
+  Enabled: true
+
+Style/TrivialAccessors:
+  Enabled: true
+
+Performance/FlatMap:
+  Enabled: true
+
+Performance/RedundantMerge:
+  Enabled: true
+
+Performance/StartWith:
+  Enabled: true
+
+Performance/EndWith:
+  Enabled: true
+
+Performance/RegexpMatch:
+  Enabled: true
+
+Performance/ReverseEach:
+  Enabled: true
+
+Performance/UnfreezeString:
+  Enabled: true

data/CHANGELOG.md

@@ -0,0 +1,43 @@
+## 3.0.0 (2021-12-15)
+
+### Breaking Changes
+
+- Drop Ruby support below 2.6.
+
+### Bug fixes
+
+-
+
+### Enhancements
+
+-
+
+## 2.1.1 (2020-03-13)
+
+### Breaking Changes
+
+-
+
+### Bug fixes
+
+-
+
+### Enhancements
+
+- Update rake requirement from ~> 10.0 to ~> 13.0 (#6)
+
+## 2.0.0 (2019-10-17)
+
+### Breaking Changes
+
+- Drop Ruby support below 2.4.
+
+### Bug fixes
+
+-
+
+### Enhancements
+
+- Clean up dependencies
+
+## 1.0.1 (2016-02-16)

data/Gemfile

@@ -1,4 +1,10 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
-gem "codeclimate-test-reporter", group: :test, require: nil
+group :development, :test do
+  gem "rubocop", ">= 0.75", require: false
+  gem "rubocop-performance", require: false
+end
+
 gemspec

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    norma43_parser (3.0.0)
+      virtus (~> 1.0)
+      zeitwerk (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    equalizer (0.0.11)
+    ice_nine (0.11.2)
+    jaro_winkler (1.5.3)
+    parallel (1.18.0)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.75.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.5.0)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    thread_safe (0.3.6)
+    unicode-display_width (1.6.0)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+    zeitwerk (2.5.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  norma43_parser!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (>= 0.75)
+  rubocop-performance
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -1,20 +1,22 @@
 # Norma43 file parser
 
-Norma43 is the standard format file to extract bank transactions from the SEPA (Single euro payments area), format details and content is described in the [Norma43 format](https://github.com/sequra/norma43_parser/blob/master/doc/cuaderno_43_-_junio_2012.pdf). 
+[![Gem Version](https://badge.fury.io/rb/norma43_parser.svg)](https://badge.fury.io/rb/norma43_parser)
+
+Norma43 is the standard format file to extract bank transactions from the SEPA (Single euro payments area), format details and content is described in the [Norma43 format](https://github.com/sequra/norma43_parser/blob/master/doc/cuaderno_43_-_junio_2012.pdf).
 
 ## Usage
 
 Include it in your Gemfile
+
 ```
 gem 'norma43_parser', git: "git@github.com:sequra/norma43_parser.git"
 ```
 
-
 ```ruby
 require "norma43"
 
 norma43_file_contents = File.open("path_to_file.n43", encoding: "iso-8859-1")
-document = norma43.parse norma43_file_contents
+document = Norma43.parse norma43_file_contents
 ```
 
 ### Document
@@ -25,7 +27,7 @@ The parser returns a Norma43 Document that may include multiple accounts.
 accounts=[account1..accountN]
 ```
 
-### Account 
+### Account
 
 The account object has all the information described in the standard format and the transactions between **start_date** and **end_date**.
 

data/Rakefile

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"

data/lib/norma43/line_handlers.rb

@@ -1,5 +1,4 @@
-require "norma43/line_parsers/line_parsers"
-require "norma43/line_processors"
+# frozen_string_literal: true
 
 module Norma43
   module LineHandlers
@@ -44,7 +43,7 @@ module Norma43
     end
 
     Handler = Struct.new :parser, :processor do
-      def process line, contexts
+      def process(line, contexts)
         line_parser = self.parser.new(line)
 
         processor.call line_parser, contexts

data/lib/norma43/line_parsers/account_end.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Norma43
+  module LineParsers
+    class AccountEnd < LineParser
+      field :bank_code, 2..5, :integer
+      field :branch_code, 6..9, :integer
+      field :account_number, 10..19, :integer
+      field :debit_entries, 20..24, :integer
+      field :debit_amount, 25..38, :integer
+      field :credit_entries, 39..43, :integer
+      field :credit_amount, 44..57, :integer
+      field :balance_code, 58, :integer
+      field :balance_amount, 59..72, :integer
+      field :currency_code, 73..75, :integer
+    end
+  end
+end

data/lib/norma43/line_parsers/account_start.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Norma43
+  module LineParsers
+    class AccountStart < LineParser
+      field :bank_code, 2..5, :integer
+      field :branch_code, 6..9, :integer
+      field :account_number, 10..19, :integer
+      field :start_date, 20..25, :date
+      field :end_date, 26..31, :date
+      field :balance_code, 32, :integer
+      field :balance_amount, 33..46, :integer
+      field :currency_code, 47..49, :integer
+      field :information_mode_code, 50, :integer
+      field :abbreviated_name, 51..76
+    end
+  end
+end

data/lib/norma43/line_parsers/additional_currency.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Norma43
+  module LineParsers
+    class AdditionalCurrency < LineParser
+      field :data_code, 2..3, :integer
+      field :currency_code, 4..6, :integer
+      field :amount, 7..20, :integer
+      field :free, 21..79
+    end
+  end
+end

data/lib/norma43/line_parsers/additional_item.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Norma43
+  module LineParsers
+    class AdditionalItem < LineParser
+      field :data_code, 2..3, :integer
+      field :item_1, 4..41
+      field :item_2, 42..79
+    end
+  end
+end

data/lib/norma43/line_parsers/document_end.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Norma43
+  module LineParsers
+    class DocumentEnd < LineParser
+      field :record_number, 20..25, :integer
+    end
+  end
+end

data/lib/norma43/line_parsers/document_start.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Norma43
+  module LineParsers
+    class DocumentStart < LineParser
+      field :id, 2..13
+      field :created_at, 14..33, :time
+      field :delivery_number, 34..35, :integer
+      field :file_type, 36..38
+      field :name, 39..48
+    end
+  end
+end

data/lib/norma43/line_parsers/file_format_validator.rb

@@ -1,19 +1,22 @@
-require "norma43/line_parsers/line_parser"
+# frozen_string_literal: true
+
 module Norma43
-  class FileFormatValidator < LineParser
-    field :record_type, 0..1, :raw
-    field :file_type, 36..38
+  module LineParsers
+    class FileFormatValidator < LineParser
+      field :record_type, 0..1, :raw
+      field :file_type, 36..38
 
-    def has_document?; file_type=="00" end
+      def has_document?; file_type == "00" end
 
-    def valid?
-      errors.empty?
-    end
+      def valid?
+        errors.empty?
+      end
 
-    def errors
-      errors = []
-      %w(11 00).include? record_type or errors << "Must start with 00 (was ”#{record_type}”)"
-      errors
+      def errors
+        errors = []
+        %w(11 00).include?(record_type) || errors << ("Must start with 00 (was ”#{record_type}”)")
+        errors
+      end
     end
   end
 end

data/lib/norma43/line_parsers/line_parser.rb

@@ -1,42 +1,43 @@
-require "norma43/utils/typecaster"
+# frozen_string_literal: true
 
 module Norma43
-  class LineParser
-    attr_reader :line
-    def initialize line
-      @line = line
-    end
+  module LineParsers
+    class LineParser
+      attr_reader :line
+      def initialize(line)
+        @line = line
+      end
 
-    def attributes
-      self.class.field_names.each_with_object({}) do |field, attrs|
-        attrs[field] = self.public_send(field)
+      def attributes
+        self.class.field_names.each_with_object({}) do |field, attrs|
+          attrs[field] = self.public_send(field)
+        end
       end
-    end
 
-    def self.field name, range, type = :string
-      self.field_names.push name
+      def self.field(name, range, type = :string)
+        self.field_names.push name
 
-      define_method name do
-        if range.is_a?(Array) # let multivalued attribute
-          range.map { |r| value_at_position(r, type) }.compact
-        else
-          value_at_position range, type
+        define_method name do
+          if range.is_a?(Array) # let multivalued attribute
+            range.map { |r| value_at_position(r, type) }.compact
+          else
+            value_at_position range, type
+          end
         end
       end
-    end
-
-    private
 
-    def self.field_names
-      @field_names ||= []
-    end
+      private
+        def self.field_names
+          @field_names ||= []
+        end
 
-    def value_at_position range, type
-      typecast line[range].to_s.strip, type
-    end
+        def value_at_position(range, type)
+          typecast line[range].to_s.strip, type
+        end
 
-    def typecast value, type
-      Typecaster.cast value, type
+        def typecast(value, type)
+          Norma43::Utils::Typecaster.cast value, type
+        end
     end
   end
 end

data/lib/norma43/line_parsers/transaction.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Norma43
+  module LineParsers
+    class Transaction < LineParser
+      field :origin_branch_code, 6..9, :integer
+      field :transaction_date, 10..15, :date
+      field :value_date, 16..21, :date
+      field :shared_item, 22..23, :integer
+      field :own_item, 24..26, :integer
+      field :amount_code, 27, :integer
+      field :amount, 28..41, :integer
+      field :document_number, 42..51, :integer
+      field :reference_1, 52..63, :integer
+      field :reference_2, 64..79
+    end
+  end
+end