component-framework 0.1.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8280c1c50490cce661848221f17155e2f681968
-  data.tar.gz: 945c3f11a3362c8c5db692b52e2fff5b96537706
+  metadata.gz: da855042888484421b1f621360157021aa99ee01
+  data.tar.gz: aa093726bcb6d8fcf6d038d090c8ea0bacd145ce
 SHA512:
-  metadata.gz: cf0d288fbb1a42bdc06ee84173c192638e5f85cef2382f4ee0fc570dd2d3b9d5c2d4ed5d02057e6292371d0bfc631b8b256f80ddb2dc0264de23f638d2ed29a4
-  data.tar.gz: dac7a1cef4c8ddc3b7dbe021224ea17edc719c028f59bd3aa74113cd75175a8cf0bca1316813857b3b8c0f3f1f849e9c9976cae7af7f7b4cfb9dbac452f4dca3
+  metadata.gz: 3882972a53ca9222608d836ca07a6eecf77cca425435f65ca3dbce947a90d1603e5126a71d1183fcfca402c924a31a2f507855730d2799b8149f6fcd627d4157
+  data.tar.gz: 35caf9b3402ed1da0bff8a07efd4a2801491117fe2fe96b88a7369dbc967374ad84258d33a8655cf2a62987781992434cb9e129cb24d121be069d27b88ee950e

data/README.md

@@ -32,9 +32,20 @@ module My
     ...
   end
 
-  Component::Framework.initialize(YourApplication)
+  Component::Framework.initialize(My::Application)
+  
+end
 ```
 
+to get the components initialization output specify `verbose: true` parameter in framework initialization call
+
+in case you don't use Sprockets assets pipeline, you can explicitly disable it's configuration by specifying 
+`assets_pipeline: false` in framework initialization call
+
+e.g.
+`Component::Framework.initialize(My::Application, assets_pipeline: false, verbose: true)`
+
+
 ### Conventions
 
 
@@ -83,7 +94,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/component-framework. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/brokermint/component-framework. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/lib/component/framework.rb

@@ -10,11 +10,19 @@ module Component
     end
 
 
+    # Components root folder path
+    #
+    # @return [string] Components root folder path
     def self.components_base_dir
       @base_dir ||= Rails.root.join("components")
     end
 
 
+    # Initialize Component Framework
+    #
+    # @param application [Rails::Application] the application class
+    # @param assets_pipeline [bool] specifies whether Sprockets asset_pipeline should be configured for components
+    # @param verbose [bool] allows to show components initialization log, default `false`
     def self.initialize(application, assets_pipeline: true, verbose: false)
       @verbose = verbose
 
@@ -42,15 +50,27 @@ module Component
         _initialize_assets_pipeline(application)
       end
 
-      # Initialize components after all initialization finished.
-      application.config.after_initialize do |app|
+      # Initialize components
+      #
+      # Initialization happen in 2 steps to allow components to perform actions upon initialized components.
+      # First cycle is a part of Rails initialization, so it's possible to configure Rails env in it
+      # like registering middleware etc.
+      application.initializer :initialize_components, group: :all do |app|
 
-        log("Load Components Initializers")
-        _load_components_initializers
+        Component::Framework.log("Load Components Initializers")
+        Component::Framework._load_components_initializers
 
-        components = get_component_modules
-        log("Initialize Components")
+        components = Component::Framework.get_component_modules
+        Component::Framework.log("Initialize Components")
         components.each {|component| component.send("init") if component.respond_to?("init") }
+      end
+
+      # Post initialization of components
+      # when all the other parts are ready to be referenced
+      #
+      # A place to register subscribers as well as call other component's services.
+      application.config.after_initialize do |app|
+        components = get_component_modules
 
         log("Post-Initialize Components")
         components.each {|component| component.send("ready") if component.respond_to?("ready") }
@@ -61,18 +81,27 @@ module Component
       log("Configuration Finished")
     end
 
-
+    # List of component names
+    #
+    # @return [Array<string>] List of component names
     def self.get_component_names
       Dir.entries(components_base_dir)
           .select { |entry| (entry !="." && entry != "..") and File.directory? components_base_dir.join(entry) }
     end
 
 
+    # List of component root modules
+    #
+    # @return [Array<Object>] List of component root modules
     def self.get_component_modules
       get_component_names.map { |name| component_module_by_name(name) }
     end
 
 
+    # Get the component root module by component name
+    #
+    # @param name [string] the component name
+    # @return [Object] Component root module
     def self.component_module_by_name(name)
       return name.camelize.constantize
     rescue NameError, ArgumentError

data/lib/component/framework/version.rb

@@ -1,5 +1,5 @@
 module Component
   module Framework
-    VERSION = "0.1.2"
+    VERSION = "0.2.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: component-framework
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Alexander Yegorov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-06 00:00:00.000000000 Z
+date: 2018-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler