rdf 0.2.3 → 0.3.0.pre

data/lib/rdf/model/literal/boolean.rb

@@ -27,15 +27,42 @@ module RDF; class Literal
     end
 
     ##
-    # Converts the literal into its canonical lexical representation.
+    # Converts this literal into its canonical lexical representation.
     #
-    # @return [Literal]
-    # @see    http://www.w3.org/TR/xmlschema-2/#boolean
-    def canonicalize
+    # @return [RDF::Literal] `self`
+    # @see    http://www.w3.org/TR/xmlschema-2/#boolean-canonical-representation
+    def canonicalize!
       @string = (@object ? :true : :false).to_s
       self
     end
 
+    ##
+    # Compares this literal to `other` for sorting purposes.
+    #
+    # @param  [Object] other
+    # @return [Integer] `-1`, `0`, or `1`
+    # @since  0.3.0
+    def <=>(other)
+      case other
+        when TrueClass, FalseClass
+          to_i <=> (other ? 1 : 0)
+        when RDF::Literal::Boolean
+          to_i <=> other.to_i
+        else super
+      end
+    end
+
+    ##
+    # Returns `true` if this literal is equivalent to `other`.
+    #
+    # @param  [Object] other
+    # @return [Boolean] `true` or `false`
+    # @since  0.3.0
+    def ==(other)
+      (self <=> other).zero?
+    end
+    alias_method :===, :==
+
     ##
     # Returns the value as a string.
     #
@@ -44,6 +71,15 @@ module RDF; class Literal
       @string || @object.to_s
     end
 
+    ##
+    # Returns the value as an integer.
+    #
+    # @return [Integer] `0` or `1`
+    # @since  0.3.0
+    def to_i
+      @object ? 1 : 0
+    end
+
     ##
     # Returns `true` if this value is `true`.
     #
@@ -59,5 +95,5 @@ module RDF; class Literal
     def false?
       @object.equal?(false)
     end
-  end # class Boolean
-end; end # class RDF::Literal
+  end # Boolean
+end; end # RDF::Literal

data/lib/rdf/model/literal/date.rb

@@ -23,15 +23,27 @@ module RDF; class Literal
     end
 
     ##
-    # Converts the literal into its canonical lexical representation.
+    # Converts this literal into its canonical lexical representation.
     #
-    # @return [Literal]
+    # @return [RDF::Literal] `self`
     # @see    http://www.w3.org/TR/xmlschema-2/#date
-    def canonicalize
+    def canonicalize!
       @string = @object.strftime('%Y-%m-%d%Z').sub(/\+00:00|UTC/, 'Z')
       self
     end
 
+    ##
+    # Returns `true` if the value adheres to the defined grammar of the
+    # datatype.
+    #
+    # Special case for date and dateTime, for which '0000' is not a valid year
+    #
+    # @return [Boolean]
+    # @since  0.2.1
+    def valid?
+      !!(value =~ GRAMMAR) && value !~ %r(\A0000)
+    end
+
     ##
     # Returns the value as a string.
     #
@@ -39,5 +51,5 @@ module RDF; class Literal
     def to_s
       @string || @object.strftime('%Y-%m-%d%Z').sub(/\+00:00|UTC/, 'Z')
     end
-  end # class Date
-end; end # class RDF::Literal
+  end # Date
+end; end # RDF::Literal

data/lib/rdf/model/literal/datetime.rb

@@ -23,15 +23,27 @@ module RDF; class Literal
     end
 
     ##
-    # Converts the literal into its canonical lexical representation.
+    # Converts this literal into its canonical lexical representation.
     #
-    # @return [Literal]
+    # @return [RDF::Literal] `self`
     # @see    http://www.w3.org/TR/xmlschema-2/#dateTime
-    def canonicalize
-      @string = @object.strftime('%Y-%m-%dT%H:%M:%S%Z').sub(/\+00:00|UTC/, 'Z')
+    def canonicalize!
+      @string = @object.new_offset(0).strftime('%Y-%m-%dT%H:%M:%S%Z').sub(/\+00:00|UTC/, 'Z')
       self
     end
 
+    ##
+    # Returns `true` if the value adheres to the defined grammar of the
+    # datatype.
+    #
+    # Special case for date and dateTime, for which '0000' is not a valid year
+    #
+    # @return [Boolean]
+    # @since  0.2.1
+    def valid?
+      !!(value =~ GRAMMAR) && value !~ %r(\A0000)
+    end
+
     ##
     # Returns the value as a string.
     #
@@ -39,5 +51,5 @@ module RDF; class Literal
     def to_s
       @string || @object.strftime('%Y-%m-%dT%H:%M:%S%Z').sub(/\+00:00|UTC/, 'Z')
     end
-  end # class DateTime
-end; end # class RDF::Literal
+  end # DateTime
+end; end # RDF::Literal

data/lib/rdf/model/literal/decimal.rb

@@ -28,11 +28,11 @@ module RDF; class Literal
     end
 
     ##
-    # Converts the literal into its canonical lexical representation.
+    # Converts this literal into its canonical lexical representation.
     #
-    # @return [Literal]
+    # @return [RDF::Literal] `self`
     # @see    http://www.w3.org/TR/xmlschema-2/#decimal
-    def canonicalize
+    def canonicalize!
       # Can't use simple %f transformation due to special requirements from
       # N3 tests in representation
       @string = begin
@@ -46,6 +46,33 @@ module RDF; class Literal
       self
     end
 
+    ##
+    # Compares this literal to `other` for sorting purposes.
+    #
+    # @param  [Object] other
+    # @return [Integer] `-1`, `0`, or `1`
+    # @since  0.3.0
+    def <=>(other)
+      case other
+        when Numeric
+          to_d <=> other
+        when RDF::Literal::Decimal, RDF::Literal::Double
+          to_d <=> other.to_d
+        else super
+      end
+    end
+
+    ##
+    # Returns `true` if this literal is equivalent to `other`.
+    #
+    # @param  [Object] other
+    # @return [Boolean] `true` or `false`
+    # @since  0.3.0
+    def ==(other)
+      (self <=> other).zero?
+    end
+    alias_method :===, :==
+
     ##
     # Returns the absolute value of `self`.
     #
@@ -177,5 +204,5 @@ module RDF; class Literal
     def to_r
       @object.to_r # only available on Ruby 1.9+
     end
-  end # class Decimal
-end; end # class RDF::Literal
+  end # Decimal
+end; end # RDF::Literal

data/lib/rdf/model/literal/double.rb

@@ -30,11 +30,11 @@ module RDF; class Literal
     end
 
     ##
-    # Converts the literal into its canonical lexical representation.
+    # Converts this literal into its canonical lexical representation.
     #
-    # @return [Literal]
+    # @return [RDF::Literal] `self`
     # @see    http://www.w3.org/TR/xmlschema-2/#double
-    def canonicalize
+    def canonicalize!
       # Can't use simple %f transformation due to special requirements from
       # N3 tests in representation
       @string = case
@@ -51,6 +51,33 @@ module RDF; class Literal
       self
     end
 
+    ##
+    # Compares this literal to `other` for sorting purposes.
+    #
+    # @param  [Object] other
+    # @return [Integer] `-1`, `0`, or `1`
+    # @since  0.3.0
+    def <=>(other)
+      case other
+        when Numeric
+          to_d <=> other
+        when RDF::Literal::Decimal, RDF::Literal::Double
+          to_d <=> other.to_d
+        else super
+      end
+    end
+
+    ##
+    # Returns `true` if this literal is equivalent to `other`.
+    #
+    # @param  [Object] other
+    # @return [Boolean] `true` or `false`
+    # @since  0.3.0
+    def ==(other)
+      (self <=> other).zero?
+    end
+    alias_method :===, :==
+
     ##
     # Returns `true` if the value is an invalid IEEE floating point number.
     #
@@ -253,5 +280,5 @@ module RDF; class Literal
     def to_r
       @object.to_r # only available on Ruby 1.9+
     end
-  end # class Double
-end; end # class RDF::Literal
+  end # Double
+end; end # RDF::Literal

data/lib/rdf/model/literal/integer.rb

@@ -30,11 +30,11 @@ module RDF; class Literal
     end
 
     ##
-    # Converts the literal into its canonical lexical representation.
+    # Converts this literal into its canonical lexical representation.
     #
-    # @return [Literal]
+    # @return [RDF::Literal] `self`
     # @see    http://www.w3.org/TR/xmlschema-2/#integer
-    def canonicalize
+    def canonicalize!
       @string = @object.to_s if @object
       self
     end
@@ -203,5 +203,16 @@ module RDF; class Literal
     def to_r
       @object.to_r
     end
-  end # class Integer
-end; end # class RDF::Literal
+
+    ##
+    # Returns the value as an `OpenSSL::BN` instance.
+    #
+    # @return [OpenSSL::BN]
+    # @see    http://ruby-doc.org/stdlib/libdoc/openssl/rdoc/classes/OpenSSL/BN.html
+    # @since  0.2.4
+    def to_bn
+      require 'openssl' unless defined?(OpenSSL::BN)
+      OpenSSL::BN.new(to_s)
+    end
+  end # Integer
+end; end # RDF::Literal

data/lib/rdf/model/literal/time.rb

@@ -27,7 +27,7 @@ module RDF; class Literal
     end
 
     ##
-    # Converts the literal into its canonical lexical representation.
+    # Converts this literal into its canonical lexical representation.
     #
     # §3.2.8.2 Canonical representation
     #
@@ -37,10 +37,10 @@ module RDF; class Literal
     # time zone must be Coordinated Universal Time (UTC) indicated by a "Z".
     # Additionally, the canonical representation for midnight is 00:00:00.
     #
-    # @return [Literal]
+    # @return [RDF::Literal] `self`
     # @see    http://www.w3.org/TR/xmlschema-2/#time
-    def canonicalize
-      @string = @object.strftime('%H:%M:%S%Z').sub(/\+00:00|UTC/, 'Z')
+    def canonicalize!
+      @string = @object.utc.strftime('%H:%M:%S%Z').sub(/\+00:00|UTC/, 'Z')
       self
     end
 
@@ -51,5 +51,5 @@ module RDF; class Literal
     def to_s
       @string || @object.strftime('%H:%M:%S%Z').sub(/\+00:00|UTC/, 'Z')
     end
-  end # class Time
-end; end # class RDF::Literal
+  end # Time
+end; end # RDF::Literal

data/lib/rdf/model/literal/token.rb

@@ -19,11 +19,11 @@ module RDF; class Literal
     end
 
     ##
-    # Converts the literal into its canonical lexical representation.
+    # Converts this literal into its canonical lexical representation.
     #
-    # @return [Literal]
+    # @return [RDF::Literal] `self`
     # @see    http://www.w3.org/TR/xmlschema-2/#boolean
-    def canonicalize
+    def canonicalize!
       @string = @object.to_s if @object
       self
     end
@@ -43,5 +43,5 @@ module RDF; class Literal
     def to_s
       @string || @object.to_s
     end
-  end # class Token
-end; end # class RDF::Literal
+  end # Token
+end; end # RDF::Literal

data/lib/rdf/model/literal/xml.rb

@@ -19,11 +19,11 @@ module RDF; class Literal
     end
 
     ##
-    # Converts the literal into its canonical lexical representation.
+    # Converts this literal into its canonical lexical representation.
     #
-    # @return [Literal]
+    # @return [RDF::Literal] `self`
     # @see    http://www.w3.org/TR/xml-exc-c14n/
-    def canonicalize
+    def canonicalize!
       # TODO: implement XML canonicalization
       self
     end
@@ -35,5 +35,5 @@ module RDF; class Literal
     def to_s
       @string || @object.to_s # TODO
     end
-  end # class XML
-end; end # class RDF::Literal
+  end # XML
+end; end # RDF::Literal

data/lib/rdf/model/literal.rb

@@ -100,8 +100,8 @@ module RDF
       end
       literal = klass.allocate
       literal.send(:initialize, value, options)
-      literal.validate if options[:validate]
-      literal.canonicalize if options[:canonicalize]
+      literal.validate!     if options[:validate]
+      literal.canonicalize! if options[:canonicalize]
       literal
     end
 
@@ -263,23 +263,36 @@ module RDF
     # Validates the value using {#valid?}, raising an error if the value is
     # invalid.
     #
+    # @return [RDF::Literal] `self`
     # @raise  [ArgumentError] if the value is invalid
-    # @return [Literal]
     # @since  0.2.1
-    def validate
-      raise ArgumentError.new("#{to_s.inspect} is not a valid <#{datatype.to_s}> literal") if invalid?
+    def validate!
+      raise ArgumentError, "#{to_s.inspect} is not a valid <#{datatype.to_s}> literal" if invalid?
       self
     end
-    alias_method :validate!, :validate
+    alias_method :validate, :validate!
 
     ##
-    # Converts the literal into its canonical lexical representation.
+    # Returns a copy of this literal converted into its canonical lexical
+    # representation.
     #
-    # Subclasses should override this as needed and appropriate.
+    # Subclasses should override `#canonicalize!` as needed and appropriate,
+    # not this method.
     #
-    # @return [Literal]
+    # @return [RDF::Literal]
     # @since  0.2.1
     def canonicalize
+      self.dup.canonicalize!
+    end
+
+    ##
+    # Converts this literal into its canonical lexical representation.
+    #
+    # Subclasses should override this as needed and appropriate.
+    #
+    # @return [RDF::Literal] `self`
+    # @since  0.3.0
+    def canonicalize!
       @language = @language.to_s.downcase.to_sym if @language
       self
     end
@@ -299,5 +312,5 @@ module RDF
     def inspect
       sprintf("#<%s:%#0x(%s)>", self.class.name, __id__, RDF::NTriples.serialize(self))
     end
-  end
-end
+  end # Literal
+end # RDF

data/lib/rdf/model/node.rb

@@ -9,27 +9,28 @@ module RDF
   #   bnode = RDF::Node.uuid
   #   bnode.to_s #=> "_:504c0a30-0d11-012d-3f50-001b63cac539"
   #
-  # @see http://rubygems.org/gems/uuid
-  # @see http://rubygems.org/gems/uuidtools
   class Node
     include RDF::Resource
 
     ##
     # Returns a blank node with a random UUID-based identifier.
     #
+    # @param  [Hash{Symbol => Object}] options
+    # @option options [Regexp] :grammar (nil)
+    #   a grammar specification that the generated UUID must match
     # @return [RDF::Node]
-    def self.uuid
-      begin
-        require 'uuid'
-        self.new(UUID.generate)
-      rescue LoadError => e
-        begin
-          require 'uuidtools'
-          self.new(UUIDTools::UUID.random_create)
-        rescue LoadError => e
-          raise LoadError.new("no such file to load -- uuid or uuidtools")
-        end
+    def self.uuid(options = {})
+      case
+        when options[:grammar]
+          # The UUID is generated such that its initial part is guaranteed
+          # to match the given `grammar`, e.g. `/^[A-Za-z][A-Za-z0-9]*/`.
+          # Some RDF storage systems (e.g. AllegroGraph) require this.
+          # @see http://github.com/bendiken/rdf/pull/43
+          uuid = RDF::Util::UUID.generate(options) until uuid =~ options[:grammar]
+        else
+          uuid = RDF::Util::UUID.generate(options)
       end
+      self.new(uuid)
     end
 
     ##