micon 0.1.20 → 0.1.21

data/Rakefile

@@ -3,7 +3,7 @@ require 'rake_ext'
 project(
   name: "micon",
   gem: true,
-  summary: "Silent and invisible Killer of dependencies and configs",
+  summary: "Silent killer of dependencies and configs",
 
   author: "Alexey Petrushin",
   homepage: "http://github.com/alexeypetrushin/micon"

data/lib/micon/core.rb

@@ -244,7 +244,7 @@ class Micon::Core
     end
 
     # Micon::Core is independent itself and there can be multiple Cores simultaneously.
-    # But some of it's extensions can work only with one global instance, and them need to know how to get it,
+    # But some of its extensions can work only with one global instance, and them need to know how to get it,
     # the MICON constant references this global instance.
     Object.send(:remove_const, :MICON) if Object.const_defined?(:MICON)
     Object.const_set :MICON, self
@@ -296,7 +296,7 @@ class Micon::Core
       initializer, dependencies, config = @metadata.initializers[key]
       raise "no initializer for :#{key} component!" unless initializer
 
-      raise "component :#{key} used before it's initialization is finished!" if @stack.include? key
+      raise "component :#{key} used before its initialization is finished!" if @stack.include? key
       begin
         dependencies.each{|d| self[d]}
         @metadata.call_before key

data/lib/micon/support.rb

@@ -13,19 +13,4 @@ class Hash
       r
     end
   end
-end
-
-# class Module
-#   unless respond_to? :namespace_for
-#     # TODO3 cache it?
-#     def self.namespace_for class_name
-#       list = class_name.split("::")
-#       if list.size > 1
-#         list.pop
-#         return eval(list.join("::"), TOPLEVEL_BINDING, __FILE__, __LINE__)
-#       else
-#         return nil
-#       end
-#     end
-#   end
-# end
+end

data/readme.md

@@ -1,6 +1,6 @@
-# Micon - silent and invisible Killer of dependencies and configs
+# Micon - silent killer of dependencies and configs
 
-Micon allows You easilly and transparently eliminate dependencies and configs in Your Application. Usually, when You are building complex system there are following tasks should be solved:
+Micon allows You easilly and transparently eliminate dependencies and configs. Usually, when You are building complex system there are following tasks should be solved:
 
 - where the component's code is located
 - in what order should it be loaded
@@ -18,23 +18,22 @@ Micon allows You easilly and transparently eliminate dependencies and configs in
 
 Micon **solves all these tasks automatically**, and has the following **price** - You has to:
 
-- use the *register component_name, &initialization_block* method for component initialization
-- use the *inject component_name* to whire components toghether
-- place component definition to the lib/components folder
+- use the *register(component_name, &initialization_block)* method for component initialization
+- use the *inject(component_name)* to whire components toghether
+- place component definitions to the "lib/components" folder
 
 That's all the price, not a big one, compared to the value, eh? 
 That all You need to know to use 95% of it, there are also 2-3 more specific methods, but they are needed very rarelly.
 
-Techincally Micon is sort of Dependency Injector, but because of it's simplicity and invisibility it looks like an alien compared to it's complex and bloated IoC / DI cousins.
+Techincally Micon is sort of Dependency Injector, but because of its simplicity and invisibility it looks like an alien compared to its complex and bloated IoC / DI cousins.
 
 ## Basic example
 
 ``` ruby
 require 'micon'
-# standard ruby logger
-require 'logger' 
+require 'logger' # standard ruby logger
 
-micon.register(:logger){Logger.new}
+micon.register(:logger){Logger.new STDOUT}
 
 class Application
   inject logger: :logger
@@ -44,21 +43,28 @@ class Application
   end
 end
 
-Application.new.run             # => running ...
+Application.new.run
+# You should see something like this in the console:
+# [2011-08-16T19:09:05.921238 #24944]  INFO -- : running ...
 ```
 
 Code in examples/basics.rb
 
-## Advanced example: let's build the Ultima - an Ultimate Web Framework
+## Advanced example: let's build Web Framework
 
 This example is more complicated and requires about 3-7 minutes. 
 
-Let's pretend that we are building an Ultimate Framework, the RoR Killer. There will be lot's of modules and dependencies, let's see how Micon can eliminate them.
-There will be two steps, at the first we'll build it as usual, and at the second refactor it using Micon.
+Let's pretend that we are building an Ultimate Framework, the RoR Killer. There will be lot's of modules and dependencies, let's see how Micon can eliminate them. There will be only two components: router, request.
+Let's build it in two steps, at the first we'll build it as usual, and at the second refactor it using Micon.
 
-There will be following components: router, request.
+First step, building our framework **without Micon**.
 
 ``` ruby
+# setting load paths
+dir = File.dirname __FILE__
+$LOAD_PATH << "#{dir}/lib"
+
+
 # Assembling Ultima Framework
 module Ultima
   class << self
@@ -76,14 +82,17 @@ module Ultima
   end
 end
 
+# reading application config
 require 'yaml'
 Ultima.config = YAML.load_file "#{dir}/config/config.yml"
 
+# initializing router
 require 'router'
 router = Router.new
 router.url_root = Ultima.config['url_root']
 Ultima.router = router
 
+# loading request and controller
 require 'request'
 require 'controller'
 
@@ -102,7 +111,7 @@ Ultima.run '/index'
 
 Code in examples/ultima1/run.rb
 
-Below are the same example but done with Micon. As You can see there's no any assembling or configuration code, because all the components are auto-discovered, auto-loaded and auto-configured.
+Below are the same example but refactored **with using Micon**. As You can see there's no any assembling or configuration code, because all the components are auto-discovered, auto-loaded and auto-configured.
 
 ``` ruby
 # Assembling Ultima Framework

data/spec/miscellaneous_spec.rb

@@ -24,7 +24,7 @@ describe "Miscellaneous" do
         micon[:kit]
         'kit'
       end
-      lambda{micon[:kit]}.should raise_error(/component :kit used before it's initialization is finished/)
+      lambda{micon[:kit]}.should raise_error(/component :kit used before its initialization is finished/)
     end
 
     it "should not initialize twice if called from dependency (from error)" do
@@ -37,7 +37,7 @@ describe "Miscellaneous" do
         'router'
       end
 
-      -> {micon[:router]}.should raise_error(/component .* used before it's initialization is finished/)
+      -> {micon[:router]}.should raise_error(/component .* used before its initialization is finished/)
     end
 
     it "should allow to use circullar dependency in :after callback" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: micon
 version: !ruby/object:Gem::Version
-  version: 0.1.20
+  version: 0.1.21
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-16 00:00:00.000000000Z
+date: 2011-09-22 00:00:00.000000000Z
 dependencies: []
 description: 
 email: 
@@ -70,5 +70,5 @@ rubyforge_project:
 rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: Silent and invisible Killer of dependencies and configs
+summary: Silent killer of dependencies and configs
 test_files: []