Changelog
All notable changes to this project will be documented in this file.
[1.1.0] — 2026-06-04
Breaking changes
-
Rails generator
ofx_kit:ejectremoved in favour ofofx_kit:install -
YAML-based field mappings removed:
OFX::Configuration#load_mappingsand auto-loading ofconfig/initializers/ofx_mappings.ymlare no longer supported. Use a Ruby initializer instead.
OFX.configure { |c| c.section.map "TAG", to: "attr" }
-
Error classes moved into
OFX::Errornamespace and renamed for clarity:
| Before | After |
|---|---|
OFX::Errors::* (any subclass) |
OFX::Error::* |
OFX::ParseError |
OFX::Error::Parse |
OFX::InvalidHeaderError |
OFX::Error::InvalidHeader |
OFX::InvalidBodyError |
OFX::Error::InvalidBody |
OFX::UnsupportedVersionError |
OFX::Error::UnsupportedVersion |
OFX::EncodingError |
OFX::Error::UnsupportedEncoding |
OFX::ConfigurationError |
OFX::Error::InvalidConfiguration |
OFX::MultipleStatementsError |
OFX::Error::MultipleStatements |
rescue OFX::Error continues to catch all gem exceptions.
Added
-
Rails generator
ofx_kit:install— createsconfig/initializers/ofx_kit.rbwith all field mapping options and behavioral settings pre-written and commented, ready to uncomment and customize. -
Mapping the same XML key twice in an
OFX.configureblock now raisesOFX::Error::InvalidConfigurationinstead of silently overwriting the first mapping.
[1.0.2] — 2026-06-02
Changed
-
Replaced
homepage_uriwithsource_code_uriin gemspec for clarity
[1.0.1] — 2026-06-02
Added
-
/docsdirectory with generated API documentation from RDoc to GitHub Pages -
Updated README with instructions to generate docs locally and gem installation
[1.0.0] — 2026-06-02
Breaking changes
-
OFX::Configuration#default_currencyremoved — currency is always derived fromCURDEFin theOFXfile -
Rails generator renamed from
rails generate ofx:ejecttorails generate ofx_kit:eject -
Error classes split into individual files under
lib/ofx_kit/errors/; require paths changed accordingly
Changed
-
Documentation migrated from YARD (
@return/@param) to RDoc (##) throughout the codebase -
lib/ofx_kit/configuration.rbremoved — submodules (core,section_proxy, etc.) now loaded directly
Added
-
rdocRake task configured with README.md, CHANGELOG.md, andlib/**/*.rbas sources -
README section with instructions to generate API docs locally via
rake rdoc
[0.1.0] — 2026-06-01
Added
-
Parse
OFX1.x (SGML) andOFX2.x (XML) files viaOFX.new(path_or_io) -
OFX::BankAccountandOFX::CreditCardAccountdomain objects -
OFX::BankStatementandOFX::CreditCardStatementwithaccount,balance, andtransactions -
OFX::TransactionCollection—Enumerablewith.credits,.debits,.total_credits,.total_debits,.net -
OFX::Balancewithamount(Money),amount_cents, andposted_at -
Configurable field mappings via
OFX.configureandOFX.config -
OFX.configure { |c| c.transaction.map "TAG", to: :attr }for custom/renamed fields -
OFX.config.load_mappings("path/to/mappings.yml")for YAML-based configuration -
OFX.config.multi_statement_warningsflag to silence aggregation warnings -
Rails generator
rails generate ofx:ejectto copy default mappings into the app -
Auto-load of
config/initializers/ofx_mappings.ymlin Rails projects