rdf-json 0.0.0 → 0.0.1

data/README

@@ -1,19 +1,19 @@
-RDF::JSON: RDF/JSON Support for RDF.rb
-======================================
+RDF/JSON Support for RDF.rb
+===========================
 
-This is an [RDF.rb](http://rdf.rubyforge.org/) plugin that adds support for
-parsing/serializing the RDF/JSON serialization format.
+This is an [RDF.rb][] plugin that adds support for parsing/serializing the
+[RDF/JSON][] serialization format.
 
 * <http://github.com/bendiken/rdf-json>
 
-### About RDF/JSON
-
-* <http://n2.talis.com/wiki/RDF_JSON_Specification>
-
 Documentation
 -------------
 
 * {RDF::JSON}
+  * {RDF::JSON::Extensions}
+  * {RDF::JSON::Format}
+  * {RDF::JSON::Reader}
+  * {RDF::JSON::Writer}
 
 Dependencies
 ------------
@@ -51,3 +51,6 @@ License
 
 `RDF::JSON` is free and unencumbered public domain software. For more
 information, see <http://unlicense.org/> or the accompanying UNLICENSE file.
+
+[RDF.rb]:   http://rdf.rubyforge.org/
+[RDF/JSON]: http://n2.talis.com/wiki/RDF_JSON_Specification

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.0.1

data/lib/rdf/json.rb

@@ -4,39 +4,43 @@ module RDF
   ##
   # **`RDF::JSON`** is an RDF/JSON plugin for RDF.rb.
   #
-  # Dependencies
-  # ------------
-  #
-  # * [RDF.rb](http://gemcutter.org/gems/rdf) (>= 0.0.9)
-  # * [JSON](http://gemcutter.org/gems/json_pure) (>= 1.2.0)
-  #
-  # Installation
-  # ------------
-  #
-  # The recommended installation method is via RubyGems. To install the latest
-  # official release from Gemcutter, do:
-  #
-  #     % [sudo] gem install rdf-json
-  #
-  # Documentation
-  # -------------
-  #
-  # * {RDF::JSON::Format}
-  # * {RDF::JSON::Reader}
-  # * {RDF::JSON::Writer}
-  #
   # @example Requiring the `RDF::JSON` module
   #   require 'rdf/json'
   #
+  # @example Serializing RDF values into RDF/JSON strings
+  #   RDF::Node.new('foobar').to_json
+  #   RDF::URI.new("http://rdf.rubyforge.org/").to_json
+  #   RDF::Literal.new("Hello, world!").to_json
+  #   RDF::Literal.new("Hello, world!", :language => 'en-US').to_json
+  #   RDF::Literal.new(3.1415).to_json
+  #   RDF::Literal.new('true', :datatype => RDF::XSD.boolean).to_json
+  #   RDF::Statement.new(s, p, o).to_json
+  #
+  # @example Parsing RDF statements from an RDF/JSON file
+  #   RDF::JSON::Reader.open("spec/data/test.json") do |reader|
+  #     reader.each_statement do |statement|
+  #       puts statement.inspect
+  #     end
+  #   end
+  #
+  # @example Serializing RDF statements into an RDF/JSON file
+  #   RDF::JSON::Writer.open("spec/data/test.json") do |writer|
+  #     graph.each_statement do |statement|
+  #       writer << statement
+  #     end
+  #   end
+  #
   # @see http://rdf.rubyforge.org/
   # @see http://n2.talis.com/wiki/RDF_JSON_Specification
   # @see http://en.wikipedia.org/wiki/JSON
   #
   # @author [Arto Bendiken](http://ar.to/)
   module JSON
+    require 'json'
+    require 'rdf/json/extensions'
     require 'rdf/json/format'
     autoload :Reader,  'rdf/json/reader'
     autoload :Writer,  'rdf/json/writer'
     autoload :VERSION, 'rdf/json/version'
-  end
-end
+  end # module JSON
+end # module RDF

data/lib/rdf/json/extensions.rb

@@ -0,0 +1,137 @@
+module RDF::JSON
+  ##
+  # RDF/JSON extensions for [RDF.rb](http://rdf.rubyforge.org/) core classes
+  # and mixins.
+  #
+  # Classes are extended with two new instance methods:
+  #
+  # * `#to_rdf_json` returns the RDF/JSON representation as a `Hash` object.
+  # * `#to_json` returns the serialized RDF/JSON representation as a string.
+  #
+  # @example Serializing blank nodes into RDF/JSON format
+  #   RDF::Node.new(id).to_json
+  #
+  # @example Serializing URI references into RDF/JSON format
+  #   RDF::URI.new("http://rdf.rubyforge.org/").to_json
+  #
+  # @example Serializing plain literals into RDF/JSON format
+  #   RDF::Literal.new("Hello, world!").to_json
+  #
+  # @example Serializing language-tagged literals into RDF/JSON format
+  #   RDF::Literal.new("Hello, world!", :language => 'en-US').to_json
+  #
+  # @example Serializing datatyped literals into RDF/JSON format
+  #   RDF::Literal.new(3.1415).to_json
+  #   RDF::Literal.new('true', :datatype => RDF::XSD.boolean).to_json
+  #
+  # @example Serializing statements into RDF/JSON format
+  #   RDF::Statement.new(s, p, o).to_json
+  #
+  # @example Serializing enumerables into RDF/JSON format
+  #   [RDF::Statement.new(s, p, o)].extend(RDF::Enumerable).to_json
+  #
+  module Extensions
+    ##
+    # RDF/JSON extensions for `RDF::Value`.
+    module Value
+      ##
+      # Returns the serialized RDF/JSON representation of this value.
+      #
+      # @return [String]
+      def to_json
+        # Any RDF/JSON-compatible class must implement `#to_rdf_json`:
+        to_rdf_json.to_json
+      end
+    end
+
+    ##
+    # RDF/JSON extensions for `RDF::Node`.
+    module Node
+      ##
+      # Returns the RDF/JSON representation of this blank node.
+      #
+      # @return [Hash]
+      def to_rdf_json
+        {:type => :bnode, :value => to_s}
+      end
+    end
+
+    ##
+    # RDF/JSON extensions for `RDF::URI`.
+    module URI
+      ##
+      # Returns the RDF/JSON representation of this URI reference.
+      #
+      # @return [Hash]
+      def to_rdf_json
+        {:type => :uri, :value => to_s}
+      end
+    end
+
+    ##
+    # RDF/JSON extensions for `RDF::Literal`.
+    module Literal
+      ##
+      # Returns the RDF/JSON representation of this literal.
+      #
+      # @return [Hash]
+      def to_rdf_json
+        case
+          when datatype? # FIXME: use `has_datatype?` in RDF.rb 0.1.0
+            {:type => :literal, :value => value.to_s, :datatype => datatype.to_s}
+          when language? # FIXME: use `has_language?` in RDF.rb 0.1.0
+            {:type => :literal, :value => value.to_s, :lang => language.to_s}
+          else
+            {:type => :literal, :value => value.to_s}
+        end
+      end
+    end
+
+    ##
+    # RDF/JSON extensions for `RDF::Statement`.
+    module Statement
+      ##
+      # Returns the RDF/JSON representation of this statement.
+      #
+      # @return [Hash]
+      def to_rdf_json
+        # FIXME: improve the RDF::Statement constructor in RDF.rb 0.1.0
+        s, p, o = subject.to_s, predicate.to_s, object.is_a?(RDF::Value) ? object : RDF::Literal.new(object)
+        {s => {p => [o.to_rdf_json]}}
+      end
+    end
+
+    ##
+    # RDF/JSON extensions for `RDF::Enumerable`.
+    module Enumerable
+      ##
+      # Returns the serialized RDF/JSON representation of this object.
+      #
+      # @return [String]
+      def to_json
+        to_rdf_json.to_json
+      end
+
+      ##
+      # Returns the RDF/JSON representation of this object.
+      #
+      # @return [Hash]
+      def to_rdf_json
+        json = {}
+        each_statement do |statement|
+          s = statement.subject.to_s
+          p = statement.predicate.to_s
+          o = statement.object.is_a?(RDF::Value) ? statement.object : RDF::Literal.new(statement.object)
+          json[s]    ||= {}
+          json[s][p] ||= []
+          json[s][p] << o.to_rdf_json
+        end
+        json
+      end
+    end
+  end # module Extensions
+
+  Extensions.constants.each do |klass|
+    RDF.const_get(klass).send(:include, Extensions.const_get(klass))
+  end
+end # module RDF::JSON

data/lib/rdf/json/format.rb

@@ -2,6 +2,13 @@ module RDF::JSON
   ##
   # RDF/JSON format specification.
   #
+  # @example Obtaining an RDF/JSON format class
+  #   RDF::Format.for(:json)         #=> RDF::JSON::Format
+  #   RDF::Format.for("spec/data/test.json")
+  #   RDF::Format.for(:file_name      => "spec/data/test.json")
+  #   RDF::Format.for(:file_extension => "json")
+  #   RDF::Format.for(:content_type   => "application/json")
+  #
   # @see http://n2.talis.com/wiki/RDF_JSON_Specification
   class Format < RDF::Format
     content_type     'application/json', :extension => :json
@@ -11,5 +18,5 @@ module RDF::JSON
     writer { RDF::JSON::Writer }
 
     require 'json'
-  end
-end
+  end # class Format
+end # module RDF::JSON

data/lib/rdf/json/reader.rb

@@ -2,17 +2,32 @@ module RDF::JSON
   ##
   # RDF/JSON parser.
   #
-  # @example Reading RDF/JSON data
+  # @example Obtaining an RDF/JSON reader class
+  #   RDF::Reader.for(:json)         #=> RDF::JSON::Reader
+  #   RDF::Reader.for("spec/data/test.json")
+  #   RDF::Reader.for(:file_name      => "spec/data/test.json")
+  #   RDF::Reader.for(:file_extension => "json")
+  #   RDF::Reader.for(:content_type   => "application/json") 
+  #
+  # @example Parsing RDF statements from an RDF/JSON file
   #   RDF::JSON::Reader.open("spec/data/test.json") do |reader|
   #     reader.each_statement do |statement|
   #       puts statement.inspect
   #     end
   #   end
   #
+  # @example Parsing RDF statements from an RDF/JSON string
+  #   data = StringIO.new(File.read("spec/data/test.json"))
+  #   RDF::JSON::Reader.new(data) do |reader|
+  #     reader.each_statement do |statement|
+  #       puts statement.inspect
+  #     end
+  #   end
+  #
   # @see http://n2.talis.com/wiki/RDF_JSON_Specification
   class Reader < RDF::Reader
     format RDF::JSON::Format
 
     # TODO
-  end
-end
+  end # class Reader
+end # module RDF::JSON

data/lib/rdf/json/version.rb

@@ -2,7 +2,7 @@ module RDF module JSON
   module VERSION
     MAJOR = 0
     MINOR = 0
-    TINY  = 0
+    TINY  = 1
     EXTRA = nil
 
     STRING = [MAJOR, MINOR, TINY].join('.')
@@ -15,5 +15,9 @@ module RDF module JSON
     ##
     # @return [String]
     def self.to_str() STRING end
+
+    ##
+    # @return [Array(Integer, Integer, Integer)]
+    def self.to_a() [MAJOR, MINOR, TINY] end
   end
 end end

data/lib/rdf/json/writer.rb

@@ -2,10 +2,89 @@ module RDF::JSON
   ##
   # RDF/JSON serializer.
   #
+  # @example Obtaining an RDF/JSON writer class
+  #   RDF::Writer.for(:json)         #=> RDF::JSON::Writer
+  #   RDF::Writer.for("spec/data/test.json")
+  #   RDF::Writer.for(:file_name      => "spec/data/test.json")
+  #   RDF::Writer.for(:file_extension => "json")
+  #   RDF::Writer.for(:content_type   => "application/json")
+  #
+  # @example Serializing RDF statements into an RDF/JSON file
+  #   RDF::JSON::Writer.open("spec/data/test.json") do |writer|
+  #     graph.each_statement do |statement|
+  #       writer << statement
+  #     end
+  #   end
+  #
+  # @example Serializing RDF statements into an RDF/JSON string
+  #   RDF::JSON::Writer.buffer do |writer|
+  #     graph.each_statement do |statement|
+  #       writer << statement
+  #     end
+  #   end
+  #
   # @see http://n2.talis.com/wiki/RDF_JSON_Specification
   class Writer < RDF::Writer
     format RDF::JSON::Format
 
-    # TODO
-  end
-end
+    ##
+    # Stores the RDF/JSON representation of a triple.
+    #
+    # @param  [RDF::Resource] subject
+    # @param  [RDF::URI]      predicate
+    # @param  [RDF::Value]    object
+    # @return [void]
+    # @see    #write_epilogue
+    def write_triple(subject, predicate, object)
+      s = subject.to_s
+      p = predicate.to_s
+      o = object.is_a?(RDF::Value) ? object : RDF::Literal.new(object)
+      @json       ||= {}
+      @json[s]    ||= {}
+      @json[s][p] ||= []
+      @json[s][p] << o.to_rdf_json
+    end
+
+    ##
+    # Outputs the RDF/JSON representation of all stored triples.
+    #
+    # @return [void]
+    # @see    #write_triple
+    def write_epilogue
+      puts @json.to_json
+    end
+
+    ##
+    # Returns the RDF/JSON representation of a blank node.
+    #
+    # @param  [RDF::Node] value
+    # @param  [Hash{Symbol => Object}] options
+    # @return [String]
+    def format_node(value, options = {})
+      value.to_json
+    end
+
+    ##
+    # Returns the RDF/JSON representation of a URI reference.
+    #
+    # @param  [RDF::URI] value
+    # @param  [Hash{Symbol => Object}] options
+    # @return [String]
+    def format_uri(value, options = {})
+      value.to_json
+    end
+
+    ##
+    # Returns the RDF/JSON representation of a literal.
+    #
+    # @param  [RDF::Literal, String, #to_s] value
+    # @param  [Hash{Symbol => Object}] options
+    # @return [String]
+    def format_literal(value, options = {})
+      case value
+        when RDF::Literal then value.to_json
+        else RDF::Literal.new(value).to_json
+      end
+    end
+  end # class Writer
+end # module RDF::JSON

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rdf-json
 version: !ruby/object:Gem::Version 
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors: 
 - Arto Bendiken
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-28 00:00:00 +01:00
+date: 2010-02-02 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.5.2
+        version: 0.5.3
     version: 
 - !ruby/object:Gem::Dependency 
   name: rdf
@@ -65,6 +65,7 @@ files:
 - README
 - UNLICENSE
 - VERSION
+- lib/rdf/json/extensions.rb
 - lib/rdf/json/format.rb
 - lib/rdf/json/reader.rb
 - lib/rdf/json/version.rb