copland 0.8.0

data/lib/copland/configuration/loader.rb

@@ -0,0 +1,113 @@
+#--
+# =============================================================================
+# 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
+  module Configuration
+
+    # This is the driver class for processing a series of directories, looking
+    # for configuration files. It relies on visitor objects to do the actual
+    # configuration processing--all this class does is recurse through the
+    # requested directories.
+    class Loader
+
+      # This is the array of search paths that the loader will descend.
+      attr_reader :search_paths
+
+      # This is the array of visitor objects that will be employed by this
+      # driver.
+      attr_reader :loaders
+
+      # Create a new Loader object that will search the given paths.
+      # Regardless, the 'copland/impl' directory will always be processed.
+      def initialize( search_paths=[] )
+        @search_paths = []
+        use_library "copland"
+        add_search_path *search_paths
+        @loaders = []
+      end
+
+      # Add new search paths to be searched.
+      def add_search_path( *paths )
+        @search_paths.concat( paths ).uniq!
+      end
+
+      # Add a new visitor loader to be used while processing directories.
+      def add_loader( loader )
+        @loaders.push loader
+      end
+
+      # Processes each search path in turn, and finishes by calling
+      # #finalize! on each of the visitors. The +options+ parameter is
+      # passed to each loader.
+      def load( options={} )
+        @search_paths.each { |path| load_path path, options }
+        @loaders.each { |loader| loader.finalize! }
+      end
+
+      # Processes a single path (recursively). Each loader gets a turn
+      # at the directory, and then any subdirectories are processed by
+      # recursively calling this method on that directory.
+      #
+      # If the given path does not exist, this does nothing.
+      def load_path( path, options )
+        return unless File.directory?( path ) 
+
+        @loaders.each do |loader|
+          options = loader.process_dir( path, options )
+        end
+
+        Dir.foreach( path ) do |entry|
+          next if entry == "." || entry == ".."
+
+          file_name = File.join( path, entry )
+          load_path( file_name, options ) if File.directory?( file_name )
+        end
+      end
+
+      # Adds the use of the given library to the registry that is being
+      # constructed. The +name+ parameter must be the string that would be
+      # +require+'d (i.e., "copland/lib"). That file must then (at least)
+      # add a value to the Copland::LIBRARIES hash: the key must be the
+      # library name (i.e., "copland/lib"), and the value must be an array
+      # of paths that should be searched for this library, for package
+      # descriptors.
+      def use_library( name )
+        require( name )
+        # add_search_path does a uniq! on the result, so we can always just
+        # add the whole thing in and not worry about duplication.
+        add_search_path *Copland::LIBRARIES[ name ]
+      end
+    end
+
+  end
+end

data/lib/copland/configuration/yaml/configuration-point.rb

@@ -0,0 +1,87 @@
+#--
+# =============================================================================
+# 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/class-factory'
+require 'copland/configuration-point'
+require 'copland/configuration/yaml/schema'
+require 'copland/configuration/yaml/utils'
+
+module Copland
+  module Configuration
+    module YAML
+
+      # This delegate is responsible for processing configuration points in a
+      # package descriptor.
+      class ConfigurationPointProcessor
+        include TypeValidator
+
+        # Creates a new ConfigurationPointProcessor that feeds into the given
+        # Package instance. The +options+ are used while processing each
+        # configuration point.
+        def initialize( package, options={} )
+          @package = package
+          @options = options
+          @schema = SchemaParser.new
+        end
+
+        # The list of recognized key values in a configuration point element.
+        VALID_KEYS = [ "description", "type", "schema" ]
+
+        # The list of required key values in a configuration point element.
+        REQUIRED_KEYS = [ "type" ]
+
+        # Create and return a new configuration point with the given name.
+        # Initialize it with the data in the +doc+ parameter (which must be a
+        # Hash).
+        def process( name, doc )
+          ensure_element_type "configuration-point", doc, Hash
+          validate_elements doc
+
+          factory = Copland::ClassFactory.instance
+          point = factory.get( Copland::ConfigurationPoint::POOL_NAME,
+            doc["type"], @package, name, @options )
+
+          point.description = doc["description"]
+
+          if doc['schema']
+            point.schema = @schema.process( point, doc['schema'] )
+          end
+
+          return point
+        end
+
+      end
+
+    end
+  end
+end

data/lib/copland/configuration/yaml/implementor.rb

@@ -0,0 +1,134 @@
+#--
+# =============================================================================
+# 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/class-factory'
+require 'copland/configuration/errors'
+require 'copland/instantiator/abstract'
+
+module Copland
+  module Configuration
+    module YAML
+
+      # This structure is used to represent individual values in an
+      # implementor's "construction parameters". It is basically used to
+      # remove the YAML-specific data structures, so that the core Copland
+      # routines become more YAML-agnostic.
+      ValueElement = Struct.new( :type_id, :value )
+
+      # This delegate is responsible for processing the 'implementor' token in
+      # a YAML stream.
+      class ImplementorProcessor
+
+        # Process the given implementor +definition+ and set the service
+        # point's instantiator to the resulting instantiator.
+        #
+        # If definition is a string, then the instantiator will be
+        # "simple", backed by the class given as the definition.
+        #
+        # If definition is a Hash, then the instantiator will be "complex",
+        # and will be described by the definition.
+        #
+        # Any other type is an error.
+        def process( point, definition )
+          case definition
+            when String
+              instantiator = "simple"
+            when Hash
+              instantiator = "complex"
+              deyamlize_hash point, definition
+            else
+              raise ParserError,
+                "'implementor' must be either a String or a Hash"
+          end
+
+          factory = Copland::ClassFactory.instance
+          point.instantiator = factory.get( Copland::Instantiator::POOL_NAME,
+            instantiator, point, definition )
+        end
+
+        # Converts the given hash from YAML-specific data structures to more
+        # general ValueElement-based data.
+        def deyamlize_hash( point, hash, path="" )
+          hash.each_pair do |key, value|
+            hash[ key ] = deyamlize_value( point, key, value, path )
+          end
+        end
+        private :deyamlize_hash
+
+        # Converts the given array from YAML-specific data structures to more
+        # general ValueElement-based data.
+        def deyamlize_array( point, array, path="" )
+          index = 0
+          return array.map do |v|
+            v = deyamlize_value point, index, v, path
+            index += 1
+            v
+          end
+        end
+        private :deyamlize_array
+
+        # Converts the given value from YAML-specific data structures to more
+        # general ValueElement-based data. The converted value is returned.
+        def deyamlize_value( point, key, value, path )
+          new_value = ValueElement.new "string", value
+
+          if value.is_a? Hash
+            new_value.type_id = "hash"
+            deyamlize_hash point, value, path + key.to_s + "/"
+
+          elsif value.is_a? Array
+            new_value.type_id = "array"
+            new_value.value = deyamlize_array point, value,
+              path + key.to_s + "/"
+
+          elsif value.is_a? Integer
+            new_value.type_id = "integer"
+
+          elsif value.is_a? Float
+            new_value.type_id = "real"
+
+          elsif value.respond_to?( :type_id ) && value.respond_to?( :value )
+            new_value.type_id = value.type_id
+            new_value.value = value.value
+
+          end
+
+          return new_value
+        end
+        private :deyamlize_value
+
+      end
+
+    end
+  end
+end

data/lib/copland/configuration/yaml/interceptor.rb

@@ -0,0 +1,63 @@
+#--
+# =============================================================================
+# 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/configuration/errors'
+require 'copland/configuration/yaml/utils'
+
+module Copland
+  module Configuration
+    module YAML
+
+      # Manages the processing of 'interceptor' elements from the parsed YAML
+      # stream.
+      class InterceptorProcessor
+        include TypeValidator
+
+        # Processes the given +definition+ (which must be a Hash), and adds
+        # the definition as a pending interceptor to the given service point
+        # (see ServicePoint#add_pending_interceptor).
+        def process( point, definition )
+          ensure_element_type "interceptor", definition, Hash
+
+          unless definition[ "service" ]
+            raise ParserError, "missing element: service"
+          end
+
+          point.add_pending_interceptor definition
+        end
+
+      end
+
+    end
+  end
+end

data/lib/copland/configuration/yaml/listener.rb

@@ -0,0 +1,56 @@
+#--
+# =============================================================================
+# 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/configuration/yaml/utils'
+
+module Copland
+  module Configuration
+    module YAML
+
+      # This delegate is responsible for processing an element the 'listen-to'
+      # construct.
+      class ListenerProcessor
+        include TypeValidator
+
+        # Adds the given definition to the point as an event producer. (See
+        # ServicePoint::add_event_producer.)
+        def process( point, definition )
+          ensure_element_type "listen-to-element", definition, String
+          point.add_event_producer definition
+        end
+
+      end
+
+    end
+  end
+end