norma43_parser 1.0.1 → 3.0.0

data/lib/norma43/line_processors.rb

@@ -1,4 +1,5 @@
-require "norma43/models"
+# frozen_string_literal: true
+
 module Norma43
   module LineProcessors
     DocumentStart = ->(line, contexts) {
@@ -55,6 +56,5 @@ module Norma43
       contexts.current.additional_currency = additional_currency
       contexts
     }
-
   end
 end

data/lib/norma43/models.rb

@@ -1,9 +1,10 @@
-require "norma43/utils/string_helpers"
-require 'virtus'
+# frozen_string_literal: true
+
+require "virtus"
 
 module Norma43
   module Models
-    #forward declarations
+    # forward declarations
     class Account; end
     class Transaction; end
     class AdditionalItem; end
@@ -62,7 +63,7 @@ module Norma43
       attribute :reference_2
       attribute :additional_items, Array[AdditionalItem]
       attribute :additional_currency, AdditionalCurrency
-      def debit?; self.amount_code==DEBIT_CODE end
+      def debit?; self.amount_code == DEBIT_CODE end
     end
 
     class AdditionalItem

data/lib/norma43/parser.rb

@@ -1,25 +1,23 @@
-require "norma43/line_parsers/file_format_validator"
-require "norma43/line_handlers"
-require "norma43/utils/contexts"
+# frozen_string_literal: true
 
 module Norma43
-  class InvalidFileFormatError < ArgumentError; end;
+  class InvalidFileFormatError < ArgumentError; end
 
   class Parser
     attr_reader :file
 
     # Parser.new accepts a File instance or a String
     # A InvalidFileFormatError will be raised if file isn't in the Norma43 format
-    def initialize file
+    def initialize(file)
       @file = file
       validator = validate_file_format
       @contexts = if validator.has_document?
-        Contexts.new
+        Norma43::Utils::Contexts.new
       else
         # in theory Norma43 says that files should start with DocumentStart but
         # practically doesn't happen, so that we create one artificially
         # to avoid corner cases in the processors
-        Contexts.new().tap { |ctx| ctx.add Models::Document.new }
+        Norma43::Utils::Contexts.new().tap { |ctx| ctx.add Models::Document.new }
       end
     end
 
@@ -28,52 +26,50 @@ module Norma43
     end
 
     protected
-
-    def lines
-      @lines ||= file.each_line
-    end
+      def lines
+        @lines ||= file.each_line
+      end
 
     private
+      def validate_file_format
+        validator = Norma43::LineParsers::FileFormatValidator.new first_line
+        raise InvalidFileFormatError.new(validator.errors.join(", ")) unless validator.valid?
+        validator
+      end
 
-    def validate_file_format
-      validator = FileFormatValidator.new first_line
-      raise InvalidFileFormatError.new(validator.errors.join(", ")) unless validator.valid?
-      validator
-    end
-
-    def parse_lines contexts
-      parse_lines parse_line(self.lines.next, contexts)
+      def parse_lines(contexts)
+        parse_lines parse_line(self.lines.next, contexts)
 
-    rescue StopIteration# because lines is an enumerator raises StopIteration on end
-      self.lines.rewind # Ensure we do not bomb out when calling result multiple times
-      contexts
-    end
+      rescue StopIteration # because lines is an enumerator raises StopIteration on end
+        self.lines.rewind # Ensure we do not bomb out when calling result multiple times
+        contexts
+      end
 
-    # Look up a matching handler for the line and process it
-    # The process method on a handler always returns a Contexts object
-    def parse_line line, contexts
-      line = line.encode Encoding::UTF_8 if encode_lines?
+      # Look up a matching handler for the line and process it
+      # The process method on a handler always returns a Contexts object
+      def parse_line(line, contexts)
+        line = line.encode Encoding::UTF_8 if encode_lines?
 
-      handler = handler_for_line line
+        handler = handler_for_line line
 
-      handler.process line, contexts
-    end
+        handler.process line, contexts
+      end
 
-    def handler_for_line line
-      LineHandlers.mapping.fetch line[0..1]
-    end
+      def handler_for_line(line)
+        LineHandlers.mapping.fetch line[0..1]
+      end
 
-    def encode_lines?
-      first_line.encoding != Encoding::UTF_8
-    end
+      def encode_lines?
+        first_line.encoding != Encoding::UTF_8
+      end
 
-    def first_line
-      @first_line ||= begin
-        line = self.lines.peek
-        self.lines.rewind # peek seems to move the pointer when file is an actual File object
+      def first_line
+        @first_line ||= begin
+          line = self.lines.peek
+          self.lines.rewind # peek seems to move the pointer when file is an actual File object
 
-        line
+          line
+        end
       end
-    end
   end
 end

data/lib/norma43/utils/contexts.rb

@@ -1,54 +1,57 @@
+# frozen_string_literal: true
+
 module Norma43
-  class Contexts
-    def initialize containers = nil
-      Array(containers).compact.each do |container|
-        add container
+  module Utils
+    class Contexts
+      def initialize(containers = nil)
+        Array(containers).compact.each do |container|
+          add container
+        end
       end
-    end
-
-    def result
-      contexts.first
-    end
 
-    def current
-      contexts.last
-    end
-
-    def add container
-      contexts.push container
-    end
+      def result
+        contexts.first
+      end
 
-    def move_up
-      contexts.pop
-    end
+      def current
+        contexts.last
+      end
 
-    def move_to container_class
-      until current.is_a?(container_class) or current.nil?
-        move_up
-      end if contexts.any?
-    end
+      def add(container)
+        contexts.push container
+      end
 
-    def move_to_or_add_to_parent container_class, parent_container_class
-      return self if current.is_a?(container_class)
+      def move_up
+        contexts.pop
+      end
 
-      until current.kind_of?(parent_container_class)
-        move_up
+      def move_to(container_class)
+        until current.is_a?(container_class) || current.nil?
+          move_up
+        end if contexts.any?
       end
 
-      entity = container_class.new
+      def move_to_or_add_to_parent(container_class, parent_container_class)
+        return self if current.is_a?(container_class)
 
-      setter_name = StringHelpers.underscore container_class.name.split("::").last
-      current.public_send "#{setter_name}=", entity
+        until current.kind_of?(parent_container_class)
+          move_up
+        end
 
-      add entity
+        entity = container_class.new
 
-      self
-    end
+        setter_name = StringHelpers.underscore container_class.name.split("::").last
+        current.public_send "#{setter_name}=", entity
 
-    private
+        add entity
+
+        self
+      end
 
-    def contexts
-      @contexts ||= []
+      private
+        def contexts
+          @contexts ||= []
+        end
     end
   end
 end

data/lib/norma43/utils/string_helpers.rb

@@ -1,10 +1,14 @@
+# frozen_string_literal: true
+
 module Norma43
-  module StringHelpers
-    def self.underscore word
-      word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
-      word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
-      word.tr!("-", "_")
-      word.downcase
+  module Utils
+    module StringHelpers
+      def self.underscore(word)
+        word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+        word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+        word.tr!("-", "_")
+        word.downcase
+      end
     end
   end
 end

data/lib/norma43/utils/typecaster.rb

@@ -1,19 +1,23 @@
+# frozen_string_literal: true
+
 require "time"
 
 module Norma43
-  module Typecaster
-    def self.cast value, type
-      casters.fetch(type).call(value) unless value == ""
-    end
+  module Utils
+    module Typecaster
+      def self.cast(value, type)
+        casters.fetch(type).call(value) unless value == ""
+      end
 
-    def self.casters
-      {
-        integer: ->(value) { value.to_i },
-        time: ->(value) { Time.strptime(value, "%Y%m%d%H%M%S%N") },
-        date: ->(value) { Date.strptime(value, "%y%m%d") },
-        string: ->(value) { value unless value.match(/\A0+\Z/) },
-        raw: ->(value) { value }
-      }
+      def self.casters
+        {
+          integer: ->(value) { value.to_i },
+          time: ->(value) { Time.strptime(value, "%Y%m%d%H%M%S%N") },
+          date: ->(value) { Date.strptime(value, "%y%m%d") },
+          string: ->(value) { value unless value.match?(/\A0+\Z/) },
+          raw: ->(value) { value }
+        }
+      end
     end
   end
 end

data/lib/norma43/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Norma43
-  VERSION = "1.0.1"
+  VERSION = "3.0.0"
 end

data/lib/norma43.rb

@@ -1,8 +1,14 @@
-require "norma43/version"
-require "norma43/parser"
+# frozen_string_literal: true
+
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup # ready!
 
 module Norma43
-  def self.parse text
+  def self.parse(text)
     Parser.new(text).result
   end
 end
+
+loader.eager_load

data/norma43_parser.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "norma43/version"
 
@@ -8,20 +9,19 @@ Gem::Specification.new do |spec|
   spec.version       = Norma43::VERSION
   spec.authors       = ["Sequra engineering"]
   spec.email         = ["dev@sequra.es"]
-  spec.summary       = %q{Parses banks transactions files specified in rule 43}
+  spec.summary       = "Parses banks transactions files specified in rule 43"
   spec.homepage      = "https://github.com/sequra/norma43_parser"
   spec.license       = "MIT"
 
-  spec.required_ruby_version = "~> 2.0"
+  spec.required_ruby_version = ">= 2.6"
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "byebug"
-  spec.add_development_dependency "rspec"
-  spec.add_runtime_dependency "virtus"
+  spec.add_runtime_dependency "virtus",   "~> 1.0"
+  spec.add_runtime_dependency "zeitwerk", "~> 2.0"
+
+  spec.add_development_dependency "rake",    "~> 13.0"
+  spec.add_development_dependency "rspec",   "~> 3.0"
 end

data/spec/example1_parse_spec.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require "norma43"
 
 RSpec.describe Norma43 do
   describe "parse" do
-
     let(:document) do
-      file = File.open( File.join(__dir__, "fixtures/example1.n43"),
+      file = File.open(File.join(__dir__, "fixtures/example1.n43"),
                         encoding: "iso-8859-1")
       Norma43.parse file
     end
@@ -17,7 +18,7 @@ RSpec.describe Norma43 do
       let(:account) { document.accounts.first }
 
       it "stores expected attributes from AccountStart parser" do
-        expect(account).to have_attributes({
+        expect(account).to have_attributes(
           "bank_code"             => 9999,
           "branch_code"           => 1111,
           "account_number"        => 123456789,
@@ -26,18 +27,18 @@ RSpec.describe Norma43 do
           "currency_code"         => 1,
           "information_mode_code" => 3,
           "abbreviated_name"      => "MY ACCOUNT"
-        })
+        )
       end
 
       it "stores expected attributes from AccountEnd parser" do
-        expect(account).to have_attributes({
+        expect(account).to have_attributes(
           "balance_code"   => 2,
           "balance_amount" => 78889999999999,
           "debit_entries"  => 4,
           "debit_amount"   => 4936,
           "credit_entries" => 2,
           "credit_amount"  => 999999,
-        })
+        )
       end
 
       describe "transactions" do
@@ -48,7 +49,7 @@ RSpec.describe Norma43 do
         describe "first transaction" do
           let(:transaction) { account.transactions[0] }
           it "stores expected attributes" do
-            expect(transaction).to have_attributes({
+            expect(transaction).to have_attributes(
               "origin_branch_code" => 6700,
               "transaction_date"   => Date.parse("2004-04-08"),
               "value_date"         => Date.parse("2004-04-08"),
@@ -59,7 +60,7 @@ RSpec.describe Norma43 do
               "document_number"    => 0,
               "reference_1"        => 0,
               "reference_2"        => nil,
-            })
+            )
           end
         end
 
@@ -70,13 +71,13 @@ RSpec.describe Norma43 do
         end
 
         describe "first additional item" do
-          let(:additional_item) { account.transactions[0].additional_items[0]}
+          let(:additional_item) { account.transactions[0].additional_items[0] }
           it "stores expected attributes" do
-            expect(additional_item).to have_attributes({
+            expect(additional_item).to have_attributes(
               "data_code" => 1,
               "item_1"    => "XXXXXXXXX",
               "item_2"    => nil
-            })
+            )
           end
         end
 

data/spec/norma43/line_parsers/account_end_spec.rb

@@ -1,4 +1,4 @@
-require "norma43/line_parsers/line_parsers"
+# frozen_string_literal: true
 
 module Norma43
   module LineParsers

data/spec/norma43/line_parsers/account_start_spec.rb

@@ -1,4 +1,4 @@
-require "norma43/line_parsers/line_parsers"
+# frozen_string_literal: true
 
 module Norma43
   module LineParsers
@@ -49,7 +49,6 @@ module Norma43
       it "parses the abbreviated name" do
         expect(account_start.abbreviated_name).to eq "MY ACCOUNT"
       end
-
     end
   end
 end

data/spec/norma43/line_parsers/additional_currency_spec.rb

@@ -1,4 +1,4 @@
-require "norma43/line_parsers/line_parsers"
+# frozen_string_literal: true
 
 module Norma43
   module LineParsers

data/spec/norma43/line_parsers/additional_items_spec.rb

@@ -1,4 +1,4 @@
-require "norma43/line_parsers/line_parsers"
+# frozen_string_literal: true
 
 module Norma43
   module LineParsers

data/spec/norma43/line_parsers/document_end_spec.rb

@@ -1,4 +1,4 @@
-require "norma43/line_parsers/line_parsers"
+# frozen_string_literal: true
 
 module Norma43
   module LineParsers
@@ -10,7 +10,6 @@ module Norma43
       it "parses the record number" do
         expect(document_end.record_number).to eq 48
       end
-
     end
   end
 end

data/spec/norma43/line_parsers/document_start_spec.rb

@@ -1,4 +1,4 @@
-require "norma43/line_parsers/line_parsers"
+# frozen_string_literal: true
 
 module Norma43
   module LineParsers

data/spec/norma43/line_parsers/transaction_spec.rb

@@ -1,10 +1,9 @@
-require "norma43/line_parsers/line_parsers"
+# frozen_string_literal: true
 
 module Norma43
   module LineParsers
     RSpec.describe Transaction do
       let :transaction do
-
         Transaction.new "2256781127040805040805020092000000000012340000000000000000000000           REF 2"
       end
 
@@ -52,4 +51,3 @@ module Norma43
     end
   end
 end
-

data/spec/norma43/line_processors/account_end_spec.rb

@@ -1,19 +1,18 @@
-require "norma43/utils/contexts"
-require "norma43/line_processors"
+# frozen_string_literal: true
 
 module Norma43
   module LineProcessors
-    RSpec.describe "AccountEnd" do
+    RSpec.describe AccountEnd do
       let :line do
         double "Line", attributes: {}
       end
 
-      let(:account){ Models::Account.new }
-      let(:contexts){ Contexts.new(
+      let(:account) { Norma43::Models::Account.new }
+      let(:contexts) { Norma43::Utils::Contexts.new(
         [
-          Models::Document.new,
+          Norma43::Models::Document.new,
           account,
-          Models::Transaction.new
+          Norma43::Models::Transaction.new
         ])
       }
 
@@ -31,4 +30,3 @@ module Norma43
     end
   end
 end
-

data/spec/norma43/line_processors/account_start_spec.rb

@@ -1,29 +1,28 @@
-require "norma43/utils/contexts"
-require "norma43/line_processors"
+# frozen_string_literal: true
 
 module Norma43
   module LineProcessors
     RSpec.describe "AccountStart" do
-      let(:line){ double "Line", attributes: {} }
-      let(:document) { Models::Document.new }
-      let(:contexts){ Contexts.new}
+      let(:line) { double "Line", attributes: {} }
+      let(:document) { Norma43::Models::Document.new }
+      let(:contexts) { Norma43::Utils::Contexts.new }
 
       before do
         contexts.add document
       end
 
       it "instantiates a new account with the line attributes" do
-        allow(Models::Account).to receive :new
+        allow(Norma43::Models::Account).to receive :new
 
         AccountStart.call line, contexts
 
-        expect(Models::Account).to have_received(:new).with line.attributes
+        expect(Norma43::Models::Account).to have_received(:new).with line.attributes
       end
 
       context "when AccountStart is called" do
-        let(:fake_account) { double "Models::Account" }
+        let(:fake_account) { double "Norma43::Models::Account" }
         before do
-          allow(Models::Account).to receive(:new) { fake_account }
+          allow(Norma43::Models::Account).to receive(:new) { fake_account }
         end
         let!(:subject) { AccountStart.call line, contexts }
 

data/spec/norma43/line_processors/additional_currency_spec.rb

@@ -1,15 +1,14 @@
-require "norma43/utils/contexts"
-require "norma43/line_processors"
+# frozen_string_literal: true
 
 module Norma43
   module LineProcessors
     RSpec.describe "AdditionalCurrency" do
-      let(:line){ double "Line", attributes: {} }
-      let(:transaction){ Models::Transaction.new }
-      let(:contexts){ Contexts.new(
+      let(:line) { double "Line", attributes: {} }
+      let(:transaction) { Norma43::Models::Transaction.new }
+      let(:contexts) { Norma43::Utils::Contexts.new(
         [
-          Models::Document.new ,
-          Models::Account.new ,
+          Norma43::Models::Document.new,
+          Norma43::Models::Account.new,
           transaction
         ])
       }

data/spec/norma43/line_processors/additional_items_spec.rb

@@ -1,15 +1,14 @@
-require "norma43/utils/contexts"
-require "norma43/line_processors"
+# frozen_string_literal: true
 
 module Norma43
   module LineProcessors
     RSpec.describe "AdditionalItems" do
-      let(:line){ double "Line", attributes: {} }
-      let(:transaction){ Models::Transaction.new }
-      let(:contexts){ Contexts.new(
+      let(:line) { double "Line", attributes: {} }
+      let(:transaction) { Norma43::Models::Transaction.new }
+      let(:contexts) { Norma43::Utils::Contexts.new(
         [
-          Models::Document.new ,
-          Models::Account.new ,
+          Norma43::Models::Document.new,
+          Norma43::Models::Account.new,
           transaction
         ])
       }