-
Notifications
You must be signed in to change notification settings - Fork 27
/
format.rb
248 lines (243 loc) · 10.1 KB
/
format.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
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
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
169
170
171
172
173
174
175
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
# -*- encoding: utf-8 -*-
# frozen_string_literal: true
module JSON::LD
##
# JSON-LD format specification.
#
# @example Obtaining an JSON-LD format class
# RDF::Format.for(:jsonld) #=> JSON::LD::Format
# RDF::Format.for("etc/foaf.jsonld")
# RDF::Format.for(:file_name => "etc/foaf.jsonld")
# RDF::Format.for(file_extension: "jsonld")
# RDF::Format.for(:content_type => "application/ld+json")
#
# @example Obtaining serialization format MIME types
# RDF::Format.content_types #=> {"application/ld+json" => [JSON::LD::Format],
# "application/x-ld+json" => [JSON::LD::Format]}
#
# @example Obtaining serialization format file extension mappings
# RDF::Format.file_extensions #=> {:jsonld => [JSON::LD::Format] }
#
# @see https://www.w3.org/TR/json-ld11/
# @see https://w3c.github.io/json-ld-api/tests/
class Format < RDF::Format
content_type 'application/ld+json',
extension: :jsonld,
alias: 'application/x-ld+json'
content_encoding 'utf-8'
reader { JSON::LD::Reader }
writer { JSON::LD::Writer }
##
# Sample detection to see if it matches JSON-LD
#
# Use a text sample to detect the format of an input file. Sub-classes implement
# a matcher sufficient to detect probably format matches, including disambiguating
# between other similar formats.
#
# @param [String] sample Beginning several bytes (~ 1K) of input.
# @return [Boolean]
def self.detect(sample)
!!sample.match(/\{\s*"@(id|context|type)"/m) &&
# Exclude CSVW metadata
!sample.include?("http://www.w3.org/ns/csvw")
end
##
# Hash of CLI commands appropriate for this format
# @return [Hash{Symbol => Hash}]
def self.cli_commands
{
expand: {
description: "Expand JSON-LD or parsed RDF",
parse: false,
help: "expand [--context <context-file>] files ...",
filter: {output_format: :jsonld}, # Only shows output format set
lambda: ->(files, **options) do
out = options[:output] || $stdout
out.set_encoding(Encoding::UTF_8) if RUBY_PLATFORM == "java"
options = options.merge(expandContext: options.delete(:context)) if options.key?(:context)
options[:base] ||= options[:base_uri]
if options[:format] == :jsonld
if files.empty?
# If files are empty, either use options[:evaluate] or STDIN
input = options[:evaluate] ? StringIO.new(options[:evaluate]) : STDIN
input.set_encoding(options.fetch(:encoding, Encoding::UTF_8))
JSON::LD::API.expand(input, validate: false, **options) do |expanded|
out.puts expanded.to_json(JSON::LD::JSON_STATE)
end
else
files.each do |file|
JSON::LD::API.expand(file, validate: false, **options) do |expanded|
out.puts expanded.to_json(JSON::LD::JSON_STATE)
end
end
end
else
# Turn RDF into JSON-LD first
RDF::CLI.parse(files, **options) do |reader|
JSON::LD::API.fromRdf(reader) do |expanded|
out.puts expanded.to_json(JSON::LD::JSON_STATE)
end
end
end
end,
option_use: {context: :removed}
},
compact: {
description: "Compact JSON-LD or parsed RDF",
parse: false,
filter: {output_format: :jsonld}, # Only shows output format set
help: "compact --context <context-file> files ...",
lambda: ->(files, **options) do
raise ArgumentError, "Compacting requires a context" unless options[:context]
out = options[:output] || $stdout
out.set_encoding(Encoding::UTF_8) if RUBY_PLATFORM == "java"
options[:base] ||= options[:base_uri]
if options[:format] == :jsonld
if files.empty?
# If files are empty, either use options[:evaluate] or STDIN
input = options[:evaluate] ? StringIO.new(options[:evaluate]) : STDIN
input.set_encoding(options.fetch(:encoding, Encoding::UTF_8))
JSON::LD::API.compact(input, options[:context], **options) do |compacted|
out.puts compacted.to_json(JSON::LD::JSON_STATE)
end
else
files.each do |file|
JSON::LD::API.compact(file, options[:context], **options) do |compacted|
out.puts compacted.to_json(JSON::LD::JSON_STATE)
end
end
end
else
# Turn RDF into JSON-LD first
RDF::CLI.parse(files, **options) do |reader|
JSON::LD::API.fromRdf(reader) do |expanded|
JSON::LD::API.compact(expanded, options[:context], **options) do |compacted|
out.puts compacted.to_json(JSON::LD::JSON_STATE)
end
end
end
end
end,
options: [
RDF::CLI::Option.new(
symbol: :context,
datatype: RDF::URI,
control: :url2,
use: :required,
on: ["--context CONTEXT"],
description: "Context to use when compacting.") {|arg| RDF::URI(arg).absolute? ? RDF::URI(arg) : StringIO.new(File.read(arg))},
]
},
flatten: {
description: "Flatten JSON-LD or parsed RDF",
parse: false,
help: "flatten [--context <context-file>] files ...",
filter: {output_format: :jsonld}, # Only shows output format set
lambda: ->(files, **options) do
out = options[:output] || $stdout
out.set_encoding(Encoding::UTF_8) if RUBY_PLATFORM == "java"
options[:base] ||= options[:base_uri]
if options[:format] == :jsonld
if files.empty?
# If files are empty, either use options[:evaluate] or STDIN
input = options[:evaluate] ? StringIO.new(options[:evaluate]) : STDIN
input.set_encoding(options.fetch(:encoding, Encoding::UTF_8))
JSON::LD::API.flatten(input, options[:context], **options) do |flattened|
out.puts flattened.to_json(JSON::LD::JSON_STATE)
end
else
files.each do |file|
JSON::LD::API.flatten(file, options[:context], **options) do |flattened|
out.puts flattened.to_json(JSON::LD::JSON_STATE)
end
end
end
else
# Turn RDF into JSON-LD first
RDF::CLI.parse(files, **options) do |reader|
JSON::LD::API.fromRdf(reader) do |expanded|
JSON::LD::API.flatten(expanded, options[:context], **options) do |flattened|
out.puts flattened.to_json(JSON::LD::JSON_STATE)
end
end
end
end
end,
options: [
RDF::CLI::Option.new(
symbol: :context,
datatype: RDF::URI,
control: :url2,
use: :required,
on: ["--context CONTEXT"],
description: "Context to use when compacting.") {|arg| RDF::URI(arg)},
RDF::CLI::Option.new(
symbol: :createAnnotations,
datatype: TrueClass,
default: false,
control: :checkbox,
on: ["--[no-]create-annotations"],
description: "Unfold embedded nodes which can be represented using `@annotation`."),
]
},
frame: {
description: "Frame JSON-LD or parsed RDF",
parse: false,
help: "frame --frame <frame-file> files ...",
filter: {output_format: :jsonld}, # Only shows output format set
lambda: ->(files, **options) do
raise ArgumentError, "Framing requires a frame" unless options[:frame]
out = options[:output] || $stdout
out.set_encoding(Encoding::UTF_8) if RUBY_PLATFORM == "java"
options[:base] ||= options[:base_uri]
if options[:format] == :jsonld
if files.empty?
# If files are empty, either use options[:evaluate] or STDIN
input = options[:evaluate] ? StringIO.new(options[:evaluate]) : STDIN
input.set_encoding(options.fetch(:encoding, Encoding::UTF_8))
JSON::LD::API.frame(input, options[:frame], **options) do |framed|
out.puts framed.to_json(JSON::LD::JSON_STATE)
end
else
files.each do |file|
JSON::LD::API.frame(file, options[:frame], **options) do |framed|
out.puts framed.to_json(JSON::LD::JSON_STATE)
end
end
end
else
# Turn RDF into JSON-LD first
RDF::CLI.parse(files, **options) do |reader|
JSON::LD::API.fromRdf(reader) do |expanded|
JSON::LD::API.frame(expanded, options[:frame], **options) do |framed|
out.puts framed.to_json(JSON::LD::JSON_STATE)
end
end
end
end
end,
option_use: {context: :removed},
options: [
RDF::CLI::Option.new(
symbol: :frame,
datatype: RDF::URI,
control: :url2,
use: :required,
on: ["--frame FRAME"],
description: "Frame to use when serializing.") {|arg| RDF::URI(arg).absolute? ? RDF::URI(arg) : StringIO.new(File.read(arg))}
]
},
}
end
##
# Override normal symbol generation
def self.to_sym
:jsonld
end
##
# Override normal format name
def self.name
"JSON-LD"
end
end
end