ruby-structured-data 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +36 -0
- data/LICENSE.txt +21 -0
- data/README.md +252 -0
- data/data/schema_org_v30.json +20081 -0
- data/lib/generators/structured_data/install/install_generator.rb +17 -0
- data/lib/generators/structured_data/install/templates/structured_data.rb +15 -0
- data/lib/ruby-structured-data.rb +3 -0
- data/lib/ruby_structured_data.rb +4 -0
- data/lib/structured_data/compiler/parser.rb +120 -0
- data/lib/structured_data/compiler/terms.rb +24 -0
- data/lib/structured_data/compiler/uri_helper.rb +66 -0
- data/lib/structured_data/compiler/vocabulary.rb +115 -0
- data/lib/structured_data/compiler.rb +68 -0
- data/lib/structured_data/configuration.rb +19 -0
- data/lib/structured_data/document.rb +99 -0
- data/lib/structured_data/enum.rb +64 -0
- data/lib/structured_data/error.rb +19 -0
- data/lib/structured_data/list.rb +46 -0
- data/lib/structured_data/node.rb +133 -0
- data/lib/structured_data/rails/helper.rb +38 -0
- data/lib/structured_data/rails/railtie.rb +22 -0
- data/lib/structured_data/rails/registry.rb +124 -0
- data/lib/structured_data/rails/renderer.rb +20 -0
- data/lib/structured_data/rails.rb +6 -0
- data/lib/structured_data/reference.rb +46 -0
- data/lib/structured_data/serializer.rb +44 -0
- data/lib/structured_data/validator/context.rb +30 -0
- data/lib/structured_data/validator/diagnostic.rb +45 -0
- data/lib/structured_data/validator/node_validator.rb +131 -0
- data/lib/structured_data/validator/range_checker.rb +83 -0
- data/lib/structured_data/validator/result.rb +37 -0
- data/lib/structured_data/validator.rb +76 -0
- data/lib/structured_data/values.rb +148 -0
- data/lib/structured_data/version.rb +5 -0
- data/lib/structured_data/vocabulary/data_loader.rb +25 -0
- data/lib/structured_data/vocabulary/hierarchy.rb +32 -0
- data/lib/structured_data/vocabulary/registry.rb +90 -0
- data/lib/structured_data/vocabulary.rb +136 -0
- data/lib/structured_data.rb +84 -0
- metadata +252 -0
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require_relative "structured_data/version"
|
|
4
|
+
require_relative "structured_data/error"
|
|
5
|
+
require_relative "structured_data/configuration"
|
|
6
|
+
require_relative "structured_data/compiler"
|
|
7
|
+
require_relative "structured_data/reference"
|
|
8
|
+
require_relative "structured_data/list"
|
|
9
|
+
require_relative "structured_data/enum"
|
|
10
|
+
require_relative "structured_data/values"
|
|
11
|
+
require_relative "structured_data/node"
|
|
12
|
+
require_relative "structured_data/vocabulary"
|
|
13
|
+
require_relative "structured_data/document"
|
|
14
|
+
require_relative "structured_data/validator"
|
|
15
|
+
require_relative "structured_data/serializer"
|
|
16
|
+
|
|
17
|
+
# Rails integration is optional: StructuredData::Rails::Railtie subclasses
|
|
18
|
+
# ::Rails::Railtie, so requiring it without Rails raises NameError.
|
|
19
|
+
begin
|
|
20
|
+
require_relative "structured_data/rails"
|
|
21
|
+
rescue LoadError, NameError
|
|
22
|
+
nil
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
module StructuredData
|
|
26
|
+
class << self
|
|
27
|
+
def config
|
|
28
|
+
@config ||= Configuration.new
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
def configure
|
|
32
|
+
yield(config) if block_given?
|
|
33
|
+
config
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
def reset_config!
|
|
37
|
+
@config = Configuration.new
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
def node(type, id: nil, **attributes, &)
|
|
41
|
+
Node.new(type, id: id, **attributes, &)
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
def document(*nodes, **)
|
|
45
|
+
Document.new(*nodes, **)
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
def ref(id)
|
|
49
|
+
Reference.new(id)
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
def list(*items)
|
|
53
|
+
Values.list(*items)
|
|
54
|
+
end
|
|
55
|
+
|
|
56
|
+
def enum(name, type = nil)
|
|
57
|
+
Values.enum(name, type)
|
|
58
|
+
end
|
|
59
|
+
|
|
60
|
+
def url(val)
|
|
61
|
+
Values.url(val)
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
def text(val)
|
|
65
|
+
Values.text(val)
|
|
66
|
+
end
|
|
67
|
+
|
|
68
|
+
def validate(target, mode: config.validation_mode)
|
|
69
|
+
Validator.validate(target, mode: mode)
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
def validate!(target, mode: config.validation_mode)
|
|
73
|
+
Validator.validate!(target, mode: mode)
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
def dump(target, pretty: config.pretty)
|
|
77
|
+
Serializer.dump(target, pretty: pretty)
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
def vocabulary
|
|
81
|
+
Vocabulary.default
|
|
82
|
+
end
|
|
83
|
+
end
|
|
84
|
+
end
|
metadata
ADDED
|
@@ -0,0 +1,252 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: ruby-structured-data
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.1.1
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- Mauricio Zaffari
|
|
8
|
+
bindir: exe
|
|
9
|
+
cert_chain: []
|
|
10
|
+
date: 1980-01-02 00:00:00.000000000 Z
|
|
11
|
+
dependencies:
|
|
12
|
+
- !ruby/object:Gem::Dependency
|
|
13
|
+
name: actionpack
|
|
14
|
+
requirement: !ruby/object:Gem::Requirement
|
|
15
|
+
requirements:
|
|
16
|
+
- - ">="
|
|
17
|
+
- !ruby/object:Gem::Version
|
|
18
|
+
version: '7.0'
|
|
19
|
+
type: :development
|
|
20
|
+
prerelease: false
|
|
21
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
22
|
+
requirements:
|
|
23
|
+
- - ">="
|
|
24
|
+
- !ruby/object:Gem::Version
|
|
25
|
+
version: '7.0'
|
|
26
|
+
- !ruby/object:Gem::Dependency
|
|
27
|
+
name: bundler-audit
|
|
28
|
+
requirement: !ruby/object:Gem::Requirement
|
|
29
|
+
requirements:
|
|
30
|
+
- - "~>"
|
|
31
|
+
- !ruby/object:Gem::Version
|
|
32
|
+
version: '0.9'
|
|
33
|
+
type: :development
|
|
34
|
+
prerelease: false
|
|
35
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
36
|
+
requirements:
|
|
37
|
+
- - "~>"
|
|
38
|
+
- !ruby/object:Gem::Version
|
|
39
|
+
version: '0.9'
|
|
40
|
+
- !ruby/object:Gem::Dependency
|
|
41
|
+
name: railties
|
|
42
|
+
requirement: !ruby/object:Gem::Requirement
|
|
43
|
+
requirements:
|
|
44
|
+
- - ">="
|
|
45
|
+
- !ruby/object:Gem::Version
|
|
46
|
+
version: '7.0'
|
|
47
|
+
type: :development
|
|
48
|
+
prerelease: false
|
|
49
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
50
|
+
requirements:
|
|
51
|
+
- - ">="
|
|
52
|
+
- !ruby/object:Gem::Version
|
|
53
|
+
version: '7.0'
|
|
54
|
+
- !ruby/object:Gem::Dependency
|
|
55
|
+
name: rake
|
|
56
|
+
requirement: !ruby/object:Gem::Requirement
|
|
57
|
+
requirements:
|
|
58
|
+
- - "~>"
|
|
59
|
+
- !ruby/object:Gem::Version
|
|
60
|
+
version: '13.0'
|
|
61
|
+
type: :development
|
|
62
|
+
prerelease: false
|
|
63
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
64
|
+
requirements:
|
|
65
|
+
- - "~>"
|
|
66
|
+
- !ruby/object:Gem::Version
|
|
67
|
+
version: '13.0'
|
|
68
|
+
- !ruby/object:Gem::Dependency
|
|
69
|
+
name: reek
|
|
70
|
+
requirement: !ruby/object:Gem::Requirement
|
|
71
|
+
requirements:
|
|
72
|
+
- - "~>"
|
|
73
|
+
- !ruby/object:Gem::Version
|
|
74
|
+
version: '6.3'
|
|
75
|
+
type: :development
|
|
76
|
+
prerelease: false
|
|
77
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
78
|
+
requirements:
|
|
79
|
+
- - "~>"
|
|
80
|
+
- !ruby/object:Gem::Version
|
|
81
|
+
version: '6.3'
|
|
82
|
+
- !ruby/object:Gem::Dependency
|
|
83
|
+
name: rspec
|
|
84
|
+
requirement: !ruby/object:Gem::Requirement
|
|
85
|
+
requirements:
|
|
86
|
+
- - "~>"
|
|
87
|
+
- !ruby/object:Gem::Version
|
|
88
|
+
version: '3.13'
|
|
89
|
+
type: :development
|
|
90
|
+
prerelease: false
|
|
91
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
92
|
+
requirements:
|
|
93
|
+
- - "~>"
|
|
94
|
+
- !ruby/object:Gem::Version
|
|
95
|
+
version: '3.13'
|
|
96
|
+
- !ruby/object:Gem::Dependency
|
|
97
|
+
name: rubocop
|
|
98
|
+
requirement: !ruby/object:Gem::Requirement
|
|
99
|
+
requirements:
|
|
100
|
+
- - "~>"
|
|
101
|
+
- !ruby/object:Gem::Version
|
|
102
|
+
version: '1.65'
|
|
103
|
+
type: :development
|
|
104
|
+
prerelease: false
|
|
105
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
106
|
+
requirements:
|
|
107
|
+
- - "~>"
|
|
108
|
+
- !ruby/object:Gem::Version
|
|
109
|
+
version: '1.65'
|
|
110
|
+
- !ruby/object:Gem::Dependency
|
|
111
|
+
name: rubocop-performance
|
|
112
|
+
requirement: !ruby/object:Gem::Requirement
|
|
113
|
+
requirements:
|
|
114
|
+
- - "~>"
|
|
115
|
+
- !ruby/object:Gem::Version
|
|
116
|
+
version: '1.21'
|
|
117
|
+
type: :development
|
|
118
|
+
prerelease: false
|
|
119
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
120
|
+
requirements:
|
|
121
|
+
- - "~>"
|
|
122
|
+
- !ruby/object:Gem::Version
|
|
123
|
+
version: '1.21'
|
|
124
|
+
- !ruby/object:Gem::Dependency
|
|
125
|
+
name: rubocop-rspec
|
|
126
|
+
requirement: !ruby/object:Gem::Requirement
|
|
127
|
+
requirements:
|
|
128
|
+
- - "~>"
|
|
129
|
+
- !ruby/object:Gem::Version
|
|
130
|
+
version: '3.0'
|
|
131
|
+
type: :development
|
|
132
|
+
prerelease: false
|
|
133
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
134
|
+
requirements:
|
|
135
|
+
- - "~>"
|
|
136
|
+
- !ruby/object:Gem::Version
|
|
137
|
+
version: '3.0'
|
|
138
|
+
- !ruby/object:Gem::Dependency
|
|
139
|
+
name: rubocop-rubycw
|
|
140
|
+
requirement: !ruby/object:Gem::Requirement
|
|
141
|
+
requirements:
|
|
142
|
+
- - "~>"
|
|
143
|
+
- !ruby/object:Gem::Version
|
|
144
|
+
version: 0.1.6
|
|
145
|
+
type: :development
|
|
146
|
+
prerelease: false
|
|
147
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
148
|
+
requirements:
|
|
149
|
+
- - "~>"
|
|
150
|
+
- !ruby/object:Gem::Version
|
|
151
|
+
version: 0.1.6
|
|
152
|
+
- !ruby/object:Gem::Dependency
|
|
153
|
+
name: simplecov
|
|
154
|
+
requirement: !ruby/object:Gem::Requirement
|
|
155
|
+
requirements:
|
|
156
|
+
- - "~>"
|
|
157
|
+
- !ruby/object:Gem::Version
|
|
158
|
+
version: '0.22'
|
|
159
|
+
type: :development
|
|
160
|
+
prerelease: false
|
|
161
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
162
|
+
requirements:
|
|
163
|
+
- - "~>"
|
|
164
|
+
- !ruby/object:Gem::Version
|
|
165
|
+
version: '0.22'
|
|
166
|
+
- !ruby/object:Gem::Dependency
|
|
167
|
+
name: simplecov-lcov
|
|
168
|
+
requirement: !ruby/object:Gem::Requirement
|
|
169
|
+
requirements:
|
|
170
|
+
- - "~>"
|
|
171
|
+
- !ruby/object:Gem::Version
|
|
172
|
+
version: '0.8'
|
|
173
|
+
type: :development
|
|
174
|
+
prerelease: false
|
|
175
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
176
|
+
requirements:
|
|
177
|
+
- - "~>"
|
|
178
|
+
- !ruby/object:Gem::Version
|
|
179
|
+
version: '0.8'
|
|
180
|
+
description: Framework-neutral Ruby gem for authoring Schema.org JSON-LD structured
|
|
181
|
+
data with metadata-driven validation and optional Rails integration.
|
|
182
|
+
email:
|
|
183
|
+
- mauriciozaffari@gmail.com
|
|
184
|
+
executables: []
|
|
185
|
+
extensions: []
|
|
186
|
+
extra_rdoc_files: []
|
|
187
|
+
files:
|
|
188
|
+
- CHANGELOG.md
|
|
189
|
+
- LICENSE.txt
|
|
190
|
+
- README.md
|
|
191
|
+
- data/schema_org_v30.json
|
|
192
|
+
- lib/generators/structured_data/install/install_generator.rb
|
|
193
|
+
- lib/generators/structured_data/install/templates/structured_data.rb
|
|
194
|
+
- lib/ruby-structured-data.rb
|
|
195
|
+
- lib/ruby_structured_data.rb
|
|
196
|
+
- lib/structured_data.rb
|
|
197
|
+
- lib/structured_data/compiler.rb
|
|
198
|
+
- lib/structured_data/compiler/parser.rb
|
|
199
|
+
- lib/structured_data/compiler/terms.rb
|
|
200
|
+
- lib/structured_data/compiler/uri_helper.rb
|
|
201
|
+
- lib/structured_data/compiler/vocabulary.rb
|
|
202
|
+
- lib/structured_data/configuration.rb
|
|
203
|
+
- lib/structured_data/document.rb
|
|
204
|
+
- lib/structured_data/enum.rb
|
|
205
|
+
- lib/structured_data/error.rb
|
|
206
|
+
- lib/structured_data/list.rb
|
|
207
|
+
- lib/structured_data/node.rb
|
|
208
|
+
- lib/structured_data/rails.rb
|
|
209
|
+
- lib/structured_data/rails/helper.rb
|
|
210
|
+
- lib/structured_data/rails/railtie.rb
|
|
211
|
+
- lib/structured_data/rails/registry.rb
|
|
212
|
+
- lib/structured_data/rails/renderer.rb
|
|
213
|
+
- lib/structured_data/reference.rb
|
|
214
|
+
- lib/structured_data/serializer.rb
|
|
215
|
+
- lib/structured_data/validator.rb
|
|
216
|
+
- lib/structured_data/validator/context.rb
|
|
217
|
+
- lib/structured_data/validator/diagnostic.rb
|
|
218
|
+
- lib/structured_data/validator/node_validator.rb
|
|
219
|
+
- lib/structured_data/validator/range_checker.rb
|
|
220
|
+
- lib/structured_data/validator/result.rb
|
|
221
|
+
- lib/structured_data/values.rb
|
|
222
|
+
- lib/structured_data/version.rb
|
|
223
|
+
- lib/structured_data/vocabulary.rb
|
|
224
|
+
- lib/structured_data/vocabulary/data_loader.rb
|
|
225
|
+
- lib/structured_data/vocabulary/hierarchy.rb
|
|
226
|
+
- lib/structured_data/vocabulary/registry.rb
|
|
227
|
+
homepage: https://github.com/develoz-com/ruby-structured-data
|
|
228
|
+
licenses:
|
|
229
|
+
- MIT
|
|
230
|
+
metadata:
|
|
231
|
+
homepage_uri: https://github.com/develoz-com/ruby-structured-data
|
|
232
|
+
source_code_uri: https://github.com/develoz-com/ruby-structured-data/tree/v0.1.1
|
|
233
|
+
changelog_uri: https://github.com/develoz-com/ruby-structured-data/blob/main/CHANGELOG.md
|
|
234
|
+
rubygems_mfa_required: 'true'
|
|
235
|
+
rdoc_options: []
|
|
236
|
+
require_paths:
|
|
237
|
+
- lib
|
|
238
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
239
|
+
requirements:
|
|
240
|
+
- - ">="
|
|
241
|
+
- !ruby/object:Gem::Version
|
|
242
|
+
version: '3.4'
|
|
243
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
244
|
+
requirements:
|
|
245
|
+
- - ">="
|
|
246
|
+
- !ruby/object:Gem::Version
|
|
247
|
+
version: '0'
|
|
248
|
+
requirements: []
|
|
249
|
+
rubygems_version: 3.6.9
|
|
250
|
+
specification_version: 4
|
|
251
|
+
summary: Schema.org JSON-LD authoring and structured data DSL for Ruby.
|
|
252
|
+
test_files: []
|