rdf-rdfxml 3.2.1 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfa748c97db5ab4bb41a371438ff9b948da9e283be1ca9236c22011c1063ef4a
-  data.tar.gz: 9728665fbc8e96663b2f43761d78b997dd0514f77ff58bbeb178fc9a295ccc5e
+  metadata.gz: 31d21f8a5ec4aaeb5a8cb7bb31f93fbc593021e5a625cd08449eea5d805b5a27
+  data.tar.gz: 82f02071b30962db802433efa1f2229d981c6f072589b1815318fd4c88b17927
 SHA512:
-  metadata.gz: ba53a0163d5d8b3fa8c6023afcdec46348336df48f69a6f4a8a388eefeba0450adedd6a3525666afb8e6dcb789e30a9d10fcbda8b09f3df2833c28e27d126ced
-  data.tar.gz: 736215a450c7efe0ba7c94c8f96c1bfc0cf1412af4019e36e7cb962106f7b47144fb635b65236a23e1e8ebf141c8970ef0200f8684b231406715aeddceab02d0
+  metadata.gz: 40396b842bcfc0036f89d2c54240df74214cf0f53d1b0d25533e51a04abad3f3e1d354e1dbe3e5268c1fd45abd548413edadc6dc9dcee83ea219ac896317c495
+  data.tar.gz: 8126b7218906cf1d25a76c066af26fa2ad033531299df32095bfa27b8446eab886ea263e477f23d323354b1b5852ae2f4e2057295f30e641459d7d24681218be

data/README.md

@@ -2,7 +2,7 @@
 
 [RDF/XML][] reader/writer for [RDF.rb][].
 
-[![Gem Version](https://badge.fury.io/rb/rdf-rdfxml.png)](https://badge.fury.io/rb/rdf-rdfxml)
+[![Gem Version](https://badge.fury.io/rb/rdf-rdfxml.svg)](https://badge.fury.io/rb/rdf-rdfxml)
 [![Build Status](https://github.com/ruby-rdf/rdf-rdfxml/workflows/CI/badge.svg?branch=develop)](https://github.com/ruby-rdf/rdf-rdfxml/actions?query=workflow%3ACI)
 [![Coverage Status](https://coveralls.io/repos/ruby-rdf/rdf-rdfxml/badge.svg?branch=develop)](https://coveralls.io/github/ruby-rdf/rdf-rdfxml?branch=develop)
 [![Gitter chat](https://badges.gitter.im/ruby-rdf/rdf.png)](https://gitter.im/ruby-rdf/rdf)
@@ -20,7 +20,7 @@ Install with `gem install rdf-rdfxml`
 
 * 100% free and unencumbered [public domain](https://unlicense.org/) software.
 * Implements a complete parser for [RDF/XML][].
-* Compatible with Ruby >= 2.6.
+* Compatible with Ruby >= 3.0.
 
 ## Usage:
 Instantiate a parser and parse source, specifying type and base-URL
@@ -42,9 +42,9 @@ Write a graph to a file:
     end
 
 ## Dependencies
-* [RDF.rb](https://rubygems.org/gems/rdf) (~> 3.2)
-* [Haml](https://rubygems.org/gems/haml) (~>- 5.2)
-* Soft dependency on [Nokogiri](https://rubygems.org/gems/nokogiri) (>= 1.12)
+* [RDF.rb](https://rubygems.org/gems/rdf) (~> 3.3)
+* [Builder](https://rubygems.org/gems/builder) (~>- 3.2)
+* Soft dependency on [Nokogiri](https://rubygems.org/gems/nokogiri) (>= 1.15)
 
 ## Documentation
 Full documentation available on [Rubydoc.info][RDF/XML doc])

data/VERSION

@@ -1 +1 @@
-3.2.1
+3.3.0

data/lib/rdf/rdfxml/extensions.rb

@@ -0,0 +1,54 @@
+# Extend builder to allow for better control of whitespace in XML Literals
+
+require 'builder'
+
+module Builder
+  # Extends XmlMarkup#tag! to better control whitespace when adding content from a block
+  #
+  class RdfXml < Builder::XmlMarkup
+    # Create a tag named +sym+.  Other than the first argument which
+    # is the tag name, the arguments are the same as the tags
+    # implemented via <tt>method_missing</tt>.
+    #
+    # @see https://github.com/jimweirich/builder/blob/master/lib/builder/xmlbase.rb
+    def tag!(sym, *args, &block)
+      text = nil
+      attrs = args.last.is_a?(::Hash) ? args.last : {}
+      return super unless block && attrs[:no_whitespace]
+      attrs.delete(:no_whitespace)
+
+      sym = "#{sym}:#{args.shift}".to_sym if args.first.kind_of?(::Symbol)
+
+      args.each do |arg|
+        case arg
+        when ::Hash
+          attrs.merge!(arg)
+        when nil
+          attrs.merge!({:nil => true}) if explicit_nil_handling?
+        else
+          text ||= ''
+          text << arg.to_s
+        end
+      end
+
+      unless text.nil?
+        ::Kernel::raise ::ArgumentError,
+          "XmlMarkup cannot mix a text argument with a block"
+      end
+
+      # Indent
+      _indent
+      #unless @indent == 0 || @level == 0
+      #  text!(" " * (@level * @indent))
+      #end
+
+      _start_tag(sym, attrs)
+      begin
+        _nested_structures(block)
+      ensure
+        _end_tag(sym)
+        _newline
+      end
+    end
+  end
+end

data/lib/rdf/rdfxml/reader.rb

@@ -1,6 +1,6 @@
 begin
   require 'nokogiri'
-rescue LoadError => e
+rescue LoadError
   :rexml
 end
 require 'rdf/xsd'
@@ -91,7 +91,7 @@ module RDF::RDFXML
       # Produce the next list entry for this context
       def li_next
         @li_counter += 1
-        predicate = RDF["_#{@li_counter}"]
+        RDF["_#{@li_counter}"]
       end
 
       # Set XML base. Ignore any fragment
@@ -328,7 +328,6 @@ module RDF::RDFXML
       end
       
       # Handle the propertyEltList children events in document order
-      li_counter = 0 # this will increase for each li we iterate through
       el.children.each do |child|
         log_fatal "child must be a proxy not a #{child.class}" unless child.is_a?(@implementation::NodeProxy)
         next unless child.element?

data/lib/rdf/rdfxml/writer.rb

@@ -1,4 +1,4 @@
-require 'rdf/rdfa'
+require_relative 'extensions'
 
 module RDF::RDFXML
   ##
@@ -47,12 +47,22 @@ module RDF::RDFXML
   #   end
   #
   # @author [Gregg Kellogg](http://greggkellogg.net/)
-  class Writer < RDF::RDFa::Writer
+  class Writer < RDF::Writer
     format RDF::RDFXML::Format
     include RDF::Util::Logger
 
     VALID_ATTRIBUTES = [:none, :untyped, :typed]
 
+    # Defines rdf:type of subjects to be emitted at the beginning of the document.
+    # @return [Array<URI>]
+    attr :top_classes
+
+    # @return [Graph] Graph of statements serialized
+    attr_accessor :graph
+
+    # @return [RDF::URI] Base URI used for relativizing URIs
+    attr_accessor :base_uri
+
     ##
     # RDF/XML Writer options
     # @see https://ruby-rdf.github.io/rdf/RDF/Writer#options-class_method
@@ -71,8 +81,8 @@ module RDF::RDFXML
         RDF::CLI::Option.new(
           symbol: :lang,
           datatype: String,
-          on: ["--lang"],
-          description: "Output as root @lang attribute, and avoid generation _@lang_ where possible."),
+          on: ["--lang LANG", :REQUIRED],
+          description: "Output as root xml:lang attribute, and avoid generation xml:lang, where possible.") {|arg| RDF::URI(arg)},
         RDF::CLI::Option.new(
           symbol: :max_depth,
           datatype: Integer,
@@ -93,71 +103,152 @@ module RDF::RDFXML
     #   the output stream
     # @param  [Hash{Symbol => Object}] options
     #   any additional options
-    # @option options [Boolean]  :canonicalize (false)
-    #   whether to canonicalize literals when serializing
-    # @option options [Hash]     :prefixes     (Hash.new)
-    #   the prefix mappings to use (not supported by all writers)
+    # @option options [Symbol]    :attributes   (nil)
+    #   How to use XML attributes when serializing, one of :none, :untyped, :typed. The default is :none.
     # @option options [#to_s]    :base_uri     (nil)
     #   the base URI to use when constructing relative URIs
-    # @option options [Integer]  :max_depth (10)
-    #   Maximum depth for recursively defining resources
+    # @option options [Boolean]  :canonicalize (false)
+    #   whether to canonicalize literals when serializing
+    # @option options [String]   :default_namespace (nil)
+    #   URI to use as default namespace, same as prefix(nil)
     # @option options [#to_s]   :lang   (nil)
     #   Output as root xml:lang attribute, and avoid generation _xml:lang_ where possible
-    # @option options [Symbol]    :attributes   (nil)
-    #   How to use XML attributes when serializing, one of :none, :untyped, :typed. The default is :none.
+    # @option options [Integer]  :max_depth (10)
+    #   Maximum depth for recursively defining resources
+    # @option options [Hash]     :prefixes     (Hash.new)
+    #   the prefix mappings to use (not supported by all writers)
     # @option options [Boolean]  :standard_prefixes   (false)
     #   Add standard prefixes to _prefixes_, if necessary.
-    # @option options [String]   :default_namespace (nil)
-    #   URI to use as default namespace, same as prefix(nil)
     # @option options [String] :stylesheet (nil)
     #   URI to use as @href for output stylesheet processing instruction.
+    # @option options [Array<RDF::URI>] :top_classes ([RDF::RDFS.Class])
+    #   Defines rdf:type of subjects to be emitted at the beginning of the document.
     # @yield  [writer]
     # @yieldparam [RDF::Writer] writer
     def initialize(output = $stdout, **options, &block)
-      super
-    end
+      super do
+        @graph = RDF::Graph.new
+        @uri_to_prefix = {}
+        @uri_to_qname = {}
+        @top_classes = options[:top_classes] || [RDF::RDFS.Class]
 
-    # @return [Hash<Symbol => String>]
-    def haml_template
-      return @haml_template if @haml_template
-      case @options[:haml]
-      when Hash             then @options[:haml]
-      else                       DEFAULT_HAML
+        block.call(self) if block_given?
       end
     end
 
+    ##
+    # Addes a triple to be serialized
+    # @param  [RDF::Resource] subject
+    # @param  [RDF::URI]      predicate
+    # @param  [RDF::Value]    object
+    # @return [void]
+    # @raise  [NotImplementedError] unless implemented in subclass
+    # @abstract
+    # @raise [RDF::WriterError] if validating and attempting to write an invalid {RDF::Term}.
+    def write_triple(subject, predicate, object)
+      @graph.insert(RDF::Statement(subject, predicate, object))
+    end
+
     def write_epilogue
-      @force_RDF_about = {}
       @max_depth = @options.fetch(:max_depth, 10)
       @attributes = @options.fetch(:attributes, :none)
+      @base_uri = RDF::URI(@options[:base_uri]) if @options[:base_uri]
+      @lang = @options[:lang]
+      self.reset
+
+      log_debug {"\nserialize: graph size: #{@graph.size}"}
+
+      preprocess
+      # Prefixes
+      prefix = prefixes.keys.map {|pk| "#{pk}: #{prefixes[pk]}"}.sort.join(" ") unless prefixes.empty?
+      log_debug {"\nserialize: prefixes: #{prefix.inspect}"}
+
+      @subjects = order_subjects
+
+      # Generate document
+      doc = render_document(@subjects,
+        lang:       @lang,
+        base:       base_uri,
+        prefix:     prefix,
+        stylesheet: @options[:stylesheet]) do |s|
+        subject(s)
+      end
+      @output.write(doc)
 
       super
     end
 
   protected
+
+    # Reset parser to run again
+    def reset
+      @options[:log_depth] = 0
+      @references = {}
+      @serialized = {}
+      @subjects = {}
+    end
+
+    # Render document using `haml_template[:doc]`. Yields each subject to be rendered separately.
+    #
+    # @param [Array<RDF::Resource>] subjects
+    #   Ordered list of subjects. Template must yield to each subject, which returns
+    #   the serialization of that subject (@see #subject_template)
+    # @param [Hash{Symbol => Object}] options Rendering options passed to Haml render.
+    # @option options [RDF::URI] base (nil)
+    #   Base URI added to document, used for shortening URIs within the document.
+    # @option options [Symbol, String] language (nil)
+    #   Value of @lang attribute in document, also allows included literals to omit
+    #   an @lang attribute if it is equivalent to that of the document.
+    # @option options [String] title (nil)
+    #   Value of html>head>title element.
+    # @option options [String] prefix (nil)
+    #   Value of @prefix attribute.
+    # @option options [String] haml (haml_template[:doc])
+    #   Haml template to render.
+    # @yield [subject]
+    #   Yields each subject
+    # @yieldparam [RDF::URI] subject
+    # @yieldparam [Builder::RdfXml] builder
+    # @yieldreturn [:ignored]
+    # @return String
+    #   The rendered document is returned as a string
+    def render_document(subjects, lang: nil, base: nil, **options, &block)
+      builder = Builder::RdfXml.new(indent: 2)
+      builder.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
+      builder.instruct! :'xml-stylesheet', type: 'text/xsl', href: options[:stylesheet] if options[:stylesheet]
+      attrs = prefix_attrs
+      attrs[:"xml:lang"] = lang if lang
+      attrs[:"xml:base"] = base if base
+
+      builder.rdf(:RDF, **attrs) do |b|
+        subjects.each do |subject|
+          render_subject(subject, b, **options)
+        end
+      end
+    end
+
     # Render a subject using `haml_template[:subject]`.
     #
     # The _subject_ template may be called either as a top-level element, or recursively under another element if the _rel_ local is not nil.
     #
     #  For RDF/XML, removes from predicates those that can be rendered as attributes, and adds the `:attr_props` local for the Haml template, which includes all attributes to be rendered as properties.
     #
-    # Yields each predicate/property to be rendered separately (@see #render_property_value and `#render_property_values`).
+    # Yields each property to be rendered separately.
     #
     # @param [Array<RDF::Resource>] subject
     #   Subject to render
-    # @param [Array<RDF::Resource>] predicates
-    #   Predicates of subject. Each property is yielded for separate rendering.
+    # @param [Builder::RdfXml] builder
     # @param [Hash{Symbol => Object}] options Rendering options passed to Haml render.
     # @option options [String] about (nil)
-    #   About description, a CURIE, URI or Node definition.
+    #   About description, a QName, URI or Node definition.
     #   May be nil if no @about is rendered (e.g. unreferenced Nodes)
     # @option options [String] resource (nil)
-    #   Resource description, a CURIE, URI or Node definition.
+    #   Resource description, a QName, URI or Node definition.
     #   May be nil if no @resource is rendered
     # @option options [String] rel (nil)
-    #   Optional @rel property description, a CURIE, URI or Node definition.
+    #   Optional @rel property description, a QName, URI or Node definition.
     # @option options [String] typeof (nil)
-    #   RDF type as a CURIE, URI or Node definition.
+    #   RDF type as a QName, URI or Node definition.
     #   If :about is nil, this defaults to the empty string ("").
     # @option options [:li, nil] element (nil)
     #   Render with &lt;li&gt;, otherwise with template default.
@@ -167,102 +258,54 @@ module RDF::RDFXML
     #   Yields each predicate
     # @yieldparam [RDF::URI] predicate
     # @yieldreturn [:ignored]
-    # @return String
-    #   The rendered document is returned as a string
-    # Return Haml template for document from `haml_template[:subject]`
-    def render_subject(subject, predicates, **options, &block)
-      # extract those properties that can be rendered as attributes
-      attr_props = if [:untyped, :typed].include?(@attributes)
-        options[:property_values].inject({}) do |memo, (prop, values)|
-          object = values.first
-          if values.length == 1 &&
-            object.literal? &&
-            (object.plain? || @attributes == :typed) &&
-            get_lang(object).nil?
+    # @return Builder::RdfXml
+    def render_subject(subject, builder, **options, &block)
+      return nil if is_done?(subject)
+
+      attr_props, embed_props, types = prop_partition(properties_for_subject(subject))
+
+      # The first type is used for
+      first_type = types.shift
+      type_qname = get_qname(first_type) if first_type && !first_type.node?
+      type_qname = nil unless type_qname.is_a?(String)
+      types.unshift(first_type) if first_type && !type_qname
+      type_qname ||= "rdf:Description"
+
+      attr_props = attr_props.merge("rdf:nodeID": subject.id) if subject.node? && ref_count(subject) >= 1
+      attr_props = attr_props.merge("rdf:about": subject.relativize(base_uri)) if subject.uri?
+
+      log_debug {"render_subject(#{subject.inspect})"}
+      subject_done(subject)
 
-            memo[get_qname(RDF::URI(prop))] = object.value
+      builder.tag!(type_qname, **attr_props) do |b|
+        types.each do |type|
+          if type.node?
+            b.tag!("rdf:type",  "rdf:nodeID": type.id)
+          else
+            b.tag!("rdf:type",  "rdf:resource": type.to_s)
           end
-          memo
         end
-      else
-        {}
-      end
-
-      predicates -= attr_props.keys.map {|k| expand_curie(k).to_s}
-      super(subject, predicates, **options.merge(attr_props: attr_props), &block)
-    end
-    # See if we can serialize as attribute.
-    # * untyped attributes that aren't duplicated where xml:lang == @lang
-    # * typed attributes that aren't duplicated if @dt_as_attr is true
-    # * rdf:type
-    def predicate_as_attribute?(prop, object)
-      [:untyped, :typed].include?(@attributes) && (
-        prop == RDF.type ||
-        [:typed].include?(@attributes) && object.literal? && object.typed? ||
-        (object.literal? && object.simple? || @lang && object.language.to_s == @lang.to_s)
-      )
-    end
 
-    # Render document using `haml_template[:doc]`. Yields each subject to be rendered separately.
-    #
-    # For RDF/XML pass along a stylesheet option.
-    #
-    # @param [Array<RDF::Resource>] subjects
-    #   Ordered list of subjects. Template must yield to each subject, which returns
-    #   the serialization of that subject (@see #subject_template)
-    # @param [Hash{Symbol => Object}] options Rendering options passed to Haml render.
-    # @option options [RDF::URI] base (nil)
-    #   Base URI added to document, used for shortening URIs within the document.
-    # @option options [Symbol, String] language (nil)
-    #   Value of @lang attribute in document, also allows included literals to omit
-    #   an @lang attribute if it is equivalent to that of the document.
-    # @option options [String] title (nil)
-    #   Value of html>head>title element.
-    # @option options [String] prefix (nil)
-    #   Value of @prefix attribute.
-    # @option options [String] haml (haml_template[:doc])
-    #   Haml template to render.
-    # @yield [subject]
-    #   Yields each subject
-    # @yieldparam [RDF::URI] subject
-    # @yieldreturn [:ignored]
-    # @return String
-    #   The rendered document is returned as a string
-    def render_document(subjects, **options, &block)
-      super(subjects, **options.merge(stylesheet: @options[:stylesheet]), &block)
+        log_depth do
+          embed_props.each do |p, objects|
+            render_property(p, objects, b, **options)
+          end
+        end
+      end
     end
 
-    # Render a single- or multi-valued predicate using `haml_template[:property_value]` or `haml_template[:property_values]`. Yields each object for optional rendering. The block should only render for recursive subject definitions (i.e., where the object is also a subject and is rendered underneath the first referencing subject).
-    #
-    # For RDF/XML, pass the `:no_list_literals` option onto the `RDFa` implementation because of special considerations for lists in RDF/XML.
+    # Render a single- or multi-valued property. Yields each object for optional rendering. The block should only render for recursive subject definitions (i.e., where the object is also a subject and is rendered underneath the first referencing subject).
     #
     # If a multi-valued property definition is not found within the template, the writer will use the single-valued property definition multiple times.
     #
-    # @param [Array<RDF::Resource>] predicate
-    #   Predicate to render.
+    # @param [String] property
+    #   Property to render, already in QName form.
     # @param [Array<RDF::Resource>] objects
     #   List of objects to render. If the list contains only a single element, the :property_value template will be used. Otherwise, the :property_values template is used.
+    # @param [Builder::RdfXml] builder
     # @param [Hash{Symbol => Object}] options Rendering options passed to Haml render.
-    # @option options [String] :haml (haml_template[:property_value], haml_template[:property_values])
-    #   Haml template to render. Otherwise, uses `haml_template[:property_value] or haml_template[:property_values]`
-    #   depending on the cardinality of objects.
-    # @option options [Boolean] :no_list_literals
-    #   Do not serialize as a list if any elements are literal.
-    # @yield object, inlist
-    #   Yields object and if it is contained in a list.
-    # @yieldparam [RDF::Resource] object
-    # @yieldparam [Boolean] inlist
-    # @yieldreturn [String, nil]
-    #   The block should only return a string for recursive object definitions.
-    # @return String
-    #   The rendered document is returned as a string
-    def render_property(predicate, objects, **options, &block)
-      log_debug {"render_property(#{predicate}): #{objects.inspect}, #{options.inspect}"}
-      # If there are multiple objects, and no :property_values is defined, call recursively with
-      # each object
-
-      template = options[:haml]
-      template ||= haml_template[:property_value]
+    def render_property(property, objects, builder, **options)
+      log_debug {"render_property(#{property}): #{objects.inspect}"}
 
       # Separate out the objects which are lists and render separately
       lists = objects.
@@ -270,38 +313,57 @@ module RDF::RDFXML
         map {|o| RDF::List.new(subject: o, graph: @graph)}.
         select {|l| l.valid? && l.none?(&:literal?)}
 
+      objects = objects - lists.map(&:subject)
+
       unless lists.empty?
         # Render non-list objects
-        log_debug {"properties with lists: #{lists} non-lists: #{objects - lists.map(&:subject)}"}
-        nl = log_depth {render_property(predicate, objects - lists.map(&:subject), options, &block)} unless objects == lists.map(&:subject)
-        return nl.to_s + lists.map do |list|
+        log_debug(depth: log_depth + 1) {"properties with lists: #{lists} non-lists: #{objects - lists.map(&:subject)}"}
+
+        unless objects.empty?
+          render_property(property,  objects, builder, **options)
+        end
+
+        # Render each list
+        lists.each do |list|
           # Render each list as multiple properties and set :inlist to true
           list.each_statement {|st| subject_done(st.subject)}
 
-          log_debug {"list: #{list.inspect} #{list.to_a}"}
           log_depth do
-            render_collection(predicate, list, **options) do |object|
-              yield(object, true) if block_given?
-            end
+            log_debug {"list: #{list.inspect} #{list.to_a}"}
+            render_collection(property, list, builder, **options)
           end
-        end.join(" ")
+        end
       end
 
-      if objects.length > 1
-        # Render each property using property_value template
-        objects.map do |object|
-          log_depth {render_property(predicate, [object], **options, &block)}
-        end.join(" ")
+      if objects.length == 1
+        recurse = log_depth <= @max_depth
+        object = objects.first
+        
+        if recurse && !is_done?(object)
+          builder.tag!(property) do |b|
+            render_subject(object, b, **options)
+          end
+        elsif object.literal? && object.datatype == RDF.XMLLiteral
+          builder.tag!(property, "rdf:parseType": "Literal", no_whitespace: true) do |b|
+            b << object.value
+          end
+        elsif object.literal?
+          attrs = {}
+          attrs[:"xml:lang"] = object.language if object.language?
+          attrs[:"rdf:datatype"] = object.datatype if object.datatype?
+          builder.tag!(property, object.value.to_s, **attrs)
+        elsif object.node?
+           builder.tag!(property, "rdf:nodeID": object.id)
+        else
+          builder.tag!(property, "rdf:resource": object.relativize(base_uri))
+        end
       else
-        log_fatal("Missing property template", exception:  RDF::WriterError) if template.nil?
-
-        options = {
-          object:     objects.first,
-          predicate:  predicate,
-          property:   get_qname(predicate),
-          recurse:    log_depth <= @max_depth
-        }.merge(options)
-        hamlify(template, **options, &block)
+        # Render each property using property_value template
+        objects.each do |object|
+          log_depth do
+            render_property(property, [object], builder, **options)
+          end
+        end
       end
     end
 
@@ -309,27 +371,27 @@ module RDF::RDFXML
     # Render a collection, which may be included in a property declaration, or
     # may be recursive within another collection
     #
-    # @param [RDF::URI] predicate
+    # @param [String] property in QName form
     # @param [RDF::List] list
+    # @param [Builder::RdfXml] builder
     # @param [Hash{Symbol => Object}] options
-    # @yield object
-    #   Yields object, unless it is an included list
-    # @yieldparam [RDF::Resource] object
-    # @yieldreturn [String, nil]
-    #   The block should only return a string for recursive object definitions.
     # @return String
     #   The rendered collection is returned as a string
-    def render_collection(predicate, list, **options, &block)
-      template = options[:haml] || haml_template[:collection]
-
-      options = {
-        list:       list,
-        predicate:  predicate,
-        property:   get_qname(predicate),
-        recurse:    log_depth <= @max_depth,
-      }.merge(options)
-      hamlify(template, **options) do |object|
-        yield object
+    def render_collection(property, list, builder, **options, &block)
+      builder.tag!(property, "rdf:parseType": "Collection") do |b|
+        list.each do |object|
+          if log_depth <= @max_depth && !is_done?(object)
+            render_subject(object, b)
+          elsif object.node?
+            if ref_count(object) > 1
+              b.tag!("rdf:Description", "rdf:nodeID": object.id)
+            else
+              b.tag!("rdf:Description")
+            end
+          else
+            b.tag!("rdf:Description", "rdf:about": object.relativize(base_uri))
+          end
+        end
       end
     end
 
@@ -337,7 +399,7 @@ module RDF::RDFXML
     # @return [Hash{String => String}]
     def prefix_attrs
       prefixes.inject({}) do |memo, (k, v)|
-        memo[k ? "xmlns:#{k}" : "xmlns"] = v.to_s
+        memo[(k ? "xmlns:#{k}" : "xmlns").to_sym] = v.to_s
         memo
       end
     end
@@ -363,32 +425,174 @@ module RDF::RDFXML
         prefix(nil, @options[:default_namespace])
       end
 
-      # Process each statement to establish CURIEs and Terms
+      # Process each statement to establish QNames and Terms
       @graph.each {|statement| preprocess_statement(statement)}
     end
 
-    ##
-    # Turn CURIE into a QNAME
-    def get_qname(uri)
-      curie = get_curie(uri)
-      curie.start_with?(":") ? curie[1..-1] : curie
-    end
-
     # Perform any statement preprocessing required. This is used to perform reference counts and determine required prefixes.
     #
-    # For RDF/XML, make sure that all predicates have CURIEs
+    # For RDF/XML, make sure that all predicates have QNames
     # @param [Statement] statement
     def preprocess_statement(statement)
-      super
+      #log_debug {"preprocess: #{statement.inspect}"}
+      bump_reference(statement.object)
+      @subjects[statement.subject] = true
+      get_qname(statement.subject)
+      ensure_qname(statement.predicate)
+      statement.predicate == RDF.type && statement.object.uri? ? ensure_qname(statement.object) : get_qname(statement.object)
+      get_qname(statement.object.datatype) if statement.object.literal? && statement.object.datatype?
+    end
+
+  private
 
-      # Invent a prefix for the predicate, if necessary
-      ensure_curie(statement.predicate)
-      ensure_curie(statement.object) if statement.predicate == RDF.type
+    # Order subjects for output. Override this to output subjects in another order.
+    #
+    # Uses #top_classes and #base_uri.
+    # @return [Array<Resource>] Ordered list of subjects
+    def order_subjects
+      seen = {}
+      subjects = []
+
+      # Start with base_uri
+      if base_uri && @subjects.keys.include?(base_uri)
+        subjects << base_uri
+        seen[base_uri] = true
+      end
+
+      # Add distinguished classes
+      top_classes.
+      select {|s| !seen.include?(s)}.
+      each do |class_uri|
+        graph.query({predicate: "rdf:type", object: class_uri}).map {|st| st.subject}.sort.uniq.each do |subject|
+          #log_debug {"order_subjects: #{subject.inspect}"}
+          subjects << subject
+          seen[subject] = true
+        end
+      end
+
+      # Sort subjects by resources over nodes, ref_counts and the subject URI itself
+      recursable = @subjects.keys.
+        select {|s| !seen.include?(s)}.
+        map {|r| [r.is_a?(RDF::Node) ? 1 : 0, ref_count(r), r]}.
+        sort
+
+      log_debug {"order_subjects: #{recursable.inspect}"}
+
+      subjects += recursable.map{|r| r.last}
+    end
+
+    # @param [RDF::Resource] subject
+    # @return [Hash{String => Object}]
+    def properties_for_subject(subject)
+      properties = {}
+      @graph.query({subject: subject}) do |st|
+        key = get_qname(st.predicate.to_s)
+        properties[key] ||= []
+        properties[key] << st.object
+      end
+      properties
+    end
+
+    # Partition properties into attributed, embedded, and types
+    #
+    # @param [Hash{String => Array<RDF::Resource}] properties
+    # @return [Hash, Hash, Array<RDF::Resource>]
+    def prop_partition(properties)
+      attr_props, embed_props = {}, {}
+
+      type_prop = "rdf:type"
+      types = properties.delete(type_prop)
+
+      # extract those properties that can be rendered as attributes
+      if [:untyped, :typed].include?(@attributes)
+        properties.each do |prop, values|
+          object = values.first
+          if values.length == 1 &&
+            object.literal? &&
+            (object.plain? || @attributes == :typed) &&
+            get_lang(object).nil?
+
+            attr_props[prop.to_sym] = values.first.to_s
+          else
+            embed_props[prop] = values
+          end
+        end
+      else
+        embed_props = properties
+      end
+
+      [attr_props, embed_props, Array(types)]
+    end
+
+    # Return language for literal, if there is no language, or it is the same as the document, return nil
+    #
+    # @param [RDF::Literal] literal
+    # @return [Symbol, nil]
+    # @raise [RDF::WriterError]
+    def get_lang(literal)
+      if literal.is_a?(RDF::Literal)
+        literal.language if literal.literal? && literal.language && literal.language.to_s != @lang.to_s
+      else
+        log_error("Getting language for #{literal.inspect}, which must be a literal")
+        nil
+      end
     end
 
-    # Make sure a CURIE is defined
-    def ensure_curie(resource)
-      if get_curie(resource) == resource.to_s || get_curie(resource).split(':', 2).last =~ /[\.#]/
+    # Return appropriate, term, QName or URI for the given resource.
+    #
+    # @param [RDF::Value, String] resource
+    # @return [String] value to use to identify URI
+    # @raise [RDF::WriterError]
+    def get_qname(resource)
+      return @uri_to_qname[resource] if resource.is_a?(String) && @uri_to_qname.key?(resource)
+
+      case resource
+      when RDF::URI
+        begin
+          uri = resource.to_s
+
+          qname = case
+          when @uri_to_qname.key?(uri)
+            @uri_to_qname[uri]
+          when base_uri && uri.index(base_uri.to_s) == 0
+            #log_debug {"get_qname(#{uri}): base_uri (#{uri.sub(base_uri.to_s, "")})"}
+            uri.sub(base_uri.to_s, "")
+          when u = @uri_to_prefix.keys.detect {|u| uri.index(u.to_s) == 0}
+            #log_debug {"get_qname(#{uri}): uri_to_prefix"}
+            # Use a defined prefix
+            prefix = @uri_to_prefix[u]
+            prefix(prefix, u)  # Define for output
+            uri.sub(u.to_s, "#{prefix}:")
+          when @options[:standard_prefixes] && vocab = RDF::Vocabulary.detect {|v| uri.index(v.to_uri.to_s) == 0}
+            #log_debug {"get_qname(#{uri}): standard_prefixes"}
+            prefix = vocab.__name__.to_s.split('::').last.downcase
+            prefix(prefix, vocab.to_uri) # Define for output
+            uri.sub(vocab.to_uri.to_s, "#{prefix}:")
+          end
+
+          # Don't define ill-formed qnames
+          @uri_to_qname[uri] = if qname.nil? || qname == ':'
+            resource
+          elsif qname.start_with?(':')
+            qname[1..-1]
+          else
+            qname
+          end
+        rescue ArgumentError => e
+          log_error("Invalid URI #{uri.inspect}: #{e.message}")
+          nil
+        end
+      when RDF::Node then resource.to_s
+      when RDF::Literal then nil
+      else
+        log_error("Getting QName for #{resource.inspect}, which must be a resource")
+        nil
+      end
+    end
+
+    # Make sure a QName is defined
+    def ensure_qname(resource)
+      if get_qname(resource) == resource.to_s || get_qname(resource).split(':', 2).last =~ /[\.#]/
         uri = resource.to_s
         # No vocabulary found, invent one
         # Add bindings for predicates not already having bindings
@@ -399,29 +603,40 @@ module RDF::RDFXML
         base_uri = uri.to_s[0..separation]
         suffix = uri.to_s[separation+1..-1]
         @gen_prefix = @gen_prefix ? @gen_prefix.succ : "ns0"
-        log_debug {"ensure_curie: generated prefix #{@gen_prefix} for #{base_uri}"}
+        log_debug {"ensure_qname: generated prefix #{@gen_prefix} for #{base_uri}"}
         @uri_to_prefix[base_uri] = @gen_prefix
-        @uri_to_term_or_curie[uri] = "#{@gen_prefix}:#{suffix}"
+        @uri_to_qname[uri] = "#{@gen_prefix}:#{suffix}"
         prefix(@gen_prefix, base_uri)
-        get_curie(resource)
+        get_qname(resource)
       end
     end
-    
-    # If base_uri is defined, use it to try to make uri relative
-    # @param [#to_s] uri
-    # @return [String]
-    def relativize(uri)
-      uri = expand_curie(uri.to_s)
-      base_uri ? uri.sub(base_uri.to_s, "") : uri
+
+    # Mark a subject as done.
+    # @param [RDF::Resource] subject
+    # @return [Boolean]
+    def subject_done(subject)
+      @serialized[subject] = true
     end
 
-    # Undo CURIE
-    # @return [RDF::URI]
-    def expand_curie(curie)
-      pfx, suffix = curie.split(":", 2)
-      prefix(pfx) ? prefix(pfx) + suffix : curie
+    # Determine if the subject has been completed
+    # @param [RDF::Resource] subject
+    # @return [Boolean]
+    def is_done?(subject)
+      @serialized.include?(subject) || !@subjects.include?(subject)
+    end
+
+    # Increase the reference count of this resource
+    # @param [RDF::Resource] resource
+    # @return [Integer] resulting reference count
+    def bump_reference(resource)
+      @references[resource] = ref_count(resource) + 1
+    end
+
+    # Return the number of times this node has been referenced in the object position
+    # @param [RDF::Node] node
+    # @return [Boolean]
+    def ref_count(node)
+      @references.fetch(node, 0)
     end
   end
 end
-
-require 'rdf/rdfxml/writer/haml_templates'

data/lib/rdf/rdfxml.rb

@@ -2,7 +2,8 @@ $:.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..')))
 require 'rdf'
 
 module RDF
-  autoload :XML, 'rdf/rdfa/vocab'
+  XML = Class.new(Vocabulary("http://www.w3.org/XML/1998/namespace"))
+
   ##
   # **`RDF::RDFXML`** is an RDF/XML extension for RDF.rb.
   #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdf-rdfxml
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.3.0
 platform: ruby
 authors:
 - Gregg
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-05 00:00:00.000000000 Z
+date: 2023-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdf
@@ -17,42 +17,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: rdf-xsd
   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'
-- !ruby/object:Gem::Dependency
-  name: rdf-rdfa
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
-  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: htmlentities
   requirement: !ruby/object:Gem::Requirement
@@ -68,47 +54,53 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.3'
 - !ruby/object:Gem::Dependency
-  name: haml
+  name: builder
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.4
 - !ruby/object:Gem::Dependency
   name: json-ld
   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
@@ -129,56 +121,56 @@ dependencies:
     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-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-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: yard
   requirement: !ruby/object:Gem::Requirement
@@ -206,14 +198,13 @@ files:
 - UNLICENSE
 - VERSION
 - lib/rdf/rdfxml.rb
+- lib/rdf/rdfxml/extensions.rb
 - lib/rdf/rdfxml/format.rb
-- lib/rdf/rdfxml/patches/nokogiri_hacks.rb
 - lib/rdf/rdfxml/reader.rb
 - lib/rdf/rdfxml/reader/nokogiri.rb
 - lib/rdf/rdfxml/reader/rexml.rb
 - lib/rdf/rdfxml/version.rb
 - lib/rdf/rdfxml/writer.rb
-- lib/rdf/rdfxml/writer/haml_templates.rb
 homepage: https://github.com/ruby-rdf/rdf-rdfxml
 licenses:
 - Unlicense
@@ -231,14 +222,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.4.6
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: RDF/XML reader/writer for RDF.rb.

data/lib/rdf/rdfxml/patches/nokogiri_hacks.rb

@@ -1,23 +0,0 @@
-require 'nokogiri'
-class Nokogiri::XML::Node
-  # URI of namespace + node_name
-  def uri
-    ns = self.namespace ? self.namespace.href : RDF::XML.to_s
-    RDF::URI.intern(ns + self.node_name)
-  end
-  
-  alias_method :attribute_with_ns_without_ffi_null, :attribute_with_ns
-  ##
-  # Monkey patch attribute_with_ns, to insure nil is returned for #null?
-  #
-  # Get the attribute node with name and namespace
-  #
-  # @param [String] name
-  # @param [String] namespace
-  # @return [Nokogiri::XML::Attr]
-  def attribute_with_ns(name, namespace)
-    a = attribute_with_ns_without_ffi_null(name, namespace)
-    
-    (a.respond_to?(:null?) && a.null?) ? nil : a # to ensure FFI Pointer compatibility
-  end
-end

data/lib/rdf/rdfxml/writer/haml_templates.rb

@@ -1,86 +0,0 @@
-# Default HAML templates used for generating RDF/XML output from the writer
-module RDF::RDFXML
-  class Writer
-    # The default set of HAML templates used for RDFa code generation
-   BASE_HAML = {
-     identifier: "base", 
-      # Document
-      # Locals: lang, title, prefix, base, subjects
-      # Yield: subjects.each
-      doc: %q(
-        = %(<?xml version='1.0' encoding='utf-8' ?>)
-        - if stylesheet
-          = %(<?xml-stylesheet type="text/xsl" href="#{stylesheet}"?>)
-        %rdf:RDF{prefix_attrs.merge("xml:lang" => lang, "xml:base" => base)}
-          - subjects.each do |subject|
-            != yield(subject)
-      ),
-
-      # Output for non-leaf resources
-      # Note that @about may be omitted for Nodes that are not referenced
-      #
-      # If _rel_ and _resource_ are not nil, the tag will be written relative
-      # to a previous subject. If _element_ is :li, the tag will be written
-      # with <li> instead of <div>.
-      #
-      # Locals: subject, typeof, predicates, rel, element, inlist, attr_props
-      # Yield: predicates.each
-      subject: %q(
-        - first_type, *types = typeof.to_s.split(' ')
-        - (types.unshift(first_type); first_type = nil) if first_type && (first_type.include?('/') || first_type.start_with?('_:'))
-        - first_type ||= get_qname(RDF.Description)
-        - first_type = first_type[1..-1] if first_type.to_s.start_with?(":")
-        - attr_props = attr_props.merge(get_qname(RDF.nodeID) => subject.id) if subject.node? && ref_count(subject) >= 1
-        - attr_props = attr_props.merge(get_qname(RDF.about) => relativize(subject)) if subject.uri?
-        - haml_tag(first_type, attr_props) do
-          - types.each do |type|
-            - expanded_type = expand_curie(type)
-            - if expanded_type.start_with?('_:')
-              - haml_tag(get_qname(RDF.type), "rdf:nodeID" => expanded_type[2..-1])
-            -else
-              - haml_tag(get_qname(RDF.type), "rdf:resource" => expanded_type)
-          - predicates.each do |p|
-            = yield(p)
-      ),
-
-      # Output for single-valued properties
-      # Locals: predicate, object, inlist
-      # Yields: object
-      # If nil is returned, render as a leaf
-      # Otherwise, render result
-      property_value: %q(
-      - if recurse && res = yield(object)
-        - haml_tag(property) do
-          = res
-      - elsif object.literal? && object.datatype == RDF.XMLLiteral
-        - haml_tag(property, :"<", "rdf:parseType" => "Literal") do
-          = object.value
-      - elsif object.literal?
-        - haml_tag(property, :"<", "xml:lang" => object.language, "rdf:datatype" => (object.datatype unless object.plain?)) do
-          = object.value.to_s.encode(xml: :text)
-      - elsif object.node?
-        - haml_tag(property, :"/", "rdf:nodeID" => object.id)
-      - else
-        - haml_tag(property, :"/", "rdf:resource" => relativize(object))
-      ),
-
-      # Outpust for a list
-      # Locals: predicate, list
-      # Yields: object
-      # If nil is returned, render as a leaf
-      # Otherwise, render result
-      collection: %q(
-        - haml_tag(property, get_qname(RDF.parseType) => "Collection") do
-          - list.each do |object|
-            - if recurse && res = yield(object)
-              = res
-            - elsif object.node?
-              - haml_tag(get_qname(RDF.Description), :"/", "rdf:nodeID" => (object.id if ref_count(object) > 1))
-            - else
-              - haml_tag(get_qname(RDF.Description), :"/", "rdf:about" => relativize(object))
-      ),
-    }
-    HAML_TEMPLATES = {base: BASE_HAML}
-    DEFAULT_HAML = BASE_HAML
-  end
-end