fix: make Creator a subclass of Person

closes #793

Author: rokroskar

renku/core/commands/graph.py

@@ -31,9 +31,9 @@
 from renku.core.models.cwl.workflow import Workflow
 from renku.core.models.entities import Collection, Entity
 from renku.core.models.git import Range
-from renku.core.models.provenance import Activity, Generation, ProcessRun, \
-    Usage
+from renku.core.models.provenance.activities import Activity, ProcessRun, Usage
 from renku.core.models.provenance.processes import Process
+from renku.core.models.provenance.qualified import Generation
 
 LINK_CWL = CommandLineTool(
     baseCommand=['true'],

renku/core/models/creators.py

@@ -17,46 +17,26 @@
 # limitations under the License.
 """Model objects representing a creator."""
 import configparser
-import re
-import uuid
 
 import attr
-from attr.validators import instance_of
 
 from renku.core import errors
+from renku.core.models.provenance.agents import Person
 
 from . import jsonld as jsonld
 
 
-@jsonld.s(
-    type='schema:Person',
-    context={'schema': 'http://schema.org/'},
-    slots=True,
-)
-class Creator(object):
+class Creator(Person):
     """Represent the creator of a resource."""
 
-    client = attr.ib(default=None, kw_only=True)
-
     affiliation = jsonld.ib(
         default=None, kw_only=True, context='schema:affiliation'
     )
 
-    email = jsonld.ib(default=None, kw_only=True, context='schema:email')
-
     alternate_name = jsonld.ib(
         default=None, kw_only=True, context='schema:alternateName'
     )
 
-    name = jsonld.ib(
-        default=None,
-        kw_only=True,
-        validator=instance_of(str),
-        context='schema:name'
-    )
-
-    _id = jsonld.ib(kw_only=True, context='@id')
-
     @property
     def short_name(self):
         """Gives full name in short form."""
@@ -70,14 +50,6 @@ def short_name(self):
 
         return '{0}.{1}'.format('.'.join(initials), last_name)
 
-    @email.validator
-    def check_email(self, attribute, value):
-        """Check that the email is valid."""
-        if self.email and not (
-            isinstance(value, str) and re.match(r'[^@]+@[^@]+\.[^@]+', value)
-        ):
-            raise ValueError('Email address is invalid.')
-
     @classmethod
     def from_git(cls, git):
         """Create an instance from a Git repo."""
@@ -104,18 +76,6 @@ def from_git(cls, git):
 
         return cls(name=name, email=email)
 
-    @classmethod
-    def from_commit(cls, commit):
-        """Create an instance from a Git commit."""
-        return cls(name=commit.author.name, email=commit.author.email)
-
-    @_id.default
-    def default_id(self):
-        """Set the default id."""
-        if self.email:
-            return 'mailto:{email}'.format(email=self.email)
-        return '_:{}'.format(str(uuid.uuid4()))
-
     def __attrs_post_init__(self):
         """Finish object initialization."""
         # handle the case where ids were improperly set

renku/core/models/provenance/__init__.py

@@ -19,22 +19,3 @@
 
 .. seealso:: https://www.w3.org/TR/prov-o/
 """
-
-from .activities import Activity, ProcessRun, WorkflowRun
-from .agents import Person, SoftwareAgent
-from .qualified import Generation, Usage
-from .processes import Process, Workflow
-
-__all__ = (
-    'Activity',
-    'Entity',
-    'Collection',
-    'Generation',
-    'Person',
-    'Process',
-    'ProcessRun',
-    'SoftwareAgent',
-    'Usage',
-    'Workflow',
-    'WorkflowRun',
-)

renku/core/models/provenance/agents.py

@@ -19,6 +19,8 @@
 
 import re
 
+from attr.validators import instance_of
+
 from renku.core.models import jsonld as jsonld
 from renku.version import __version__, version_url
 
@@ -31,28 +33,41 @@
     context={
         'schema': 'http://schema.org/',
         'prov': 'http://www.w3.org/ns/prov#',
+        'rdfs': 'http://www.w3.org/2000/01/rdf-schema#'
     },
     frozen=True,
     slots=True,
 )
 class Person:
     """Represent a person."""
 
-    name = jsonld.ib(context='rdfs:label')
-    email = jsonld.ib(context='schema:email')
+    name = jsonld.ib(
+        context='schema:name', kw_only=True, validator=instance_of(str)
+    )
+    email = jsonld.ib(context='schema:email', default=None, kw_only=True)
+    label = jsonld.ib(context='rdfs:label', kw_only=True)
 
-    _id = jsonld.ib(context='@id', init=False, kw_only=True)
+    _id = jsonld.ib(context='@id', kw_only=True)
 
     @_id.default
     def default_id(self):
-        """Configure calculated ID."""
-        return 'mailto:{0}'.format(self.email)
+        """Set the default id."""
+        if self.email:
+            return 'mailto:{email}'.format(email=self.email)
+        return '_:{}'.format(''.join(self.name.lowercase.split()))
 
     @email.validator
     def check_email(self, attribute, value):
         """Check that the email is valid."""
-        if not (isinstance(value, str) and re.match(r'[^@]+@[^@]+', value)):
-            raise ValueError('Email address "{0}" is invalid.'.format(value))
+        if self.email and not (
+            isinstance(value, str) and re.match(r'[^@]+@[^@]+\.[^@]+', value)
+        ):
+            raise ValueError('Email address is invalid.')
+
+    @label.default
+    def default_label(self):
+        """Set the default label."""
+        return self.name
 
     @classmethod
     def from_commit(cls, commit):

tests/core/models/test_projects.py

@@ -169,6 +169,8 @@ def test_project_creator_deserialization(client, project):
     )
     # the project creator should always be the one in the metadata
     assert client.project.creator.email == 'johndoe@example.com'
+    assert client.project.creator.name == 'Johnny Doe'
+    assert client.project.creator.label == client.project.creator.name
 
     # Remove the creator from metadata
     project = client.project
@@ -181,3 +183,5 @@ def test_project_creator_deserialization(client, project):
     # now the creator should be the one from the commit
     project = Project.from_yaml(client.renku_metadata_path, client=client)
     assert project.creator.email == 'janedoe@example.com'
+    assert project.creator.name == 'Jane Doe'
+    assert project.creator.label == project.creator.name