bootinq 1.1.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f503e7ad103931ee10ce325a3590e3b7742f128a6947a37f59a1566ec57ceaed
-  data.tar.gz: 750b19a788035d9325cff83342cc67e2aac08b9ef4e892637eee07121a73b7b4
+  metadata.gz: 24d33e5b4116c1406447099627f69b28099408be01a35b8addb8870c70b1d526
+  data.tar.gz: ab43719f9bb45caadff14a577a23449157e1fa24e35301301a59d903947bb199
 SHA512:
-  metadata.gz: f2878d2f0977783d2d586baa923bbc80945a2495120b522a5c198fd0c493c21f9b7ab4f591799b4f041130cfb62e3747f9287683d23db0bbccf92a64716fac49
-  data.tar.gz: 15eac28f64c7777dcafefb756d4a6e3644d22561c673bada3e5d6ff7187283d7596a8c62aae2e1933cab49e1f44531570a99c32e37b1db5a69e4fda4cf66eb34
+  metadata.gz: 1a145181cdbd31411d4b6208cf84a418adb74ea1594d9d76fe10aab41af3e1e52a3bd97be211ef4e946d2f5285a6462ed3fd058d5d139cd8f95216fd3644c052
+  data.tar.gz: 8ec205d218a4a262b8c45070b3e0141d0e5b13c97b2749a79f48def1a4836625b0615c672e9de992d1c8cba16965e5b90490672bb396ffbfc99bc65e85d2f97e

data/README.md

@@ -15,9 +15,9 @@ And then execute:
     $ bundle
 
 
-## Usage
+## Get started
 
-There are few steps to setup partial gem booting in a Rails application using Bootinq:
+There are few steps to setup partial gem booting using Bootinq in any ruby application:
 
 ### 1. Declare loadable parts
 
@@ -60,7 +60,9 @@ group :console_boot do
 end
 ```
 
-### 3. Change config/application.rb
+## Ruby on Rails
+
+### 3. Swap Bundle.require to Bootinq.require
 
 Insert `require "bootinq"` to the top of `config/application.rb` file and replace `Bundler.require(*Rails.groups)` with the `Bootinq.require`:
 
@@ -74,11 +76,10 @@ require 'rails/all'
 require 'bootinq'
 
 # With no additional gem groups:
-Bootinq.require
+Bootinq.require(verbose: true)
 # 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
@@ -131,6 +132,24 @@ api:   env BOOTINQ=a MAX_THREADS=128 bundle exec puma -w 4
 admin: env BOOTINQ=z bundle exec puma
 ```
 
+## Usage with other frameworks
+
+3. Locate `Bundler.require(...)` in your app and insert `require "bootinq"` above it.
+
+4. Replace located `Bundler.require(...)` line with the `Bootinq.require(...)`.
+
+For example, if you are using Grape:
+
+```ruby
+# config/application.rb
+
+require 'boot'
+require 'bootinq'
+
+# Bundler.require :default, ENV['RACK_ENV']
+Bootinq.require :default, ENV['RACK_ENV'], verbose: true
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/bootinq.rb

@@ -4,16 +4,36 @@ require "yaml"
 require "singleton"
 require "forwardable"
 require "bootinq/component"
+require "bootinq/switch"
 
 # = Bootinq
 #
 # == Installation
 #
+# === Ruby on Rails
+#
 # 1. Insert <tt>require "bootinq"</tt> in the top of <tt>config/application.rb</tt>
 #
 # 2. Find <tt>Bundler.require(*Rails.groups)</tt> line below and replace it
 #    with the <tt>Bootinq.require</tt>.
 #
+# === Other
+#
+# 1. Locate <tt>Bundler.require(...)</tt> in your app and insert <tt>require "bootinq"</tt> above.
+#
+# 2. Replace located <tt>Bundler.require(...)</tt> line with the <tt>Bootinq.require(...)</tt>.
+#
+# For example, if you are using Grape:
+#
+#     # config/application.rb
+#
+#     require 'boot'
+#     require 'bootinq'
+#
+#     # Bundler.require :default, ENV['RACK_ENV']
+#     Bootinq.require :default, ENV['RACK_ENV'], verbose: true
+#     ...
+#
 # == Example <tt>config/bootinq.yml</tt>:
 #
 #     env_key: BOOTINQ
@@ -26,7 +46,6 @@ require "bootinq/component"
 #       a: :api
 #       f: :engine
 class Bootinq
-  extend SingleForwardable
   include Singleton
 
   DEFAULT = {
@@ -36,30 +55,55 @@ class Bootinq
     "mount"   => {}
   }.freeze
 
-  # 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)
-
-    setup(verbose: verbose, &block)
+  class << self
+    protected def delegated(sym) # :no-doc:
+      location = caller_locations(1, 1).first
+      file, line = location.path, location.lineno
+      definiton = %(def self.#{sym}(*args, &block); instance.#{sym}(*args, &block); end)
+      class_eval definiton, file, line
+    end
+  end
 
+  # :call-seq:
+  #   Bootinq.require(*groups, verbose: false, &block)
+  #
+  # Invokes the <tt>Bootinq.init</tt> method with the given verbose key argument & block,
+  # and, finally, makes Bundler to require the given groups.
+  def self.require(*groups, verbose: false, &block) # :yields: Bootinq.instance
+    init(verbose: verbose, &block)
     Bundler.require(*instance.groups(*groups))
   end
 
   # :call-seq:
-  #   Bootinq.setup(verbose: true, &block) -> true or false
+  #   Bootinq.setup(*groups, verbose: false, &block)
   #
-  # Initializes itself. When verbose: true
-  # Yields optional block in the own instance's binding and,
-  def self.setup(verbose: false, &block) # :yields: Bootinq.instance
+  # Invokes the <tt>Bootinq.init</tt> method with the given verbose key argument & block,
+  # and, finally, makes Bundler to setup the given groups.
+  def self.setup(*groups, verbose: false, &block) # :yields: Bootinq.instance
+    init(verbose: verbose, &block)
+    Bundler.setup(*instance.groups(*groups))
+  end
+
+  # :call-seq:
+  #   Bootinq.init(verbose: false, &block) -> true or false
+  #
+  # Initializes itself. Sets the BOOTINQ_PATH enviroment variable if it is missing.
+  # To track inquired components use <tt>verbose: true</tt> key argument.
+  # Optionally yields block within the own instance's binding.
+  def self.init(verbose: false, &block) # :yields: Bootinq.instance
+    ENV['BOOTINQ_PATH'] ||= File.expand_path('../bootinq.yml', caller_locations(2, 1)[0].path)
+
     instance
+    instance.instance_variable_set(:@_on_ready, block.to_proc) if block_given?
     puts "Bootinq: loading components #{instance.components.join(', ')}" if verbose
-    instance.instance_exec(&block) if block_given?
-    instance
+    instance.ready!
   end
 
-  attr_reader :flags, :components
+  attr_reader :flags
+  attr_reader :components
+
+  delegated :flags
+  delegated :components
 
   def initialize # :no-doc:
     config_path = ENV.fetch('BOOTINQ_PATH')
@@ -75,10 +119,29 @@ class Bootinq
     config['mount'].each { |flag, name| enable_component(name, flag: flag, as: Mountable) }
   end
 
+  delegated def ready? # :no-doc:
+    !!@ready
+  end
+
+  # :call-seq:
+  #   Bootinq.ready! -> nil or self
+  #
+  # At the first call marks Bootinq as ready and returns the instance,
+  # otherwise returns nil.
+  delegated def ready!
+    return if ready?
+    @ready = true
+    if defined?(@_on_ready)
+      instance_exec(&@_on_ready)
+      remove_instance_variable :@_on_ready
+    end
+    self
+  end
+
   # :call-seq:
   #   Bootinq.enable_component(name, flag: [, as: Component])
   #
-  def enable_component(name, flag:, as: Component)
+  delegated def enable_component(name, flag:, as: Component)
     if @_neg ^ @_value.include?(flag)
       @flags      << flag
       @components << as.new(name)
@@ -90,7 +153,7 @@ class Bootinq
   #
   # Checks if a component with the given name (i.e. the same gem group)
   # is enabled
-  def enabled?(name)
+  delegated def enabled?(name)
     components.include?(name)
   end
 
@@ -99,12 +162,12 @@ class Bootinq
   #   Bootinq[name] -> Bootinq::Component
   #
   # Returns a <tt>Bootinq::Component</tt> object by its name
-  def component(name)
+  delegated def component(name)
     components[components.index(name)]
   end
 
   alias :[] :component
-
+  delegated :[]
 
   # :call-seq:
   #   Bootinq.each_mountable { |part| block } -> Array
@@ -114,16 +177,23 @@ class Bootinq
   # 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
+  delegated 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)
+  # Merges enabled Bootinq's groups with the given groups and, if loaded with Rails,
+  # passes them to <tt>Rails.groups</tt> method, otherwise just returns the merged list
+  # to use with <tt>Bundler.require</tt>.
+  delegated def groups(*groups)
+    groups.unshift(*components.map(&:group))
+    if defined?(Rails)
+      Rails.groups(*groups)
+    else
+      groups
+    end
   end
 
   # :call-seq:
@@ -149,7 +219,7 @@ class Bootinq
   #   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:
+  delegated 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))
@@ -169,7 +239,7 @@ class Bootinq
   #
   # 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:
+  delegated def on_all(*parts) # :yields:
     is_matched = parts.all? { |p| enabled?(p) }
     yield if is_matched && block_given?
     is_matched
@@ -180,12 +250,28 @@ class Bootinq
   #
   # 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:
+  delegated def on_any(*parts) # :yields:
     is_matched = parts.any? { |p| enabled?(p) }
     yield if is_matched && block_given?
     is_matched
   end
 
+  # :call-seq:
+  #   Bottinq.switch(*parts) { block } -> nil
+  #
+  # Collector method.
+  #
+  # Example:
+  #
+  #   Bootinq.switch do |part|
+  #     part.frontend { … }
+  #     part.backend { … }
+  #   end
+  delegated def switch # :yields: Bootinq::Switch.new
+    yield(Switch.new)
+    nil
+  end
+
   # Freezes every instance variables and the instance itself.
   def freeze
     @_value.freeze
@@ -195,9 +281,7 @@ class Bootinq
     super
   end
 
-  def_delegators "instance", *instance_methods(false)
-
-  def self.new # :no-doc:
+  def self.new
     super.freeze
   end
 

data/lib/bootinq/component.rb

@@ -20,6 +20,17 @@ class Bootinq
       false
     end
 
+    def module_name
+      @id2name.camelcase.to_sym
+    end
+
+    def engine
+    end
+
+    def kind_of?(klass)
+      super || @intern.kind_of?(klass)
+    end
+
     def == other
       case other
       when String then other == @id2name
@@ -28,26 +39,44 @@ class Bootinq
       end
     end
 
-    def inspect
-      @intern.inspect
+    def ===(other)
+      case other
+      when String then other === @id2name
+      when Symbol then other === @intern
+                  else super
+      end
     end
 
-    def engine
+    def casecmp(other)
+      case other
+      when String then @id2name.casecmp(other)
+      when Symbol then @intern.casecmp(other)
+      when self.class then casecmp(other.to_s)
+      end
     end
 
-    def module_name
-      @id2name.camelcase.to_sym
+    def casecmp?(other)
+      case other
+      when String then @id2name.casecmp?(other)
+      when Symbol then @intern.casecmp?(other)
+      when self.class then casecmp?(other.to_s)
+      end
     end
 
-    def respond_to_missing?(method_name, include_all=false)
-      @intern.respond_to?(method_name, include_all)
-    end
+    %i(inspect to_proc __id__ hash).
+      each { |sym| class_eval %(def #{sym}; @intern.#{sym}; end), __FILE__, __LINE__ + 1 }
 
-    private
+    %i(encoding empty? length).
+      each { |sym| class_eval %(def #{sym}; @id2name.#{sym}; end), __FILE__, __LINE__ + 1 }
 
-    def method_missing(method_name, *args, &blk)
-      @intern.respond_to?(method_name) ? @intern.public_send(method_name, *args, &blk) : super
-    end
+    %i(match match? =~ []).
+      each { |sym| class_eval %(def #{sym}(*args); @id2name.#{sym}(*args); end), __FILE__, __LINE__ + 1 }
+
+    %i(upcase downcase capitalize swapcase succ next).
+      each { |sym| class_eval %(def #{sym}; self.class.new(@intern.#{sym}); end), __FILE__, __LINE__ + 1 }
+
+    alias :slice :[]
+    alias :size :length
   end
 
   class Mountable < Component

data/lib/bootinq/switch.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class Bootinq
+  class Switch < ::BasicObject # :no-doc:
+    undef_method :==
+    undef_method :equal?
+
+    def raise(*args) # :no-doc:
+      ::Object.send(:raise, *args)
+    end
+
+    def method_missing(name, *)
+      if ::Bootinq.enabled?(name)
+        yield()
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/bootinq/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootinq
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Anton
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-06 00:00:00.000000000 Z
+date: 2020-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,6 +58,7 @@ files:
 - lib/bootinq.rb
 - lib/bootinq.yml
 - lib/bootinq/component.rb
+- lib/bootinq/switch.rb
 - lib/bootinq/version.rb
 homepage: https://github.com/estum/bootinq
 licenses:
@@ -78,8 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Rails Boot Inquirer