ofx_kit 0.1.0 → 1.0.1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ofx_kit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Lucas Geron
@@ -65,6 +65,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.2.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -102,39 +116,48 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- lib/generators/ofx/eject_generator.rb
-- lib/generators/ofx/templates/ofx_mappings.yml
+- lib/generators/ofx_kit/eject_generator.rb
+- lib/generators/ofx_kit/templates/ofx_mappings.yml
 - lib/ofx_kit.rb
+- lib/ofx_kit/balance.rb
+- lib/ofx_kit/bank_account.rb
+- lib/ofx_kit/bank_statement.rb
 - lib/ofx_kit/base/account.rb
 - lib/ofx_kit/base/builder.rb
 - lib/ofx_kit/base/document.rb
 - lib/ofx_kit/base/entity.rb
 - lib/ofx_kit/base/statement.rb
-- lib/ofx_kit/configuration.rb
 - lib/ofx_kit/configuration/core.rb
 - lib/ofx_kit/configuration/date_parser.rb
 - lib/ofx_kit/configuration/mapping_applicator.rb
 - lib/ofx_kit/configuration/section_proxy.rb
-- lib/ofx_kit/domain/balance.rb
-- lib/ofx_kit/domain/bank_account.rb
-- lib/ofx_kit/domain/bank_statement.rb
-- lib/ofx_kit/domain/credit_card_account.rb
-- lib/ofx_kit/domain/credit_card_statement.rb
-- lib/ofx_kit/domain/transaction.rb
-- lib/ofx_kit/domain/transaction_collection.rb
-- lib/ofx_kit/errors.rb
+- lib/ofx_kit/credit_card_account.rb
+- lib/ofx_kit/credit_card_statement.rb
+- lib/ofx_kit/errors/configuration_error.rb
+- lib/ofx_kit/errors/encoding_error.rb
+- lib/ofx_kit/errors/error.rb
+- lib/ofx_kit/errors/invalid_body_error.rb
+- lib/ofx_kit/errors/invalid_header_error.rb
+- lib/ofx_kit/errors/multiple_statements_error.rb
+- lib/ofx_kit/errors/parse_error.rb
+- lib/ofx_kit/errors/unsupported_version_error.rb
 - lib/ofx_kit/mappings/core_mappings.yml
 - lib/ofx_kit/mappings/field_mappings.yml
 - lib/ofx_kit/parser.rb
 - lib/ofx_kit/tokenizer/base.rb
 - lib/ofx_kit/tokenizer/ofx1.rb
 - lib/ofx_kit/tokenizer/ofx2.rb
+- lib/ofx_kit/transaction.rb
+- lib/ofx_kit/transaction_collection.rb
 - lib/ofx_kit/version.rb
 homepage: https://github.com/lucasgeron/ofx_kit
 licenses:
 - MIT
 metadata:
+  homepage_uri: https://github.com/lucasgeron/ofx_kit
   source_code_uri: https://github.com/lucasgeron/ofx_kit
+  changelog_uri: https://lucasgeron.github.io/ofx_kit/CHANGELOG_md
+  documentation_uri: https://lucasgeron.github.io/ofx_kit/
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -143,7 +166,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.4'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/ofx_kit/configuration.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'configuration/core'
-require_relative 'configuration/section_proxy'
-require_relative 'configuration/date_parser'
-require_relative 'configuration/mapping_applicator'

data/lib/ofx_kit/domain/balance.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module OFX
-  # Represents the ledger balance of an account at a specific point in time.
-  class Balance < Base::Entity
-    attr_accessor :amount, :amount_cents, :posted_at
-
-    wired_by_builder :statement, :account
-  end
-end

data/lib/ofx_kit/domain/bank_account.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module OFX
-  # Represents a bank (checking or savings) account parsed from an OFX statement.
-  class BankAccount < Base::Account
-    attr_accessor :bank_id, :account_id, :account_type, :branch_id
-  end
-end

data/lib/ofx_kit/domain/transaction.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module OFX
-  # Represents a single financial transaction parsed from an OFX statement.
-  class Transaction < Base::Entity
-    attr_accessor :fit_id, :type, :posted_at, :occurred_at,
-                  :amount, :amount_cents,
-                  :name, :memo, :payee,
-                  :check_number, :ref_number, :sic
-
-    wired_by_builder :statement, :account
-  end
-end

data/lib/ofx_kit/domain/transaction_collection.rb

@@ -1,94 +0,0 @@
-# frozen_string_literal: true
-
-module OFX
-  # An +Enumerable+ collection of {Transaction} objects parsed from an OFX statement.
-  # Provides convenience filters for credits and debits.
-  class TransactionCollection
-    include Enumerable
-
-    # Placeholder overridden per-instance by {Base::Builder#wire} at build time.
-    def statement = nil
-
-    # @param transactions [Array<Transaction>] the list of transactions
-    def initialize(transactions)
-      @transactions = transactions
-    end
-
-    # Iterates over each transaction.
-    # @yieldparam transaction [Transaction]
-    def each(&)
-      @transactions.each(&)
-    end
-
-    # @return [Integer] number of transactions in the collection
-    def length
-      @transactions.length
-    end
-
-    # @return [TransactionCollection] a new collection containing only positive-amount transactions
-    def credits
-      sub = self.class.new(select { |t| t.amount.positive? })
-      # Propagate statement wiring so inferred_currency resolves to the correct
-      # account currency even when this sub-collection has no transactions.
-      if (stmt = statement)
-        sub.define_singleton_method(:statement) { stmt }
-      end
-      sub
-    end
-
-    # @return [TransactionCollection] a new collection containing only negative-amount transactions
-    def debits
-      sub = self.class.new(select { |t| t.amount.negative? })
-      # Same as credits — statement is the authoritative source of currency.
-      if (stmt = statement)
-        sub.define_singleton_method(:statement) { stmt }
-      end
-      sub
-    end
-
-    # @return [Money] sum of all positive transaction amounts
-    def total_credits
-      sum_amounts(credits)
-    end
-
-    # @return [Money] sum of all negative transaction amounts
-    def total_debits
-      sum_amounts(debits)
-    end
-
-    # @return [Money] net amount (credits + debits)
-    # @note This is NOT the account balance. It reflects only the transactions present in
-    #   the OFX file and ignores any accumulated prior balance (e.g. opening cash balance
-    #   or unpaid invoice from a previous period). Use {Balance} for the actual account balance.
-    def net
-      total_credits + total_debits
-    end
-
-    # @return [Array<Transaction>] a duplicate of the internal transactions array
-    def to_a
-      @transactions.dup
-    end
-
-    # @param other [TransactionCollection] collection to compare against
-    # @return [Boolean]
-    def ==(other)
-      @transactions == other.to_a
-    end
-
-    private
-
-    def currency
-      statement&.account&.currency
-    end
-
-    def inferred_currency
-      currency || OFX.config.default_currency
-    end
-
-    def sum_amounts(collection)
-      return Money.new(0, inferred_currency) if collection.none?
-
-      collection.map(&:amount).inject(:+)
-    end
-  end
-end

data/lib/ofx_kit/errors.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module OFX
-  # Base error class for all OFX-related exceptions.
-  class Error < StandardError; end
-
-  # Raised when the OFX file cannot be parsed.
-  class ParseError < Error; end
-
-  # Raised when the OFX file header is malformed or missing.
-  class InvalidHeaderError < ParseError; end
-
-  # Raised when the OFX file body cannot be parsed into a valid document.
-  class InvalidBodyError < ParseError; end
-
-  # Raised when the OFX version declared in the file is not supported.
-  class UnsupportedVersionError < Error
-    # @return [String] the unsupported version string found in the file
-    attr_reader :version
-
-    # @param version [String] the unsupported OFX version string
-    def initialize(version)
-      @version = version
-      super("Unsupported OFX version: #{version}")
-    end
-  end
-
-  # Raised when a character encoding error occurs while reading the OFX file.
-  class EncodingError < Error; end
-
-  # Raised when the library configuration is invalid or inconsistent.
-  class ConfigurationError < Error; end
-
-  # Raised when an operation requires a single statement but multiple were found.
-  class MultipleStatementsError < Error; end
-end