fix: ensure all Person instances have valid ids

closes #812

Author: rokroskar

docs/models/datasets.rst

@@ -37,11 +37,3 @@ Manage files in the dataset.
 .. autoclass:: renku.core.models.datasets.DatasetFile
    :members:
    :inherited-members:
-
-
-Creator
--------
-
-.. autoclass:: renku.core.models.creators.Creator
-   :members:
-   :inherited-members:

renku/cli/exception_handler.py

@@ -136,10 +136,10 @@ def _handle_sentry(self):
             with capture_internal_exceptions():
                 from git import Repo
                 from renku.core.commands import get_git_home
-                from renku.core.models.creators import Creator
+                from renku.core.models.provenance.agents import Person
 
                 repo = Repo(get_git_home())
-                user = Creator.from_git(repo)
+                user = Person.from_git(repo)
 
                 scope.user = {'name': user.name, 'email': user.email}
 

renku/core/commands/dataset.py

@@ -42,8 +42,8 @@
     MigrationRequired, ParameterError, UsageError
 from renku.core.management.datasets import DATASET_METADATA_PATHS
 from renku.core.management.git import COMMIT_DIFF_STRATEGY
-from renku.core.models.creators import Creator
 from renku.core.models.datasets import Dataset
+from renku.core.models.provenance.agents import Person
 from renku.core.models.refs import LinkReference
 from renku.core.models.tabulate import tabulate
 from renku.core.utils.doi import extract_doi
@@ -106,7 +106,7 @@ def create_dataset(client, name):
     :raises: ``renku.core.errors.ParameterError``
     """
     with client.with_dataset(name=name, create=True) as dataset:
-        creator = Creator.from_git(client.repo)
+        creator = Person.from_git(client.repo)
         if creator not in dataset.creator:
             dataset.creator.append(creator)
 

renku/core/management/datasets.py

@@ -35,10 +35,10 @@
 
 from renku.core import errors
 from renku.core.management.config import RENKU_HOME
-from renku.core.models.creators import Creator
 from renku.core.models.datasets import Dataset, DatasetFile, DatasetTag
 from renku.core.models.git import GitURL
 from renku.core.models.locals import with_reference
+from renku.core.models.provenance.agents import Person
 from renku.core.models.refs import LinkReference
 
 
@@ -425,7 +425,7 @@ def _add_from_git(
                     creators = []
                     # grab all the creators from the commit history
                     for commit in repo.iter_commits(paths=path):
-                        creator = Creator.from_commit(commit)
+                        creator = Person.from_commit(commit)
                         if creator not in creators:
                             creators.append(creator)
 
@@ -727,7 +727,7 @@ def update_dataset_files(self, files, ref, delete=False):
             creators = []
             # grab all the creators from the commit history
             for commit in repo.iter_commits(paths=file_.path):
-                creator = Creator.from_commit(commit)
+                creator = Person.from_commit(commit)
                 if creator not in creators:
                     creators.append(creator)
 

renku/core/management/repository.py

@@ -394,8 +394,8 @@ def init_repository(self, name=None, force=False):
         self.repo.description = name or path.name
 
         # Check that an creator can be determined from Git.
-        from renku.core.models.creators import Creator
-        Creator.from_git(self.repo)
+        from renku.core.models.provenance.agents import Person
+        Person.from_git(self.repo)
 
         # TODO read existing gitignore and create a unique set of rules
         import pkg_resources

renku/core/models/creators.py

@@ -29,8 +29,9 @@
 import attr
 from attr.validators import instance_of
 
-from renku.core.models.creators import Creator, CreatorsMixin
+# from renku.core.models.creators import CreatorsMixin
 from renku.core.models.entities import Entity
+from renku.core.models.provenance.agents import Person
 from renku.core.utils.datetime8601 import parse_date
 from renku.core.utils.doi import extract_doi, is_doi
 
@@ -44,6 +45,32 @@
 )
 
 
+def _convert_creators(value):
+    """Convert creators."""
+    if isinstance(value, dict):  # compatibility with previous versions
+        return [Person.from_jsonld(value)]
+
+    if isinstance(value, list):
+        return [Person.from_jsonld(v) for v in value]
+
+
+@attr.s
+class CreatorMixin:
+    """Mixin for handling creators container."""
+
+    creator = jsonld.container.list(
+        Person,
+        kw_only=True,
+        context='schema:creator',
+        converter=_convert_creators
+    )
+
+    @property
+    def creators_csv(self):
+        """Comma-separated list of creators associated with dataset."""
+        return ','.join(creator.name for creator in self.creator)
+
+
 def _extract_doi(value):
     """Return either a string or the doi part of a URL."""
     value = str(value)
@@ -117,17 +144,6 @@ class Language:
     name = jsonld.ib(default=None, kw_only=True, context='schema:name')
 
 
-def _convert_dataset_files_creators(value):
-    """Convert dataset files creators."""
-    coll = value
-
-    if isinstance(coll, dict):
-        return [Creator.from_jsonld(coll)]
-
-    if isinstance(coll, list):
-        return [Creator.from_jsonld(c) for c in coll]
-
-
 def convert_filename_path(p):
     """Return name of the file."""
     if p:
@@ -141,16 +157,9 @@ def convert_filename_path(p):
         'schema': 'http://schema.org/',
     }
 )
-class DatasetFile(Entity, CreatorsMixin):
+class DatasetFile(Entity, CreatorMixin):
     """Represent a file in a dataset."""
 
-    creator = jsonld.container.list(
-        Creator,
-        converter=_convert_dataset_files_creators,
-        kw_only=True,
-        context='schema:creator'
-    )
-
     added = jsonld.ib(
         converter=parse_date, context='schema:dateCreated', kw_only=True
     )
@@ -226,15 +235,6 @@ def _convert_dataset_tags(value):
     return [DatasetTag.from_jsonld(v) for v in value]
 
 
-def _convert_dataset_creator(value):
-    """Convert dataset creators."""
-    if isinstance(value, dict):  # compatibility with previous versions
-        return [Creator.from_jsonld(value)]
-
-    if isinstance(value, list):
-        return [Creator.from_jsonld(v) for v in value]
-
-
 def _convert_language(obj):
     """Convert language object."""
     if isinstance(obj, dict):
@@ -257,7 +257,7 @@ def _convert_keyword(keywords):
         'schema': 'http://schema.org/',
     },
 )
-class Dataset(Entity, CreatorsMixin):
+class Dataset(Entity, CreatorMixin):
     """Repesent a dataset."""
 
     SUPPORTED_SCHEMES = ('', 'file', 'http', 'https', 'git+https', 'git+ssh')
@@ -270,13 +270,6 @@ class Dataset(Entity, CreatorsMixin):
     _id = jsonld.ib(default=None, context='@id', kw_only=True)
     _label = jsonld.ib(default=None, context='rdfs:label', kw_only=True)
 
-    creator = jsonld.container.list(
-        Creator,
-        converter=_convert_dataset_creator,
-        context='schema:creator',
-        kw_only=True
-    )
-
     date_published = jsonld.ib(
         default=None, context='schema:datePublished', kw_only=True
     )

renku/core/models/datasets.py

@@ -23,8 +23,8 @@
 import attr
 
 from renku.core.models import jsonld
-from renku.core.models.creators import Creator
 from renku.core.models.datastructures import Collection
+from renku.core.models.provenance.agents import Person
 from renku.core.utils.datetime8601 import parse_date
 
 PROJECT_URL_PATH = 'projects'
@@ -75,7 +75,7 @@ class Project(object):
             '@id': 'schema:creator',
             '@type': 'schema:Person',
         },
-        type=Creator
+        type=Person
     )
 
     _id = jsonld.ib(context='@id', kw_only=True, default=None)
@@ -90,14 +90,14 @@ def __attrs_post_init__(self):
         """Initialize computed attributes."""
         if not self.creator and self.client:
             if self.client.renku_metadata_path.exists():
-                self.creator = Creator.from_commit(
+                self.creator = Person.from_commit(
                     self.client.find_previous_commit(
                         self.client.renku_metadata_path, return_first=True
                     ),
                 )
             else:
                 # this assumes the project is being newly created
-                self.creator = Creator.from_git(self.client.repo)
+                self.creator = Person.from_git(self.client.repo)
 
         self._id = self.project_id