bootinq 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e3f02fce19c9b509420de6322555b1f3a8fe7c2a
-  data.tar.gz: 1a269f11b486f95c33d6df89948281cb74d6e2f6
+SHA256:
+  metadata.gz: f503e7ad103931ee10ce325a3590e3b7742f128a6947a37f59a1566ec57ceaed
+  data.tar.gz: 750b19a788035d9325cff83342cc67e2aac08b9ef4e892637eee07121a73b7b4
 SHA512:
-  metadata.gz: efc41497347123f8025457ad4af3e2037df51387f56248ece3bcdacfb0443eae8f12428203a4dda3a8e3d1d19a8ef21e32687eafdb01475486dc00c02a06f808
-  data.tar.gz: 274f3d80999d1acacf21ceeafea979fd67a138ed617959effa234b860331599109e71c3cd5c964c11c93c4d4fead1dafec65521326e76a9a3344199b69e1e651
+  metadata.gz: f2878d2f0977783d2d586baa923bbc80945a2495120b522a5c198fd0c493c21f9b7ab4f591799b4f041130cfb62e3747f9287683d23db0bbccf92a64716fac49
+  data.tar.gz: 15eac28f64c7777dcafefb756d4a6e3644d22561c673bada3e5d6ff7187283d7596a8c62aae2e1933cab49e1f44531570a99c32e37b1db5a69e4fda4cf66eb34

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/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,3 +1,5 @@
+# frozen_string_literal: true
+
 require "yaml"
 require "singleton"
 require "forwardable"
@@ -35,61 +37,100 @@ class Bootinq
   }.freeze
 
   # 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, 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)
 
-    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: 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
 
-
   attr_reader :flags, :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
 
-  # 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
 
   alias :[] :component
 
-  # 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.
+  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(*list)
-    Rails.groups(*components.map(&:group), *list)
+  def groups(*groups)
+    Rails.groups(*components.map(&:group), *groups)
   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.
   #
@@ -109,20 +150,44 @@ class Bootinq
   #     # 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
+    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.
+  def on_all(*parts) # :yields:
+    is_matched = parts.all? { |p| enabled?(p) }
+    yield if is_matched && block_given?
+    is_matched
   end
 
-  def freeze # :no-doc:
+  # :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
@@ -132,10 +197,9 @@ class Bootinq
 
   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 # :no-doc:
+    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

data/lib/bootinq/version.rb

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

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: bootinq
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Anton
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-02 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'
+        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
@@ -59,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
@@ -80,9 +79,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+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