iq_rdf 0.0.15 → 0.1.0

data/README.md

@@ -0,0 +1,92 @@
+# IqRdf - RDF Renderering for Ruby and Rails
+IqRdf is a RDF renderer for Ruby and Rails. You can use it in any Ruby
+environment to render Trurtle-, N-Triple- (not implemented jet) or XML-RDF.
+
+IqRdf underlays a [Builder](http://builder.rubyforge.org/)-like approach to specify
+the RDF-Data by using a internal Ruby DSL. The basic Idea for specifing a triple
+(subject, predicate, object) is that the predicate is a method call on the
+subject with the object as parameters:
+
+```ruby
+IqRdf::some_subject.some_predicate(IqRdf::some_object)
+```
+
+The IqRdf namespaces are needed not to mess up the rest of your project due to
+the heavy use of method_missing in the IqRdf-Library. See the IqRdf::use method
+for Ruby 1.9 to omit the `IqRdf::` prefix.
+
+## Ruby example
+You can use IqRdf in pure Ruby to produce Strings in a certain RDF Syntax like
+Turtle or XML:
+
+```ruby
+require 'IqRdf'
+document = IqRdf::Document.new('http://www.test.de/')
+
+document.namespaces :skos => 'http://www.w3.org/2008/05/skos#',
+  :foaf => 'http://xmlns.com/foaf/0.1/' # A :rdf namespace is added automatically
+
+document << IqRdf::john_doe.myCustomNote("This is an example", :lang => :en) 
+# Turtle: :john_doe :myCustomNote "This is an example"@en.
+
+document << IqRdf::john_doe(IqRdf::Foaf::build_uri("Person")).Foaf::name("John Doe") 
+# Turtle: :john_doe a foaf:Person; foaf:name "John Doe".
+
+document << IqRdf::john_doe.Foaf::knows(IqRdf::jane_doe)
+# Turtle: :john_doe foaf:knows :jane_doe.
+
+document.to_turtle
+# => "@prefix : <http://www.test.de/>. ..."
+```
+
+## Rails example
+Include IqRdf to your Ruby on Rails project by adding the following line to your
+Gemfile (or with Rails 2.x in your config/environment.rb):
+
+```ruby
+gem "iq_rdf"
+```
+  
+Add the mime types you want to support to your config/initializers/mime_types.rb
+file:
+
+```ruby
+Mime::Type.register "application/rdf+xml", :rdf
+Mime::Type.register "text/turtle", :ttl
+Mime::Type.register "application/n-triples", :nt
+```
+  
+Now you can define views in you application. Use the extension *.iqrdf*
+for the view files. You can use the extensions *.ttl* or
+*.rdf* in the URL of your request, to force the output to be
+in Turtle or XML/RDF.
+
+### Views
+In your views IqRdf gives you a *document* object you can add your triples
+to. But first you will have to define your namespaces and the global language if
+you want to label all String literals in a certain language (as long as there is
+no other language or `:none` given).
+
+```ruby
+document.namespaces :default => 'http://data.example.com/', :foaf => 'http://xmlns.com/foaf/0.1/'
+document.lang = :en
+
+document << IqRdf::test_subject.test_predicate("test")
+# Turtle: :test_subject :test_predicate "test"@en.
+
+document << IqRdf::test_subject.test_predicate("test", :lang => :de)
+# Turtle: :test_subject :test_predicate "test"@de.
+
+document << IqRdf::test_subject.test_predicate("test", :lang => :none)
+# Turtle: :test_subject :test_predicate "test".
+
+# ...
+```
+
+Use the namespace token `:default` to mark the default namespace. This has the
+same effect as specifing the default namespace in `IqRdf::Document.new`.
+
+## Complex RDF definitions
+TODO
+
+Copyright (c) 2011 innoQ Deutschland GmbH, released under the Apache License 2.0

data/iq_rdf.gemspec

@@ -25,12 +25,12 @@ Gem::Specification.new do |s|
   s.homepage    = "http://github.com/innoq/iq_rdf"
   s.summary     = "IqRdf - A builder like rdf library for ruby and rails"
   s.description = s.summary
-  s.extra_rdoc_files = ['README.rdoc', 'LICENSE']
+  s.extra_rdoc_files = ['README.md', 'LICENSE']
   
   s.add_dependency "bundler"
   s.add_dependency "builder"
 
-  s.files = %w(LICENSE README.rdoc Rakefile iq_rdf.gemspec) + Dir.glob("{lib,rails,test}/**/*")
+  s.files = %w(LICENSE README.md Rakefile iq_rdf.gemspec) + Dir.glob("{lib,rails,test}/**/*")
   s.test_files = Dir.glob("{test}/**/*")
   s.executables = Dir.glob("{bin}/**/*")
   s.require_paths = ["lib"]

data/lib/iq_rdf/rails/iq_rdf.rb

@@ -12,31 +12,32 @@
 #   See the License for the specific language governing permissions and
 #   limitations under the License.
 
-module ActionView::TemplateHandlers
+module ActionView
+  module Template::Handlers
 
-  class IqRdf < ActionView::TemplateHandler
-    include ActionView::TemplateHandlers::Compilable
+    class IqRdf
 
-    def compile(template)
-      <<-EOV
+      def self.call(template)
+        <<-EOV
 
-      document = IqRdf::Document.new()
-      #{template.source}
-      if params[:format].to_s == "ttl"
-        controller.response.headers["Content-Type"] ||= 'text/turtle'
-        document.to_turtle
-      elsif  params[:format].to_s == "nt"
-        controller.response.headers["Content-Type"] ||= 'text/plain'
-        document.to_ntriples
-      elsif params[:format].to_s == "rdf"
-        controller.response.headers["Content-Type"] ||= 'application/xml+rdf'
-        document.to_xml
-      else # Default => turtle
-        controller.response.headers["Content-Type"] ||= 'text/turtle'
-        document.to_turtle
+        document = IqRdf::Document.new()
+        #{template.source}
+        if params[:format].to_s == "ttl"
+          controller.response.headers["Content-Type"] ||= 'text/turtle'
+          document.to_turtle
+        elsif  params[:format].to_s == "nt"
+          controller.response.headers["Content-Type"] ||= 'text/plain'
+          document.to_ntriples
+        elsif params[:format].to_s == "rdf"
+          controller.response.headers["Content-Type"] ||= 'application/xml+rdf'
+          document.to_xml
+        else # Default => turtle
+          controller.response.headers["Content-Type"] ||= 'text/turtle'
+          document.to_turtle
+        end
+        EOV
       end
-      EOV
     end
+    
   end
-  
 end

data/lib/iq_rdf/version.rb

@@ -13,5 +13,5 @@
 #   limitations under the License.
 
 module IqRdf
-  VERSION = "0.0.15"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,64 +1,49 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: iq_rdf
-version: !ruby/object:Gem::Version 
-  hash: 1
+version: !ruby/object:Gem::Version
+  version: 0.1.0
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 15
-  version: 0.0.15
 platform: ruby
-authors: 
+authors:
 - Till Schulte-Coerne
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-26 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-01-10 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2154052080 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: builder
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2154052080
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: &2154050800 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *2154050800
 description: IqRdf - A builder like rdf library for ruby and rails
-email: 
+email:
 - till.schulte-coerne@innoq.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.rdoc
+extra_rdoc_files:
+- README.md
 - LICENSE
-files: 
+files:
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - iq_rdf.gemspec
 - lib/iq_rdf/blank_node.rb
@@ -79,41 +64,37 @@ files:
 - test/test_helper.rb
 - test/turtle_test.rb
 - test/xml_test.rb
-has_rdoc: true
 homepage: http://github.com/innoq/iq_rdf
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -3269158319309008120
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -3269158319309008120
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: IqRdf - A builder like rdf library for ruby and rails
-test_files: 
+test_files:
 - test/iq_rdf_test.rb
 - test/test_helper.rb
 - test/turtle_test.rb

data/README.rdoc

@@ -1,77 +0,0 @@
-== IqRdf
-IqRdf is a RDF renderer for Ruby and Rails. You can use it in any Ruby
-environment to render Trurtle-, N-Triple- (not implemented jet) or XML-RDF.
-
-IqRdf underlays a Builder-like (http://builder.rubyforge.org/) approach to specify
-the RDF-Data by using a internal Ruby DSL. The basic Idea for specifing a triple
-(subject, predicate, object) is that the predicate is a method call on the
-subject with the object as parameters:
-
-  IqRdf::some_subject.some_predicate(IqRdf::some_object)
-
-The IqRdf namespaces are needed not to mess up the rest of your project due to
-the heavy use of method_missing in the IqRdf-Library. See the IqRdf::use method
-for Ruby 1.9 to omit the "IqRdf::" prefix.
-
-=== Ruby example
-You can use IqRdf in pure Ruby to produce Strings in a certain RDF Syntax like
-Turtle or XML:
-  require 'IqRdf'
-  document = IqRdf::Document.new('http://www.test.de/')
-
-  document.namespaces :skos => 'http://www.w3.org/2008/05/skos#',
-    :foaf => 'http://xmlns.com/foaf/0.1/' # A :rdf namespace is added automatically
-
-  document << IqRdf::john_doe.myCustomNote("This is an example", :lang => :en) 
-  # Turtle: :john_doe :myCustomNote "This is an example"@en.
-
-  document << IqRdf::john_doe(IqRdf::Foaf::build_uri("Person")).Foaf::name("John Doe") 
-  # Turtle: :john_doe a foaf:Person; foaf:name "John Doe".
-
-  document << IqRdf::john_doe.Foaf::knows(IqRdf::jane_doe)
-  # Turtle: :john_doe foaf:knows :jane_doe.
-
-  document.to_turtle
-  # => "@prefix : <http://www.test.de/>. ..."
-
-=== Rails example
-Include IqRdf to your Ruby on Rails project by adding the following line to your
-Gemfile (or with Rails 2.x in your config/environment.rb):
-  gem "iq_rdf"
-Add the mime types you want to support to your config/initializers/mime_types.rb
-file:
-  Mime::Type.register "application/rdf+xml", :rdf
-  Mime::Type.register "text/turtle", :ttl
-  Mime::Type.register "application/n-triples", :nt
-Now you can define views in you application. Use the extension <em>.iqrdf</em>
-for the view files. You can use the extensions <em>.ttl</em> or
-<em>.rdf</em> in the URL of your request, to force the output to be
-in Turtle or XML/RDF.
-
-==== The views
-In your views IqRdf gives you a <em>document</em> object you can add your triples
-to. But first you will have to define your namespaces and the global language if
-you want to label all String literals in a certain language (as long as there is
-no other language or <em>:none</em> given).
-  document.namespaces :default => 'http://data.example.com/', :foaf => 'http://xmlns.com/foaf/0.1/'
-  document.lang = :en
-
-  document << IqRdf::test_subject.test_predicate("test")
-  # Turtle: :test_subject :test_predicate "test"@en.
-
-  document << IqRdf::test_subject.test_predicate("test", :lang => :de)
-  # Turtle: :test_subject :test_predicate "test"@de.
-
-
-  document << IqRdf::test_subject.test_predicate("test", :lang => :none)
-  # Turtle: :test_subject :test_predicate "test".
-
-  ...
-
-Use the namespace token <em>:default</em> to mark the default namespace. This has the
-same effect as specifing the default namespace in IqRdf::Document.new.
-
-=== Complex RDF definitions
-...
-
-Copyright (c) 2011 innoQ Deutschland GmbH, released under the Apache License 2.0