norma43_parser 2.1.1 → 3.1.0

data/lib/norma43/models.rb

@@ -1,86 +1,8 @@
 # frozen_string_literal: true
 
-require "virtus"
-
 module Norma43
   module Models
-    # forward declarations
-    class Account; end
-    class Transaction; end
-    class AdditionalItem; end
-    class AdditionalCurrency; end
     DEBIT_CODE = 1
     CREDIT_CODE = 2
-
-    class Document
-      include Virtus.model
-
-      attribute :id
-      attribute :created_at
-      attribute :delivery_number
-      attribute :file_type
-      attribute :name
-      attribute :number_of_lines
-      attribute :accounts, Array[Account]
-
-      def transaction_date
-        accounts.map(&:date).compact.first
-      end
-    end
-
-    class Account
-      include Virtus.model
-
-      attribute :bank_code
-      attribute :branch_code
-      attribute :account_number
-      attribute :start_date
-      attribute :end_date
-      attribute :balance_code
-      attribute :balance_amount
-      attribute :currency_code
-      attribute :information_mode_code
-      attribute :abbreviated_name
-      attribute :debit_entries
-      attribute :debit_amount
-      attribute :credit_entries
-      attribute :credit_amount
-      attribute :transactions, Array[Transaction]
-    end
-
-    class Transaction
-      include Virtus.model
-
-      attribute :origin_branch_code
-      attribute :transaction_date
-      attribute :value_date
-      attribute :shared_item
-      attribute :own_item
-      attribute :amount_code
-      attribute :amount
-      attribute :document_number
-      attribute :reference_1
-      attribute :reference_2
-      attribute :additional_items, Array[AdditionalItem]
-      attribute :additional_currency, AdditionalCurrency
-      def debit?; self.amount_code == DEBIT_CODE end
-    end
-
-    class AdditionalItem
-      include Virtus.model
-
-      attribute :data_code
-      attribute :item_1
-      attribute :item_2
-    end
-
-    class AdditionalCurrency
-      include Virtus.model
-
-      attribute :data_code
-      attribute :currency_code
-      attribute :amount
-      attribute :free
-    end
   end
 end

data/lib/norma43/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Norma43
-  VERSION = "2.1.1"
+  VERSION = "3.1.0"
 end

data/norma43_parser.gemspec

@@ -13,17 +13,14 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/sequra/norma43_parser"
   spec.license       = "MIT"
 
-  spec.required_ruby_version = "~> 2.4"
+  spec.required_ruby_version = ">= 3.0"
 
   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_runtime_dependency "virtus",   "~> 1.0"
   spec.add_runtime_dependency "zeitwerk", "~> 2.0"
 
-  spec.add_development_dependency "bundler", "~> 1.0"
-  spec.add_development_dependency "rake",    "~> 13.0"
-  spec.add_development_dependency "rspec",   "~> 3.0"
+  spec.add_development_dependency "rake",  "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.9"
 end

data/spec/example1_parse_spec.rb

@@ -26,7 +26,7 @@ RSpec.describe Norma43 do
           "end_date"              => Date.parse("2004-09-05"),
           "currency_code"         => 1,
           "information_mode_code" => 3,
-          "abbreviated_name"      => "MY ACCOUNT"
+          "abbreviated_name"      => "MY ACCOUNT",
         )
       end
 

data/spec/norma43/line_processors/account_end_spec.rb

@@ -3,10 +3,7 @@
 module Norma43
   module LineProcessors
     RSpec.describe AccountEnd do
-      let :line do
-        double "Line", attributes: {}
-      end
-
+      let(:line) { instance_double(LineParsers::AccountEnd, attributes: {}) } 
       let(:account) { Norma43::Models::Account.new }
       let(:contexts) { Norma43::Utils::Contexts.new(
         [

data/spec/norma43/line_processors/account_start_spec.rb

@@ -2,8 +2,8 @@
 
 module Norma43
   module LineProcessors
-    RSpec.describe "AccountStart" do
-      let(:line) { double "Line", attributes: {} }
+    RSpec.describe AccountStart do
+      let(:line) { instance_double(LineParsers::AccountStart, attributes: {}) }
       let(:document) { Norma43::Models::Document.new }
       let(:contexts) { Norma43::Utils::Contexts.new }
 
@@ -20,7 +20,7 @@ module Norma43
       end
 
       context "when AccountStart is called" do
-        let(:fake_account) { double "Norma43::Models::Account" }
+        let(:fake_account) { instance_double(Norma43::Models::Account) }
         before do
           allow(Norma43::Models::Account).to receive(:new) { fake_account }
         end

data/spec/norma43/line_processors/additional_currency_spec.rb

@@ -2,8 +2,8 @@
 
 module Norma43
   module LineProcessors
-    RSpec.describe "AdditionalCurrency" do
-      let(:line) { double "Line", attributes: {} }
+    RSpec.describe AdditionalCurrency do
+      let(:line) { instance_double(LineParsers::AdditionalCurrency, attributes: {}) }
       let(:transaction) { Norma43::Models::Transaction.new }
       let(:contexts) { Norma43::Utils::Contexts.new(
         [
@@ -22,7 +22,7 @@ module Norma43
       end
 
       context "when AdditionalCurrency is called" do
-        let(:fake_additional_currency) { double "Models::AdditionalCurrency" }
+        let(:fake_additional_currency) { instance_double(Models::AdditionalCurrency) }
         before do
           allow(Models::AdditionalCurrency).to receive(:new) { fake_additional_currency }
         end

data/spec/norma43/line_processors/{additional_items_spec.rb → additional_item_spec.rb}

@@ -2,8 +2,8 @@
 
 module Norma43
   module LineProcessors
-    RSpec.describe "AdditionalItems" do
-      let(:line) { double "Line", attributes: {} }
+    RSpec.describe AdditionalItem do
+      let(:line) { instance_double(LineParsers::AdditionalItem, attributes: {}) }
       let(:transaction) { Norma43::Models::Transaction.new }
       let(:contexts) { Norma43::Utils::Contexts.new(
         [
@@ -22,7 +22,7 @@ module Norma43
       end
 
       context "when AdditionalItem is called" do
-        let(:fake_additional_item) { double "Models::AdditionalItem" }
+        let(:fake_additional_item) { instance_double(Models::AdditionalItem) }
         before do
           allow(Models::AdditionalItem).to receive(:new) { fake_additional_item }
         end

data/spec/norma43/line_processors/document_end_spec.rb

@@ -2,15 +2,12 @@
 
 module Norma43
   module LineProcessors
-    RSpec.describe "DocumentEnd" do
-      class Thing
-      end
-
-      let(:line) { double "Line", record_number: 35 }
+    RSpec.describe DocumentEnd do
+      let(:line) { instance_double(LineParsers::DocumentEnd, record_number: 35) }
 
       it "moves to the nearest document context" do
         document = Norma43::Models::Document.new
-        contexts = Norma43::Utils::Contexts.new [Thing.new, document, Thing.new, Thing.new]
+        contexts = Norma43::Utils::Contexts.new [anything, document, anything, anything]
 
         DocumentEnd.call line, contexts
 

data/spec/norma43/line_processors/document_start_spec.rb

@@ -2,8 +2,8 @@
 
 module Norma43
   module LineProcessors
-    RSpec.describe "DocumentStart" do
-      let (:line) { double "Line", attributes: {} }
+    RSpec.describe DocumentStart do
+      let(:line) { instance_double(LineParsers::DocumentStart, attributes: {}) }
 
       it "instantiates a new document with the line attributes" do
         allow(Models::Document).to receive :new
@@ -14,7 +14,7 @@ module Norma43
       end
 
       it "sets the document as the current context" do
-        fake_document = double "Models::Document"
+        fake_document = instance_double(Models::Document)
         allow(Models::Document).to receive(:new) { fake_document }
 
         contexts = DocumentStart.call line, Norma43::Utils::Contexts.new

data/spec/norma43/line_processors/transaction_spec.rb

@@ -2,8 +2,8 @@
 
 module Norma43
   module LineProcessors
-    RSpec.describe "Transaction" do
-      let(:line) { double "Line", attributes: {} }
+    RSpec.describe Transaction do
+      let(:line) { instance_double(LineParsers::Transaction, attributes: {}) }
       let(:account) { Norma43::Models::Account.new }
       let(:contexts) { Norma43::Utils::Contexts.new(
         [
@@ -22,7 +22,7 @@ module Norma43
       end
 
       context "when Transaction is called" do
-        let(:fake_transaction) { double "Models::Transaction" }
+        let(:fake_transaction) { instance_double(Models::Transaction) }
         before do
           allow(Models::Transaction).to receive(:new) { fake_transaction }
         end

data/spec/norma43/models/account/spanish_iban_spec.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module Norma43
+  module Models
+    class Account
+      RSpec.describe SpanishIban do
+        def build_account(**attributes)
+          instance_double(Account, **attributes)
+        end
+
+        describe ".from_account" do
+          subject(:iban) { described_class.from_account(account) }
+
+          context "with the example in the documentation" do
+            let(:account) { build_account(bank_code: 81, branch_code: 54, account_number: 1234567) }
+            it { is_expected.to eq("ES5400810054180001234567") }
+          end
+
+          context "with the account from the example1.n43 fixture" do
+            let(:account) {
+              file.seek 2
+              bank_code = file.read(4).to_i
+              branch_code = file.read(4).to_i
+              account_number = file.read(10).to_i
+
+              build_account(bank_code: bank_code, branch_code: branch_code, account_number: account_number)
+            }
+            let(:file) { File.open(File.join(__dir__, "../../../fixtures/example1.n43"), encoding: "iso-8859-1") }
+
+            it { is_expected.to eq("ES1799991111710123456789") }
+
+            after { file.close }
+          end
+
+          context "with minimal edge-case" do
+            let(:account) { build_account(bank_code: 3, branch_code: 0, account_number: 0) }
+            it { is_expected.to eq("ES8700030000300000000000") }
+          end
+
+          context "with extreme edge-case" do
+            let(:account) { build_account(bank_code: 9000, branch_code: 9999, account_number: 9999999999) }
+            it { is_expected.to eq("ES3790009999309999999999") }
+          end
+        end
+
+        describe "#to_s" do
+          subject { described_class.new(bank_code: 0, branch_code: 0, account_number: 0) }
+
+          it { is_expected.to(respond_to(:to_s)) }
+
+          context "with incorrect account values" do
+            subject { described_class.new(bank_code: bank_code, branch_code: branch_code, account_number: account_number).to_s }
+
+            let(:bank_code) { 9999 }
+            let(:branch_code) { 1111 }
+            let(:account_number) { 123456789 }
+
+            context "with missing bank code" do
+              let(:bank_code) { nil }
+              it { is_expected.to be_empty }
+            end
+
+            context "with missing branch code" do
+              let(:branch_code) { nil }
+              it { is_expected.to be_empty }
+            end
+
+            context "with missing account number" do
+              let(:account_number) { nil }
+              it { is_expected.to be_empty }
+            end
+
+            context "with negative bank code" do
+              let(:bank_code) { -3 }
+              it { is_expected.to be_empty }
+            end
+
+            context "with negative branch code" do
+              let(:bank_code) { -1 }
+              it { is_expected.to be_empty }
+            end
+
+            context "with negative account number" do
+              let(:account_number) { -123456789 }
+              it { is_expected.to be_empty }
+            end
+
+            context "with more than 4 digits in the bank code" do
+              let(:bank_code) { 99990 }
+              it { is_expected.to be_empty }
+            end
+
+            context "with more than 4 digits in the branch code" do
+              let(:bank_code) { 11110 }
+              it { is_expected.to be_empty }
+            end
+
+            context "with more than 10 digits in the account number" do
+              let(:account_number) { 12345678900 }
+              it { is_expected.to be_empty }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/norma43/models/account_spec.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Norma43
+  module Models
+    RSpec.describe Account do
+      it_behaves_like "a model"
+
+      describe "#iban" do
+        it { is_expected.to respond_to(:iban) }
+
+        context "with the example in the documentation" do
+          it "returns the correct IBAN string" do
+            account = subject
+            account.account_number = 1234567
+            account.bank_code = 81
+            account.branch_code = 54
+
+            expect(account.iban).to eq("ES5400810054180001234567")
+          end
+        end
+
+        context "with missing bank data" do
+          subject { described_class.new.iban }
+          it { is_expected.to be_nil }
+        end
+
+        context "with missing bank code" do
+          subject { described_class.new(bank_code: nil, branch_code: 1234, account_number: 1234).iban }
+          it { is_expected.to be_nil }
+        end
+
+        context "with missing branch code" do
+          subject { described_class.new(bank_code: 1234, branch_code: nil, account_number: 1234).iban }
+          it { is_expected.to be_nil }
+        end
+
+        context "with missing account number" do
+          subject { described_class.new(bank_code: 1234, branch_code: 1234, account_number: nil).iban }
+          it { is_expected.to be_nil }
+        end
+
+        context "with negative account number" do
+          subject { described_class.new(bank_code: 1234, branch_code: 1234, account_number: -1234).iban }
+          it { is_expected.to be_nil }
+        end
+
+        context "with an account number which is too large" do
+          subject { described_class.new(bank_code: 1234, branch_code: 1234, account_number: 1*10**10).iban }
+          it { is_expected.to be_nil }
+        end
+      end
+    end
+  end
+end

data/spec/norma43/models/document_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Norma43
+  module Models
+    RSpec.describe Document do
+      it_behaves_like "a model"
+
+      describe "#transaction_date" do
+        it { is_expected.to respond_to(:transaction_date) }
+
+        context "when there are no accounts" do
+          subject(:document) { described_class.new({ accounts: [] }) }
+
+          it { expect(document.transaction_date).to be_nil }
+        end
+
+        context "when there are accounts" do
+          subject(:document) { described_class.new({ accounts: [account] }) }
+
+          let(:account) {
+            Account.new(transactions: [
+              nil,
+              Transaction.new(transaction_date: nil),
+              Transaction.new(transaction_date: Date.parse("2024-01-23")),
+            ])
+          }
+
+          it "returns the date of the first account with a transaction date" do
+            expect(document.transaction_date).to eq(Date.parse("2024-01-23"))
+          end
+        end
+      end
+    end
+  end
+end

data/spec/norma43/models/transaction_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Norma43
+  module Models
+    RSpec.describe Transaction do
+      it_behaves_like "a model"
+
+      describe "#debit?" do
+        it { is_expected.to respond_to(:debit?) }
+
+        context "when amount code is code for debits" do
+          subject(:transaction) { described_class.new(amount_code: 1) }
+
+          it { expect(transaction.debit?).to be_truthy }
+        end
+
+        context "when amount code is code for credits" do
+          subject(:transaction) { described_class.new(amount_code: 2) }
+
+          it { expect(transaction.debit?).to be_falsey }
+        end
+      end
+    end
+  end
+end

data/spec/norma43_spec.rb

@@ -6,7 +6,7 @@ RSpec.describe Norma43 do
   describe "#parse" do
     it "returns the parser results" do
       text = "some total-in text"
-      parser = double "Parser", result: "result"
+      parser = instance_double(Norma43::Parser, result: "result")
       expect(Norma43::Parser).to receive(:new).with(text) { parser }
 
       expect(Norma43.parse(text)).to eq "result"

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "norma43"
+
 RSpec.configure do |config|
   config.order = :random
   Kernel.srand config.seed
@@ -11,6 +13,7 @@ RSpec.configure do |config|
   config.mock_with :rspec do |mocks|
     mocks.syntax = :expect
     mocks.verify_partial_doubles = true
+    mocks.verify_doubled_constant_names = true
   end
 end
 

data/spec/support/shared_examples_for_models.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples "a model" do
+  it { is_expected.to respond_to(:attributes) }
+  it { is_expected.to respond_to(:attributes=) }
+  it { is_expected.to respond_to(:to_h) }
+  it { is_expected.to respond_to(:to_hash) }
+
+  describe "#new" do
+    subject(:model) { described_class.new(attributes) }
+
+    context "when instantiated with an empty hash" do
+      let(:attributes) { {} }
+
+      it "accepts it without failing" do
+        expect { model }.not_to raise_error
+      end
+    end
+  end
+
+  describe "#attributes" do
+    subject { described_class.new.attributes }
+
+    it { is_expected.not_to be_empty }
+    it { is_expected.to respond_to(:each_pair) }
+    it { is_expected.to respond_to(:to_h) }
+    it { is_expected.to respond_to(:to_hash) }
+    it { is_expected.to respond_to(:keys) }
+
+    describe "#attributes.keys" do
+      subject { super().keys }
+
+      it { is_expected.not_to be_empty }
+      it { is_expected.to all(be_a(Symbol)) }
+    end
+  end
+
+  describe "#attributes=" do
+    subject { described_class.new.attributes=(attributes) }
+
+    context "when passed an empty hash" do
+      let(:attributes) { {} }
+
+      it "accepts it without failing" do
+        expect { subject }.not_to raise_error
+      end
+    end
+
+    context "when passed a hash with unknown attribute names" do
+      let(:attributes) { { potato: nil } }
+
+      it "accepts it without failing" do
+        expect { subject }.not_to raise_error
+      end
+
+      it "does not set any new method" do
+        expect { subject.potato }.to raise_error(NoMethodError, /undefined method.+potato/i)
+      end
+    end
+  end
+end