micon 0.1.7 → 0.1.8

data/Rakefile

@@ -2,7 +2,7 @@ require 'rake_ext'
 
 project(
   name: "micon",
-  version: "0.1.7",
+  gem: true,
   summary: "Assembles and Manages Components of Your Application",
 
   author: "Alexey Petrushin",

data/lib/micon.rb

@@ -1,3 +1,5 @@
+require 'yaml'
+
 module Micon
 end
 
@@ -5,6 +7,7 @@ end
   support
   
   metadata
+  config
   core
   helper
   

data/lib/micon/config.rb

@@ -0,0 +1,46 @@
+class Micon::Config    
+  attr_reader :micon, :name
+  def initialize micon, name
+    @micon, @name = micon, name
+  end
+  
+  def load        
+    files = []
+    files.push *config_paths.collect{|path| find_file(path, $LOAD_PATH)}
+    files.push *runtime_config_paths.collect{|path| find_file(path, [micon.runtime_path])} if micon.runtime_path?
+
+    config = {}
+    files.compact.each do |f|
+      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}
+    end
+
+    config.empty? ? nil : config
+  end
+  
+  protected
+    def config_paths
+      fs_name = name.to_s.gsub(/::/, '/')
+      paths = ["/components/#{fs_name}.yml"]
+      paths << "/components/#{fs_name}.#{micon.mode}.yml" if micon.mode?
+      paths
+    end
+
+    def runtime_config_paths
+      fs_name = name.to_s.gsub(/::/, '/')
+      paths = ["/config/#{fs_name}.yml"]
+      if micon.mode?
+        paths << "/config/#{fs_name}.#{micon.mode}.yml"
+        paths << "/config/#{micon.mode}/#{fs_name}.yml"
+      end
+      paths
+    end
+  
+    def find_file path, directories
+      files = directories.collect{|dir| "#{dir}#{path}"}.select{|f| File.exist? f}
+      raise "multiple configs for :#{name} component" if files.size > 1
+      files.first
+    end
+end

data/lib/micon/core.rb

@@ -107,66 +107,6 @@ class Micon::Core
     end
   end
   
-  # def get_constant_component key      
-  #   sname = @registry[key] || autoload_component_definition(key, false)
-  #   
-  #   case sname
-  #   when nil
-  #     nil        
-  #   when :instance        
-  #     must_be.never_called
-  #   when :application        
-  #     return nil unless @constants.include? key
-  #     
-  #     o = @application[key]          
-  #     unless o
-  #       return create_object(key, @application)
-  #     else
-  #       return o
-  #     end
-  #   else # custom        
-  #     must_be.never_called
-  #   end
-  # end
-  # 
-  # def get_constant namespace, const
-  #   original_namespace = namespace
-  #   namespace = nil if namespace == Object or namespace == Module
-  #   target_namespace = namespace
-  # 
-  #   # Name hack (for anonymous classes)
-  #   namespace = eval "#{name_hack(namespace)}" if namespace
-  # 
-  #   class_name = namespace ? "#{namespace.name}::#{const}" : const
-  # 
-  #   simple_also_tried = false
-  #   begin
-  #     simple_also_tried = (namespace == nil)
-  # 
-  #     if result = get_constant_component(class_name.to_sym)
-  #       if @loaded_classes.include?(class_name)
-  #         raise_without_self "something wrong is goin on, constant '#{const}' in '#{original_namespace}' namespace already has been defined!"
-  #       end
-  #     
-  #       real_namespace = namespace ? namespace : Object
-  #       if real_namespace.const_defined?(const)
-  #         raise_without_self "component trying to redefine constant '#{const}' that already defined in '#{real_namespace}'!"
-  #       end
-  #       
-  #       real_namespace.const_set const, result
-  #   
-  #       @loaded_classes[class_name] = [real_namespace, const]
-  # 
-  #       return result
-  #     elsif namespace
-  #       namespace = Module.namespace_for(namespace.name)
-  #       class_name = namespace ? "#{namespace.name}::#{const}" : const
-  #     end
-  #   end until simple_also_tried
-  #   
-  #   return nil
-  # end
-
   def []= key, value
     raise "can't assign nill as :#{key} component!" unless value
   
@@ -296,6 +236,7 @@ class Micon::Core
       # I intentially broke the Metadata incapsulation to provide better performance, don't refactor it.
       @registry = {} # @loaded_classes, @constants = {}, {}
       @metadata = Micon::Metadata.new(@registry)
+      @stack = {}
     
       @application, @custom_scopes = {}, {}
       
@@ -319,59 +260,85 @@ class Micon::Core
     # @loaded_classes.clear
   end
     
+  # 
+  # :mode, :runtime_path, used in component configuration
+  # - 'app/runtime'
+  # - :development, :test, :production
+  # 
+  def runtime_path; @runtime_path || raise(":runtime_path not defined!") end
+  def runtime_path= runtime_path
+    runtime_path, force = runtime_path
+    raise "some components has been already initialized before You set :runtime_path!" unless empty? or force
+    @runtime_path = runtime_path
+  end
+  def runtime_path?; !!@runtime_path end
+    
+  def mode; @mode || raise(":mode not defined!") end
+  def mode= mode        
+    mode, force = mode    
+    raise "some components has been already initialized before You set :mode!" unless empty? or force
+    @mode = mode
+  end
+  def mode?; !!@mode end
+  
   protected    
     def autoload_component_definition key, bang = true
       begin
         load "components/#{key.to_s.gsub(/::/, '/')}.rb"
       rescue LoadError
-      end
+      end      
       sname = @registry[key]
       raise_without_self "'#{key}' component not managed!" if bang and !sname
       sname
     end
 
     def create_object key, container = nil        
-      initializer, dependencies = @metadata.initializers[key]
+      initializer, dependencies, config = @metadata.initializers[key]
       raise "no initializer for :#{key} component!" unless initializer
-    
-      dependencies.each{|d| self[d]}
-      @metadata.call_before key 
-    
-      if container
-        unless o = container[key]            
-          o = initializer.call                      
-          container[key] = o 
-        else
-          # complex case, there's an circular dependency, and the 'o' already has been 
-          # initialized in dependecies or callbacks
-          # here's the sample case:
-          # 
-          # app.register :environment, :application do
-          #   p :environment
-          #   'environment'
-          # end
-          # 
-          # app.register :conveyors, :application, depends_on: :environment do
-          #   p :conveyors
-          #   'conveyors'
-          # end
-          # 
-          # app.after :environment do
-          #   app[:conveyors]
-          # end
-          # 
-          # app[:conveyors]            
-                    
-          o = container[key]
+      
+      raise "component :#{key} used before it's initialization is finished!" if @stack.include? key      
+      begin
+        dependencies.each{|d| self[d]}
+        @metadata.call_before key 
+
+        # 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                    
         end
-      else
-        o = initializer.call
+        
+        container[key] = o if container
+        
+        raise "initializer for component :#{key} returns nill!" unless o
+      ensure
+        @stack.delete key
       end
-      raise "initializer for component :#{key} returns nill!" unless o
-            
+          
       @metadata.call_after key, o
-      o
-    end  
+      o      
+    end
+    
+    def get_config key
+      ::Micon::Config.new(self, key).load
+    end
+    
+    def apply_config component, config
+      # config already have keys like "#{k}="
+      config.each{|k, v| component.send(k, v)}
+    end
     
     def name_hack namespace
       if namespace

data/readme.md

@@ -6,6 +6,8 @@ Concentrate on business logic and interfaces and Micon will provide automatic co
 
 Technically it's [IoC][ioc] like framework with components, callbacks, scopes and bijections, inspired by Spring and JBoss Seam.
 
+Is it usefull, is there any real-life application? - I'm using it as a heart of my [web framework][rad_core], this site http://ruby-lang.info for example powered with it.
+
 ## Usage
 	
 Let's suppose you are building the Ruby on Rails clone, there are lots of modules let's try to deal with them
@@ -89,4 +91,5 @@ there's no multithreading in ruby.
 
 Copyright (c) Alexey Petrushin [http://4ire.net](http://4ire.net), released under the MIT license.
 
-[ioc]: http://en.wikipedia.org/wiki/Inversion_of_control
+[ioc]: http://en.wikipedia.org/wiki/Inversion_of_control
+[rad_core]: https://github.com/alexeypetrushin/rad_core

data/spec/config_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe "Configuration" do    
+  before{self.micon = Micon::Core.new}
+  
+  it "should configure component if config provided" do
+    micon.register(:logger){OpenStruct.new}    
+    with_load_path "#{spec_dir}/basic/lib" do      
+      micon[:logger].level.should == :info
+    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    
+      micon.runtime_path = "#{spec_dir}/order/app"
+      micon.mode = :production
+      micon[:object].tap do |o|
+        o.a.should == 'object.production.yml'
+        o.b.should == 'runtime.object.yml'
+        o.c.should == 'runtime.object.production.yml'
+      end
+    end
+  end
+end

data/spec/config_spec/basic/lib/components/logger.yml

@@ -0,0 +1 @@
+level: :info

data/spec/config_spec/order/app/config/object.production.yml

@@ -0,0 +1 @@
+c: 'runtime.object.production.yml'

data/spec/config_spec/order/app/config/object.yml

@@ -0,0 +1,2 @@
+b: 'runtime.object.yml'
+c: 'runtime.object.yml'

data/spec/config_spec/order/lib/components/object.production.yml

@@ -0,0 +1,3 @@
+a: 'object.production.yml'
+b: 'object.production.yml'
+c: 'object.production.yml'

data/spec/config_spec/order/lib/components/object.yml

@@ -0,0 +1,3 @@
+a: 'object.yml'
+b: 'object.yml'
+c: 'object.yml'

data/spec/micelaneous_spec.rb

@@ -3,13 +3,8 @@ require 'spec_helper'
 describe "Micelaneous" do
   with_load_path "#{spec_dir}/autoload/lib"    
   
-  before do
-    self.micon = Micon::Core.new
-  end
-  
-  after do
-    remove_constants :TheRouter, :TheRad
-  end
+  before{self.micon = Micon::Core.new}  
+  after{remove_constants :TheRouter, :TheRad}
   
   describe "autoloading" do  
     it "should autoload component definition" do
@@ -22,27 +17,57 @@ describe "Micelaneous" do
     #   TheRad::TheView.should == "TheView"
     # end
   end
-
-  it "should not initialize twice (from error)" do
-    check = mock
-    check.should_receive(:environment).once.ordered
-    check.should_receive(:router).once.ordered
+  
+  describe "complex circullar dependencies" do        
+    it "should not initialize twice (from error)" do
+      micon.register :kit do
+        micon[:kit]
+        'kit'
+      end
+      lambda{micon[:kit]}.should raise_error(/component :kit used before it's initialization is finished/)
+    end
     
-    micon.register :environment do
-      check.environment
-      'environment'
+    it "should not initialize twice if called from dependency (from error)" do
+      micon.register :environment do
+        micon[:router]
+        'environment'
+      end
+
+      micon.register :router, depends_on: :environment do
+        'router'
+      end
+
+      -> {micon[:router]}.should raise_error(/component .* used before it's initialization is finished/)
     end
     
-    micon.register :router, depends_on: :environment do
-      check.router
-      'router'
+    it "should allow to use circullar dependency in :after callback" do
+      check = mock
+      check.should_receive(:initialized).once
+      micon.register :kit do
+        check.initialized
+        'kit'
+      end
+      micon.after :kit do
+        micon[:kit]
+      end
+      micon[:kit].should == 'kit'
     end
-    micon.after :environment do
-      # some code that needs :router
-      micon[:router]
-    end    
     
-    micon[:router]
+    it "should allow circullar dependencies in :after callback" do
+      micon.register :environment do
+        'environment'
+      end
+    
+      micon.register :router, depends_on: :environment do
+        'router'
+      end
+    
+      micon.after :environment do
+        micon[:router]
+      end
+    
+      micon[:router]                  
+    end
   end  
   
   it "helper method generation" do

data/spec/static_scope_spec.rb

@@ -1,13 +1,11 @@
 require 'spec_helper'
 
 describe "Application and Instance scopes" do  
-  before do
-    self.micon = Micon::Core.new
-  end
+  before{self.micon = Micon::Core.new}
   
   it "dependencies" do        
     micon.register(:another_object, depends_on: :the_object){"another_object"}
-    -> {micon[:another_object]}.should raise_error(/the_object/)
+    -> {micon[:another_object]}.should raise_error(/the_object.*not managed/)
     micon.register(:the_object){"the_object"}
     micon[:another_object]
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: micon
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-06-17 00:00:00.000000000 +04:00
+date: 2011-07-04 00:00:00.000000000 +04:00
 default_executable: 
 dependencies: []
 description: 
@@ -21,6 +21,7 @@ files:
 - Rakefile
 - readme.md
 - lib/micon/class.rb
+- lib/micon/config.rb
 - lib/micon/core.rb
 - lib/micon/helper.rb
 - lib/micon/metadata.rb
@@ -30,6 +31,12 @@ files:
 - lib/micon/support.rb
 - lib/micon.rb
 - spec/callbacks_spec.rb
+- spec/config_spec/basic/lib/components/logger.yml
+- spec/config_spec/order/app/config/object.production.yml
+- spec/config_spec/order/app/config/object.yml
+- spec/config_spec/order/lib/components/object.production.yml
+- spec/config_spec/order/lib/components/object.yml
+- spec/config_spec.rb
 - spec/constants_spec/get_constant_component/lib/components/TheController.rb
 - spec/constants_spec.rb
 - spec/custom_scope_spec.rb