CHANGELOG.adoc 13.6 KB
Newer Older
35V LG84's avatar
35V LG84 committed
1 2 3 4
= Tackler releases

Current published release is:

35V LG84's avatar
35V LG84 committed
5 6
 libraryDependencies += "fi.e257" %%% "tackler-api"  % "0.30.0"
 libraryDependencies += "fi.e257" %%  "tackler-core" % "0.30.0"
35V LG84's avatar
35V LG84 committed
7

35V LG84's avatar
35V LG84 committed
8 9 10

== Release history

35V LG84's avatar
35V LG84 committed
11

35V LG84's avatar
35V LG84 committed
12 13 14 15
=== 0.31.0-SNAPSHOT

New features and changes in this release:

16 17 18 19
 * Support for link:https://tackler.e257.fi/docs/gis/[Geographic Information System (GIS)]
 ** See link:https://tackler.e257.fi/docs/gis/txn-geo-location/[Transaction Geo Location]
 ** See link:https://tackler.e257.fi/docs/gis/txn-geo-filter/[Transaction Geo Filter]
 * Add support for Value Position with link:https://tackler.e257.fi/docs/journal/format/#value-pos[total amount (`=` syntax)]
35V LG84's avatar
35V LG84 committed
20 21 22 23


==== Fixes

24 25
Fixes in this release:

26
* Reject "identity" (e.g. `1 € @ 2 €`) value positions as invalid construct
35V LG84's avatar
35V LG84 committed
27 28 29 30 31 32 33


==== Development

Updated deps and tools:

 * Dependencies
34
 ** jgit: 5.3.1.201904271842-r
35V LG84's avatar
35V LG84 committed
35 36 37



35V LG84's avatar
35V LG84 committed
38
=== 0.30.0
35V LG84's avatar
35V LG84 committed
39

40 41 42 43 44 45 46 47 48 49 50 51
[WARNING]
.Phase 2 support for new Journal Format Version v2
====

[horizontal]
Transaction description:: must start with `'` -prefix

Transaction code:: can not contain  `'` `(` `)` `[` `]` `{` `}` `<` `>` characters

Transaction metadata (uuid):: must start by ``#`` character with space
====

35V LG84's avatar
35V LG84 committed
52 53
New features and changes in this release:

54 55 56 57
 * New Journal Format Version v2 (phase 2), see:
 ** link:https://tackler.e257.fi/docs/journal/format/v2/[New Journal Format v2]
 ** link:https://tackler.e257.fi/docs/journal/format/v1/[Deprecated Journal Format v1]
 ** xref:./docs/tep/tep-1009.adoc[TEP-1009: Txn Header Syntax]
58 59
 * CLI switch `input.storage` to change used storage type

35V LG84's avatar
35V LG84 committed
60 61 62 63 64

==== Fixes

Fixes in this release:

65
 * Account and Commodity Names: Accept signs which were left unintentionally outside in the cold
35V LG84's avatar
35V LG84 committed
66
 ** Currency symbols `$`, `¢`, `£`, `¤`, `¥` from Latin-1 Base and Supplement blocks
67 68 69 70
 ** Micro and Degree (`µ`, `°`) from Latin-1 Supplement block
 ** Vulgar Fractions (`¼`, `½`, `¾`) from Latin-1 Supplement block
 ** Superscripts (`¹`, `²`, `³`) from Latin-1 Supplement block

35V LG84's avatar
35V LG84 committed
71 72 73 74
==== Development

Updated deps and tools:

35V LG84's avatar
35V LG84 committed
75
 * Dependencies
35V LG84's avatar
35V LG84 committed
76
 ** config: 1.3.4
35V LG84's avatar
35V LG84 committed
77 78 79
 ** jgit: 5.3.0.201903130848-r
 ** scallop: 3.2.0
 * Build
35V LG84's avatar
35V LG84 committed
80
 ** sbt-scalajs: 0.6.27
35V LG84's avatar
35V LG84 committed
81 82 83
 ** sbt-antlr: 0.8.2
 * Tests
 ** scalatest: 3.0.7
35V LG84's avatar
35V LG84 committed
84 85 86



35V LG84's avatar
35V LG84 committed
87 88 89 90 91 92 93 94 95 96 97 98 99
=== 0.24.0

[WARNING]
.Phase 1 support for new Journal Format Version v2
====

[horizontal]
Transaction description:: in v2, description must start with `'` -prefix

Transaction code:: in v2, code can not contain  `'` `(` `)` `[` `]` `{` `}` `<` `>` characters

Transaction metadata (uuid):: in v2, metadata must start by ``#`` character with space
====
35V LG84's avatar
35V LG84 committed
100 101 102

New features and changes in this release are:

35V LG84's avatar
35V LG84 committed
103 104 105 106 107 108 109 110 111
 * New Journal Format Version v2 (phase 1), see:
 ** link:https://tackler.e257.fi/docs/journal/format/v2/[New Journal Format v2]
 ** link:https://tackler.e257.fi/docs/journal/format/v1/[Deprecated Journal Format v1]
 ** xref:./docs/tep/tep-1009.adoc[TEP-1009: Txn Header Syntax]
 * Support for numerical sub-account names, see:
 ** xref:./docs/tep/tep-1008.adoc[TEP-1008: Numerical Account names] for details
 ** Related link:https://gitlab.com/e257/accounting/tackler/issues/2[GitLab Issue: 2]
 * All user documentation has been moved to Tackler's new web site: https://tackler.e257.fi/

112

113 114 115 116 117
link:https://gitlab.com/e257/accounting/tackler/tree/master/tools/generator[Generator]:

 * Version v0.5.1
 ** Generate test data in journal format v2

118 119
==== Journal format changes

35V LG84's avatar
35V LG84 committed
120 121 122 123 124 125 126 127
This release has Phase 1 support for new Journal Format Version v2.
This means that it will accept both old deprecated
link:https://tackler.e257.fi/docs/journal/format/v1/[version v1]
and new link:https://tackler.e257.fi/docs/journal/format/v2/[version v2]
of journal format. All exports
(link:https://tackler.e257.fi/docs/export-equity/[Equity] and
link:https://tackler.e257.fi/docs/export-identity/[Identity])
are in new format.
128

35V LG84's avatar
35V LG84 committed
129 130 131 132 133
Phase 1 support for Journal Format Version v2

 * Txn description can start with `'` (this is mandatory with v2)
 * Txn Metadata (UUID) can start with `#` (this is mandatory with v2)
 * Txn code can still have `'` `(` `)` `[` `]` `{` `}` `<` `>` characters (these are not allowed with v2)
134 135 136

 * link:https://tackler.e257.fi/docs/export-identity/[Identity] and
 link:https://tackler.e257.fi/docs/export-equity/[Equity]
35V LG84's avatar
35V LG84 committed
137
 will output only format v2 compatible exports
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155

===== Future Journal format v2

Future version of Tackler journal v2 will have following changes:

Transaction description::
Transaction description must start with `'` -prefix.


Transaction code::
Transaction code can not contain characters: +
`'` `(` `)` `[` `]` `{` `}` `<` `>`

Transaction metadata::
Transaction metadata (UUID) must start with `#` + space -prefix.

See xref:./docs/tep/tep-1009.adoc[TEP-1009: Txn Header Syntax]
for motivation for this change and for further info.
35V LG84's avatar
35V LG84 committed
156

35V LG84's avatar
35V LG84 committed
157 158 159

==== Fixes

160
Changes to Journal Format to make it more lenient when possible.
35V LG84's avatar
35V LG84 committed
161 162 163

==== Development

164
Updated deps and tools: None
35V LG84's avatar
35V LG84 committed
165 166


35V LG84's avatar
35V LG84 committed
167 168


35V LG84's avatar
35V LG84 committed
169
=== 0.23.0
35V LG84's avatar
35V LG84 committed
170

171
New features and changes in this release are:
35V LG84's avatar
35V LG84 committed
172

35V LG84's avatar
35V LG84 committed
173
 * Support Account Auditing, see:
35V LG84's avatar
35V LG84 committed
174 175 176
 ** xref:./docs/auditing.adoc[Accounting Auditing and Asssurance]
 ** xref:./docs/tep/tep-1007.adoc[TEP-1007: Txn Set Checksum]
 ** xref:./docs/tackler.conf[tackler.conf]
177 178
 * New or changed Metadata:
 ** Renamed Metadata's `metadataItems` to `items`
35V LG84's avatar
35V LG84 committed
179 180
 ** New item: `TxnSetChecksum`
 ** New item: `AccountSelectorChecksum`
181
 ** New fields in `GitInputReference`
35V LG84's avatar
35V LG84 committed
182 183
 *** Fields: `input.git.dir` and `input.git.suffix`
 ** Renamed `TxnFilterMetadata` -> `TxnFilterDescription`
184
 * Add CLI option for: `input.git.dir`.
185
 * Reformat balance report for better clarity
186
 * Base64 ascii armor for Txn Filters defined by `--api-filter-def` CLI option
35V LG84's avatar
35V LG84 committed
187
 ** See xref:./docs/usage.adoc[Usage Guide] and Txn Filters
35V LG84's avatar
35V LG84 committed
188 189 190 191 192 193 194 195 196
 * Scala-ARM has been removed and replaced with functionality from better-files

Generator:

 * Versions v0.4.0 and v0.4.1
 * Add uuid to test corpus transactions
 * Add 1E1 and 1E2 test sets
 * Update build and deps

35V LG84's avatar
35V LG84 committed
197 198 199

==== Fixes

35V LG84's avatar
35V LG84 committed
200 201 202 203 204 205 206 207 208 209 210 211
Reject invalid UUIDs which were permitted in the past. These are certain 
way invalid and malformed UUIDs, which are accepted by JDK.

This could change old valid journal to invalid, if journal contains 
these special way invalid UUIDs. 

See following openjdk bugs for details:

 * https://bugs.openjdk.java.net/browse/JDK-8159339
 * https://bugs.openjdk.java.net/browse/JDK-8165199
 * https://bugs.openjdk.java.net/browse/JDK-8216407

35V LG84's avatar
35V LG84 committed
212 213 214 215 216 217 218


==== Development

Updated deps and tools:

 * Updated dependencies
35V LG84's avatar
35V LG84 committed
219
 ** cats: 1.6.0
35V LG84's avatar
35V LG84 committed
220
 ** scala-arm: removed
35V LG84's avatar
35V LG84 committed
221
 * build
35V LG84's avatar
35V LG84 committed
222
 ** sbt-wartremover: 2.4.1
35V LG84's avatar
35V LG84 committed
223 224
 * tests
 ** dirsuite: 0.21.0
35V LG84's avatar
35V LG84 committed
225 226 227



35V LG84's avatar
35V LG84 committed
228
=== 0.22.0
35V LG84's avatar
35V LG84 committed
229 230 231

New features in this release are:

232
* Strict validation of commodities and currencies. This is turned on by default,
35V LG84's avatar
35V LG84 committed
233
  if `accounts.strict = true`.  See xref:./docs/accounts.conf[accounts.conf]
234
  for how to configure this.
35V LG84's avatar
35V LG84 committed
235
* Improve error messages in case of parse and logic errors (filename, lines, etc.)
236 237
* Reports
** Register report: Add separator between txn entries
238
* tackler-api: TxnTS based sharders (date, month, year, iso-week, iso-week-date)
239

35V LG84's avatar
35V LG84 committed
240 241 242

==== Fixes

243 244
Force UTF-8 always on console, regardless of console settings.
This is needed for Windows/MinGW/MSYS2.
35V LG84's avatar
35V LG84 committed
245 246 247 248 249 250 251


==== Development

Updated deps and tools:

 * build
35V LG84's avatar
35V LG84 committed
252
 ** wartremover: 2.4.0
35V LG84's avatar
35V LG84 committed
253 254


35V LG84's avatar
35V LG84 committed
255

35V LG84's avatar
35V LG84 committed
256
=== 0.21.0
35V LG84's avatar
35V LG84 committed
257

258 259
New features in this release are:

260 261
* Configuration settings `reporting.scale` and `reports.<report>.scale`
  for report output scale. Defaults are not changed (min=2, max=7). See:
35V LG84's avatar
35V LG84 committed
262 263 264
** xref:./docs/usage.adoc[Usage Guide]
** xref:./docs/tackler.conf[tackler.conf]
** xref:./docs/tep/tep-1006.adoc[TEP-1006: Configuration settings for report output scale]
265 266


35V LG84's avatar
35V LG84 committed
267 268
==== Fixes

269
 * Fix failing test: e257/accounting/tackler#1
35V LG84's avatar
35V LG84 committed
270

271

35V LG84's avatar
35V LG84 committed
272 273 274 275 276
==== Development

Updated deps and tools:

 * Updated dependencies
277 278 279
 ** ANTLR: 4.7.2
 ** circe: 0.11.1
 ** jgit: 5.2.1.201812262042-r
35V LG84's avatar
35V LG84 committed
280
 * build
281 282
 ** sbt: 1.2.8

35V LG84's avatar
35V LG84 committed
283 284


35V LG84's avatar
35V LG84 committed
285 286 287 288
=== 0.20.0

This is same as Tackler v0.10.0. The difference is that code is
hosted at gitlab.com and moved under new groupId.
35V LG84's avatar
35V LG84 committed
289 290 291

==== Fixes

35V LG84's avatar
35V LG84 committed
292 293
None

35V LG84's avatar
35V LG84 committed
294 295 296 297 298 299 300
==== Development

Updated deps and tools:

 * build
 ** sbt-sonatype: 2.3

35V LG84's avatar
35V LG84 committed
301

35V LG84's avatar
35V LG84 committed
302 303 304
=== 0.10.0

New features of this release are
35V LG84's avatar
35V LG84 committed
305 306
xref:./docs/txn-filters.adoc[transaction filters]
and updated xref:./tools/generator/[generator].
35V LG84's avatar
35V LG84 committed
307 308

* Transaction filters:
35V LG84's avatar
35V LG84 committed
309 310 311 312 313
** xref:./docs/txn-filters.adoc[Txn filter overview]
** xref:./docs/server-api.adoc[Server API for filters]
** xref:./docs/client-api.adoc[Client API and data model for filters]
** xref:./docs/tep/tep-1005.adoc[TEP-1005: Txn Filters]
* Transaction test data xref:./tools/generator/[generator]:
35V LG84's avatar
35V LG84 committed
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
** new version: 0.3.0
** Txn generator creates txn `code` and `description` fields
  to support perf testing of Txn Filters.

==== Fixes

Documentation:

* Improved Installation Instructions

==== Development

Updated deps and tools:

 * Updated dependencies
 ** better-files: 3.7.0
 ** cats: 1.5.0
 ** circe: 0.10.1
 ** scallop: 3.1.5
 ** config: 1.3.3
 ** jgit: 5.1.3.201810200350-r
 ** scalatest: 3.0.5
 * build
 ** scala: 2.12.8
 ** sbt: 1.2.7
 ** sbt-assembly: 0.14.9
 ** sbt-buildinfo: 0.9.0
 ** sbt-coveralls: 1.2.4
 ** sbt-crossproject: 0.6.0
 ** sbt-scalajs: 0.6.26
 ** sbt-scalajs-crossproject: 0.6.0
 ** sbt-wartremover: 2.3.7


=== 0.9.0

35V LG84's avatar
35V LG84 committed
350
 * New xref:./docs/client-api.adoc[client API] (`tackler-api`) library of  data models (JVM and JS environments).
35V LG84's avatar
35V LG84 committed
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
 ** Publish JVM and JS version of `tackler-api.jar` on Maven Central Repository
 * Server API clean ups and enhancements (helper methods for Txns and report handling).
 * JSON cleanups and changes (see diff of `tests` with `ignore-whitespace`)
 ** Use tackler-api and Circe for serializing JSON reports


==== Development

Updated deps and tools:

 * Updatede dependencies
 ** ANTLR: 4.7.1 
 ** cats: 1.0.1
 ** circe: 0.9.1
 ** jgit: 4.10.0.201712302008-r
 * build
 ** sbt: 1.1.0
 ** sbt-antlr4: 0.8.1
 ** sbt-scalajs: 0.6.21
 ** sbt-crossproject: 0.3.0
 ** sbt-scalajs-crossproject: 0.3.0


=== 0.8.0

 * Publish `tackler-core.jar` on  Maven Central Repository
 * Provide specialized configuration for all reports
 * Add reporting method which returns report as json-object
 * Provide Settings constructors without conf-file path and with only embedded configuration
 ** Renamed embedded configuration `tackler.conf` to `reference.conf`
 ** Move Tackler's conf-file configuration under `tackler.core` namespace
 * Change `equity` and `identity` to actual exports (code and configuration)
 ** new conf+cli option `reporting.exports`
 ** Conf+cli key `reporting.reports` doesn't accept `equity` nor `identity` anymore
 ** move conf-key `reports.equity` to `exports.equity`

==== Fixes

 * Don't include logger implementation with `tackler-core.jar`

==== Development

 * Change: change `ReportType` to `OutputType`, and split it to `ReportType` and `ExportType` traits.
 * New: ReportSettings base class for report configuration
 * Change: All reports takes specialized <ReportType>Settings as settings argument 

Updated deps and tools:

 * Updated dependencies
 ** better-files: 3.4.0
 ** jgit: 4.9.1.201712030800-r
 * build
 ** sbt: 1.0.4
 ** assembly: 0.14.6
 ** sonatype: 2.0

=== 0.7.0

 * JSON report format
35V LG84's avatar
35V LG84 committed
410
 ** xref:docs/tep/tep-1004.adoc[TEP-1004: JSON report output]
35V LG84's avatar
35V LG84 committed
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
 * Update build chain to sbt 1.0

==== Fixes

None.

==== Development

Build is updated to sbt 1.0.

 * Updated dependencies
 ** libs
 *** better-files: 3.2.0
 *** cats: 1.0.0-RC1
 *** circe: 1.0.0-M2 (new)
 *** config: 1.3.2
 *** jgit: 4.9.0.201710071750-r
 *** scallop: 3.3.1
 * build
 ** sbt: 1.0.3
 ** scala: 2.12.4
 ** wartremover: 2.2.1
 ** DirSuite: 0.7.0
 ** scalatest: 3.0.4

=== 0.6.0

 * Support for Units and Commodities
35V LG84's avatar
35V LG84 committed
439 440 441 442 443
 ** xref:docs/commodities.adoc[Commodities]
 ** xref:docs/currencies.adoc[Currencies]
 ** xref:docs/tep/tep-1001.adoc[TEP-1001: Units and Commodities]
 ** xref:docs/journal.adoc[Journal changes to support commodities]
 ** xref:docs/trimix-filling-station.adoc[Example of accounting system for Trimix Gas Mixing Station]
35V LG84's avatar
35V LG84 committed
444 445 446 447 448 449 450 451 452 453 454


==== Fixes

 * Fix equity report when postings balance (zero) out


=== 0.5.0

 * First public release
 * Git storage support:
35V LG84's avatar
35V LG84 committed
455 456
 ** xref:docs/git-storage.adoc[Git Storage Manual]
 ** xref:docs/tep/tep-1002.adoc[TEP-1002: Git Storage System]
35V LG84's avatar
35V LG84 committed
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
 * Rename configuration and CLI arg key `input.txn` to `input.fs`
 * Support link as target for top-level shard directory (`input.fs.dir`)

==== Fixes

* Use always ISO-8601 week rules regardless of system locale


=== 0.4.1

* Documentation updates
* Internal cleanups

* Perf:
** Single file 1E3
** Single file 1E6
** Generator 0.2.1


=== 0.4.0

* Supports single star globs (`*.txn`) for flat directories

* Internal: better-files
* Internal: logback 1.2.3


=== 0.3.2

* Documentation and test updates
* Equity report
** own account selection

* Internal clean ups


=== 0.3.1

* Change register report output


=== 0.3.0

* Txns file changes
** meta:uuid: feature
** Account names
*** hyphen '-'
*** underscore '_'
*** wide range of characters (e.g. kanji) in account names
** Txn comments are printend with identity report

* TS with offset is used for Txn sorting and group-by

* Change automatic scale to (2-7 decimals)

* Do not allow zero postings

* reporting.console = true

* RegisterReport
** prints meta:uuid:
** prints txn comments
** Stream based implementation

* IdentityReport
** Stream based implementation

* EquityReport
** printing

* Perf:
** 1E3: (1000) txns testing
** 1E6: (1_000_000) txns testing
** Generator (0.1.4)


=== 0.2.1

* Reporting
** initial support for reports and accounts as cli opt
** Automatic scale (2-6 decimals)
** Register report title format


=== 0.2.0

* reporting
** renamed balgrp -> balance-group
** report names from conf
** balance-group: group-by from conf
** balance summary line


=== 0.1.90

* Reporting: account definitions


=== 0.1.0

* conf-settings
* Z as UTC marker
* conf: timezone
* Chart of Accounts
* cli+conf: accounts.coa
* cli+conf: accounts.strict


=== 0.0.1

* initial release, hardcoded account filters, no config