Add retag command (#551)

Closes #515 

---------

Signed-off-by: cyberme0w <iuri_archer@hotmail.com>

doc/man1/timew-retag.1.adoc

@@ -0,0 +1,40 @@
+= timew-retag(1)
+
+== NAME
+timew-retag - replace all tags in intervals
+
+== SYNOPSIS
+[verse]
+*timew retag* [_<id>_**...**] _<tag>_**...**
+
+== DESCRIPTION
+The 'retag' command is used to replace all tags in an interval with the newly provided tags.
+Using the 'summary' command, and specifying the ':ids' hint shows interval IDs.
+Using the right ID, you can identify an interval to retag.
+
+== EXAMPLES
+For example, show the IDs:
+
+    $ timew summary :week :ids
+
+Then having selected '@2' as the interval you wish to retag:
+
+    $ timew retag @2 'New Tag'
+
+Note that you can retag multiple intervals, with multiple tags:
+
+    $ timew retag @2 @10 @23 'Tag One' tag2 tag3
+
+If there is active time tracking, you can omit the ID when you want to retag the current open interval:
+
+    $ timew start foo
+    $ timew retag bar
+
+This results in the current interval having only the 'bar' tag.
+
+== SEE ALSO
+**timew-lengthen**(1),
+**timew-shorten**(1),
+**timew-summary**(1),
+**timew-tag**(1)
+**timew-untag**(1)

doc/man1/timew.1.adoc

@@ -88,6 +88,9 @@ Alphabetically:
 *timew-resize*(1)::
     Set interval duration
 
+*timew-retag*(1)::
+    Replace tags in intervals
+
 *timew-shorten*(1)::
     Shorten intervals
 

src/Interval.cpp

@@ -85,6 +85,12 @@ void Interval::untag (const std::string& tag)
   _tags.erase (tag);
 }
 
+////////////////////////////////////////////////////////////////////////////////
+void Interval::clearTags ()
+{
+  _tags.clear ();
+}
+
 ////////////////////////////////////////////////////////////////////////////////
 std::string Interval::serialize () const
 {

src/Interval.h

@@ -47,6 +47,7 @@ public:
   const std::set <std::string>& tags () const;
   void tag (const std::string&);
   void untag (const std::string&);
+  void clearTags ();
 
   void setRange (const Range& range);
   void setRange (const Datetime& start, const Datetime& end);

src/commands/CMakeLists.txt

@@ -36,6 +36,7 @@ set (commands_SRCS CmdAnnotate.cpp
                    CmdMove.cpp
                    CmdReport.cpp
                    CmdResize.cpp
+                   CmdRetag.cpp
                    CmdStart.cpp
                    CmdStop.cpp
                    CmdSummary.cpp

src/commands/CmdRetag.cpp

@@ -0,0 +1,126 @@
+////////////////////////////////////////////////////////////////////////////////
+//
+// Copyright 2023, Thomas Lauf, Paul Beckingham, Federico Hernandez.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included
+// in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+//
+// https://www.opensource.org/licenses/mit-license.php
+//
+////////////////////////////////////////////////////////////////////////////////
+
+#include <IntervalFilterAllInRange.h>
+#include <IntervalFilterAllWithIds.h>
+#include <IntervalFilterFirstOf.h>
+#include <commands.h>
+#include <format.h>
+#include <iostream>
+#include <timew.h>
+
+////////////////////////////////////////////////////////////////////////////////
+int CmdRetag (
+  const CLI& cli,
+  Rules& rules,
+  Database& database,
+  Journal& journal)
+{
+  const bool verbose = rules.getBoolean ("verbose");
+
+  // Gather IDs and TAGs.
+  std::set <int> ids = cli.getIds ();
+  std::set<std::string> tags = cli.getTags ();
+
+  if (tags.empty ())
+  {
+    throw std::string ("At least one tag must be specified. See 'timew help retag'.");
+  }
+
+  journal.startTransaction ();
+
+  flattenDatabase (database, rules);
+  std::vector <Interval> intervals;
+
+  if (ids.empty ())
+  {
+    IntervalFilterFirstOf filtering {std::make_shared <IntervalFilterAllInRange> (Range {})};
+    auto latest = getTracked (database, rules, filtering);
+
+    if (latest.empty ())
+    {
+      throw std::string ("There is no active time tracking.");
+    }
+    else if (!latest.at (0).is_open ())
+    {
+      throw std::string ("At least one ID must be specified. See 'timew help retag'.");
+    }
+
+    intervals = latest;
+  }
+  else
+  {
+    auto filtering = IntervalFilterAllWithIds (ids);
+    intervals = getTracked (database, rules, filtering);
+
+    if (intervals.size () != ids.size ())
+    {
+      for (auto& id: ids)
+      {
+        bool found = false;
+
+        for (auto& interval: intervals)
+        {
+          if (interval.id == id)
+          {
+            found = true;
+            break;
+          }
+        }
+        if (!found)
+        {
+          throw format ("ID '@{1}' does not correspond to any tracking.", id);
+        }
+      }
+    }
+  }
+
+  // Remove old tags and apply new tags to intervals.
+  for (const auto& interval : intervals)
+  {
+    Interval modified {interval};
+
+    modified.clearTags ();
+
+    for (auto& tag : tags)
+    {
+      modified.tag (tag);
+    }
+
+    database.modifyInterval (interval, modified, verbose);
+
+    if (verbose)
+    {
+      std::cout << "Retagged @" << interval.id << " as " << joinQuotedIfNeeded (" ", tags) << '\n';
+    }
+  }
+
+  journal.endTransaction ();
+
+  return 0;
+}
+
+////////////////////////////////////////////////////////////////////////////////

src/commands/commands.h

@@ -53,6 +53,7 @@ int CmdModify        (const CLI&, Rules&, Database&, Journal&
 int CmdMove          (const CLI&, Rules&, Database&, Journal&                   );
 int CmdReport        (const CLI&, Rules&, Database&,           const Extensions&);
 int CmdResize        (const CLI&, Rules&, Database&, Journal&                   );
+int CmdRetag         (const CLI&, Rules&, Database&, Journal&                   );
 int CmdShorten       (const CLI&, Rules&, Database&, Journal&                   );
 int CmdShow          (            Rules&                                        );
 int CmdSplit         (const CLI&, Rules&, Database&, Journal&                   );

src/init.cpp

@@ -69,6 +69,7 @@ void initializeEntities (CLI& cli)
   cli.entity ("command", "move");
   cli.entity ("command", "report");
   cli.entity ("command", "resize");
+  cli.entity ("command", "retag");
   cli.entity ("command", "shorten");
   cli.entity ("command", "show");
   cli.entity ("command", "split");
@@ -240,6 +241,7 @@ int dispatchCommand (
     else if (command == "move")        status = CmdMove          (cli, rules, database, journal            );
     else if (command == "report")      status = CmdReport        (cli, rules, database,          extensions);
     else if (command == "resize")      status = CmdResize        (cli, rules, database, journal            );
+    else if (command == "retag")       status = CmdRetag         (cli, rules, database, journal            );
     else if (command == "shorten")     status = CmdShorten       (cli, rules, database, journal            );
     else if (command == "show")        status = CmdShow          (     rules                               );
     else if (command == "split")       status = CmdSplit         (cli, rules, database, journal            );

test/retag.t

@@ -0,0 +1,339 @@
+#!/usr/bin/env python3
+
+###############################################################################
+#
+# Copyright 2023, Thomas Lauf, Paul Beckingham, Federico Hernandez.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+# https://www.opensource.org/licenses/mit-license.php
+#
+###############################################################################
+
+import os
+import sys
+import unittest
+from datetime import datetime, timedelta
+
+# Ensure python finds the local simpletap module
+sys.path.append(os.path.dirname(os.path.abspath(__file__)))
+
+from basetest import Timew, TestCase
+
+
+class TestTag(TestCase):
+    def setUp(self):
+        """Executed before each test in the class"""
+        self.t = Timew()
+
+    def test_should_use_default_on_missing_id_and_active_time_tracking(self):
+        """Use open interval when retagging with missing id and active time tracking"""
+        now_utc = datetime.now().utcnow()
+        one_hour_before_utc = now_utc - timedelta(hours=1)
+        two_hours_before_utc = now_utc - timedelta(hours=2)
+
+        self.t("track {:%Y-%m-%dT%H:%M:%S}Z - {:%Y-%m-%dT%H:%M:%S}Z foo".format(two_hours_before_utc, one_hour_before_utc))
+        self.t("start {:%Y-%m-%dT%H:%M:%S}Z bar".format(one_hour_before_utc))
+
+        code, out, err = self.t("retag baz")
+
+        self.assertIn("Retagged @1 as baz", out)
+
+        j = self.t.export()
+        self.assertClosedInterval(j[0], expectedTags=["foo"])
+        self.assertOpenInterval(j[1], expectedTags=["baz"])
+
+    def test_should_fail_on_missing_id_and_empty_database(self):
+        """Retagging interval with missing id on empty database is an error"""
+        code, out, err = self.t.runError("retag foo")
+
+        self.assertIn("There is no active time tracking.", err)
+
+    def test_should_fail_on_missing_id_and_inactive_time_tracking(self):
+        """Retagging with missing id on inactive time tracking is an error"""
+        now_utc = datetime.now().utcnow()
+        one_hour_before_utc = now_utc - timedelta(hours=1)
+
+        self.t("track {:%Y-%m-%dT%H:%M:%S}Z - {:%Y-%m-%dT%H:%M:%S}Z".format(one_hour_before_utc, now_utc))
+
+        code, out, err = self.t.runError("retag foo")
+
+        self.assertIn("At least one ID must be specified.", err)
+
+    def test_should_fail_on_no_tags(self):
+        """Calling command 'retag' without tags is an error"""
+        now_utc = datetime.now().utcnow()
+        one_hour_before_utc = now_utc - timedelta(hours=1)
+
+        self.t("track {:%Y-%m-%dT%H:%M:%S}Z - {:%Y-%m-%dT%H:%M:%S}Z".format(one_hour_before_utc, now_utc))
+
+        code, out, err = self.t.runError("retag @1")
+
+        self.assertIn("At least one tag must be specified.", err)
+
+    def test_retag_tagless_closed_interval_with_single_tag(self):
+        """Retag a tagless, closed interval with a single tag"""
+        now_utc = datetime.now().utcnow()
+        one_hour_before_utc = now_utc - timedelta(hours=1)
+
+        self.t("track {:%Y-%m-%dT%H:%M:%S}Z - {:%Y-%m-%dT%H:%M:%S}Z".format(one_hour_before_utc, now_utc))
+
+        code, out, err = self.t("retag @1 foo")
+
+        self.assertIn("Retagged @1 as foo", out)
+
+        j = self.t.export()
+        self.assertClosedInterval(j[0], expectedTags=["foo"])
+
+    def test_retag_tagless_closed_interval_with_multiple_tags(self):
+        """Retag a tagless, closed interval with multiple tags"""
+        now_utc = datetime.now().utcnow()
+        one_hour_before_utc = now_utc - timedelta(hours=1)
+
+        self.t("track {:%Y-%m-%dT%H:%M:%S}Z - {:%Y-%m-%dT%H:%M:%S}Z".format(one_hour_before_utc, now_utc))
+
+        code, out, err = self.t("retag @1 foo bar")
+
+        self.assertIn("Retagged @1 as bar foo", out)
+
+        j = self.t.export()
+        self.assertClosedInterval(j[0], expectedTags=["bar", "foo"])
+
+    def test_retag_tagless_open_interval_with_single_tag(self):
+        """Retag a tagless, open interval with a single tag"""
+        now_utc = datetime.now().utcnow()
+        one_hour_before_utc = now_utc - timedelta(hours=1)
+
+        self.t("start {:%Y-%m-%dT%H:%M:%S}Z".format(one_hour_before_utc))
+
+        code, out, err = self.t("retag @1 foo")
+
+        self.assertIn("Retagged @1 as foo", out)
+
+        j = self.t.export()
+        self.assertOpenInterval(j[0], expectedTags=["foo"])
+
+    def test_retag_tagless_open_interval_with_multiple_tags(self):
+        """Retag a tagless, open interval with multiple tags"""
+        now_utc = datetime.now().utcnow()
+        one_hour_before_utc = now_utc - timedelta(hours=1)
+
+        self.t("start {:%Y-%m-%dT%H:%M:%S}Z".format(one_hour_before_utc))
+
+        code, out, err = self.t("retag @1 foo bar")
+
+        self.assertIn("Retagged @1 as bar foo", out)
+
+        j = self.t.export()
+        self.assertOpenInterval(j[0], expectedTags=["bar", "foo"])
+
+    def test_retag_tagged_open_interval_with_single_tag(self):
+        """Retag a tagged, open interval with a single tag"""
+        now_utc = datetime.now().utcnow()
+        one_hour_before_utc = now_utc - timedelta(hours=1)
+
+        self.t("start {:%Y-%m-%dT%H:%M:%S}Z foo".format(one_hour_before_utc))
+
+        code, out, err = self.t("retag @1 bar")
+
+        self.assertIn("Retagged @1 as bar", out)
+
+        j = self.t.export()
+        self.assertOpenInterval(j[0], expectedTags=["bar"])
+
+    def test_retag_tagged_open_interval_with_multiple_tags(self):
+        """Retag a tagged, open interval with a single tag"""
+        now_utc = datetime.now().utcnow()
+        one_hour_before_utc = now_utc - timedelta(hours=1)
+
+        self.t("start {:%Y-%m-%dT%H:%M:%S}Z foo".format(one_hour_before_utc))
+
+        code, out, err = self.t("retag @1 bar buz")
+
+        self.assertIn("Retagged @1 as bar buz", out)
+
+        j = self.t.export()
+        self.assertOpenInterval(j[0], expectedTags=["bar", "buz"])
+
+    def test_retag_tagged_closed_interval_with_single_tag(self):
+        """Retag a tagged, closed interval with a single tag"""
+        now_utc = datetime.now().utcnow()
+        one_hour_before_utc = now_utc - timedelta(hours=1)
+
+        self.t("track {:%Y-%m-%dT%H:%M:%S}Z - {:%Y-%m-%dT%H:%M:%S}Z foo".format(one_hour_before_utc, now_utc))
+
+        code, out, err = self.t("retag @1 bar")
+
+        self.assertIn("Retagged @1 as bar", out)
+
+        j = self.t.export()
+        self.assertClosedInterval(j[0], expectedTags=["bar"])
+
+    def test_retag_tagged_closed_interval_with_multiple_tags(self):
+        """Retag a tagged, closed interval with multiple tag"""
+        now_utc = datetime.now().utcnow()
+        one_hour_before_utc = now_utc - timedelta(hours=1)
+
+        self.t("track {:%Y-%m-%dT%H:%M:%S}Z - {:%Y-%m-%dT%H:%M:%S}Z foo bar".format(one_hour_before_utc, now_utc))
+
+        code, out, err = self.t("retag @1 buz fuz")
+
+        self.assertIn("Retagged @1 as buz fuz", out)
+
+        j = self.t.export()
+        self.assertClosedInterval(j[0], expectedTags=["buz", "fuz"])
+
+    def test_retag_multiple_intervals_with_single_tag(self):
+        """Retag multiple intervals with a single tag"""
+        now_utc = datetime.now().utcnow()
+        one_hour_before_utc = now_utc - timedelta(hours=1)
+        two_hours_before_utc = now_utc - timedelta(hours=2)
+
+        self.t("track {:%Y-%m-%dT%H:%M:%S}Z - {:%Y-%m-%dT%H:%M:%S}Z one".format(two_hours_before_utc, one_hour_before_utc))
+        self.t("track {:%Y-%m-%dT%H:%M:%S}Z - {:%Y-%m-%dT%H:%M:%S}Z two".format(one_hour_before_utc, now_utc))
+
+        code, out, err = self.t("retag @1 @2 foo")
+
+        self.assertIn("Retagged @2 as foo\nRetagged @1 as foo", out)
+
+        j = self.t.export()
+        self.assertClosedInterval(j[0], expectedTags=["foo"])
+        self.assertClosedInterval(j[1], expectedTags=["foo"])
+
+    def test_retag_multiple_intervals_with_multiple_tags(self):
+        """Retag multiple intervals with multiple tags"""
+        now_utc = datetime.now().utcnow()
+        one_hour_before_utc = now_utc - timedelta(hours=1)
+        two_hours_before_utc = now_utc - timedelta(hours=2)
+
+        self.t("track {:%Y-%m-%dT%H:%M:%S}Z - {:%Y-%m-%dT%H:%M:%S}Z one".format(two_hours_before_utc, one_hour_before_utc))
+        self.t("track {:%Y-%m-%dT%H:%M:%S}Z - {:%Y-%m-%dT%H:%M:%S}Z two".format(one_hour_before_utc, now_utc))
+
+        code, out, err = self.t("retag @1 @2 foo bar")
+
+        self.assertIn("Retagged @2 as bar foo\nRetagged @1 as bar foo", out)
+
+        j = self.t.export()
+        self.assertClosedInterval(j[0], expectedTags=["bar", "foo"])
+        self.assertClosedInterval(j[1], expectedTags=["bar", "foo"])
+
+    def test_retag_synthetic_interval(self):
+        """Retag a synthetic interval."""
+        now = datetime.now()
+        three_hours_before = now - timedelta(hours=3)
+        four_hours_before = now - timedelta(hours=4)
+
+        now_utc = now.utcnow()
+        three_hours_before_utc = now_utc - timedelta(hours=3)
+        four_hours_before_utc = now_utc - timedelta(hours=4)
+        five_hours_before_utc = now_utc - timedelta(hours=5)
+
+        self.t.configure_exclusions((four_hours_before.time(), three_hours_before.time()))
+        self.t("start {:%Y-%m-%dT%H:%M:%S}Z foo".format(five_hours_before_utc))
+
+        self.t("retag @2 bar")
+
+        j = self.t.export()
+
+        self.assertEqual(len(j), 2)
+        self.assertClosedInterval(j[0],
+                                  expectedStart="{:%Y%m%dT%H%M%S}Z".format(five_hours_before_utc),
+                                  expectedEnd="{:%Y%m%dT%H%M%S}Z".format(four_hours_before_utc),
+                                  expectedTags=["bar"],
+                                  description="modified interval")
+        self.assertOpenInterval(j[1],
+                                expectedStart="{:%Y%m%dT%H%M%S}Z".format(three_hours_before_utc),
+                                expectedTags=["foo"],
+                                description="unmodified interval")
+
+    def test_retag_with_identical_ids(self):
+        """Call 'retag' with identical ids"""
+        now_utc = datetime.now().utcnow()
+        one_hour_before_utc = now_utc - timedelta(hours=1)
+
+        self.t("track {:%Y-%m-%dT%H:%M:%S}Z - {:%Y-%m-%dT%H:%M:%S}Z".format(one_hour_before_utc, now_utc))
+        self.t("tag @1 @1 foo")
+
+        j = self.t.export()
+
+        self.assertEqual(len(j), 1)
+        self.assertClosedInterval(j[0], expectedTags=["foo"])
+
+    def test_retag_with_new_tag(self):
+        """Call 'retag' with new tag"""
+        now_utc = datetime.now().utcnow()
+
+        two_hours_before_utc = now_utc - timedelta(hours=2)
+        one_hour_before_utc = now_utc - timedelta(hours=1)
+
+        self.t("track {:%Y-%m-%dT%H:%M:%S} - {:%Y-%m-%dT%H:%M:%S} foo".format(two_hours_before_utc, one_hour_before_utc))
+        code, out, err = self.t("retag @1 bar")
+
+        self.assertIn("Note: 'bar' is a new tag", out)
+        self.assertIn("Retagged @1 as bar", out)
+
+    def test_retag_with_previous_tag(self):
+        """Call 'retag' with previous tag"""
+        now_utc = datetime.now().utcnow()
+
+        three_hours_before_utc = now_utc - timedelta(hours=3)
+        two_hours_before_utc = now_utc - timedelta(hours=2)
+        one_hour_before_utc = now_utc - timedelta(hours=1)
+
+        self.t("track {:%Y-%m-%dT%H:%M:%S} - {:%Y-%m-%dT%H:%M:%S} bar".format(three_hours_before_utc, two_hours_before_utc))
+        self.t("track {:%Y-%m-%dT%H:%M:%S} - {:%Y-%m-%dT%H:%M:%S} foo".format(two_hours_before_utc, one_hour_before_utc))
+        code, out, err = self.t("retag @1 bar")
+
+        self.assertNotIn("Note: 'bar' is a new tag", out)
+        self.assertIn("Retagged @1 as bar", out)
+
+    def test_retag_with_percent_sign(self):
+        """Call 'retag' with an embedded percent sign"""
+        self.t("start 1h ago bar")
+        code, out, err = self.t("retag @1 reta%g")
+
+        self.assertIn("Note: '\"reta%g\"' is a new tag", out)
+
+        self.t("stop")
+        self.t("delete @1")
+
+    def test_retag_with_double_quote(self):
+        """Call 'retag' with an embedded double quote sign"""
+        self.t("start 1h ago bar")
+        code, out, err = self.t("retag @1 'this is a \"test\"'")
+
+        self.assertIn("Note: '\"this is a \\\"test\\\"\"' is a new tag", out)
+        self.t("stop")
+        self.t("delete @1")
+
+    def test_referencing_a_non_existent_interval_is_an_error(self):
+        """Calling retag with a non-existent interval reference is an error"""
+        code, out, err = self.t.runError("retag @1 @2 foo")
+        self.assertIn("ID '@1' does not correspond to any tracking.", err)
+
+        self.t("start 1h ago bar")
+
+        code, out, err = self.t.runError("retag @2 foo")
+        self.assertIn("ID '@2' does not correspond to any tracking.", err)
+
+
+if __name__ == "__main__":
+    from simpletap import TAPTestRunner
+
+    unittest.main(testRunner=TAPTestRunner())