Merge pull request #39 from casework/add_prefix_customization

Add and confirm prefix customization; start doctests

Author: fabrizio-turchi

.github/workflows/ci.yml

@@ -24,14 +24,14 @@ jobs:
 
       - name: Install Dependencies
         run: |
-          pip -q install poetry pre-commit
+          pip -q install poetry pre-commit rdflib
           poetry install
 
       - name: Pre-commit Checks
         run: pre-commit run --all-files
 
       - name: Unit Tests
-        run: poetry run pytest
+        run: poetry run pytest --doctest-modules
 
       - name: Run Example
         run: poetry run python example.py > case.jsonld
@@ -44,6 +44,11 @@ jobs:
           case-version: "case-1.3.0"
           extension-filter: "jsonld"
 
+      - name: Convert example
+        run: |
+          rdfpipe --output-format turtle case.jsonld > case.ttl
+          test 0 -eq $(grep 'file:' case.ttl | wc -l) || (echo "ERROR:ci.yml:Some graph IRIs do not supply a resolving prefix.  Look for the string 'file:///' in the file case.ttl (created by running 'make check') to see these instances." >&2 ; exit 1)
+
       # Always build the package as a sanity check to ensure no issues with the build system
       # exist as part of the CI process
       - name: Build Package

.gitignore

@@ -19,3 +19,4 @@ __pycache__/
 # Build Artifacts
 build/
 dist/
+case.ttl

Makefile

@@ -81,7 +81,26 @@ case.jsonld: \
 	    _$@
 	mv _$@ $@
 
+case.ttl: \
+  case.jsonld
+	source venv/bin/activate \
+	  && rdfpipe \
+	    --output-format turtle \
+	    $< \
+	    > _$@
+	source venv/bin/activate \
+	  && case_validate \
+	    _$@
+	@# In instances where graph nodes omit use of a prefix, a 'default' prefix-base is used that incorporates the local directory as a file URL.  This is likely to be an undesired behavior, so for the generated example JSON-LD in the top source directory, check that "file:///" doesn't start any of the graph individuals' IRIs.
+	test \
+	  0 \
+	  -eq \
+	  $$(grep 'file:' _$@ | wc -l) \
+	  || ( echo "ERROR:Makefile:Some graph IRIs do not supply a resolving prefix.  Look for the string 'file:///' in the file _$@ to see these instances." >&2 ; exit 1)
+	mv _$@ $@
+
 check: \
-  all
+  all \
+  case.ttl
 	source venv/bin/activate \
-	  && poetry run pytest
+	  && poetry run pytest --doctest-modules