occi-core 5.0.0 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ee5d882ffc4b2bbd1303e37307911dc65cf1ecd
-  data.tar.gz: b1d1b4fce539e518607ae2ffe5f74c92347b913c
+  metadata.gz: d523a58448adfcac4670df02b7666b1a9e48c7da
+  data.tar.gz: 2442b720cd5e338f33bfcf92f3da9ce1a3bff0c0
 SHA512:
-  metadata.gz: 993fa9077687fc522635f593f37cc565686be0fed8c022ff7affe640cb31bfef8a7bd89df1c5e260246a828760d8b51fc0f0d65da5a0d5e4b227b92fcb6815b5
-  data.tar.gz: 6962b980323f9d2f43f75901e07f8d3c353ca6e3f76829e4ea6a71ede49a813128a47820faa6812ae84533cd32c9be639ff18bb7a6b704b7cf48a4a0271501b5
+  metadata.gz: 02bf8369a2c0c5a084e670b2f106d43ba83312ba0e0bd2ae7b84421da32e2aa592f7f95b51a2c892f7ea5160cf7aa72a894245c1e91e194e13acb4859874f217
+  data.tar.gz: f8565410f77fd48b20aff72581fb2e477c00e3f8a5e42afc784988b01395360fdcdf3d5329d23b6c2a54b9e905ea26d98c8be2378e6257951a199f46c52032fb

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+cache: bundler
 
 rvm:
   - 2.2.7

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+
+5.0.1 / 2017-09-05
+==================
+
+  * `occi.ipreservation.address` not required for `Occi::InfrastructureExt::IPReservation`
+  * Respecting `{source,target}_kind` for Link rendering to JSON
+  * Logging `debug` messages via blocks (perf.)
+  * Converting JSON keys to symbols by default

data/README.md

@@ -9,7 +9,7 @@
 * Ruby 2.2.2+ or jRuby 9+ (with JDK7 a JDK8)
 
 ## Installation
-### As a gem
+### Gem
 To install the most recent stable version
 ~~~
 gem install occi-core
@@ -19,17 +19,152 @@ To install the most recent beta version
 ~~~
 gem install occi-core --pre
 ~~~
-
-### From source
-To build and install the bleeding edge version from master
+### Source
+To build a bleeding edge version from master
 ~~~
 git clone git://github.com/the-rocci-project/rOCCI-core.git
 cd rOCCI-core
 gem build occi-core.gemspec
+gem install occi-core-*.gem
 ~~~
 
 ## Usage
-`TODO`
+### Logging
+```ruby
+require 'occi/infrastructure-ext'
+logger = Yell.new STDOUT, name: Object # IO or String
+logger.level = :debug                  # see https://github.com/rudionrails/yell
+```
+### Model
+```ruby
+model = Occi::InfrastructureExt::Model.new
+model.load_core!
+model.load_infrastructure!
+model.load_infrastructure_ext!
+
+model.valid! # this should never raise an error when using stock model extensions
+```
+```ruby
+model.kinds   # => #<Set ...>
+model.mixins  # => #<Set ...>
+model.actions # => #<Set ...>
+```
+```ruby
+kind  = model.find_by_identifier! 'http://schemas.ogf.org/occi/infrastructure#compute' # => #<Occi::Core::Kind ...>
+mixin = model.find_by_identifier! 'http://schemas.ogf.org/occi/infrastructure#os_tpl' # => #<Occi::Core::Mixin ...>
+
+model.find_dependent mixin # => #<Set ...> of mixins that depend on the given mixin
+model.find_related kind    # => #<Set ...> of kinds related to the given kind
+```
+### Instance Builder
+```ruby
+# always access the IB instance associated with a model instance
+ib = model.instance_builder
+ib.get 'http://schemas.ogf.org/occi/infrastructure#compute' # => #<Occi::Infrastructure::Compute ...>
+```
+### Entity Instance
+```ruby
+# using `mixin` selected from Model instance
+# using `compute` created by InstanceBuilder instance
+compute.identify!                   # to generate `occi.core.id`
+
+compute['occi.core.id']             # => #<String ...>
+compute['occi.core.title'] = 'Mine' # to assign instance attribute value
+
+compute << mixin                    # add a mixin
+
+compute.valid!                      # to validate
+```
+### Action Instance
+```ruby
+# using `action` selected from Model instance
+ai = Occi::Core::ActionInstance.new(action: action)
+
+ai['method']          # => #<String ...>
+ai['method'] = 'cold' # to assign action instance attribute value
+
+ai.valid!
+```
+### Collection
+```ruby
+# using `model`
+# using `compute` created by InstanceBuilder instance
+# using `compute1` created by InstanceBuilder instance
+# using `compute2` created by InstanceBuilder instance
+collection = Occi::Core::Collection.new
+collection.categories = model.categories
+
+collection << compute
+collection << compute1
+collection << compute2
+
+collection.valid!
+```
+```ruby
+# using `kind` selected from Model instance
+collection.find_by_kind kind     # => #<Set ...> of Occi::Core::Entity or its sub-type
+collection.find_by_id!  '12554'  # => #<Occi::Core::Entity ...> or its sub-type
+```
+### Rendering
+```ruby
+# using `compute` created by InstanceBuilder instance
+compute.valid!    # ALWAYS validate before rendering!
+
+compute.to_text   # => #<String ...>
+compute.to_json   # => #<String ...>
+```
+```ruby
+# using `collection` with `collection.categories` set
+collection.valid!    # ALWAYS validate before rendering!
+
+collection.to_text   # => #<String ...> with at most one Occi::Core::Entity sub-type
+collection.to_json   # => #<String ...>
+```
+### Parsing
+```ruby
+model = Occi::InfrastructureExt::Model.new  # empty or partially loaded model instance can be used
+
+mf = File.read File.join('examples', 'rendering', 'model.json')
+Occi::Core::Parsers::JsonParser.model(mf, {}, 'application/occi+json', model)
+
+model.valid! # ALWAYS validate before using the model!
+```
+```ruby
+# using `model`
+parser = Occi::Core::Parsers::JsonParser.new(model: model, media_type: 'application/occi+json')
+
+cf = File.read File.join('examples', 'rendering', 'instance.json')
+entities = parser.entities(cf, {})  # => #<Set ...>
+
+entities.each(&:valid!)             # ALWAYS validate before using parsed instances!
+```
+### Warehouse
+```ruby
+module Custom
+  class Warehouse < Occi::Core::Warehouse
+    class << self
+      protected
+
+      def whereami
+        # the `warehouse` directory should be located in this directory
+        File.expand_path(File.dirname(__FILE__))
+      end
+    end
+  end
+end
+```
+See definitions in [`Occi::Infrastructure::Warehouse`](https://github.com/the-rocci-project/rOCCI-core/tree/master/lib/occi/infrastructure/warehouse) for inspiration.
+### Extending Model
+If you need to extend the model, use a custom `Warehouse` class to do it. Actions, kinds, and mixins referenced
+by identifier in `Custom::Warehouse` definition YAMLs have to be already present in the model instance being extended!
+```ruby
+model = Occi::InfrastructureExt::Model.new
+model.load_core!
+
+Custom::Warehouse.bootstrap! model
+
+model.valid!
+```
 
 ## Changelog
 See `CHANGELOG.md`.
@@ -37,9 +172,8 @@ See `CHANGELOG.md`.
 ## Code Documentation
 [Code Documentation for rOCCI](http://rubydoc.info/github/the-rocci-project/rOCCI-core/)
 
-### Contribute
-
-1. Fork it.
+## Contribute
+1. Fork it
 2. Create a branch (git checkout -b my_markup)
 3. Commit your changes (git commit -am "My changes")
 4. Push to the branch (git push origin my_markup)

data/lib/occi/core/attribute_definition.rb

@@ -154,7 +154,7 @@ module Occi
         begin
           valid! value
         rescue Occi::Core::Errors::AttributeValidationError => ex
-          logger.debug "AttributeValidation: #{ex.message}"
+          logger.debug { "AttributeValidation: #{ex.message}" }
           return false
         end
 

data/lib/occi/core/helpers/argument_validator.rb

@@ -8,7 +8,7 @@ module Occi
       module ArgumentValidator
         # :nodoc:
         def default_args!(args)
-          logger.debug "Merging #{self.class} args #{args.inspect} with defaults #{defaults.inspect}"
+          logger.debug { "Merging #{self.class} args #{args.inspect} with defaults #{defaults.inspect}" }
           args.merge!(defaults) { |_, oldval, _| oldval }
           sufficient_args!(args)
         end

data/lib/occi/core/helpers/instance_attribute_resetter.rb

@@ -53,7 +53,7 @@ module Occi
           name_cache = attribute_names
           attributes.keep_if do |key, value|
             defined = name_cache.include?(key) && value && value.attribute_definition
-            logger.debug "Removing undefined attribute #{key.inspect} on #{self.class}" unless defined
+            logger.debug { "Removing undefined attribute #{key.inspect} on #{self.class}" } unless defined
             defined
           end
         end
@@ -122,10 +122,10 @@ module Occi
         # @param force [TrueClass, FalseClass] forcibly change attribute value to default
         def reset_attribute(name, definition, force)
           if attributes[name]
-            logger.debug "Setting attribute definition for existing #{name.inspect} on #{self.class}"
+            logger.debug { "Setting attribute definition for existing #{name.inspect} on #{self.class}" }
             attributes[name].attribute_definition = definition
           else
-            logger.debug "Creating attribute definition for new #{name.inspect} on #{self.class}"
+            logger.debug { "Creating attribute definition for new #{name.inspect} on #{self.class}" }
             attributes[name] = Attribute.new(nil, definition)
           end
 

data/lib/occi/core/helpers/parser_dereferencer.rb

@@ -44,8 +44,8 @@ module Occi
         # @param derefd [Array] list of all available category instances
         # @param parsed_actions [Array] textual representation of needed actions
         def lookup_action_references!(cat, derefd, parsed_actions)
-          logger.debug "Dereferencing actions #{parsed_actions.inspect} for #{cat.identifier.inspect}"
           return if parsed_actions.blank?
+          logger.debug { "Dereferencing actions #{parsed_actions.inspect} for #{cat.identifier.inspect}" }
           parsed_actions.each { |action| cat.actions << first_or_die(derefd, action) }
         end
 
@@ -54,7 +54,7 @@ module Occi
         # @param parsed_rel [Array] textual representation of needed parent(s)
         def lookup_parent_references!(kind, derefd, parsed_rel)
           return if parsed_rel.blank? || kind.parent.is_a?(Occi::Core::Kind)
-          logger.debug "Dereferencing parent #{parsed_rel.inspect} for #{kind.identifier.inspect}"
+          logger.debug { "Dereferencing parent #{parsed_rel.inspect} for #{kind.identifier.inspect}" }
           if parsed_rel.is_a?(Enumerable)
             if parsed_rel.count > 1
               raise Occi::Core::Errors::ParsingError,
@@ -85,7 +85,7 @@ module Occi
         # @param what [String] identifier of the desired item
         # @return [Object] desired item from `where`
         def first_or_die(where, what)
-          logger.debug "Looking for #{what.inspect} in #{where.class}"
+          logger.debug { "Looking for #{what.inspect} in #{where.class}" }
           found = where.detect { |elm| elm.identifier == what }
           unless found
             raise Occi::Core::Errors::ParsingError,

data/lib/occi/core/helpers/renderable.rb

@@ -27,7 +27,7 @@ module Occi
         # @return [Object] output of the chosen renderer
         def render(format, options = {})
           options[:format] = format
-          logger.debug "#{self.class} is being rendered to #{format} with #{options.inspect}" if respond_to?(:logger)
+          logger.debug { "#{self.class} is rendered to #{format} with #{options.inspect}" } if respond_to?(:logger)
           renderer_for(format).render(self, options)
         end
 
@@ -55,7 +55,7 @@ module Occi
         # @param base [Class] class receiving this module
         def self.included(base)
           renderer_factory.formats.each do |format|
-            base.logger.debug "Adding support for format #{format} to #{base}" if base.respond_to?(:logger)
+            base.logger.debug { "Adding support for format #{format} to #{base}" } if base.respond_to?(:logger)
             base.send(:define_method, "to_#{format}", proc { render(format) })
           end
         end

data/lib/occi/core/helpers/yaml_summoner.rb

@@ -25,7 +25,7 @@ module Occi
           raise 'This method cannot be invoked on instances' unless is_a? Class
           allowed_classes = respond_to?(:allowed_yaml_classes, true) ? allowed_yaml_classes : []
 
-          logger.debug "Loading YAML definition for #{self} from #{path.inspect}"
+          logger.debug { "Loading YAML definition for #{self} from #{path.inspect}" }
           object_args = YAML.safe_load(File.read(path), allowed_classes)
           object_args.symbolize_keys!
           object_args.dereference_with!(self, model, attribute_definitions) if needs_dereferencing?

data/lib/occi/core/instance_builder.rb

@@ -42,7 +42,7 @@ module Occi
       # @return [Object] constructed instance
       # @return [NilClass] if such an instance could not be constructed
       def build(identifier, args = {})
-        logger.debug "Building instance of #{identifier.inspect} with #{args.inspect}"
+        logger.debug { "Building instance of #{identifier.inspect} with #{args.inspect}" }
         k_args = args_with_kind(identifier, args)
         klass(identifier, parent_klass(k_args[:kind])).new k_args
       end
@@ -93,7 +93,7 @@ module Occi
                 "#{found_klass} is not a sub-type of #{known_ancestor}"
         end
 
-        logger.debug "Found class #{found_klass} for #{identifier.inspect}"
+        logger.debug { "Found class #{found_klass} for #{identifier.inspect}" }
         found_klass
       end
 
@@ -119,10 +119,10 @@ module Occi
       # @return [Class] located known parent class
       def parent_klass(kind)
         if kind.related? kind_instance(Occi::Core::Constants::RESOURCE_KIND)
-          logger.debug "Identified #{kind.identifier} as Resource"
+          logger.debug { "Identified #{kind.identifier} as Resource" }
           Occi::Core::Resource
         elsif kind.related? kind_instance(Occi::Core::Constants::LINK_KIND)
-          logger.debug "Identified #{kind.identifier} as Link"
+          logger.debug { "Identified #{kind.identifier} as Link" }
           Occi::Core::Link
         else
           raise Occi::Core::Errors::ModelLookupError,

data/lib/occi/core/parsers/base_parser.rb

@@ -18,10 +18,6 @@ module Occi
 
         attr_accessor :model, :media_type
 
-        # Shortcuts to interesting methods on logger
-        DELEGATED = %i[debug? info? warn? error? fatal?].freeze
-        delegate(*DELEGATED, to: :logger, prefix: true)
-
         # Constructs an instance of the parser that will use a particular model as the reference for every
         # parsed instance. Only instances allowed by the model will be successfuly parsed. In case of
         # `Occi::Core::Category` instances, only identifiers are parsed and existing instances from the model
@@ -36,7 +32,7 @@ module Occi
 
           @model = args.fetch(:model)
           @media_type = args.fetch(:media_type)
-          logger.debug "Initializing parser for #{media_type.inspect}"
+          logger.debug { "Initializing parser for #{media_type.inspect}" }
 
           post_initialize(args)
         end
@@ -123,10 +119,6 @@ module Occi
         end
 
         class << self
-          # Shortcuts to interesting methods on logger
-          DELEGATED = %i[debug? info? warn? error? fatal?].freeze
-          delegate(*DELEGATED, to: :logger, prefix: true)
-
           # Returns a list of supported media types for this parser.
           #
           # @return [Array] list of supported media types

data/lib/occi/core/parsers/json/action_instance.rb

@@ -12,10 +12,6 @@ module Occi
           extend Helpers::RawJsonParser
 
           class << self
-            # Shortcuts to interesting methods on logger
-            DELEGATED = %i[debug? info? warn? error? fatal?].freeze
-            delegate(*DELEGATED, to: :logger, prefix: true)
-
             # Parses action instances. Internal references between objects are converted from strings
             # to actual objects. Actions have to be declared in the provided model.
             #
@@ -26,12 +22,12 @@ module Occi
               parsed = raw_hash(body)
               action = handle(Occi::Core::Errors::ParsingError) { model.find_by_identifier! parsed[:action] }
 
-              logger.debug "Identified #{action.class}[#{action.identifier}]"
+              logger.debug { "Identified #{action.class}[#{action.identifier}]" }
               ai = Occi::Core::ActionInstance.new(action: action)
               ep = Entity.new(model: model)
               ep.set_attributes!(ai, parsed[:attributes]) if parsed[:attributes]
 
-              logger.debug "Parsed into ActionInstance #{ai.inspect}" if logger_debug?
+              logger.debug { "Parsed into ActionInstance #{ai.inspect}" }
               ai
             end
           end

data/lib/occi/core/parsers/json/category.rb

@@ -27,10 +27,6 @@ module Occi
           DEPENDS_KEY = :depends
 
           class << self
-            # Shortcuts to interesting methods on logger
-            DELEGATED = %i[debug? info? warn? error? fatal?].freeze
-            delegate(*DELEGATED, to: :logger, prefix: true)
-
             # Parses categories into instances of subtypes of `Occi::Core::Category`. Internal references
             # between objects are converted from strings to actual objects. Categories provided in the model
             # will be reused but have to be declared in the parsed model as well.
@@ -41,12 +37,12 @@ module Occi
             def json(body, model)
               parsed = raw_hash(body)
               instantiate_hashes! parsed, model
-              logger.debug "Parsed into raw hashes #{parsed.inspect}" if logger_debug?
+              logger.debug { "Parsed into raw hashes #{parsed.inspect}" }
 
               raw_categories = [parsed[:kinds], parsed[:mixins]].flatten.compact
               dereference_identifiers! model.categories, raw_categories
 
-              logger.debug "Returning (updated) model #{model.inspect}" if logger_debug?
+              logger.debug { "Returning (updated) model #{model.inspect}" }
               model
             end
 
@@ -59,7 +55,7 @@ module Occi
 
             # :nodoc:
             def instatiate_hash(raw, klass)
-              logger.debug "Creating #{klass} from #{raw.inspect}" if logger_debug?
+              logger.debug { "Creating #{klass} from #{raw.inspect}" }
 
               obj = klass.new(
                 term: raw[:term], schema: raw[:scheme], title: raw[:title],
@@ -67,11 +63,11 @@ module Occi
               )
 
               if obj.respond_to?(:location)
-                logger.debug "Setting location #{raw[:location].inspect}" if logger_debug?
+                logger.debug { "Setting location #{raw[:location].inspect}" }
                 obj.location = handle(Occi::Core::Errors::ParsingError) { URI.parse(raw[:location]) }
               end
 
-              logger.debug "Created category #{obj.inspect}" if logger_debug?
+              logger.debug { "Created category #{obj.inspect}" }
               obj
             end
 
@@ -81,7 +77,7 @@ module Occi
 
               attr_defs = {}
               raw.each_pair do |k, v|
-                logger.debug "Creating AttributeDefinition for #{k.inspect} from #{v.inspect}" if logger_debug?
+                logger.debug { "Creating AttributeDefinition for #{k.inspect} from #{v.inspect}" }
                 def_hsh = typecast(v)
                 unless def_hsh[:type]
                   raise Occi::Core::Errors::ParsingError, "Attribute #{k.to_s.inspect} has no type"
@@ -105,14 +101,14 @@ module Occi
 
             # :nodoc:
             def lookup_applies_references!(mixin, derefd, parsed_rel)
-              logger.debug "Looking up applies from #{parsed_rel.inspect}" if logger_debug?
+              logger.debug { "Looking up applies from #{parsed_rel.inspect}" }
               return if parsed_rel.blank?
               parsed_rel.each { |kind| mixin.applies << first_or_die(derefd, kind) }
             end
 
             # :nodoc:
             def lookup_depends_references!(mixin, derefd, parsed_rel)
-              logger.debug "Looking up depens from #{parsed_rel.inspect}" if logger_debug?
+              logger.debug { "Looking up depens from #{parsed_rel.inspect}" }
               return if parsed_rel.blank?
               parsed_rel.each { |mxn| mixin.depends << first_or_die(derefd, mxn) }
             end

data/lib/occi/core/parsers/json/entity.rb

@@ -14,10 +14,6 @@ module Occi
           include Helpers::ErrorHandler
           extend Helpers::RawJsonParser
 
-          # Shortcuts to interesting methods on logger
-          DELEGATED = %i[debug? info? warn? error? fatal?].freeze
-          delegate(*DELEGATED, to: :logger, prefix: true)
-
           # Constants
           SINGLE_INSTANCE_TYPES = %i[resource link].freeze
           MULTI_INSTANCE_TYPES  = %i[entity-collection].freeze
@@ -67,14 +63,14 @@ module Occi
           # @param hash [Hash] Hash body for parsing
           # @return [Array] constructed instances
           def json_single(hash)
-            logger.debug "Converting #{hash.inspect} into a single instance" if logger_debug?
+            logger.debug { "Converting #{hash.inspect} into a single instance" }
             instance = @_ib.get hash[:kind], mixins: lookup(hash[:mixins]), actions: lookup(hash[:actions])
 
             set_attributes! instance, hash[:attributes]
             set_links! instance, hash[:links] if instance.respond_to?(:links)
             set_target! instance, hash[:target] if instance.respond_to?(:target)
 
-            logger.debug "Created instance #{instance.inspect}" if logger_debug?
+            logger.debug { "Created instance #{instance.inspect}" }
             Set.new [instance]
           end
 
@@ -85,12 +81,12 @@ module Occi
           def json_collection(hash)
             all = []
 
-            logger.debug "Converting #{hash.inspect} into multiple instances" if logger_debug?
+            logger.debug { "Converting #{hash.inspect} into multiple instances" }
             all.concat hash[:resources] if hash[:resources]
             all.concat hash[:links] if hash[:links]
             all.map! { |a| json_single(a) }
 
-            logger.debug "Created instances #{all.inspect}" if logger_debug?
+            logger.debug { "Created instances #{all.inspect}" }
             Set.new(all).flatten
           end
 
@@ -107,7 +103,7 @@ module Occi
           def set_attributes!(instance, hash)
             return if hash.blank?
             hash.each_pair do |name, value|
-              logger.debug "Setting attribute #{name} to #{value.inspect}" if logger_debug?
+              logger.debug { "Setting attribute #{name} to #{value.inspect}" }
               attribute = instance.attributes[name.to_s]
               unless attribute
                 raise Occi::Core::Errors::ParsingError,
@@ -138,7 +134,7 @@ module Occi
             end
             return value unless TYPECASTER_HASH.key?(type)
 
-            logger.debug "Typecasting value #{value.inspect} to #{type}" if logger_debug?
+            logger.debug { "Typecasting value #{value.inspect} to #{type}" }
             TYPECASTER_HASH[type].call(value)
           end
 

data/lib/occi/core/parsers/json/validator.rb

@@ -15,10 +15,6 @@ module Occi
           BASE_SCHEMAS = %i[occi-schema].freeze
 
           class << self
-            # Shortcuts to interesting methods on logger
-            DELEGATED = %i[debug? info? warn? error? fatal?].freeze
-            delegate(*DELEGATED, to: :logger, prefix: true)
-
             # Validates given `json` text with the appropriate schema for `type`.
             # This method raises `Occi::Core::Errors::ParsingError` on failure.
             #
@@ -26,7 +22,7 @@ module Occi
             # @param type [Symbol] schema selector
             # @raise [Occi::Core::Errors::ParsingError] on validation failure
             def validate!(json, type)
-              logger.debug "Validating #{json.inspect} as #{type}" if logger_debug?
+              logger.debug { "Validating #{json.inspect} as #{type}" }
 
               JSON::Validator.schema_reader = JSON::Schema::Reader.new(accept_uri: false, accept_file: true)
               JSON::Validator.validate!(schema_for(type), json, json: true)
@@ -75,7 +71,7 @@ module Occi
                 raise Occi::Core::Errors::ParserError, "Schema type #{type.inspect} is not allowed"
               end
               schema_path = File.join(SCHEMA_REPO, "#{type}.json")
-              logger.debug "Found JSON schema for #{type} in #{schema_path}" if logger_debug?
+              logger.debug { "Found JSON schema for #{type} in #{schema_path}" }
 
               schema_path
             end

data/lib/occi/core/parsers/json_parser.rb

@@ -34,7 +34,7 @@ module Occi
         # @return [Set] set of instances
         def entities(body, _headers = nil, expectation = nil)
           expectation ||= Occi::Core::Entity
-          logger.debug "Parsing #{expectation}(s) from #{body.inspect}" if logger_debug?
+          logger.debug { "Parsing #{expectation}(s) from #{body.inspect}" }
           type = validate_entities! body
 
           entity_parser = Json::Entity.new(model: model)
@@ -55,7 +55,7 @@ module Occi
         # @param headers [Hash] raw headers as provided by the transport protocol
         # @return [Set] set of parsed instances
         def action_instances(body, _headers = nil)
-          logger.debug "Parsing Occi::Core::ActionInstance(s) from #{body.inspect}" if logger_debug?
+          logger.debug { "Parsing Occi::Core::ActionInstance(s) from #{body.inspect}" }
           Json::Validator.validate_action_instance! body
           Set.new [Json::ActionInstance.json(body, model)]
         end
@@ -69,7 +69,7 @@ module Occi
         # @return [Set] set of instances
         def categories(body, _headers = nil, expectation = nil)
           expectation ||= Occi::Core::Category
-          logger.debug "Parsing #{expectation}(s) from #{body.inspect}" if logger_debug?
+          logger.debug { "Parsing #{expectation}(s) from #{body.inspect}" }
           Json::Validator.validate_category_identifiers! body
 
           cats = Set.new
@@ -84,12 +84,12 @@ module Occi
           found = nil
 
           %i[link resource entity-collection].each do |type|
-            logger.debug "Attempting to validate #{body.inspect} as #{type}" if logger_debug?
+            logger.debug { "Attempting to validate #{body.inspect} as #{type}" }
             begin
               Json::Validator.validate! body, type
               found = type
             rescue => ex
-              logger.debug "Moving on, body does not contain valid #{type} - #{ex.message.inspect}"
+              logger.debug { "Moving on, body does not contain valid #{type} - #{ex.message.inspect}" }
             end
           end
           raise Occi::Core::Errors::ParsingError, 'No acceptable entity rendering found' unless found
@@ -111,7 +111,7 @@ module Occi
               raise Occi::Core::Errors::ParsingError,
                     "Model cannot be parsed from #{media_type.inspect}"
             end
-            logger.debug "Parsing model from #{media_type.inspect} in #{body.inspect}" if logger_debug?
+            logger.debug { "Parsing model from #{media_type.inspect} in #{body.inspect}" }
 
             Json::Validator.validate_model! body
             Json::Category.json body, model
@@ -129,7 +129,7 @@ module Occi
             unless media_types.include?(media_type)
               raise Occi::Core::Errors::ParsingError, "Locations cannot be parsed from #{media_type.inspect}"
             end
-            logger.debug "Parsing locations from #{media_type.inspect} in #{body.inspect}" if logger_debug?
+            logger.debug { "Parsing locations from #{media_type.inspect} in #{body.inspect}" }
 
             Json::Validator.validate_locations! body
             handle(Occi::Core::Errors::ParsingError) { JSON.parse(body).map { |i| URI.parse(i) } }

data/lib/occi/core/parsers/text/category.rb

@@ -20,10 +20,6 @@ module Occi
           DEPENDS_KEY = :rel
 
           class << self
-            # Shortcuts to interesting methods on logger
-            DELEGATED = %i[debug? info? warn? error? fatal?].freeze
-            delegate(*DELEGATED, to: :logger, prefix: true)
-
             # Parses category lines into instances of subtypes of `Occi::Core::Category`. Internal references
             # between objects are converted from strings to actual objects. Categories provided in the model
             # will be reused but have to be declared in the parsed model as well. This mechanism can be used to
@@ -41,7 +37,7 @@ module Occi
               end
               dereference_identifiers! model.categories, raw_categories
 
-              logger.debug "Returning (updated) model #{model.inspect}" if logger_debug?
+              logger.debug { "Returning (updated) model #{model.inspect}" }
               model
             end
 
@@ -52,7 +48,7 @@ module Occi
             # @param full [TrueClass, FalseClass] parse full definition, defaults to `true`
             # @return [Hash] raw category hash for further processing
             def plain_category(line, full = true)
-              logger.debug "Parsing line #{line.inspect}" if logger_debug?
+              logger.debug { "Parsing line #{line.inspect}" }
               matched = line.match(CATEGORY_REGEXP)
               unless matched
                 raise Occi::Core::Errors::ParsingError, "#{line.inspect} does not match expectations for Category"
@@ -96,7 +92,7 @@ module Occi
 
               attributes = {}
               line.split.each { |attribute| attributes.merge! plain_attribute(attribute) }
-              logger.debug "Matched attributes as #{attributes.inspect}" if logger_debug?
+              logger.debug { "Matched attributes as #{attributes.inspect}" }
 
               attributes
             end
@@ -112,7 +108,7 @@ module Occi
             def plain_attribute(line)
               # TODO: find a better approach to fixing split
               line.gsub!(/\{(immutable|required)_(required|immutable)\}/, '{\1 \2}')
-              logger.debug "Parsing attribute line #{line.inspect}" if logger_debug?
+              logger.debug { "Parsing attribute line #{line.inspect}" }
 
               matched = line.match(ATTRIBUTE_REGEXP)
               unless matched && matched[1]

data/lib/occi/core/parsers/text/entity.rb

@@ -13,10 +13,6 @@ module Occi
           include Helpers::ArgumentValidator
           include Helpers::ErrorHandler
 
-          # Shortcuts to interesting methods on logger
-          DELEGATED = %i[debug? info? warn? error? fatal?].freeze
-          delegate(*DELEGATED, to: :logger, prefix: true)
-
           # Regexp constants
           ATTRIBUTE_REGEXP = /#{Constants::REGEXP_ATTRIBUTE}/
           LINK_REGEXP      = /#{Constants::REGEXP_LINK}/
@@ -25,7 +21,7 @@ module Occi
           DEFAULT_LAMBDA  = ->(val) { raise "#{self} -> Cannot typecast #{val.inspect} to an unknown type" }
 
           FLOAT_LAMBDA    = ->(val) { Float(val) rescue raise(Occi::Core::Errors::ParsingError, "Wrong value #{val}") }
-          JSON_LAMBDA     = ->(val) { JSON.parse(val.gsub('\"', '"')) }
+          JSON_LAMBDA     = ->(val) { JSON.parse(val.gsub('\"', '"'), symbolize_names: true) }
 
           TYPECASTER_HASH = {
             IPAddr  => ->(val) { IPAddr.new val },
@@ -62,7 +58,7 @@ module Occi
             cats = plain_categories(lines)
             kind = cats.detect { |c| c.is_a?(Occi::Core::Kind) }
             raise Occi::Core::Errors::ParsingError, 'Entity does not specify its kind' unless kind
-            logger.debug "Identified entity kind #{kind.inspect}" if logger_debug?
+            logger.debug { "Identified entity kind #{kind.inspect}" }
 
             entity = @_ib.build(kind.identifier)
             cats.each { |cat| cat.is_a?(Occi::Core::Mixin) && entity << cat }
@@ -70,7 +66,7 @@ module Occi
             plain_attributes! lines, entity.attributes
             plain_links! lines, entity
 
-            logger.debug "Created instance #{entity.inspect}" if logger_debug?
+            logger.debug { "Created instance #{entity.inspect}" }
             entity
           end
 
@@ -116,7 +112,7 @@ module Occi
           # @param line [String] line containing a single entity attribute
           # @return [Array] two-element array with name and value of the attribute
           def raw_attribute(line)
-            logger.debug "Parsing attribute line #{line.inspect}" if logger_debug?
+            logger.debug { "Parsing attribute line #{line.inspect}" }
             matched = line.match(ATTRIBUTE_REGEXP)
             unless matched
               raise Occi::Core::Errors::ParsingError, "#{line.inspect} does not match expectations for Attribute"
@@ -133,7 +129,7 @@ module Occi
           def plain_links!(lines, entity)
             lines.each do |line|
               next unless line.start_with?(TextParser::LINK_KEYS.first)
-              logger.debug "Parsing link line #{line.inspect}" if logger_debug?
+              logger.debug { "Parsing link line #{line.inspect}" }
 
               matched = line.match(LINK_REGEXP)
               unless matched
@@ -196,11 +192,11 @@ module Occi
             target_kind = handle(Occi::Core::Errors::ParsingError) { model.find_by_identifier!(md[:rel]) }
             link = @_ib.build(categories.shift, target_kind: target_kind)
             categories.each do |mxn|
-              logger.debug "Adding mixin #{mxn.inspect} to link instance" if logger_debug?
+              logger.debug { "Adding mixin #{mxn.inspect} to link instance" }
               link << handle(Occi::Core::Errors::ParsingError) { model.find_by_identifier!(mxn) }
             end
 
-            logger.debug "Created link instance #{link.inspect} from #{md.inspect}" if logger_debug?
+            logger.debug { "Created link instance #{link.inspect} from #{md.inspect}" }
             link
           end
 
@@ -212,7 +208,7 @@ module Occi
             if md[:attributes].blank?
               raise Occi::Core::Errors::ParsingError, "Link #{link.id} is missing attribute information"
             end
-            logger.debug "Parsing inline link attributes from line #{md[:attributes].inspect}" if logger_debug?
+            logger.debug { "Parsing inline link attributes from line #{md[:attributes].inspect}" }
 
             regexp = Regexp.new "(\\s*#{Constants::REGEXP_ATTRIBUTE_REPR})"
             line = md[:attributes].strip.gsub(/^;\s*/, '')
@@ -234,7 +230,7 @@ module Occi
               raise Occi::Core::Errors::ParsingError, 'Cannot typecast (un)set value to (un)set type'
             end
 
-            logger.debug "Typecasting value #{value.inspect} to #{type}" if logger_debug?
+            logger.debug { "Typecasting value #{value.inspect} to #{type}" }
             self.class.typecaster[type].call(value)
           end
 

data/lib/occi/core/parsers/text/location.rb

@@ -11,10 +11,6 @@ module Occi
           include Helpers::ErrorHandler
 
           class << self
-            # Shortcuts to interesting methods on logger
-            DELEGATED = %i[debug? info? warn? error? fatal?].freeze
-            delegate(*DELEGATED, to: :logger, prefix: true)
-
             # Parses text/plain OCCI locations into `URI` instances suitable for futher processing.
             # Every location line is expected to begin with 'X-OCCI-Location'.
             #
@@ -25,7 +21,7 @@ module Occi
 
               locations = lines.map do |line|
                 next if line.blank?
-                logger.debug "Parsing location from line #{line.inspect}" if logger_debug?
+                logger.debug { "Parsing location from line #{line.inspect}" }
 
                 matched = line.match(regexp)
                 unless matched
@@ -45,7 +41,7 @@ module Occi
             def uri_list(lines)
               uris = lines.map do |line|
                 next if line.blank? || line.start_with?('#')
-                logger.debug "Parsing location from line #{line.inspect}" if logger_debug?
+                logger.debug { "Parsing location from line #{line.inspect}" }
 
                 handle(Occi::Core::Errors::ParsingError) { URI.parse(line.strip) }
               end

data/lib/occi/core/parsers/text_parser.rb

@@ -50,7 +50,7 @@ module Occi
         # @return [Set] set of instances
         def entities(body, headers, expectation = nil)
           expectation ||= Occi::Core::Entity
-          logger.debug "Parsing #{expectation} from #{body.inspect} and #{headers.inspect}" if logger_debug?
+          logger.debug { "Parsing #{expectation} from #{body.inspect} and #{headers.inspect}" }
 
           entity_parser = Text::Entity.new(model: model)
           entity = entity_parser.plain transform(body, headers)
@@ -68,7 +68,7 @@ module Occi
         # @param headers [Hash] raw headers as provided by the transport protocol
         # @return [Set] set of parsed instances
         def action_instances(body, headers)
-          logger.debug "Parsing Occi::Core::ActionInstance from #{body.inspect} and #{headers.inspect}" if logger_debug?
+          logger.debug { "Parsing Occi::Core::ActionInstance from #{body.inspect} and #{headers.inspect}" }
           entity_parser = Text::Entity.new(model: model)
           tformed = transform(body, headers)
 
@@ -88,7 +88,7 @@ module Occi
         # @return [Set] set of instances
         def categories(body, headers, expectation = nil)
           expectation ||= Occi::Core::Category
-          logger.debug "Parsing #{expectation} from #{body.inspect} and #{headers.inspect}" if logger_debug?
+          logger.debug { "Parsing #{expectation} from #{body.inspect} and #{headers.inspect}" }
 
           cats = transform(body, headers).map do |line|
             cat = Text::Category.plain_category(line, false)
@@ -119,9 +119,7 @@ module Occi
           # @param model [Occi::Core::Model] `Model`-like instance to be populated (may contain existing categories)
           # @return [Occi::Core::Model] model instance filled with parsed categories
           def model(body, headers, media_type, model)
-            if logger_debug?
-              logger.debug "Parsing model from #{media_type.inspect} in #{body.inspect} and #{headers.inspect}"
-            end
+            logger.debug { "Parsing model from #{media_type.inspect} in #{body.inspect} and #{headers.inspect}" }
 
             if HEADERS_TEXT_TYPES.include? media_type
               Text::Category.plain transform_headers(headers), model
@@ -139,9 +137,7 @@ module Occi
           # @param media_type [String] media type string as provided by the transport protocol
           # @return [Array] list of extracted URIs
           def locations(body, headers, media_type)
-            if logger_debug?
-              logger.debug "Parsing locations from #{media_type.inspect} in #{body.inspect} and #{headers.inspect}"
-            end
+            logger.debug { "Parsing locations from #{media_type.inspect} in #{body.inspect} and #{headers.inspect}" }
 
             if URI_LIST_TYPES.include? media_type
               Text::Location.uri_list transform_body(body)
@@ -170,7 +166,7 @@ module Occi
           # @param headers [Hash] hash with raw header key-value pairs
           # @return [Array] an array of body-like lines
           def transform_headers(headers)
-            logger.debug "Transforming headers #{headers.inspect}" if logger_debug?
+            logger.debug { "Transforming headers #{headers.inspect}" }
             unify_headers(
               canonize_headers(
                 normalize_headers(headers)
@@ -192,7 +188,7 @@ module Occi
             headers.delete_if { |_k, v| v.blank? }            # remove pairs with empty values
             headers.keep_if { |k, _v| OCCI_KEYS.include?(k) } # drop non-OCCI pairs
 
-            logger.debug "Normalized headers #{headers.inspect}" if logger_debug?
+            logger.debug { "Normalized headers #{headers.inspect}" }
             headers
           end
 
@@ -210,7 +206,7 @@ module Occi
               canonical[pref.first] = [canonize_header_value(value)].flatten
             end
 
-            logger.debug "Canonized headers #{canonical.inspect}" if logger_debug?
+            logger.debug { "Canonized headers #{canonical.inspect}" }
             canonical
           end
 
@@ -237,7 +233,7 @@ module Occi
               lines << v.map { |val| "#{k}: #{val}" }
             end
 
-            logger.debug "Unified headers #{lines.inspect}" if logger_debug?
+            logger.debug { "Unified headers #{lines.inspect}" }
             lines.flatten.sort
           end
 

data/lib/occi/core/renderer_factory.rb

@@ -31,7 +31,7 @@ module Occi
       def initialize(args = {})
         default_args! args
 
-        logger.debug "Initializing RendererFactory with #{args.inspect}"
+        logger.debug { "Initializing RendererFactory with #{args.inspect}" }
         @required_methods = args.fetch(:required_methods)
         @namespace = args.fetch(:namespace)
 
@@ -40,7 +40,7 @@ module Occi
 
       #
       def reload!
-        logger.debug 'Clearing RendererFactory cache for renderer reload'
+        logger.debug { 'Clearing RendererFactory cache for renderer reload' }
         @ravail_cache = nil
       end
 
@@ -65,7 +65,7 @@ module Occi
         @ravail_cache = {}
 
         renderer_classes.each do |rndr_klass|
-          logger.debug "RendererFactory registering #{rndr_klass} for #{rndr_klass.formats}"
+          logger.debug { "RendererFactory registering #{rndr_klass} for #{rndr_klass.formats}" }
           rndr_klass.formats.each { |rndr_klass_f| @ravail_cache[rndr_klass_f] = rndr_klass }
         end
 
@@ -113,7 +113,7 @@ module Occi
           renderer_with_methods! candidate
           renderer_with_formats! candidate
         rescue Occi::Core::Errors::RendererError => ex
-          logger.debug "Renderer validation failed with #{ex.message}"
+          logger.debug { "Renderer validation failed with #{ex.message}" }
           return false
         end
 
@@ -176,7 +176,7 @@ module Occi
             raise Occi::Core::Errors::RendererError, "#{namespace.inspect} " \
                   'is not a Module'
           end
-          logger.debug "RendererFactory looking for renderers in #{namespace}"
+          logger.debug { "RendererFactory looking for renderers in #{namespace}" }
           namespace.constants.collect { |const| namespace.const_get(const) }
         end
 

data/lib/occi/core/renderers/base_renderer.rb

@@ -32,7 +32,7 @@ module Occi
           # @option options [String] :format (nil) rendering (sub)type
           # @return [String] object rendering
           def render(object, options)
-            logger.debug "#{self} rendering #{object.inspect} with #{options.inspect}"
+            logger.debug { "#{self} rendering #{object.inspect} with #{options.inspect}" }
             candidate = rendering_candidate(object)
             unless candidate
               raise Occi::Core::Errors::RenderingError, "#{object.class} cannot be " \

data/lib/occi/core/renderers/json/link.rb

@@ -12,7 +12,7 @@ module Occi
         class Link < Base
           include Instance
 
-          # TODO: this is a hack for typing `source` on known Compute links
+          # Note: this is a hack for typing `source` on known Compute links
           COMPUTE_KIND  = 'http://schemas.ogf.org/occi/infrastructure#compute'.freeze
           COMPUTY_LINKS = %w[
             http://schemas.ogf.org/occi/infrastructure#networkinterface
@@ -32,10 +32,11 @@ module Occi
           def typed_uri_hash(attribute, type)
             hsh = { location: attribute.to_s }
 
-            if type == :target && object_respond_to?(:rel)
-              hsh[:kind] = object_rel.to_s
-            elsif type == :source && COMPUTY_LINKS.include?(object_kind.to_s)
-              # TODO: fix this mess
+            known_kind = object_send("#{type}_kind")
+            hsh[:kind] = known_kind.identifier if known_kind
+
+            # Note: this is a hack for typing `source` on known Compute links
+            if hsh[:kind].blank? && type == :source && COMPUTY_LINKS.include?(object_kind.identifier)
               hsh[:kind] = COMPUTE_KIND
             end
 

data/lib/occi/core/version.rb

@@ -2,7 +2,7 @@ module Occi
   module Core
     MAJOR_VERSION = 5                # Major update constant
     MINOR_VERSION = 0                # Minor update constant
-    PATCH_VERSION = 0                # Patch/Fix version constant
+    PATCH_VERSION = 1                # Patch/Fix version constant
     STAGE_VERSION = nil              # use `nil` for production releases
 
     unless defined?(::Occi::Core::VERSION)

data/lib/occi/core/warehouse.rb

@@ -29,7 +29,7 @@ module Occi
         #
         # @param model [Occi::Core::Model] model to be bootstrapped
         def bootstrap!(model)
-          logger.debug "Bootstrapping#{model.empty? ? ' empty' : ''} model"
+          logger.debug { "Bootstrapping#{model.empty? ? ' empty' : ''} model" }
           actions! model
           kinds! model
           mixins! model
@@ -67,7 +67,7 @@ module Occi
         def kinds!(model)
           attribute_definitions = attribute_definitions_for(kinds_path)
           yamls_in(kinds_path).each do |file|
-            logger.debug "Warehouse loading kind from #{file.inspect}"
+            logger.debug { "Warehouse loading kind from #{file.inspect}" }
             model << Occi::Core::Kind.from_yaml(file, model, attribute_definitions)
           end
         end
@@ -76,7 +76,7 @@ module Occi
         def mixins!(model)
           attribute_definitions = attribute_definitions_for(mixins_path)
           yamls_in(mixins_path).each do |file|
-            logger.debug "Warehouse loading mixin from #{file.inspect}"
+            logger.debug { "Warehouse loading mixin from #{file.inspect}" }
             model << Occi::Core::Mixin.from_yaml(file, model, attribute_definitions)
           end
         end
@@ -86,7 +86,7 @@ module Occi
           # TODO: work with separate attribute definitions
           attribute_definitions = {}
           yamls_in(actions_path).each do |file|
-            logger.debug "Warehouse loading action from #{file.inspect}"
+            logger.debug { "Warehouse loading action from #{file.inspect}" }
             model << Occi::Core::Action.from_yaml(file, model, attribute_definitions)
           end
         end
@@ -98,7 +98,7 @@ module Occi
           attr_defs_path = File.join(categories_path, ATTRIBS)
           yamls_in(attr_defs_path).each do |file|
             name = attribute_name_from(file)
-            logger.debug "Warehouse loading attribute definition for #{name.inspect} from #{file.inspect}"
+            logger.debug { "Warehouse loading attribute definition for #{name.inspect} from #{file.inspect}" }
             attribute_definitions[name] = Occi::Core::AttributeDefinition.from_yaml(file)
           end
 

data/lib/occi/infrastructure_ext/warehouse/kinds/attributes/occi.ipreservation.address.yml

@@ -1,6 +1,6 @@
 ---
 type: !ruby/class IPAddr
-required: true
+required: false
 mutable: true
 default: ~
 description: IP address (v4 or v6) assigned to this reservation.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: occi-core
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.0.1
 platform: ruby
 authors:
 - Boris Parak
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-23 00:00:00.000000000 Z
+date: 2017-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json