spira 0.0.1 → 0.0.2

data/README

@@ -5,12 +5,14 @@ It's time to breathe life into your linked data.
 ---
 
 ## Synopsis
-Spira is a framework for using the information in RDF.rb repositories as model
+Spira is a framework for using the information in [RDF.rb][] repositories as model
 objects.  It gives you the ability to work in a resource-oriented way without
 losing access to statement-oriented nature of linked data, if you so choose.
 It can be used either to access existing RDF data in a resource-oriented way,
 or to create a new store of RDF data based on simple defaults.
 
+An introductory blog post is at <http://blog.datagraph.org/2010/05/spira>
+
 ### Example
 
     class Person
@@ -332,12 +334,12 @@ built in `assert` and assert helpers such as `assert_set` and
       end
     end
 
-    dancing-queen.artist = nickelback
-    dancing-queen.save!  #=> ValidationError
-    dancing-queen.errors.each => ["artist cannot be Nickelback"]
+    dancing_queen.artist = nickelback
+    dancing_queen.save!  #=> ValidationError
+    dancing_queen.errors.each #=> ["artist cannot be Nickelback"]
 
-    dancing-queen.artist = abba
-    dancing-queen.save!  #=> true
+    dancing_queen.artist = abba
+    dancing_queen.save!  #=> true
 
 
 ## Inheritance
@@ -391,3 +393,4 @@ Fork it on Github and go.  Please make sure you're kosher with the UNLICENSE
 file before contributing.
 
 [public-rdf-ruby w3c mailing list]:         http://lists.w3.org/Archives/Public/public-rdf-ruby/
+[RDF.rb]:                                   http://rdf.rubyforge.org

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/spira.rb

@@ -1,4 +1,5 @@
 require 'rdf'
+require 'spira/exceptions'
 
 ##
 # Spira is a framework for building projections of RDF data into Ruby classes.
@@ -103,7 +104,6 @@ module Spira
   autoload :Errors,           'spira/errors'
   autoload :VERSION,          'spira/version'
 
-  class ValidationError < StandardError; end
 end
 
 module RDF

data/lib/spira/exceptions.rb

@@ -0,0 +1,11 @@
+module Spira
+
+  ##
+  # For cases when a method is called which requires a `type` method be
+  # declared on a Spira class.
+  class NoTypeError < StandardError ; end
+
+  ##
+  # For cases when a projection fails a validation check
+  class ValidationError < StandardError; end
+end

data/lib/spira/resource.rb

@@ -64,8 +64,8 @@ module Spira
     end
     
     # This lets including classes reference vocabularies without the RDF:: prefix
-    include RDF
     include Spira::Types
+    include RDF
     include InstanceMethods
 
   end

data/lib/spira/resource/class_methods.rb

@@ -72,14 +72,12 @@ module Spira
         case identifier
           when RDF::URI
             identifier
-          when String
-            uri = RDF::URI.new(identifier)
+          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)
-          else
-            raise ArgumentError, "Cannot create an identifier for #{self} from #{identifier}, expected RDF::URI or String"
+            RDF::URI.new(self.base_uri.to_s + separator + identifier.to_s)
         end
       end
 
@@ -89,15 +87,42 @@ module Spira
       # This method is only valid for classes which declare a `type` with the
       # `type` method in the DSL.
       #
-      # @raise  [TypeError] if the resource class does not have an RDF type declared
+      # @raise  [Spira::NoTypeError] if the resource class does not have an RDF type declared
       # @return [Integer] the count
       # @see Spira::Resource::DSL
       def count
-        raise TypeError, "Cannot count a #{self} without a reference type URI." if @type.nil?
-        result = repository.query(:predicate => RDF.type, :object => @type)
-        result.count
+        raise Spira::NoTypeError, "Cannot count a #{self} without a reference type URI." if @type.nil?
+        repository.query(:predicate => RDF.type, :object => @type).subjects.count
+      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
+      # the DSL.
+      #
+      # @raise  [Spira::NoTypeError] if the resource class does not have an RDF type declared
+      # @overload each
+      #   @yield [instance] A block to perform for each available projection of this class
+      #   @yieldparam [self] instance
+      #   @yieldreturn [Void]
+      #   @return [Void]
+      #
+      # @overload each
+      #   @return [Enumerator]
+      # @see Spira::Resource::DSL
+      def each(&block)
+        raise Spira::NoTypeError, "Cannot count a #{self} without a reference type URI." if @type.nil?
+        case block_given?
+          when false
+            enum_for(:each)
+          else
+            repository.query(:predicate => RDF.type, :object => @type).each_subject do |subject|
+              block.call(self.for(subject))
+            end
+        end
       end
 
+
       ##
       # Returns true if the given property is a has_many property, false otherwise
       #

data/lib/spira/resource/instance_methods.rb

@@ -176,7 +176,23 @@ module Spira
       def type=(type)
         raise TypeError, "Cannot reassign RDF.type for #{self}; consider appending to a has_many :types"
       end
- 
+
+      ##
+      # Returns the RDF representation of this resource.
+      #
+      # @return [RDF::Enumerable]
+      def to_rdf
+        self
+      end
+      
+      ##
+      # Returns the URI representation of this resource.
+      #
+      # @return [RDF::URI]
+      def to_uri
+        uri
+      end
+
       ##
       # A developer-friendly view of this projection
       #
@@ -255,6 +271,7 @@ module Spira
       def ==(other)
         case other
           # TODO: define behavior for equality on subclasses.
+          # TODO: should we compare attributes here?
           when self.class
             @uri == other.uri 
           when RDF::Enumerable

data/lib/spira/types.rb

@@ -19,6 +19,7 @@ module Spira
     require 'spira/types/any'
     require 'spira/types/string'
     require 'spira/types/float'
+    require 'spira/types/uri'
 
 
   end

data/lib/spira/types/uri.rb

@@ -0,0 +1,25 @@
+module Spira::Types
+
+  ##
+  # This type takes RDF Resource objects and provides RDF::URI objects for the
+  # ruby representation.
+  #
+  # @see Spira::Type
+  # @see http://rdf.rubyforge.org/RDF/URI.html
+  class URI
+
+    include Spira::Type
+
+    def self.unserialize(value)
+      RDF::URI(value)
+    end
+
+    def self.serialize(value)
+      RDF::URI(value)
+    end
+
+    register_alias :uri
+    register_alias RDF::URI
+
+  end
+end

data/lib/spira/version.rb

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

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Ben Lavender
@@ -15,7 +15,7 @@ bindir:
 - bin
 cert_chain: []
 
-date: 2010-05-21 00:00:00 +02:00
+date: 2010-06-04 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -116,6 +116,7 @@ files:
 - UNLICENSE
 - VERSION
 - lib/spira/errors.rb
+- lib/spira/exceptions.rb
 - lib/spira/resource/class_methods.rb
 - lib/spira/resource/dsl.rb
 - lib/spira/resource/instance_methods.rb
@@ -127,10 +128,11 @@ files:
 - lib/spira/types/float.rb
 - lib/spira/types/integer.rb
 - lib/spira/types/string.rb
+- lib/spira/types/uri.rb
 - lib/spira/types.rb
 - lib/spira/version.rb
 - lib/spira.rb
-has_rdoc: false
+has_rdoc: yard
 homepage: http://spira.rubyforge.org
 licenses: 
 - Public Domain