s2container 0.8.0

data/lib/seasar/container/s2application-context.rb

@@ -0,0 +1,447 @@
+# -*- coding: utf-8 -*-
+#--
+# +----------------------------------------------------------------------+
+# | Copyright 2005-2008 the Seasar Foundation and the Others.            |
+# +----------------------------------------------------------------------+
+# | Licensed under the Apache License, Version 2.0 (the "License");      |
+# | you may not use this file except in compliance with the License.     |
+# | You may obtain a copy of the License at                              |
+# |                                                                      |
+# |     http://www.apache.org/licenses/LICENSE-2.0                       |
+# |                                                                      |
+# | Unless required by applicable law or agreed to in writing, software  |
+# | distributed under the License is distributed on an "AS IS" BASIS,    |
+# | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,                        |
+# | either express or implied. See the License for the specific language |
+# | governing permissions and limitations under the License.             |
+# +----------------------------------------------------------------------+
+#++
+module Seasar
+  module Container
+    #
+    # The main functions of S2ApplicationContext become the next.
+    # - Generate S2Container which contains the registerd class as a component
+    # - Automatic setup of Aspect
+    # - Singleton S2Container instance management
+    #
+    class S2ApplicationContext
+      @@static_component_infos = []
+      @@static_aspect_infos = []
+      @@instance = nil
+      
+      class << self
+        #
+        # - args
+        #   - none
+        # - return
+        #   - Seasar::Container::S2ApplicationContext
+        #
+        def instance
+          if @@instance.nil?
+            @@instance = self.new
+          end
+          return @@instance;
+        end
+
+        #
+        # - args
+        #   1. Seasar::Container::S2ApplicationContext
+        # - return
+        #   - nil
+        #
+        def instance=(obj); @@instance = obj; end
+      end
+
+      #
+      # - args
+      #   - none
+      # - return
+      #   - nil
+      #
+      def initialize
+        self.init
+      end
+
+      #
+      # - args
+      #   - none
+      # - return
+      #   - nil
+      #
+      def init(options = {})
+        if options[:force] == true
+          @@static_component_infos = []
+          @@static_aspect_infos    = []
+          @@instance = nil
+        end
+        @include_patterns = []
+        @exclude_patterns = []
+        @singletons       = {}
+        @selectors        = []
+        @component_infos  = []
+        @aspect_infos     = []
+        @snapshot_component_infos = nil
+        @snapshot_aspect_infos    = nil
+      end
+
+      #
+      # - args
+      #   - none
+      # - return
+      #   - Array : component information list.
+      #
+      def component_infos
+        return @snapshot_component_infos if self.snapshot?
+        return @component_infos + @@static_component_infos
+      end
+
+      #
+      # - args
+      #   - none
+      # - return
+      #   - Array : aspect information list.
+      #
+      def aspect_infos
+        return @snapshot_aspect_infos if self.snapshot?
+        return @aspect_infos + @@static_aspect_infos
+      end
+
+      #
+      # - args
+      #   - none
+      # - return
+      #   - Boolean
+      #
+      def snapshot?
+        if @snapshot_component_infos.nil? && @snapshot_aspect_infos.nil?
+          return false
+        else
+          return true
+        end
+      end
+
+      #
+      # - args
+      #   - none
+      # - return
+      #   - S2ApplicationContext
+      #
+      def snapshot
+        app = S2ApplicationContext.new
+        app.snapshot_component_infos = self.component_infos
+        app.snapshot_aspect_infos    = self.aspect_infos
+        return app
+      end
+
+      #
+      # - args
+      #   1. Array <em>infos</em>
+      # - return
+      #   - nil
+      #
+      def snapshot_component_infos=(infos)
+        @snapshot_component_infos = infos
+      end
+
+      #
+      # - args
+      #   1. Array <em>infos</em>
+      # - return
+      #   - nil
+      #
+      def snapshot_aspect_infos=(infos)
+        @snapshot_aspect_infos = infos
+      end
+
+      #
+      # - args
+      #   1. Hash _options_ component information
+      #   2. Proc _procedure_ constructor block of component
+      # - return
+      #   - nil
+      #
+      def register(options = {}, &procedure)
+        raise "can not register component_info to snapshot application context." if self.snapshot?
+        info = ComponentInfoDef.new(options, &procedure)
+        if options[:static] == true
+          @@static_component_infos << info
+        else
+          @component_infos << info
+        end
+      end
+
+      #
+      # - args
+      #   1. Hash _options_ aspect information
+      #   2. Proc _procedure_ interceptor block
+      # - return
+      #   - nil
+      #
+      def register_aspect(options, &procedure)
+        raise "can not register aspect_info to snapshot application context." if self.snapshot?
+        if block_given?
+          options[:interceptor] = procedure
+        end
+
+        info = AspectInfoDef.new(options)
+        if options[:static] == true
+          @@static_aspect_infos << info
+        else
+          @aspect_infos << info
+        end
+      end
+      alias aspect register_aspect
+
+      #
+      # - args
+      #   1. String|Symbol <em>key</em> component key
+      #   2. Array <em>namespaces</em> String namespaces
+      #   3. Proc <em>procedure</em> constructor block
+      # - return
+      #   - Object
+      #
+      def get_component(key, namespaces = [], &procedure)
+        namespace_key = self.create_singleton(namespaces)
+        return @singletons[namespace_key].get_component(key, &procedure)
+      end
+      alias component get_component
+      alias get get_component
+      alias [] get_component
+
+      #
+      # - args
+      #   1. String|Symbol <em>key</em> component key
+      #   2. Array <em>namespaces</em> String namespaces
+      # - return
+      #   - Boolean
+      #
+      def has_component_def(key, namespaces = [])
+        namespace_key = self.create_singleton(namespaces)
+        return @singletons[namespace_key].has_component_def(key)
+      end
+      alias component_def? has_component_def
+
+      #
+      # - args
+      #   1. Array <em>namespaces</em> String namespaces
+      # - return
+      #   - String
+      #
+      def create_singleton(namespaces)
+        namespaces = [namespaces] unless namespaces.is_a?(Array)
+        key = namespaces.sort
+        if not @singletons.key?(key)
+          @singletons[key] = self.create(namespaces)
+        end
+        return key
+      end
+
+      #
+      # - args
+      #   1. Array <em>namespaces</em> String namespaces
+      #   2. Proc <em>procedure</em> constructor block
+      # - return
+      #   - Seasar::Container::S2Container
+      #
+      def create(namespaces = [], &procedure)
+        namespaces = [namespaces] unless namespaces.is_a?(Array)
+        container = S2Container.new
+        component_defs = []
+        component_infos = self.get_component_infos(namespaces)
+        component_infos = self.select_component_infos(component_infos, &procedure)
+        component_infos.each {|component_info|
+          if component_info.procedure.nil?
+            cd = ComponentDef.new(component_info.component_class, component_info.component_name)
+          else
+            procedure = component_info.procedure
+            cd = ComponentDef.new(component_info.component_class, component_info.component_name, &procedure)
+          end
+          if not component_info.instance.nil?
+            cd.instance_def = Seasar::Container::Deployer::InstanceDefFactory.get_instance_def(component_info.instance)
+          end
+          if not component_info.autobinding.nil?
+            cd.autobinding_def = Seasar::Container::Assembler::AutoBindingDefFactory.get_autobinding_def(component_info.autobinding)
+          end
+          component_defs << cd
+          if component_info.namespace.nil?
+            container.register(cd)
+          else
+            self.get_container(container, component_info.namespace).register(cd)
+          end
+        }
+        component_defs.each{|cd|
+          self.setup_auto_aspect(cd)
+        }
+        return container
+      end
+
+      #
+      # - args
+      #   1. Seasar::Container::ComponentDef <em>component_def</em>
+      # - return
+      #   - nil
+      #
+      def setup_auto_aspect(component_def)
+        self.aspect_infos.each {|aspect_info|
+          if aspect_info.applicable?(component_def)
+            aspect_def = AspectDef.new(aspect_info.pointcut)
+            if component_def.container.has_component_def(aspect_info.interceptor)
+              aspect_def.child_component_def = component_def.container.get_component_def(aspect_info.interceptor)
+            else
+              aspect_def.value = aspect_info.interceptor
+            end
+            component_def.add_aspect_def(aspect_def)
+          end
+        }
+      end
+
+      #
+      # - args
+      #   1. Seasar::Container::S2Container <em>container</em>
+      #   2. String <em>namespace</em>
+      # - return
+      #   - Seasar::Container::S2Container
+      #
+      def get_container(container, namespace)
+        items = namespace.split('.', 2)
+        if container.has_component_def(items[0])
+          if items.length == 1
+            return container.get_component(items[0])
+          else
+            return self.get_container(container.get_component(items[0]), items[1])
+          end
+        else
+          child = S2Container.new
+          child.namespace = items[0]
+          container.include(child)
+          if items.length == 1
+            return child
+          else
+            return self.get_container(child, items[1])
+          end
+        end
+      end
+
+      #
+      # - args
+      #   1. Array <em>component_infos</em> Array of Seasar::Container::ComponentInfoDef
+      #   2. Proc <em>procedure</em> filter block
+      # - return
+      #   - Array
+      #
+      def select_component_infos(component_infos, &procedure)
+        @selectors.each {|selector|
+          component_infos = selector.call(component_infos)
+          raise TypeError.new("result of component selector must be Array") if not component_infos.is_a?(Array)
+        }
+        if not procedure.nil?
+          component_infos = procedure.call(component_infos)
+        end
+        raise TypeError.new("result of component selector must be Array") if not component_infos.is_a?(Array)
+        return component_infos
+      end
+
+      #
+      # - args
+      #   1. Array <em>namespaces</em> String namespaces
+      # - return
+      #   - Array
+      #
+      def get_component_infos(namespaces)
+        component_infos = self.select_component_info_by_namespace(self.component_infos, namespaces)
+        component_infos = self.select_component_info_by_include(component_infos)
+        component_infos = self.select_component_info_by_exclude(component_infos)
+        return component_infos
+      end
+
+      #
+      # - args
+      #   1. Array <em>component_infos</em> Array of Seasar::Container::ComponentInfoDef
+      # - return
+      #   - Array
+      #
+      def select_component_info_by_exclude(component_infos)
+        return component_infos if @exclude_patterns.size == 0
+        result = []
+        component_infos.each {|info|
+          @exclude_patterns.each {|pattern|
+            if info.match(pattern)
+              next
+            end
+            result << info
+            break
+          }
+        }
+        return result
+      end
+
+      #
+      # - args
+      #   1. Array <em>component_infos</em> Array of Seasar::Container::ComponentInfoDef
+      # - return
+      #   - Array
+      #
+      def select_component_info_by_include(component_infos)
+        return component_infos if @include_patterns.size == 0
+        result = []
+        component_infos.each {|info|
+          @include_patterns.each {|pattern|
+            if info.match(pattern)
+              result << info
+              break
+            end
+          }
+        }
+        return result
+      end
+
+      #
+      # - args
+      #   1. Array <em>component_infos</em> Array of Seasar::Container::ComponentInfoDef
+      #   2. Array <em>namespaces</em> String namespaces
+      # - return
+      #   - Array
+      #
+      def select_component_info_by_namespace(component_infos, namespaces)
+        return component_infos if namespaces.size == 0
+        reg_namespaces = namespaces.map {|v| /^#{v.gsub(/\./, '\.')}\./ }
+        return component_infos.select {|info|
+          next false if info.namespace.nil?
+          next true if namespaces.member?(info.namespace)
+          next true if nil != reg_namespaces.find {|reg| info.namespace.match(reg)}
+          next false
+          }
+      end
+
+      #
+      # - args
+      #   1. Proc <em>procedure</em> filter block
+      # - return
+      #   - nil
+      #
+      def select(&procedure)
+        @selectors << procedure if not procedure.nil?
+      end
+
+      #
+      # - args
+      #   1. String|Symbol|Class|Module|Regexp <em>pattern</em>
+      # - return
+      #   - nil
+      #
+      def include(pattern)
+        @include_patterns << pattern
+      end
+
+      #
+      # - args
+      #   1. String|Symbol|Class|Module|Regexp <em>pattern</em>
+      # - return
+      #   - nil
+      #
+      def exclude(pattern)
+        @exclude_patterns << pattern
+      end
+    end
+  end
+end

data/lib/seasar/container/s2container-component-def.rb

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+#--
+# +----------------------------------------------------------------------+
+# | Copyright 2005-2008 the Seasar Foundation and the Others.            |
+# +----------------------------------------------------------------------+
+# | Licensed under the Apache License, Version 2.0 (the "License");      |
+# | you may not use this file except in compliance with the License.     |
+# | You may obtain a copy of the License at                              |
+# |                                                                      |
+# |     http://www.apache.org/licenses/LICENSE-2.0                       |
+# |                                                                      |
+# | Unless required by applicable law or agreed to in writing, software  |
+# | distributed under the License is distributed on an "AS IS" BASIS,    |
+# | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,                        |
+# | either express or implied. See the License for the specific language |
+# | governing permissions and limitations under the License.             |
+# +----------------------------------------------------------------------+
+#++
+module Seasar
+  module Container
+    class S2ContainerComponentDef < SimpleComponentDef
+
+      # - args
+      #   1. Seasar::Container::S2Container <em>container</em>
+      #   2. Symbol|String <em>name</em>
+      def initialize(container, name)
+        super
+      end
+
+      #
+      # - args
+      #   - none
+      # - return
+      #   - Seasar::Container::S2Container
+      #
+      def get_container
+        return @component
+      end
+    end
+  end
+end