bootinq 1.3.1 → 1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2132126092e2938ead320330a8866a61e496e47683b1a88c7ec3f8b15d3f1f2b
-  data.tar.gz: 3eee6dabbc507a0d8234d2edc64461eddca66259b3df04c76799cbfffbbb94f8
+  metadata.gz: 33cdc97b02b2407bf6cf031dbac9e0fdae903d6a97a60e266b058729d6a43895
+  data.tar.gz: 1cba1d8a6a48ff92ba80dbcad36623a7389f95f512b8d844debc5c7c22644e6b
 SHA512:
-  metadata.gz: e2b45226f655ee94a841ec79f70934af6948427ba97e4a1269a4371693b9c3d50bbd9857db2b2b7a914532cc04a571176c41dbeb7f44bbd5979b4464562e5dbe
-  data.tar.gz: cd87ee76d07175f774202a45c20875d5e1c9a18ab2e0f469e75b2d4a9039520fda537ba29d12f05f67e5e1704b8797a4296ba5c277e56da14a1982731ff7678f
+  metadata.gz: 7a4b636bbdea12800a0b367bd5e4294c9681738200597100725595bd3ce3f4f6a5d4b95c14594249cba8755fa11206ba6a01fc516923e1e72493a34efbb79b1d
+  data.tar.gz: b6c5e5d242ffff08ac9f00a680dd760979879769e9a752193e039453f31d86684ce97f9d7e19167e36de4ede4003ae9e7a1e42647288082e36bee6badd58095e

data/Gemfile

@@ -32,6 +32,14 @@ group :shared_boot do
   gem 'shared', path: 'spec/dummy/engines/shared'
 end
 
+group :api_part_boot do
+  gem 'api_part', path: 'spec/dummy/engines/api_part'
+end
+
 group :api_boot do
   gem 'api', path: 'spec/dummy/engines/api'
+end
+
+group :api2_boot do
+  gem 'api2', path: 'spec/dummy/engines/api2'
 end

data/lib/bootinq.rb

@@ -37,7 +37,7 @@ require "bootinq/switch"
 # == Example <tt>config/bootinq.yml</tt>:
 #
 #     env_key: BOOTINQ
-#     default: "-f"
+#     default: a
 #
 #     parts:
 #       s: :shared
@@ -45,6 +45,11 @@ require "bootinq/switch"
 #     mount:
 #       a: :api
 #       f: :engine
+#
+#     deps:
+#       shared:
+#         in: af
+#
 class Bootinq
   include Singleton
 
@@ -52,70 +57,106 @@ class Bootinq
     "env_key" => 'BOOTINQ',
     "default" => '',
     "parts"   => {},
-    "mount"   => {}
+    "mount"   => {},
+    "deps"    => {}
   }.freeze
 
-  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
+  FilterNegValue = -> (value, config) do
+    if value.start_with?(?-, ?^)
+      value = value.tr('\\-', '\\^')
+      flags = (config['parts'].keys + config['mount'].keys).join
+      [true, flags.delete(flags.delete(value))]
+    else
+      [false, value.dup]
     end
   end
 
+  private_constant :FilterNegValue
+
   # :call-seq:
   #   Bootinq.require(*groups, verbose: false, &block)
   #
-  # The helper method to bootstrap the Bootinq.
-  # Sets the BOOTINQ_PATH enviroment variable if it is missing,
-  # invokes the <tt>Bootinq.setup</tt> method with the given verbose key argument & block,
-  # and, finally, gets Bundler to require the given groups.
+  # 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
-    ENV['BOOTINQ_PATH'] ||= File.expand_path('../bootinq.yml', caller_locations(1..1)[0].path)
-
-    setup(verbose: verbose, &block)
-
+    init(verbose: verbose, &block)
     Bundler.require(*instance.groups(*groups))
   end
 
   # :call-seq:
-  #   Bootinq.setup(verbose: false, &block) -> true or false
+  #   Bootinq.setup(*groups, verbose: false, &block)
   #
-  # Initializes itself. To track inquired components use <tt>verbose: true</tt> key argument.
+  # 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.setup(verbose: false, &block) # :yields: Bootinq.instance
+  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
+
+  # Reads config from the given or default path, deserializes it and returns as a hash.
+  def self.deserialized_config(path: nil)
+    bootinq_yaml = File.read(path || ENV.fetch('BOOTINQ_PATH'))
+    YAML.safe_load(bootinq_yaml, [Symbol])
   end
 
   attr_reader :flags
   attr_reader :components
 
-  delegated :flags
-  delegated :components
-
   def initialize # :no-doc:
-    config_path = ENV.fetch('BOOTINQ_PATH')
-    config = YAML.safe_load(File.read(config_path), [Symbol])
+    config = self.class.deserialized_config
     config.merge!(DEFAULT) { |_, l, r| l.nil? ? r : l }
 
-    @_value     = ENV.fetch(config['env_key']) { config['default'] }
-    @_neg       = @_value.start_with?(?-, ?^)
+    @_orig_value = ENV.fetch(config['env_key']) { config['default'] }
+    @_neg, @_value = FilterNegValue[@_orig_value, config]
+
+    @_deps = config['deps']
+
     @flags      = []
     @components = []
 
-    config['parts'].each { |flag, name| enable_component(name, flag: flag) }
-    config['mount'].each { |flag, name| enable_component(name, flag: flag, as: Mountable) }
+    config['parts'].each { |flag, name| enable_component(name, flag: flag.to_s) }
+    config['mount'].each { |flag, name| enable_component(name, flag: flag.to_s, as: Mountable) }
+  end
+
+  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.
+  def ready!
+    return if ready?
+    @ready = true
+    if defined?(@_on_ready)
+      instance_exec(&@_on_ready)
+      remove_instance_variable :@_on_ready
+    end
+    freeze
   end
 
   # :call-seq:
   #   Bootinq.enable_component(name, flag: [, as: Component])
   #
-  delegated def enable_component(name, flag:, as: Component)
-    if @_neg ^ @_value.include?(flag)
+  def enable_component(name, flag:, as: Component)
+    if is_dependency?(name) || @_value.include?(flag)
       @flags      << flag
       @components << as.new(name)
     end
@@ -126,7 +167,7 @@ class Bootinq
   #
   # Checks if a component with the given name (i.e. the same gem group)
   # is enabled
-  delegated def enabled?(name)
+  def enabled?(name)
     components.include?(name)
   end
 
@@ -135,12 +176,11 @@ class Bootinq
   #   Bootinq[name] -> Bootinq::Component
   #
   # Returns a <tt>Bootinq::Component</tt> object by its name
-  delegated def component(name)
+  def component(name)
     components[components.index(name)]
   end
 
   alias :[] :component
-  delegated :[]
 
   # :call-seq:
   #   Bootinq.each_mountable { |part| block } -> Array
@@ -150,7 +190,7 @@ class Bootinq
   # passing that part as a parameter. Returns the array of all mountable components.
   #
   # If no block is given, an Enumerator is returned.
-  delegated def each_mountable(&block) # :yields: part
+  def each_mountable(&block) # :yields: part
     components.select(&:mountable?).each(&block)
   end
 
@@ -160,7 +200,7 @@ class Bootinq
   # 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)
+  def groups(*groups)
     groups.unshift(*components.map(&:group))
     if defined?(Rails)
       Rails.groups(*groups)
@@ -192,7 +232,7 @@ class Bootinq
   #   Bootinq.on all: %i(frontend backend) do
   #     # do something when frontend and backend are enabled
   #   end
-  delegated def on(name = nil, any: nil, all: nil) # :yields:
+  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))
@@ -212,7 +252,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.
-  delegated def on_all(*parts) # :yields:
+  def on_all(*parts) # :yields:
     is_matched = parts.all? { |p| enabled?(p) }
     yield if is_matched && block_given?
     is_matched
@@ -223,14 +263,14 @@ class Bootinq
   #
   # Takes a list of component names and yields a given block  (optionally)
   # if any of them are enabled. Returns boolean matching status.
-  delegated def on_any(*parts) # :yields:
+  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
+  #   Bootinq.switch(*parts) { block } -> nil
   #
   # Collector method.
   #
@@ -240,23 +280,47 @@ class Bootinq
   #     part.frontend { … }
   #     part.backend { … }
   #   end
-  delegated def switch # :yields: Bootinq::Switch.new
+  def switch # :yields: Bootinq::Switch.new
     yield(Switch.new)
     nil
   end
 
+  # :call-seq:
+  #   is_dependency?(part_name) -> true or false
+  #
+  # Checks if the named component is a dependency of the enabled one.
+  def is_dependency?(name)
+    @_deps.key?(name) && @_value.count(@_deps[name]['in'].to_s) > 0
+  end
+
   # Freezes every instance variables and the instance itself.
   def freeze
     @_value.freeze
-    @_neg.freeze
+    @_neg
     @flags.freeze
     @components.freeze
     super
   end
 
-  def self.new
-    super.freeze
-  end
+  delegate_template = <<~RUBY
+    def self.%1$s(*args, &block)
+      instance.%1$s(*args, &block)
+    end
+  RUBY
 
-  private_class_method :new
+  %I(flags
+     components
+     ready?
+     ready!
+     enable_component
+     enabled?
+     component
+     []
+     each_mountable
+     groups
+     on
+     on_all
+     on_any
+     switch
+  ).each { |sym| class_eval(delegate_template  % sym, *instance_method(sym).source_location) }
 end

data/lib/bootinq/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootinq
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: '1.6'
 platform: ruby
 authors:
 - Anton
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-27 00:00:00.000000000 Z
+date: 2021-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler