bootinq 0.2.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a2e3311d9fe2f906d1d620e0bff5fa4271d6aaf0
-  data.tar.gz: fa4bc277f3707743b340b53988252f425a6648c0
+SHA256:
+  metadata.gz: f503e7ad103931ee10ce325a3590e3b7742f128a6947a37f59a1566ec57ceaed
+  data.tar.gz: 750b19a788035d9325cff83342cc67e2aac08b9ef4e892637eee07121a73b7b4
 SHA512:
-  metadata.gz: d047b517e113b611dbfc62ad58f8f4ac86aa96cd30a4ae7ac9d11a5ac1564911e35307e5d651f01f5401224b8a31e4ae48ef1e38a152f9b8144edc0a99e5414f
-  data.tar.gz: 4b09c5cff33cfc68c72dffeeea388673e4ab873283a34db963c9e73cbe6b818d3d1c3572253e6a040d00c44c964a38d7595b2a24e12b3a3bce7ba015b9369ebf
+  metadata.gz: f2878d2f0977783d2d586baa923bbc80945a2495120b522a5c198fd0c493c21f9b7ab4f591799b4f041130cfb62e3747f9287683d23db0bbccf92a64716fac49
+  data.tar.gz: 15eac28f64c7777dcafefb756d4a6e3644d22561c673bada3e5d6ff7187283d7596a8c62aae2e1933cab49e1f44531570a99c32e37b1db5a69e4fda4cf66eb34

data/.gitignore

@@ -13,4 +13,5 @@
 /spec/dummy/log/*.log
 /spec/dummy/tmp/
 /spec/dummy/.sass-cache
-.rake_t_cache
+.rake_t_cache
+.ruby-version

data/Gemfile

@@ -10,7 +10,7 @@ gemspec
 # Git. Remember to move these dependencies to your gemspec before releasing
 # your gem to rubygems.org.
 
-gem 'rails', '~> 4.2'
+gem 'rails', '>= 5.0'
 gem 'sqlite3'
 
 # To use a debugger
@@ -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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Anton
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

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,13 +12,13 @@ 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"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
 end

data/lib/bootinq.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
+
 require "yaml"
-require "erb"
 require "singleton"
 require "forwardable"
 require "bootinq/component"
@@ -25,78 +26,180 @@ require "bootinq/component"
 #       a: :api
 #       f: :engine
 class Bootinq
-  NEG     = '-'.freeze
+  extend SingleForwardable
+  include Singleton
+
   DEFAULT = {
     "env_key" => 'BOOTINQ',
     "default" => '',
     "parts"   => {},
     "mount"   => {}
-  }
+  }.freeze
 
-  attr_reader :flags, :components
+  # The helper method to bootstrap the Bootinq.
+  # Sets the BOOTINQ_PATH enviroment variable, invokes <tt>Bootinq.setup</tt> method
+  # with given verbose argument & block, and, finally, gets Bundler to require the given groups.
+  def self.require(*groups, verbose: false, &block) # :yields: Bootinq.instance
+    ENV['BOOTINQ_PATH'] ||= File.expand_path('../bootinq.yml', caller_locations(1..1)[0].path)
 
-  include Singleton
-  extend SingleForwardable
+    setup(verbose: verbose, &block)
 
-  def initialize
-    config = YAML.load(File.read(ENV['BOOTINQ_PATH']))
-    config.reject! { |_, v| v.nil? }
-    config.reverse_merge!(DEFAULT)
+    Bundler.require(*instance.groups(*groups))
+  end
 
-    config['parts'].merge!(config['mount'])
+  # :call-seq:
+  #   Bootinq.setup(verbose: true, &block) -> true or false
+  #
+  # Initializes itself. When verbose: true
+  # Yields optional block in the own instance's binding and,
+  def self.setup(verbose: false, &block) # :yields: Bootinq.instance
+    instance
+    puts "Bootinq: loading components #{instance.components.join(', ')}" if verbose
+    instance.instance_exec(&block) if block_given?
+    instance
+  end
 
-    value = ENV[config['env_key']] || config['default'].to_s
-    neg   = value.start_with?(NEG)
+  attr_reader :flags, :components
 
-    flags = []
-    parts = []
+  def initialize # :no-doc:
+    config_path = ENV.fetch('BOOTINQ_PATH')
+    config = YAML.safe_load(File.read(config_path), [Symbol])
+    config.merge!(DEFAULT) { |_, l, r| l.nil? ? r : l }
 
-    config['parts'].each do |flag, name|
-      if neg ^ value[flag]
-        flags << flag
-        parts << Component.new(name, mountable: config['mount'].key?(flag))
-      end
-    end
+    @_value     = ENV.fetch(config['env_key']) { config['default'] }
+    @_neg       = @_value.start_with?(?-, ?^)
+    @flags      = []
+    @components = []
 
-    @_value     = value.freeze
-    @_neg       = neg.freeze
-    @flags      = flags.freeze
-    @components = parts.freeze
+    config['parts'].each { |flag, name| enable_component(name, flag: flag) }
+    config['mount'].each { |flag, name| enable_component(name, flag: flag, as: Mountable) }
   end
 
-  # Checks if a given gem (i.e. a gem group) is enabled
-  def enabled?(gem_name)
-    components.include?(gem_name)
+  # :call-seq:
+  #   Bootinq.enable_component(name, flag: [, as: Component])
+  #
+  def enable_component(name, flag:, as: Component)
+    if @_neg ^ @_value.include?(flag)
+      @flags      << flag
+      @components << as.new(name)
+    end
   end
 
+  # :call-seq:
+  #   Bootinq.enabled?(name) -> true or false
+  #
+  # Checks if a component with the given name (i.e. the same gem group)
+  # is enabled
+  def enabled?(name)
+    components.include?(name)
+  end
+
+  # :call-seq:
+  #   Bootinq.component(name) -> Bootinq::Component
+  #   Bootinq[name] -> Bootinq::Component
+  #
   # Returns a <tt>Bootinq::Component</tt> object by its name
-  def component(key)
-    components[components.index(key)]
+  def component(name)
+    components[components.index(name)]
   end
 
-  # Enums each mountable component
-  def each_mountable
-    return to_enum(__method__) unless block_given?
-    components.each { |c| yield(c) if c.mountable? }
+  alias :[] :component
+
+
+  # :call-seq:
+  #   Bootinq.each_mountable { |part| block } -> Array
+  #   Bootinq.each_mountable -> Enumerator
+  #
+  # Calls the given block once for each enabled mountable component
+  # passing that part as a parameter. Returns the array of all mountable components.
+  #
+  # If no block is given, an Enumerator is returned.
+  def each_mountable(&block) # :yields: part
+    components.select(&:mountable?).each(&block)
   end
 
+  # :call-seq:
+  #   Bootinq.groups(*groups)
+  #
   # Invokes <tt>Rails.groups</tt> method within enabled Bootinq's groups
   def groups(*groups)
     Rails.groups(*components.map(&:group), *groups)
   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)
-      ENV['BOOTINQ_PATH'] ||= File.expand_path('../bootinq.yml', caller_locations(1..1)[0].path)
-      Bundler.require(*instance.groups(*groups))
+  # :call-seq:
+  #   Bootinq.on(name) { block } -> true or false
+  #   Bootinq.on(any: [names]) { block } -> true or false
+  #   Bootinq.on(all: [names]) { block } -> true or false
+  #
+  # Takes a component's name or single-key options hash as an argument and
+  # yields a given block if the target components are enabled.
+  #
+  # See examples for a usage.
+  #
+  # ==== Example:
+  #
+  #   Bootinq.on :frontend do
+  #     # make frontend thing...
+  #   end
+  #
+  #   Bootinq.on any: %i(frontend backend) do
+  #     # do something when frontend or backend is enabled
+  #   end
+  #
+  #   Bootinq.on all: %i(frontend backend) do
+  #     # do something when frontend and backend are enabled
+  #   end
+  def on(name = nil, any: nil, all: nil) # :yields:
+    if name.nil? && any.nil? && all.nil?
+      raise ArgumentError, "wrong arguments (given 0, expected 1)"
+    elsif (any && all) || (name && (any || all))
+      raise ArgumentError, "expected single argument or one of keywords: `all' or `any'"
     end
 
-    private def new
-      super.freeze
-    end
+    is_matched =
+      name ? enabled?(name) :
+      any  ? on_any(*any) :
+      all  ? on_all(*all) : false
+    yield if is_matched
+    is_matched
+  end
+
+  # :call-seq:
+  #   Bootinq.on_all(*names) { block } -> true or false
+  #
+  # Takes a list of component names and yields a given block (optionally)
+  # if all of them are enabled. Returns boolean matching status.
+  def on_all(*parts) # :yields:
+    is_matched = parts.all? { |p| enabled?(p) }
+    yield if is_matched && block_given?
+    is_matched
+  end
+
+  # :call-seq:
+  #   Bootinq.on_all(*names) { block } -> true or false
+  #
+  # Takes a list of component names and yields a given block  (optionally)
+  # if any of them are enabled. Returns boolean matching status.
+  def on_any(*parts) # :yields:
+    is_matched = parts.any? { |p| enabled?(p) }
+    yield if is_matched && block_given?
+    is_matched
   end
+
+  # Freezes every instance variables and the instance itself.
+  def freeze
+    @_value.freeze
+    @_neg.freeze
+    @flags.freeze
+    @components.freeze
+    super
+  end
+
+  def_delegators "instance", *instance_methods(false)
+
+  def self.new # :no-doc:
+    super.freeze
+  end
+
+  private_class_method :new
 end

data/lib/bootinq/component.rb

@@ -1,20 +1,62 @@
+# frozen_string_literal: true
+
 class Bootinq
-  class Component < DelegateClass(Symbol)
-    attr_reader :gem_name, :mountable, :namespace, :group
-    alias :to_s :gem_name
-    alias :mountable? :mountable
-
-    def initialize(name, mountable: false)
-      super(name)
-      @gem_name  = name.to_s.freeze
-      @mountable = !!mountable
-      @group     = :"#{gem_name}_boot"
-      @namespace = :"#{gem_name.camelcase}" if mountable?
+  class Component
+    attr_reader :intern, :id2name, :group
+
+    alias :to_sym   :intern
+    alias :to_s     :id2name
+    alias :gem_name :id2name
+    alias :name     :id2name
+
+    def initialize(intern)
+      @intern  = intern.to_sym
+      @id2name = intern.to_s.freeze
+      @group   = :"#@id2name\_boot"
       freeze
     end
 
+    def mountable?
+      false
+    end
+
+    def == other
+      case other
+      when String then other == @id2name
+      when Symbol then other == @intern
+                  else super
+      end
+    end
+
+    def inspect
+      @intern.inspect
+    end
+
+    def engine
+    end
+
+    def module_name
+      @id2name.camelcase.to_sym
+    end
+
+    def respond_to_missing?(method_name, include_all=false)
+      @intern.respond_to?(method_name, include_all)
+    end
+
+    private
+
+    def method_missing(method_name, *args, &blk)
+      @intern.respond_to?(method_name) ? @intern.public_send(method_name, *args, &blk) : super
+    end
+  end
+
+  class Mountable < Component
+    def mountable?
+      true
+    end
+
     def engine
-      Object.const_get(@namespace)::Engine
+      Object.const_get(module_name)::Engine
     end
   end
 end

data/lib/bootinq/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Bootinq
-  VERSION = "0.2.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,45 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: bootinq
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Anton
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-01 00:00:00.000000000 Z
+date: 2020-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -63,6 +49,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
@@ -72,9 +59,9 @@ files:
 - lib/bootinq.yml
 - lib/bootinq/component.rb
 - lib/bootinq/version.rb
-- lib/tasks/bootinq_tasks.rake
 homepage: https://github.com/estum/bootinq
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -92,9 +79,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Rails Boot Inquirer
 test_files: []
-has_rdoc: 

data/lib/tasks/bootinq_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :bootinq do
-#   # Task goes here
-# end