pius-dm-semantic 0.0.2

data/README.markdown

@@ -0,0 +1,82 @@
+DM-Semantic Release 0.0.2 (January 8th 2009) 
+===================================
+
+**Git**:  [http://github.com/pius/dm-semantic](http://github.com/pius/dm-semantic)   
+**Author**:    Pius Uzamere, The Uyiosa Corporation
+
+**Copyright**: 2009
+
+
+SYNOPSIS
+--------
+
+DM-Semantic is a plugin for DataMapper that will allow you to seamlessly export your data models as OWL ontologies and expose your data as RDF.
+
+
+FEATURE LIST
+------------
+                                                                              
+1. **Import and Export RDF Data Directly From Your Models**: DM-Semantic adds a special DataMapper Type called RDFGraph.  You can add properties with this type to your DataMapper models and transparently load and dump RDF triples to your models (in Ntriples form.)  Let your data do more for you by manipulating it as RDF so that you can mash it up with other data sources and inference across the data.
+
+USAGE
+-----
+
+1. **Install the Gem**
+
+Make sure you've upgraded to at least RubyGems 1.2.  Then, if you've never installed a gem from GitHub before then do this:
+
+  > gem sources -a http://gems.github.com (you only have to do this once)
+
+Then:
+
+  > sudo gem install pius-dm-semantic
+
+2. **Make Sure You've Got the Dependencies installed**
+
+DM-Semantic depends on Reddy (http://github.com/tommorris/reddy).
+
+  > sudo gem install reddy
+
+3. **Require the gem and include it in your DataMapper models**
+
+To use the special RDFGraph type, create a property with the type in your model.  For example:
+
+  > property :graph, RDFGraph
+  
+4.  Now, you can use RDF in your model.  For example:
+
+>> c = Concept.new(:slug => "pius", :graph => "<http://pius.github.com#me> <http://xmlns.com/foaf/0.1/name> \"Pius Uzamere\" . 
+<http://pius.github.com#me> <http://xmlns.com/foaf/0.1/homepage> \"Pius Uzamere\" .")
+=> #<Concept id=nil slug="pius" graph="<http://pius.github.com#me> <http://xmlns.com/foaf/0.1/name> \"Pius Uzamere\" . \n<http://pius.github.com#me> <http://xmlns.com/foaf/0.1/homepage> \"Pius Uzamere\" .">
+>> c.save
+ ~ (0.000087) SELECT "id", "slug" FROM "concepts" WHERE ("slug" = 'pius') ORDER BY "id", "slug" LIMIT 1
+ ~ (0.002364) INSERT INTO "concepts" ("graph", "slug") VALUES ('<http://pius.github.com#me> <http://xmlns.com/foaf/0.1/name> "Pius Uzamere" . 
+<http://pius.github.com#me> <http://xmlns.com/foaf/0.1/homepage> "Pius Uzamere" .', 'pius')
+=> true
+>> exit
+
+Then, later:
+
+>> c = Concept.first
+ ~ (0.000086) SELECT "id", "slug" FROM "concepts" ORDER BY "id", "slug" LIMIT 1
+=> #<Concept id=4 slug="pius" graph=<not loaded>>
+>> c.graph
+ ~ (0.000084) SELECT "graph", "id", "slug" FROM "concepts" WHERE ("id" = 4) AND ("slug" = 'pius') ORDER BY "id", "slug"
+=> #<Reddy::Graph:0x2742a3c @nsbinding={}, @triples=[[#<Reddy::URIRef:0x274262c @uri=#<Addressable::URI:0x13a0d1c URI:http://pius.github.com#me>, #<Reddy::URIRef:0x27415b0 @uri=#<Addressable::URI:0x13a03da URI:http://xmlns.com/foaf/0.1/name>, #<Reddy::Literal:0x27404f8 @encoding=<theReddy::TypeLiteral::Encoding::Null>, contents"Pius Uzamere"], [#<Reddy::URIRef:0x2742690 @uri=#<Addressable::URI:0x13a0024 URI:http://pius.github.com#me>, #<Reddy::URIRef:0x273fc10 @uri=#<Addressable::URI:0x139fc5a URI:http://xmlns.com/foaf/0.1/homepage>, #<Reddy::Literal:0x273f670 @encoding=<theReddy::TypeLiteral::Encoding::Null>, contents"Pius Uzamere"]]
+>> 
+
+
+4. **Read the documentation**
+
+It's YARD.  It's sexy.
+
+5. **Contribute!**
+
+Fork my repository (http://github.com/pius/dm-semantic), make some changes, and send along a pull request!
+                                                                              
+
+COPYRIGHT
+---------                                                                 
+
+DM-Semantic was created in 2008 by Pius Uzamere (pius -AT- alum -DOT- mit -DOT- edu) and is    
+licensed under the MIT license.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'spec'
+require 'rake/clean'
+require 'spec/rake/spectask'
+require 'pathname'
+
+task :default => [ :spec ]
+
+desc 'Run specifications'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts << '--options' << 'spec/spec.opts' if File.exists?('spec/spec.opts')
+  t.spec_files = Pathname.glob(Pathname.new(__FILE__).dirname + 'spec/**/*_spec.rb')
+ 
+  begin
+    t.rcov = ENV.has_key?('NO_RCOV') ? ENV['NO_RCOV'] != 'true' : true
+    t.rcov_opts << '--exclude' << 'spec'
+    t.rcov_opts << '--text-summary'
+    t.rcov_opts << '--sort' << 'coverage' << '--sort-reverse'
+  rescue Exception
+    # rcov not installed
+  end
+end

data/dm-semantic.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name = "dm-semantic"
+  s.version = "0.0.2"
+  s.date = "2009-01-08"
+  s.summary = "DM-Semantic is a DataMapper plugin for adding semantic capabilities to models."
+  s.email = "pius+github@alum.mit.edu"
+  s.homepage = "http://github.com/pius/dm-semantic"
+  s.description = "DM-Semantic is a DataMapper plugin for adding semantic capabilities to models."
+  s.has_rdoc = true
+  s.authors = ["Pius Uzamere"]
+  s.files = ["README.markdown", "Rakefile", "dm-semantic.gemspec", "lib/dm-semantic.rb", "lib/dm-semantic/functions.rb", "lib/dm-semantic/model.rb", "lib/dm-semantic/types.rb"]
+  s.test_files = ["spec/spec_helper.rb"]
+  #s.rdoc_options = ["--main", "README.txt"]
+  #s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
+  s.add_dependency("dm-types", ["> 0.9.6"])
+  s.add_dependency("reddy", ["> 0.0.1"])
+end

data/lib/dm-semantic.rb

@@ -0,0 +1,26 @@
+require 'pathname'
+require 'rubygems'
+
+gem 'dm-core', '~>0.9.8'
+require 'dm-core'
+
+gem 'reddy'
+require 'reddy'
+
+class Pathname
+  def /(path)
+    (self + path).expand_path
+  end
+end # class Pathname
+
+dir = Pathname(__FILE__).dirname.expand_path / 'dm-semantic'
+
+require dir / 'functions'
+require dir / 'model'
+
+module DataMapper
+  module Types
+    dir = (Pathname(__FILE__).dirname.expand_path / 'dm-semantic/types' ).to_s
+    autoload :RDFGraph, dir / 'rdf_graph'
+  end
+end

data/lib/dm-semantic/functions.rb

@@ -0,0 +1,173 @@
+module DataMapper
+  module Semantic
+      module ClassMethods
+        
+        # property :id,                         Serial
+        # property :login,                      String,   :nullable => false, :length => 3..40, :unique => true
+        # property :email,                      String,   :nullable => false, :unique => true
+        # property :created_at,                 DateTime
+        # property :updated_at,                 DateTime
+        # property :activated_at,               DateTime
+        # property :activation_code,            String
+        # property :crypted_password,           String
+        # property :salt,                       String
+        # property :remember_token_expires_at,  DateTime
+        # property :remember_token,             String
+        # property :password_reset_key,         String, :writer => :protected
+        
+        # Triple.new(:User, is_a, FOAF:Person)
+        # Triple.new(:id, rdf:datatype, :integer)
+        # Triple.new(:login, rdf:datatype, :string)
+
+        ## 
+        # Returns a hash of the ontologies to which the model is mapped, along with their authoritative URIs.
+        #
+        # ==== Example
+        #   Person.ontologies # returns {:foaf => "http://xmlns.com/foaf/spec/"}
+        #   Person.ontologies(:rdf) # returns {:foaf => "http://xmlns.com/foaf/spec/index.rdf"}
+        #
+        # @param [Symbol] format format of the ontology to which the URI points (:rdf, :turtle, or :json).  Defaults to :rdf
+        #
+        # ==== Returns
+        # @return [String] the OWL ontology in the requested format.
+        #
+        # @author Pius Uzamere
+        #---
+        # @public
+
+        def ontologies(format = :rdf)
+          raise "Not Yet Implemented"
+        end
+        
+        ## 
+        # Export the entire class definition as an OWL ontology.
+        #
+        # ==== Example
+        #   Person.to_owl # returns string representation of the OWL ontology in Turtle.
+        #   Person.to_owl(:json) # returns string representation of the OWL ontology in RDF-JSON.
+        #
+        # @param [Symbol] format format of the OWL-RDF output (:xml, :turtle, or :json).  Defaults to :turtle
+        # ==== Rules for creating the ontology
+        # The class itself will be represented by a b-node.
+        #
+        # ==== Returns
+        # @return [String] the OWL ontology in the requested format.
+        #
+        # @author Pius Uzamere
+        #---
+        # @public
+
+        def to_owl(*args)
+          g = Graph.new
+          owl = Namespace.new('http://www.w3.org/2002/07/owl', 'owl', true)
+          foaf = Namespace.new("http://xmlns.com/foaf/0.1/", "foaf")
+          rdf = Namespace.new("http://www.w3.org/1999/02/22-rdf-syntax-ns", "rdf", true)
+          rdfs = Namespace.new("http://www.w3.org/2000/01/rdf-schema", 'rdfs', true)
+          xsd = Namespace.new('http://www.w3.org/2001/XMLSchema', 'xsd', true)
+  
+          for property in properties
+            g << Triple.new(BNode.new('john'), foaf.knows, BNode.new('jane'))
+          end
+          return g
+        end
+        
+        ## 
+        # Create the basic OWL triples for the class, without the properties.
+        #
+        # ==== Example
+        #   Person.triple_for_class_definition # returns a graph of the triples representing the bare class in OWL.
+        #
+        # ==== Rules for creating the ontology
+        # The class itself will be represented by a b-node.
+        #
+        # ==== Returns
+        # @return [Graph] graph of the OWL triples for the bare class.
+        #
+        # @author Pius Uzamere
+        #---
+        # @public
+        
+        def triples_for_class_definition
+          declare_namespaces
+          g = Graph.new
+          b = BNode.new(self.name)
+          g << Triple.new(b, URIRef.new('http://www.w3.org/1999/02/22-rdf-syntax-ns#type'), URIRef.new('http://www.w3.org/2002/07/owl#Class'))
+          return g
+        end
+        
+        ## 
+        # Create the OWL triples for a DataMapper property.
+        #
+        # ==== Example
+        #   Person.triples_for_property(Person.properties[:id]) # returns a graph of the triples representing the id property on Person in OWL.
+        #
+        #
+        # ==== Returns
+        # @return [Graph] graph of the OWL triples for the property.
+        #
+        # @author Pius Uzamere
+        #---
+        # @public
+        
+        def triples_for_property(property)
+          g = Graph.new
+          b = BNode.new(property.field)
+          t = Triple.new(b, URIRef.new('http://www.w3.org/1999/02/22-rdf-syntax-ns#type'), URIRef.new('http://www.w3.org/2002/07/owl#DatatypeProperty'))
+          g << t
+          return g
+        end
+        
+        protected
+        
+        ## 
+        # Utility method to declare a bunch of useful namespaces.
+        #
+        # ==== Example
+        #   Person.declare_namespaces # instantiates some useful namespaces.
+        #
+        # @author Pius Uzamere
+        #---
+        # @protected
+        
+        def declare_namespaces
+          foaf = Namespace.new("http://xmlns.com/foaf/0.1/", "foaf")
+          rdf = Namespace.new("http://www.w3.org/1999/02/22-rdf-syntax-ns", "rdf", true)
+          rdfs = Namespace.new("http://www.w3.org/2000/01/rdf-schema", 'rdfs', true)
+          xsd = Namespace.new('http://www.w3.org/2001/XMLSchema', 'xsd', true)
+          owl = Namespace.new('http://www.w3.org/2002/07/owl', 'owl', true)
+        end
+        
+    end
+
+    
+    module InstanceMethods
+        
+        ## 
+        # Export a representation of the instance in RDF.
+        #
+        # ==== Example
+        #   Friend.first.to_rdf # returns the first Friend model instance in RDF using its ontology
+        #
+        # @param [Symbol] format format of the OWL-RDF output (:xml, :turtle, or :json).  Defaults to :turtle
+        #
+        # ==== Returns
+        # @return [String] the RDF representation in the requested serialization format.
+        #
+        # @author Pius Uzamere
+        #---
+        # @public
+        
+         def to_rdf(format = :xml)
+           raise "not yet implemented"
+         end
+    end
+    
+    private
+    
+    def self.included(receiver)
+      receiver.extend(ClassMethods)
+      receiver.send :include, InstanceMethods
+    end
+    
+  end
+end

data/lib/dm-semantic/model.rb

@@ -0,0 +1,9 @@
+module DataMapper
+  module Model
+    include DataMapper::Semantic
+    # 
+    # private
+    # 
+    # sample function here
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'pathname'
+
+gem 'dm-core', '=0.9.3'
+require 'dm-core'
+
+spec_dir_path = Pathname(__FILE__).dirname.expand_path
+require spec_dir_path.parent + 'lib/dm-semantic'
+
+def load_driver(name, default_uri)
+  return false if ENV['ADAPTER'] != name.to_s
+
+  lib = "do_#{name}"
+
+  begin
+    gem lib, '=0.9.3'
+    require lib
+    DataMapper.setup(name, ENV["#{name.to_s.upcase}_SPEC_URI"] || default_uri)
+    DataMapper::Repository.adapters[:default] =  DataMapper::Repository.adapters[name]
+    true
+  rescue Gem::LoadError => e
+    warn "Could not load #{lib}: #{e}"
+    false
+  end
+end
+
+ENV['ADAPTER'] ||= 'sqlite3'
+
+HAS_SQLITE3  = load_driver(:sqlite3,  'sqlite3::memory:')
+HAS_MYSQL    = load_driver(:mysql,    'mysql://localhost/dm_core_test')
+HAS_POSTGRES = load_driver(:postgres, 'postgres://postgres@localhost/dm_core_test')
+
+
+# require fixture resources
+Dir[spec_dir_path + "fixtures/*.rb"].each do |fixture_file|
+  require fixture_file
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: pius-dm-semantic
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Pius Uzamere
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-08 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-types
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.9.6
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: reddy
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.1
+    version: 
+description: DM-Semantic is a DataMapper plugin for adding semantic capabilities to models.
+email: pius+github@alum.mit.edu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- Rakefile
+- dm-semantic.gemspec
+- lib/dm-semantic.rb
+- lib/dm-semantic/functions.rb
+- lib/dm-semantic/model.rb
+- lib/dm-semantic/types.rb
+has_rdoc: true
+homepage: http://github.com/pius/dm-semantic
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: DM-Semantic is a DataMapper plugin for adding semantic capabilities to models.
+test_files: 
+- spec/spec_helper.rb