micon 0.1.22 → 0.1.23

data/lib/micon.rb

@@ -15,7 +15,7 @@ end
   class
 }.each{|f| require "micon/#{f}"}
 
-# Initializing Micon
+# Initializing Micon.
 Micon::Core.send :include, Micon::Helper
 micon = Micon::Core.new
 micon.initialize!

data/lib/micon/class.rb

@@ -1,6 +1,7 @@
 class Class
-  # register_as :session, scope: :request
-  # register_as :loggger
+  # Usage:
+  #     register_as :session, scope: :request
+  #     register_as :loggger
   def register_as *args
     ::MICON.register(*args){self.new}
   end

data/lib/micon/config.rb

@@ -14,7 +14,7 @@ class Micon::Config
       c = YAML.load_file(f)
       next unless c
       raise "component config must be a Hash (#{f})!" unless c.is_a? Hash
-      c.each{|k, v| config[:"#{k}="] = v}
+      c.each{|k, v| config[k.to_sym] = v}
     end
 
     config.empty? ? nil : config

data/lib/micon/core.rb

@@ -1,12 +1,8 @@
-# Predefined scopes are: :application | :session | :instance | :"custom_name"
-#
-# Micons :"custom_name" are managed by 'scope_begin' / 'scope_end' methods
-#
-# :"custom_name" can't be nested (it will destroy old and start new one) and always should be explicitly started!.
+# There are 3 types of component scopes: :application, :instance and custom scope.
+# Custom scopes are managed with `activate` and `deactivate` methods.
 class Micon::Core
-  #
-  # Scope Management
-  #
+  # Scope Management.
+
   attr_accessor :custom_scopes
 
   def activate sname, container, &block
@@ -61,10 +57,8 @@ class Micon::Core
     @application.empty? and @custom_scopes.empty?
   end
 
+  # Component Management.
 
-  #
-  # Object Management
-  #
   def include? key
     sname = @registry[key]
 
@@ -75,7 +69,7 @@ class Micon::Core
       true
     when :application
       @application.include? key
-    else # custom
+    else # custom scope.
       container = @custom_scopes[sname]
       return false unless container
       container.include? key
@@ -95,7 +89,7 @@ class Micon::Core
       else
         return o
       end
-    else # custom
+    else # custom scope.
       container = @custom_scopes[sname]
       raise_without_self "Scope '#{sname}' not started!" unless container
       o = container[key]
@@ -117,7 +111,7 @@ class Micon::Core
       raise_without_self "You can't outject variable with the 'instance' sname!"
     when :application
       @application[key] = value
-    else # custom
+    else # custom scope.
       container = @custom_scopes[sname]
       raise_without_self "Scope '#{sname}' not started!" unless container
       container[key] = value
@@ -129,7 +123,7 @@ class Micon::Core
   end
 
   def delete key
-    sname = @registry[key] # || autoload_component_definition(key)
+    sname = @registry[key]
 
     case sname
     when nil
@@ -137,9 +131,8 @@ class Micon::Core
       raise_without_self "You can't outject variable with the 'instance' scope!"
     when :application
       @application.delete key
-    else # Custom
+    else # custom scope.
       container = @custom_scopes[sname]
-      # raise_without_self "Scope '#{sname}' not started!" unless container
       container.delete key if container
     end
   end
@@ -154,9 +147,8 @@ class Micon::Core
     self[key]
   end
 
-  #
-  # Metadata
-  #
+  # Metadata.
+
   attr_accessor :metadata
 
   def register key, options = {}, &initializer
@@ -165,7 +157,6 @@ class Micon::Core
 
     sname = options.delete(:scope) || :application
     dependencies = Array(options.delete(:require) || options.delete(:depends_on))
-    # constant = options.delete(:constant) || false
 
     raise "unknown options :#{options.keys.join(', :')}!" unless options.empty?
 
@@ -173,17 +164,11 @@ class Micon::Core
       raise "internal error, reference to registry aren't equal to actual registry!"
     end
     @metadata.registry[key] = sname
-    @metadata.initializers[key] = [initializer, dependencies] #, constant]
-    # if constant
-    #   raise "component '#{key}' defined as constant must be a symbol!" unless key.is_a? Symbol
-    #   raise "component '#{key}' defined as constant can have only :application scope!" unless sname == :application
-    #   @constants[key] = true
-    # end
+    @metadata.initializers[key] = [initializer, dependencies]
   end
 
   def unregister key
     @metadata.delete key
-    # @constants.delete key
   end
 
   def before component, options = {}, &block
@@ -216,8 +201,6 @@ class Micon::Core
     @metadata.register_after_scope sname, &block
   end
 
-
-
   def clone
     another = super
     %w(@metadata @application @custom_scopes).each do |name| # @loaded_classes, @constants
@@ -232,9 +215,9 @@ class Micon::Core
 
   def initialize!
     unless @initialized
-      # quick access to Metadata inner variable.
-      # I intentially broke the Metadata incapsulation to provide better performance, don't refactor it.
-      @registry = {} # @loaded_classes, @constants = {}, {}
+      # Quick access to Metadata inner variable. I intentially broke
+      # the Metadata incapsulation to provide better performance, don't refactor it.
+      @registry = {}
       @metadata = Micon::Metadata.new(@registry)
       @stack = {}
 
@@ -252,19 +235,9 @@ class Micon::Core
 
   def deinitialize!
     Object.send(:remove_const, :MICON) if Object.const_defined?(:MICON)
-
-    # @loaded_classes.each do |class_name, tuple|
-    #   namespace, const = tuple
-    #   namespace.send(:remove_const, const)
-    # end
-    # @loaded_classes.clear
   end
 
-  #
-  # :mode, :runtime_path, used in component configuration
-  # - 'app/runtime'
-  # - :development, :test, :production
-  #
+  # `runtime_path` is used to search for component configurations, it may be `app/runtime` for example..
   def runtime_path; @runtime_path || raise(":runtime_path not defined!") end
   def runtime_path= runtime_path
     runtime_path, force = runtime_path
@@ -273,6 +246,9 @@ class Micon::Core
   end
   def runtime_path?; !!@runtime_path end
 
+  # `mode` used to search for component configuration, examples:
+  # - `app/runtime/logger.production.yml`
+  # - `app/runtime/production/logger.yml`
   def mode; @mode || raise(":mode not defined!") end
   def mode= mode
     mode, force = mode
@@ -301,23 +277,21 @@ class Micon::Core
         dependencies.each{|d| self[d]}
         @metadata.call_before key
 
-        # we need to check container first, in complex cases (circullar dependency)
+        # We need to check container first, in complex cases (circullar dependency)
         # the object already may be initialized.
         # See "should allow to use circullar dependency in :after callback".
         @stack[key] = true
         o = (container && container[key]) || initializer.call
 
-        unless config == false
-          unless config
-            # loading and caching config
-            config = get_config key
-            config = false unless config # we use false to differentiate from nil
-            @metadata.initializers[key] = [initializer, dependencies, config]
-
-            apply_config o, config if config
-          else
-            apply_config o, config
-          end
+        if config
+          apply_config o, config
+        elsif config != false
+          # Loading and caching config.
+          config = get_config key
+          config = false unless config # We use false to differentiate from nil.
+          @metadata.initializers[key] = [initializer, dependencies, config]
+
+          apply_config o, config if config
         end
 
         container[key] = o if container
@@ -336,40 +310,42 @@ class Micon::Core
     end
 
     def apply_config component, config
-      # config already have keys like "#{k}="
-      config.each{|k, v| component.send(k, v)}
+      if component.respond_to? :configure!
+        component.configure! config
+      else
+        config.each{|k, v| component.send("#{k}=", v)}
+      end
     end
 
+    # Module.name doesn't works correctly for Anonymous classes,
+    # try to execute this code:
+    #
+    #     class Module
+    #      def const_missing const
+    #        p self.to_s
+    #      end
+    #     end
+    #
+    #     class A
+    #       class << self
+    #         def a
+    #           p self
+    #           MissingConst
+    #         end
+    #       end
+    #     end
+    #
+    #     A.a
+    #
+    # The output will be:
+    #
+    #     A
+    #     "#<Class:A>"
     def name_hack namespace
       if namespace
         namespace.to_s.gsub("#<Class:", "").gsub(">", "")
       else
         ""
       end
-      # Namespace Hack description
-      # Module.name doesn't works correctly for Anonymous classes.
-      # try to execute this code:
-      #
-      #class Module
-      #  def const_missing const
-      #    p self.to_s
-      #  end
-      #end
-      #
-      #class A
-      #    class << self
-      #        def a
-      #            p self
-      #            MissingConst
-      #        end
-      #    end
-      #end
-      #
-      #A.a
-      #
-      # the output will be:
-      # A
-      # "#<Class:A>"
-      #
     end
 end

data/lib/micon/helper.rb

@@ -1,7 +1,4 @@
-#
-# Generates helper methods for Micon,
-# so you can use micon.config instead of micon[:config]
-#
+# Generates helper methods for Micon, so you can use micon.logger instead of micon[:logger]
 module Micon::Helper
   def method_missing m, *args, &block
     super if args.size > 1 or block

data/lib/micon/metadata.rb

@@ -1,6 +1,4 @@
-#
 # This class intentially made using "wired and not clear code", to provide better performance.
-#
 class Micon::Metadata
   attr_accessor :registry, :initializers, :before, :after
 
@@ -38,25 +36,13 @@ class Micon::Metadata
   alias_method :deep_clone, :clone
 
 
-  #
-  # Registry
-  #
-  def [] key
-    @registry[key]
-  end
-
-  # def []= key, value
-  #   @registry[key] = value
-  # end
+  # Registry.
 
-  def include? key
-    @registry.include? key
-  end
+  def [] key; @registry[key] end
+  def include? key; @registry.include? key end
 
+  # Callbacks.
 
-  #
-  # Callbacks
-  #
   def register_before key, &block
     raise "you should provide block!" unless block
     (@before[key] ||= []) << block
@@ -79,10 +65,8 @@ class Micon::Metadata
     end
   end
 
+  # Scope callbacks.
 
-  #
-  # Scope callbacks
-  #
   def register_before_scope key, &block
     raise "you should provide block!" unless block
     (@before_scope[key] ||= []) << block
@@ -111,22 +95,4 @@ class Micon::Metadata
     call_after_scope key, container
     result
   end
-
-
-  #
-  # Other
-  #
-  # def inspect
-  #   "Registry: " + self.registry.keys.inspect
-  # end
-
-  # def deep_clone
-  #   m = Metadata.new
-  #   m.registry = {}
-  #   registry.each do |k, v|
-  #     m.registry[k] = v
-  #   end
-  #   p m
-  #   m
-  # end
 end

data/lib/micon/module.rb

@@ -1,58 +1,13 @@
 Module.class_eval do
-  #
-  # inject attribute: :session
-  #
+  # Usage: `inject logger: :logger`.
   def inject attributes
     ::MICON.raise_without_self "Invalid argument!" unless attributes.is_a? Hash
     attributes.each do |name, specificator|
       ::MICON.raise_without_self "Attribute name should be a Symbol!" unless name.is_a? Symbol
 
-      if [Class, Module].include? specificator.class
-        specificator = specificator.name
-      elsif specificator.is_a? Symbol
-        specificator = ":#{specificator}"
-      else
-        specificator = "\"#{specificator}\""
-      end
-
-      script = <<-RUBY
-def #{name}
-  ::MICON[#{specificator}]
-end
-
-def #{name}= value
-  ::MICON[#{specificator}] = value
-end
-
-def #{name}?
-  ::MICON.include? #{specificator}
-end
-      RUBY
-
-      self.class_eval script, __FILE__, __LINE__
+      define_method(name){::MICON[specificator]}
+      define_method("#{name}="){|value| ::MICON[specificator] = value}
+      define_method("#{name}?"){::MICON.include? specificator}
     end
   end
-
-
-  #
-  # Hook to use Constants as Components
-  #
-#   if defined? ::ClassLoader
-#     text = <<-TEXT
-# It seems that ClassLoader already defined, but it supposed to be activated after the Micon, otherwise it can cause performance loss!
-# Micon.const_missing extension should be included before than ClassLoader.const_missing otherwise the Micon.const_missing will be
-# called (and will ping file system) for every loaded class!
-#     TEXT
-#     warn text
-#   end
-#
-#   alias_method :const_missing_without_micon, :const_missing
-#   protected :const_missing_without_micon
-#   def const_missing const
-#     if value = ::MICON.get_constant(self, const)
-#       value
-#     else
-#       const_missing_without_micon const
-#     end
-#   end
 end

data/spec/config_spec.rb

@@ -10,6 +10,16 @@ describe "Configuration" do
     end
   end
 
+  it "should allow to explicitly configure component if configure! method provided" do
+    logger = Object.new
+    logger.should_receive(:configure!).with(level: :info)
+    micon.register(:logger){logger}
+
+    with_load_path "#{spec_dir}/basic/lib" do
+      micon[:logger]
+    end
+  end
+
   it "should merge in order: conf <- conf.mode <- runtime <- runtime.mode" do
     micon.register(:object){::OpenStruct.new}
     with_load_path "#{spec_dir}/order/lib" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: micon
 version: !ruby/object:Gem::Version
-  version: 0.1.22
+  version: 0.1.23
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-24 00:00:00.000000000Z
+date: 2011-10-24 00:00:00.000000000Z
 dependencies: []
 description: 
 email: