bootinq 1.0.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 729bf1c9b83d3e11258f451f220542d46836ffc9
-  data.tar.gz: fc860ed30c15acc2046e2e33074d4097004aa4fc
+SHA256:
+  metadata.gz: 2132126092e2938ead320330a8866a61e496e47683b1a88c7ec3f8b15d3f1f2b
+  data.tar.gz: 3eee6dabbc507a0d8234d2edc64461eddca66259b3df04c76799cbfffbbb94f8
 SHA512:
-  metadata.gz: f2aa46cef37e5b173a9efb010bbc3fcc616f324ddb8ed52938e8303ab400ff707baf6bddfa3135b918c7adcf791463c59021a257efa0589b8888435877d0c2ae
-  data.tar.gz: b1f55595d4f7611014c547831d1b34b5dae00ba479802099de799f732b2665afefb94ecb9ae7377b6b355a427c568957eeffc9783e4cf26dca0dcb8d6747b3c3
+  metadata.gz: e2b45226f655ee94a841ec79f70934af6948427ba97e4a1269a4371693b9c3d50bbd9857db2b2b7a914532cc04a571176c41dbeb7f44bbd5979b4464562e5dbe
+  data.tar.gz: cd87ee76d07175f774202a45c20875d5e1c9a18ab2e0f469e75b2d4a9039520fda537ba29d12f05f67e5e1704b8797a4296ba5c277e56da14a1982731ff7678f

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

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

@@ -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/bootinq.gemspec

@@ -19,6 +19,6 @@ Gem::Specification.new do |spec|
   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 "bundler"
+  spec.add_development_dependency "rake"
 end

data/lib/bootinq.rb

@@ -1,17 +1,39 @@
+# frozen_string_literal: true
+
 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
@@ -24,7 +46,6 @@ require "bootinq/component"
 #       a: :api
 #       f: :engine
 class Bootinq
-  extend SingleForwardable
   include Singleton
 
   DEFAULT = {
@@ -34,62 +55,125 @@ class Bootinq
     "mount"   => {}
   }.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
+    end
+  end
+
+  # :call-seq:
+  #   Bootinq.require(*groups, verbose: false, &block)
+  #
   # 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 self.require(*groups, verbose: false, &block) # :yields:
+  # 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.
+  def self.require(*groups, verbose: false, &block) # :yields: Bootinq.instance
     ENV['BOOTINQ_PATH'] ||= File.expand_path('../bootinq.yml', caller_locations(1..1)[0].path)
 
-    puts "Bootinq: loading components #{instance.components.join(', ')}" if verbose
-
-    instance.instance_exec(&block) if block_given?
+    setup(verbose: verbose, &block)
 
     Bundler.require(*instance.groups(*groups))
   end
 
-  private_class_method def self.new # :nodoc:
-    super.freeze
+  # :call-seq:
+  #   Bootinq.setup(verbose: false, &block) -> true or false
+  #
+  # Initializes itself. 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
+    instance
+    puts "Bootinq: loading components #{instance.components.join(', ')}" if verbose
+    instance.instance_exec(&block) if block_given?
+    instance
   end
 
+  attr_reader :flags
+  attr_reader :components
 
-  attr_reader :flags, :components
+  delegated :flags
+  delegated :components
 
-  def initialize
-    config = YAML.safe_load(File.read(ENV.fetch('BOOTINQ_PATH')), [Symbol]).
-      merge!(DEFAULT) { |_,l,r| l.nil? ? r : l }
+  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 }
 
     @_value     = ENV.fetch(config['env_key']) { config['default'] }
-    @_neg       = @_value.start_with?("-", "^")
+    @_neg       = @_value.start_with?(?-, ?^)
     @flags      = []
     @components = []
 
-    config['parts'].each { |flag, name| enable_component(flag) { Component.new(name) } }
-    config['mount'].each { |flag, name| enable_component(flag) { Mountable.new(name) } }
+    config['parts'].each { |flag, name| enable_component(name, flag: flag) }
+    config['mount'].each { |flag, name| enable_component(name, flag: flag, as: Mountable) }
+  end
+
+  # :call-seq:
+  #   Bootinq.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)
+    end
   end
 
-  # Checks if a given gem (i.e. a gem group) is enabled
-  def enabled?(gem_name)
-    components.include?(gem_name)
+  # :call-seq:
+  #   Bootinq.enabled?(name) -> true or false
+  #
+  # Checks if a component with the given name (i.e. the same gem group)
+  # is enabled
+  delegated 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)]
+  delegated def component(name)
+    components[components.index(name)]
   end
 
   alias :[] :component
+  delegated :[]
 
-  # Enums each mountable component
-  def each_mountable # :yields:
-    return to_enum(__method__) unless block_given?
-    components.each { |part| yield(part) if part.mountable? }
+  # :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.
+  delegated def each_mountable(&block) # :yields: part
+    components.select(&:mountable?).each(&block)
   end
 
-  # Invokes <tt>Rails.groups</tt> method within enabled Bootinq's groups
-  def groups(*list)
-    Rails.groups(*components.map(&:group), *list)
+  # :call-seq:
+  #   Bootinq.groups(*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:
+  #   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.
   #
@@ -108,21 +192,61 @@ 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:
-    if (any && all) || (name && (any || all))
-      raise ArgumentError, "expected single argument or one of keywords: `all' or `any'"
-    elsif name
-      yield if enabled?(name)
-    elsif any
-      yield if any.any? { |part| enabled?(part) }
-    elsif all
-      yield if all.all? { |part| enabled?(part) }
-    else
+  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))
+      raise ArgumentError, "expected single argument or one of keywords: `all' or `any'"
     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.
+  delegated 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.
+  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
 
-  def freeze # :no-doc:
+  # Freezes every instance variables and the instance itself.
+  def freeze
     @_value.freeze
     @_neg.freeze
     @flags.freeze
@@ -130,12 +254,9 @@ class Bootinq
     super
   end
 
-  def_delegators "instance", *instance_methods(false)
-
-  private def enable_component(flag) # :yields:
-    if @_neg ^ @_value.include?(flag)
-      @flags      << flag
-      @components << yield
-    end
+  def self.new
+    super.freeze
   end
+
+  private_class_method :new
 end

data/lib/bootinq/component.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Bootinq
   class Component
     attr_reader :intern, :id2name, :group
@@ -18,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
@@ -26,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,3 +1,5 @@
+# frozen_string_literal: true
+
 class Bootinq
-  VERSION = "1.0.0"
+  VERSION = "1.3.1"
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: bootinq
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Anton
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-14 00:00:00.000000000 Z
+date: 2020-06-27 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'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 description: Allows to select which bundle groups to boot in the current rails process
 email:
 - anton.estum@gmail.com
@@ -49,6 +49,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
@@ -57,8 +58,8 @@ files:
 - lib/bootinq.rb
 - lib/bootinq.yml
 - lib/bootinq/component.rb
+- lib/bootinq/switch.rb
 - lib/bootinq/version.rb
-- lib/tasks/bootinq_tasks.rake
 homepage: https://github.com/estum/bootinq
 licenses:
 - MIT
@@ -78,10 +79,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 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