Class: RDF::Vocabulary

Inherits:
Object show all
Extended by:
Enumerable
Defined in:
vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb,
vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocab/writer.rb,
vendor/bundler/ruby/3.0.0/bundler/gems/rdf-vocab-20ebe47bf63c/lib/rdf/vocab/extensions.rb

Overview

Vocabulary format specification. This can be used to generate a Ruby class definition from a loaded vocabulary.

Definitions can include recursive term definitions, when the value of a property is a blank-node term. They can also include list definitions, to provide a reasonable way to represent owl:unionOf-type relationships.

Examples:

a simple term definition

property :comment,
  comment: %(A description of the subject resource.).freeze,
  domain: "rdfs:Resource".freeze,
  label: "comment".freeze,
  range: "rdfs:Literal".freeze,
  isDefinedBy: %(rdfs:).freeze,
  type: "rdf:Property".freeze

an embedded skos:Concept

term :ad,
  exactMatch: [term(
      type: "skos:Concept".freeze,
      inScheme: "country:iso3166-1-alpha-2".freeze,
      notation: %(ad).freeze
    ), term(
      type: "skos:Concept".freeze,
      inScheme: "country:iso3166-1-alpha-3".freeze,
      notation: %(and).freeze
    )],
  "foaf:name": "Andorra".freeze,
  isDefinedBy: "country:".freeze,
  type: "http://sweet.jpl.nasa.gov/2.3/humanJurisdiction.owl#Country".freeze

owl:unionOf

property :duration,
  comment: %(The duration of a track or a signal in ms).freeze,
  domain: term(
      "owl:unionOf": list("mo:Track".freeze, "mo:Signal".freeze),
      type: "owl:Class".freeze
    ),
  isDefinedBy: "mo:".freeze,
  "mo:level": "1".freeze,
  range: "xsd:float".freeze,
  type: "owl:DatatypeProperty".freeze,
  "vs:term_status": "testing".freeze

Defined Under Namespace

Modules: Term, VocabFormatExtensions Classes: Format, Writer

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(uri) ⇒ Vocabulary

Returns a new instance of Vocabulary.

Parameters:



694
695
696
697
698
699
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 694

def initialize(uri)
  @uri = case uri
    when RDF::URI then uri.to_s
    else RDF::URI.parse(uri.to_s) ? uri.to_s : nil
  end
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(property, *args, &block) ⇒ Object (protected)



744
745
746
747
748
749
750
751
752
753
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 744

def method_missing(property, *args, &block)
  property = self.class.camelize(property.to_s)
  if %w(to_ary).include?(property.to_s)
    super
  elsif args.empty?
    self[property]
  else
    super
  end
end

Class Method Details

.[](property) ⇒ RDF::URI

Returns the URI for the term property in this vocabulary.

Parameters:

Returns:



441
442
443
444
445
446
447
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 441

def [](property)
  if props.key?(property.to_sym)
    props[property.to_sym]
  else
    Term.intern([to_s, property.to_s].join(''), vocab: self, attributes: {})
  end
end

.__prefix__Symbol

Returns a suggested CURIE/PName prefix for this vocabulary class.

Returns:

Since:

  • 0.3.0



649
650
651
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 649

def __prefix__
  __name__.split('::').last.downcase.to_sym
end

._orig_each {|klass| ... } ⇒ Enumerator

Enumerates known RDF vocabulary classes. Enumerates known RDF vocabulary classes.

Yields:

  • (klass)
  • (klass)

Yield Parameters:

  • klass (Class)
  • klass (Class)

Returns:

  • (Enumerator)
  • (Enumerator)


17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-vocab-20ebe47bf63c/lib/rdf/vocab/extensions.rb', line 17

def each(&block)
  if self.equal?(Vocabulary)
    if @vocabs
      @vocabs.select(&:name).each(&block)
    else
      # This is needed since all vocabulary classes are defined using
      # Ruby's autoloading facility, meaning that `@@subclasses` will be
      # empty until each subclass has been touched or require'd.
      RDF::VOCABS.each { |v, p| RDF.const_get(p[:class_name].to_sym) unless v == :rdf }
      @@subclasses.select(&:name).each(&block)
    end
  else
    __properties__.each(&block)
  end
end

._orig_from_symRDF::Vocabulary

Return the vocabulary based on it's class_name symbol Return the vocabulary based on it's class_name symbol

Parameters:

Returns:



48
49
50
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-vocab-20ebe47bf63c/lib/rdf/vocab/extensions.rb', line 48

def from_sym(sym)
  RDF.const_get(sym.to_sym)
end

.camelize(str) ⇒ Object (protected)



755
756
757
758
759
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 755

def self.camelize(str)
  str.split('_').inject([]) do |buffer, e| 
    buffer.push(buffer.empty? ? e : e.capitalize)
  end.join
end

.each {|klass| ... } ⇒ Enumerator

Enumerates known RDF vocabulary classes.

Yields:

  • (klass)

Yield Parameters:

  • klass (Class)

Returns:

  • (Enumerator)


71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 71

def each(&block)
  if self.equal?(Vocabulary)
    if @vocabs
      @vocabs.select(&:name).each(&block)
    else
      # This is needed since all vocabulary classes are defined using
      # Ruby's autoloading facility, meaning that `@@subclasses` will be
      # empty until each subclass has been touched or require'd.
      RDF::VOCABS.each { |v, p| RDF.const_get(p[:class_name].to_sym) unless v == :rdf }
      @@subclasses.select(&:name).each(&block)
    end
  else
    __properties__.each(&block)
  end
end

.each_statement {|| ... } ⇒ Object

Enumerate each statement constructed from the defined vocabulary terms

If a property value is known to be a URI, or expands to a URI, the object is a URI, otherwise, it will be a Literal.

Yields:

  • statement

Yield Parameters:



504
505
506
507
508
509
510
511
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 504

def each_statement(&block)
  props.each do |name, subject|
    subject.each_statement(&block)
  end

  # Also include the ontology, if it's not also a property
  @ontology.each_statement(&block) if @ontology && @ontology != self
end

.enum_for(method = :each_statement, *args) ⇒ RDF::Enumerable::Enumerator Also known as: to_enum

Return an enumerator over Statement defined for this vocabulary.

Returns:

See Also:

  • Object#enum_for


488
489
490
491
492
493
494
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 488

def enum_for(method = :each_statement, *args)
  # Ensure that enumerators are, themselves, queryable
  this = self
  Enumerable::Enumerator.new do |yielder|
    this.send(method, *args) {|*y| yielder << (y.length > 1 ? y : y.first)}
  end
end

.expand_pname(pname) ⇒ Term

Attempt to expand a Compact IRI/PName/QName using loaded vocabularies

Parameters:

Returns:

Raises:

  • (KeyError)

    if pname suffix not found in identified vocabulary

  • (ArgumentError)

    if resulting URI is not valid



388
389
390
391
392
393
394
395
396
397
398
399
400
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 388

def expand_pname(pname)
  return pname unless pname.is_a?(String) || pname.is_a?(Symbol)
  prefix, suffix = pname.to_s.split(":", 2)
  if prefix == "rdf"
    RDF[suffix]
  elsif vocab_detail = RDF::Vocabulary.vocab_map[prefix.to_sym]
    vocab = vocab_detail[:class] ||
      RDF::Vocabulary.from_sym(vocab_detail[:class_name])
    suffix.to_s.empty? ? vocab.to_uri : vocab[suffix]
  else
    (RDF::Vocabulary.find_term(pname) rescue nil) || RDF::URI(pname, validate: true)
  end
end

.find(uri) ⇒ Vocabulary

Return the Vocabulary associated with a URI. Allows the trailing '/' or '#' to be excluded

Parameters:

Returns:



407
408
409
410
411
412
413
414
415
416
417
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 407

def find(uri)
  uri = RDF::URI(uri) if uri.is_a?(String)
  return nil unless uri.uri? && uri.valid?
  RDF::Vocabulary.detect do |v|
    if uri.length >= v.to_uri.length
      uri.start_with?(v.to_uri)
    else
      v.to_uri.to_s.sub(%r([/#]$), '') == uri.to_s
    end
  end
end

.find_term(uri) ⇒ Vocabulary::Term

Return the Vocabulary term associated with a URI

Parameters:

Returns:



424
425
426
427
428
429
430
431
432
433
434
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 424

def find_term(uri)
  uri = RDF::URI(uri)
  return uri if uri.is_a?(Vocabulary::Term)
  if vocab = find(uri)
    if vocab.ontology == uri
      vocab.ontology
    else
      vocab[uri.to_s[vocab.to_uri.to_s.length..-1].to_s]
    end
  end
end

.from_graph(graph, url: nil, class_name: nil, extra: nil) ⇒ RDF::Vocabulary

Create a vocabulary from a graph or enumerable

Parameters:

  • graph (RDF::Enumerable)
  • url (URI, #to_s) (defaults to: nil)
  • class_name (RDF::Vocabulary, String) (defaults to: nil)

    The class_name associated with the vocabulary, used for creating the class name of the vocabulary. This will create a new class named with a top-level constant based on class_name. If given an existing vocabulary, it replaces the existing definitions for that vocabulary with those from the graph.

  • extra (Array<Symbol>, Hash{Symbol => Hash}) (defaults to: nil)

    Extra terms to add to the vocabulary. In the first form, it is an array of symbols, for which terms are created. In the second, it is a Hash mapping symbols to property attributes, as described in property.

Returns:



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 531

def from_graph(graph, url: nil, class_name: nil, extra: nil)
  vocab = case class_name
  when RDF::Vocabulary
    class_name.instance_variable_set(:@ontology, nil)
    class_name.instance_variable_set(:@properties, nil)
    class_name
  when String
    Object.const_set(class_name, Class.new(self.create(url)))
  else
    Class.new(self.create(url))
  end

  ont_url = url.to_s.sub(%r([/#]$), '')
  term_defs = {}
  embedded_defs = {}
  graph.each do |statement|
    #next unless statement.subject.uri?
    if statement.subject.start_with?(url) || statement.subject == ont_url
      name = statement.subject.to_s[url.to_s.length..-1].to_s
      term = (term_defs[name.to_sym] ||= {})
    else
      # subject is not a URI or is not associated with the vocabulary
      term = (embedded_defs[statement.subject] ||= {})
    end

    key = Term::URI_ATTRs.fetch(statement.predicate) do
      statement.predicate.to_s.to_sym
    end

    # Skip literals other than plain or english
    # This is because the ruby representation does not preserve language
    next if statement.object.literal? && (statement.object.language || :en).to_s !~ /^en-?/

    (term[key] ||= []) << statement.object
  end

  # Create extra terms
  term_defs = case extra
  when Array
    extra.inject({}) {|memo, s| memo[s.to_sym] = {}; memo}.merge(term_defs)
  when Hash
    extra.merge(term_defs)
  else
    term_defs
  end

  # Pass over embedded_defs with anonymous references, once
  embedded_defs.each do |term, attributes|
    attributes.each do |ak, avs|
      # Turn embedded BNodes into either their Term definition or a List
      avs = [avs] unless avs.is_a?(Array)
      attributes[ak] = avs.map do |av|
        l = RDF::List.new(subject: av, graph: graph)
        if l.valid?
          RDF::List.new(subject: av) do |nl|
            l.each do |lv|
              nl << (embedded_defs[lv] ? Term.new(vocab: vocab, attributes: embedded_defs[lv]) : lv)
            end
          end
        elsif av.is_a?(RDF::Node)
          Term.new(vocab: vocab, attributes: embedded_defs[av]) if embedded_defs[av]
        else
          av
        end
      end.compact
    end
  end

  term_defs.each do |term, attributes|
    # Turn embedded BNodes into either their Term definition or a List
    attributes.each do |ak, avs|
      attributes[ak] = avs.is_a?(Array) ? (avs.map do |av|
        l = RDF::List.new(subject: av, graph: graph)
        if l.valid?
          RDF::List.new(subject: av) do |nl|
            l.each do |lv|
              nl << (embedded_defs[lv] ? Term.new(vocab: vocab, attributes: embedded_defs[lv]) : lv)
            end
          end
        elsif av.is_a?(RDF::Node)
          Term.new(vocab: vocab, attributes: embedded_defs[av]) if embedded_defs[av]
        else
          av
        end
      end).compact : avs
    end

    if term == :""
      vocab.__ontology__ vocab, attributes
    else
      vocab.__property__ term, attributes
    end
  end

  vocab
end

.from_sym(sym) ⇒ RDF::Vocabulary

Return the vocabulary based on it's class_name symbol

Parameters:

Returns:



104
105
106
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 104

def from_sym(sym)
  RDF.const_get(sym.to_sym)
end

.imported_fromArray<RDF::Vocabulary>

List of vocabularies which import this vocabulary

Returns:



467
468
469
470
471
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 467

def imported_from
  @imported_from ||= begin
    RDF::Vocabulary.select {|v| v.__imports__.include?(self)}
  end
end

.importsArray<RDF::Vocabulary> Also known as: __imports__

Note:

the alias <strong>imports</strong> guards against RDF::OWL.imports returning a term, rather than an array of vocabularies

List of vocabularies this vocabulary owl:imports

Returns:



454
455
456
457
458
459
460
461
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 454

def imports
  return [] unless self.ontology
  @imports ||= begin
    Array(self.ontology.properties[:"http://www.w3.org/2002/07/owl#imports"]).compact
  rescue KeyError
    []
  end
end

.inspectString

Returns a developer-friendly representation of this vocabulary class.

Returns:



632
633
634
635
636
637
638
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 632

def inspect
  if self == Vocabulary
    self.to_s
  else
    sprintf("%s(%s)", superclass.to_s, to_s)
  end
end

.limit_vocabs(*vocabs) ⇒ Array<RDF::Vocabulary>

Limits iteration over vocabularies to just those selected

Examples:

limit to set of vocabularies by symbol

RDF::Vocabulary.limit_vocabs(:rdf, :rdfs, :schema)
RDF::Vocabulary.find_term('http://schema.org/CreativeWork').pname
# => 'schema:CreativeWork'

limit to set of vocabularies by class name

RDF::Vocabulary.limit_vocabs(RDF::RDFV, RDF::RDFS, RDF::Vocab::SCHEMA)
RDF::Vocabulary.find_term('http://schema.org/CreativeWork').pname
# => 'schema:CreativeWork'

Parameters:

  • vocabs (Array<symbol, RDF::Vocabulary>)

    A list of vocabularies (symbols or classes) which may be returned by each. Also limits vocabularies that will be inspeced for other methods. Set to nil, or an empty array to reset.

Returns:



157
158
159
160
161
162
163
164
165
166
167
168
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 157

def limit_vocabs(*vocabs)
  @vocabs = if Array(vocabs).empty?
    nil
  else
    vocabs.map do |vocab|
      vocab = :rdfv if vocab == :rdf
      vocab.is_a?(Symbol) && RDF::VOCABS.key?(vocab) ?
        RDF.const_get(RDF::VOCABS[vocab][:class_name].to_sym) :
        vocab
    end.compact
  end
end

.list(*values) ⇒ RDF::List (protected)

Create a list of terms

Parameters:

  • values (Array<String>)

    Each value treated as a URI or PName

Returns:



677
678
679
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 677

def list(*values)
  RDF::List[*values.map {|v| expand_pname(v) rescue RDF::Literal(v)}]
end

.method_missing(property, *args, &block) ⇒ Object (protected)



664
665
666
667
668
669
670
671
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 664

def method_missing(property, *args, &block)
  property = RDF::Vocabulary.camelize(property.to_s)
  if args.empty? && !to_s.empty?
    Term.intern([to_s, property.to_s].join(''), vocab: self, attributes: {})
  else
    super
  end
end

.ontologyRDF::Vocabulary::Term .ontology(name, options) ⇒ RDF::Vocabulary::Term Also known as: __ontology__

Note:

If the ontology URI has the vocabulary namespace URI as a prefix, it may also be defined using #property or #term

Overloads:



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 356

def ontology(*args)
  case args.length
  when 0
    @ontology
  else
    uri, options = args
    URI.cache.delete(uri.to_s.to_sym)  # Clear any previous entry
    # Term attributes passed in a block for lazy evaluation. This helps to avoid load-time circular dependencies
    @ontology = Term.intern(uri.to_s, vocab: self, attributes: options || {})

    # If the URI is the same as the vocabulary namespace, also define it as a term
    props[:""] ||= @ontology if self.to_s == uri.to_s

    @ontology
  end
end

.propertiesObject Also known as: __properties__

@return [ArrayRDF::URI] a list of properties in the current vocabulary



376
377
378
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 376

def properties
  props.values
end

.propertyRDF::Vocabulary::Term .property(name, options) ⇒ RDF::Vocabulary::Term Also known as: term, __property__

Overloads:



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 279

def property(*args)
  case args.length
  when 0
    Term.intern("#{self}property", vocab: self, attributes: {})
  else
    name = args.shift unless args.first.is_a?(Hash)
    options = args.last
    if name
      uri_str = [to_s, name.to_s].join('')
      URI.cache.delete(uri_str.to_sym)  # Clear any previous entry

      # Transform attribute keys that are PNames with a warning
      # FIXME: add back later
      #if !@is_deprecated && options.is_a?(Hash) &&
      #   options.keys.map(&:to_s).any? {|k| k.include?(':') && !k.match?(/^https?:/)}
      #
      #  @is_deprecated = true
      #  warn "[DEPRECATION] Vocabulary #{to_uri} includes pname attribute keys, regenerate"
      #end

      # Term attributes passed in a block for lazy evaluation. This helps to avoid load-time circular dependencies
      prop = Term.intern(uri_str, vocab: self, attributes: options || {})
      props[name.to_sym] = prop

      # If name is empty, also treat it as the ontology
      @ontology ||= prop if name.to_s.empty?

      # Define an accessor, except for problematic properties
      (class << self; self; end).send(:define_method, name) { prop } unless %w(property term hash).include?(name.to_s)
    else
      # Define the term without a name
      # Term attributes passed in a block for lazy evaluation. This helps to avoid load-time circular dependencies
      prop = Term.new(vocab: self, attributes: options)
    end
    prop
  end
end

.register(prefix, vocab, **params) ⇒ Hash

Register a vocabulary for internal prefix lookups. Parameters of interest include :uri, :class_name, :source, and :skip.

Parameters:

  • prefix (Symbol)

    the prefix to use

  • vocab (String, Class)

    either the URI or the vocab class

  • params (Hash{Symbol => String})

    Relevant parameters

Returns:

  • (Hash)

    The parameter hash, but frozen

Raises:

  • (ArgumentError)


116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 116

def register(prefix, vocab, **params)
  # check the input
  raise ArgumentError, "#{prefix} must be symbol-able" unless
    [String, Symbol].any? { |c| prefix.is_a? c }

  # note an explicit uri: param overrides
  case vocab
  when String then params[:uri] ||= vocab
  when Class
    raise ArgumentError, 'vocab must be an RDF::(Strict)Vocabulary' unless
      vocab.ancestors.include? RDF::Vocabulary
    params[:class] = vocab
    params[:uri] ||= vocab.to_uri.to_s
  end

  # fill in the class name
  params[:class_name] ||= prefix.to_s.upcase

  # now freeze and assign
  vocab_map[prefix.to_s.to_sym] = params.freeze
end

.strict?Boolean

Is this a strict vocabulary, or a liberal vocabulary allowing arbitrary properties?

Returns:

  • (Boolean)


172
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 172

def strict?; false; end

.to_html(graph: nil, prefixes: nil, jsonld: nil, template: nil) ⇒ String

Generate HTML+RDFa representation, specific to vocabularies. This uses generated JSON-LD and a Haml template.

Parameters:

  • graph (RDF::Queryable) (defaults to: nil)

    Optional graph, otherwise uses statements from vocabulary.

  • prefixes (Hash{#to_sym => String}) (defaults to: nil)

    to add to output

  • jsonld (String, Hash) (defaults to: nil)

    If not provided, the to_jsonld method is used to generate it.

  • template (String) (defaults to: nil)

    The path to a Haml or ERB template used to generate the output using the JSON-LD serialization

Returns:



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-vocab-20ebe47bf63c/lib/rdf/vocab/extensions.rb', line 329

def to_html(graph: nil, prefixes: nil, jsonld: nil, template: nil)
  # Find namespaces used in the vocabulary
  graph = RDF::Graph.new {|g| each_statement {|s| g << s}} if graph.nil? || graph.empty?

  # Get JSON as an object
  json = case jsonld
  when String then ::JSON.parse(File.read jsonld)
  when Hash   then jsonld
  else
    ::JSON.parse(to_jsonld(graph: graph, prefixes: prefixes))
  end
  raise "Expected JSON-LD data within the '@graph' key" unless json.has_key?('@graph')

  template ||= File.expand_path("../../../../etc/template.erb", __FILE__)

  prefixes = vocab_prefixes(graph).merge(prefixes || {})
  prefixes[:owl] = RDF::OWL.to_uri.to_s

  # Make sure ontology is typed
  json['@graph']['@type'] ||= ['owl:Ontology']

  jld_context = ::JSON::LD::Context.new.parse([json['@context'], json['@graph']['@context']])

  # Expand the JSON-LD to normalize accesses
  expanded = ::JSON::LD::API.expand(json).first
  expanded.delete('@reverse')

  # Re-compact keys
  expanded = expanded.inject({}) do |memo, (k, v)|
    term = RDF::Vocabulary.find_term(k)
    k = term.pname if term
    memo.merge(k => v)
  end

  # Normalize label accessors
  expanded['rdfs:label'] ||= %w(dc:title dc11:title skos:prefLabel).inject(nil) do |memo, key|
    memo || expanded[key]
  end || [{'@value' => json['@graph']['@id']}]
  %w(rdfs_classes rdfs_properties rdfs_datatypes rdfs_instances).each do |section|
    next unless json['@graph'][section]
    json['@graph'][section].each do |node|
      node['rdfs:label'] ||= %w(dc:title dc11:title skos:prefLabel).inject do |memo, key|
        memo || node[key]
      end || [{'@value' => node['@id']}]
    end
  end

  # Expand each part separately, as well.
  %w(rdfs_classes rdfs_properties rdfs_datatypes rdfs_instances).each do |section|
    next unless json['@graph'][section]
    expanded_section = ::JSON::LD::API.expand(json['@graph'][section], expandContext: jld_context)
    # Re-compact keys
    expanded[section] = expanded_section.map do |node|
      node.inject({}) do |memo, (k, v)|
        term = RDF::Vocabulary.find_term(k)
        k = term.pname if term
        memo.merge(k => v)
      end
    end
  end

  # Template invoked with expanded JSON-LD with outer object including `rdfs_classes`, `rdfs_properties`, and `rdf_instances` sections.
  case template
  when /.haml$/
    require 'haml'
    haml = Haml::Engine.new(File.read(template))
    haml.render(self, ont: expanded, context: json['@context'], prefixes: prefixes)
  when /.erb$/
    require 'erubis'
    eruby = Erubis::FastEruby.new(File.read(template))
    eruby.evaluate(binding: self, ont: expanded, context: json['@context'], prefixes: prefixes)
  else
    raise "Unknown template type #{template}. Should have '.erb' or '.haml' extension"
  end
end

.to_iriRDF::URI

Returns the base URI for this vocabulary class. For IRI compatibility

Returns:



482
483
484
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 482

def to_uri
  RDF::URI.intern(@@uris[self].to_s)
end

.to_jsonld(graph: nil, prefixes: nil) ⇒ String

Generate JSON-LD representation, specific to vocabularies

Parameters:

  • :graph (RDF::Queryable)

    Optional graph, otherwise uses statements from vocabulary.

  • Prefixes (Hash{#to_sym => String})

    to add to output

Returns:



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-vocab-20ebe47bf63c/lib/rdf/vocab/extensions.rb', line 176

def to_jsonld(graph: nil, prefixes: nil)
  require 'json/ld'

  context = {}
  rdfs_context = ::JSON.parse %({
    "dc:title": {"@container": "@language"},
    "dc:description": {"@container": "@language"},
    "dc:date": {"@type": "xsd:date"},
    "rdfs:comment": {"@container": "@language"},
    "rdfs:domain": {"@type": "@vocab"},
    "rdfs:label": {"@container": "@language"},
    "rdfs:range": {"@type": "@vocab"},
    "rdfs:seeAlso": {"@type": "@id"},
    "rdfs:subClassOf": {"@type": "@vocab"},
    "rdfs:subPropertyOf": {"@type": "@vocab"},
    "schema:domainIncludes": {"@type": "@vocab"},
    "schema:rangeIncludes": {"@type": "@vocab"},
    "owl:equivalentClass": {"@type": "@vocab"},
    "owl:equivalentProperty": {"@type": "@vocab"},
    "owl:oneOf": {"@container": "@list", "@type": "@vocab"},
    "owl:imports": {"@type": "@id"},
    "owl:versionInfo": {"@type": "@id"},
    "owl:inverseOf": {"@type": "@vocab"},
    "owl:unionOf": {"@type": "@vocab", "@container": "@list"},
    "rdfs_classes": {"@reverse": "rdfs:isDefinedBy", "@type": "@id"},
    "rdfs_properties": {"@reverse": "rdfs:isDefinedBy", "@type": "@id"},
    "rdfs_datatypes": {"@reverse": "rdfs:isDefinedBy", "@type": "@id"},
    "rdfs_instances": {"@reverse": "rdfs:isDefinedBy", "@type": "@id"}
  })
  rdfs_classes, rdfs_properties, rdfs_datatypes, rdfs_instances = [], [], [], [], []

  ontology = {
    "@context" => rdfs_context,
    "@id" => to_uri.to_s
  }

  # Find namespaces used in the vocabulary
  graph = RDF::Graph.new {|g| each_statement {|s| g << s}} if graph.nil? || graph.empty?

  prefixes = vocab_prefixes(graph).merge(prefixes || {})
  prefixes.each do |pfx, uri|
    context[pfx.to_s] = uri.to_s unless pfx.to_s.empty?
  end

  # Determine the category for each subject in the vocabulary graph
  cats = subject_categories(graph)

  # Generate term definitions from graph subjects
  cats.values.flatten.each do |term|
    next unless Array(term.qname).length == 2
    context[term.qname.last.to_s] = term.to_uri.to_s
  end

  # Parse the two contexts so we know what terms are in scope
  jld_context = ::JSON::LD::Context.new.parse([context, rdfs_context])

  {
    ont: {
      heading:  "# #{__name__.split('::').last} Vocabulary definition\n",
      bucket:   ontology,
    },
    classes: {
      heading:  "# Class definitions\n",
      bucket:   rdfs_classes,
      rev_prop: "rdfs_classes"
    },
    properties: {
      heading:  "# Property definitions\n",
      bucket:   rdfs_properties,
      rev_prop: "rdfs_properties"
    },
    datatypes: {
      heading:  "# Datatype definitions\n",
      bucket:   rdfs_datatypes,
      rev_prop: "rdfs_datatypes"
    },
    other: {
      heading:  "# Other definitions\n",
      bucket:   rdfs_instances,
      rev_prop: "rdfs_instances"
    }
  }.each do |key, hash|
    next unless cats[key]

    cats[key].each do |subject|
      node = {"@id" => subject.pname}
      po = {}

      # Group predicates with their values
      graph.query({subject: subject}) do |statement|
        # Sanity check this, as these are set to an empty string if not defined.
        next if [RDF::RDFS.label, RDF::RDFS.comment].include?(statement.predicate) && statement.object.to_s.empty?
        po[statement.predicate] ||= []
        po[statement.predicate] << statement.object
      end

      next if po.empty?

      node['@type'] = po.delete(RDF.type).map {|t| jld_context.compact_iri(t, vocab: true)}

      po.each do |predicate, objects|
        term = jld_context.compact_iri(predicate, vocab: true)
        node[term] = if jld_context.container(term) == '@language'
          lang_map = objects.inject({}) do |memo, o|
            raise "Language-mapped term #{term} with non plain-literal #{o.inspect}" unless o.literal? && o.plain?
            memo.merge(o.language.to_s => o.value)
          end
          # Don't use language map if there's only one entry with no language
          lang_map = lang_map[""] if lang_map.keys == [""]
          [lang_map]
        else
          objects.map do |o|
            expanded_value = jld_context.expand_value(term, o)
            jld_context.compact_value(term, expanded_value)
          end
        end
      end

      node.each do |property, values|
        case values.length
        when 0 then node.delete(property)
        when 1 then node[property] = values.first
        end
      end

      # Either set bucket from node, or append node to bucket
      if hash[:bucket].is_a?(Hash)
        hash[:bucket].merge!(node)
      else
        ontology[hash[:rev_prop]] ||= hash[:bucket]
        hash[:bucket] << node
      end
    end
  end

  # Serialize result
  {
    "@context" => context,
    "@graph" => ontology
  }.to_json(::JSON::LD::JSON_STATE)
rescue LoadError
  # No JSON-LD serialization unless gem loaded
end

.to_sString

Returns a string representation of this vocabulary class.

Returns:



517
518
519
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 517

def to_s
  @@uris.key?(self) ? @@uris[self].to_s : super
end

.to_ttl(graph: nil, prefixes: nil) ⇒ String

Generate Turtle representation, specific to vocabularies

Parameters:

  • :graph (RDF::Queryable)

    Optional graph, otherwise uses statements from vocabulary.

  • Prefixes (Hash{#to_sym => String})

    to add to output

Returns:



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-vocab-20ebe47bf63c/lib/rdf/vocab/extensions.rb', line 96

def to_ttl(graph: nil, prefixes: nil)
  require 'rdf/turtle'
  output = []

  # Find namespaces used in the vocabulary
  graph = RDF::Graph.new {|g| each_statement {|s| g << s}} if graph.nil? || graph.empty?

  prefixes = vocab_prefixes(graph).merge(prefixes || {})
  pfx_width = prefixes.keys.map(&:to_s).map(&:length).max
  prefixes.each do |pfx, uri|
    output << "@prefix %*s: <%s> .\n" % [pfx_width, pfx, uri]
  end

  # Determine the category for each subject in the vocabulary graph
  cats = subject_categories(graph)

  writer = RDF::Turtle::Writer.new(StringIO.new, prefixes: prefixes)

  {
    ont: {
      heading:  "# #{__name__.split('::').last} Vocabulary definition\n"
    },
    classes: {
      heading:  "# Class definitions\n"
    },
    properties: {
      heading:  "# Property definitions\n"
    },
    datatypes: {
      heading:  "# Datatype definitions\n"
    },
    other: {
      heading:  "# Other definitions\n"
    }
  }.each do |key, hash|
    next unless cats[key]

    output << "\n\n#{hash[:heading]}"

    cats[key].each do |subject|
      po = {}

      # Group predicates with their values
      graph.query({subject: subject}) do |statement|
        # Sanity check this, as these are set to an empty string if not defined.
        next if [RDF::RDFS.label, RDF::RDFS.comment].include?(statement.predicate) && statement.object.to_s.empty?
        po[statement.predicate] ||= []
        po[statement.predicate] << statement.object
      end

      next if po.empty?

      po_list = []
      unless (types = po.delete(RDF.type)).empty?
        po_list << 'a ' + types.map {|o| writer.format_term(o)}.join(", ")
      end

      # Serialize other predicate/objects
      po.each do |predicate, objects|
        resource = predicate.qname ? predicate.pname : "<#{predicate}>"
        po_list << resource + ' ' + objects.map {|o| writer.format_term(o)}.join(", ")
      end

      # Output statements for this subject
      subj = subject.qname ? subject.pname : "<#{subject}>"
      output << "#{subj} " + po_list.join(";\n  ") + "\n  .\n"
    end
  end

  output.join("")
rescue LoadError
  # No Turtle serialization unless gem loaded
end

.to_uriRDF::URI

Returns the base URI for this vocabulary class.

Returns:



477
478
479
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 477

def to_uri
  RDF::URI.intern(@@uris[self].to_s)
end

.value_to_html(property, value, tag) ⇒ Object

Create HTML for values (Helper method, needs to be public)



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-vocab-20ebe47bf63c/lib/rdf/vocab/extensions.rb', line 407

def value_to_html(property, value, tag)
  value.map do |v|
    %(<#{tag} property="#{property}") +
    if v['@value']
      (v['@language'] ? %( lang="#{v['@language']}") : "") +
      (v['@type'] ? %( datatype="#{RDF::URI(v['@type']).pname}") : "") +
      %(>#{v['@value']})
    elsif v['@id']
      %( resource="#{RDF::URI(v['@id']).pname}">#{RDF::URI(v['@id']).pname})
    else
      raise "Unknown value type: #{v.inspect}, #{property}"
    end +
    %(</#{tag}>)
  end.join("\n")
end

.vocab_mapHash{Symbol => Hash{Symbol => String}}

A hash of all vocabularies by prefix showing relevant URI and associated vocabulary Class Name

alias_method :_orig_vocab_map, :vocab_map

Returns:



92
93
94
95
96
97
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 92

def vocab_map
  # Create an initial duplicate of RDF::VOCABS. We want to
  # ensure the hash itself is modifiable but the values are
  # frozen.
  @vocab_map ||= RDF::VOCABS.transform_values(&:freeze)
end

Instance Method Details

#[](property) ⇒ URI

Returns the URI for the term property in this vocabulary.

Parameters:

Returns:



706
707
708
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 706

def [](property)
  Term.intern([to_s, property.to_s].join(''), vocab: self, attributes: {})
end

#inspectString

Returns a developer-friendly representation of this vocabulary.

Returns:



733
734
735
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 733

def inspect
  sprintf("#<%s:%#0x(%s)>", self.class.name, __id__, to_s)
end

#to_sString

Returns a string representation of this vocabulary.

Returns:



725
726
727
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 725

def to_s
  @uri.to_s
end

#to_uriURI Also known as: to_iri

Returns the base URI for this vocabulary.

Returns:



714
715
716
# File 'vendor/bundler/ruby/3.0.0/bundler/gems/rdf-237066655558/lib/rdf/vocabulary.rb', line 714

def to_uri
  RDF::URI.intern(to_s)
end