dowl 0.2

data/CHANGES

@@ -0,0 +1 @@
+Changes

data/README

@@ -0,0 +1,19 @@
+A simple command-line tool for generating HTML documentation from RDFS/OWL schemas
+
+INSTALLATION
+
+Once you have the code checked out simple do:
+
+rake install
+
+To install the dowl gem. This will give you a new command-line application called dowl.
+
+The application takes two parameters. The first parameter is the location of the schema file to parse (currently in Turtle only) the second parameter is option and is the location of an ERB file that contains the template for output. A default template is provided and can be customized for specific purposes.
+
+The script sends its output to STDOUT so just pipe it into a file.
+
+E.g:
+
+dowl examples/example.ttl >/tmp/example.html
+
+The script will automatically include the contents of introduction.html, if found in the same directory as the schema, into the documentation. This file should contain an HTML fragment.

data/Rakefile

@@ -0,0 +1,64 @@
+require 'rake'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+require 'rake/clean'
+
+NAME = "dowl"
+VER = "0.2"
+
+RDOC_OPTS = ['--quiet', '--title', 'dowl Reference', '--main', 'README']
+
+PKG_FILES = %w( README Rakefile CHANGES ) + 
+  Dir.glob("{bin,doc,tests,examples,lib}/**/*")
+
+CLEAN.include ['*.gem', 'pkg']  
+SPEC =
+  Gem::Specification.new do |s|
+    s.name = NAME
+    s.version = VER
+    s.platform = Gem::Platform::RUBY
+    s.required_ruby_version = ">= 1.8.5"    
+    s.has_rdoc = true
+    s.extra_rdoc_files = ["README", "CHANGES"]
+    s.rdoc_options = RDOC_OPTS
+    s.summary = "dowl OWL/RDF doc generator"
+    s.description = s.summary
+    s.author = "Leigh Dodds"
+    s.email = 'leigh.dodds@talis.com'
+    s.homepage = 'http://github.com/ldodds/dowl'
+    s.files = PKG_FILES
+    s.require_path = "lib" 
+    s.bindir = "bin"
+    s.executables = ["dowl"]
+    s.test_file = "tests/ts_dowl.rb"
+    s.add_dependency("mocha", ">= 0.9.5")
+    s.add_dependency("rdf-raptor", ">= 0.4.0")
+  end
+      
+Rake::GemPackageTask.new(SPEC) do |pkg|
+    pkg.need_tar = true
+end
+
+Rake::RDocTask.new do |rdoc|
+    rdoc.rdoc_dir = 'doc/rdoc'
+    rdoc.options += RDOC_OPTS
+    rdoc.rdoc_files.include("README", "CHANGES", "lib/**/*.rb")
+    rdoc.main = "README"
+    
+end
+
+Rake::TestTask.new do |test|
+  test.test_files = FileList['tests/tc_*.rb']
+end
+
+desc "Install from a locally built copy of the gem"
+task :install do
+  sh %{rake package}
+  sh %{sudo gem install pkg/#{NAME}-#{VER}}
+end
+
+desc "Uninstall the gem"
+task :uninstall => [:clean] do
+  sh %{sudo gem uninstall #{NAME}}
+end

data/bin/dowl

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'rubygems'
+require 'getoptlong'
+require 'rdf/redland'
+require 'dowl'
+require 'erb'
+
+PROGRAM     = File::basename $0
+
+schema = DOWL::Schema.create_from_file(ARGV[0])
+if ARGV[1]
+  generator = DOWL::Generator.new( schema, ARGV[1] )
+else
+  generator = DOWL::Generator.new( schema )
+end
+file = generator.run()
+puts file

data/examples/example.ttl

@@ -0,0 +1,73 @@
+#General Namespaces
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#>.
+@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>.
+@prefix owl: <http://www.w3.org/2002/07/owl#>.
+@prefix foaf: <http://xmlns.com/foaf/0.1/>.
+@prefix dcterms: <http://purl.org/dc/terms/>.
+@prefix dctypes: <http://purl.org/dc/dcmitype/>.
+@prefix vs: <http://www.w3.org/2003/06/sw-vocab-status/ns#> .
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#>.
+@prefix ex: <http://www.example.org/dowl/>.
+
+############################################################################
+# General description of the schema
+############################################################################
+
+<http://www.example.org/dowl/>
+	a owl:Ontology;
+	dcterms:title "An Example"@en ;
+	rdfs:comment "This is a simple example"@en ;
+	foaf:maker <http://www.ldodds.com#me> ;
+	foaf:maker <http://www.example.org/unknown> ;	
+	dcterms:created "2010-02-19"^^xsd:date ;
+	dcterms:modified "2010-09-28"^^xsd:date .
+	
+<http://www.ldodds.com#me> a foaf:Person ;
+	foaf:name "Leigh Dodds" .
+
+<http://www.example.org/unknown> a foaf:Person .
+
+############################################################################
+# Classes
+############################################################################
+
+ex:SomeClass
+	a owl:Class;
+    rdfs:label "Some Class"@en;
+    rdfs:comment "A Class of Things."@en;
+	rdfs:seeAlso <http://en.wikipedia.org/>;
+    vs:term_status "testing".
+
+ex:DerivedClass
+	a owl:Class;
+	rdfs:subClassOf ex:SomeClass;
+    rdfs:label "Derived"@en;
+	rdfs:comment "A Derived Class"@en ;
+	rdfs:seeAlso <http://www.google.com>;
+    vs:term_status "testing".
+	
+############################################################################
+# Object Properties
+############################################################################
+
+ex:objectProperty
+	a owl:ObjectProperty;
+	rdfs:label "object property"@en;
+	rdfs:comment "associates Some Class with another thing"@en;
+	rdfs:range ex:SomeClass;
+	rdfs:domain ex:SomeClass;
+	vs:term_status "testing".	
+
+############################################################################
+# Datatype Properties
+############################################################################
+
+ex:datatypeProperty
+	a owl:DatatypeProperty;
+	rdfs:label "datatype property"@en;
+	rdfs:comment "a datatype property"@en;
+	rdfs:range xsd:string;
+	rdfs:domain ex:DerivedClass;
+	vs:term_status "testing".
+	
+

data/examples/introduction.html

@@ -0,0 +1,5 @@
+<h2>Introduction</h2>
+
+<p>
+Contents of introduction.html in the same directory is automatically included.
+</p>

data/lib/dowl.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'erb'
+require 'rdf'
+require 'rdf/raptor'
+require 'dowl/util'
+require 'dowl/schema'
+require 'dowl/class'
+require 'dowl/property'
+require 'dowl/ontology'
+require 'dowl/generator'
+
+module DOWL
+      
+  class Namespaces
+
+    OWL = RDF::Vocabulary.new("http://www.w3.org/2002/07/owl#")    
+    RDFS = RDF::RDFS    
+    VS = RDF::Vocabulary.new("http://www.w3.org/2003/06/sw-vocab-status/ns#")    
+    DCTERMS = RDF::Vocabulary.new("http://purl.org/dc/terms/")
+    FOAF = RDF::Vocabulary.new("http://xmlns.com/foaf/0.1/")
+        
+  end
+
+end

data/lib/dowl/class.rb

@@ -0,0 +1,56 @@
+module DOWL
+  
+  class Class < DOWL::LabelledDocObject
+    include Comparable
+    
+    attr_reader :resource
+    
+    def initialize(resource, schema)
+      super(resource, schema)
+    end
+    
+    def uri
+      return @resource.uri.to_s
+    end
+    
+    def sub_class_of()
+      parent = @schema.model.first_value( 
+        RDF::Query::Pattern.new( @resource, DOWL::Namespaces::RDFS.subClassOf ) )
+      if parent
+        uri = parent.to_s
+        if @schema.classes[uri]
+          return @schema.classes[uri]
+        else
+          return uri
+        end
+      end
+      return nil
+    end
+   
+    def see_alsos()
+       links = []
+       @schema.model.query( 
+         RDF::Query::Pattern.new( @resource, DOWL::Namespaces::RDFS.seeAlso ) ) do |statement|
+         links << statement.object.to_s
+       end
+       return links
+    end
+    
+    def to_s
+      return short_name
+    end
+    
+    def sub_classes()
+      list = []
+        
+      @schema.model.query(
+        RDF::Query::Pattern.new( nil, DOWL::Namespaces::RDFS.subClassOf, @resource) ) do |statement|
+          list << DOWL::Class.new(statement.subject, @schema)
+      end
+      return list
+    end
+    
+  end
+  
+  
+end

data/lib/dowl/default.erb

@@ -0,0 +1,226 @@
+<html>
+	<head>
+		<title><%= schema.ontology.title %></title>
+	</head>
+	<body>
+		<h1><%= schema.ontology.title %></h1>
+		
+		<dl>
+		  <dt>Latest Version</dt>
+		  <dd><a href="<%= schema.ontology.uri %>"><%= schema.ontology.uri %></a></dd>
+		  <% if schema.ontology.created %>
+		  	<dt>Created</dt>
+		  	<dd><%= schema.ontology.created %></dd>
+		  <% end %>
+		  <% if schema.ontology.modified %>		  	
+		  	<dt>Last Modified</dt>
+		  	<dd><%= schema.ontology.modified %></dd>
+		  <% end %>		  		  
+		  <dt>Authors</dt>
+		  <% schema.ontology.authors.each do |author| %><dd><a href="<%= author.uri %>"><%= author.name %></a></dd><%end%>
+		</dl>
+		
+		<h1>Abstract</h1>
+		
+			<%= schema.ontology.comment %>
+		
+		<% if introduction %>
+		<%= introduction %>
+		<% end %>
+		
+		<div id="overview">
+			<h2>Overview Of Terms</h2>		
+			<p>An alphabetical index of the ontology terms, divided into classes, properties and individuals. All the terms are hyperlinked to their 
+			detailed description for quick reference.
+			</p>
+			
+			<p><strong>Classes</strong>:
+			 <% schema.list_classes().each do |key,val| %>
+			 | <a href="#class_<%= val.short_name %>"><%= val.short_name %></a>
+			 <% end %>		
+			</p>
+			<p><strong>Properties</strong>:
+			 <% schema.list_properties().each do |key,val| %>
+			 | <a href="#prop_<%= val.short_name %>"><%= val.short_name %></a>
+			 <% end %>
+			</p>				
+		</div>
+		
+		<div id="terms">
+			<h2>Ontology Terms</h2>
+		</div>
+		
+		<div id="classes">
+			<h3>Classes</h3>
+			
+	   		<%schema.list_classes().each do |t| %>
+	   			<div class="term" id="class_<%= t[1].short_name %>">	   			
+	   				<h4>Class: <%= t[1].short_name %></h4>
+	   				<table>
+	   				<tr><td class="label">Label</td><td><%= t[1].label %> </ts></tr>
+	   				<tr><td class="label">Status</td><td><%= t[1].status %> </ts></tr>
+	   				<% if t[1].sub_class_of %>
+	   					<% if t[1].sub_class_of.class.to_s == "String" %>	   				
+	   						<tr><td class="label">Has Parent Class</td><td><a href="<%= t[1].sub_class_of %>"><%= t[1].sub_class_of %></a></td></tr>
+	   					<% else %>
+	   						<tr><td class="label">Has Parent Class</td><td><a href="#class_<%= t[1].sub_class_of.short_name %>"><%= t[1].sub_class_of.short_name %></a></td></tr>
+	   					<% end %>
+	   				<% end %>
+	   				<% if t[1].sub_classes.length > 0 %>
+						<tr>
+							<td class="label">Sub-Classes</td>
+							<td>
+								<% t[1].sub_classes.each do |child| %>
+									<a href="#class_<%= child.short_name %>"><%= child.short_name %></a>
+								<% end %>
+							</td>
+						</tr>
+	   				<% end %>	   				
+	   				</table>	   				   				
+	   				<p><%= t[1].comment %> </p>
+	   				<% if t[1].see_alsos.length > 0 %>
+		   				<p><em>Further Reading:</em></p>
+		   				<ul>	   			
+	   						<% t[1].see_alsos.each do |link| %>
+	   						<li><a href="<%= link %>"><%= link %></a></li>
+	   						<% end %>
+	   					</ul>
+	   				<% end %>
+	   			</div>
+	  		<%end%>		
+		
+		</div>
+		
+		<div id="properties">
+			<h3>Object Properties</h3>
+	
+	   		<% schema.list_object_properties().each do |t| %>
+	   			<div class="term" id="prop_<%= t[1].short_name %>">
+	   				<h4>Property: <%= t[1].short_name %></h4>
+	   				<table>
+	   					<tr><td class="label">Label</td><td><%= t[1].label %> </ts></tr>
+		   				<tr><td class="label">Status</td><td><%= t[1].status %> </ts></tr>
+		   				<% if t[1].sub_property_of %>
+		   					<% if t[1].sub_property_of.class.to_s == "String" %>	   				
+		   						<tr><td class="label">Has Parent Property</td><td><a href="<%= t[1].sub_property_of %>"><%= t[1].sub_property_of %></a></td></tr>
+		   					<% else %>
+		   						<tr><td class="label">Has Parent Property</td><td><a href="#prop_<%= t[1].sub_property_of.short_name %>"><%= t[1].sub_property_of.short_name %></a></td></tr>
+		   					<% end %>
+		   				<% end %>
+		   				<% if t[1].sub_properties.length > 0 %>
+							<tr>
+								<td class="label">Sub-Properties</td>
+								<td>
+									<% t[1].sub_properties.each do |child| %>
+										<a href="#class_<%= child.short_name %>"><%= child.short_name %></a>
+									<% end %>
+								</td>
+							</tr>
+		   				<% end %>		   				
+		   				<% if t[1].range.length > 0 %>
+		   					<tr><td class="label">Range</td>
+		   					<td>
+		   					<% t[1].range.each do |cls| %>
+		   						<% if cls.class.to_s == "String" %>
+		   						<a href="<%= cls %>"><%= cls %></a>
+		   						<% else %>
+		   						<a href="#class_<%= cls.short_name %>"><%= cls.short_name %></a>
+		   						<% end %>
+		   					<% end %>		   				
+		   					</td>
+		   					</tr>
+		   				<% end %>
+		   				<% if t[1].domain.length > 0 %>
+		   					<tr><td class="label">Domain</td>
+		   					<td>
+		   					<% t[1].domain.each do |cls| %>
+		   						<% if cls.class.to_s == "String" %>
+		   						<a href="<%= cls %>"><%= cls %></a>
+		   						<% else %>
+		   						<a href="#class_<%= cls.short_name %>"><%= cls.short_name %></a>
+		   						<% end %>
+		   					<% end %>		   				
+		   					</td>
+		   					</tr>
+		   				<% end %>		   				
+	   				</table>	   				
+	   				<p><%= t[1].comment %> </p>
+	   				<% if t[1].see_alsos.length > 0 %>
+		   				<p><em>Further Reading:</em></p>
+		   				<ul>	   			
+	   						<% t[1].see_alsos.each do |link| %>
+	   						<li><a href="<%= link %>"><%= link %></a></li>
+	   						<% end %>
+	   					</ul>
+	   				<% end %>
+	   			</div>
+	  		<%end%>		
+		
+					
+			<h3>Datatype Properties</h3>
+	
+	   		<%schema.list_datatype_properties().each do |t| %>
+	   			<div class="term" id="prop_<%= t[1].short_name %>">
+	   				<h4>Property: <%= t[1].short_name %></h4>
+	   				<table>
+						<tr><td class="label">Label</td><td><%= t[1].label %> </ts></tr>	   				
+		   				<tr><td class="label">Status</td><td><%= t[1].status %> </ts></tr>
+		   				<% if t[1].sub_property_of %>
+		   					<% if t[1].sub_property_of.class.to_s == "String" %>	   				
+		   						<tr><td class="label">Has Parent Property</td><td><a href="<%= t[1].sub_property_of %>"><%= t[1].sub_property_of %></a></td></tr>
+		   					<% else %>
+		   						<tr><td class="label">Has Parent Property</td><td><a href="#prop_<%= t[1].sub_property_of.short_name %>"><%= t[1].sub_property_of.short_name %></a></td></tr>
+		   					<% end %>
+		   				<% end %>
+		   				<% if t[1].sub_properties.length > 0 %>
+							<tr>
+								<td class="label">Sub-Properties</td>
+								<td>
+									<% t[1].sub_properties.each do |child| %>
+										<a href="#class_<%= child.short_name %>"><%= child.short_name %></a>
+									<% end %>
+								</td>
+							</tr>
+		   				<% end %>		   				
+		   				<% if t[1].range.length > 0 %>
+		   					<tr><td class="label">Range</td>
+		   					<td>
+		   					<% t[1].range.each do |cls| %>
+		   						<% if cls.class.to_s == "String" %>
+		   						<a href="<%= cls %>"><%= cls %></a>
+		   						<% else %>
+		   						<a href="#class_<%= cls.short_name %>"><%= cls.short_name %></a>
+		   						<% end %>
+		   					<% end %>		   				
+		   					</td>
+		   					</tr>
+		   				<% end %>
+		   				<% if t[1].domain.length > 0 %>
+		   					<tr><td class="label">Domain</td>
+		   					<td>
+		   					<% t[1].domain.each do |cls| %>
+		   						<% if cls.class.to_s == "String" %>
+		   						<a href="<%= cls %>"><%= cls %></a>
+		   						<% else %>
+		   						<a href="#class_<%= cls.short_name %>"><%= cls.short_name %></a>
+		   						<% end %>
+		   					<% end %>		   				
+		   					</td>
+		   					</tr>
+		   				<% end %>				
+	   				</table>	   				
+	   				<p><%= t[1].comment %> </p>
+	   				<% if t[1].see_alsos.length > 0 %>
+		   				<p><em>Further Reading:</em></p>
+		   				<ul>	   			
+	   						<% t[1].see_alsos.each do |link| %>
+	   						<li><a href="<%= link %>"><%= link %></a></li>
+	   						<% end %>
+	   					</ul>
+	   				<% end %>
+	   			</div>
+	  		<%end%>		
+				
+		</div>
+	</body>
+</html>

data/lib/dowl/generator.rb

@@ -0,0 +1,27 @@
+module DOWL
+
+  class Generator
+    
+    def initialize(schema, template=Generator.default_template())
+      @template = ERB.new(File.read(template))
+      @schema = schema
+      if schema.introduction
+        @introduction = File.read(schema.introduction)
+      end      
+    end
+    
+    def Generator.default_template()
+       dir = File.dirname( __FILE__ )
+       return default_template_file = File.join(dir, "default.erb")
+    end
+    
+    def run()      
+      b = binding
+      schema = @schema
+      introduction = @introduction
+      return @template.result(b)               
+    end
+    
+  end  
+  
+end

data/lib/dowl/ontology.rb

@@ -0,0 +1,64 @@
+require 'dowl'
+
+module DOWL
+  
+  class Person < DOWL::DocObject
+     def initialize(resource, schema)
+       super(resource, schema)
+     end
+     
+     def uri()
+       return @resource.to_s
+     end
+     
+     def name()
+       name = get_literal(DOWL::Namespaces::FOAF.name)
+       if name == nil
+         name = uri()
+       end
+       return name
+     end
+     
+     def <=>(other)
+       return name() <=> other.name()
+     end
+     
+  end
+  
+  class Ontology < DOWL::DocObject
+   
+    def initialize(resource, schema)
+        super(resource, schema)  
+    end
+    
+    def uri() 
+        return @resource.to_s
+    end
+    
+    def title()
+      return get_literal(DOWL::Namespaces::DCTERMS.title)
+    end
+    
+    def comment()
+      return get_literal(DOWL::Namespaces::RDFS.comment)
+    end
+        
+    def created()
+      return get_literal(DOWL::Namespaces::DCTERMS.created)
+    end
+
+    def modified()
+      return get_literal(DOWL::Namespaces::DCTERMS.modified)
+    end
+    
+    def authors()      
+      authors = []
+      @schema.model.query( 
+        RDF::Query::Pattern.new( @resource, DOWL::Namespaces::FOAF.maker ) ) do |statement|
+          authors << Person.new( statement.object, @schema )
+      end         
+      return authors.sort     
+    end
+    
+  end
+end

data/lib/dowl/property.rb

@@ -0,0 +1,81 @@
+require 'dowl'
+
+module DOWL
+  
+  class Property < DOWL::LabelledDocObject
+    
+    def initialize(resource, schema)
+      super(resource, schema)
+    end
+    
+    def see_alsos()
+       links = []
+       @schema.model.query(
+         RDF::Query::Pattern.new( @resource, DOWL::Namespaces::RDFS.seeAlso ) ) do |statement|
+         links << statement.object.to_s
+       end       
+       return links
+    end
+        
+    def sub_property_of()
+      parent = @schema.model.first_value(
+        RDF::Query::Pattern.new( @resource, DOWL::Namespaces::RDFS.subPropertyOf) )
+      if parent
+        uri = parent.to_s
+        if @schema.properties[uri]
+          return @schema.properties[uri]
+        else
+          return uri
+        end
+      end
+      return nil
+    end
+        
+    def range()
+      ranges = []
+      @schema.model.query(RDF::Query::Pattern.new( @resource, DOWL::Namespaces::RDFS.range ) ) do |statement|
+        ranges << statement.object
+      end  
+      classes = []
+      ranges.each do |o|
+        if o.resource?
+          uri = o.to_s        
+          if @schema.classes[uri]
+            classes << @schema.classes[uri]
+          else
+            classes << uri
+          end
+        end
+      end
+      return classes
+    end
+
+    def domain()
+      domains = []
+      @schema.model.query(RDF::Query::Pattern.new( @resource, DOWL::Namespaces::RDFS.domain ) ) do |statement|
+        domains << statement.object
+      end  
+      classes = []
+      domains.each do |o|
+        if o.resource?
+          uri = o.to_s         
+          if @schema.classes[uri]
+            classes << @schema.classes[uri]
+          else
+            classes << uri
+          end
+        end
+        #TODO union
+      end
+      return classes
+    end
+    
+    def sub_properties()
+      list = []
+      @schema.model.query(RDF::Query::Pattern.new( nil, DOWL::Namespaces::RDFS.subPropertyOf, @resource ) ) do |statement|
+        list << DOWL::Property.new( statement.subject, @schema )
+      end
+      return list
+    end            
+  end
+end

data/lib/dowl/schema.rb

@@ -0,0 +1,90 @@
+module DOWL
+  
+  #Utility class providing access to information about the schema, e.g. its description, lists of classes, etc
+  class Schema
+    
+    attr_reader :model
+    attr_reader :introduction
+    attr_reader :datatype_properties
+    attr_reader :object_properties
+    attr_reader :classes
+    
+    def initialize(model, introduction=nil)
+        @model = model
+        @introduction = introduction
+        init()
+    end
+    
+    def Schema.create_from_file(file=nil)
+      if file == nil
+        raise "Filename should be provided"
+      end
+      model = RDF::Graph.new(file)
+      model.load!
+      
+      dir = File.dirname(file)
+      introduction = File.join(dir, "introduction.html")
+      if File.exists?(introduction)
+        return Schema.new(model, introduction)
+      end      
+      return Schema.new(model)
+    end       
+    
+    def init()
+      @classes = Hash.new
+      init_classes( DOWL::Namespaces::OWL.Class )
+      init_classes( DOWL::Namespaces::RDFS.Class )
+      ontology = @model.first_subject( RDF::Query::Pattern.new( nil, RDF.type, DOWL::Namespaces::OWL.Ontology ) )
+      if ontology
+        @ontology = Ontology.new(ontology, self)
+      end
+      @datatype_properties = init_properties( DOWL::Namespaces::OWL.DatatypeProperty)      
+      @object_properties = init_properties( DOWL::Namespaces::OWL.ObjectProperty)
+    end
+    
+    def ontology()
+      return @ontology  
+    end
+    
+    def init_classes(type)
+      @model.query( RDF::Query::Pattern.new( nil, RDF.type, type ) ) do |statement|
+        if !statement.subject.anonymous?
+            cls = DOWL::Class.new(statement.subject, self)
+            @classes[ statement.subject.to_s ] = cls                    
+        end
+      end      
+    end
+    
+    def init_properties(type)
+      properties = Hash.new
+      @model.query( RDF::Query::Pattern.new( nil, RDF.type, type ) ) do |statement|
+        properties[ statement.subject.to_s] = DOWL::Property.new(statement.subject, self)
+      end      
+      return properties      
+    end
+    
+    def properties()
+      return @datatype_properties.merge( @object_properties )     
+    end
+    
+    def list_properties()
+      return properties().sort { |x,y| x[1] <=> y[1] }          
+    end
+    
+    def list_datatype_properties()
+      return datatype_properties().sort { |x,y| x[1] <=> y[1] }
+    end
+    
+    def list_object_properties()
+      return object_properties().sort { |x,y| x[1] <=> y[1] }
+    end    
+    
+    #Return sorted, nested array
+    def list_classes()
+      sorted = classes().sort { |x,y| x[1] <=> y[1] }
+      return sorted      
+    end
+    
+  end  
+  
+end

data/lib/dowl/util.rb

@@ -0,0 +1,47 @@
+module DOWL
+  
+  class DocObject
+    attr_reader :resource
+    attr_reader :schema  
+    def initialize(resource, schema)
+      @resource = resource
+      @schema = schema
+    end  
+    
+    def get_literal(property)
+      return @schema.model.first_value(RDF::Query::Pattern.new( @resource, property ) )
+    end
+    
+  end
+  
+  class LabelledDocObject < DOWL::DocObject
+    
+    def initialize(resource, schema)
+       super(resource, schema)
+    end
+     
+    def short_name()
+      uri = @resource.to_s
+      ontology_uri = @schema.ontology.uri
+      return uri.gsub(ontology_uri, "")
+    end
+     
+    def label()
+      return get_literal(DOWL::Namespaces::RDFS.label)
+    end
+        
+    def comment()
+      return get_literal(DOWL::Namespaces::RDFS.comment)
+    end
+    
+    def status()      
+      return get_literal(DOWL::Namespaces::VS.status)
+    end
+         
+    def <=>(other)
+      return label().downcase <=> other.label().downcase
+    end    
+    
+  end
+  
+end

data/tests/tc_ontology.rb

@@ -0,0 +1,41 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'dowl'
+require 'test/unit'
+
+class OntologyTest < Test::Unit::TestCase
+  
+  def setup
+    file = "examples/example.ttl"
+    @schema = DOWL::Schema.create_from_file(File.expand_path(file))         
+  end
+  
+  def test_get_title
+    assert_equal( "An Example", @schema.ontology.title )
+  end
+  
+  def test_get_comment
+    assert_equal( "This is a simple example", @schema.ontology.comment )
+  end
+
+  def test_get_created
+    assert_equal( "2010-02-19", @schema.ontology.created )
+  end
+  
+  def test_get_created
+    assert_equal( "2010-09-28", @schema.ontology.modified )
+  end
+
+  def test_get_authors
+    assert_equal( 2 , @schema.ontology.authors.length )
+    author = @schema.ontology.authors[0]
+    assert_equal( "http://www.ldodds.com#me", author.uri )
+    assert_equal( "Leigh Dodds", author.name )
+    
+    author = @schema.ontology.authors[1]
+    assert_equal( "http://www.example.org/unknown", author.uri )
+    assert_equal( "http://www.example.org/unknown", author.name )
+    
+  end
+  
+        
+end

data/tests/tc_schema.rb

@@ -0,0 +1,40 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'dowl'
+require 'test/unit'
+
+class SchemaTest < Test::Unit::TestCase
+  
+  def test_cannot_create_from_nil_file
+      assert_raise RuntimeError do
+        DOWL::Schema.create_from_file(nil) 
+      end
+  end
+  
+  def test_create_from_file
+    file = "examples/example.ttl"
+    DOWL::Schema.create_from_file(File.expand_path(file))     
+  end
+  
+  def test_read_classes_from_sample()
+    file = "examples/example.ttl"
+    schema = DOWL::Schema.create_from_file(File.expand_path(file))     
+    classes = schema.classes()
+    assert_not_nil classes
+    assert_equal(2, classes.length)
+  end
+  
+  def test_identify_owl_classes()    
+    model = RDF::Graph.new()
+    model << RDF::Statement.new( RDF::URI.new("http://www.example.com/"), RDF.type, DOWL::Namespaces::OWL.Class)
+    schema = DOWL::Schema.new(model)
+    assert_equal(1, schema.classes.length)
+  end
+
+  def test_identify_rdf_classes()
+    model = RDF::Graph.new()
+    model << RDF::Statement.new( RDF::URI.new("http://www.example.com/"), RDF.type, DOWL::Namespaces::RDFS.Class)
+    schema = DOWL::Schema.new(model)
+    assert_equal(1, schema.classes.length)
+  end
+  
+end

data/tests/ts_dowl.rb

@@ -0,0 +1,5 @@
+$:.unshift File.dirname(__FILE__)
+require 'test/unit'
+
+require 'tc_schema.rb'
+require 'tc_ontology.rb'

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification 
+name: dowl
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  version: "0.2"
+platform: ruby
+authors: 
+- Leigh Dodds
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-28 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 9
+        - 5
+        version: 0.9.5
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdf-raptor
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :runtime
+  version_requirements: *id002
+description: dowl OWL/RDF doc generator
+email: leigh.dodds@talis.com
+executables: 
+- dowl
+extensions: []
+
+extra_rdoc_files: 
+- README
+- CHANGES
+files: 
+- README
+- Rakefile
+- CHANGES
+- bin/dowl
+- tests/ts_dowl.rb
+- tests/tc_schema.rb
+- tests/tc_ontology.rb
+- examples/example.ttl
+- examples/introduction.html
+- lib/dowl.rb
+- lib/dowl/property.rb
+- lib/dowl/default.erb
+- lib/dowl/util.rb
+- lib/dowl/class.rb
+- lib/dowl/schema.rb
+- lib/dowl/ontology.rb
+- lib/dowl/generator.rb
+has_rdoc: true
+homepage: http://github.com/ldodds/dowl
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --quiet
+- --title
+- dowl Reference
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 61
+      segments: 
+      - 1
+      - 8
+      - 5
+      version: 1.8.5
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: dowl OWL/RDF doc generator
+test_files: 
+- tests/ts_dowl.rb