[reconcile-report] pull reconcile-report into separate file

gnucash/report/standard-reports/CMakeLists.txt

@@ -27,6 +27,7 @@ set (standard_reports_SCHEME_2
     net-charts.scm
     portfolio.scm
     price-scatter.scm
+    reconcile-report.scm
     register.scm
     sx-summary.scm
     transaction.scm

gnucash/report/standard-reports/reconcile-report.scm

@@ -0,0 +1,109 @@
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;; reconcile-report.scm : Reconciliation report
+;;
+;; calls functions defined in trep-engine.scm with defaults suitable
+;; for a reconciliation report including alternative date filtering
+;; strategy
+;;
+;; This program is free software; you can redistribute it and/or
+;; modify it under the terms of the GNU General Public License as
+;; published by the Free Software Foundation; either version 2 of
+;; the License, or (at your option) any later version.
+;;
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+;;
+;; You should have received a copy of the GNU General Public License
+;; along with this program; if not, contact:
+;;
+;; Free Software Foundation           Voice:  +1-617-542-5942
+;; 51 Franklin Street, Fifth Floor    Fax:    +1-617-542-2652
+;; Boston, MA  02110-1301,  USA       gnu@gnu.org
+;;
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
+(define-module (gnucash report standard-reports reconcile-report))
+
+(use-modules (gnucash gettext))
+(use-modules (gnucash gnc-module))
+(gnc:module-load "gnucash/report/report-system" 0)
+
+(define (reconcile-report-options-generator)
+  (let ((options (gnc:trep-options-generator)))
+    (gnc:option-set-value
+     (gnc:lookup-option options "Sorting" "Primary Key") 'reconciled-status)
+    (gnc:option-set-value
+     (gnc:lookup-option options "Sorting" "Secondary Key")   'date)
+    (gnc:option-set-value
+     (gnc:lookup-option options "Sorting" "Secondary Subtotal for Date Key") 'none)
+    (gnc:option-set-value
+     (gnc:lookup-option options gnc:pagename-general "Start Date")
+     (cons 'relative 'start-prev-quarter))
+    (gnc:option-set-value
+     (gnc:lookup-option options gnc:pagename-general "End Date")
+     (cons 'relative 'today))
+    (gnc:option-set-value
+     (gnc:lookup-option options gnc:pagename-display "Reconciled Date") #t)
+    (gnc:option-set-value
+     (gnc:lookup-option options gnc:pagename-display "Running Balance") #f)
+    (gnc:option-set-value
+     (gnc:lookup-option options gnc:pagename-display "Memo") #f)
+    (gnc:option-make-internal! options gnc:pagename-display "Running Balance")
+    options))
+
+(define reconcile-report-instructions
+  (gnc:make-html-text
+   (_ "The reconcile report is designed to be similar to the formal \
+reconciliation tool.  Please select the account from Report \
+Options. Please note the dates specified in the options will apply \
+to the Reconciliation Date.")
+   (gnc:html-markup-br)
+   (gnc:html-markup-br)))
+
+(define (split->reconcile-date split)
+  (and (char=? (xaccSplitGetReconcile split) #\y)
+       (xaccSplitGetDateReconciled split)))
+
+(define (reconcile-report-calculated-cells options)
+  (letrec
+      ((split-amount (lambda (s)
+                       (if (gnc:split-voided? s)
+                           (xaccSplitVoidFormerAmount s)
+                           (xaccSplitGetAmount s))))
+       (split-currency (compose xaccAccountGetCommodity xaccSplitGetAccount))
+       (amount (lambda (s)
+                 (gnc:make-gnc-monetary (split-currency s) (split-amount s))))
+       (debit-amount (lambda (s)
+                       (and (positive? (split-amount s))
+                            (amount s))))
+       (credit-amount (lambda (s)
+                        (and (not (positive? (split-amount s)))
+                             (gnc:monetary-neg (amount s))))))
+    ;; similar to default-calculated-cells but disable dual-subtotals.
+    (list (vector (_ "Funds In")
+                  debit-amount #f #t #f
+                  (const ""))
+          (vector (_ "Funds Out")
+                  credit-amount #f #t #f
+                  (const "")))))
+
+(define (reconcile-report-renderer rpt)
+  (gnc:trep-renderer
+   rpt
+   #:custom-calculated-cells reconcile-report-calculated-cells
+   #:split->date split->reconcile-date
+   #:split->date-include-false? #t
+   #:empty-report-message reconcile-report-instructions))
+
+(gnc:define-report
+ 'version 1
+ 'name (_ "Reconciliation Report")
+ 'report-guid "e45218c6d76f11e7b5ef0800277ef320"
+ 'options-generator reconcile-report-options-generator
+ ;; the renderer is the same as trep, however we're using a different
+ ;; split-date strategy.  we're comparing reconcile date for
+ ;; inclusion, and if split is unreconciled, include it anyway.
+ 'renderer reconcile-report-renderer)
+

gnucash/report/standard-reports/test/test-transaction.scm

@@ -2,6 +2,7 @@
 (gnc:module-begin-syntax (gnc:module-load "gnucash/app-utils" 0))
 (use-modules (gnucash engine test test-extras))
 (use-modules (gnucash report standard-reports transaction))
+(use-modules (gnucash report standard-reports reconcile-report))
 (use-modules (gnucash report stylesheets))
 (use-modules (gnucash report report-system))
 (use-modules (gnucash report report-system test test-extras))
@@ -890,9 +891,8 @@
 
 
     (let* ((options (default-testing-options)))
-      (let ((sxml (options->sxml options "null test")))
-        (test-assert "sxml"
-          sxml))
+      (test-assert "reconcile-report basic run"
+        (options->sxml options "null test"))
       (set-option! options "General" "Start Date" (cons 'absolute (gnc-dmy2time64 01 03 1970)))
       (set-option! options "General" "End Date" (cons 'absolute (gnc-dmy2time64 31 03 1970)))
       (let ((sxml (options->sxml options "filter reconcile date")))

po/POTFILES.in

@@ -485,6 +485,7 @@ gnucash/report/standard-reports/income-statement.scm
 gnucash/report/standard-reports/net-charts.scm
 gnucash/report/standard-reports/portfolio.scm
 gnucash/report/standard-reports/price-scatter.scm
+gnucash/report/standard-reports/reconcile-report.scm
 gnucash/report/standard-reports/register.scm
 gnucash/report/standard-reports/standard-reports.scm
 gnucash/report/standard-reports/sx-summary.scm