rdfobjects 0.6.6 → 0.7.0

data/README

@@ -53,15 +53,25 @@ Usage:
   
   => "en"
   
-  To relate a resource to another URI you can use #.resource - it will accept full uri strings, safe curies or other RDFObject::Resource objects
+  To relate a resource to another URI you can use #.relate - it will accept full uri strings, safe curies or other RDFObject::Resource objects
   
   >> resource.relate("[skos:closeMatch]", "http://dbpedia.org/resource/Category:Semantic_Web")
   
   => [#<RDFObject::Resource uri="http://stitch.cs.vu.nl/vocabularies/rameau/ark:/12148/cb14521343b">, #<RDFObject::Resource uri="http://dbpedia.org/resource/Category:Semantic_Web">]
   
-  RDFObject::Resources sort of act as singletons
+  These relationships are actually replaced with RDFObject::ResourceReference objects (to prevent massive recursion errors).  To access the actual Resource object, use:
   
-  >> r1 = Resource.new('http://ex.org/ex/1234')
+  >> resource["[skos:closeMatch]"].first.resource
+  
+  => #<RDFObject::Resource uri="http://stitch.cs.vu.nl/vocabularies/rameau/ark:/12148/cb14521343b">
+  
+  In order to be sure you are always asserting against the same object, use RDFObject::Collection objects to manage your Resources.
+  
+  >> collection = Collection.new
+  
+  => {}
+  
+  >> r1 = collection.find_or_create('http://ex.org/ex/1234')
   
   => #<RDFObject::Resource uri="http://ex.org/ex/1234">
   
@@ -69,7 +79,7 @@ Usage:
   
   => 8996290
   
-  >> r2 = Resource.new('http://ex.org/ex/1234')
+  >> r2 = collection.find_or_create('http://ex.org/ex/1234')
   
   => #<RDFObject::Resource uri="http://ex.org/ex/1234">  
   
@@ -77,38 +87,46 @@ Usage:
   
   => 8996290  
   
-  So relationships and assertions are always applied to the same object.  These are managed in the RDFObject::Resource class:
+  So relationships and assertions are always applied to the same objects.
   
-  >> Resource.instances
+  You can delete a single resource:
   
-  => {"http://ex.org/ex/1234"=>#<RDFObject::Resource uri="http://ex.org/ex/1234">}
+  >> collection.remove(r1)
   
-  To override this behavior (i.e. to create another object with the same URI), pass the :force argument:
+  >> collection
+  => {}
   
-  >> r2 = Resource.new('http://ex.org/ex/1234', :force)
+  There is also a convenience method on RDFObject::Collection to help find particular resources by predicate:
   
-  => #<RDFObject::Resource uri="http://ex.org/ex/1234">  
+  >> resources_with_types = collection.find_by_predicate("http://www.w3.org/1999/02/22-rdf-syntax-ns#type")
   
-  >> r2.object_id
+  And to find resources by predicate and object:
   
-  => 8996310  
+  >> resources_i_want = collection.find_by_predicate_and_object("http://www.w3.org/2004/02/skos/core#closeMatch", "http://stitch.cs.vu.nl/vocabularies/rameau/ark:/12148/cb145537755")
   
-  You can delete a single resource:
+  Both these return RDFObject::Collection objects with your matches.  Changes to resources in these collections also affect the resource in original collection.
   
-  >> Resource.remove(r1)
+  There are also parsers for ntriples, rdf/xml, RSS 1.0, RDFa, and JSON.  Parsers return a RDFObject::Collection with all of the resources discovered in the RDF source.
   
-  >> Resource.instances
-  => {}
-
-  Or clear the entire hash:
+  >> resources = Parser.parse(open('lcsh.nt').read)
   
-  >> Resource.reset!
+  >> resources.values.first
   
-  There are also parsers for ntriples, rdf/xml, RSS 1.0, RDFa, and JSON.
+  => #<RDFObject::Resource n0={"altLabel"=>"Lichen ruber planus", "inScheme"=>[#<RDFObject::Resource uri="http://id.loc.gov/authorities#conceptScheme">, #<RDFObject::Resource uri="http://id.loc.gov/authorities#topicalTerms">], "prefLabel"=>"Lichen planus"}, n1={"sameAs"=>#<RDFObject::Resource uri="info:lc/authorities/sh85076767">}, uri="http://id.loc.gov/authorities/sh85076767#concept", n2={"modified"=>#<DateTime: 211644344801/86400,-1/6,2299161>}, rdf={"type"=>#<RDFObject::Resource uri="http://www.w3.org/2004/02/skos/core#Concept">}>
   
-  >> resources = Parser.parse(open('lcsh.nt').read)
+  There are serializers for RDF/XML and ntriples.  Both resources and collections can be serialized.
   
-  >> resources.first
+  >> resource.to_xml
   
-  => #<RDFObject::Resource n0={"altLabel"=>"Lichen ruber planus", "inScheme"=>[#<RDFObject::Resource uri="http://id.loc.gov/authorities#conceptScheme">, #<RDFObject::Resource uri="http://id.loc.gov/authorities#topicalTerms">], "prefLabel"=>"Lichen planus"}, n1={"sameAs"=>#<RDFObject::Resource uri="info:lc/authorities/sh85076767">}, uri="http://id.loc.gov/authorities/sh85076767#concept", n2={"modified"=>#<DateTime: 211644344801/86400,-1/6,2299161>}, rdf={"type"=>#<RDFObject::Resource uri="http://www.w3.org/2004/02/skos/core#Concept">}>
+  => "<rdf:RDF xmlns:n0="http://www.w3.org/2004/02/skos/core#" xmlns:n1="http://www.w3.org/2002/07/owl#" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:n2="http://purl.org/dc/terms/"><rdf:Description rdf:about="http://id.loc.gov/authorities/sh85076767#concept"><n0:altLabel>Lichen ruber planus</n0:altLabel><n0:inScheme><rdf:Description rdf:about="http://id.loc.gov/authorities#conceptScheme"></rdf:Description></n0:inScheme><n0:inScheme><rdf:Description rdf:about="http://id.loc.gov/authorities#topicalTerms"></rdf:Description></n0:inScheme><n0:prefLabel>Lichen planus</n0:prefLabel><n1:sameAs><rdf:Description rdf:about="info:lc/authorities/sh85076767"></rdf:Description></n1:sameAs><n2:modified rdf:datatype="http://www.w3.org/2001/XMLSchema#dateTime">1994-08-22T15:46:41-04:00</n2:modified><rdf:type><rdf:Description rdf:about="http://www.w3.org/2004/02/skos/core#Concept"></rdf:Description></rdf:type></rdf:Description></rdf:RDF>"
+  
+  >> collection.to_xml
+  
+  >> resource.to_ntriples
+  
+  => "<http://id.loc.gov/authorities/sh85076767#concept> <http://www.w3.org/2004/02/skos/core#altLabel> "Lichen ruber planus"@en.\n<http://id.loc.gov/authorities/sh85076767#concept> <http://www.w3.org/2004/02/skos/core#inScheme> <http://id.loc.gov/authorities#conceptScheme>.\n<http://id.loc.gov/authorities/sh85076767#concept> <http://www.w3.org/2004/02/skos/core#inScheme> <http://id.loc.gov/authorities#topicalTerms>.\n<http://id.loc.gov/authorities/sh85076767#concept> <http://www.w3.org/2004/02/skos/core#prefLabel> "Lichen planus"@en.\n<http://id.loc.gov/authorities/sh85076767#concept> <http://www.w3.org/2002/07/owl#sameAs> <info:lc/authorities/sh85076767>.\n<http://id.loc.gov/authorities/sh85076767#concept> <http://purl.org/dc/terms/modified> "1994-08-22T15:46:41-04:00"^^<http://www.w3.org/2001/XMLSchema#dateTime>.\n<http://id.loc.gov/authorities/sh85076767#concept> <http://www.w3.org/1999/02/22-rdf-syntax-ns#type> <http://www.w3.org/2004/02/skos/core#Concept>.\n"
+  
+  >> collection.to_ntriples
+  
+  etc.
   

data/lib/rdf_objects/collection.rb

@@ -7,12 +7,34 @@ module RDFObject
       if predicate.could_be_a_safe_curie?
         predicate = Curie.parse predicate
       end      
-      self.find_all {|r| 
+      matches = self.find_all {|r| 
         if r[1][predicate]
           r[1]
         end
       }
+      resources = Collection.new
+      matches.each do | match |
+        resources[match[0]] = match[1]
+      end
+      return resources
     end
+    
+    def find_by_predicate_and_object(predicate, object)
+      if predicate.could_be_a_safe_curie?
+        predicate = Curie.parse predicate
+      end      
+      if object.could_be_a_safe_curie?
+        object = Curie.parse object
+      end
+      object = self[object] if self[object]      
+      matches = self.find_all {|r| [*r[1][predicate]].index(object) }
+
+      resources = Collection.new
+      matches.each do | match |
+        resources[match[0]] = match[1]
+      end
+      return resources
+    end    
 
     def find_or_create(uri)
       if uri.could_be_a_safe_curie?
@@ -32,5 +54,36 @@ module RDFObject
       parser.parse
       nil
     end
+    
+    def to_ntriples
+      ntriples = ""
+      self.each_pair do | uri, resource |
+        ntriples << resource.to_ntriples
+      end
+      ntriples
+    end
+    
+    def to_xml(depth=0)
+      namespaces = {}
+      rdf_data = ""
+      self.values.each do | resource |
+        ns, desc = resource.rdf_description_block(depth)
+        namespaces.merge!(ns)
+        rdf_data << desc
+      end
+      unless namespaces["xmlns:rdf"]
+        if  x = namespaces.index("http://www.w3.org/1999/02/22-rdf-syntax-ns#")
+          namespaces.delete(x)
+        end
+        namespaces["xmlns:rdf"] = "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+      end
+
+      rdf = "<rdf:RDF"
+      namespaces.each_pair {|key, value| rdf << " #{key}=\"#{value}\""}
+      rdf <<">"
+      rdf << rdf_data
+      rdf << "</rdf:RDF>"
+      rdf      
+    end    
   end
 end

data/lib/rdf_objects/rdf_resource.rb

@@ -4,6 +4,7 @@ require 'curies'
 
 module RDFObject
   class Resource < OpenStruct
+    attr_reader :table
     def initialize(uri)        
       if uri.could_be_a_safe_curie?
         uri = Curie.parse uri
@@ -101,6 +102,123 @@ module RDFObject
       end
       return true
     end
+    
+    def to_ntriples
+      ntriples = ""
+      Curie.get_mappings.each do | prefix, uri |
+        if self[uri]
+          self[uri].keys.each do | pred |    
+            if self[uri][pred].is_a?(Array)
+              objects = self[uri][pred]
+            else
+              objects = [self[uri][pred]]
+            end
+            objects.each do | object |           
+              line = "<#{self.uri}> <#{uri}#{pred}> "
+              if (object.is_a?(Resource) or object.is_a?(ResourceReference))
+                line << "<#{object.uri}>"
+              else
+                line << "#{object.to_json}"
+                if (object.respond_to?(:data_type) || object.respond_to?(:language))
+                  if object.data_type
+                    line << "^^<#{object.data_type}>"
+                  end
+                  if object.language
+                    line << "@#{object.language}"
+                  end
+                end
+              end
+              line << ".\n"
+              ntriples << line              
+            end
+          end
+        end
+      end 
+      ntriples     
+    end
+    
+    def to_xml(depth=0)
+      namespaces, rdf_data = rdf_description_block(depth)
+      unless namespaces["xmlns:rdf"]
+        if  x = namespaces.index("http://www.w3.org/1999/02/22-rdf-syntax-ns#")
+          namespaces.delete(x)
+        end
+        namespaces["xmlns:rdf"] = "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+      end
+
+      rdf = "<rdf:RDF"
+      namespaces.each_pair {|key, value| rdf << " #{key}=\"#{value}\""}
+      rdf <<">"
+      rdf << rdf_data
+      rdf << "</rdf:RDF>"
+      rdf      
+    end
+    
+    def rdf_description_block(depth)
+      rdf = "<rdf:Description rdf:about=\"#{CGI.escapeHTML(self.uri)}\">"
+      namespaces = {}
+      Curie.get_mappings.each_pair do |key, value|
+        if self.respond_to?(key.to_sym)
+          self.send(key.to_sym).each_pair do | predicate, objects |
+            [*objects].each do | object |
+              rdf << "<#{key}:#{predicate}"
+              namespaces["xmlns:#{key}"] = "#{Curie.parse("[#{key}:]")}"
+              if object.is_a?(RDFObject::ResourceReference)
+                if depth > 0
+                  rdf << " rdf:resource=\"#{CGI.escapeHTML(object.uri)}\" />"
+                else
+                  rdf << ">"
+                  ns, rdf_data = object.resource.rdf_description_block(depth+1)
+                  namespaces.merge!(ns)
+                  rdf << rdf_data
+                  rdf << "</#{key}:#{predicate}>"
+                end
+              else
+                if object.language
+                  rdf << " xml:lang=\"#{object.language}\""
+                end
+                if object.data_type
+                  rdf << " rdf:datatype=\"#{object.data_type}\""
+                end
+                rdf << ">#{CGI.escapeHTML(object.to_s)}</#{key}:#{predicate}>"
+              end
+            end
+          end
+        end
+      end
+      rdf << "</rdf:Description>"
+      [namespaces, rdf]
+    end    
+    
+    def ==(other)
+      return false unless self.uri == other.uri
+      Curie.get_mappings.each do | prefix, uri |
+        next unless self[uri] or other[uri]
+        return false if self[uri] && !other[uri]
+        return false if !self[uri] && other[uri]     
+        return false if self[uri].class != other[uri].class  
+        if self[uri] != other[uri]
+          if self[uri].is_a?(Hash)            
+            return false unless self[uri].keys.eql?(other[uri].keys)
+            self[uri].keys.each do | pred |
+              if self[uri][pred].is_a?(Array)
+                return false unless self[uri][pred].length == other[uri][pred].length
+              else
+                if self[uri][pred].is_a?(Resource) or self[uri][pred].is_a?(ResourceReference)
+                  return false unless other[uri][pred].is_a?(Resource) or other[uri][pred].is_a?(ResourceReference)
+                  return false unless self.uri == other.uri
+                else
+                  return false unless self[uri][pred] == other[uri][pred]
+                end
+              end
+            end
+          else
+            return false 
+          end
+        end
+      end
+      true
+    end
   end
   
   class ResourceReference

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rdfobjects
 version: !ruby/object:Gem::Version 
-  version: 0.6.6
+  version: 0.7.0
 platform: ruby
 authors: 
 - Ross Singer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-30 00:00:00 -04:00
+date: 2009-11-10 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency