mercury_banking 0.5.34

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 30960a19dc6f93e69961414fa8eaa97d39821b5143c1c68f745d95f73f71fe38
+  data.tar.gz: 67b8f43f1035cd73bb266a82c306844781973c0cb51dcd2a2c8b9ef02c764c71
+SHA512:
+  metadata.gz: 947d1a012d252ad361cd629216cf4376a7580b947975f0f776b1f58bce82eb7f7fb6eaa0c737a194e3eff552b6e0a864c0aa2d8a5d6a2dd0e9ea16ffe09613b5
+  data.tar.gz: 40e68e11df82741dfa756e43a8d58dc335a03b9582489dec803a40785cda0abc1a4b03ff440bc5a3bb49db35c7f66d0e8c8f19b5546ee0bb86adcc4073ab7563

data/.env_test

@@ -0,0 +1 @@
+API_KEY=YOUR_API_KEY

data/.gitignore

@@ -0,0 +1,24 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# mac settings
+.DS_Store
+
+# #transfer log files
+log
+.env
+log.csv
+.mercury-api-keys
+.mercury-configtags
+*.gem
+tags
+*.ledger

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+# Disable the rule that changes $? to $CHILD_STATUS
+Style/GlobalVars:
+  Enabled: true
+  Exclude:
+    - '**/*.rb'  # Exclude all Ruby files
+
+# Or alternatively, you can specifically allow $? while keeping other global var checks
+Style/SpecialGlobalVars:
+  Enabled: false  # This disables the rule that changes $? to $CHILD_STATUS
+
+# Allow slightly longer methods since we've already done significant refactoring
+Metrics/MethodLength:
+  Max: 25  # Default is 10, we're increasing it to 25 

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,90 @@
+# Changelog
+
+## [0.5.34] - 2025-03-10
+### Fixed
+- Added missing `thor` gem dependency to fix LoadError when running CLI commands
+
+## [0.5.33] - 2025-03-10
+### Added
+- Added `--verbose` option to `transactions_download` command to control output verbosity
+- Updated all export methods to conditionally display debug information based on the verbose flag
+- Default behavior is now less verbose, showing only essential output
+
+## [0.5.32] - 2025-03-09
+### Changed
+- Updated transaction filenames to use full account numbers (e.g., `2022-12-Mercury-ACCOUNT.ledger`) instead of sanitized account names
+
+## [0.5.31] - 2025-03-09
+### Fixed
+- Fixed "wrong number of arguments" error in transactions_download command
+- Updated transactions methods to correctly handle start_date and end_date parameters
+- Added tests to ensure get_transactions method only accepts account_id and start_date parameters
+
+## [0.5.30] - 2025-03-09
+### Changed
+- Removed duplicate export methods in the transactions module
+- Refactored transactions module to use the ExportFormatter module for all export functionality
+- Improved code organization and reduced duplication
+- Fixed warnings about helper methods being exposed as commands by wrapping them in a no_commands block
+
+## [0.5.29] - 2025-03-09
+### Fixed
+- Enhanced transaction description sanitization to properly handle newlines and semicolons
+- Improved ledger file format compatibility by escaping special characters according to ledger format rules
+- Updated all export formats (ledger, beancount, hledger, CSV) to properly handle problematic characters in descriptions
+- Simplified sanitization code to focus only on characters that cause issues with the ledger format
+
+## [0.5.28] - 2024-03-08
+### Fixed
+- Fixed error in `financials balancesheet` command caused by invalid date/time format in ledger files
+- Added validation and sanitization for transaction descriptions to prevent ledger parsing errors
+- Improved error handling when processing transactions with problematic data
+
+## [0.5.27] - 2024-03-08
+### Fixed
+- Fixed ledger file balance issues by explicitly including amounts for both sides of transactions
+- Ensured proper negative amounts for Income entries in ledger files
+- Improved ledger file compatibility with strict ledger validation
+
+## [0.5.26] - 2024-03-08
+### Added
+- Added full timestamps as metadata to ledger transactions for better chronological ordering
+- Improved transaction sorting to ensure transactions are exported in strict chronological order
+- Fixed reconciliation issues when multiple transactions occur on the same day
+
+## [0.5.25] - 2024-03-08
+### Fixed
+- Fixed error with `command_exists?` method not being defined when running balance sheet commands
+- Added utility method to check for external command availability
+
+## [0.5.24] - 2024-03-08
+### Added
+- Added ledger format support to the `transactions_download` command
+- Included transaction IDs in ledger files for better traceability and future reference
+
+## [0.5.23] - 2024-03-08
+### Removed
+- Removed all reconciliation-related features (`reconcile`, `reconcile_all`, `reconciliation_status`, `unreconcile`, and `export_reconciled` commands)
+- Simplified the CLI by focusing on core financial reporting functionality
+
+## [0.5.22] - 2024-03-08
+### Fixed
+- Fixed missing require statements in the financials.rb file
+
+## [0.5.21] - 2024-03-08
+### Fixed
+- Fixed the `financials balancesheet` command by including necessary modules in the FinancialsCommand class
+- Moved the balance_sheet method inside a no_commands block to prevent it from being exposed as a command
+
+## [0.5.20] - 2024-03-08
+### Changed
+- Relocated the `balance_sheet` method from the Reports module to the Financials module for better code organization
+- Improved architecture by placing the method in the module where it's actually used
+
+## [0.5.19] - 2024-03-08
+### Fixed
+- Fixed warning about the balance_sheet method by moving it inside a no_commands block
+
+## [0.5.18] - 2024-03-08
+### Removed
+- Removed redundant `mercury balance_sheet` command as this functionality is already available through `

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ishidayusuke01@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,26 @@
+source 'https://rubygems.org'
+
+ruby '3.3.5'
+
+# Specify your gem's dependencies in mercury_banking.gemspec
+gemspec
+
+gem 'dotenv'
+gem 'activesupport'
+gem 'terminal-table'
+gem 'pry'
+gem 'webmock'
+gem 'thor'
+gem 'symmetric-encryption'
+gem 'lockbox'
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', require: false
+gem 'rubocop-performance', require: false
+gem 'rubocop-rspec', require: false
+gem 'rubocop-rake', require: false
+gem 'dead_end', require: false  # Helps find syntax errors
+gem 'debride', require: false   # Finds unused code
+gem 'csv'
+gem 'base64'
+

data/Gemfile.lock

@@ -0,0 +1,140 @@
+PATH
+  remote: .
+  specs:
+    mercury_banking (0.5.34)
+      activesupport (~> 7.0.0)
+      symmetric-encryption (~> 4.6.0)
+      terminal-table (~> 1.8.0)
+      thor (~> 1.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.8.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.9)
+    coderay (1.1.3)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    concurrent-ruby (1.3.5)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    csv (3.3.2)
+    dead_end (4.0.0)
+    debride (1.12.0)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.20)
+      sexp_processor (~> 4.17)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.6.0)
+    dotenv (3.1.7)
+    hashdiff (1.1.2)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    json (2.10.1)
+    lockbox (2.0.1)
+    method_source (1.1.0)
+    minitest (5.25.4)
+    parallel (1.26.3)
+    parser (3.3.7.1)
+      ast (~> 2.4.1)
+      racc
+    path_expander (1.1.3)
+    pry (0.15.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (6.0.1)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.10.0)
+    rexml (3.4.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.2)
+    rubocop (1.42.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.38.1)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.19.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (3.0.0)
+      rubocop (~> 1.40)
+    ruby-progressbar (1.13.0)
+    ruby_parser (3.21.1)
+      racc (~> 1.5)
+      sexp_processor (~> 4.16)
+    sexp_processor (4.17.3)
+    symmetric-encryption (4.6.0)
+      coercible (~> 1.0)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thor (1.2.2)
+    thread_safe (0.3.6)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.8.0)
+    webmock (3.25.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  base64
+  csv
+  dead_end
+  debride
+  dotenv
+  lockbox
+  mercury_banking!
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
+  symmetric-encryption
+  terminal-table
+  thor
+  webmock
+
+RUBY VERSION
+   ruby 3.3.5p100
+
+BUNDLED WITH
+   2.6.5

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 XenonIO
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LINTING_REPORT.md

@@ -0,0 +1,118 @@
+# Mercury Banking CLI Linting Report
+
+## Overview
+This report summarizes the findings from running RuboCop and debride on the Mercury Banking CLI codebase. It identifies potential bugs, code quality issues, and unused code that could be removed.
+
+## RuboCop Findings
+After disabling style-related cops to focus on more important issues, RuboCop identified 673 offenses. The main issues include:
+
+1. **Code Quality Issues**:
+   - Methods with high ABC complexity (Assignment, Branch, Condition)
+   - Methods with high cyclomatic complexity
+   - Methods that are too long
+   - Modules that are too long
+
+2. **Potential Bugs**:
+   - Useless variable assignments
+   - Redundant conditions
+   - Rescuing without specifying error classes
+   - Non-local exits from iterators
+   - Ambiguous operator precedence
+
+3. **Performance Issues**:
+   - Inefficient string operations
+   - Inefficient array operations
+   - Non-atomic file operations
+
+## Dead Code Analysis
+The debride tool identified 1,252 lines of potentially unused code. The main areas include:
+
+### Unused Methods
+
+1. **API Methods**:
+   - `add_recipient`
+   - `get_recipient`
+   - `update_recipient`
+
+2. **CLI Commands**:
+   - `log_transfer`
+   - `balancesheet`
+   - `incomestatement`
+   - `banner`
+   - `exit_on_failure?`
+   - `help`
+   - `set_key`
+   - `transactions`
+   - `version`
+
+3. **Reconciliation Methods**:
+   - All methods in `MercuryBanking::CLI::Reconciliation`
+   - `export_reconciled`
+   - `reconcile`
+   - `reconcile_all`
+   - `reconciliation_status`
+   - `unreconcile`
+
+4. **Report Methods**:
+   - `statement`
+   - `transactions`
+   - `transactions_download`
+
+5. **Formatter Methods**:
+   - `display_recipients_table`
+   - `display_transaction_details`
+   - `display_transactions_table`
+
+6. **Multi Methods**:
+   - `balances`
+
+7. **Recipient Methods**:
+   - `name`
+   - `name=`
+
+8. **Balance Sheet Methods**:
+   - `export_transactions_to_beancount`
+   - `export_transactions_to_ledger`
+
+9. **Reconciliation Report Methods**:
+   - `generate_reconciliation_report`
+
+## Recommendations
+
+### High Priority Issues
+
+1. **Fix Potential Bugs**:
+   - Address useless variable assignments that might indicate logic errors
+   - Fix rescuing without specifying error classes
+   - Fix ambiguous operator precedence issues
+   - Address non-atomic file operations
+
+2. **Remove Unused Reconciliation Module**:
+   The entire `MercuryBanking::CLI::Reconciliation` module appears to be unused and could be removed.
+
+3. **Refactor Complex Methods**:
+   Several methods have high complexity scores and should be refactored:
+   - `MercuryBanking::CLI::Financials::FinancialsCommand#balance_sheet` (ABC: 150.6)
+   - `MercuryBanking::CLI::Reconciliation#reconcile_all` (ABC: 142.3)
+   - `MercuryBanking::Reports::Reconciliation#generate_reconciliation_report` (ABC: 129.3)
+   - `MercuryBanking::CLI::Reports#statement` (ABC: 100.8)
+
+### Further Investigation
+1. **API Methods**:
+   Verify if the recipient-related API methods are used in any part of the application or tests.
+
+2. **Formatter Methods**:
+   Check if the table formatter methods are used in any part of the application.
+
+3. **Balance Sheet Methods**:
+   Verify if the export methods are used in any part of the application.
+
+### Code Cleanup Strategy
+1. Start by addressing potential bugs that could cause runtime issues.
+2. Remove the clearly unused modules and methods.
+3. Refactor complex methods to improve maintainability.
+4. Run the test suite after each change to ensure functionality is preserved.
+5. Update documentation to reflect the changes made.
+
+## Conclusion
+The codebase has a significant amount of potentially unused code that could be removed to improve maintainability. Additionally, there are several complex methods that would benefit from refactoring. By addressing these issues, the Mercury Banking CLI codebase will become more maintainable, with reduced complexity and improved code quality.