shacl 0.1.0

data/lib/shacl/validation_report.rb

@@ -0,0 +1,109 @@
+$:.unshift(File.expand_path("../..", __FILE__))
+
+require 'rdf'
+require 'sxp'
+require_relative 'refinements'
+require_relative 'validation_report'
+
+module SHACL
+  # A SHACL [Validateion Report](https://www.w3.org/TR/shacl/#results-validation-report).
+  #
+  # Collects the individual {SHACL::ValidationResult} instances and provides a `conforms` boolean accessor.
+  #
+  # Allows the report to be serialized as a set of RDF Statements
+  class ValidationReport
+    include RDF::Enumerable
+    using SHACL::Refinements
+
+    ##
+    # All results, both conforming and non-conforming
+    attr_reader :all_results
+
+    ##
+    # Creates a report from the set of results
+    #
+    # @param [Array<ValidationResult>] results
+    # @return [ValidationReport]
+    def initialize(results)
+      @all_results = Array(results)
+    end
+
+    ##
+    # The non-conforming results
+    #
+    # @return [Array<ValidationResult>]
+    def results
+      @all_results.reject(&:conform?)
+    end
+
+    ##
+    # The number of non-conforming results
+    #
+    # @return [Integer]
+    def count
+      results.length
+    end
+
+    ##
+    # Do the individual results indicate conformance?
+    #
+    # @return [Boolean]
+    def conform?
+      results.empty?
+    end
+
+    ##
+    # The number of results
+    #
+    def to_sxp_bin
+      [:ValidationReport, conform?, results].to_sxp_bin
+    end
+
+    def to_sxp
+      self.to_sxp_bin.to_sxp
+    end
+
+    def to_s
+      results.map(&:to_s).join("\n")
+    end
+
+    ##
+    # Two reports are eq if they have the same number of results and each result equals a result in the other report.
+    # @param [ValidationReport] other
+    # @return [Boolean]
+    def ==(other)
+      return false unless other.is_a?(ValidationReport)
+      count == other.count && other.results.all? {|r| results.include?(r)}
+    end
+
+    ##
+    # Create a hash of messages appropriate for linter-like output.
+    #
+    # @return [Hash{Symbol => Hash{Symbol => Array<String>}}]
+    def linter_messages
+      results.inject({}) {|memo, result| memo.deep_merge(result.linter_message)}
+    end
+
+    ##
+    # Yields statements for this report
+    #
+    # @yield  [statement]
+    #   each statement
+    # @yieldparam  [RDF::Statement] statement
+    # @yieldreturn [void] ignored
+    # @return [void]
+    def each(&block)
+      subject = RDF::Node.new
+      block.call(RDF::Statement(subject, RDF.type, RDF::Vocab::SHACL.ValidationReport))
+      block.call(RDF::Statement(subject, RDF::Vocab::SHACL.conforms, RDF::Literal(conform?)))
+      results.each do |result|
+        result_subject = nil
+        result.each do |statement|
+          result_subject ||= statement.subject
+          yield(statement)
+        end
+        yield(RDF::Statement(subject, RDF::Vocab::SHACL.result, result_subject))
+      end
+    end
+  end
+end

data/lib/shacl/validation_result.rb

@@ -0,0 +1,153 @@
+$:.unshift(File.expand_path("../..", __FILE__))
+
+require 'rdf'
+require 'sxp'
+require_relative 'context'
+require_relative 'refinements'
+
+module SHACL
+  # A SHACL [Validateion Result](https://www.w3.org/TR/shacl/#results-validation-result).
+  #
+  # Also allows for a successful result, if the `resultSeverity` `nil`.
+  ValidationResult = Struct.new(
+    :focus,
+    :path,
+    :shape,
+    :resultSeverity,
+    :component,
+    :details,
+    :value,
+    :message) do
+
+    include RDF::Enumerable
+    using SHACL::Refinements
+
+    ##
+    # Initializer calculates lexical values for URIs
+    def initialize(*args)
+      args = args.map do |v|
+        if v.respond_to?(:qname) && !v.lexical && v.qname
+          v = RDF::URI.new(v.to_s) if v.frozen?
+          v.lexical = v.qname.join(':')
+        end
+        v
+      end
+      super(*args)
+    end
+
+    # A result conforms if it is not a violation
+    #
+    # @return [Boolean]
+    def conform?
+      resultSeverity.nil?
+    end
+    alias_method :conforms?, :conform?
+
+    def to_sxp_bin
+      %i(value focus path shape resultSeverity component details message).inject([:ValidationResult]) do |memo, sym|
+        v = self.send(sym)
+        v ? (memo + [[sym, *v]]) : memo
+      end.to_sxp_bin
+    end
+
+    def to_sxp
+      self.to_sxp_bin.to_sxp
+    end
+
+    ##
+    # Create a hash of messages appropriate for linter-like output.
+    #
+    # @return [Hash{Symbol => Hash{Symbol => Array<String>}}]
+    def linter_message
+      case
+      when path then {path: {path.to_sxp => [to_s]}}
+      when focus then {focus: {focus.to_sxp => [to_s]}}
+      else {shape: {shape.to_sxp => [to_s]}}
+      end
+    end
+
+    ##
+    # Some humanized result for the report
+    def to_s
+      "Result for: " +
+      %i(value focus path shape resultSeverity component details message).map do |sym|
+        v = self.send(sym)
+        if v.respond_to?(:humanize)
+          v.humanize
+        elsif v.respond_to?(:lexical)
+          v.lexical
+        else
+          v.to_sxp
+        end
+        (sym == :value ? v.to_sxp : "#{sym}: #{v.to_sxp}") if v
+      end.compact.join("\n  ")
+    end
+
+    ##
+    # Yields statements for this result
+    #
+    # @yield  [statement]
+    #   each statement
+    # @yieldparam  [RDF::Statement] statement
+    # @yieldreturn [void] ignored
+    # @return [void]
+    def each(&block)
+      subject = RDF::Node.new
+      block.call(RDF::Statement(subject, RDF.type, RDF::Vocab::SHACL.ValidationResult))
+
+      block.call(RDF::Statement(subject, RDF::Vocab::SHACL.focusNode, focus)) if focus
+      case path
+      when RDF::URI
+        block.call(RDF::Statement(subject, RDF::Vocab::SHACL.resultPath, path))
+      when SPARQL::Algebra::Expression
+        path.each_statement(&block)
+        block.call(RDF::Statement(subject, RDF::Vocab::SHACL.resultPath, path.subject))
+      end
+      block.call(RDF::Statement(subject, RDF::Vocab::SHACL.resultSeverity, resultSeverity)) if resultSeverity
+      block.call(RDF::Statement(subject, RDF::Vocab::SHACL.sourceConstraintComponent, component)) if component
+      block.call(RDF::Statement(subject, RDF::Vocab::SHACL.sourceShape, shape)) if shape
+      block.call(RDF::Statement(subject, RDF::Vocab::SHACL.value, value)) if value
+      block.call(RDF::Statement(subject, RDF::Vocab::SHACL.detail, RDF::Literal(details))) if details
+      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
+
+      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
+
+    # To results are eql? if their overlapping properties are equal
+    # @param [ValidationResult] other
+    # @return [Boolean]
+    def ==(other)
+      return false unless other.is_a?(ValidationResult)
+      %i(focus path resultSeverity component shape value).all? do |prop|
+        ours = self.send(prop)
+        theirs = other.send(prop)
+        theirs.nil? || (ours && ours.node? && theirs.node?) || ours && ours.eql?(theirs)
+      end
+    end
+
+    # Inspect as SXP
+    def inspect
+      SXP::Generator.string to_sxp_bin
+    end
+  end
+end

data/lib/shacl/version.rb

@@ -0,0 +1,19 @@
+module SHACL
+  module VERSION
+    FILE = File.expand_path('../../../VERSION', __FILE__)
+    MAJOR, MINOR, TINY, EXTRA = File.read(FILE).chomp.split('.')
+    STRING = [MAJOR, MINOR, TINY, EXTRA].compact.join('.').freeze
+
+    ##
+    # @return [String]
+    def self.to_s() STRING end
+
+    ##
+    # @return [String]
+    def self.to_str() STRING end
+
+    ##
+    # @return [Array(String, String, String, String)]
+    def self.to_a() [MAJOR, MINOR, TINY, EXTRA].compact end
+  end
+end

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: shacl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gregg Kellogg
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.8
+- !ruby/object:Gem::Dependency
+  name: json-ld
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.7
+- !ruby/object:Gem::Dependency
+  name: sxp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: sparql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rdf-spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rdf-turtle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rdf-xsd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Implements SHACL Core and SHACL-SPARQL within the RDF.rb ecosystem.
+email: public-rdf-ruby@w3.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- VERSION
+- etc/doap.ttl
+- lib/rdf/vocab/shacl.rb
+- lib/shacl.rb
+- lib/shacl/algebra.rb
+- lib/shacl/algebra/and.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/property_shape.rb
+- lib/shacl/algebra/qualified_value_shape.rb
+- lib/shacl/algebra/shape.rb
+- lib/shacl/algebra/xone.rb
+- lib/shacl/context.rb
+- lib/shacl/format.rb
+- lib/shacl/refinements.rb
+- lib/shacl/shapes.rb
+- lib/shacl/validation_report.rb
+- lib/shacl/validation_result.rb
+- lib/shacl/version.rb
+homepage: https://ruby-rdf.github.com/shacl
+licenses:
+- Unlicense
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Implementation of Shapes Constraint Language (SHACL) for RDF.rb
+test_files: []