iq_rdf 0.0.14

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.
data/LICENSE ADDED
@@ -0,0 +1,177 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
data/README.rdoc ADDED
@@ -0,0 +1,77 @@
1
+ == IqRdf
2
+ IqRdf is a RDF renderer for Ruby and Rails. You can use it in any Ruby
3
+ environment to render Trurtle-, N-Triple- (not implemented jet) or XML-RDF.
4
+
5
+ IqRdf underlays a Builder-like (http://builder.rubyforge.org/) approach to specify
6
+ the RDF-Data by using a internal Ruby DSL. The basic Idea for specifing a triple
7
+ (subject, predicate, object) is that the predicate is a method call on the
8
+ subject with the object as parameters:
9
+
10
+ IqRdf::some_subject.some_predicate(IqRdf::some_object)
11
+
12
+ The IqRdf namespaces are needed not to mess up the rest of your project due to
13
+ the heavy use of method_missing in the IqRdf-Library. See the IqRdf::use method
14
+ for Ruby 1.9 to omit the "IqRdf::" prefix.
15
+
16
+ === Ruby example
17
+ You can use IqRdf in pure Ruby to produce Strings in a certain RDF Syntax like
18
+ Turtle or XML:
19
+ require 'IqRdf'
20
+ document = IqRdf::Document.new('http://www.test.de/')
21
+
22
+ document.namespaces :skos => 'http://www.w3.org/2008/05/skos#',
23
+ :foaf => 'http://xmlns.com/foaf/0.1/' # A :rdf namespace is added automatically
24
+
25
+ document << IqRdf::john_doe.myCustomNote("This is an example", :lang => :en)
26
+ # Turtle: :john_doe :myCustomNote "This is an example"@en.
27
+
28
+ document << IqRdf::john_doe(IqRdf::Foaf::build_uri("Person")).Foaf::name("John Doe")
29
+ # Turtle: :john_doe a foaf:Person; foaf:name "John Doe".
30
+
31
+ document << IqRdf::john_doe.Foaf::knows(IqRdf::jane_doe)
32
+ # Turtle: :john_doe foaf:knows :jane_doe.
33
+
34
+ document.to_turtle
35
+ # => "@prefix : <http://www.test.de/>. ..."
36
+
37
+ === Rails example
38
+ Include IqRdf to your Ruby on Rails project by adding the following line to your
39
+ Gemfile (or with Rails 2.x in your config/environment.rb):
40
+ gem "iq_rdf"
41
+ Add the mime types you want to support to your config/initializers/mime_types.rb
42
+ file:
43
+ Mime::Type.register "application/rdf+xml", :rdf
44
+ Mime::Type.register "text/turtle", :ttl
45
+ Mime::Type.register "application/n-triples", :nt
46
+ Now you can define views in you application. Use the extension <em>.iqrdf</em>
47
+ for the view files. You can use the extensions <em>.ttl</em> or
48
+ <em>.rdf</em> in the URL of your request, to force the output to be
49
+ in Turtle or XML/RDF.
50
+
51
+ ==== The views
52
+ In your views IqRdf gives you a <em>document</em> object you can add your triples
53
+ to. But first you will have to define your namespaces and the global language if
54
+ you want to label all String literals in a certain language (as long as there is
55
+ no other language or <em>:none</em> given).
56
+ document.namespaces :default => 'http://data.example.com/', :foaf => 'http://xmlns.com/foaf/0.1/'
57
+ document.lang = :en
58
+
59
+ document << IqRdf::test_subject.test_predicate("test")
60
+ # Turtle: :test_subject :test_predicate "test"@en.
61
+
62
+ document << IqRdf::test_subject.test_predicate("test", :lang => :de)
63
+ # Turtle: :test_subject :test_predicate "test"@de.
64
+
65
+
66
+ document << IqRdf::test_subject.test_predicate("test", :lang => :none)
67
+ # Turtle: :test_subject :test_predicate "test".
68
+
69
+ ...
70
+
71
+ Use the namespace token <em>:default</em> to mark the default namespace. This has the
72
+ same effect as specifing the default namespace in IqRdf::Document.new.
73
+
74
+ === Complex RDF definitions
75
+ ...
76
+
77
+ Copyright (c) 2011 Till Schulte-Coerne (innoQ Deutschland GmbH), released under the Apache License 2.0
data/Rakefile ADDED
@@ -0,0 +1,32 @@
1
+ # Copyright 2011 Till Schulte-Coerne (innoQ Deutschland GmbH)
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'bundler'
16
+ Bundler::GemHelper.install_tasks
17
+
18
+ require 'rake/rdoctask'
19
+ require 'rake/testtask'
20
+
21
+ Rake::RDocTask.new do |rdoc|
22
+ files = ['README.rdoc', 'LICENSE', 'lib/**/*.rb', 'rails/**/*.rb']
23
+ rdoc.rdoc_files.add(files)
24
+ rdoc.main = "README.rdoc" # page to start on
25
+ rdoc.title = "IqRdf Documentation"
26
+ rdoc.rdoc_dir = 'doc' # rdoc output folder
27
+ rdoc.options << '--line-numbers'
28
+ end
29
+
30
+ Rake::TestTask.new do |t|
31
+ t.test_files = FileList['test/**/*.rb']
32
+ end
data/iq_rdf.gemspec ADDED
@@ -0,0 +1,37 @@
1
+ # Copyright 2011 Till Schulte-Coerne (innoQ Deutschland GmbH)
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ # -*- encoding: utf-8 -*-
16
+ $:.push File.expand_path("../lib", __FILE__)
17
+ require "iq_rdf/version"
18
+
19
+ Gem::Specification.new do |s|
20
+ s.name = "iq_rdf"
21
+ s.version = IqRdf::VERSION
22
+ s.platform = Gem::Platform::RUBY
23
+ s.authors = ["Till Schulte-Coerne"]
24
+ s.email = ["till.schulte-coerne@innoq.com"]
25
+ s.homepage = "http://innoq.com"
26
+ s.summary = "IqRdf - A builder like rdf library for ruby and rails"
27
+ s.description = s.summary
28
+ s.extra_rdoc_files = ['README.rdoc', 'LICENSE']
29
+
30
+ s.add_dependency "bundler"
31
+ s.add_dependency "builder"
32
+
33
+ s.files = %w(LICENSE README.rdoc Rakefile iq_rdf.gemspec) + Dir.glob("{lib,rails,test}/**/*")
34
+ s.test_files = Dir.glob("{test}/**/*")
35
+ s.executables = Dir.glob("{bin}/**/*")
36
+ s.require_paths = ["lib"]
37
+ end
data/lib/iq_rdf.rb ADDED
@@ -0,0 +1,78 @@
1
+ # Copyright 2011 Till Schulte-Coerne (innoQ Deutschland GmbH)
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'iq_rdf/node'
16
+ require 'iq_rdf/uri'
17
+ require 'iq_rdf/blank_node'
18
+ require 'iq_rdf/predicate'
19
+
20
+ require 'iq_rdf/literal'
21
+ require 'iq_rdf/plain_turtle_literal'
22
+ require 'iq_rdf/namespace'
23
+ require 'iq_rdf/collection'
24
+ require 'iq_rdf/predicate_namespace'
25
+ require 'iq_rdf/document'
26
+
27
+ require 'builder'
28
+
29
+ require 'uri'
30
+
31
+ if defined?(ActionView::Template)
32
+ require 'iq_rdf/rails/iq_rdf'
33
+ ActionView::Template.register_template_handler('iqrdf', ActionView::TemplateHandlers::IqRdf)
34
+ end
35
+
36
+ # The main module of IqRdf.
37
+ module IqRdf
38
+
39
+ # This is needed for a system check in the "use" method.
40
+ module TestModule #:nodoc:
41
+ end
42
+ TestModule::module_eval {TEST_CONST = 1} #:nodoc: Where will TEST_CONST be difined? TestModule::TEST_CONST (Ruby 1.9) or IqRdf::TEST_CONST (Ruby 1.8 and JRuby)
43
+
44
+ # This evals the given block in the context of IqRdF.
45
+ # You can use this to be able to omit the "IqRdf::" in your turtle statements.
46
+ #
47
+ # Example:
48
+ # IqRdf::use do
49
+ # mySubject Rdf::type Skos::Concept # => mySubject rdf:type skos:Concept
50
+ # end
51
+ #
52
+ # But: There is an inconsistency in Ruby 1.8 and JRuby <= 1.4 (even with --1.9):
53
+ # module M; end
54
+ # M.module_eval {C = 1; self::D = 1}
55
+ # p defined? M::C # => nil (should be "constant" (and is in C Ruby 1.9))
56
+ # p defined? M::D # => "constant"
57
+ # This means, that _use_ will only work with Ruby 1.9. Feel free to change
58
+ # this if you know another way then module_eval to achieve this.
59
+ def self.use(&block)
60
+ raise NotImplementedError, "This is not supported in your Ruby version." unless defined?(TestModule::TEST_CONST)
61
+ self.module_eval(&block)
62
+ end
63
+
64
+ # A shortcut so be able to define Subjects and Objects without specifing a
65
+ # namespace. When no namespace is given, Default will be used.
66
+ #
67
+ # Example:
68
+ # IqRdf::sub.pred(IqRdf::obj) # => :sub :pred :obj.
69
+ def self.method_missing(method_name, *args, &block)
70
+ IqRdf::Default.send(method_name, *args, &block)
71
+ end
72
+
73
+ def self.build_full_uri_subject(uri, type = nil, &block)
74
+ raise "Parameter uri has to be an URI" unless uri.is_a?(URI)
75
+ Namespace.dummy_empty_namespace.build_uri(uri, type, &block)
76
+ end
77
+
78
+ end
@@ -0,0 +1,50 @@
1
+ # Copyright 2011 Till Schulte-Coerne (innoQ Deutschland GmbH)
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ module IqRdf
16
+ class BlankNode < Node
17
+
18
+ attr_reader :node_id
19
+
20
+ def initialize(node_id = nil)
21
+ super
22
+ @node_id = node_id
23
+ end
24
+
25
+ def to_turtle(parent_lang = nil)
26
+
27
+ end
28
+
29
+ def to_s(parent_lang = nil)
30
+ "[\n#{(nodes.map{|pred| "#{pred} #{pred.nodes.map{|o| o.to_s(pred.lang || parent_lang)}.join(", ")}"}.join(";\n")).gsub(/^/, " ")}\n]"
31
+ end
32
+
33
+ def build_predicate(*args, &block)
34
+ IqRdf::PredicateNamespace.new(self, IqRdf::Default).build_predicate(*args, &block)
35
+ end
36
+
37
+ def build_xml(xml, &block)
38
+ block.call({}, lambda {
39
+ attrs = {}
40
+ attrs["xml:lang"] = self.lang if self.lang
41
+ xml.rdf(:Description, attrs) do
42
+ self.nodes.each do |predicate|
43
+ predicate.build_xml(xml)
44
+ end
45
+ end
46
+ })
47
+ end
48
+
49
+ end
50
+ end