lightrdf 0.1.9 → 0.2.0

data/History.txt

@@ -1,3 +1,7 @@
+=== 0.2.0 2011-03-03
+
+* Instantiation of RDF data as Ruby objects (with methods and so on)
+
 === 0.1.9 2011-02-18
 
 * Simplified design with much better performance

data/Manifest

@@ -6,6 +6,7 @@ bin/yarfp
 lib/lightrdf.rb
 lib/lightrdf/graph.rb
 lib/lightrdf/node.rb
+lib/lightrdf/node_proxy.rb
 lib/lightrdf/parser.rb
 lib/lightrdf/repository.rb
 lib/lightrdf/id.rb

data/README.rdoc

@@ -103,6 +103,52 @@ Also, queries for triples can be performed on a graph:
   # Find all predicates bob has
   g.find(Node('ex:bob'), nil, []) # => [Node('foaf:name'), Node('foaf:age')]
 
+== INSTANTIATING OBJECTS:
+
+LightRDF allows defining a class hierarchy that is instantiated using RDF data. Simply match
+modules to prefix names and classes to RDF types and include RDF::NodeProxy:
+
+  module Foaf
+    class Person
+      include RDF::NodeProxy
+      # Optionally, you can specify the mapped URI:
+      # maps 'foaf:Person'
+      # or
+      # maps 'http://xmlns.com/foaf/0.1/Person'
+  
+      # Adds 1 year to the person's age
+      def happy_birthday!
+        foaf::age = (foaf::age.first.to_i + 1).to_s
+      end
+    end
+  end
+
+This class can be instantiated by passing an RDF node or a hash with predicates:
+
+  Foaf::Person.new.rdf::type # => [Node("http://xmlns.com/foaf/0.1/Person")]
+  
+  person_node = Node(nil)
+  person_node.rdf::type = Node('foaf:Person')
+  person_node.foaf::age = "19"
+  person = Foaf::Person.new(person_node)
+  person.foaf::age # => ["19"]
+  
+  person = Foaf::Person.new('foaf:age'=>"25")
+  person.happy_birthday!
+  person.foaf::age # => ["26"]
+
+Also, you can use Graph#node to get instances of class Person out of an RDF graph:
+  
+  graph       = RDF::Graph.new
+  person_node = Node(nil)
+  person_node.rdf::type = Node('foaf:Person')
+  person_node.foaf::age = "25"
+  graph << person_node
+  
+  person = graph.node(person_node)
+  person.happy_birthday!
+  person.foaf::age # => ["26"]
+
 == PARSING AND SERIALIZING:
 
 LightRDF uses Raptor library internally to support many RDF formats. It also introduces

data/lib/lightrdf/graph.rb

@@ -41,6 +41,12 @@ module RDF
       values.select &block
     end
     
+    # This is equivalent to [], but tries to return a NodeProxy
+    def node id
+      node = self[id]
+      Node.classes[node.rdf::type.first].new node
+    end
+    
     def find subject, predicate, object
       # Convert nodes into IDs
       subject   = subject.id   if subject.is_a?(Node)

data/lib/lightrdf/id.rb

@@ -5,6 +5,7 @@ module RDF
             :rdfs => 'http://www.w3.org/2000/01/rdf-schema#',
             :dc   => 'http://purl.org/dc/elements/1.1/',
             :owl  => 'http://www.w3.org/2002/07/owl#' }
+
     def self.ns;      @ns;      end
     def self.count;   @count;   end
     def self.count=c; @count=c; end

data/lib/lightrdf/node.rb

@@ -22,6 +22,9 @@ module RDF
   
   class Node < Hash
     include Parser
+    @classes = {}
+    def self.classes; @classes; end
+    
     attr_accessor :graph, :id
 
     def initialize id=nil, graph=nil

data/lib/lightrdf/node_proxy.rb

@@ -0,0 +1,66 @@
+module RDF  
+  # This class allows instantiating RDF resources as Ruby objects
+  module NodeProxy
+    def self.included base
+      base.extend ClassMethods
+      base.send :attr_reader, :node
+      base.maps base.to_s.gsub("::",":").gsub(/\A.*:/) { |a| a.downcase }
+    end
+    
+    module ClassMethods
+      def maps id
+        @rdf_type = Node(id)
+        Node.classes.delete Node.classes.invert[self]
+        Node.classes[@rdf_type] = self
+      end
+    end
+
+    # Constructor that allows 
+    def initialize arg=nil
+      @node = if arg.is_a?(RDF::Node)
+        arg
+      elsif arg.is_a?(Hash)
+        new_node = Node('*')
+        new_node.rdf::type = rdf_type
+        arg.each { |k,v| new_node[k] = (new_node[k] + [v].flatten).uniq }
+        new_node
+      else
+        new_node = Node('*')
+        new_node.rdf::type = rdf_type
+        new_node
+      end
+    end
+    
+    # Equality method delegated to node
+    def == other_node
+      @node.eql? other_node.node
+    end
+    # Equality method delegated to node
+    def eql? other_node
+      self.class == other_node.class and @node.id == other_node.node.id
+    end
+    # Hash method delegated to node
+    def hash # Hack for Ruby 1.8.6
+      @node.id.hash ^ self.class.hash
+    end
+    
+    # to_s method delegated to node
+    def to_s
+      @node.to_s
+    end
+    
+    # id method delegated to node
+    def id
+      @node.id
+    end
+    
+    def rdf_type
+      self.class.instance_variable_get("@rdf_type")
+    end
+    
+    # Any other method (including any predicate) delegated to node
+    def method_missing method, *args
+      @node.send method, args
+    end
+  end
+end

data/lib/lightrdf.rb

@@ -2,7 +2,7 @@ $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 module RDF
-  VERSION = '0.1.9'
+  VERSION = '0.2.0'
 end
 
 require 'rubygems'
@@ -20,4 +20,5 @@ require "lightrdf/id"
 require "lightrdf/parser"
 require "lightrdf/graph"
 require "lightrdf/node"
+require "lightrdf/node_proxy"
 require "lightrdf/repository"

data/lightrdf.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{lightrdf}
-  s.version = "0.1.9"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jose Ignacio"]
-  s.date = %q{2011-02-18}
+  s.date = %q{2011-03-03}
   s.default_executable = %q{yarfp}
   s.description = %q{RDF library}
   s.email = %q{joseignacio.fernandez@gmail.com}
   s.executables = ["yarfp"]
-  s.extra_rdoc_files = ["README.rdoc", "bin/yarfp", "lib/lightrdf.rb", "lib/lightrdf/graph.rb", "lib/lightrdf/node.rb", "lib/lightrdf/parser.rb", "lib/lightrdf/repository.rb", "lib/lightrdf/id.rb"]
-  s.files = ["History.txt", "Manifest", "README.rdoc", "Rakefile", "bin/yarfp", "lib/lightrdf.rb", "lib/lightrdf/graph.rb", "lib/lightrdf/node.rb", "lib/lightrdf/parser.rb", "lib/lightrdf/repository.rb", "lib/lightrdf/id.rb", "test/test_helper.rb", "test/test_lightrdf.rb", "lightrdf.gemspec"]
+  s.extra_rdoc_files = ["README.rdoc", "bin/yarfp", "lib/lightrdf.rb", "lib/lightrdf/graph.rb", "lib/lightrdf/node.rb", "lib/lightrdf/node_proxy.rb", "lib/lightrdf/parser.rb", "lib/lightrdf/repository.rb", "lib/lightrdf/id.rb"]
+  s.files = ["History.txt", "Manifest", "README.rdoc", "Rakefile", "bin/yarfp", "lib/lightrdf.rb", "lib/lightrdf/graph.rb", "lib/lightrdf/node.rb", "lib/lightrdf/node_proxy.rb", "lib/lightrdf/parser.rb", "lib/lightrdf/repository.rb", "lib/lightrdf/id.rb", "test/test_helper.rb", "test/test_lightrdf.rb", "lightrdf.gemspec"]
   s.homepage = %q{http://github.com/josei/lighrdf}
   s.post_install_message = %q{**Remember to install raptor RDF tools and (optionally for RDF PNG output) Graphviz**}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Lightrdf", "--main", "README.rdoc"]

data/test/test_lightrdf.rb

@@ -1,12 +1,27 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
 
-class TestLightRDF < Test::Unit::TestCase
+Namespace :ex,   'http://www.example.com/ontology#'
+Namespace :foaf, 'http://xmlns.com/foaf/0.1/'
+
+module Foaf
+  class Person
+    include RDF::NodeProxy
+
+    # Adds 1 year to the person's age
+    def happy_birthday!
+      foaf::age = (foaf::age.first.to_i + 1).to_s
+    end
+  end
+end
 
-  def setup
-    Namespace :ex,   'http://www.example.com/ontology#'
-    Namespace :foaf, 'http://xmlns.com/foaf/0.1/'
-  end
-  
+module Foaf
+  class Thing
+    include RDF::NodeProxy
+    maps 'http://xmlns.com/foaf/0.1/Agent'
+  end
+end
+
+class TestLightRDF < Test::Unit::TestCase
   def test_equality
    assert Node('_:something') == Node(Node('_:something'))
    assert ID('_:2') == ID('_:2')
@@ -167,4 +182,39 @@ foaf: http://xmlns.com/foaf/0.1/
     # Check if the added context is there
     assert contexts.include?("http://test_repository_contexts.org")
   end
+
+  def test_instantiation
+    assert_equal Node("foaf:Person"), Foaf::Person.new.rdf::type.first
+    assert_equal Node("foaf:Agent"),  Foaf::Thing.new.rdf::type.first
+
+    person_node = Node(nil)
+    person_node.foaf::age = "19"
+    person = Foaf::Person.new(person_node)
+    assert_equal ["19"], person.foaf::age 
+  
+    person = Foaf::Person.new('foaf:age'=>"25", 'rdf:type'=>Node('rdf:Resource'))
+    person.happy_birthday!
+    assert_equal ["26"], person.foaf::age
+    assert_equal Node("foaf:Person"), person.rdf::type.first
+  end
+
+  def test_graph_instantiation
+    graph       = RDF::Graph.new
+    person_node = Node(nil)
+    person_node.rdf::type = Node('foaf:Person')
+    person_node.foaf::age = "25"
+    graph << person_node
+
+    person = graph.node(person_node)
+    person.happy_birthday!
+    assert_equal ["26"], person.foaf::age
+  end
+
+  def test_instance_equality
+    node   = Node(nil)
+    node.foaf::age = "25"
+    person1 = Foaf::Person.new(node)
+    person2 = Foaf::Person.new(node)
+    assert_equal person1.id, person2.id
+  end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 9
-  version: 0.1.9
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jose Ignacio
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-18 00:00:00 +01:00
+date: 2011-03-03 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -71,6 +71,7 @@ extra_rdoc_files:
 - lib/lightrdf.rb
 - lib/lightrdf/graph.rb
 - lib/lightrdf/node.rb
+- lib/lightrdf/node_proxy.rb
 - lib/lightrdf/parser.rb
 - lib/lightrdf/repository.rb
 - lib/lightrdf/id.rb
@@ -83,6 +84,7 @@ files:
 - lib/lightrdf.rb
 - lib/lightrdf/graph.rb
 - lib/lightrdf/node.rb
+- lib/lightrdf/node_proxy.rb
 - lib/lightrdf/parser.rb
 - lib/lightrdf/repository.rb
 - lib/lightrdf/id.rb