bootinq 0.3.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a8647f4b798663b8511a3d2c7a9527b93756b9ca
-  data.tar.gz: 35bd6157a95de1bd4df9648896d08939401281cb
+SHA256:
+  metadata.gz: 266e204b1e16ba81aaaf17e2ab6b638f2c33b1717a9c728e65332b6b2274e98d
+  data.tar.gz: 0f8210ddf0aae40d21ccc68b3964df30b7102ea35cb76c04779e3a2f48d0f9dd
 SHA512:
-  metadata.gz: 8cf0fc21e41449527782916a81a3dfb2749f6e9f91dda590d381a5b5dd15bc31c5d15b6216fdf1cb717424cd83a069b09a3fab213a657a041700ae313fe9a8df
-  data.tar.gz: add219d5df6e7a54aae76552de7be7f5509d79fdb51541399f3705f3c0f025de28b19b396374b842e92fd6ae96591bb2284b66acb75ceff8a3b500477d83f748
+  metadata.gz: d8d3172c9a7a38e335585b0b1a35dc7bdaccbb993076095cd414a317f891d0506e6b0995b5e7eb4cdea9f885553658cd175219273a788db797994d63eca59a44
+  data.tar.gz: 182655c54c91a0a4cac2d7c17e5750e59e8941309a9ce492faddc1204f30e72a90c847f5e48e23ffb549cc9dc60ad4ed0c0b064eb92348960a6b85286380321b

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

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,5 +1,6 @@
+# frozen_string_literal: true
+
 require "yaml"
-require "erb"
 require "singleton"
 require "forwardable"
 require "bootinq/component"
@@ -8,11 +9,30 @@ require "bootinq/component"
 #
 # == 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
@@ -25,93 +45,201 @@ require "bootinq/component"
 #       a: :api
 #       f: :engine
 class Bootinq
-  NEG     = '-'.freeze
+  include Singleton
+
   DEFAULT = {
     "env_key" => 'BOOTINQ',
     "default" => '',
     "parts"   => {},
     "mount"   => {}
-  }
+  }.freeze
 
-  attr_reader :flags, :components
+  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
 
-  include Singleton
-  extend SingleForwardable
+  # :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.
+  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)
+
+    Bundler.require(*instance.groups(*groups))
+  end
 
-  def initialize
-    config = YAML.load(File.read(ENV['BOOTINQ_PATH']))
-    config.reject! { |_, v| v.nil? }
-    config.reverse_merge!(DEFAULT)
+  # :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
 
-    config['parts'].merge!(config['mount'])
+  attr_reader :flags
+  attr_reader :components
 
-    value = ENV[config['env_key']] || config['default'].to_s
-    neg   = value.start_with?(NEG)
+  delegated :flags
+  delegated :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
+
+  # :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
 
-  # Enums each mountable component
-  def each_mountable
-    return to_enum(__method__) unless block_given?
-    components.each { |c| yield(c) if c.mountable? }
+  alias :[] :component
+  delegated :[]
+
+  # :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
 
-  # Yields the given block if any of given components is enabled.
+  # :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
-  def on(*names) # :yields:
-    if names.any? { |name| enabled?(name) }
-      yield
+  #
+  #   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
+  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
 
-  def_delegators "instance", *instance_methods(false)
+  # :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
 
-  class << self
-    # 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
+  # :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
 
-    private def new
-      super.freeze
-    end
+  # Freezes every instance variables and the instance itself.
+  def freeze
+    @_value.freeze
+    @_neg.freeze
+    @flags.freeze
+    @components.freeze
+    super
   end
+
+  def self.new
+    super.freeze
+  end
+
+  private_class_method :new
 end

data/lib/bootinq/component.rb

@@ -1,20 +1,91 @@
+# 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 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
+      when Symbol then other == @intern
+                  else super
+      end
+    end
+
+    def ===(other)
+      case other
+      when String then other === @id2name
+      when Symbol then other === @intern
+                  else super
+      end
+    end
+
+    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 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
+
+    %i(inspect to_proc __id__ hash).
+      each { |sym| class_eval %(def #{sym}; @intern.#{sym}; end), __FILE__, __LINE__ + 1 }
+
+    %i(encoding empty? length).
+      each { |sym| class_eval %(def #{sym}; @id2name.#{sym}; end), __FILE__, __LINE__ + 1 }
+
+    %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
+    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.3.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: bootinq
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Anton
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-26 00:00:00.000000000 Z
+date: 2020-06-24 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
@@ -58,7 +59,6 @@ files:
 - lib/bootinq.yml
 - lib/bootinq/component.rb
 - lib/bootinq/version.rb
-- lib/tasks/bootinq_tasks.rake
 homepage: https://github.com/estum/bootinq
 licenses:
 - MIT
@@ -79,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