From b22e7fd07778cf8150cb63d566695956eea84814 Mon Sep 17 00:00:00 2001
From: Lance Edgar <lance@edbob.org>
Date: Mon, 31 Jan 2022 19:34:24 -0600
Subject: [PATCH] Make "generate report" the same as "create new generated
 report"

no reason to reinvent that wheel
---
 .../reports/{ => generated}/choose.mako       |  12 +-
 .../reports/{ => generated}/generate.mako     |  10 +-
 .../templates/reports/generated/index.mako    |  11 --
 .../templates/reports/generated/view.mako     |   7 -
 tailbone/views/exports.py                     |   8 +-
 tailbone/views/reports.py                     | 128 ++++++++----------
 6 files changed, 58 insertions(+), 118 deletions(-)
 rename tailbone/templates/reports/{ => generated}/choose.mako (90%)
 rename tailbone/templates/reports/{ => generated}/generate.mako (63%)
 delete mode 100644 tailbone/templates/reports/generated/index.mako

diff --git a/tailbone/templates/reports/choose.mako b/tailbone/templates/reports/generated/choose.mako
similarity index 90%
rename from tailbone/templates/reports/choose.mako
rename to tailbone/templates/reports/generated/choose.mako
index 58c9ee22..a6cb8977 100644
--- a/tailbone/templates/reports/choose.mako
+++ b/tailbone/templates/reports/generated/choose.mako
@@ -1,9 +1,5 @@
 ## -*- coding: utf-8; -*-
-<%inherit file="/form.mako" />
-
-<%def name="title()">${index_title}</%def>
-
-<%def name="content_title()"></%def>
+<%inherit file="/master/create.mako" />
 
 <%def name="extra_javascript()">
   ${parent.extra_javascript()}
@@ -60,12 +56,6 @@
   </style>
 </%def>
 
-<%def name="context_menu_items()">
-  % if request.has_perm('report_output.list'):
-      ${h.link_to("View Generated Reports", url('report_output'))}
-  % endif
-</%def>
-
 <%def name="render_buefy_form()">
   <div class="form">
     <p>Please select the type of report you wish to generate.</p>
diff --git a/tailbone/templates/reports/generate.mako b/tailbone/templates/reports/generated/generate.mako
similarity index 63%
rename from tailbone/templates/reports/generate.mako
rename to tailbone/templates/reports/generated/generate.mako
index 57e72385..38adfe34 100644
--- a/tailbone/templates/reports/generate.mako
+++ b/tailbone/templates/reports/generated/generate.mako
@@ -1,15 +1,9 @@
 ## -*- coding: utf-8; -*-
-<%inherit file="/form.mako" />
+<%inherit file="/master/form.mako" />
 
 <%def name="title()">${index_title} &raquo; ${report.name}</%def>
 
-<%def name="content_title()">${report.name}</%def>
-
-<%def name="context_menu_items()">
-  % if request.has_perm('report_output.list'):
-      ${h.link_to("View Generated Reports", url('report_output'))}
-  % endif
-</%def>
+<%def name="content_title()">New Report:&nbsp; ${report.name}</%def>
 
 <%def name="render_buefy_form()">
   <div class="form">
diff --git a/tailbone/templates/reports/generated/index.mako b/tailbone/templates/reports/generated/index.mako
deleted file mode 100644
index 63a5b9b5..00000000
--- a/tailbone/templates/reports/generated/index.mako
+++ /dev/null
@@ -1,11 +0,0 @@
-## -*- coding: utf-8; -*-
-<%inherit file="/master/index.mako" />
-
-<%def name="context_menu_items()">
-  ${parent.context_menu_items()}
-  % if request.has_perm('{}.generate'.format(permission_prefix)):
-      <li>${h.link_to("Generate new Report", url('generate_report'))}</li>
-  % endif
-</%def>
-
-${parent.body()}
diff --git a/tailbone/templates/reports/generated/view.mako b/tailbone/templates/reports/generated/view.mako
index ce8ef38d..496857c5 100644
--- a/tailbone/templates/reports/generated/view.mako
+++ b/tailbone/templates/reports/generated/view.mako
@@ -1,13 +1,6 @@
 ## -*- coding: utf-8; -*-
 <%inherit file="/master/view.mako" />
 
-<%def name="context_menu_items()">
-  ${parent.context_menu_items()}
-  % if request.has_perm('{}.generate'.format(permission_prefix)):
-      <li>${h.link_to("Generate new Report", url('generate_report'))}</li>
-  % endif
-</%def>
-
 <%def name="modify_this_page_vars()">
   ${parent.modify_this_page_vars()}
   <script type="text/javascript">
diff --git a/tailbone/views/exports.py b/tailbone/views/exports.py
index c136359a..3f6d417c 100644
--- a/tailbone/views/exports.py
+++ b/tailbone/views/exports.py
@@ -2,7 +2,7 @@
 ################################################################################
 #
 #  Rattail -- Retail Software Framework
-#  Copyright © 2010-2019 Lance Edgar
+#  Copyright © 2010-2022 Lance Edgar
 #
 #  This file is part of Rattail.
 #
@@ -148,12 +148,6 @@ class ExportMasterView(MasterView):
             obj.created_by = self.request.user
         return obj
 
-    def render_download(self, export, field):
-        path = self.get_file_path(export)
-        text = "{} ({})".format(export.filename, self.readable_size(path))
-        url = self.request.route_url('{}.download'.format(self.get_route_prefix()), uuid=export.uuid)
-        return tags.link_to(text, url)
-
     def render_created_by(self, export, field):
         user = export.created_by
         if not user:
diff --git a/tailbone/views/reports.py b/tailbone/views/reports.py
index b9850ed6..8985e204 100644
--- a/tailbone/views/reports.py
+++ b/tailbone/views/reports.py
@@ -212,6 +212,7 @@ class ReportOutputView(ExportMasterView):
     model_class = model.ReportOutput
     route_prefix = 'report_output'
     url_prefix = '/reports/generated'
+    creatable = True
     downloadable = True
     configurable = True
     config_title = "Reporting"
@@ -235,6 +236,14 @@ class ReportOutputView(ExportMasterView):
         'created_by',
     ]
 
+    def __init__(self, request):
+        super(ReportOutputView, self).__init__(request)
+        self.report_handler = self.get_report_handler()
+
+    def get_report_handler(self):
+        app = self.get_rattail_app()
+        return app.get_report_handler()
+
     def configure_grid(self, g):
         super(ReportOutputView, self).configure_grid(g)
         g.set_link('filename')
@@ -245,10 +254,6 @@ class ReportOutputView(ExportMasterView):
         # params
         f.set_renderer('params', self.render_params)
 
-        # filename
-        if self.viewing:
-            f.set_renderer('filename', self.render_download)
-
     def render_params(self, report, field):
         params = report.params
         if not params:
@@ -273,11 +278,6 @@ class ReportOutputView(ExportMasterView):
         else:
             return HTML.literal(g.render_grid())
 
-    def render_download(self, report, field):
-        path = report.filepath(self.rattail_config)
-        url = self.get_action_url('download', report)
-        return self.render_file_field(path, url=url)
-
     def get_params_context(self, report):
         params_data = []
         for name, value in (report.params or {}).items():
@@ -305,36 +305,7 @@ class ReportOutputView(ExportMasterView):
 
         return kwargs
 
-    def download(self):
-        report = self.get_instance()
-        path = report.filepath(self.rattail_config)
-        return self.file_response(path)
-
-    def configure_get_simple_settings(self):
-        config = self.rattail_config
-        return [
-
-            # generating
-            {'section': 'tailbone',
-             'option': 'reporting.choosing_uses_form',
-             'type': bool},
-        ]
-
-
-class GenerateReport(View):
-    """
-    View for generating a new report.
-    """
-
-    def __init__(self, request):
-        super(GenerateReport, self).__init__(request)
-        self.handler = self.get_handler()
-
-    def get_handler(self):
-        app = self.get_rattail_app()
-        return app.get_report_handler()
-
-    def choose(self):
+    def create(self):
         """
         View which allows user to choose which type of report they wish to
         generate.
@@ -342,7 +313,7 @@ class GenerateReport(View):
         use_buefy = self.get_use_buefy()
 
         # handler is responsible for determining which report types are valid
-        reports = self.handler.get_reports()
+        reports = self.report_handler.get_reports()
         if isinstance(reports, OrderedDict):
             sorted_reports = list(reports)
         else:
@@ -370,18 +341,17 @@ class GenerateReport(View):
             raise self.redirect(self.request.route_url('generate_specific_report',
                                                        type_key=form.validated['report_type']))
 
-        return {
-            'index_title': "Generate Report",
+        return self.render_to_response('choose', {
             'form': form,
             'dform': form.make_deform_form(),
             'reports': reports,
             'sorted_reports': sorted_reports,
             'report_descriptions': dict([(r.type_key, r.__doc__)
                                          for r in reports.values()]),
-            'use_form': self.rattail_config.getbool('tailbone', 'reporting.choosing_uses_form',
-                                                    default=True),
-            'use_buefy': use_buefy,
-        }
+            'use_form': self.rattail_config.getbool(
+                'tailbone', 'reporting.choosing_uses_form',
+                default=True),
+        })
 
     def generate(self):
         """
@@ -391,8 +361,9 @@ class GenerateReport(View):
         """
         use_buefy = self.get_use_buefy()
         type_key = self.request.matchdict['type_key']
-        report = self.handler.get_report(type_key)
+        report = self.report_handler.get_report(type_key)
         report_params = report.make_params(Session())
+        route_prefix = self.get_route_prefix()
 
         NODE_TYPES = {
             bool: colander.Boolean,
@@ -429,7 +400,7 @@ class GenerateReport(View):
         form = forms.Form(schema=schema, request=self.request,
                           use_buefy=use_buefy, helptext=helptext)
         form.submit_label = "Generate this Report"
-        form.cancel_url = self.request.route_url('generate_report')
+        form.cancel_url = self.request.route_url('{}.create'.format(route_prefix))
 
         # must declare jquery support for date fields, ugh
         # TODO: obviously would be nice for this to be automatic?
@@ -458,14 +429,16 @@ class GenerateReport(View):
                 'cancel_msg': "Report generation was canceled",
             })
 
-        return {
-            'index_title': "Generate Report",
-            'index_url': self.request.route_url('generate_report'),
+        # hide the "Create New" button for this page, b/c user is
+        # already in the process of creating new..
+        # TODO: this seems hacky, but works
+        self.show_create_link = False
+
+        return self.render_to_response('generate', {
             'report': report,
             'form': form,
             'dform': form.make_deform_form(),
-            'use_buefy': self.get_use_buefy(),
-        }
+        })
 
     def generate_thread(self, report, params, user_uuid, progress=None):
         """
@@ -476,7 +449,7 @@ class GenerateReport(View):
         session = RattailSession()
         user = session.query(model.User).get(user_uuid)
         try:
-            output = self.handler.generate_output(session, report, params, user, progress=progress)
+            output = self.report_handler.generate_output(session, report, params, user, progress=progress)
 
         # if anything goes wrong, rollback and log the error etc.
         except Exception as error:
@@ -501,24 +474,36 @@ class GenerateReport(View):
                 progress.session['success_url'] = success_url
                 progress.session.save()
 
+    def download(self):
+        report = self.get_instance()
+        path = report.filepath(self.rattail_config)
+        return self.file_response(path)
+
+    def configure_get_simple_settings(self):
+        config = self.rattail_config
+        return [
+
+            # generating
+            {'section': 'tailbone',
+             'option': 'reporting.choosing_uses_form',
+             'type': bool},
+        ]
+
     @classmethod
     def defaults(cls, config):
+        cls._defaults(config)
+        cls._report_output_defaults(config)
 
-        # note that we include this in the "Generated Reports" permissions group
-        config.add_tailbone_permission('report_output', 'report_output.generate',
-                                       "Generate new report (of any type)")
+    @classmethod
+    def _report_output_defaults(cls, config):
+        url_prefix = cls.get_url_prefix()
+        permission_prefix = cls.get_permission_prefix()
 
-        # "generate report" (which is really "choose")
-        config.add_route('generate_report', '/reports/generate')
-        config.add_view(cls, attr='choose', route_name='generate_report',
-                        permission='report_output.generate',
-                        renderer='/reports/choose.mako')
-
-        # "generate specific report" (accept custom params, truly generate)
-        config.add_route('generate_specific_report', '/reports/generate/{type_key}')
+        # generate report (accept custom params, truly create)
+        config.add_route('generate_specific_report',
+                         '{}/new/{{type_key}}'.format(url_prefix))
         config.add_view(cls, attr='generate', route_name='generate_specific_report',
-                        permission='report_output.generate',
-                        renderer='/reports/generate.mako')
+                        permission='{}.create'.format(permission_prefix))
 
 
 @colander.deferred
@@ -680,18 +665,13 @@ def add_routes(config):
 
 
 def includeme(config):
-    add_routes(config)
 
+    # TODO: not in love with this pattern, but works for now
+    add_routes(config)
     config.add_view(OrderingWorksheet, route_name='reports.ordering',
                     renderer='/reports/ordering.mako')
-
     config.add_view(InventoryWorksheet, route_name='reports.inventory',
                     renderer='/reports/inventory.mako')
 
-    # fix permission group
-    config.add_tailbone_permission_group('report_output', "Generated Reports")
-
-    # note that GenerateReport must come first, per route matching
-    GenerateReport.defaults(config)
     ReportOutputView.defaults(config)
     ProblemReportView.defaults(config)