copland 0.8.0

data/lib/copland/utils.rb

@@ -0,0 +1,221 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 
+#     * Redistributions of source code must retain the above copyright notice,
+#       this list of conditions and the following disclaimer.
+# 
+#     * Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+# 
+#     * The names of its contributors may not be used to endorse or promote
+#       products derived from this software without specific prior written
+#       permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# =============================================================================
+#++
+
+require 'copland/errors'
+require 'copland/log-factory'
+require 'copland/registry'
+require 'copland/configuration/errors'
+
+module Copland
+
+  # This is the regular expression that is used to match substitution
+  # string patterns in a value.
+  SUBSTITUTION_STRING_REGEXP = /\${(.*?)}/
+
+  # Examines the +id+ to determine whether it is a local service, or a
+  # fully-qualified service name.  If it is local, then it pertains to the
+  # given +pkg+ parameter.  Otherwise, the corresponding package is looked up
+  # in the registry.
+  #
+  # Without a block, this always calls Package#service( id ).  With a block,
+  # it passes the correct pkg and unqualified service name to the block and
+  # returns the result.
+  def get_possibly_local_service( registry, pkg, id )
+    if id =~ /^(.+)\.([^.]+)$/
+      pkg = registry.package( $1 )
+      id = $2
+    end
+
+    if block_given?
+      yield pkg, id
+    else
+      pkg.service( id )
+    end
+  end
+
+  # Deconstructs the given reference to get the +require+ and +classname+
+  # parts of the reference.  If there is no +require+ portion, then it will
+  # return nil for that part.
+  #
+  # For example:
+  #
+  #   'copland/impl/builder/BuilderFactory'
+  #
+  # would return:
+  #
+  #   [ 'copland/impl/builder', '::BuilderFactory' ]
+  #
+  # and
+  #
+  #   'LoggingInterceptor'
+  #
+  # would return:
+  #
+  #   [ nil, '::LoggingInterceptor' ]
+  #
+  # Note that '::' is prepended onto the class part, to help ensure that the
+  # requested class is always evaluated in the topmost context.
+  def get_class_ref_parts( ref )
+    if ref =~ %r{^(.+)/([^/]+)$}
+      return [ $1, "::" + $2 ]
+    end
+
+    return [ nil, ref ]
+  end
+
+  # A convenience function for parsing the reference (using
+  # #get_class_ref_parts) and automatically doing the +require+ (if needed).
+  # The class that was referred to is returned.
+  def get_class( ref )
+    require_file, class_name = get_class_ref_parts( ref )
+
+    require require_file if require_file
+    return eval( class_name )
+  end
+
+  # Translates the given value.  If the value is an object that responds the
+  # +type_id+ method, then it is translated to another value, based on its
+  # +type_id+.  Otherwise, the value itself is returned.
+  #
+  # The values are translated based on this table:
+  #
+  # service-id::
+  #   the value is treated as a as service-id, and the service is looked up
+  # configuration-id::
+  #   the value is treated as a as configuration-point id, and the
+  #   configuration point is looked up and used as the value
+  # class::      the value is interpreted as the path to and name of a class.
+  # log::
+  #   the value is ignored, but a new logger is allocated for the service point
+  # int::        the value is interpreted as an integer
+  # real::       the value is interpreted as a floating point
+  # string::     the value is interpreted as a string
+  def translate_value( registry, pkg, point, value )
+    substitute_symbols( registry, value )
+
+    if value.is_a?( Array )
+      return translate_array( registry, pkg, point, value )
+
+    elsif value.is_a?( Hash )
+      return translate_hash( registry, pkg, point, value )
+
+    elsif value.respond_to?( :type_id )
+      case value.type_id
+        when "service"
+          return get_possibly_local_service( registry, pkg, value.value )
+        when "configuration"
+          cfg = get_possibly_local_service(
+            registry, pkg, value.value ) do |pkg,id|
+              raise PackageNotFound, value.value unless pkg
+              pkg.configuration_point id
+            end
+          raise ConfigurationPointNotFound, value.value unless cfg
+          return cfg
+        when "class"
+          return get_class( value.value )
+        when "log"
+          return registry.logs.get( point.full_name )
+        when "integer"
+          return value.value.to_i
+        when "real"
+          return value.value.to_f
+        when "string"
+          return value.value.to_s
+        when "hash"
+          return translate_hash( registry, pkg, point, value.value )
+        when "array"
+          return translate_array( registry, pkg, point, value.value )
+        when "boolean"
+          return value.to_s == "true"
+        else
+          raise Copland::Configuration::ParserError, "unknown value type id: #{value.type_id}"
+      end
+    end
+
+    value
+  end
+
+  # Translate a hash value.
+  def translate_hash( registry, pkg, point, hash )
+    new_hash = Hash.new
+    hash.each_pair do |k, v|
+      new_hash[k] = translate_value( registry, pkg, point, v )
+    end
+    return new_hash
+  end
+
+  # Translate an array value.
+  def translate_array( registry, pkg, point, array )
+    array.map { |v| translate_value( registry, pkg, point, v ) }
+  end
+
+  # Substitutes all symbols (in place) for the given value.  If the value
+  # responds to the +type_id+ method, then the result of the +value+ method is
+  # used for the substitution (thus, this works on private YAML types).
+  def substitute_symbols( registry, value )
+    str = ( value.respond_to?( :type_id ) ? value.value : value )
+    return unless str.respond_to? :gsub!
+
+    str.gsub!( SUBSTITUTION_STRING_REGEXP ) do
+      symbol = $1
+      result = lookup_symbol( registry, symbol )
+      if result == NOT_FOUND
+        symbol.upcase.gsub( /[^a-zA-Z0-9]/, "_" )
+      else
+        result
+      end
+    end
+  end
+
+  # A constant identifying the name of the SymbolSourceManager service.
+  DEFAULT_SYMBOL_SOURCE = "copland.SymbolSourceManager"
+
+  # A constant used to indicate that the symbol was not found
+  NOT_FOUND = Object.new
+
+  # Looks in the SymbolSource service for the given symbol.
+  def lookup_symbol( registry, symbol )
+    source = registry.service( DEFAULT_SYMBOL_SOURCE )
+    source.lookup( symbol, NOT_FOUND )
+  end
+
+  module_function :get_possibly_local_service
+  module_function :get_class_ref_parts
+  module_function :get_class
+  module_function :translate_value
+  module_function :translate_hash
+  module_function :translate_array
+  module_function :substitute_symbols
+  module_function :lookup_symbol
+
+end

data/lib/copland/version.rb

@@ -0,0 +1,47 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 
+#     * Redistributions of source code must retain the above copyright notice,
+#       this list of conditions and the following disclaimer.
+# 
+#     * Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+# 
+#     * The names of its contributors may not be used to endorse or promote
+#       products derived from this software without specific prior written
+#       permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# =============================================================================
+#++
+
+module Copland
+
+  # A simple module for holding version information about Copland.
+  module Version
+
+    MAJOR = 0
+    MINOR = 8
+    TINY  = 0
+
+    STRING = [ MAJOR, MINOR, TINY ].join( "." )
+
+  end
+
+end

data/test/conf-test/list-bad-key.yml

@@ -0,0 +1,30 @@
+---
+id: list-good
+
+configuration-points:
+
+  ListGood:
+    type: list
+    schema:
+      definition:
+        service:
+          type: string
+          required: true
+        before:
+          type: array
+        after:
+          type: array
+
+contributions:
+
+  ListGood:
+    - service: some.Service
+    - service: another.Service
+      before:
+        - some.Service
+      bogus: value
+    - service: last.Service
+      before:
+      - some.Service
+      after:
+      - another.Service

data/test/conf-test/list-bad-missing.yml

@@ -0,0 +1,28 @@
+---
+id: list-bad-missing
+
+configuration-points:
+
+  ListBadMissing:
+    type: list
+    schema:
+      definition:
+        service:
+          type: string
+          required: true
+        before:
+          type: array
+        after:
+          type: array
+
+contributions:
+
+  ListBadMissing:
+    - service: some.Service
+    - service: another.Service
+      before:
+        - some.Service
+    - before:
+      - some.Service
+      after:
+      - another.Service

data/test/conf-test/list-bad-type.yml

@@ -0,0 +1,28 @@
+---
+id: list-bad-type
+
+configuration-points:
+
+  ListBadType:
+    type: list
+    schema:
+      definition:
+        service:
+          type: string
+          required: true
+        before:
+          type: array
+        after:
+          type: array
+
+contributions:
+
+  ListBadType:
+    - service: some.Service
+    - service: another.Service
+      before: some.Service
+    - service: last.Sevice
+      before:
+      - some.Service
+      after:
+      - another.Service

data/test/conf-test/list-good.yml

@@ -0,0 +1,29 @@
+---
+id: list-good
+
+configuration-points:
+
+  ListGood:
+    type: list
+    schema:
+      definition:
+        service:
+          type: string
+          required: true
+        before:
+          type: array
+        after:
+          type: array
+
+contributions:
+
+  ListGood:
+    - service: some.Service
+    - service: another.Service
+      before:
+        - some.Service
+    - service: last.Service
+      before:
+      - some.Service
+      after:
+      - another.Service

data/test/conf-test/map-bad-key.yml

@@ -0,0 +1,25 @@
+---
+id: map-bad-key
+
+configuration-points:
+
+  MapBadKey:
+    type: map
+    schema:
+      definition:
+        service:
+          type: string
+          required: true
+        options:
+          type: array
+        color:
+          type: string
+
+contributions:
+
+  MapBadKey:
+    service: some.Service
+    bogus:
+    - opt1: opt2
+    - opt3: opt4
+    color: blue

data/test/conf-test/map-bad-missing.yml

@@ -0,0 +1,24 @@
+---
+id: map-bad-missing
+
+configuration-points:
+
+  MapBadMissing:
+    type: map
+    schema:
+      definition:
+        service:
+          type: string
+          required: true
+        options:
+          type: array
+        color:
+          type: string
+
+contributions:
+
+  MapBadMissing:
+    options:
+    - opt1: opt2
+    - opt3: opt4
+    color: blue

data/test/conf-test/map-bad-type.yml

@@ -0,0 +1,23 @@
+---
+id: map-bad-type
+
+configuration-points:
+
+  MapBadType:
+    type: map
+    schema:
+      definition:
+        service:
+          type: string
+          required: true
+        options:
+          type: array
+        color:
+          type: string
+
+contributions:
+
+  MapBadType:
+    service: some.Service
+    options: hello
+    color: blue