initial PR for expense updater helper

regolith/helper.py

@@ -24,6 +24,7 @@
 from regolith.helpers import v_meetingshelper as v_meetings
 from regolith.helpers import f_todohelper as f_todo
 from regolith.helpers import u_todohelper as u_todo
+from regolith.helpers import u_expensehelper as u_expense
 
 HELPERS = {
     "a_expense": (a_expense.ExpenseAdderHelper, a_expense.subparser),
@@ -51,6 +52,7 @@
     "u_institution": (u_institutions.InstitutionsUpdaterHelper, u_institutions.subparser),
     "u_logurl": (u_logurl.LogUrlUpdaterHelper, u_logurl.subparser),
     "u_milestone": (u_milestone.MilestoneUpdaterHelper, u_milestone.subparser),
+    "u_expense": (u_expense.ExpenseUpdaterHelper, u_expense.subparser),
     "v_meetings": (v_meetings.MeetingsValidatorHelper, v_meetings.subparser),
     "u_todo": (u_todo.TodoUpdaterHelper, u_todo.subparser),
 }

regolith/helpers/u_expensehelper.py

@@ -0,0 +1,192 @@
+"""
+Helper for updating expenses
+"""
+from regolith.helpers.basehelper import DbHelperBase
+from regolith.fsclient import _id_key
+from regolith.tools import all_docs_from_collection, fragment_retrieval
+from regolith.dates import get_due_date
+from itertools import chain
+
+TARGET_COLL = "expenses"
+ALLOWED_TYPES = {"m":"meeting", "r":"release", "p":"pull request", "o":"other"}
+ALLOWED_STATI = {"p":"proposed", "s":"started", "f":"finished", "b":"back_burner","c":"converged", "l": "cancelled"}
+
+def subparser(subpi):
+    subpi.add_argument("exepnse_id", help="The id of the expense.")
+    subpi.add_argument("-v", "--verbose", action="store_true",
+                        help="Increases the verbosity of the output.")
+    subpi.add_argument("-i", "--index",
+                        help="Index of the item in the enumerated list to update.",
+                        type = int)
+    subpi.add_argument("-d", "--due_date",
+                       help="New due date of the milestone in ISO format(YYYY-MM-DD). "
+                            "Required for a new milestone.")
+    subpi.add_argument("-o", "--objective",
+                       help="Objective of the milestone. "
+                            "Required for a new milestone.")
+    subpi.add_argument("-s", "--status",
+                       help="Status of the milestone/deliverable: "
+                            f"{ALLOWED_STATI}. "
+                            "Defaults to proposed for a new milestone.")
+    subpi.add_argument("-t", "--type",
+                       help="Type of the milestone: "
+                            f"{ALLOWED_TYPES} "
+                            "Defaults to meeting for a new milestone.")
+
+    # Do not delete --database arg
+    subpi.add_argument("--database",
+                       help="The database that will be updated.  Defaults to "
+                            "first database in the regolithrc.json file.")
+    return subpi
+
+class ExpenseUpdaterHelper(DbHelperBase):
+    """Helper for updating milestones to the projecta collection.
+    """
+    # btype must be the same as helper target in helper.py
+    btype = "u_expense"
+    needed_dbs = [f'{TARGET_COLL}']
+
+    def construct_global_ctx(self):
+        """Constructs the global context"""
+        super().construct_global_ctx()
+        gtx = self.gtx
+        rc = self.rc
+        rc.coll = f"{TARGET_COLL}"
+        if not rc.database:
+            rc.database = rc.databases[0]["name"]
+        gtx[rc.coll] = sorted(
+            all_docs_from_collection(rc.client, rc.coll), key=_id_key
+        )
+        gtx["all_docs_from_collection"] = all_docs_from_collection
+        gtx["float"] = float
+        gtx["str"] = str
+        gtx["zip"] = zip
+
+    def db_updater(self):
+        rc = self.rc
+        key = rc.projectum_id
+        filterid = {'_id': key}
+        target_prum = rc.client.find_one(rc.database, rc.coll, filterid)
+        if not target_prum:
+            pra = fragment_retrieval(self.gtx["projecta"], ["_id"], rc.projectum_id)
+            if len(pra) == 0:
+                raise RuntimeError("Please input a valid projectum id or a valid fragment of a projectum id")
+            print("Projecta not found. Projecta with similar names: ")
+            for i in range(len(pra)):
+                print(f"{pra[i].get('_id')}")
+            print("Please rerun the helper specifying the complete ID.")
+            return
+        milestones = target_prum.get('milestones')
+        deliverable = target_prum.get('deliverable')
+        kickoff = target_prum.get('kickoff')
+        deliverable['identifier'] = 'deliverable'
+        kickoff['identifier'] = 'kickoff'
+        for item in milestones:
+            item['identifier'] = 'milestones'
+        all_milestones = [deliverable, kickoff]
+        all_milestones.extend(milestones)
+        for i in all_milestones:
+            i['due_date'] = get_due_date(i)
+        all_milestones.sort(key = lambda x: x['due_date'], reverse=False)
+        index_list = list(range(2, (len(all_milestones)+2)))
+        if not rc.verbose and not rc.index:
+            print("Please choose from one of the following to update/add:")
+            print("1. new milestone")
+            for i, j in zip(index_list, all_milestones):
+                if j['identifier'] == 'milestones':
+                    print(f"{i}. {j.get('name')}    due date: {j.get('due_date')}"
+                          f"    status: {j.get('status')}")
+                else:
+                    print(f"{i}. {j.get('identifier')}    due date: {j.get('due_date')}"
+                          f"    status: {j.get('status')}")
+                del j['identifier']
+            return
+        if rc.verbose:
+            print("Please choose from one of the following to update/add:")
+            print("1. new milestone")
+            for i, j in zip(index_list, all_milestones):
+                if j['identifier'] == 'milestones':
+                    print(f"{i}. {j.get('name')}    due date: {j.get('due_date')}:\n"
+                          f"     audience: {j.get('audience')}\n"
+                          f"     objetive: {j.get('objective')}\n"
+                          f"     status: {j.get('status')}\n"
+                          f"     type: {j.get('type')}")
+                else:
+                    print(f"{i}. {j.get('identifier')}    due date: {j.get('due_date')}:\n"
+                          f"     audience: {j.get('audience')}\n"
+                          f"     status: {j.get('status')}")
+                del j['identifier']
+            return
+        pdoc = {}
+        if rc.type and rc.type not in (list(chain.from_iterable((k, v) for k, v in ALLOWED_TYPES.items()))):
+                raise KeyError(f"please rerun specifying --type with a value from {ALLOWED_TYPES}")
+        if rc.status and rc.status not in (list(chain.from_iterable((k, v) for k, v in ALLOWED_STATI.items()))):
+                raise KeyError(f"please rerun specifying --status with a value from {ALLOWED_STATI}")
+        if rc.index == 1:
+            mil = {}
+            if not rc.due_date or not rc.name or not rc.objective:
+                raise RuntimeError("name, objective, and due date are required for a new milestone")
+            mil.update({'due_date': rc.due_date})
+            mil['due_date'] = get_due_date(mil)
+            mil.update({'objective': rc.objective, 'name': rc.name})
+            if rc.audience:
+                mil.update({'audience': rc.audience})
+            else:
+                mil.update({'audience': ['lead', 'pi', 'group_members']})
+            if rc.status:
+                if rc.type in ALLOWED_TYPES:
+                    mil.update({'type': ALLOWED_TYPES.get(rc.type)})
+                else:
+                    mil.update({'type': rc.type})
+            else:
+                mil.update({'status': 'proposed'})
+            if rc.type:
+                if rc.status in ALLOWED_STATI:
+                    mil.update({'status': ALLOWED_STATI.get(rc.status)})
+                else:
+                    mil.update({'status': rc.status})
+            else:
+                mil.update({'type': 'meeting'})
+            milestones.append(mil)
+            pdoc = {'milestones':milestones}
+        if rc.index > 1:
+            doc = all_milestones[rc.index-2]
+            identifier = doc['identifier']
+            if not doc.get('type') and not rc.type and identifier=='milestones':
+                    raise RuntimeError("ERROR: This milestone does not have a type set and this is required. "
+                                       "Please rerun your command adding '--type' "
+                                       f"and typing a type from this list: {ALLOWED_TYPES}")
+            if rc.type:
+                if rc.type in ALLOWED_TYPES:
+                    doc.update({'type': ALLOWED_TYPES.get(rc.type)})
+                else:
+                    doc.update({'type': rc.type})
+            if rc.status:
+                if rc.status in ALLOWED_STATI:
+                    doc.update({'status': ALLOWED_STATI.get(rc.status)})
+                else:
+                    doc.update({'status': rc.status})
+            if rc.audience:
+                doc.update({'audience': rc.audience})
+            if rc.due_date:
+                doc.update({'due_date': rc.due_date})
+            doc['due_date'] = get_due_date(doc)
+            if identifier == 'milestones':
+                if rc.name:
+                    doc.update({'name': rc.name})
+                if rc.objective:
+                    doc.update({'objective': rc.objective})
+                new_mil = []
+                for i, j in zip(index_list, all_milestones):
+                    if j['identifier'] == 'milestones' and i != rc.index:
+                        new_mil.append(j)
+                new_mil.append(doc)
+                pdoc.update({'milestones':new_mil})
+            else:
+                pdoc.update({identifier:doc})
+        for i in all_milestones:
+            del i['identifier']
+        rc.client.update_one(rc.database, rc.coll, filterid, pdoc)
+        print("{} has been updated in projecta".format(key))
+
+        return