Skip to content

tep-1016.adoc

Latest commit

 

History

History
265 lines (159 loc) · 5.37 KB

tep-1016.adoc

File metadata and controls

265 lines (159 loc) · 5.37 KB
Raw

TEP-1016: Flat Balance

See branch /tep/tep-1016-flat-balance for actual TEP-1016 content.

Implement flat balance as an alternative for tree balance reports.

Tracking issue

GH-86

Status

Implemented

How to Test

There is new optional report.balance.type and report.balance-group.type configuration settings with flat or tree values.

# development version of tackler will generate above config keys
tackler new demo
tackler --config demo/conf/tackler.toml

Summary

Summary of changes

  • Flat Balance

  • Flat Balance Group

  • Configuration option to select balance type (tree or flat)

At the moment tackler generates balance family reports with additional tree balance column. The tree balance is that second column in the report below.

BALANCE (TREE)
--------------
                 0.00   -2.00  Assets
                -2.00   -2.00  Assets:Cash
                 0.00    2.00  Expenses
                 2.00    2.00  Expenses:Ice_cream
=====================
                 0.00

Implement flat balance so that the balance is reported only for the leaf accounts.

This is semantically more similar to other PTA tool’s balance reports.

BALANCE (FLAT)
--------------
                -2.00  Assets:Cash
                 2.00  Expenses:Ice_cream
=====================
                 0.00

Journal File Format

No changes to journal file format.

Implementation

CLI Changes

No changes to CLI - this will be config only feature.

CONF Changes

Add optional configuration option report.balance.type, with possible values tree and flat. If the option is missing, then tree-type is used.

  • ✓ report.balance.type

  • ✓ report.balance-group.type

Filtering Changes

No changes to filtering.

Machinery

Changes to machinery

  • ✓ flat balance builder

API Changes

Api changes to server or client interfaces.

Server API Changes

Changes to server API

  • [-] Change model::balance_tree_node::BalanceTreeNode field sub_acc_tree_sum to optional. This was implemented with Zero value

Client API Changes

Changes to client API or JSON model

  • ❏ Eventually change JSON to have optional accountTreeSum field.

JSON Model

Changes to JSON model

  • ❏ JSON Reports

    • ❏ BalanceReport

      • ❏ optional accountTreeSum field

    • ❏ BalanceGroupReport

      • ❏ optional accountTreeSum field

New Dependencies

No new dependencies were added.

Reporting

Changes to reports or reporting

Balance Report

Changes to balance report

  • ✓ New report content: Flat Balance

Balance Group Report

Changes to balance group report

  • ✓ New report content: Flat Balance Group

Register Report

No changes to register report

Exporting

Changes to exports or exporting

Equity Export

No changes to equity export

Identity Export

No changes to identity export

Documentation

Future Plans and Postponed (PP) Features

Possibly expose option to select balance type from CLI.

In the future, maybe turn this into mandatory option (with grace period).

Postponed (PP) Features

Tests

Normal, ok-case tests to validate functionality:

  • ✓ balance report

    • ✓ type is not set

    • ✓ type is set to flat

    • ✓ type is set to tree

  • ✓ balance group report

    • ✓ type is not set

    • ✓ type is set to flat

    • ✓ type is set to tree

  • ✓ balance and balance group has different type setting

  • ✓ verify that reports are not changed with tree

  • ❏ test flat balance sorting order

Errors

Various error cases:

  • ✓ e: unknown balance type

  • ✓ e: unknown balance-group type

Perf

  • ❏ Update perf tests with flat balance

Feature and Test Coverage Tracking

Feature-id

  • name: Flat Balance

  • uuid: cb7f968e-61f4-43d2-b2d8-d08f179d5fd7

Metadata template for Feature and Test Coverage Tracking

features:
  - feature:
      id: cb7f968e-61f4-43d2-b2d8-d08f179d5fd7
      subject: "Flat Balance"

  - feature:
      id: 55cbf642-7d2b-4a68-9eed-4cd97066b2be
      parent: cb7f968e-61f4-43d2-b2d8-d08f179d5fd7
      subject: "Flat Balance Report"

  - feature:
      id: eac0e587-2232-42ed-9569-d1026d762e60
      parent: cb7f968e-61f4-43d2-b2d8-d08f179d5fd7
      subject: "Flat Balance Group Report"

Tackler is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.