rtriplify 0.0.0 → 0.0.1

data/README

@@ -1,18 +1,56 @@
-Triplify
+rTriplify
 ========
 
-Introduction goes here.
+rTriplify is a ruby clone of the triplify-php version. It is used to create
+a rdf-mapping of your existing database and serve it out to the (semantic)-web.
 
+rTriplify uses the rails database models to generate your rdf-data.
+
+It comes with most of the origin features of triplify.
+Please have a look at ..... to see the full features list.
+
+In addition you have the possibility to generate RDFa -Data and place it inside of
+your webpage as a hidden div. Please be aware that this is not the clean way to
+serve your content as RDFa. But I think, if you have generated the mapping file
+for your database it's just the consequence to place RDFa on your page instead.
+rTriplify gives you the right tools to place RDFa tags on your Webpage without having
+to do a full code review of your templates. And of course, search engines like google
+and yahoo already watch for these tags. Google already rewards RDFa tags with some specials.
+For further informations please see here [1] or [2] here
+
+
+Links:
+[1]http://www.google.com/support/webmasters/bin/answer.py?hl=en&answer=99170
+[2]http://developer.yahoo.com/searchmonkey/    (sadly this project has been rejected)
 
 Example
 =======
 
 gem install rtriplify
 
+then place a triplify.yml file in the config folder of your RoR-application.
+Probably it's the best idea to use the sample config file included in the gem or
+you can download the sample file here [3] too.
+
+Usaly the sample config has all configuration possibilitys inside of it and
+it's well documented. I think you can start now and change the config so that it
+will fit to your Application.
+
+Now, you want to see your nice RDF-Data?
+
+just add following route in the route.config:
+
+ map.connect 'triplify/*specs', :controller => 'triplify', :action => "tripleize"
+
+that's it. Now just go to http://your-app.com/triplify/ and you will get the full
+RDF dump of your database. (If you haven't changed the data-depth part in the config)
 
+That's all the magic.
+For detailed documentation I'll go on detail on some of the config sections.
 
 
-Example goes here.
 
 
+Links:
+[3] sample config
 Copyright (c) 2010 Nico Patitz, released under the MIT license

data/lib/app/controllers/triplify_controller.rb

@@ -1,95 +1,95 @@
 require  'configatron'
 
 class TriplifyController < ActionController::Base
-  def all
-    #get all models
-    #render all models
-    ret=""
+
+  def tripleize
     t = Tripleizer.new
-    $base_uri= t.uri request.env['REQUEST_URI'].to_s
+    t.base_uri = t.uri request.env['REQUEST_URI'].to_s
 
-    filename = 'test.rdf'
+    filename = 'data.n3'
     headers.merge!(
       'Content-Type' => 'text/rdf+n3',
       'Content-Disposition' => "attachment; filename=\"#{filename}\"",
       'Content-Transfer-Encoding' => 'binary'
     )
-   
-    render :content_type => 'text/plain', :text => proc { |response, output|
-      t.write_rdf_head(output)
-      model_groups =  eval("configatron.query").to_hash
-      model_groups.each do |model_group_name,model_group|
-        model_group.each do |model_name,model_attributes|
-          if model_name.to_s =="sql_query"
-            t.write_sql(model_group_name,model_attributes,output)
-          else
-            t.write_model(model_name, model_attributes, output)
-          end
-        end
+
+    t.output_json = request.content_type.try(:to_sym)==:json
+    content_type =   t.output_json   ? 'application/json' :  'text/plain'
+    render :content_type => content_type , :text => proc { |response, output|
+      t.output = output      
+      case params[:specs].length
+      when 0
+        t.write_rdf_head
+        all t
+      when 1
+        t.base_uri = t.base_uri.to_s[0..t.base_uri.to_s.index(params[:specs][0].to_s)-1]
+        t.write_rdf_head
+        model t, params[:specs][0]
+      when 2
+        t.base_uri = t.base_uri.to_s[0..t.base_uri.to_s.index(params[:specs][0].to_s)-1]
+        t.write_rdf_head
+        index t, params[:specs]
       end
+      
       t_metadata = TriplifyMetadata.new
-      t.output = output
-      t_metadata.write_metadata(t, output)
+      t_metadata.write_metadata(t)
+      output.write t.json if t.output_json
     }
   end
 
-  def model
+  private
+  
+  def all t
+    #get all models
+    #render all models
     ret=""
-    t = Tripleizer.new
-    $base_uri= t.uri request.env['REQUEST_URI'].to_s.split(params[:model])[0]
-    render :content_type => 'text/plain', :text => proc {|response, output|
-      t.write_rdf_head(output)
-      model_group= params[:model].to_s #TODO:groß/kleinschreibung.capitalize
-      model_group.downcase!
-      params[:id] ? entries= [params[:id]] : entries = :all
-      #TODO: multiple models
-      models = t.search_models model_group
-      models.each do |model_name, model_attributes|
+    model_groups =  eval("configatron.query").to_hash
+    model_groups.each do |model_group_name,model_group|
+      model_group.each do |model_name,model_attributes|
         if model_name.to_s =="sql_query"
-          t.write_sql(model_group_name,model_attributes,output)
+          t.write_sql(model_group_name,model_attributes,t.output)
         else
-          t.write_model(model_name, model_attributes, output)
+          t.write_model(model_name,model_group_name)
         end
       end
-      #write metadata
-      #t.write_rdf_metadata(t,output)
-    }
+    end
+    ""
   end
 
-  def index
-    ret=""
-    t = Tripleizer.new
-    $base_uri= t.uri request.env['REQUEST_URI'].to_s
-    render :content_type => 'text/plain', :text => proc { |response, output|
-      t.write_rdf_head(output)
-      subclass = $base_uri.split("triplify/")[1].split("/")
-
-      group = eval("configatron.query."+controller).to_hash;
-      group.each do |key,name|
-        model = key.to_s.capitalize
-        model = eval(model)
-        dtypes =t.dbd_types model
-
-        model= model.find(:all)
-        mapping =eval("configatron.query."+controller+"."+key.to_s).to_hash
+  #get all models
+  def model t, model_group   
+    models = t.search_models model_group
+    models.values[0].each do |model_name, model_attributes|
+      if model_name.to_s =="sql_query"
+        t.write_sql(model_group_name,model_attributes,output)
+      else
+        t.write_model(model_name, models.keys[0])
+      end
+    end
+  end
 
-        model.each do |item|
-          #t.write_triple(item.id, object, is_literal, dtype, lang)
-          c1 = Hash.new
-          #add first the id
-          c1[:id] = item.id
-          #und jetzt das mapping
-          mapping.each do |k,v|
-            c1[k]=eval("item."+v.to_s)
+  # get a defined model with given id
+  def index t,param
+    subclass,id = param
+    models = t.search_models subclass
+    models.values[0].each do |model_name, model_attributes|
+      if model_name.to_s =="sql_query"
+        #some magic is needed here  ..parse the sql query?
+      else
+        m = Model.new model_name,  models.keys[0].to_s
+        row_values=m.get_row_by_id(id).first
+        c1=Hash.new
+        if row_values
+          m.model.columns_hash.each_with_index do |column_name,i|
+            c1[column_name[0]]=eval("row_values.#{column_name}")
           end
-
-          output.write t.make_triples(c1, controller , "", dtypes)
-          #render :text =>  t.make_triples(c1, controller , "", t.dbd_types)
+          t.extract_id_line model_attributes, c1,row_values,m.get_datatypes
+          t.make_triples(c1,  models.keys[0].to_s , "", m.get_datatypes)
         end
       end
-      meta = TriplifyMetadata.new
-      t.output=output
-      meta.write_metadata t,output
-    }
+
+    end
+    #render :text =>  t.make_triples(c1, controller , "", t.dbd_types)
+    
   end
 end

data/lib/app/helpers/triplify_helper.rb

@@ -1,8 +1,4 @@
 require 'configatron'
 
-module TriplifyHelper
-
-  def tweet(text)
-    "Tweet! #{text}"
-  end
+module TriplifyHelper 
 end

data/lib/config/{database.yml → database_1.yml}

@@ -1,3 +1,14 @@
+# Please note that this configuration file is using the yaml syntax.
+# If your application doesn't start after installing the rtriplify syntax
+# please make sure, you configured everything properly. Especially in the
+# query-configuration section you have to take care. Easiest way is to use
+# an editor for it. For example Netbeans already have a build in one.
+
+# Please be sure having configured your database configuration properly
+
+
+# all namespaces for your application. Please use them in your application to
+# get the data better linked
 namespaces:
   vocabulary: http://your-webapp.com/vocabulary/
   rdf: http://www.w3.org/1999/02/22-rdf-syntax-ns#
@@ -17,12 +28,48 @@ namespaces:
   daml: http://www.daml.org/2001/09/countries/iso-3166-ont#
 
 #queries:
-#  project: SELECT p.id AS id,p.title AS 'dc:title',p.description AS 'sioc:content',u.nickname AS 'sioc:has_creator',p.changed AS 'dcterms:modified',p.created AS 'dcterms:created',p.status FROM project p INNER JOIN user u ON(user_id=u.id)
-#  user: SELECT nickname id,SHA(CONCAT('mailto:',email)) AS 'foaf:mbox_sha1sum',profile AS 'profile@en' FROM user",
-#  update: SELECT p.changed AS id,p.id AS 'update:updatedResource->project' FROM project p
+# In general there are two possibilites to configure your rdf Data. First is by
+# using sql queries like in the php version of triplify. Please have a look at
+# http://triplify.svn.sourceforge.net/viewvc/triplify/triplify-php/config.dist.php?view=markup
+# to find out how to configure.
+#
+# Secound possibility and may be the more "rails-way" is to use active record.
+# you have two hierarchy levels for configuration. First, the group and secound,
+# the Active record model.
+# A configuration line in the model has always the Schema
+# nameOfField: ar_field
+# ID field has a special meaning. The ID field is always the Subject of the RDF
+# triples.
+# If your model has a relation to another Model you can reference the field by using
+# the "->" symbol. For example if your Country has States just reference it by
+# " state->State: states" before the "->"-Symbol the predicate is written. after the Symbol the
+# referencing model is notated
+# Additional you can define a filter e.g.
+# filter:
+#   ID: ">213 and id <224"
+# Note: in some case lower and Uppercase Notation is Important.
+# the "id" field is alway written uppercase.
+# group is written lowercase
+# Model are written Capitalized like using it in ruby.
+# first time you may be a little bit irritated, but up to now there is
+# no better solution for this issue.
+
 
 query:
-  location:   #the group write it lowercase
+  shipping:   #the group write it lowercase
+
+    ShippingMethod:
+      gr:DeliveryModeParcelService: name
+      zone->zone: zone
+
+    Zone:
+      rdfs:label: name
+      rdfs:comment: description
+
+    ZoneMember:
+      zone->zone: zone
+      Country->Country: zoneable
+
     Country: #the model name...write it capitalized
       ID: iso
       daml:name: iso_name
@@ -44,23 +91,12 @@ query:
       abrr: abbr
       Country->Country: country
 
-#    Zone:
-#      ID: name
-#      description: description
-#      ZoneMembers->ZoneMembers: zone_member
-
-#    ZoneMembers:
-#      Zone->Zone: zone
-#      type: zoneable_type
-#      Country->Country: zoneable
-
   product:   #the group write it lowercase
     Product: #the model name...write it capitalized
-      name: name
-      description: description
-      available_on: available_on
-      permalink: permalink
-      Property->Propery: properties
+      rdfs:label: name
+      rdfs:comment: description    
+      ID: permalink
+      Property->Property: properties
       PropertyValue->ProductProperty: product_properties
       OptionType->OptionType: option_types
       CategoryName: tax_category.name
@@ -96,14 +132,16 @@ query:
 
 
     Variant:
+      gr:hasBusinessFunction: "gr:Sell"
       Product->Product: product
-      sku: sku
-      price: price
-      weight: weight
-      height: height
-      width: width
-      depth: depth
-      count_on_hand: count_on_hand
+      ID: sku
+      #gr:hasCurrency
+      gr:hasCurrencyValue: price
+      gr:weight: weight
+      gr:height: height
+      gr:width: width
+      gr:depth: depth
+      #count_on_hand: count_on_hand
       OptionValue->OptionValue: option_values
 
     Taxon:
@@ -121,8 +159,6 @@ query:
       Variant->Variant: variants
       OptionType->OptionType: option_type
 
-
-
   user:
     User:
       firstname: ship_address.firstname
@@ -151,7 +187,7 @@ query:
 # specifies, which columns are references to objects of which type.
 
 objectProperties:
-  has_creator: movie
+  has_creator: person
 
 # Objects are classified according to their type. However, you can specify
 # a mapping here, if objects of a certain type should be associated with a
@@ -159,8 +195,12 @@ objectProperties:
 # unsure it is safe to leave this configuration array empty.
 #
 classMap:
-  movie: foaf:person
+  Movie: foaf:person
+  Product: gr:ProductOrServiceModel 
+  ShippingMethod: gr:DeliveryMethod
+  Variant:
 
+#the licence under which you publish your data
 license: http://creativecommons.org/licenses/by/3.0/us/
 
 # Additional metadata
@@ -171,6 +211,7 @@ metadata:
   dc:title: test
   dc:publisher: test
 
+# not yet
 # Set this to true in order to register your linked data endpoint with the
 # Triplify registry (http://triplify.org/Registry).
 # Registering is absolutely recommended, since that allows other Web sites
@@ -180,8 +221,8 @@ metadata:
 # the triplify folder, or at: http://triplify.org/Registry
 
 register: true
-ttl: 0
-cachedir: cache
+#ttl: 0
+#cachedir: cache
 
 # Linked Data Depth
 #
@@ -195,7 +236,7 @@ cachedir: cache
 #    content will be exposed on the instance level, e.g. when /triplify/user/1/
 #    is accessed.
 #
-LinkedDataDepth: 2
+# LinkedDataDepth: 2
 
 # Callback Functions
 #
@@ -215,10 +256,7 @@ pingback:
   # Whether X-Pingback header should be exposed and XML-RPC is active.
   enabled: true
   #Whether to write Pingbacks with the instance data.
-  write: true
-  #Whether to use mod_rewrite, if it is available...
-  use_mod_rewrite: true
-
+  write: true  
 
 # metadata
 
@@ -227,14 +265,11 @@ pingback:
 ##
 
 # You have to specify the operator of this Triplify service. The operator is
-#  usually you or your group or organization.
+#  usually you or your group or organizationlly you or your group or organiz.
 #  There are two options to specify the operator. The first option is an HTTP
 #  URI that identifies the operator. This is the preferred option.
 #
-operator_uri:
-#/* The second option is the specification by providing a name, a homepage
-# * address, and a URI that identifies the type of the operator.
-# */
+
 operator_name:
 operator_homepage:
 operator_type:
@@ -242,21 +277,6 @@ operator_type:
 #// $provenance['OperatorType'] = 'http://swrc.ontoware.org/ontology#ResearchGroup';
 
 
-#/* If you have an HTTP URI that identifies your triplified dataset (and that
-# * links to a voiD description of your dataset) specify it here:
-# */
-dataset:
-
-#/* If you have an HTTP URI that identifies the accessed database server specify
-# * it here:
-# */
-database_server:
-
-#/* If you have an HTTP URI that identifies the configuration file used by your
-# * Triplify installation specify it here:
-# */
-mapping:
-
 #
 #//
 #//  END OF CONFIGURATION

data/lib/model.rb

@@ -5,24 +5,37 @@ require 'configatron'
 class Model
   attr_accessor :model
   attr_accessor :model_name 
-  attr_accessor :model_attributes 
-  
-  def initialize model_name
-    @model_name= model_name 
-    
+  attr_accessor :model_attributes
+  attr_accessor :model_class
+
+  #hard coded mapping look mapping table
+  @mapping
+
+
+  def initialize model_name, model_class, var=nil
+    @model_name= model_name
+    @model_class= model_class
     #read the model attributes
-    @model_attributes = get_model_attributes model_name
-    unless @model_attributes
-      h="hello"
-    end
-    @model = get_model
-    
+    @model_attributes = get_model_attributes model_name,model_class
+    @model = var ? var : get_model
+    @mapping = Hash[ "binary"=>"base64Binary","boolean"=>"boolean","date"=>"date","datetime"=>"dateTime","decimal"=>"decimal","float"=>"float","integer"=>"integer","string"=>"string","text"=>"string","time"=>"time","timestamp"=>"dateTime",]
   end
+
   
   def get_model
     eval(@model_name.to_s)
   end 
-  
+
+  def get_const input
+    #remove function name
+    input = input.to_s
+    input = input[6..input.index(')')-1]
+
+    const = input.index(",")? input.split(",")[0]:input
+    datatype = input.index(",")? input.split(",")[1]: "xsd:String"
+    return [const,datatype]
+  end
+
   ###
   # *returns the filter of the model
   #*@remove if filter should be removed from model_attributes list
@@ -41,53 +54,83 @@ class Model
 
   def get_include
     ret = Array.new
-    model_attributes.select {|k,v| k.to_s.include?("->")}.each do |attribute|
-      ref_model = attribute[1]
-      #get model     
-      ret.push(ref_model.downcase.to_sym)
+    #    model_attributes.select {|k,v| k.to_s.include?("->")}.each do |attribute|
+    #      ref_model = attribute[0].to_s.split("->")[1]
+    #      get_model_model(@model_class).each do |r_mod|
+    #        ret.push(r_mod.to_s.capitalize.to_sym)
+    #      end
+    #    end
+
+    model_attributes.select {|k,v| v.to_s.include?("*")}.each do |attribute|
+      m_class,field=attribute[1].to_s.split("*")
+      #get model
+      ret.push(m_class.downcase.to_sym) unless ret.index(m_class.downcase.to_sym) || m_class[0..5]=="MODEL("
     end
+
     model_attributes.select {|k,v| v.to_s.include?(".")}.each do |attribute|
-      ref_model = attribute[1].split(".")[0]
+      ref_model = attribute[1].split(".")[0].to_s.downcase
       #get model
-      ret.push(ref_model.downcase.to_sym)
+      ret.push(ref_model.to_sym) unless ret.index(ref_model.to_sym)
     end
     ret
   end
 
-  def get_model_attributes key
+  def get_model_attributes key, model_class
     model_groups =  eval("configatron.query").to_hash
     model_groups.each do |model_group_name,model_group|
-      model_group.each do |model_name_query,attributes|
-        if model_name_query.to_s.downcase == key.to_s.downcase
-          return attributes
+      if model_group_name.to_s==model_class.to_s
+        hello="hello"
+        model_group.each do |model_name_query,attributes|
+          return attributes if model_name_query.to_s.downcase == key.to_s.downcase
         end
       end
     end
     nil
   end
 
+  def get_model_model model_class
+    model_groups =  eval("configatron.query").to_hash
+    model_groups.each do |model_group_name,model_group|
+      if model_group_name==model_class
+        return model_group.keys
+      end
+    end
+    nil
+  end
+
   def read_attributes
     get_model_attributes @model_name
   end
   
-  def get_datatypes
-    #hard coded mapping look mapping table
-    mapping = Hash[ "binary"=>"base64Binary","boolean"=>"boolean","date"=>"date","datetime"=>"dateTime","decimal"=>"decimal","float"=>"float","integer"=>"integer","string"=>"string","text"=>"string","time"=>"time","timestamp"=>"dateTime",]
+  def get_datatypes   
     dtypes = Hash.new
     @model.columns_hash.each_key do |m|
       #make xsd datatye
-      dtypes[m.to_s] ="xsd:#{mapping[@model.columns_hash[m].type.to_s] }"
+      dtypes[m.to_s] ="xsd:#{@mapping[@model.columns_hash[m].type.to_s] }"
     end
     #replace mapping
     @model_attributes.each do |k,v|
-      dtypes[k.to_s]=dtypes[v.to_s]
+      if ((v.include? "*") ||(v.include? "." )) && v.to_s[0..5]!="Model("
+        field,model = k.to_s.split "->"
+        unless model
+          #todo: get datatype..thats a little bit tricky at this point
+#          v.gsub!("*",".")
+#          a,db_field= v.to_s.split "."
+#          t = eval("#{model}.columns_hash[db_field.to_s].type.to_s.downcase")
+#          dtypes[k.to_s]="xsd:#{@mapping[t]}"
+        end 
+      else
+        dtypes[k.to_s]=dtypes[v.to_s]
+      end
     end
     dtypes
   end
 
   def get_rows
     #make filter
+
     t = @model
+    return t if t.class == Array
     filter = get_filter(true)
     include = get_include
       
@@ -106,6 +149,29 @@ class Model
     end
     t
   end
+
+  def get_row_by_id id
+    #make filter
+    t = @model
+    filter = get_filter(true)
+    include = get_include
+    find_command = "find_all_by_#{get_key.to_s.downcase}"
+
+    if include.empty?
+      if filter
+        t = eval("t.#{find_command}(#{id}, :conditions =>filter)")
+      else
+        t = eval("t.#{find_command}(#{id})")
+      end
+    else
+      if filter
+        t = eval("t.#{find_command}(#{id},:include => include, :conditions => filter)")
+      else
+        t = eval("t.#{find_command}(\"#{id}\",:include => include)")
+      end
+    end
+    t
+  end
   
   def get_key
     id_keys = @model_attributes.to_hash.keys
@@ -115,24 +181,5 @@ class Model
     return :id if id_key.empty?
     return @model_attributes[id_key[0].to_sym]      
   end
-
-#  def extract_id_line model_attributes, line,item,dtypes
-#    #look if id is mapped to another field
-#    id_keys = model_attributes.to_hash.keys
-#    #hotfix..bad performance
-#    id_keys.map!{|k| k.to_s }
-#    id_key= id_keys.select{|k| k =~/^(ID|id|iD|Id)$/ }
-#    if id_key.empty?
-#      line[:id] = item.id
-#    else
-#      line[:id] = eval("item.#{model_attributes[id_key[0].to_sym]}")
-#      #set the correct datatype for it
-#      dtypes["id"]= line[:id].class.to_s.downcase
-#      #remove the id line
-#      line.delete id_key[0].to_sym
-#    end
-#  end
-
-
   
 end