spira 0.0.8 → 0.0.9

data/AUTHORS

@@ -1,2 +1,3 @@
 * Ben Lavender <blavender@gmail.com>
+* Arto Bendiken <arto@bendiken.net>
 * Nicholas J Humfrey <njh@aelius.com>

data/CHANGES.md

@@ -1,4 +1,18 @@
 # Changelog for Spira <http://github.com/datagraph/spira>
+
+## 0.0.9
+ * Fix a bug with Spira::Types::Any that prevented blank node objects
+ * Added Spira::Resource#copy, #copy!, #copy_resource!, and #rename!
+ * Fix a bug with fragment RDF::URI arguments that prevented correct URI
+   construction
+ * Added Spira::Resource.project(subject, attributes, &block), which creates a
+   new instance without attempting to perform any base_uri logic on the given
+   subject. This provides a supported API entry point for implementors to
+   create their own domain-specific URI construction.
+ * Updating a value to nil will now remove it from the repository on #save!
+ * Tweaks to dirty tracking to correctly catch both changed and updated values.
+   All tests pass for the first time with this change.
+
 ## 0.0.8
  * Remove type checking for repository addition.  More power in return for 
    slightly more difficult error messages.

data/VERSION

@@ -1 +1 @@
-0.0.8
+0.0.9

data/lib/spira/extensions.rb

@@ -0,0 +1,14 @@
+# Extensions to other modules for use by Spira
+#
+
+class RDF::Literal
+
+  def self.unserialize(rdf_value)
+    rdf_value.object
+  end
+
+  def self.unserialize(ruby_value)
+    self.class.new(ruby_value)
+  end
+
+end

data/lib/spira/resource/class_methods.rb

@@ -43,7 +43,7 @@ module Spira
       # Spira does not have 'find' or 'create' functions.  As RDF identifiers
       # are globally unique, they all simply 'are'.
       #
-      # On calling `for`, a new instance is created for the given URI.  The
+      # On calling `for`, a new projection is created for the given URI.  The
       # first time access is attempted on a field, the repository will be
       # queried for existing attributes, which will be used for the given URI.
       # Underlying repositories are not accessed at the time of calling `for`.
@@ -66,11 +66,28 @@ module Spira
       # @return  [Spira::Resource] The newly created instance
       # @see http://rdf.rubyforge.org/RDF/URI.html
       def for(identifier, attributes = {}, &block)
+        self.project(id_for(identifier), attributes, &block)
+      end
+
+      ##
+      # Create a new instance with the given subjet without any modification to
+      # the given subject at all.  This method exists to provide an entry point
+      # for implementing classes that want to create a more intelligent .for
+      # and/or .id_for for their given use cases, such as simple string
+      # appending to base URIs or calculated URIs from other representations.
+      #
+      # @example Using simple string concatentation with base_uri in .for instead of joining delimiters
+      #     def for(identifier, attributes = {}, &block)
+      #       self.project(RDF::URI(self.base_uri.to_s + identifier.to_s), attributes, &block)
+      #     end
+      # @param [RDF::URI, RDF::Node] subject
+      # @param [Hash{Symbol => Any}] attributes Initial attributes
+      # @return [Spira::Resource] the newly created instance
+      def project(subject, attributes = {}, &block)
         if !self.type.nil? && attributes[:type]
           raise TypeError, "#{self} has an RDF type, #{self.type}, and cannot accept one as an argument."
         end
-        subject = id_for(identifier)
-        instance = self.new(attributes.merge(:_subject => subject), &block)
+        self.new(attributes.merge(:_subject => subject), &block)
       end
 
       ##
@@ -92,23 +109,40 @@ module Spira
       # @return [RDF::URI, RDF::Node]
       # @raise  [ArgumentError] If this class cannot create an identifier from the given argument
       # @see http://rdf.rubyforge.org/RDF/URI.html
+      # @see Spira::Resource.base_uri
+      # @see Spira::Resource.for
       def id_for(identifier)
-        case 
-          # Catches RDF::URI and implementing subclasses
-          when identifier.respond_to?(:to_uri)
-            identifier.to_uri
-          # Catches RDF::Nodes
+        case
+          # Absolute URI's go through unchanged
+          when identifier.is_a?(RDF::URI) && identifier.absolute?
+            identifier
+          # We don't have a base URI to join this fragment with, so go ahead and instantiate it as-is.
+          when identifier.is_a?(RDF::URI) && self.base_uri.nil?
+            identifier
+          # Blank nodes go through unchanged
           when identifier.respond_to?(:node?) && identifier.node?
             identifier
+          # Anything that can be an RDF::URI, we re-run this case statement
+          # on it for the fragment logic above.
+          when identifier.respond_to?(:to_uri) && !identifier.is_a?(RDF::URI)
+            id_for(identifier.to_uri)
+          # see comment with #to_uri above, this might be a fragment
           when identifier.is_a?(Addressable::URI)
-            RDF::URI.new(identifier)
-          # Treat identifier as a string, and create a URI out of it.
+            id_for(RDF::URI.new(identifier))
+          # This is a #to_s or a URI fragment with a base uri.  We'll treat them the same.
+          # FIXME: when #/ makes it into RDF.rb proper, this can all be wrapped
+          # into the one case statement above.
           else
-            uri = RDF::URI.new(identifier.to_s)
-            return uri if uri.absolute?
-            raise ArgumentError, "Cannot create identifier for #{self} by String without base_uri; RDF::URI required" if self.base_uri.nil?
-            separator = self.base_uri.to_s[-1,1] =~ /(\/|#)/ ? '' : '/'
-            RDF::URI.new(self.base_uri.to_s + separator + identifier.to_s)
+            uri = identifier.is_a?(RDF::URI) ? identifier : RDF::URI.new(identifier.to_s)
+            case
+              when uri.absolute?
+                uri
+              when self.base_uri.nil?
+                raise ArgumentError, "Cannot create identifier for #{self} by String without base_uri; an RDF::URI is required" if self.base_uri.nil?
+              else
+                separator = self.base_uri.to_s[-1,1] =~ /(\/|#)/ ? '' : '/'
+                RDF::URI.new(self.base_uri.to_s + separator + identifier.to_s)
+            end
         end
       end
 

data/lib/spira/resource/instance_methods.rb

@@ -12,8 +12,13 @@ module Spira
     # @see Spira::Resource::ClassMethods
     # @see Spira::Resource::DSL
     # @see Spira::Resource::Validations
-    module InstanceMethods 
- 
+    module InstanceMethods
+
+      # Marker for whether or not a field has been set or not; distinguishes
+      # nil and unset.
+      # @private
+      NOT_SET = ::Object.new.freeze
+
       ##
       # This instance's URI.
       #
@@ -39,6 +44,7 @@ module Spira
           yield(self)
           save!
         end
+        self
       end
   
       ##
@@ -52,12 +58,18 @@ module Spira
         @cache = opts[:_cache] || RDF::Util::Cache.new
         @cache[subject] = self
         @dirty = {}
-        # We need to save all attributes twice to track state changes in
-        # mutable objects, like lists
-        @attributes = promise { reload_attributes }
+        @attributes = {}
+        @attributes[:current] = {}
+        @attributes[:copied] = {}
         self.class.properties.each do |name, predicate|
-          attribute_set(name, opts[name]) unless opts[name].nil?
+          case opts[name].nil?
+            when false
+              attribute_set(name, opts[name])
+            when true
+              @attributes[:copied][name] = NOT_SET
+          end
         end
+        @attributes[:original] = promise { reload_attributes }
       end
 
       ##
@@ -68,8 +80,6 @@ module Spira
       def reload_attributes()
         statements = self.class.repository_or_fail.query(:subject => @subject)
         attributes = {}
-        attributes[:original] = {}
-        attributes[:current] = {}
 
         # Set attributes for each statement corresponding to a predicate
         self.class.properties.each do |name, property|
@@ -81,22 +91,12 @@ module Spira
                 values << self.class.build_value(statement,property[:type], @cache)
               end
             end
-            attributes[:current][name] = values
-            attributes[:original][name] = values.dup
+            attributes[name] = values
           else
             statement = statements.query(:subject => @subject, :predicate => property[:predicate]).first unless statements.empty?
-            attributes[:current][name] = self.class.build_value(statement, property[:type], @cache)
-
-            # Lots of things like Fixnums and Nil can't be dup'd, but they are
-            # all immutable, so if we can't dup, it's no problem for dirty tracking.
-            begin
-              attributes[:original][name] = attributes[:current][name].dup
-            rescue TypeError
-              attributes[:original][name] = attributes[:current][name]
-            end
+            attributes[name] = self.class.build_value(statement, property[:type], @cache)
           end
         end
-
         attributes
       end
 
@@ -225,11 +225,12 @@ module Spira
               end
               self.class.repository_or_fail.insert(*repo)
             else
-              self.class.repository_or_fail.insert(RDF::Statement.new(subject, predicate[:predicate], self.class.build_rdf_value(attribute_get(property), self.class.properties[property][:type])))
+              self.class.repository_or_fail.insert(RDF::Statement.new(subject, predicate[:predicate], self.class.build_rdf_value(attribute_get(property), self.class.properties[property][:type]))) unless attribute_get(property).nil?
             end
           end
-          @dirty[property] = nil
           @attributes[:original][property] = attribute_get(property)
+          @dirty[property] = nil
+          @attributes[:copied][property] = NOT_SET
         end
         self.class.repository_or_fail.insert(RDF::Statement.new(@subject, RDF.type, type)) unless type.nil?
       end
@@ -309,8 +310,13 @@ module Spira
             case
               when @dirty[name] == true
                 true
-              else 
-                @attributes[:current][name] != @attributes[:original][name]
+              else
+                case @attributes[:copied][name]
+                  when NOT_SET
+                    false
+                  else
+                    @attributes[:copied][name] != @attributes[:original][name]
+                end
             end
           end
       end
@@ -320,7 +326,26 @@ module Spira
       #
       # @private
       def attribute_get(name)
-        @attributes[:current][name]
+        case @dirty[name]
+          when true
+            @attributes[:current][name]
+          else
+            case @attributes[:copied][name].equal?(NOT_SET)
+              when true
+                dup = if @attributes[:original][name].is_a?(Spira::Resource)
+                  @attributes[:original][name]
+                else
+                  begin
+                    @attributes[:original][name].dup
+                  rescue TypeError
+                    @attributes[:original][name]
+                  end
+                end
+                @attributes[:copied][name] = dup
+              when false
+                @attributes[:copied][name]
+            end
+        end
       end
 
       ##
@@ -449,6 +474,61 @@ module Spira
         self.class.repository.query(:subject => subject)
       end
 
+      ##
+      # Returns a new instance of this class with the new subject instead of self.subject
+      #
+      # @param [RDF::Resource] new_subject
+      # @return [Spira::Resource] copy
+      def copy(new_subject)
+        copy = self.class.for(new_subject)
+        self.class.properties.each_key { |property| copy.attribute_set(property, self.attribute_get(property)) }
+        copy
+      end
+
+      ##
+      # Returns a new instance of this class with the new subject instead of
+      # self.subject after saving the new copy to the repository.
+      #
+      # @param [RDF::Resource] new_subject
+      # @return [Spira::Resource, String] copy
+      def copy!(new_subject)
+        copy(new_subject).save!
+      end
+
+      ##
+      # Copies all data, including non-model data, about this resource to
+      # another URI.  The copy is immediately saved to the repository.
+      #
+      # @param [RDF::Resource] new_subject
+      # @return [Spira::Resource, String] copy
+      def copy_resource!(new_subject)
+        new_subject = self.class.id_for(new_subject)
+        update_repository = RDF::Repository.new
+        data.each do |statement|
+          update_repository << RDF::Statement.new(new_subject, statement.predicate, statement.object) 
+        end
+        self.class.repository.insert(update_repository)
+        new_subject.as(self.class)
+      end
+
+      ## 
+      # Rename this resource in the repository to the new given subject.
+      # Changes are immediately saved to the repository.
+      #
+      # @param [RDF::Resource] new_subject
+      # @return [Spira::Resource, String] new_resource
+      def rename!(new_subject)
+        new = copy_resource!(new_subject)
+        object_statements = self.class.repository.query(:object => subject)
+        update_repository = RDF::Repository.new
+        object_statements.each do |statement|
+          update_repository << RDF::Statement.new(statement.subject, statement.predicate, new.subject)
+        end
+        self.class.repository.insert(update_repository)
+        destroy!(:completely)
+        new
+      end  
+
       ## We have defined #each and can do this fun RDF stuff by default
       include ::RDF::Enumerable, ::RDF::Queryable
 

data/lib/spira/types/any.rb

@@ -12,12 +12,12 @@ module Spira::Types
     include Spira::Type
 
     def self.unserialize(value)
-      value.respond_to?(:to_uri) ? value.to_uri : value.object
+      value.respond_to?(:object) ? value.object : value
     end
 
     def self.serialize(value)
       raise TypeError, "Spira::Types::Any cannot serialize collections" if value.is_a?(Array)
-      value.respond_to?(:to_uri) ? value.to_uri : RDF::Literal.new(value)
+      value.is_a?(RDF::Value) ? value : RDF::Literal.new(value)
     end
 
   end

data/lib/spira/version.rb

@@ -2,7 +2,7 @@ module Spira
   module VERSION
     MAJOR = 0
     MINOR = 0
-    TINY  = 8
+    TINY  = 9
     EXTRA = nil
 
     STRING = [MAJOR, MINOR, TINY].join('.')

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 8
-  version: 0.0.8
+  - 9
+  version: 0.0.9
 platform: ruby
 authors: 
 - Ben Lavender
@@ -15,7 +15,7 @@ bindir:
 - bin
 cert_chain: []
 
-date: 2010-09-22 00:00:00 -05:00
+date: 2010-10-20 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -70,8 +70,8 @@ dependencies:
         segments: 
         - 0
         - 2
-        - 2
-        version: 0.2.2
+        - 3
+        version: 0.2.3
   type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
@@ -119,6 +119,7 @@ files:
 - lib/spira/base.rb
 - lib/spira/errors.rb
 - lib/spira/exceptions.rb
+- lib/spira/extensions.rb
 - lib/spira/resource/class_methods.rb
 - lib/spira/resource/dsl.rb
 - lib/spira/resource/instance_methods.rb