Remove issue filtering from base Service class

We here remove the abstract `get_owner` method and the concrete
`include` method from the base class and copy the `include` method to
the handful of services which make use of it. The `include` method was
only being used in 6 of 26 services, so I think the duplication is
acceptable in exchange for the benefits:

- This eliminates the last instance of bidirectional communication
  between the base classes and the service implementations, which in my
  opinion is an architectural problem.
- Since most of the services don't use this filtering mechanism, it is
  annoying to have to define `get_owner`.
- This filtering mechanism is somewhat legacy from the days when API's
  were generally far less capable. I don't think we should encourage it
  going forward because it is better to implement filtering through the
  API query rather than pulling all data and iterating over it locally,
  and this is a reasonable expectation from third party API's these
  days.

One might suspect that eliminating these NotImplementedError's would
eliminate the warnings from services that do not support
only_if_assigned, but in fact these would only get raised if the service
itself called `self.include`, which they do not. So a user trying to use
these options already would find them silently ignored, which isn't
great but is a problem for another day.

bugwarrior/docs/contributing/new-service.rst

@@ -187,12 +187,6 @@ Now for the main service class which bugwarrior will invoke to fetch issues.
 
           self.client = GitBugClient(path=self.config.path, port=self.config.port)
 
-      def get_owner(self, issue):
-          # Issue assignment hasn't been implemented in upstream git-bug yet.
-          # See https://github.com/MichaelMure/git-bug/issues/112.
-          raise NotImplementedError(
-              "This service has not implemented support for 'only_if_assigned'.")
-
       def issues(self):
           for issue in self.client.get_issues():
               comments = issue.pop('comments')
@@ -209,8 +203,6 @@ Now for the main service class which bugwarrior will invoke to fetch issues.
 
 Here we see two required class attributes (pointing to the classes we previously defined) and two required methods.
 
-The ``get_owner`` method takes an individual issue and returns the "assigned" user, so that bugwarrior can filter issues on this basis. In this case git-bug has not yet implemented this feature, but it generally will just involve returning a value from the ``issue`` dictionary.
-
 The ``issues`` method is a generator which yields individual issue dictionaries.
 
 7. Service Registration

bugwarrior/services/activecollab.py

@@ -193,10 +193,6 @@ def _comments(self, issue):
                          body=comment['body']))
         return comments_formatted
 
-    def get_owner(self, issue):
-        if issue['assignee_id']:
-            return issue['assignee_id']
-
     def annotations(self, issue, issue_obj):
         if 'type' not in issue:
             # Subtask

bugwarrior/services/activecollab2.py

@@ -204,11 +204,6 @@ def __init__(self, *args, **kw):
                                           self.config.projects,
                                           self.config.target)
 
-    def get_owner(self, issue):
-        # TODO
-        raise NotImplementedError(
-            "This service has not implemented support for 'only_if_assigned'.")
-
     def issues(self):
         # Loop through each project
         start = time.time()

bugwarrior/services/azuredevops.py

@@ -249,10 +249,6 @@ def issues(self):
             issue_obj.extra.update(extra)
             yield issue_obj
 
-    def get_owner(self, issue):
-        # Issue filtering is implemented as part of issue aggregation.
-        pass
-
     @staticmethod
     def get_keyring_service(config):
         return f"azuredevops://{config.organization}@{config.host}"

bugwarrior/services/base.py

@@ -106,24 +106,6 @@ def build_annotations(self, annotations, url=None):
                 final.append('@%s - %s' % (author, message))
         return final
 
-    def include(self, issue):
-        """ Return true if the issue in question should be included """
-        if self.config.only_if_assigned:
-            owner = self.get_owner(issue)
-            include_owners = [self.config.only_if_assigned]
-
-            if self.config.also_unassigned:
-                include_owners.append(None)
-
-            return owner in include_owners
-
-        return True
-
-    @abc.abstractmethod
-    def get_owner(self, issue):
-        """ Override this for filtering on tickets """
-        raise NotImplementedError()
-
     @abc.abstractmethod
     def issues(self):
         """ Returns a list of Issue instances representing issues from a remote service.

bugwarrior/services/bitbucket.py

@@ -179,6 +179,19 @@ def get_owner(self, issue):
         if assignee is not None:
             return assignee.get('username', None)
 
+    def include(self, issue):
+        """ Return true if the issue in question should be included """
+        if self.config.only_if_assigned:
+            owner = self.get_owner(issue)
+            include_owners = [self.config.only_if_assigned]
+
+            if self.config.also_unassigned:
+                include_owners.append(None)
+
+            return owner in include_owners
+
+        return True
+
     def issues(self):
         user = self.config.username
         response = self.get_collection('/repositories/' + user + '/')

bugwarrior/services/bts.py

@@ -142,11 +142,6 @@ class BTSService(Service, Client):
     ISSUE_CLASS = BTSIssue
     CONFIG_SCHEMA = BTSConfig
 
-    def get_owner(self, issue):
-        # TODO
-        raise NotImplementedError(
-            "This service has not implemented support for 'only_if_assigned'.")
-
     def _record_for_bug(self, bug):
         return {'number': bug.bug_num,
                 'url': 'https://bugs.debian.org/' + str(bug.bug_num),

bugwarrior/services/bz.py

@@ -189,6 +189,19 @@ def get_keyring_service(config):
     def get_owner(self, issue):
         return issue['assigned_to']
 
+    def include(self, issue):
+        """ Return true if the issue in question should be included """
+        if self.config.only_if_assigned:
+            owner = self.get_owner(issue)
+            include_owners = [self.config.only_if_assigned]
+
+            if self.config.also_unassigned:
+                include_owners.append(None)
+
+            return owner in include_owners
+
+        return True
+
     def annotations(self, tag, issue):
         base_url = "%s/show_bug.cgi?id=" % self.config.base_uri
         long_url = base_url + str(issue['id'])

bugwarrior/services/deck.py

@@ -166,6 +166,19 @@ def __init__(self, *args, **kwargs):
     def get_owner(self, issue):
         return issue[issue.ASSIGNEE]
 
+    def include(self, issue):
+        """ Return true if the issue in question should be included """
+        if self.config.only_if_assigned:
+            owner = self.get_owner(issue)
+            include_owners = [self.config.only_if_assigned]
+
+            if self.config.also_unassigned:
+                include_owners.append(None)
+
+            return owner in include_owners
+
+        return True
+
     def filter_boards(self, board):
         # include_board_ids takes precedence over exclude_board_ids
         if self.config.include_board_ids:

bugwarrior/services/gerrit.py

@@ -116,11 +116,6 @@ def __init__(self, *args, **kw):
     def get_keyring_service(config):
         return f"gerrit://{config.base_uri}"
 
-    def get_owner(self, issue):
-        # TODO
-        raise NotImplementedError(
-            "This service has not implemented support for 'only_if_assigned'.")
-
     def issues(self):
         # Construct the whole url by hand here, because otherwise requests will
         # percent-encode the ':' characters, which gerrit doesn't like.

bugwarrior/services/gitbug.py

@@ -157,12 +157,6 @@ def __init__(self, *args, **kwargs):
             port=self.config.port,
             annotation_comments=self.main_config.annotation_comments)
 
-    def get_owner(self, issue):
-        # Issue assignment hasn't been implemented in upstream git-bug yet.
-        # See https://github.com/MichaelMure/git-bug/issues/112.
-        raise NotImplementedError(
-            "This service has not implemented support for 'only_if_assigned'.")
-
     def issues(self):
         for issue in self.client.get_issues():
             comments = issue.pop('comments')

bugwarrior/services/github.py

@@ -439,12 +439,23 @@ def filter_repo_name(self, name):
         return True
 
     def include(self, issue):
+        """ Return true if the issue in question should be included """
         if 'pull_request' in issue[1]:
             if self.config.exclude_pull_requests:
                 return False
             if not self.config.filter_pull_requests:
                 return True
-        return super().include(issue)
+
+        if self.config.only_if_assigned:
+            owner = self.get_owner(issue)
+            include_owners = [self.config.only_if_assigned]
+
+            if self.config.also_unassigned:
+                include_owners.append(None)
+
+            return owner in include_owners
+
+        return True
 
     def issues(self):
         issues = {}

bugwarrior/services/gmail.py

@@ -204,10 +204,6 @@ def annotations(self, issue):
         issue_url = issue.extra['url']
         return self.build_annotations([(sender, subj)], issue_url)
 
-    def get_owner(self, issue):
-        raise NotImplementedError(
-            "This service has not implemented support for 'only_if_assigned'.")
-
     def issues(self):
         labels = self.get_labels()
         for thread in self.get_threads():

bugwarrior/services/jira.py

@@ -413,11 +413,6 @@ def __init__(self, *args, **kw):
     def get_keyring_service(config):
         return f"jira://{config.username}@{config.base_uri}"
 
-    def get_owner(self, issue):
-        # TODO
-        raise NotImplementedError(
-            "This service has not implemented support for 'only_if_assigned'.")
-
     def body(self, issue):
         body = issue.record.get('fields', {}).get('description')
 

bugwarrior/services/kanboard.py

@@ -163,11 +163,6 @@ def issues(self):
 
             yield self.get_issue_for_record(task, extra)
 
-    def get_owner(self, issue):
-        # TODO
-        raise NotImplementedError(
-            "This service has not implemented support for 'only_if_assigned'.")
-
     @staticmethod
     def get_keyring_service(config):
         parsed = urlparse(config.url)

bugwarrior/services/logseq.py

@@ -296,12 +296,6 @@ def __init__(self, *args, **kwargs):
             filter=filter,
         )
 
-    def get_owner(self, issue):
-        # Issue assignment hasn't been implemented yet.
-        raise NotImplementedError(
-            "This service has not implemented support for 'only_if_assigned'."
-        )
-
     def issues(self):
         graph_name = self.client.get_graph_name()
         for issue in self.client.get_issues():

bugwarrior/services/pagure.py

@@ -154,6 +154,19 @@ def get_owner(self, issue):
         if issue[1]['assignee']:
             return issue[1]['assignee']['name']
 
+    def include(self, issue):
+        """ Return true if the issue in question should be included """
+        if self.config.only_if_assigned:
+            owner = self.get_owner(issue)
+            include_owners = [self.config.only_if_assigned]
+
+            if self.config.also_unassigned:
+                include_owners.append(None)
+
+            return owner in include_owners
+
+        return True
+
     def filter_repos(self, repo):
         if repo in self.config.exclude_repos:
             return False

bugwarrior/services/phab.py

@@ -243,10 +243,6 @@ def revisions(self):
             }
             yield self.get_issue_for_record(diff, extra)
 
-    def get_owner(self, issue):
-        # Issue filtering is implemented as part of issue aggregation.
-        pass
-
     def issues(self):
         yield from self.tasks()
         yield from self.revisions()

bugwarrior/services/pivotaltracker.py

@@ -71,10 +71,6 @@ class PivotalTrackerIssue(Issue):
 
     UNIQUE_KEY = (URL,)
 
-    def get_owner(self, issue):
-        _, issue = issue
-        return issue.get('pivotalowners')
-
     def to_taskwarrior(self):
         description = self.record.get('description')
         created = self.parse_date(self.record.get('created_at'))
@@ -148,10 +144,6 @@ def __init__(self, *args, **kwargs):
             if self.config.only_if_author:
                 self.query += f" requester:{self.config.user_id}"
 
-    def get_owner(self, issue):
-        # Issue filtering is implemented as part of the api query.
-        pass
-
     def annotations(self, annotations, story):
         final_annotations = []
         if self.main_config.annotation_comments:

bugwarrior/services/redmine.py

@@ -265,10 +265,6 @@ def __init__(self, *args, **kw):
     def get_keyring_service(config):
         return f"redmine://{config.login}@{config.url}/"
 
-    def get_owner(self, issue):
-        # Issue filtering is implemented as part of the api query.
-        pass
-
     def issues(self):
         issues = self.client.find_issues(
             self.config.issue_limit, self.config.query, self.config.only_if_assigned)

bugwarrior/services/taiga.py

@@ -80,11 +80,6 @@ def __init__(self, *args, **kw):
     def get_keyring_service(config):
         return f"taiga://{config.base_uri}"
 
-    def get_owner(self, issue):
-        # TODO
-        raise NotImplementedError(
-            "This service has not implemented support for 'only_if_assigned'.")
-
     def _issues(self, userid, task_type, task_type_plural, task_type_short):
         log.debug('Getting %s' % task_type_plural)
 

bugwarrior/services/teamwork_projects.py

@@ -145,9 +145,6 @@ def get_comments(self, issue):
                 return self.build_annotations(comment_list, None)
         return []
 
-    def get_owner(self, issue):
-        return issue.get_owner()
-
     def issues(self):
         response = self.client.call_api("GET", "/tasks.json")
         for issue in response["todo-items"]:

bugwarrior/services/trac.py

@@ -131,6 +131,19 @@ def get_owner(self, issue):
         tag, issue = issue
         return issue.get('owner', None) or None
 
+    def include(self, issue):
+        """ Return true if the issue in question should be included """
+        if self.config.only_if_assigned:
+            owner = self.get_owner(issue)
+            include_owners = [self.config.only_if_assigned]
+
+            if self.config.also_unassigned:
+                include_owners.append(None)
+
+            return owner in include_owners
+
+        return True
+
     def issues(self):
         base_url = "https://" + self.config.base_uri
         if self.trac:

bugwarrior/services/trello.py

@@ -85,10 +85,6 @@ class TrelloService(Service, Client):
     ISSUE_CLASS = TrelloIssue
     CONFIG_SCHEMA = TrelloConfig
 
-    def get_owner(self, issue):
-        # Issue filtering is implemented as part of the api query.
-        pass
-
     @staticmethod
     def get_keyring_service(config):
         return f"trello://{config.api_key}@trello.com"

bugwarrior/services/youtrack.py

@@ -147,11 +147,6 @@ def __init__(self, *args, **kw):
     def get_keyring_service(config):
         return f"youtrack://{config.login}@{config.host}"
 
-    def get_owner(self, issue):
-        # TODO
-        raise NotImplementedError(
-            "This service has not implemented support for 'only_if_assigned'.")
-
     def issues(self):
         params = {
             'query': self.config.query,