shacl2code 0.0.18__tar.gz → 0.0.20__tar.gz

{shacl2code-0.0.18 → shacl2code-0.0.20}/.github/workflows/coverage-generate.yaml

@@ -7,6 +7,9 @@ on:
     branches:
       - "main"
 
+permissions:
+  contents: read
+
 jobs:
   coverage:
     name: Generate coverage report
@@ -20,9 +23,9 @@ jobs:
       # comments (to avoid publishing multiple comments in the same PR)
       contents: write
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: Setup Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # v4.7.1
         with:
           python-version: "3.11"
       - name: Install dependencies
@@ -36,11 +39,11 @@ jobs:
           pytest -v
       - name: Coverage comment
         id: coverage_comment
-        uses: py-cov-action/python-coverage-comment-action@v3
+        uses: py-cov-action/python-coverage-comment-action@2b84cfb222691291ba358a586c13606f0a9c172c # v3
         with:
           GITHUB_TOKEN: ${{ github.token }}
       - name: Store Pull Request comment to be posted
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
         if: steps.coverage_comment.outputs.COMMENT_FILE_WRITTEN == 'true'
         with:
           # If you use a different name, update COMMENT_ARTIFACT_NAME accordingly

{shacl2code-0.0.18 → shacl2code-0.0.20}/.github/workflows/coverage-report.yaml

@@ -7,6 +7,9 @@ on:
     types:
       - completed
 
+permissions:
+  contents: read
+
 jobs:
   report-coverage:
     name: Report coverage
@@ -27,7 +30,7 @@ jobs:
       # DO NOT run actions/checkout here, for security reasons
       # For details, refer to https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
       - name: Post comment
-        uses: py-cov-action/python-coverage-comment-action@v3
+        uses: py-cov-action/python-coverage-comment-action@2b84cfb222691291ba358a586c13606f0a9c172c # v3
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           GITHUB_PR_RUN_ID: ${{ github.event.workflow_run.id }}

{shacl2code-0.0.18 → shacl2code-0.0.20}/.github/workflows/publish.yaml

@@ -18,10 +18,10 @@ jobs:
       id-token: write
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # v4.7.1
         with:
           python-version: '3.x'
 
@@ -34,4 +34,4 @@ jobs:
         run: python -m build
 
       - name: Publish distribution to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
+        uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc # release/v1

shacl2code-0.0.20/.github/workflows/scorecard.yml

@@ -0,0 +1,73 @@
+# This workflow uses actions that are not certified by GitHub. They are provided
+# by a third-party and are governed by separate terms of service, privacy
+# policy, and support documentation.
+
+name: Scorecard supply-chain security
+on:
+  # For Branch-Protection check. Only the default branch is supported. See
+  # https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection
+  branch_protection_rule:
+  # To guarantee Maintained check is occasionally updated. See
+  # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
+  schedule:
+    - cron: '36 2 * * 4'
+  push:
+    branches: [ "main" ]
+
+# Declare default permissions as read only.
+permissions: read-all
+
+jobs:
+  analysis:
+    name: Scorecard analysis
+    runs-on: ubuntu-latest
+    permissions:
+      # Needed to upload the results to code-scanning dashboard.
+      security-events: write
+      # Needed to publish results and get a badge (see publish_results below).
+      id-token: write
+      # Uncomment the permissions below if installing in a private repository.
+      # contents: read
+      # actions: read
+
+    steps:
+      - name: "Checkout code"
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+        with:
+          persist-credentials: false
+
+      - name: "Run analysis"
+        uses: ossf/scorecard-action@0864cf19026789058feabb7e87baa5f140aac736 # v2.3.1
+        with:
+          results_file: results.sarif
+          results_format: sarif
+          # (Optional) "write" PAT token. Uncomment the `repo_token` line below if:
+          # - you want to enable the Branch-Protection check on a *public* repository, or
+          # - you are installing Scorecard on a *private* repository
+          # To create the PAT, follow the steps in https://github.com/ossf/scorecard-action?tab=readme-ov-file#authentication-with-fine-grained-pat-optional.
+          # repo_token: ${{ secrets.SCORECARD_TOKEN }}
+
+          # Public repositories:
+          #   - Publish results to OpenSSF REST API for easy access by consumers
+          #   - Allows the repository to include the Scorecard badge.
+          #   - See https://github.com/ossf/scorecard-action#publishing-results.
+          # For private repositories:
+          #   - `publish_results` will always be set to `false`, regardless
+          #     of the value entered here.
+          publish_results: true
+
+      # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
+      # format to the repository Actions tab.
+      #- name: "Upload artifact"
+      #  uses: actions/upload-artifact@97a0fba1372883ab732affbe8f94b823f91727db # v3.pre.node20
+      #  with:
+      #    name: sarif-file
+      #    path: results.sarif
+      #    retention-days: 5
+
+      # Upload the results to GitHub's code scanning dashboard (optional).
+      # Commenting out will disable upload of results to your repo's Code Scanning dashboard
+      - name: "Upload to code-scanning"
+        uses: github/codeql-action/upload-sarif@v3
+        with:
+          sarif_file: results.sarif

{shacl2code-0.0.18 → shacl2code-0.0.20}/.github/workflows/test.yaml

@@ -17,13 +17,13 @@ jobs:
           - "3.11"
           - "3.12"
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: Setup Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # v4.7.1
         with:
           python-version: ${{ matrix.python-version }}
       - name: Setup Node
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
         with:
           node-version: 20
       - name: Install dependencies
@@ -44,10 +44,10 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: Setup Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # v4.7.1
         with:
           python-version: "3.11"
-      - uses: psf/black@stable
-      - uses: py-actions/flake8@v2
+      - uses: psf/black@8a737e727ac5ab2f1d4cf5876720ed276dc8dc4b # 25.1.0
+      - uses: py-actions/flake8@84ec6726560b6d5bd68f2a5bed83d62b52bb50ba # v2.3.0

{shacl2code-0.0.18 → shacl2code-0.0.20}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: shacl2code
-Version: 0.0.18
+Version: 0.0.20
 Summary: Convert SHACL model file to code bindings
 Project-URL: Homepage, https://github.com/JPEWdev/shacl2code
 Project-URL: Repository, https://github.com/JPEWdev/shacl2code.git
@@ -29,6 +29,9 @@ Requires-Dist: pytest>=7.4; extra == 'dev'
 Description-Content-Type: text/markdown
 
 # Convert SHACL Model to code bindings
+
+[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9999/badge)](https://www.bestpractices.dev/projects/9999)
+[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/JPEWdev/shacl2code/badge)](https://scorecard.dev/viewer/?uri=github.com/JPEWdev/shacl2code)
 [![Coverage Report](https://raw.githubusercontent.com/JPEWdev/shacl2code/python-coverage-comment-action-data/badge.svg)](https://htmlpreview.github.io/?https://github.com/JPEWdev/shacl2code/blob/python-coverage-comment-action-data/htmlcov/index.html)
 
 This tool can be used to convert a SHACL model into various code bindings
@@ -44,24 +47,31 @@ python3 -m pip install shacl2code
 ## Usage
 
 `shacl2code` can generate bindings from either a local file:
+
 ```shell
 shacl2code generate -i model.jsonld python -o out.py
 ```
+
 Or from a URL:
+
 ```shell
 shacl2code generate -i https://example.com/rdf/model.jsonld python -o out.py
 ```
+
 Or from stdin:
+
 ```shell
 cat model.jsonld | shacl2code generate -i - python -o - > out.py
 ```
 
 For more information, run:
+
 ```shell
 shacl2code --help
 ```
 
 The available language bindings can be viewed by running:
+
 ```shell
 shacl2code list
 ```
@@ -82,6 +92,7 @@ pip install -e ".[dev]"
 
 `shacl2code` has a test suite written in [pytest][pytest]. To run it, setup a
 virtual environment as shown above, then run:
+
 ```shell
 pytest
 ```
@@ -89,7 +100,6 @@ pytest
 In addition to the test results, a test coverage report will also be generated
 using [pytest-cov][pytest-cov]
 
-
 ## Custom Annotations
 
 `shacl2code` supports a number of custom annotations that can be specified in a
@@ -118,6 +128,7 @@ turtle will use `MyId` instead of `@id` when writing JSON-LD bindings:
 ```
 
 When doing this, the class would then look like this in JSON-LD:
+
 ```json
 {
     "@type": "MyClass",
@@ -125,7 +136,7 @@ When doing this, the class would then look like this in JSON-LD:
 }
 ```
 
-The `idProperyName` annotation is inherited by derived classes, so for example
+The `idPropertyName` annotation is inherited by derived classes, so for example
 any class that derived from `MyClass` would also use `MyId` as the subject
 property.
 
@@ -157,7 +168,6 @@ indicates if a class can be extended, and defaults to `false`. For example, the
 following turtle will declare a class as extensible:
 
 ```ttl
-
 <MyClass> a owl:Class, sh:NodeShape ;
     sh-to-code:isExtensible true
     .
@@ -193,14 +203,12 @@ a constraint on the shape that it cannot be of its own type. This can be done
 with the following turtle:
 
 ```ttl
-
 <MyClass> a owl:Class, sh:NodeShape ;
-    # SHACL to prevent a class from being instansiated as this exact type
+    # SHACL to prevent a class from being instantiated as this exact type
     sh:property [
         sh:path rdf:type ;
         sh:not [ sh:hasValue <MyClass> ]
     ] .
-
 ```
 
 `shacl2code` will detect this pattern and generate abstract bindings for
@@ -216,7 +224,6 @@ abstract. This can be done with the boolean `isAbstract` property. For
 example, the following turtle will declare a class as abstract:
 
 ```ttl
-
 <MyClass> a owl:Class, sh:NodeShape ;
     sh-to-code:isAbstract true
     .

{shacl2code-0.0.18 → shacl2code-0.0.20}/README.md

@@ -1,4 +1,7 @@
 # Convert SHACL Model to code bindings
+
+[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9999/badge)](https://www.bestpractices.dev/projects/9999)
+[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/JPEWdev/shacl2code/badge)](https://scorecard.dev/viewer/?uri=github.com/JPEWdev/shacl2code)
 [![Coverage Report](https://raw.githubusercontent.com/JPEWdev/shacl2code/python-coverage-comment-action-data/badge.svg)](https://htmlpreview.github.io/?https://github.com/JPEWdev/shacl2code/blob/python-coverage-comment-action-data/htmlcov/index.html)
 
 This tool can be used to convert a SHACL model into various code bindings
@@ -14,24 +17,31 @@ python3 -m pip install shacl2code
 ## Usage
 
 `shacl2code` can generate bindings from either a local file:
+
 ```shell
 shacl2code generate -i model.jsonld python -o out.py
 ```
+
 Or from a URL:
+
 ```shell
 shacl2code generate -i https://example.com/rdf/model.jsonld python -o out.py
 ```
+
 Or from stdin:
+
 ```shell
 cat model.jsonld | shacl2code generate -i - python -o - > out.py
 ```
 
 For more information, run:
+
 ```shell
 shacl2code --help
 ```
 
 The available language bindings can be viewed by running:
+
 ```shell
 shacl2code list
 ```
@@ -52,6 +62,7 @@ pip install -e ".[dev]"
 
 `shacl2code` has a test suite written in [pytest][pytest]. To run it, setup a
 virtual environment as shown above, then run:
+
 ```shell
 pytest
 ```
@@ -59,7 +70,6 @@ pytest
 In addition to the test results, a test coverage report will also be generated
 using [pytest-cov][pytest-cov]
 
-
 ## Custom Annotations
 
 `shacl2code` supports a number of custom annotations that can be specified in a
@@ -88,6 +98,7 @@ turtle will use `MyId` instead of `@id` when writing JSON-LD bindings:
 ```
 
 When doing this, the class would then look like this in JSON-LD:
+
 ```json
 {
     "@type": "MyClass",
@@ -95,7 +106,7 @@ When doing this, the class would then look like this in JSON-LD:
 }
 ```
 
-The `idProperyName` annotation is inherited by derived classes, so for example
+The `idPropertyName` annotation is inherited by derived classes, so for example
 any class that derived from `MyClass` would also use `MyId` as the subject
 property.
 
@@ -127,7 +138,6 @@ indicates if a class can be extended, and defaults to `false`. For example, the
 following turtle will declare a class as extensible:
 
 ```ttl
-
 <MyClass> a owl:Class, sh:NodeShape ;
     sh-to-code:isExtensible true
     .
@@ -163,14 +173,12 @@ a constraint on the shape that it cannot be of its own type. This can be done
 with the following turtle:
 
 ```ttl
-
 <MyClass> a owl:Class, sh:NodeShape ;
-    # SHACL to prevent a class from being instansiated as this exact type
+    # SHACL to prevent a class from being instantiated as this exact type
     sh:property [
         sh:path rdf:type ;
         sh:not [ sh:hasValue <MyClass> ]
     ] .
-
 ```
 
 `shacl2code` will detect this pattern and generate abstract bindings for
@@ -186,7 +194,6 @@ abstract. This can be done with the boolean `isAbstract` property. For
 example, the following turtle will declare a class as abstract:
 
 ```ttl
-
 <MyClass> a owl:Class, sh:NodeShape ;
     sh-to-code:isAbstract true
     .

shacl2code-0.0.20/SECURITY.md

@@ -0,0 +1,13 @@
+# Security Policy
+
+## Supported Versions
+
+These version of shacl2code are currently receiving security fixes:
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.0.x   | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+Security issues can be reported in the [GitHub Issues](https://github.com/JPEWdev/shacl2code/issues). If accepted, the `security` label will be able to the issue

{shacl2code-0.0.18 → shacl2code-0.0.20}/src/shacl2code/lang/templates/cpp/errorhandler.cpp.j2

@@ -25,7 +25,7 @@ namespace {{ n }} {
 
 using std::string_literals::operator""s;
 
-// DefaultErrorHanlder
+// DefaultErrorHandler
 DefaultErrorHandler::DefaultErrorHandler() {}
 DefaultErrorHandler::~DefaultErrorHandler() {}
 
@@ -41,7 +41,7 @@ void DefaultErrorHandler::handleDeserializeError(std::string const& message,
 
 DefaultErrorHandler DefaultErrorHandler::handler;
 
-// NoopErrorHanlder
+// NoopErrorHandler
 NoopErrorHandler::NoopErrorHandler() {}
 NoopErrorHandler::~NoopErrorHandler() {}
 

{shacl2code-0.0.18 → shacl2code-0.0.20}/src/shacl2code/lang/templates/cpp/extensible.hpp.j2

@@ -40,7 +40,7 @@ typedef std::variant<std::string, int, double, DateTime, Ref<SHACLObject>>
  *
  * Implements the extra APIs that need to be called by an extensible class
  *
- * @note This should not be used directy; instead the SHACLExtensibleObject
+ * @note This should not be used directly; instead the SHACLExtensibleObject
  * template class should be used
  */
 class EXPORT SHACLExtensibleObjectBase {

{shacl2code-0.0.18 → shacl2code-0.0.20}/src/shacl2code/lang/templates/cpp/header.j2

@@ -102,6 +102,10 @@ class {{ varname(*class.clsname) }};
  *
  * This class is abstract
 {%- else %}
+{%- if class.deprecated %}
+ *
+ * @deprecated This class is deprecated
+{%- endif %}
  *
  * @ingroup {{ basename }}_concrete_classes
  *
@@ -143,6 +147,10 @@ class EXPORT {{ cpp_name }} : public{% for parent in parent_cpp_classes(class, c
     {%- if context.compact_vocab(prop.path) != prop.path %}
      *
      * Compact IRI: {{ context.compact_vocab(prop.path) }}
+    {%- endif %}
+    {%- if prop.deprecated %}
+     *
+     * @deprecated This property is deprecated
     {%- endif %}
      *
     {%- for l in prop.comment.split("\n") %}

{shacl2code-0.0.18 → shacl2code-0.0.20}/src/shacl2code/lang/templates/cpp/object.hpp.j2

@@ -60,7 +60,7 @@ class EXPORT SHACLObject {
     };
 
    public:
-    /// Alias for the parameter that desribes the type IRIs an object can have
+    /// Alias for the parameter that describes the type IRIs an object can have
     using TypeIRIs =
         std::optional<std::pair<std::string, std::optional<std::string>>>;
 

{shacl2code-0.0.18 → shacl2code-0.0.20}/src/shacl2code/lang/templates/cpp/objectpath.cpp.j2

@@ -34,7 +34,7 @@ using std::string_literals::operator""s;
  */
 class Finally {
    public:
-    /// Contructor
+    /// Constructor
     explicit Finally(std::function<void(void)>&& func)
         : mFunc(std::move(func)) {}
 

{shacl2code-0.0.18 → shacl2code-0.0.20}/src/shacl2code/lang/templates/golang/classes.go.j2

@@ -16,6 +16,9 @@ import (
 {%- for l in class.comment.splitlines() %}
 {{ ("// " + l).rstrip() }}
 {% endfor -%}
+{%- if class.deprecated %}
+// Deprecated: This class is deprecated
+{%- endif %}
 {% set is_public = not class.is_abstract or class.is_extensible -%}
 type {{ struct_name(class) }} struct {
 {%- if class.parent_ids %}
@@ -148,14 +151,21 @@ type {{ interface_name(class) }} interface {
     SHACLObject
 {%- endif %}
 {%- for prop in class.properties %}
-{%- if prop_is_list(prop) %}
-    {{ varname(prop.varname) }}() ListPropertyInterface[{{ prop_go_type(prop, classes) }}]
-{%- elif not prop.enum_values and prop.class_id %}
-    {{ varname(prop.varname) }}() RefPropertyInterface[{{ interface_name(classes.get(prop.class_id)) }}]
-{%- else %}
-    {{ varname(prop.varname) }}() PropertyInterface[{{ prop_go_type(prop, classes) }}]
-{%- endif %}
+    {{ varname(prop.varname) }}() {% if not prop.enum_values and prop.class_id -%}
+            Ref
+        {%- endif %}{% if prop_is_list(prop) -%}
+            List
+        {%- endif %}PropertyInterface[
+        {%- if not prop.enum_values and prop.class_id -%}
+            {{ interface_name(classes.get(prop.class_id)) }}
+        {%- else -%}
+            {{ prop_go_type(prop, classes) }}
+        {%- endif -%}
+        ]
 {%- endfor %}
+    // Type placeholder to ensure this interface cannot be assigned
+    // incorrectly, even if it has no properties
+    typeHolder{{ interface_name(class) }}()
 }
 
 {% if not class.is_abstract %}
@@ -260,15 +270,26 @@ func (self *{{ struct_name(class) }}) Link(state *LinkState) error {
 }
 
 {% for prop in class.properties %}
-{%- if prop_is_list(prop) %}
-func (self *{{ struct_name(class) }}) {{ varname(prop.varname) }}() ListPropertyInterface[{{ prop_go_type(prop, classes) }}] { return &self.{{ prop_name(prop) }} }
-{%- elif not prop.enum_values and prop.class_id %}
-func (self *{{ struct_name(class) }}) {{ varname(prop.varname) }}() RefPropertyInterface[{{ interface_name(classes.get(prop.class_id)) }}] { return &self.{{ prop_name(prop) }} }
-{%- else %}
-func (self *{{ struct_name(class) }}) {{ varname(prop.varname) }}() PropertyInterface[{{ prop_go_type(prop, classes) }}] { return &self.{{ prop_name(prop) }} }
+{%- if prop.deprecated %}
+// Deprecated: This property is deprecated
 {%- endif %}
+func (self *{{ struct_name(class) }}) {{ varname(prop.varname) }}() {% if not prop.enum_values and prop.class_id -%}
+            Ref
+        {%- endif %}{% if prop_is_list(prop) -%}
+            List
+        {%- endif %}PropertyInterface[
+        {%- if not prop.enum_values and prop.class_id -%}
+            {{ interface_name(classes.get(prop.class_id)) }}
+        {%- else -%}
+            {{ prop_go_type(prop, classes) }}
+        {%- endif -%}
+        ] {
+    return &self.{{ prop_name(prop) }}
+}
 {%- endfor %}
 
+func (self *{{ struct_name(class) }}) typeHolder{{ interface_name(class) }}() {}
+
 func (self *{{ struct_name(class) }}) EncodeProperties(data map[string]interface{}, path Path, state *EncodeState) error {
 {%- if class.parent_ids %}
 {%- for p in class.parent_ids %}

{shacl2code-0.0.18 → shacl2code-0.0.20}/src/shacl2code/lang/templates/golang/reflistproperty.go.j2

@@ -8,6 +8,12 @@ vim: ft=go
 
 package {{ package }}
 
+type RefListPropertyInterface[T SHACLObject] interface {
+    ListPropertyInterface[Ref[T]]
+    AppendObj(obj T) error
+    AppendIRI(iri string) error
+}
+
 type RefListProperty[T SHACLObject] struct {
     ListProperty[Ref[T]]
 }
@@ -43,3 +49,14 @@ func (self *RefListProperty[T]) Link(state *LinkState) error {
     return nil
 }
 
+func (self *RefListProperty[T]) AppendObj(obj T) error {
+    // Shorthand to append an object by making a reference to it
+    return self.Append(MakeObjectRef(obj))
+}
+
+func (self *RefListProperty[T]) AppendIRI(iri string) error {
+    // Shorthand to append an IRI by making a reference to it
+    return self.Append(MakeIRIRef[T](iri))
+}
+
+