spira 0.0.7 → 0.0.8

data/CHANGES.md

@@ -1,4 +1,22 @@
 # Changelog for Spira <http://github.com/datagraph/spira>
+## 0.0.8
+ * Remove type checking for repository addition.  More power in return for 
+   slightly more difficult error messages.
+ * Repositories added via klass, *arg are now only instantiated on first use
+   instead of immediately.
+ * RDF::URI#as, RDF::Node#as, Resource.for, and Resource#new can now all accept
+   a block, which yields the new instance and saves it after the block.
+ * Clarify error message when default repository is not setup
+ * Added a weak-reference identity map for each instance.  Any circular references in
+   relations will now return the original object instead of querying for a new 
+   one.
+ * Use a weak-reference identity map when iterating by class.
+ * When serializing/unserializing, duck typing (:serialize, :unserialize) is now
+   permitted.
+
+## 0.0.7
+ * Added Resource.[], an alias for Resource.for
+ * Resource.each now correctly raises an exception when a repository isn't found
 
 ## 0.0.6
  * Added #exists?, which returns a boolean if an instance exists in

data/README

@@ -90,7 +90,7 @@ Then use your model classes, in a way more or less similar to any number of ORMs
     artist.cds = [cd]
     artist.save!
 
-    queen = Arist.for('queen')
+    queen = Artist.for('queen')
     hits = CD.for 'queens-greatest-hits'
     hits.artist == artist == queen
 
@@ -117,7 +117,7 @@ Any call to 'for' with a valid identifier will always return an object with nil
 fields.  It's a way of looking at a given resource, not a closed-world mapping
 to one.
 
-You can use also use blank nodes more or less as you would a URI:
+You can also use blank nodes more or less as you would a URI:
 
     remix_artist = Artist.for(RDF::Node.new)
     # => <Artist @subject=#<RDF::Node:0xd1d314(_:g13751060)>>

data/VERSION

@@ -1 +1 @@
-0.0.7
+0.0.8

data/lib/spira.rb

@@ -60,12 +60,10 @@ module Spira
   # @see RDF::Repository
   def add_repository(name, klass, *args)
     repositories[name] = case klass
-      when RDF::Repository
-        klass
       when Class
-        klass.new(*args)
+        promise { klass.new(*args) }
       else
-        raise ArgumentError, "Could not add repository #{klass} as #{name}; expected an RDF::Repository or class name"
+        klass
      end
      if (name == :default) && settings[:repositories][name].nil?
         warn "WARNING: Adding nil default repository"
@@ -128,10 +126,12 @@ module RDF
     #     RDF::URI('http://example.org/person/bob').as(Person)
     # @param [Class] klass
     # @param [*Any] args Any arguments to pass to klass.for
+    # @yield [self] Executes a given block and calls `#save!`
+    # @yieldparam [self] self The newly created instance
     # @return [Klass] An instance of klass
-    def as(klass, *args)
+    def as(klass, *args, &block)
       raise ArgumentError, "#{klass} is not a Spira resource" unless klass.is_a?(Class) && klass.ancestors.include?(Spira::Resource)
-      klass.for(self, *args)
+      klass.for(self, *args, &block)
     end
   end
 
@@ -144,6 +144,8 @@ module RDF
     #     RDF::Node.new.as(Person)
     # @param [Class] klass
     # @param [*Any] args Any arguments to pass to klass.for
+    # @yield [self] Executes a given block and calls `#save!`
+    # @yieldparam [self] self The newly created instance
     # @return [Klass] An instance of klass
     def as(klass, *args)
       raise ArgumentError, "#{klass} is not a Spira resource" unless klass.is_a?(Class) && klass.ancestors.include?(Spira::Resource)

data/lib/spira/resource/class_methods.rb

@@ -32,7 +32,7 @@ module Spira
       # @return [RDF::Repository]
       # @private
       def repository_or_fail
-        repository || (raise Spira::NoRepositoryError, "#{self} is configured to use #{@repository_name} as a repository, but it has not been set.")
+        repository || (raise Spira::NoRepositoryError, "#{self} is configured to use :#{@repository_name || 'default'} as a repository, but it has not been set.")
       end
 
       ##
@@ -61,14 +61,16 @@ module Spira
       # @overload for(identifier, attributes = {})
       #   @param [Any] uri The identifier to append to the base URI for this class
       #   @param [Hash{Symbol => Any}] attributes Initial attributes
+      # @yield [self] Executes a given block and calls `#save!`
+      # @yieldparam [self] self The newly created instance
       # @return  [Spira::Resource] The newly created instance
       # @see http://rdf.rubyforge.org/RDF/URI.html
-      def for(identifier, attributes = {})
+      def for(identifier, 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)
-        self.new(attributes.merge(:_subject => subject))
+        instance = self.new(attributes.merge(:_subject => subject), &block)
       end
 
       ##
@@ -124,6 +126,23 @@ module Spira
         repository.query(:predicate => RDF.type, :object => @type).subjects.count
       end
 
+      ##
+      # A cache of iterated instances of this projection
+      #
+      # @return [RDF::Util::Cache]
+      # @private
+      def cache
+        @cache ||= RDF::Util::Cache.new
+      end
+
+      ##
+      # Clear the iteration cache
+      # 
+      # @return [void]
+      def reload
+        @cache = nil
+      end
+
       ##
       # Enumerate over all resources projectable as this class.  This method is
       # only valid for classes which declare a `type` with the `type` method in
@@ -146,12 +165,12 @@ module Spira
             enum_for(:each)
           else
             repository_or_fail.query(:predicate => RDF.type, :object => @type).each_subject do |subject|
-              block.call(self.for(subject))
+              self.cache[subject] ||= self.for(subject)
+              block.call(cache[subject])
             end
         end
       end
 
-
       ##
       # Returns true if the given property is a has_many property, false otherwise
       #

data/lib/spira/resource/dsl.rb

@@ -132,15 +132,18 @@ module Spira
       # Build a Ruby value from an RDF value.
       #
       # @private
-      def build_value(statement, type)
+      def build_value(statement, type, cache)
         case
           when statement == nil
             nil
-          when type.is_a?(Class) && type.ancestors.include?(Spira::Type)
+          when !cache[statement.object].nil?
+            cache[statement.object]
+          when type.respond_to?(:unserialize)
             type.unserialize(statement.object)
           when type.is_a?(Symbol) || type.is_a?(String)
             klass = classize_resource(type)
-            promise { klass.for(statement.object) }
+            cache[statement.object] = promise { klass.for(statement.object, :_cache => cache) }
+            cache[statement.object]
           else
             raise TypeError, "Unable to unserialize #{statement.object} as #{type}"
         end
@@ -150,7 +153,7 @@ module Spira
       # @private
       def build_rdf_value(value, type)
         case
-          when type.is_a?(Class) && type.ancestors.include?(Spira::Type)
+          when type.respond_to?(:serialize)
             type.serialize(value)
           when value && value.class.ancestors.include?(Spira::Resource)
             klass = classize_resource(type)

data/lib/spira/resource/instance_methods.rb

@@ -27,12 +27,18 @@ module Spira
       # {Spira::Resource::ClassMethods#for} instead.
       #
       # @param [Hash{Symbol => Any}] opts Default attributes for this instance
+      # @yield [self] Executes a given block and calls `#save!`
+      # @yieldparam [self] self The newly created instance
       # @see Spira::Resource::ClassMethods#for
       # @see RDF::URI#as
       # @see RDF::Node#as
       def initialize(opts = {})
         @subject = opts[:_subject] || RDF::Node.new
         reload(opts)
+        if block_given?
+          yield(self)
+          save!
+        end
       end
   
       ##
@@ -43,6 +49,8 @@ module Spira
       # @param   [Hash{Symbol => Any}] opts
       # @option opts [Symbol] :any A property name.  Sets the given property to the given value.
       def reload(opts = {})
+        @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
@@ -70,14 +78,14 @@ module Spira
             collection = statements.query(:subject => @subject, :predicate => property[:predicate]) unless statements.empty?
             unless collection.nil?
               collection.each do |statement|
-                values << self.class.build_value(statement,property[:type])
+                values << self.class.build_value(statement,property[:type], @cache)
               end
             end
             attributes[:current][name] = values
             attributes[:original][name] = values.dup
           else
             statement = statements.query(:subject => @subject, :predicate => property[:predicate]).first unless statements.empty?
-            attributes[:current][name] = self.class.build_value(statement, property[:type])
+            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.

data/lib/spira/version.rb

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

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 7
-  version: 0.0.7
+  - 8
+  version: 0.0.8
 platform: ruby
 authors: 
 - Ben Lavender
@@ -15,7 +15,7 @@ bindir:
 - bin
 cert_chain: []
 
-date: 2010-09-06 00:00:00 -05:00
+date: 2010-09-22 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency