Class: JSON::LD::Writer

Inherits:
RDF::Writer
  • Object
show all
Includes:
StreamingWriter, Utils, RDF::Util::Logger
Defined in:
lib/json/ld/writer.rb

Overview

A JSON-LD parser in Ruby.

Note that the natural interface is to write a whole graph at a time. Writing statements or Triples will create a graph to add them to and then serialize the graph.

The writer will add prefix definitions, and use them for creating @context definitions, and minting CURIEs

Select the :expand option to output JSON-LD in expanded form

Examples:

Obtaining a JSON-LD writer class

RDF::Writer.for(:jsonld)         #=> JSON::LD::Writer
RDF::Writer.for("etc/test.json")
RDF::Writer.for(:file_name      => "etc/test.json")
RDF::Writer.for(file_extension: "json")
RDF::Writer.for(:content_type   => "application/turtle")

Serializing RDF graph into an JSON-LD file

JSON::LD::Writer.open("etc/test.json") do |writer|
  writer << graph
end

Serializing RDF statements into an JSON-LD file

JSON::LD::Writer.open("etc/test.json") do |writer|
  graph.each_statement do |statement|
    writer << statement
  end
end

Serializing RDF statements into an JSON-LD string

JSON::LD::Writer.buffer do |writer|
  graph.each_statement do |statement|
    writer << statement
  end
end

Creating @@context prefix definitions in output

JSON::LD::Writer.buffer(
  prefixes: {
    nil => "http://example.com/ns#",
    foaf: "http://xmlns.com/foaf/0.1/"}
) do |writer|
  graph.each_statement do |statement|
    writer << statement
  end
end

See Also:

Author:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Utils

#add_value, #as_resource, #blank_node?, #compare_values, #has_property, #has_value, #index?, #list?, #node?, #node_reference?, #value?

Methods included from StreamingWriter

#stream_epilogue, #stream_prologue, #stream_statement

Constructor Details

#initialize(output = $stdout, options = {}) {|writer| ... } ⇒ Writer

Initializes the RDF-LD writer instance.

Parameters:

  • output (IO, File) (defaults to: $stdout) —

    the output stream

  • options (Hash{Symbol => Object}) (defaults to: {}) —

    any additional options

Options Hash (options):

  • :encoding (Encoding) — default: Encoding::UTF_8 —

    the encoding to use on the output stream (Ruby 1.9+)

  • :canonicalize (Boolean) — default: false —

    whether to canonicalize literals when serializing

  • :prefixes (Hash) — default: {} —

    the prefix mappings to use (not supported by all writers)

  • :standard_prefixes (Boolean) — default: false —

    Add standard prefixes to @prefixes, if necessary.

  • :context (IO, Array, Hash, String, Context) — default: {} —

    context to use when serializing. Constructed context for native serialization.

  • :frame (IO, Array, Hash, String, Context) — default: {} —

    frame to use when serializing.

  • :unique_bnodes (Boolean) — default: false —

    Use unique bnode identifiers, defaults to using the identifier which the node was originall initialized with (if any).

  • :stream (Boolean) — default: false —

    Do not attempt to optimize graph presentation, suitable for streaming large graphs.

Yields:

  • (writer) —

    ‘self`

  • (writer)

Yield Parameters:

  • writer (RDF::Writer)
  • writer (RDF::Writer)

Yield Returns:

  • (void) 


129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/json/ld/writer.rb', line 129

def initialize(output = $stdout, options = {}, &block)
  options[:base_uri] ||= options[:base] if options.has_key?(:base)
  options[:base] ||= options[:base_uri] if options.has_key?(:base_uri)
  super do
    @repo = RDF::Repository.new

    if block_given?
      case block.arity
        when 0 then instance_eval(&block)
        else block.call(self)
      end
    end
  end
end

Instance Attribute Details

#context ⇒ Context (readonly)

Returns context used to load and administer contexts.

Returns:

  • (Context) —

    context used to load and administer contexts



66
67
68
 
# File 'lib/json/ld/writer.rb', line 66

def context
  @context
end

#graph ⇒ RDF::Graph (readonly)

Returns Graph of statements serialized.

Returns:

  • (RDF::Graph) —

    Graph of statements serialized



62
63
64
 
# File 'lib/json/ld/writer.rb', line 62

def graph
  @graph
end

Class Method Details

.options ⇒ Object

JSON-LD Writer options

See Also:



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/json/ld/writer.rb', line 71

def self.options
  super + [
    RDF::CLI::Option.new(
      symbol: :compactArrays,
      datatype: TrueClass,
      on: ["--compact-arrays"],
      description: "Replaces arrays with just one element with that element during compaction.") {true},
    RDF::CLI::Option.new(
      symbol: :context,
      datatype: RDF::URI,
      on: ["--context CONTEXT"],
      description: "Context to use when serializing. Constructed context for native serialization.") {|arg| RDF::URI(arg)},
    RDF::CLI::Option.new(
      symbol: :frame,
      datatype: RDF::URI,
      on: ["--frame FRAME"],
      description: "Frame to use when serializing.") {|arg| RDF::URI(arg)},
    RDF::CLI::Option.new(
      symbol: :stream,
      datatype: TrueClass,
      on: ["--stream"],
      description: "Do not attempt to optimize graph presentation, suitable for streaming large graphs.") {true},
    RDF::CLI::Option.new(
      symbol: :useRdfType,
      datatype: TrueClass,
      on: ["--use-rdf-type"],
      description: "Treat `rdf:type` like a normal property instead of using `@type`.") {true},
  ]
end

Instance Method Details

#write_epilogue ⇒ void

This method returns an undefined value.

Outputs the Serialized JSON-LD representation of all stored statements.

If provided a context or prefixes, we’ll create a context and use it to compact the output. Otherwise, we return un-compacted JSON-LD

See Also:



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
 
# File 'lib/json/ld/writer.rb', line 187

def write_epilogue
  if @options[:stream]
    stream_epilogue
  else

    log_debug("writer") { "serialize #{@repo.count} statements, #{@options.inspect}"}
    result = API.fromRdf(@repo, @options)

    # If we were provided a context, or prefixes, use them to compact the output
    context = RDF::Util::File.open_file(@options[:context]) if @options[:context].is_a?(String)
    context ||= @options[:context]
    context ||= if @options[:prefixes] || @options[:language] || @options[:standard_prefixes]
      ctx = Context.new(@options)
      ctx.language = @options[:language] if @options[:language]
      @options[:prefixes].each do |prefix, iri|
        ctx.set_mapping(prefix, iri) if prefix && iri
      end if @options[:prefixes]
      ctx
    end

    # Rename BNodes to uniquify them, if necessary
    if options[:unique_bnodes]
      result = API.flatten(result, context, @options)
    end

    frame = RDF::Util::File.open_file(@options[:frame]) if @options[:frame].is_a?(String)
    if frame ||= @options[:frame]
      # Perform framing, if given a frame
      log_debug("writer") { "frame result"}
      result = API.frame(result, frame, @options)
    elsif context
      # Perform compaction, if we have a context
      log_debug("writer") { "compact result"}
      result = API.compact(result, context,  @options)
    end

    @output.write(result.to_json(JSON_STATE))
  end

  super
end

#write_prologue ⇒ void

This method returns an undefined value.

Necessary for streaming



174
175
176
177
 
# File 'lib/json/ld/writer.rb', line 174

def write_prologue
  stream_prologue if @options[:stream]
  super
end

#write_quad(subject, predicate, object, graph_name) ⇒ void

This method returns an undefined value.

Outputs the N-Quads representation of a statement.

Parameters:

  • subject (RDF::Resource)
  • predicate (RDF::URI)
  • object (RDF::Term) 


162
163
164
165
166
167
168
169
 
# File 'lib/json/ld/writer.rb', line 162

def write_quad(subject, predicate, object, graph_name)
  statement = RDF::Statement.new(subject, predicate, object, graph_name: graph_name)
  if @options[:stream]
    stream_statement(statement)
  else
    @repo.insert(statement)
  end
end

#write_triple(subject, predicate, object) ⇒ void

This method is abstract.

This method returns an undefined value.

Addes a triple to be serialized

Parameters:

  • subject (RDF::Resource)
  • predicate (RDF::URI)
  • object (RDF::Value) 


151
152
153
 
# File 'lib/json/ld/writer.rb', line 151

def write_triple(subject, predicate, object)
  write_quad(subject, predicate, object, nil)
end