spira 0.0.12 → 0.5.0

data/lib/spira/errors.rb

@@ -1,94 +0,0 @@
-module Spira
-
-  ##
-  # Spira::Errors represents a collection of validation errors for a Spira
-  # resource.  It tracks a list of errors for each field.
-  #
-  # This class does not perform validations.  It only tracks the results of
-  # them.
-  class Errors
-
-    ##
-    # Creates a new Spira::Errors
-    #
-    # @return [Spira::Errors]
-    def initialize
-      @errors = {}
-    end
-
-    ##
-    # Returns true if there are no errors, false otherwise
-    #
-    # @return [true, false]
-    def empty?
-      @errors.all? do |field, errors| errors.empty? end
-    end
-
-    ##
-    # Returns true if there are errors, false otherwise
-    #
-    # @return [true, false]
-    def any?
-      !empty?
-    end
-
-    ##
-    # Returns true if the given property or list has any errors
-    #
-    # @param [Symbol] name The name of the property or list
-    # @return [true, false]
-    def any_for?(property)
-      !(@errors[property].nil?) && !(@errors[property].empty?)
-    end
- 
-    ##
-    # Add an error to a given property or list
-    #
-    # @example Add an error to a property
-    #     errors.add(:username, "cannot be nil")
-    # @param [Symbol] property The property or list to add the error to
-    # @param [String] problem The error
-    # @return [Void]
-    def add(property, problem)
-      @errors[property] ||= []
-      @errors[property].push problem
-    end
-
-    ##
-    # The list of errors for a given property or list
-    #
-    # @example Get the errors for the `:username` field
-    #     errors.add(:username, "cannot be nil")
-    #     errors.for(:username) #=> ["cannot be nil"]
-    # @param [Symbol] property The property or list to check
-    # @return [Array<String>] The list of errors
-    def for(property)
-      @errors[property]
-    end
-
-    ##
-    # Clear all errors
-    # 
-    # @return [Void]
-    def clear
-      @errors = {}
-    end
-
-    ##
-    # Return all errors as strings
-    #
-    # @example Get all errors
-    #     errors.add(:username, "cannot be nil")
-    #     errors.each #=> ["username cannot be nil"]
-    # @return [Array<String>]
-    def each
-      @errors.map do |property, problems|
-        problems.map do |problem|
-          property.to_s + " " + problem  
-        end
-      end.flatten
-    end
-
-
-  end
-end

data/lib/spira/extensions.rb

@@ -1,14 +0,0 @@
-# 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

@@ -1,260 +0,0 @@
-module Spira
- module Resource
-
-   ##
-   # This module contains all class methods available to a declared Spira::Resource class.
-   # {Spira::Resource} contains more information about Spira resources.
-   #
-   # @see Spira::Resource
-   # @see Spira::Resource::InstanceMethods
-   # @see Spira::Resource::DSL
-    module ClassMethods
-
-      ##
-      # A symbol name for the repository this class is currently using.
-      attr_reader :repository_name
-
-      ##
-      # The current repository for this class
-      # 
-      # @return [RDF::Repository, nil]
-      # @private
-      def repository
-        name = @repository_name || :default
-        Spira.repository(name)
-      end
-
-      ##
-      # Get the current repository for this class, and raise a
-      # Spira::NoRepositoryError if it is nil.
-      #
-      # @raise  [Spira::NoRepositoryError]
-      # @return [RDF::Repository]
-      # @private
-      def repository_or_fail
-        repository || (raise Spira::NoRepositoryError, "#{self} is configured to use :#{@repository_name || 'default'} as a repository, but it has not been set.")
-      end
-
-      ##
-      # Create a new projection instance of this class for the given URI.  If a
-      # class has a base_uri given, and the argument is not an `RDF::URI`, the
-      # given identifier will be appended to the base URI.
-      #
-      # Spira does not have 'find' or 'create' functions.  As RDF identifiers
-      # are globally unique, they all simply 'are'.
-      #
-      # 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`.
-      # 
-      # A class with a base URI may still be projected for any URI, whether or
-      # not it uses the given resource class' base URI.
-      #
-      # @raise [TypeError] if an RDF type is given in the attributes and one is
-      # given in the attributes.  
-      # @raise [ArgumentError] if a non-URI is given and the class does not
-      # have a base URI.  
-      # @overload for(uri, attributes = {})
-      #   @param [RDF::URI] uri The URI to create an instance for
-      #   @param [Hash{Symbol => Any}] attributes Initial attributes
-      # @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 = {}, &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
-        self.new(attributes.merge(:_subject => subject), &block)
-      end
-
-      ##
-      # Alias for #for
-      #
-      # @see #for
-      def [](*args)
-        self.for(*args)
-      end
-
-      ##
-      # Creates a URI or RDF::Node based on a potential base_uri and string,
-      # URI, or Node, or Addressable::URI.  If not a URI or Node, the given
-      # identifier should be a string representing an absolute URI, or
-      # something responding to to_s which can be appended to a base URI, which
-      # this class must have.
-      #
-      # @param  [Any] Identifier
-      # @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
-          # 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)
-            id_for(RDF::URI.intern(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 = identifier.is_a?(RDF::URI) ? identifier : RDF::URI.intern(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.intern(self.base_uri.to_s + separator + identifier.to_s)
-            end
-        end
-      end
-
-
-      ##
-      # The number of URIs projectable as a given class in the repository.
-      # 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
-      # @return [Integer] the count
-      # @see Spira::Resource::DSL
-      def 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
-
-      ##
-      # 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
-      # 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_or_fail.query(:predicate => RDF.type, :object => @type).each_subject do |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
-      #
-      # @return [true, false]
-      def is_list?(property)
-        @lists.has_key?(property)
-      end
-
-      ##
-      # Handling inheritance
-      #
-      # @private
-      def inherited(child)
-        child.instance_eval do
-          include Spira::Resource
-        end
-        # FIXME: This is clearly brittle and ugly.
-        [:@base_uri, :@default_vocabulary, :@repository_name, :@type].each do |variable|
-          value = instance_variable_get(variable).nil? ? nil : instance_variable_get(variable).dup
-          child.instance_variable_set(variable, value)
-        end
-        [:@properties, :@lists, :@validators].each do |variable|
-          if child.instance_variable_get(variable).nil?
-            if instance_variable_get(variable).nil?
-              child.instance_variable_set(variable, nil)
-            else
-              child.instance_variable_set(variable, instance_variable_get(variable).dup)
-            end
-          elsif !(instance_variable_get(variable).nil?)
-            child.instance_variable_set(variable, instance_variable_get(variable).dup.merge(child.instance_variable_get(variable)))
-          end
-        end
-      end
-
-      ## 
-      # Handling module inclusions
-      #
-      # @private
-      def included(child)
-        inherited(child)
-      end
-
-      ## 
-      # The list of validation functions for this projection
-      #
-      # @return [Array<Symbol>]
-      def validators
-        @validators ||= []
-      end
-
-    end
-  end
-end

data/lib/spira/resource/dsl.rb

@@ -1,279 +0,0 @@
-module Spira
-  module Resource
-
-    ##
-    # This module consists of Spira::Resource class methods which correspond to
-    # the Spira resource class declaration DSL.  See {Spira::Resource} for more
-    # information.
-    #
-    # @see Spira::Resource
-    # @see Spira::Resource::ClassMethods
-    # @see Spira::Resource::InstanceMethods
-    # @see Spira::Resource::Validations
-    module DSL  
-
-      ##
-      # The name of the default repository to use for this class.  This
-      # repository will be queried and written to instead of the :default
-      # repository.
-      #
-      # @param  [Symbol] name
-      # @return [Void]
-      def default_source(name)
-        @repository_name = name
-        @repository = Spira.repository(name)
-      end
- 
-      ##
-      # The base URI for this class.  Attempts to create instances for non-URI
-      # objects will be appended to this base URI.
-      #
-      # @param  [String, RDF::URI] base uri
-      # @return [Void]
-      def base_uri(uri = nil)
-        @base_uri = uri unless uri.nil?
-        @base_uri
-      end
-     
-      ##
-      # The default vocabulary for this class.  Setting a default vocabulary
-      # will allow properties to be defined without a `:predicate` option.
-      # Predicates will instead be created by appending the property name to
-      # the given string.
-      #
-      # @param  [String, RDF::URI] base uri
-      # @return [Void]
-      def default_vocabulary(uri)
-        @default_vocabulary = uri
-      end
-
-
-      ## 
-      # Add a property to this class.  A property is an accessor field that
-      # represents an RDF predicate.
-      #
-      # @example A simple string property
-      #     property :name, :predicate => FOAF.name, :type => String
-      # @example A property which defaults to {Spira::Types::Any}
-      #     property :name, :predicate => FOAF.name
-      # @example An integer property
-      #     property :age,  :predicate => FOAF.age, :type => Integer
-      # @param  [Symbol] name The name of this property
-      # @param  [Hash{Symbol => Any}] opts property options
-      # @option opts [RDF::URI]            :predicate The RDF predicate which will refer to this property
-      # @option opts [Spira::Type, String] :type      (Spira::Types::Any) The
-      # type for this property.  If a Spira::Type is given, that class will be
-      # used to serialize and unserialize values.  If a String is given, it
-      # should be the String form of a Spira::Resource class name (Strings are
-      # used to prevent issues with load order).  
-      # @see Spira::Types
-      # @see Spira::Type
-      # @return [Void]
-      def property(name, opts = {} )
-        predicate = predicate_for(opts[:predicate], name)
-        type = type_for(opts[:type])
-        @properties[name] = { :predicate => predicate, :type => type }
-        add_accessors(name,opts)
-      end
-
-      ##
-      # The plural form of `property`.  `Has_many` has the same options as
-      # `property`, but instead of a single value, a Ruby Array of objects will
-      # be created instead.
-      #
-      # has_many corresponds to an RDF subject with several triples of the same
-      # predicate.  This corresponds to a Ruby Set, which will be returned when
-      # the property is accessed.  Arrays will be accepted for new values, but
-      # ordering and duplicate values will be lost on save.
-      #
-      # @see Spira::Resource::DSL#property
-      def has_many(name, opts = {})
-        property(name, opts)
-        @lists[name] = true
-      end
-
-      ##
-      # Validate this model with the given validator function name.
-      #
-      # @example
-      #     class Person
-      #       include Spira::Resource
-      #       property :name, :predicate => FOAF.name
-      #       validate :is_awesome
-      #       def is_awesome
-      #         assert(name =~ /Thor/, :name, "not awesome")
-      #       end
-      #     end
-      # @param  [Symbol] validator
-      # @return [Void]
-      def validate(validator)
-        validators << validator unless validators.include?(validator)
-      end
-
-
-      ##
-      # Associate an RDF type with this class.  RDF resources can be multiple
-      # types at once, but if they have an `RDF.type` statement for the given
-      # URI, this class can #count them.
-      #
-      # @param  [RDF::URI] uri The URI object of the `RDF.type` triple
-      # @return [Void]
-      # @see http://rdf.rubyforge.net/RDF/URI.html
-      # @see http://rdf.rubyforge.org/RDF.html#type-class_method
-      # @see Spira::Resource::ClassMethods#count 
-      def type(uri = nil)
-        unless uri.nil?
-          @type = case uri
-            when RDF::URI
-              uri
-            else
-              raise TypeError, "Cannot assign type #{uri} (of type #{uri.class}) to #{self}, expected RDF::URI"
-          end
-        end
-        @type
-      end
-
-      # Build a Ruby value from an RDF value.
-      #
-      # @private
-      def build_value(statement, type, cache)
-        case
-          when statement == nil
-            nil
-          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)
-            cache[statement.object] = promise { klass.for(statement.object, :_cache => cache) }
-            cache[statement.object]
-          else
-            raise TypeError, "Unable to unserialize #{statement.object} as #{type}"
-        end
-      end
-
-      # Build an RDF value from a Ruby value for a property
-      # @private
-      def build_rdf_value(value, type)
-        case
-          when type.respond_to?(:serialize)
-            type.serialize(value)
-          when value && value.class.ancestors.include?(Spira::Resource)
-            klass = classize_resource(type)
-            unless klass.ancestors.include?(value.class)
-              raise TypeError, "#{value} is an instance of #{value.class}, expected #{klass}"
-            end
-            value.subject
-          when type.is_a?(Symbol) || type.is_a?(String)
-            klass = classize_resource(type)
-          else
-            raise TypeError, "Unable to serialize #{value} as #{type}"
-        end
-      end
-
-      private
-
-      # Return the appropriate class object for a string or symbol
-      # representation.  Throws errors correctly if the given class cannot be
-      # located, or if it is not a Spira::Resource
-      # 
-      def classize_resource(type)
-        klass = nil
-        begin 
-          klass = qualified_const_get(type.to_s)
-        rescue NameError
-          raise NameError, "Could not find relation class #{type} (referenced as #{type} by #{self})"
-            klass.is_a?(Class) && klass.ancestors.include?(Spira::Resource)
-        end
-        unless klass.is_a?(Class) && klass.ancestors.include?(Spira::Resource)
-          raise TypeError, "#{type} is not a Spira Resource (referenced as #{type} by #{self})"
-        end
-        klass
-      end
-
-      # Resolve a constant from a string, relative to this class' namespace, if
-      # available, and from root, otherwise.
-      #
-      # FIXME: this is not really 'qualified', but it's one of those
-      # impossible-to-name functions.  Open to suggestions.
-      #
-      # @author njh
-      # @private
-      def qualified_const_get(str)
-        path = str.to_s.split('::')
-        from_root = path[0].empty?
-        if from_root
-          from_root = []
-          path = path[1..-1]
-        else
-          start_ns = ((Class === self)||(Module === self)) ? self : self.class
-          from_root = start_ns.to_s.split('::')
-        end
-        until from_root.empty?
-          begin
-            return (from_root+path).inject(Object) { |ns,name| ns.const_get(name) }
-          rescue NameError
-            from_root.delete_at(-1)
-          end
-        end
-        path.inject(Object) { |ns,name| ns.const_get(name) }
-      end
-
-      ##
-      # Determine the type for a property based on the given type option
-      #
-      # @param [nil, Spira::Type, Constant] type
-      # @return Spira::Type
-      # @private
-      def type_for(type) 
-        case
-            when type.nil?
-              Spira::Types::Any
-            when type.is_a?(Symbol) || type.is_a?(String)
-              type
-            when !(Spira.types[type].nil?)
-              Spira.types[type]
-            else
-              raise TypeError, "Unrecognized type: #{type}"
-          end
-      end
-
-      ##
-      # Determine the predicate for a property based on the given predicate, name, and default vocabulary
-      #
-      # @param  [#to_s, #to_uri] predicate
-      # @param  [Symbol] name
-      # @return [RDF::URI]
-      # @private
-      def predicate_for(predicate, name)
-        case
-          when predicate.respond_to?(:to_uri) && predicate.to_uri.absolute?
-            predicate
-          when @default_vocabulary.nil?
-            raise ResourceDeclarationError, "A :predicate option is required for types without a default vocabulary"
-          else
-            # FIXME: use rdf.rb smart separator after 0.3.0 release
-            separator = @default_vocabulary.to_s[-1,1] =~ /(\/|#)/ ? '' : '/'
-            RDF::URI.intern(@default_vocabulary.to_s + separator + name.to_s)
-        end
-      end
-
-      ##
-      # Add getters and setters for a property or list.
-      # @private
-      def add_accessors(name, opts)
-        name_equals = (name.to_s + "=").to_sym
-
-        self.send(:define_method,name_equals) do |arg|
-          attribute_set(name, arg)
-        end
-        self.send(:define_method,name) do 
-          attribute_get(name)
-        end
-
-      end
-
-    end
-  end
-end