occi-core 4.1.3 → 4.2.0

data/lib/occi/core/entity.rb

@@ -3,8 +3,10 @@ module Occi
     class Entity
 
       include Occi::Helpers::Inspect
+      include Occi::Helpers::Comparators::Entity
 
-      attr_accessor :mixins, :attributes, :actions, :id, :model, :kind, :location
+      attr_accessor :mixins, :attributes, :actions, :id, :model, :location
+      attr_reader :kind
 
       class_attribute :kind, :mixins, :attributes, :actions
 
@@ -64,27 +66,25 @@ module Occi
         @kind = self.class.kind.clone
         @mixins = Occi::Core::Mixins.new mixins
         @mixins.entity = self
+
         attributes = self.class.attribute_properties if attributes.blank?
         if attributes.kind_of? Occi::Core::Attributes
           @attributes = attributes.convert
         else
           @attributes = Occi::Core::Attributes.new attributes
         end
+        @attributes['occi.core.id'] ||= UUIDTools::UUID.random_create.to_s
+
         @actions = Occi::Core::Actions.new actions
         @location = location
       end
 
-      # @return [Occi::Core::Kind]
-      def kind
-        @kind
-      end
-
       # @param [Occi::Core::Kind,String] kind
       # @return [Occi::Core::Kind]
       def kind=(kind)
         if kind.kind_of? String
           scheme, term = kind.split '#'
-          kind = Occi::Core::Category.get_class scheme, term
+          kind = Occi::Core::Kind.get_class scheme, term
         end
         @kind = kind
       end
@@ -115,7 +115,7 @@ module Occi
 
       # @return [UUIDTools::UUID] id of the entity
       def id
-        @id ||= @attributes.occi.core.id if @attributes.occi.core if @attributes.occi
+        @id ||= @attributes.occi_.core_.id
         @id
       end
 
@@ -127,17 +127,20 @@ module Occi
 
       # @return [String] title attribute of entity
       def title
-        @attributes.occi.core.title if @attributes.occi.core if @attributes.occi
+        @attributes.occi_.core_.title
       end
 
       # @param [Occi::Model] model
       # @return [Occi::Model]
       def model=(model)
         @model = model
+
         @kind = (model.get_by_id(@kind.type_identifier) || @kind)
         @kind.entities << self
+
         @mixins.model = model
         @mixins.each { |mixin| mixin.entities << self }
+
         @actions.model = model
       end
 
@@ -150,56 +153,29 @@ module Occi
       # @return [String] location of the entity
       def location
         return @location if @location
-        kind.location + id.gsub('urn:uuid:', '') if id
+        "#{kind.location}#{id.gsub('urn:uuid:', '')}" if id
       end
 
       # check attributes against their definitions and set defaults
-      # @param [Occi::Model] model representation of the Occi model to check the attributes against
-      def check
-        raise "No model associated" unless @model
+      # @param [true,false] set default values for all empty attributes
+      def check(set_defaults = false)
+
+        raise ArgumentError, 'No model has been assigned to this entity' unless @model # XXX: Needs error type
+ 
+        kind = @model.get_by_id(@kind.to_s)
+        raise Occi::Errors::KindNotDefinedError, "Kind not found for entity #{self.to_s}!" unless kind # XXX: Needs error type
+ 
         definitions = Occi::Core::Attributes.new
-        definitions.merge!(@model.get_by_id(@kind.to_s).attributes)
-        @mixins.each do |mixin_id|
-          mixin = @model.get_by_id(mixin_id)
+        definitions.merge! kind.attributes
+ 
+        @mixins.each do |mxn|
+          mixin = @model.get_by_id(mxn.to_s)
           next if mixin.nil?
+ 
           definitions.merge!(mixin.attributes) if mixin.attributes
         end if @mixins
-
-        @attributes = Entity.check(@attributes, definitions) if definitions
-      end
-
-      # @param [Occi::Core::Attributes] attributes
-      # @param [Occi::Core::Attributes] definitions
-      # @param [true,false] set_defaults
-      # @return [Occi::Core::Attributes] attributes with their defaults set
-      def self.check(attributes, definitions, set_defaults=false)
-        attributes = Occi::Core::Attributes.new(attributes)
-        definitions.each_key do |key|
-          next if definitions.key?(key[1..-1])
-          if definitions[key].kind_of? Occi::Core::Attributes
-            attributes[key] = check(attributes[key], definitions[key])
-          else
-            properties = definitions[key]
-            value = attributes[key]
-            value ||= properties.default if set_defaults or properties.required?
-            raise "required attribute #{key} not found" if value.nil? && properties.required?
-            next if value.blank? and not properties.required?
-            case properties.type
-              when 'number'
-                raise "attribute #{key} value #{value} from class #{value.class.name} does not match attribute property type #{properties.type}" unless value.kind_of?(Numeric)
-              when 'boolean'
-                raise "attribute #{key} value #{value} from class #{value.class.name} does not match attribute property type #{properties.type}" unless !!value == value
-              when 'string'
-                raise "attribute #{key} with value #{value} from class #{value.class.name} does not match attribute property type #{properties.type}" unless value.kind_of?(String)
-              else
-                raise "property type #{properties.type} is not one of the allowed types number, boolean or string"
-            end
-            Occi::Log.warn "attribute #{key} with value #{value} does not match pattern #{properties.pattern}" if value.to_s.scan(Regexp.new(properties.pattern)).blank? if properties.pattern
-            attributes[key] = value
-          end
-        end
-        attributes.delete_if { |_, v| v.blank? } # remove empty attributes
-        attributes
+ 
+        @attributes.check!(definitions, set_defaults)
       end
 
       # @param [Hash] options
@@ -208,7 +184,7 @@ module Occi
         entity = Hashie::Mash.new
         entity.kind = @kind.to_s if @kind
         entity.mixins = @mixins.join(' ').split(' ') if @mixins.any?
-        entity.actions = @actions if @actions.any?
+        entity.actions = @actions.as_json if @actions.any?
         entity.attributes = @attributes.as_json if @attributes.as_json.any?
         entity.id = id.to_s if id
         entity
@@ -216,42 +192,38 @@ module Occi
 
       # @return [String] text representation
       def to_text
-        text = 'Category: ' + self.kind.term + ';scheme=' + self.kind.scheme.inspect + ';class="kind"'
+        text = "Category: #{self.kind.term};scheme=#{self.kind.scheme.inspect};class=\"kind\""
         @mixins.each do |mixin|
           scheme, term = mixin.to_s.split('#')
           scheme << '#'
-          text << "\n" + 'Category: ' + term + ';scheme=' + scheme.inspect + ';class="mixin"'
-        end
-        @attributes.names.each_pair do |name, value|
-          value = value.inspect
-          text << "\n" + 'X-OCCI-Attribute: ' + name + '=' + value
-        end
-        @actions.each do |action|
-          _, term = action.split('#')
-          text << "\n" + 'Link: <' + self.location + '?action=' + term + '>;rel=' + action.inspect
+          text << "\nCategory: #{term};scheme=#{scheme.inspect};class=\"mixin\""
         end
+
+        text << @attributes.to_text
+
+        @actions.each { |action| text << "\nLink: <#{self.location}?action=#{action.term}>;rel=#{action.to_s}" }
+
         text
       end
 
       # @return [Hash] hash containing the HTTP headers of the text/occi rendering
       def to_header
         header = Hashie::Mash.new
-        header['Category'] = self.kind.term + ';scheme=' + self.kind.scheme.inspect + ';class="kind"'
+        header['Category'] = "#{self.kind.term};scheme=#{self.kind.scheme.inspect};class=\"kind\""
+
         @mixins.each do |mixin|
           scheme, term = mixin.to_s.split('#')
           scheme << '#'
-          header['Category'] += ',' + term + ';scheme=' + scheme.inspect + ';class="mixin"'
-        end
-        attributes = []
-        @attributes.names.each_pair do |name, value|
-          attributes << name + '=' + value.to_s.inspect
+          header['Category'] << ",#{term};scheme=#{scheme.inspect};class=\"mixin\""
         end
-        header['X-OCCI-Attribute'] = attributes.join(',') if attributes.any?
+
+        attributes = @attributes.to_header
+        header['X-OCCI-Attribute'] = attributes unless attributes.blank?
+
         links = []
-        @actions.each do |action|
-          _, term = action.split('#')
-          links << self.location + '?action=' + term + '>;rel=' + action.inspect
-        end
+        @actions.each { |action| links << "<#{self.location}?action=#{action.term}>;rel=#{action.to_s}" }
+        header['Link'] = links.join(',') if links.any?
+
         header
       end
 
@@ -260,6 +232,11 @@ module Occi
         self.location
       end
 
+      # @return [Bool] Indicating whether this entity is "empty", i.e. required attributes are blank
+      def empty?
+        kind.blank? || attributes['occi.core.id'].blank?
+      end
+
     end
   end
 end

data/lib/occi/core/kind.rb

@@ -21,7 +21,7 @@ module Occi
         @parent = [parent].flatten.first
         @actions = Occi::Core::Actions.new(actions)
         @entities = Occi::Core::Entities.new
-        location.blank? ? @location = '/' + term + '/' : @location = location
+        location.blank? ? @location = "/#{term}/" : @location = location
       end
 
       # @param scheme [String] The categorisation scheme.
@@ -30,9 +30,12 @@ module Occi
       # @return [Class] Ruby class with scheme as namespace, term as name and parent kind as super class.
       def self.get_class(scheme, term, parent=Occi::Core::Entity.kind)
         parent ||= Occi::Core::Entity.kind
+        raise ArgumentError, 'Mandatory argument cannot be nil' unless scheme && term
+
         if parent.kind_of? Array
           parent = parent.first
         end
+
         if parent.to_s == 'http://schemas.ogf.org/occi/core#entity'
           parent = Occi::Core::Entity.kind
         elsif parent.kind_of? Occi::Core::Kind
@@ -41,8 +44,11 @@ module Occi
           parent = self.get_class(*parent.to_s.split('#')).kind
         end
 
+        term = self.sanitize_term(term) if Occi::Settings.compatibility
+        raise ArgumentError, "Invalid characters in term #{term}" unless Occi::Core::Category.valid_term?(term)
+
         unless scheme.end_with? '#'
-          scheme += '#'
+          scheme << '#'
         end
 
         uri = URI.parse(scheme)
@@ -60,7 +66,7 @@ module Occi
           end
         end
 
-        class_name = self.sanitize_term_before_classify(term).classify
+        class_name = term.classify
         if namespace.const_defined? class_name
           klass = namespace.const_get class_name
           unless klass.ancestors.include? Occi::Core::Entity
@@ -113,20 +119,18 @@ module Occi
       # @return [String] string representation of the kind
       def to_string
         string = super
-        string << ';rel=' + self.related.first.to_s.inspect if self.related.any?
-        string << ';location=' + self.location.inspect
-        string << ';attributes=' + self.attributes.names.keys.join(' ').inspect if self.attributes.any?
-        string << ';actions=' + self.actions.join(' ').inspect if self.actions.any?
+        string << ";rel=#{self.related.first.to_s.inspect}" if self.related.any?
+        string << ";location=#{self.location.inspect}"
+        string << self.attributes.to_string_short
+        string << ";actions=#{self.actions.join(' ').inspect}" if self.actions.any?
         string
       end
 
       private
 
       # Relaxed parser rules require additional checks on terms.
-      # TODO: a better solution?
-      # TODO: check for more characters
-      def self.sanitize_term_before_classify(term)
-        sanitized = term.downcase.gsub(/[\s\(\)\.\{\}\-;,\\\/\?\!\|\*\<\>]/, '_').gsub(/_+/, '_').chomp('_').reverse.chomp('_').reverse
+      def self.sanitize_term(term)
+        sanitized = term.downcase.gsub(/[^a-z0-9-]/, '_').gsub(/_+/, '_').gsub(/^_|_$/, '')
         sanitized = "uuid_#{sanitized}" if sanitized.match(/^[0-9]/)
 
         sanitized

data/lib/occi/core/kinds.rb

@@ -9,7 +9,7 @@ module Occi
 
         if category.kind_of? String
           scheme, term = category.split '#'
-          scheme       += '#'
+          scheme << '#'
 
           klass    = Occi::Core::Kind.get_class scheme, term, [Occi::Core::Kind.new]
           category = klass.kind

data/lib/occi/core/link.rb

@@ -4,6 +4,7 @@ module Occi
 
       attr_accessor :rel, :source, :target
 
+      self.attributes = Occi::Core::Attributes.new(Occi::Core::Entity.attributes)
       self.attributes['occi.core.target'] = {:mutable => true}
       self.attributes['occi.core.source'] = {:mutable => true}
 
@@ -30,7 +31,7 @@ module Occi
 
       # @return [String] target attribute of the link
       def target
-        @target ||= self.attributes.occi.core.target if @attributes.occi.core if @attributes.occi
+        @target ||= self.attributes.occi_.core_.target
         @target
       end
 
@@ -43,7 +44,7 @@ module Occi
 
       # @return [String] source attribute of the link
       def source
-        @source ||= self.attributes.occi.core.source if @attributes.occi.core if @attributes.occi
+        @source ||= self.attributes.occi_.core_.source
         @source
       end
 
@@ -54,9 +55,9 @@ module Occi
         @source = source
       end
 
-      # @param [Occi::Model] model
+      # Runs check on attributes
       def check
-        raise "rel must be provided" unless @rel
+        raise ArgumentError, "Cannot run check on #{self.to_s} without relation (@rel attribute) set" unless @rel
         super
       end
 
@@ -72,25 +73,23 @@ module Occi
 
       # @return [String] text representation of link reference
       def to_string
-        string = '<' + self.target.to_s + '>'
-        string << ';rel=' + @rel.to_s.inspect
-        string << ';self=' + self.location.inspect if self.location
+        string = "<#{self.target.to_s}>"
+        string << ";rel=#{@rel.to_s.inspect}"
+        string << ";self=#{self.location.inspect}" if self.location
+
         categories = [@kind] + @mixins.join(',').split(',')
-        string << ';category=' + categories.join(' ').inspect
-        @attributes.names.each_pair do |name, value|
-          next if value.to_s.blank?
-          value = value.to_s.inspect
-          string << ';' + name + '=' + value
-        end
+        string << ";category=#{categories.join(' ').inspect}"
+
+        string << @attributes.to_string
 
         string
       end
 
       # @return [String] text representation of link
       def to_text_link
-        'Link: ' + self.to_string
+        "Link: #{self.to_string}"
       end
 
     end
   end
-end
+end

data/lib/occi/core/links.rb

@@ -13,7 +13,7 @@ module Occi
 
       def create(*args)
         link       = Occi::Core::Link.new(*args)
-        link.model = @model
+        link.model = @model if @model
         self << link
         link
       end

data/lib/occi/core/mixin.rb

@@ -23,7 +23,7 @@ module Occi
         @depends = Occi::Core::Dependencies.new depends
         @actions = Occi::Core::Actions.new actions
         @entities = Occi::Core::Entities.new
-        location.blank? ? @location = '/mixins/' + term + '/' : @location = location
+        location.blank? ? @location = "/mixins/#{term}/" : @location = location
         @applies = Occi::Core::Kinds.new applies
       end
 
@@ -59,10 +59,10 @@ module Occi
       # @return [String] text representation
       def to_string
         string = super
-        string << ';rel=' + self.related.join(' ').inspect if self.related.any?
-        string << ';location=' + self.location.inspect
-        string << ';attributes=' + self.attributes.names.keys.join(' ').inspect if self.attributes.any?
-        string << ';actions=' + self.actions.join(' ').inspect if self.actions.any?
+        string << ";rel=#{self.related.join(' ').inspect}" if self.related.any?
+        string << ";location=#{self.location.inspect}"
+        string << self.attributes.to_string_short
+        string << ";actions=#{self.actions.join(' ').inspect}" if self.actions.any?
         string
       end
 

data/lib/occi/core/mixins.rb

@@ -11,7 +11,7 @@ module Occi
 
       def remove(mixin)
         mixin = convert mixin
-        @entity.attributes.remove mixin.attributes
+        @entity.attributes.remove mixin.attributes if @entity
         self.delete mixin
       end
 
@@ -34,4 +34,4 @@ module Occi
 
     end
   end
-end
+end

data/lib/occi/core/properties.rb

@@ -3,33 +3,111 @@ module Occi
     class Properties
 
       include Occi::Helpers::Inspect
+      include Occi::Helpers::Comparators::Properties
 
-      attr_accessor :default, :type, :required, :mutable, :pattern, :description
+      PROPERTY_KEYS = [:type, :required, :mutable, :default, :description, :pattern]
+      attr_accessor :required, :mutable, :default, :description, :pattern
+      attr_reader :type
       alias_method :required?, :required
       alias_method :mutable?, :mutable
 
-      # @param [Hash] properties
-      # @param [Hash] default
-      def initialize(properties={})
-        self.default = properties[:default]
-        self.type = properties[:type] ||= 'string'
-        self.required = properties[:required] ||= false
-        self.mutable = properties[:mutable] ||= false
-        self.pattern = properties[:pattern] ||= '.*'
-        self.description = properties[:description]
+      # Types supported in properties, and their mapping to Ruby Classes
+      SUPPORTED_TYPES = Hash.new
+      SUPPORTED_TYPES["string"]  =  [ String ]
+      SUPPORTED_TYPES["number"]  =  [ Numeric ]
+      SUPPORTED_TYPES["boolean"] =  [ TrueClass, FalseClass ]
+
+      # @param source_hash [Hash]
+      def initialize(source_hash = {})
+        raise ArgumentError, 'Source_hash must be initialized from a hash-like structure!' unless source_hash.kind_of?(Hash)
+        raise ArgumentError, 'Source_hash must not be a Hashie::Mash instance!' if source_hash.kind_of?(Hashie::Mash)
+        source_hash = Occi::Core::Properties.normalize_props(source_hash)
+
+        self.type = source_hash[:type] ||= 'string'
+        raise Occi::Errors::AttributePropertyTypeError,
+              "Type \"#{self.type}\" unsupported in properties. " \
+              "Supported types are: #{Properties.supported_type_names}." unless SUPPORTED_TYPES.key?(self.type)
+        self.required = source_hash[:required] = source_hash[:required].nil? ? false : source_hash[:required]
+        self.mutable = source_hash[:mutable] = source_hash[:mutable].nil? ? false : source_hash[:mutable]
+        self.pattern = source_hash[:pattern] ||= '.*'
+        self.description = source_hash[:description]
+        self.default = source_hash[:default]
+      end
+
+      # @param type [String] Requested attribute type
+      def type=(type)
+        raise Occi::Errors::AttributePropertyTypeError,
+              "Type \"#{type}\" unsupported in properties. Supported " \
+              "types are: #{Properties.supported_type_names}." unless SUPPORTED_TYPES.key?(type)
+        @type = type
+      end
+
+      # @param value [Object] Object whose class will be checked against definition
+      def check_value_for_type(value, key_name = nil)
+        raise Occi::Errors::AttributePropertyTypeError,
+              "Property type #{@type} for #{key_name.inspect} is not one of the allowed " \
+              "types: #{Properties.supported_type_names}" unless SUPPORTED_TYPES.key?(@type)
+        raise Occi::Errors::AttributeTypeError,
+              "Attribute value #{value} for #{key_name.inspect} is class #{value.class.name}. " \
+              "It does not match attribute property type #{@type}" unless SUPPORTED_TYPES[@type].any? { |klasse| value.kind_of?(klasse) }
+      end
+
+      def to_hash
+        as_json.to_hash
+      end
+
+      def to_json(*a)
+        as_json(*a).to_json(*a)
       end
 
       def as_json(options={})
         hash = Hashie::Mash.new
         hash.default = self.default if self.default
         hash.type = self.type if self.type
-        hash.required = self.required if self.required
-        hash.mutable = self.mutable if self.mutable
+        hash.required = self.required unless self.required.nil?
+        hash.mutable = self.mutable unless self.mutable.nil?
         hash.pattern = self.pattern if self.pattern
         hash.description = self.description if self.description
+
         hash
       end
 
+      # @return [Bool] Indicating whether this set of properties is "empty", i.e. no attributes are set
+      def empty?
+        as_json.empty?
+      end
+
+      def self.normalize_props(hash)
+        props = {}
+
+        PROPERTY_KEYS.each do |key|
+          found = hash.keys.select { |k| k.to_s.downcase.to_sym == key }.first
+          props[key] = hash[found] if found
+        end
+
+        props
+      end
+
+      def self.contains_props?(hash)
+        # Not a hash == doesn't contain Properties
+        return false unless hash.kind_of? Hash
+        hash = normalize_props(hash)
+
+        # Are there any Property keys?
+        return false if hash.empty?
+
+        # Do all Property keys point to simple values?
+        complx_keys = hash.keys.select { |k| hash[k].kind_of?(Hash) }
+        return false unless complx_keys.empty?
+
+        true
+      end
+
+      private
+
+      def self.supported_type_names()
+        SUPPORTED_TYPES.keys.join(', ')
+      end
     end
   end
 end

data/lib/occi/core/resource.rb

@@ -4,7 +4,7 @@ module Occi
 
       attr_accessor :links
 
-      self.attributes = Occi::Core::Attributes.new
+      self.attributes = Occi::Core::Attributes.new(Occi::Core::Entity.attributes)
 
       self.attributes['occi.core.summary'] = {:mutable => true}
 
@@ -31,7 +31,7 @@ module Occi
 
       # @return [String] summary attribute of the resource
       def summary
-        self.attributes.occi.core.summary if @attributes.occi.core if @attributes.occi
+        self.attributes.occi_.core_.summary
       end
 
       # set summary attribute of resource
@@ -42,19 +42,23 @@ module Occi
 
       def link(target, kind=Occi::Core::Link.kind, mixins=[], attributes=Occi::Core::Attributes.new, rel=Occi::Core::Resource.type_identifier)
         link = kind.entity_type.new
+
         link.rel = rel
         link.attributes = attributes
+        link.id ||= UUIDTools::UUID.random_create.to_s
         link.target = target
         link.source = self
         link.mixins = mixins
+
         @links << link
+
         link
       end
 
       # @return [String] text representation
       def to_text
         text = super
-        @links.each { |link| text << "\n" + link.to_text_link }
+        @links.each { |link| text << "\n#{link.to_text_link}" }
         text
       end
 

data/lib/occi/core/resources.rb

@@ -4,11 +4,11 @@ module Occi
 
       def create(*args)
         resource       = Occi::Core::Resource.new(*args)
-        resource.model = @model
+        resource.model = @model if @model
         self << resource
         resource
       end
 
     end
   end
-end
+end

data/lib/occi/errors/attribute_definitions_converted_error.rb

@@ -0,0 +1,5 @@
+module Occi
+  module Errors
+    class AttributeDefinitionsConvrertedError < ArgumentError; end
+  end
+end

data/lib/occi/errors/attribute_missing_error.rb

@@ -0,0 +1,5 @@
+module Occi
+  module Errors
+    class AttributeMissingError < ArgumentError; end
+  end
+end

data/lib/occi/errors/attribute_name_invalid_error.rb

@@ -0,0 +1,5 @@
+module Occi
+  module Errors
+    class AttributeNameInvalidError < ArgumentError; end
+  end
+end

data/lib/occi/errors/attribute_not_defined_error.rb

@@ -0,0 +1,5 @@
+module Occi
+  module Errors
+    class AttributeNotDefinedError < ArgumentError; end
+  end
+end

data/lib/occi/errors/attribute_property_type_error.rb

@@ -0,0 +1,5 @@
+module Occi
+  module Errors
+    class AttributePropertyTypeError < ArgumentError; end
+  end
+end

data/lib/occi/errors/attribute_type_error.rb

@@ -0,0 +1,5 @@
+module Occi
+  module Errors
+    class AttributeTypeError < ArgumentError; end
+  end
+end

data/lib/occi/errors/kind_not_defined_error.rb

@@ -0,0 +1,5 @@
+module Occi
+  module Errors
+    class KindNotDefinedError < ArgumentError; end
+  end
+end

data/lib/occi/errors/parser_input_error.rb

@@ -0,0 +1,5 @@
+module Occi
+  module Errors
+    class ParserInputError < ArgumentError; end
+  end
+end