bootinq 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2e3311d9fe2f906d1d620e0bff5fa4271d6aaf0
-  data.tar.gz: fa4bc277f3707743b340b53988252f425a6648c0
+  metadata.gz: a8647f4b798663b8511a3d2c7a9527b93756b9ca
+  data.tar.gz: 35bd6157a95de1bd4df9648896d08939401281cb
 SHA512:
-  metadata.gz: d047b517e113b611dbfc62ad58f8f4ac86aa96cd30a4ae7ac9d11a5ac1564911e35307e5d651f01f5401224b8a31e4ae48ef1e38a152f9b8144edc0a99e5414f
-  data.tar.gz: 4b09c5cff33cfc68c72dffeeea388673e4ab873283a34db963c9e73cbe6b818d3d1c3572253e6a040d00c44c964a38d7595b2a24e12b3a3bce7ba015b9369ebf
+  metadata.gz: 8cf0fc21e41449527782916a81a3dfb2749f6e9f91dda590d381a5b5dd15bc31c5d15b6216fdf1cb717424cd83a069b09a3fab213a657a041700ae313fe9a8df
+  data.tar.gz: add219d5df6e7a54aae76552de7be7f5509d79fdb51541399f3705f3c0f025de28b19b396374b842e92fd6ae96591bb2284b66acb75ceff8a3b500477d83f748

data/Gemfile

@@ -18,6 +18,7 @@ gem 'byebug', group: [:development, :test]
 
 group :development, :test do
   # You need these
+  gem "rspec"
   gem "rspec-rails"
   gem "pry"
 end

data/README.md

@@ -14,27 +14,122 @@ And then execute:
 
     $ bundle
 
-Insert `require "bootinq"` to the top of `config/application.rb` file.
 
-Find a `Bundler.require(*Rails.groups)` line below and replace it with the `Bootinq.require`.
+## Usage
+
+There are few steps to setup partial gem booting in a Rails application using Bootinq:
+
+### 1. Declare loadable parts
+
+The environment variable specifies which parts should be loaded using the assigned char keys. If the value is starts with `-`, all parts except the given will be loaded.
+
+For example, looking at the configuration below, if we want to load only `api`, we should set `BOOTINQ=a`. If we want to load the all except `frontend` and `admin`, we should set `BOOTINQ=-fz`.
 
-## Example `config/bootinq.yml`:
+The name of the environment variable can be customized by changing the `env_key:`
 
 ```yaml
+# config/bootinq.yml
 env_key: BOOTINQ
 default: "-f"
 
+# Non-mountable parts
 parts:
-  s: :shared
+  c: :console
 
+# Mountable parts (engines)
 mount:
   a: :api
-  f: :engine
+  f: :frontend
+  z: :admin
 ```
 
-## Usage
+### 2. Add gem groups
+
+For each app part you should add a gem group named as `#{group_name}_boot`:
+
+```ruby
+# Gemfile
+
+gem "api",      path: "apps/api",      group: :api_boot
+gem "admin",    path: "apps/admin",    group: :admin_boot
+gem "frontend", path: "apps/frontend", group: :frontend_boot
+
+group :console_boot do
+  gem 'term-ansicolor', '1.1.5'
+  gem 'pry-rails'
+end
+```
+
+### 3. Change config/application.rb
+
+Insert `require "bootinq"` to the top of `config/application.rb` file and replace `Bundler.require(*Rails.groups)` with the `Bootinq.require`:
+
+#### Simple
+
+```ruby
+# config/application.rb
+
+require File.expand_path('../boot', __FILE__)
+require 'rails/all'
+require 'bootinq'
 
-Using example `bootinq.yml` above, you can create `api_boot` group in your `Gemfile` and load gems from that only when flag `BOOTINQ=a` is set. The group can contain local `api` gem, which provides a mountable engine. Please, see `specs/dummy` for the example.
+# With no additional gem groups:
+Bootinq.require
+# otherwise, set them like in <tt>Bundle.require(*Rails.groups(*groups))</tt>:
+# Bootinq.require(:assets => %w(development test))
+
+puts "* Bootinq: loading components #{Bootinq.components * ', '}"
+```
+
+#### Separate load rails components with Bootinq
+
+```ruby
+# config/application.rb
+require File.expand_path('../boot', __FILE__)
+
+require "rails"
+# Pick the frameworks you want:
+require "active_model/railtie"
+require "active_record/railtie"
+require "active_job/railtie"
+require "action_mailer/railtie"
+require "rails/test_unit/railtie"
+
+Bootinq.require do
+  # Load the following components only when the frontend component is enabled
+  on :frontend do
+    require "sprockets/railtie"
+    require "action_controller/railtie"
+    require "action_view/railtie"
+  end
+end
+```
+
+### 4. Mount enabled engines in config/routes.rb
+
+Use the `Bootinq.each_mountable {}` helper to easily mount currently loaded engines or do it by yourself checking `Bootinq.enabled?(engine_name)` :
+
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+  Bootinq.each_mountable do |part|
+    mount part.engine => '/', as: part.to_sym
+  end
+
+  root 'frontend/pages#index' if Bootinq.enabled?(:frontend)
+end
+```
+
+### 5. Run app with only wanted parts
+
+Now, you can set environment variable to tell workers which part of app it should load.
+
+For example, with the [foreman](https://github.com/ddollar/foreman) in `Procfile`:
+
+```
+api:   env BOOTINQ=a MAX_THREADS=128 bundle exec puma -w 4
+admin: env BOOTINQ=z bundle exec puma
+```
 
 ## Development
 
@@ -45,4 +140,3 @@ 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/estum/bootinq.
-

data/bootinq.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Rails Boot Inquirer}
   spec.description   = %q{Allows to select which bundle groups to boot in the current rails process}
   spec.homepage      = "https://github.com/estum/bootinq"
+  spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
@@ -20,5 +21,4 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
 end

data/lib/bootinq/version.rb

@@ -1,3 +1,3 @@
 class Bootinq
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/bootinq.rb

@@ -81,17 +81,32 @@ class Bootinq
   end
 
   # Invokes <tt>Rails.groups</tt> method within enabled Bootinq's groups
-  def groups(*groups)
-    Rails.groups(*components.map(&:group), *groups)
+  def groups(*list)
+    Rails.groups(*components.map(&:group), *list)
+  end
+
+  # Yields the given block if any of given components is enabled.
+  #
+  # ==== Example:
+  #
+  #   Bootinq.on :frontend do
+  #     # make frontend thing...
+  #   end
+  def on(*names) # :yields:
+    if names.any? { |name| enabled?(name) }
+      yield
+    end
   end
 
   def_delegators "instance", *instance_methods(false)
 
   class << self
-    # The helper method to bootstrap the Bootinq. Sets the BOOTINQ_PATH enviroment variable
-    # and requires selected bundler groups.
-    def require(*groups)
+    # The helper method to bootstrap the Bootinq.
+    # Sets the BOOTINQ_PATH enviroment variable, yields optional block in
+    # the own instance's binding and, finally, requires selected bundler groups.
+    def require(*groups, &block) # :yields:
       ENV['BOOTINQ_PATH'] ||= File.expand_path('../bootinq.yml', caller_locations(1..1)[0].path)
+      instance.instance_exec(&block) if block_given?
       Bundler.require(*instance.groups(*groups))
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootinq
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Anton
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-01 00:00:00.000000000 Z
+date: 2015-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Allows to select which bundle groups to boot in the current rails process
 email:
 - anton.estum@gmail.com
@@ -74,7 +60,8 @@ files:
 - lib/bootinq/version.rb
 - lib/tasks/bootinq_tasks.rake
 homepage: https://github.com/estum/bootinq
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []