shacl 0.2.1 → 0.4.0

data/lib/shacl/shapes.rb

@@ -9,6 +9,12 @@ module SHACL
   class Shapes < Array
     include RDF::Util::Logger
 
+    # The original shapes graph
+    #
+    # @return [RDF::Graph]
+    attr_reader :shapes_graph
+
+
     # The graphs which have been loaded as shapes
     #
     # @return [Array<RDF::URI>]
@@ -28,6 +34,7 @@ module SHACL
     #
     # @param [RDF::Graph] graph
     # @param [Array<RDF::URI>] loaded_graphs = []
+    #   The graphs which have been loaded as shapes
     # @param [Hash{Symbol => Object}] options
     # @return [Shapes]
     # @raise [SHACL::Error]
@@ -38,20 +45,43 @@ module SHACL
       while (imports = graph.query({predicate: RDF::OWL.imports}).map(&:object)).count > import_count
         # Load each imported graph
         imports.each do |ref|
-          graph.load(imports)
-          loaded_graphs << ref
+          # Don't try import if the import subject is already in the graph
+          unless graph.subject?(ref)
+            begin
+              options[:logger].info('Shapes') {"load import #{ref}"} if options[:logger].respond_to?(:info)
+              graph.load(ref)
+              loaded_graphs << ref
+            rescue IOError => e
+              # Skip import
+              options[:logger].warn('Shapes') {"load import #{ref}"} if options[:logger].respond_to?(:warn)
+            end
+          end
           import_count += 1
         end
       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)})
       shapes.instance_variable_set(:@shape_json, shape_json)
+      shapes.instance_variable_set(:@shapes_graph, graph)
       shapes
     end
 
@@ -65,11 +95,11 @@ module SHACL
     # @raise [SHACL::Error]
     def self.from_queryable(queryable, **options)
       # Query queryable to find one ore more shapes graphs
-      graphs = queryable.query({predicate: RDF::Vocab::SHACL.shapesGraph}).objects
-      graph = RDF::Graph.new do |g|
-        graphs.each {|iri| g.load(iri)}
+      graph_names = queryable.query({predicate: RDF::Vocab::SHACL.shapesGraph}).objects
+      graph = RDF::Graph.new(graph_name: graph_names.first, data: RDF::Repository.new) do |g|
+        graph_names.each {|iri| g.load(iri, graph_name: graph_names.first)}
       end
-      from_graph(graph, loaded_graphs: graphs, **options)
+      from_graph(graph, loaded_graphs: graph_names, **options)
     end
 
     ##
@@ -80,12 +110,18 @@ module SHACL
     # @param [Hash{Symbol => Object}] options
     # @option options [RDF::Term] :focus
     #   An explicit focus node, overriding any defined on the top-level shaps.
+    # @option options [Logger, #write, #<<] :logger
+    #   Record error/info/debug output
     # @return [SHACL::ValidationReport]
     def execute(graph, depth: 0, **options)
       self.each do |shape|
         shape.graph = graph
+        shape.shapes_graph = shapes_graph
         shape.each_descendant do |op|
-          op.graph = graph
+          op.instance_variable_set(:@logger, options[:logger]) if
+            options[:logger] && op.respond_to?(:execute)
+          op.graph = graph if op.respond_to?(:graph=)
+          op.shapes_graph = shapes_graph if op.respond_to?(:shapes_graph=)
         end
       end
 
@@ -115,11 +151,12 @@ module SHACL
         "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", "@container": "@list"},
+        "and": {"@type": "@id"},
         "annotationProperty": {"@type": "@id"},
         "class": {"@type": "@id"},
         "comment": "http://www.w3.org/2000/01/rdf-schema#comment",
@@ -130,35 +167,83 @@ module SHACL
         "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", "@container": "@list"},
+        "or": {"@type": "@id"},
         "path": {"@type": "@none"},
+        "prefixes": {"@type": "@id"},
         "property": {"@type": "@id"},
         "severity": {"@type": "@vocab"},
+        "sparql": {"@type": "@id"},
         "targetClass": {"@type": "@id"},
         "targetNode": {"@type": "@none"},
-        "xone": {"@type": "@id", "@container": "@list"}
+        "xone": {"@type": "@id"}
       },
       "and": {},
       "class": {},
       "datatype": {},
-      "in": {},
+      "in": {"@embed": "@never"},
       "node": {},
       "nodeKind": {},
       "not": {},
       "or": {},
       "property": {},
+      "sparql": {},
       "targetClass": {},
       "targetNode": {},
       "targetObjectsOf": {},
       "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

data/lib/shacl/validation_result.rb

@@ -115,26 +115,29 @@ module SHACL
       block.call(RDF::Statement(subject, RDF::Vocab::SHACL.resultMessage, RDF::Literal(message))) if message
     end
 
-    # Transform a JSON representation of a result, into a native representation
-    # @param [Hash] input
-    # @return [ValidationResult]
-    def self.from_json(input, **options)
-      input = JSON.parse(input) if input.is_a?(String)
-      input = JSON::LD::API.compact(input,
-                "http://github.com/ruby-rdf/shacl/",
-                expandContext: "http://github.com/ruby-rdf/shacl/")
-      raise ArgumentError, "Expect report to be a hash" unless input.is_a?(Hash)
-      result = self.new
+    # Class Methods
+    class << self
+      # Transform a JSON representation of a result, into a native representation
+      # @param [Hash] input
+      # @return [ValidationResult]
+      def from_json(input, **options)
+        input = JSON.parse(input) if input.is_a?(String)
+        input = JSON::LD::API.compact(input,
+                  "http://github.com/ruby-rdf/shacl/",
+                  expandContext: "http://github.com/ruby-rdf/shacl/")
+        raise ArgumentError, "Expect report to be a hash" unless input.is_a?(Hash)
+        result = self.new
 
-      result.focus = Algebra::Operator.to_rdf(:focus, input['focusNode'], base: nil, vocab: false) if input['focusNode']
-      result.path = Algebra::Operator.parse_path(input['resultPath'], **options) if input['resultPath']
-      result.resultSeverity = Algebra::Operator.iri(input['resultSeverity'], **options) if input['resultSeverity']
-      result.component = Algebra::Operator.iri(input['sourceConstraintComponent'], **options) if input['sourceConstraintComponent']
-      result.shape = Algebra::Operator.iri(input['sourceShape'], **options) if input['sourceShape']
-      result.value = Algebra::Operator.to_rdf(:value, input['value'], **options) if input['value']
-      result.details = Algebra::Operator.to_rdf(:details, input['details'], **options) if input['details']
-      result.message = Algebra::Operator.to_rdf(:message, input['message'], **options) if input['message']
-      result
+        result.focus = Algebra::Operator.to_rdf(:focus, input['focusNode'], base: nil, vocab: false) if input['focusNode']
+        result.path = Algebra::Operator.parse_path(input['resultPath'], **options) if input['resultPath']
+        result.resultSeverity = Algebra::Operator.iri(input['resultSeverity'], **options) if input['resultSeverity']
+        result.component = Algebra::Operator.iri(input['sourceConstraintComponent'], **options) if input['sourceConstraintComponent']
+        result.shape = Algebra::Operator.iri(input['sourceShape'], **options) if input['sourceShape']
+        result.value = Algebra::Operator.to_rdf(:value, input['value'], **options) if input['value']
+        result.details = Algebra::Operator.to_rdf(:details, input['details'], **options) if input['details']
+        result.message = Algebra::Operator.to_rdf(:message, input['message'], **options) if input['message']
+        result
+      end
     end
 
     # To results are eql? if their overlapping properties are equal

data/lib/shacl.rb

@@ -21,8 +21,8 @@ module SHACL
   # @option (see Shapes#from_graph)
   # @return (see Shapes#from_graph)
   # @raise  (see Shapes#from_graph)
-  def self.get_shapes(shape_graph, **options)
-    Shapes.from_graph(shape_graph, **options)
+  def self.get_shapes(shapes_graph, **options)
+    Shapes.from_graph(shapes_graph, **options)
   end
 
   ##
@@ -33,8 +33,13 @@ module SHACL
   # @return (see Shapes#from_graph)
   # @raise  (see Shapes#from_graph)
   def self.open(input, **options)
-    graph = RDF::Graph.load(input, **options)
-    self.get_shapes(graph, loaded_graphs: [RDF::URI(input, canonicalize: true)], **options)
+    # Create graph backed by repo to allow a graph_name
+    graph = RDF::Graph.load(input,
+                            graph_name: RDF::URI(input),
+                            data: RDF::Repository.new)
+    self.get_shapes(graph,
+      loaded_graphs: [RDF::URI(input, canonicalize: true)],
+      **options)
   end
 
   ##
@@ -77,7 +82,7 @@ module SHACL
     attr_reader :code
 
     ##
-    # Initializes a new patch error instance.
+    # Initializes a new error instance.
     #
     # @param  [String, #to_s]          message
     # @param  [Hash{Symbol => Object}] options

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shacl
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Gregg Kellogg
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-27 00:00:00.000000000 Z
+date: 2023-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdf
@@ -16,28 +16,28 @@ dependencies:
     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: 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
@@ -58,70 +58,84 @@ dependencies:
     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: 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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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
@@ -164,13 +178,16 @@ files:
 - lib/shacl.rb
 - lib/shacl/algebra.rb
 - lib/shacl/algebra/and.rb
+- lib/shacl/algebra/constraint_component.rb
 - lib/shacl/algebra/node_shape.rb
 - lib/shacl/algebra/not.rb
 - lib/shacl/algebra/operator.rb
 - lib/shacl/algebra/or.rb
+- lib/shacl/algebra/pattern.rb
 - lib/shacl/algebra/property_shape.rb
-- lib/shacl/algebra/qualified_value_shape.rb
+- lib/shacl/algebra/qualified_value.rb
 - lib/shacl/algebra/shape.rb
+- lib/shacl/algebra/sparql_constraint.rb
 - lib/shacl/algebra/xone.rb
 - lib/shacl/context.rb
 - lib/shacl/format.rb
@@ -196,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.2.33
 signing_key:
 specification_version: 4
 summary: Implementation of Shapes Constraint Language (SHACL) for RDF.rb