Skip to content

norcalrdf/rdf-turtle

 
 

Repository files navigation

RDF::Turtle reader/writer Build Status

Turtle reader/writer for RDF.rb .

Description

This is a Ruby implementation of a Turtle parser for RDF.rb.

Features

RDF::Turtle parses Turtle and N-Triples into statements or triples. It also serializes to Turtle.

Install with gem install rdf-turtle

  • 100% free and unencumbered public domain software.
  • Implements a complete parser for Turtle.
  • Compatible with Ruby 1.8.7+, Ruby >= 1.9, and JRuby 1.7+.

Usage

Instantiate a reader from a local file:

graph = RDF::Graph.load("etc/doap.ttl", :format => :ttl)

Define @base and @prefix definitions, and use for serialization using :base_uri an :prefixes options.

Canonicalize and validate using :canonicalize and :validate options.

Write a graph to a file:

RDF::Turtle::Writer.open("etc/test.ttl") do |writer|
   writer << graph
end

Documentation

Full documentation available on Rubydoc.info

Principle Classes

  • {RDF::Turtle::Format}
    • {RDF::Turtle::TTL} Asserts :ttl format, text/turtle mime-type and .ttl file extension.
  • {RDF::Turtle::Reader}
  • {RDF::Turtle::Writer}

Variations from the spec

In some cases, the specification is unclear on certain issues:

  • For the time being, plain literals are generated without an xsd:string datatype, but literals with an xsd:string datatype are saved as non-datatyped triples in the graph. This will be updated in the future when the rest of the library suite is brought up to date with RDF 1.1.

Implementation Notes

The reader uses the EBNF gem to generate first, follow and branch tables, and uses the Parser and Lexer modules to implement the Turtle parser.

The parser takes branch and follow tables generated from the original Turtle EBNF Grammar described in the specification. Branch and Follow tables are specified in {RDF::Turtle::Meta}, which is in turn generated using the EBNF gem.

Dependencies

Installation

The recommended installation method is via RubyGems. To install the latest official release of the RDF::Turtle gem, do:

% [sudo] gem install rdf-turtle

Mailing List

Author

Contributing

  • Do your best to adhere to the existing coding conventions and idioms.
  • Don't use hard tabs, and don't leave trailing whitespace on any line.
  • Do document every method you add using YARD annotations. Read the tutorial or just look at the existing code for examples.
  • Don't touch the .gemspec, VERSION or AUTHORS files. If you need to change them, do so on your private branch only.
  • Do feel free to add yourself to the CREDITS file and the corresponding list in the the README. Alphabetical order applies.
  • Do note that in order for us to merge any non-trivial changes (as a rule of thumb, additions larger than about 15 lines of code), we need an explicit public domain dedication on record from you.

License

This is free and unencumbered public domain software. For more information, see http://unlicense.org/ or the accompanying {file:UNLICENSE} file.