Merge branch 'mb/fetch' into develop

1 files changed, 217 insertions, 7 deletions

diff --git a/test/graph/test_nodes.py b/test/graph/test_nodes.py
index 2870f35..6bb3ef3 100644
--- a/test/graph/test_nodes.py
+++ b/test/graph/test_nodes.py
@@ -4,13 +4,18 @@ Part of the bsfs test suite.
 A copy of the license is provided with the project.
 Author: Matthias Baumgartner, 2022
 """
-# imports
-import rdflib
+# standard imports
+from functools import partial
+import operator
 import unittest
 
+# external imports
+import rdflib
+
 # bsie imports
-from bsfs import schema as _schema
-from bsfs.namespace import ns
+from bsfs import schema as bsc
+from bsfs.graph.walk import Walk
+from bsfs.namespace import Namespace, ns
 from bsfs.triple_store.sparql import SparqlStore
 from bsfs.utils import errors, URI
 
@@ -20,11 +25,13 @@ from bsfs.graph.nodes import Nodes
 
 ## code ##
 
+bst = Namespace('http://bsfs.ai/schema/Tag')
+
 class TestNodes(unittest.TestCase):
     def setUp(self):
         # initialize backend
         self.backend = SparqlStore()
-        self.backend.schema = _schema.from_string('''
+        self.backend.schema = bsc.from_string('''
             prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#>
             prefix xsd: <http://www.w3.org/2001/XMLSchema#>
 
@@ -67,6 +74,11 @@ class TestNodes(unittest.TestCase):
                 rdfs:range bsfs:User ;
                 bsfs:unique "true"^^xsd:boolean .
 
+            bst:label rdfs:subClassOf bsfs:Predicate ;
+                rdfs:domain bsfs:Tag ;
+                rdfs:range xsd:string ;
+                bsfs:unique "true"^^xsd:boolean .
+
             bst:representative rdfs:subClassOf bsfs:Predicate ;
                 rdfs:domain bsfs:Tag ;
                 rdfs:range bsfs:Entity ;
@@ -80,6 +92,7 @@ class TestNodes(unittest.TestCase):
             (rdflib.URIRef(ns.bsfs.User), rdflib.RDFS.subClassOf, rdflib.URIRef(ns.bsfs.Node)),
             (rdflib.URIRef(ns.xsd.string), rdflib.RDFS.subClassOf, rdflib.URIRef(ns.bsfs.Literal)),
             (rdflib.URIRef(ns.bsfs.Array), rdflib.RDFS.subClassOf, rdflib.URIRef(ns.bsfs.Literal)),
+            (rdflib.URIRef(ns.bsfs.BinaryBlob), rdflib.RDFS.subClassOf, rdflib.URIRef(ns.bsfs.Literal)),
             (rdflib.URIRef(ns.bsfs.Feature), rdflib.RDFS.subClassOf, rdflib.URIRef(ns.bsfs.Array)),
             (rdflib.URIRef(ns.bsfs.Number), rdflib.RDFS.subClassOf, rdflib.URIRef(ns.bsfs.Literal)),
             (rdflib.URIRef(ns.bsfs.Time), rdflib.RDFS.subClassOf, rdflib.URIRef(ns.bsfs.Literal)),
@@ -89,7 +102,8 @@ class TestNodes(unittest.TestCase):
             (rdflib.URIRef(ns.bse.filesize), rdflib.RDFS.subClassOf, rdflib.URIRef(ns.bsfs.Predicate)),
             (rdflib.URIRef(ns.bse.tag), rdflib.RDFS.subClassOf, rdflib.URIRef(ns.bsfs.Predicate)),
             (rdflib.URIRef(ns.bse.author), rdflib.RDFS.subClassOf, rdflib.URIRef(ns.bsfs.Predicate)),
-            (rdflib.URIRef('http://bsfs.ai/schema/Tag#representative'), rdflib.RDFS.subClassOf, rdflib.URIRef(ns.bsfs.Predicate)),
+            (rdflib.URIRef(bst.representative), rdflib.RDFS.subClassOf, rdflib.URIRef(ns.bsfs.Predicate)),
+            (rdflib.URIRef(bst.label), rdflib.RDFS.subClassOf, rdflib.URIRef(ns.bsfs.Predicate)),
             }
         # Nodes constructor args
         self.user = URI('http://example.com/me')
@@ -100,7 +114,8 @@ class TestNodes(unittest.TestCase):
         self.p_filesize = self.backend.schema.predicate(ns.bse.filesize)
         self.p_author = self.backend.schema.predicate(ns.bse.author)
         self.p_tag = self.backend.schema.predicate(ns.bse.tag)
-        self.p_representative = self.backend.schema.predicate(URI('http://bsfs.ai/schema/Tag#representative'))
+        self.p_representative = self.backend.schema.predicate(bst.representative)
+        self.p_label = self.backend.schema.predicate(bst.label)
         self.t_created = self.backend.schema.predicate(ns.bsm.t_created)
         self.ent_ids = {
             URI('http://example.com/me/entity#1234'),
@@ -371,6 +386,201 @@ class TestNodes(unittest.TestCase):
             (self.p_author.uri, Nodes(self.backend, self.user, self.user_type, {URI('http://example.com/me/user#1234'), URI('http://example.com/me/user#4321')}))))
         self.assertSetEqual(curr, set(self.backend._graph))
 
+    def test_get(self):
+        # setup: add some instances
+        Nodes(self.backend, self.user, self.ent_type, {'http://example.com/me/entity#1234'}) \
+            .set(ns.bse.comment, 'hello world') \
+            .set(ns.bse.filesize, 1234) \
+            .set(ns.bse.tag, Nodes(self.backend, self.user, self.tag_type, {'http://example.com/me/tag#1234'}))
+        Nodes(self.backend, self.user, self.ent_type, {'http://example.com/me/entity#4321'}) \
+            .set(ns.bse.filesize, 4321) \
+            .set(ns.bse.tag, Nodes(self.backend, self.user, self.tag_type, {'http://example.com/me/tag#4321'}))
+        Nodes(self.backend, self.user, self.tag_type, {'http://example.com/me/tag#1234'}) \
+            .set(bst.label, 'tag_label_1234')
+        Nodes(self.backend, self.user, self.tag_type, {'http://example.com/me/tag#4321'}) \
+            .set(bst.label, 'tag_label_4321')
+        # setup: get nodes instance
+        nodes = Nodes(self.backend, self.user, self.ent_type, self.ent_ids)
+        # must pass at least one path
+        self.assertRaises(AttributeError, nodes.get)
+        # view must be list or dict
+        self.assertRaises(ValueError, nodes.get, ns.bse.filesize, view='hello')
+        self.assertRaises(ValueError, nodes.get, ns.bse.filesize, view=1234)
+        self.assertRaises(ValueError, nodes.get, ns.bse.filesize, view=tuple)
+        # can pass path as URI
+        self.assertDictEqual(nodes.get(ns.bse.filesize), {
+            Nodes(self.backend, self.user, self.ent_type, {'http://example.com/me/entity#1234'}): 1234,
+            Nodes(self.backend, self.user, self.ent_type, {'http://example.com/me/entity#4321'}): 4321,
+            })
+        # can pass path as sequence of URI
+        self.assertDictEqual(nodes.get((ns.bse.tag, bst.label)), {
+            Nodes(self.backend, self.user, self.ent_type, {'http://example.com/me/entity#1234'}): {'tag_label_1234'},
+            Nodes(self.backend, self.user, self.ent_type, {'http://example.com/me/entity#4321'}): {'tag_label_4321'},
+            })
+        # get returns the same path that was passed
+        self.assertCountEqual(list(nodes.get((ns.bse.tag, bst.label), path=True, view=list)), [
+            (Nodes(self.backend, self.user, self.ent_type, {'http://example.com/me/entity#1234'}), (ns.bse.tag, bst.label), 'tag_label_1234'),
+            (Nodes(self.backend, self.user, self.ent_type, {'http://example.com/me/entity#4321'}), (ns.bse.tag, bst.label), 'tag_label_4321'),
+            ])
+        self.assertCountEqual(list(nodes.get([ns.bse.tag, bst.label], path=True, view=list)), [
+            (Nodes(self.backend, self.user, self.ent_type, {'http://example.com/me/entity#1234'}), [ns.bse.tag, bst.label], 'tag_label_1234'),
+            (Nodes(self.backend, self.user, self.ent_type, {'http://example.com/me/entity#4321'}), [ns.bse.tag, bst.label], 'tag_label_4321'),
+            ])
+        # paths must be URI or sequence thereof
+        self.assertRaises(TypeError, nodes.get, 1234)
+        self.assertRaises(TypeError, nodes.get, (ns.bse.tag, 1234))
+        self.assertRaises(TypeError, nodes.get, (1234, ns.bse.tag))
+        self.assertRaises(errors.ConsistencyError, nodes.get, 'hello world')
+        self.assertRaises(errors.ConsistencyError, nodes.get, ns.bse.invalid)
+        self.assertRaises(errors.ConsistencyError, nodes.get, (ns.bse.tag, bst.invalid))
+        # can pass multiple paths
+        self.assertDictEqual(nodes.get(ns.bse.filesize, (ns.bse.tag, bst.label)), {
+            Nodes(self.backend, self.user, self.ent_type, {'http://example.com/me/entity#1234'}): {
+                ns.bse.filesize: 1234,
+                (ns.bse.tag, bst.label): {'tag_label_1234'},
+                },
+            Nodes(self.backend, self.user, self.ent_type, {'http://example.com/me/entity#4321'}): {
+                ns.bse.filesize: 4321,
+                (ns.bse.tag, bst.label): {'tag_label_4321'},
+                },
+            })
+        # get respects view
+        self.assertDictEqual(nodes.get(ns.bse.filesize, view=dict), {
+            Nodes(self.backend, self.user, self.ent_type, {'http://example.com/me/entity#1234'}): 1234,
+            Nodes(self.backend, self.user, self.ent_type, {'http://example.com/me/entity#4321'}): 4321,
+            })
+        self.assertSetEqual(set(nodes.get(ns.bse.filesize, view=list)), {
+            (Nodes(self.backend, self.user, self.ent_type, {'http://example.com/me/entity#1234'}), 1234),
+            (Nodes(self.backend, self.user, self.ent_type, {'http://example.com/me/entity#4321'}), 4321),
+            })
+        # get returns Nodes instance when fetching a node
+        self.assertDictEqual(nodes.get(ns.bse.tag), {
+            Nodes(self.backend, self.user, self.ent_type, {'http://example.com/me/entity#1234'}):
+                {Nodes(self.backend, self.user, self.tag_type, {'http://example.com/me/tag#1234'})},
+            Nodes(self.backend, self.user, self.ent_type, {'http://example.com/me/entity#4321'}):
+                {Nodes(self.backend, self.user, self.tag_type, {'http://example.com/me/tag#4321'})},
+            })
+        # get returns a value when fetching a value and omits missing values
+        self.assertDictEqual(nodes.get(ns.bse.comment), {
+            Nodes(self.backend, self.user, self.ent_type, {'http://example.com/me/entity#1234'}): {'hello world'},
+            })
+
+        # FIXME: What if I call `get` with a single predicate and a single node, but
+        # that node has no value for that predicate?
+        # so, essentially, what if triples is empty? -> Also check in test_result!
+        raise NotImplementedError()
+
+    def test_getattr(self):
+        nodes = Nodes(self.backend, self.user, self.ent_type, {'http://example.com/me/entity#1234'})
+        # can get walks to values
+        self.assertEqual(nodes.filesize, Walk(nodes, (self.p_filesize, )))
+        # can get walks to nodes
+        self.assertEqual(nodes.tag, Walk(nodes, (self.p_tag, )))
+        # can do multiple hops
+        self.assertEqual(nodes.tag.label, Walk(nodes, (self.p_tag, self.p_label)))
+        # invalid step raises an error
+        self.assertRaises(ValueError, getattr, nodes, 'foobar')
+
+    def test_schema(self):
+        self.assertEqual(Nodes(self.backend, self.user, self.ent_type,
+            {URI('http://example.com/me/entity#1234')}).schema, self.backend.schema)
+
+    def test_operators(self): # __add__, __or__, __sub__, __and__
+        gen = partial(Nodes, self.backend, self.user, self.ent_type)
+        nodes = gen({URI('http://example.com/me/entity#1234')})
+        # add/or concatenates guids
+        self.assertEqual(
+            gen({URI('http://example.com/me/entity#1234')}) +
+            gen({URI('http://example.com/me/entity#4321')}),
+            # target
+            gen({
+                URI('http://example.com/me/entity#1234'),
+                URI('http://example.com/me/entity#4321')}))
+        self.assertEqual(
+            gen({URI('http://example.com/me/entity#1234')}) |
+            gen({URI('http://example.com/me/entity#4321')}),
+            # target
+            gen({
+                URI('http://example.com/me/entity#1234'),
+                URI('http://example.com/me/entity#4321')}))
+        # repeated guids are ignored
+        self.assertEqual(
+            gen({URI('http://example.com/me/entity#1234')}) +
+            gen({URI('http://example.com/me/entity#1234')}),
+            # target
+            gen({URI('http://example.com/me/entity#1234')}))
+        self.assertEqual(
+            gen({URI('http://example.com/me/entity#1234')}) |
+            gen({URI('http://example.com/me/entity#1234')}),
+            # target
+            gen({URI('http://example.com/me/entity#1234')}))
+
+        # sub substracts guids
+        self.assertEqual(
+            gen({URI('http://example.com/me/entity#1234'),
+                 URI('http://example.com/me/entity#4321')}) -
+            gen({URI('http://example.com/me/entity#4321')}),
+            # target
+            gen({URI('http://example.com/me/entity#1234')}))
+        # missing guids are ignored
+        self.assertEqual(
+            gen({URI('http://example.com/me/entity#1234')}) -
+            gen({URI('http://example.com/me/entity#4321')}),
+            # target
+            gen({URI('http://example.com/me/entity#1234')}))
+
+        # and intersects guids
+        self.assertEqual(
+            gen({URI('http://example.com/me/entity#1234'),
+                 URI('http://example.com/me/entity#4321')}) &
+            gen({URI('http://example.com/me/entity#4321'),
+                 URI('http://example.com/me/entity#5678')}),
+            # target
+            gen({URI('http://example.com/me/entity#4321')}))
+
+        for op in (operator.add, operator.or_, operator.sub, operator.and_):
+            # type must match
+            self.assertRaises(TypeError, op, nodes, 1234)
+            self.assertRaises(TypeError, op, nodes, 'hello world')
+            # backend must match
+            self.assertRaises(ValueError, op, nodes,
+                Nodes(None, self.user, self.ent_type, {URI('http://example.com/me/entity#1234')}))
+            # user must match
+            self.assertRaises(ValueError, op, nodes,
+                Nodes(self.backend, '', self.ent_type, {URI('http://example.com/me/entity#1234')}))
+            # node type must match
+            self.assertRaises(ValueError, op, nodes,
+                Nodes(self.backend, self.user, self.tag_type, {URI('http://example.com/me/entity#1234')}))
+
+    def test_len(self):
+        self.assertEqual(1, len(Nodes(self.backend, self.user, self.ent_type, {
+            URI('http://example.com/me/entity#1234'),
+            })))
+        self.assertEqual(2, len(Nodes(self.backend, self.user, self.ent_type, {
+            URI('http://example.com/me/entity#1234'),
+            URI('http://example.com/me/entity#4321'),
+            })))
+        self.assertEqual(4, len(Nodes(self.backend, self.user, self.ent_type, {
+            URI('http://example.com/me/entity#1234'),
+            URI('http://example.com/me/entity#4321'),
+            URI('http://example.com/me/entity#5678'),
+            URI('http://example.com/me/entity#8765'),
+            })))
+
+    def test_iter(self): # __iter__
+        gen = partial(Nodes, self.backend, self.user, self.ent_type)
+        self.assertSetEqual(set(Nodes(self.backend, self.user, self.ent_type, {
+            URI('http://example.com/me/entity#1234'),
+            URI('http://example.com/me/entity#4321'),
+            URI('http://example.com/me/entity#5678'),
+            URI('http://example.com/me/entity#8765'),
+            })), {
+            gen({URI('http://example.com/me/entity#1234')}),
+            gen({URI('http://example.com/me/entity#4321')}),
+            gen({URI('http://example.com/me/entity#5678')}),
+            gen({URI('http://example.com/me/entity#8765')}),
+            })
+
 
 ## main ##