shacl 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c633e6028fd1289d59a32deaa5fa21392fef42e19775c5360176764573c59d55
-  data.tar.gz: 1b531864030beee9032a51f47c06a4151fb41b5500d6fbf639d14261bdb14377
+  metadata.gz: d790df44442d54fd3787914c630d9ba5f4879988ce47616dbcc2ff62c8521876
+  data.tar.gz: bda5f350ad0393933cfe14391341de28e7cf30e6088717d555ccef43192ec28f
 SHA512:
-  metadata.gz: 69660f8f352892612c02d2e487d2e01a0eec8f477024f175c58e30a07ab857aa271494f19b90955cc4b63c9889ed31ebdbcdae04ab0dd188d2949108798bf6f9
-  data.tar.gz: 2e9f9e64e9ba01b171b06e35b6fc47427e3b5f6ba075d5aecb14497a9c84873a6716a029aceae925d85349b68609a8ec7987aceaa5d26e0ca77866fb385d1e4d
+  metadata.gz: f2cd4e4e2bc3686207c430be9cc582c80cc8012fc9719e902f4d72151833b3bd3a5f25d6c2b08005d3e79409378862d3d9b01c230ed794c534e92a05e18a96d3
+  data.tar.gz: 5c5a6d45bccecaa5cfdbb63a65b95934d42072f1bcce8f4060312ee0fb0c968f6f902bdfd7eba1263b6b67ef98471f272f6ef250db1aa0bd86e0cf3639877474

data/README.md

@@ -2,7 +2,7 @@
 
 This is a pure-Ruby library for working with the [Shape Constraint Language][SHACL Spec] to validate the shape of [RDF][] graphs.
 
-[![Gem Version](https://badge.fury.io/rb/shacl.png)](https://badge.fury.io/rb/shacl)
+[![Gem Version](https://badge.fury.io/rb/shacl.svg)](https://badge.fury.io/rb/shacl)
 [![Build Status](https://github.com/ruby-rdf/shacl/workflows/CI/badge.svg?branch=develop)](https://github.com/ruby-rdf/shacl/actions?query=workflow%3ACI)
 [![Coverage Status](https://coveralls.io/repos/github/ruby-rdf/shacl/badge.svg?branch=develop)](https://coveralls.io/github/ruby-rdf/shacl?branch=develop)
 [![Gitter chat](https://badges.gitter.im/ruby-rdf/rdf.png)](https://gitter.im/ruby-rdf/rdf)
@@ -87,10 +87,10 @@ This implementation is certainly not performant. Some things that can be be cons
 
 ## Dependencies
 
-* [Ruby](https://ruby-lang.org/) (>= 2.6)
-* [RDF.rb](https://rubygems.org/gems/rdf) (~> 3.2)
+* [Ruby](https://ruby-lang.org/) (>= 3.0)
+* [RDF.rb](https://rubygems.org/gems/rdf) (~> 3.3)
 * [SPARQL](https://rubygems.org/gems/sparql) (~> 3.2)
-* [json-ld](https://rubygems.org/gems/json-ld) (~> 3.2)
+* [json-ld](https://rubygems.org/gems/json-ld) (~> 3.3)
 * [sxp](https://rubygems.org/gems/sxp) (~> 1.2)
 
 ## Installation

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.1

data/lib/shacl/algebra/constraint_component.rb

@@ -5,5 +5,63 @@ module SHACL::Algebra
   # Constraint Components define basic constraint behaivor through _mandatory_ and _optional_ parameters. Constraints are accessed through their parameters.
   #
   class ConstraintComponent < Operator
+
+    # Class Methods
+    class << self
+      ##
+      # Creates an operator instance from a parsed SHACL representation.
+      #
+      # Special case for SPARQL ConstraintComponents.
+      #
+      # @param [Hash] operator
+      # @param [Hash] options ({})
+      # @option options [Hash{String => RDF::URI}] :prefixes
+      # @return [Operator]
+      def from_json(operator, **options)
+        operands = []
+
+        # Component is known by its subject IRI
+        id = operator.fetch('id')
+
+        # Component class (for instantiation) is based on the _local name_ of the component IRI
+        class_name = ncname(id)
+
+        parameters = operator.fetch('parameter', []).inject({}) do |memo, param|
+          # Symbolize keys
+          param = param.inject({}) {|memo, (k,v)| memo.merge(k.to_sym => v)}
+
+          plc = ncname(param[:path])
+
+          # Add class and local name
+          param = param.merge(class: class_name, local_name: plc)
+          memo.merge(param[:path] => param)
+        end
+
+        # Add parameters to operator lookup
+        add_component(class_name, parameters)
+
+        # Add parameter identifiers to operands
+        operands << [:parameters, parameters.keys]
+
+        # FIXME: labelTemplate
+
+        validator = %w(validator nodeValidator propertyValidator).inject(nil) do |memo, p|
+          memo || (SPARQLConstraintComponent.from_json(operator[p]) if operator.key?(p))
+        end
+        raise SHACL::Error, "Constraint Component has no validator" unless validator
+
+        operands << [:validator, validator]
+
+        new(*operands, **options)
+      end
+
+      # Extract the NCName tail of an IRI as a symbol.
+      #
+      # @param [RDF::URI] uri
+      # @return [Symbol]
+      def ncname(uri)
+        uri.to_s.match(/(\w+)$/).to_s.to_sym
+      end
+    end
   end
 end

data/lib/shacl/algebra/node_shape.rb

@@ -44,7 +44,7 @@ module SHACL::Algebra
             resultSeverity: options[:severity],
             component: RDF::Vocab::SHACL.ClosedConstraintComponent,
             **options)
-        end.compact
+        end.flatten.compact
       elsif @options[:ignoredProperties]
         raise SHACL::Error, "shape has ignoredProperties without being closed"
       end

data/lib/shacl/algebra/operator.rb

@@ -40,6 +40,7 @@ module SHACL::Algebra
     # Graph from which original shapes were loaded.
     # @return [RDF::Graph]
     attr_accessor :shapes_graph
+
     # Parameters to components.
     PARAMETERS = {
       and: {class: :AndConstraintComponent},
@@ -151,19 +152,19 @@ module SHACL::Algebra
       },
       property: {class: :PropertyConstraintComponent},
       qualifiedMaxCount: {
-        class: :QualifiedMaxCountConstraintComponent,
+        class: :QualifiedValueConstraintComponent,
         datatype: RDF::XSD.integer,
       },
       qualifiedValueShape: {
-        class: %i(QualifiedMaxCountConstraintComponent QualifiedMinCountConstraintComponent),
+        class: :QualifiedValueConstraintComponent,
       },
       qualifiedValueShapesDisjoint: {
-        class: %i(QualifiedMaxCountConstraintComponent QualifiedMinCountConstraintComponent),
+        class: :QualifiedValueConstraintComponent,
         datatype: RDF::XSD.boolean,
         optional: true,
       },
       qualifiedMinCount: {
-        class: :QualifiedMinCountConstraintComponent,
+        class: :QualifiedValueConstraintComponent,
         datatype: RDF::XSD.integer
       },
       sparql: {class: :SPARQLConstraintComponent},
@@ -175,21 +176,43 @@ module SHACL::Algebra
       xone: {class: :XoneConstraintComponent},
     }
 
-    # Constraint Component classes indexed to their mandatory and optional parameters.
-    #
-    # @note for builtins, corresponding Ruby classes may not exist.
-    COMPONENT_PARAMS = PARAMETERS.inject({}) do |memo, (param, properties)|
-      memo.merge(Array(properties[:class]).inject(memo) do |mem, cls|
-        entry = mem.fetch(cls, {})
-        param_type = properties[:optional] ? :optional : :mandatory
-        entry[param_type] ||= []
-        entry[param_type] << param
-        mem.merge(cls => entry)
-      end)
-    end
-
     ## Class methods
     class << self
+      # Add parameters and class def from a SPARQL-based Constraint Component
+      #
+      # @param [RDF::URI] cls The URI of the constraint component.
+      # @param [Hash{Symbol => Hash}] parameters Definitions of mandatory and optional parameters for this component.
+      def add_component(cls, parameters)
+        # Remember added paraemters.
+        # FIXME: should merge parameters
+        @added_parameters = (@added_parameters || {}).merge(parameters)
+        # Rebuild
+        @params = @component_params = nil
+      end
+
+      # Defined parameters for components, which may be supplemented by SPARQL-based Constraint Components. A parameter may be mapped to more than one component class.
+      #
+      # @return [Hash{Symbol => Hash}] Returns each parameter referencing the component classes it is used in, and the property validators for values of that parameter.
+      def params
+        @params ||= PARAMETERS.merge(@added_parameters || {})
+      end
+
+      # Constraint Component classes indexed to their mandatory and optional parameters, which may be supplemented by SPARQL-based Constraint Components.
+      #
+      # @return [Hash{Symbol => Hash}]
+      #   Returns a hash relating each component URI to its optional and mandatory parameters.
+      def component_params
+        @component_params ||= params.inject({}) do |memo, (param, properties)|
+          memo.merge(Array(properties[:class]).inject(memo) do |mem, cls|
+            entry = mem.fetch(cls, {})
+            param_type = properties[:optional] ? :optional : :mandatory
+            entry[param_type] ||= []
+            entry[param_type] << param
+            mem.merge(cls => entry)
+          end)
+        end
+      end
+
       ##
       # Creates an operator instance from a parsed SHACL representation
       # @param [Hash] operator
@@ -205,7 +228,7 @@ module SHACL::Algebra
         # Node Options and operands on shape or node, which are not Constraint Component Parameters
         operator.each do |k, v|
           k = k.to_sym
-          next if v.nil? || PARAMETERS.include?(k)
+          next if v.nil? || params.include?(k)
           case k
           # List properties
           when :id                 then node_opts[:id] = iri(v, vocab: false, **options)
@@ -234,8 +257,8 @@ module SHACL::Algebra
         used_components = {}
         operator.each do |k, v|
           k = k.to_sym
-          next if v.nil? || !PARAMETERS.include?(k)
-          param_props = PARAMETERS[k]
+          next if v.nil? || !params.include?(k)
+          param_props = params[k]
           param_classes = Array(param_props[:class])
 
           # Keep track of components which have been used.
@@ -293,10 +316,21 @@ module SHACL::Algebra
               name = klass.const_get(:NAME)
               # If the key `k` is the same as the NAME of the class, create the instance with the defined element values.
               if name == k
+                param_classes.each do |cls|
+                  # Add `k` as a mandatory parameter fulfilled
+                  (used_components[cls][:mandatory_parameters] ||= []) << k
+                end
+
+                # Instantiate the compoent
                 elements.map {|e| klass.new(*e, **options.dup)}
               else
                 # Add non-primary parameters for subsequent insertion
                 param_classes.each do |cls|
+                  # Add `k` as a mandatory parameter fulfilled if it is so defined
+                  (used_components[cls][:mandatory_parameters] ||= []) << k unless
+                    params[k][:optional]
+
+                  # Add parameter as S-Expression operand
                   (used_components[cls][:parameters] ||= []) << elements.unshift(k)
                 end
                 [] # No instances created
@@ -304,10 +338,12 @@ module SHACL::Algebra
             end
           end
 
-          # Record the instances created by class and add as operands
+          # Record the instances created by class and its operands
           param_classes.each do |cls|
             used_components[cls][:instances] = instances
           end
+
+          # FIXME: Only add instances when all mandatory parameters are present.
           operands.push(*instances)
         end
 

data/lib/shacl/algebra/qualified_value.rb

@@ -17,8 +17,8 @@ module SHACL::Algebra
       params, ops = operands.partition {|o| o.is_a?(Array) && o.first.is_a?(Symbol)}
       params = params.inject({}) {|memo, a| memo.merge(a.first => a.last)}
 
-      max_count = params[:qualifiedMinCount].to_i
-      min_count = params[:qualifiedMinCount].to_i
+      max_count = params[:qualifiedMinCount]
+      min_count = params[:qualifiedMinCount]
       # FIXME: figure this out
       disjoint = !!params[:qualifiedValueShapesDisjoint]
 
@@ -29,13 +29,13 @@ module SHACL::Algebra
 
         count = results.select(&:conform?).length
         log_debug(NAME, depth: depth) {"#{count}/#{results} conforming shapes"}
-        if count < min_count
+        if min_count && count < min_count.to_i
           not_satisfied(focus: node, path: path,
             message: "only #{count} conforming values, requires at least #{min_count}",
             resultSeverity: options.fetch(:severity),
             component: RDF::Vocab::SHACL.QualifiedMinCountConstraintComponent,
             depth: depth, **options)
-        elsif count > max_count
+        elsif max_count && count > max_count.to_i
           not_satisfied(focus: node, path: path,
             message: "#{count} conforming values, requires at most #{max_count}",
             resultSeverity: options.fetch(:severity),
@@ -43,19 +43,11 @@ module SHACL::Algebra
             depth: depth, **options)
         else
           satisfy(focus: node, path: path,
-            message: "#{min_count} <= #{count} <= #{max_count} values conform",
+            message: "#{min_count.to_i} <= #{count} <= #{max_count || 'inf'} values conform",
             component: RDF::Vocab::SHACL.QualifiedMinCountConstraintComponent,
             depth: depth, **options)
         end
       end
     end
   end
-
-  # Version on QualifiedConstraintComponent with required `qualifiedMaxCount` parameter
-  class QualifiedMaxCountConstraintComponent < QualifiedValueConstraintComponent
-  end
-
-  # Version on QualifiedConstraintComponent with required `qualifiedMinCount` parameter
-  class QualifiedMinCountConstraintComponent < QualifiedValueConstraintComponent
-  end
 end

data/lib/shacl/algebra.rb

@@ -27,10 +27,19 @@ module SHACL
       return operator['@list'].map {|e| from_json(e, **options)} if operator.key?('@list')
 
       type = operator.fetch('type', [])
-      type << (operator["path"] ? 'PropertyShape' : 'NodeShape') if type.empty?
+      if type.empty?
+        type << if operator["path"]
+          'PropertyShape'
+        elsif operator['nodeValidator'] || operator['propertyValidator'] || operator['validator']
+          'ConstraintComponent'
+        else
+          'NodeShape'
+        end
+      end
       klass = case
       when type.include?('NodeShape') then NodeShape
       when type.include?('PropertyShape') then PropertyShape
+      when type.include?('ConstraintComponent') then ConstraintComponent
       else raise SHACL::Error, "from_json: unknown type #{type.inspect}"
       end
 

data/lib/shacl/shapes.rb

@@ -61,9 +61,22 @@ module SHACL
       end
 
       # Serialize the graph as framed JSON-LD and initialize patterns, recursively.
-      shape_json = JSON::LD::API.fromRdf(graph, useNativeTypes: true) do |expanded|
-        JSON::LD::API.frame(expanded, SHAPES_FRAME, omitGraph: false, embed: '@always', expanded: true)
-      end['@graph']
+      expanded = JSON::LD::API.fromRdf(graph, useNativeTypes: true)
+
+      # Node and Property constraints
+      shape_json = JSON::LD::API.frame(expanded, SHAPES_FRAME,
+        omitGraph: false,
+        embed: '@always',
+        expanded: true)['@graph']
+
+      # Any defined Constraint Components
+      components = JSON::LD::API.frame(expanded, COMPONENTS_FRAME,
+        omitGraph: false,
+        embed: '@always',
+        expanded: true)['@graph']
+
+      # Extract any constraint components and merge to top-level
+      shape_json = components + shape_json
 
       # Create an array of the framed shapes
       shapes = self.new(shape_json.map {|o| Algebra.from_json(o, **options)})
@@ -189,5 +202,48 @@ module SHACL
       "xone": {},
       "targetSubjectsOf": {}
     })).freeze
+
+    COMPONENTS_FRAME = JSON.parse(%({
+      "@context": {
+        "id": "@id",
+        "type": {"@id": "@type", "@container": "@set"},
+        "@vocab": "http://www.w3.org/ns/shacl#",
+        "owl": "http://www.w3.org/2002/07/owl#",
+        "rdfs": "http://www.w3.org/2000/01/rdf-schema#",
+        "shacl": "http://www.w3.org/ns/shacl#",
+        "sh": "http://www.w3.org/ns/shacl#",
+        "xsd": "http://www.w3.org/2001/XMLSchema#",
+        "and": {"@type": "@id"},
+        "annotationProperty": {"@type": "@id"},
+        "class": {"@type": "@id"},
+        "comment": "http://www.w3.org/2000/01/rdf-schema#comment",
+        "condition": {"@type": "@id"},
+        "datatype": {"@type": "@vocab"},
+        "declare": {"@type": "@id"},
+        "disjoint": {"@type": "@id"},
+        "entailment": {"@type": "@id"},
+        "equals": {"@type": "@id"},
+        "ignoredProperties": {"@type": "@id", "@container": "@list"},
+        "imports": {"@id": "owl:imports", "@type": "@id"},
+        "in": {"@type": "@none", "@container": "@list"},
+        "inversePath": {"@type": "@id"},
+        "label": "http://www.w3.org/2000/01/rdf-schema#label",
+        "languageIn": {"@container": "@list"},
+        "lessThan": {"@type": "@id"},
+        "lessThanOrEquals": {"@type": "@id"},
+        "namespace": {"@type": "xsd:anyURI"},
+        "nodeKind": {"@type": "@vocab"},
+        "or": {"@type": "@id"},
+        "path": {"@type": "@id"},
+        "prefixes": {"@type": "@id"},
+        "property": {"@type": "@id"},
+        "severity": {"@type": "@vocab"},
+        "sparql": {"@type": "@id"},
+        "targetClass": {"@type": "@id"},
+        "targetNode": {"@type": "@none"},
+        "xone": {"@type": "@id"}
+      },
+      "@type": "ConstraintComponent"
+    })).freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shacl
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Gregg Kellogg
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-07 00:00:00.000000000 Z
+date: 2023-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdf
@@ -16,34 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.2.8
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.2.8
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: json-ld
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: sxp
   requirement: !ruby/object:Gem::Requirement
@@ -64,90 +58,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.2.4
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.2.4
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: rdf-spec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: rdf-turtle
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: rdf-vocab
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: rdf-xsd
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -225,14 +213,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Implementation of Shapes Constraint Language (SHACL) for RDF.rb