stibium-bundled 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63124b549081f71ec8962a7ce60a2d7309cc8a288123744c378e3a504460328d
-  data.tar.gz: 3002be752eca5c11fb5102d1a3db9374c9cd89535507f27f92154a304a13414b
+  metadata.gz: 540a8ad588f6dbeb56f350aa54908bd240c2ec1f321d3885bfa1e5884cf45491
+  data.tar.gz: edfeef841ad795136cf3a6c41ea711f00f6029d160d46fb63197daed1cfb36e3
 SHA512:
-  metadata.gz: 4503ed903e66d57c352ba2377d127b20485dbf24d761a32571f1775b4c86b864be1142e15ee8ec883909b6fb9b19a18ee204e78ccf13ba0d7eb65b2cfcc9ec91
-  data.tar.gz: c8c6f97330f328d35c902b4818a90d68dabf53178fc46e3df1fab2acfd077f9a741ce3d8a82ef3f953cd6fff67c4306e66e68973165f92cad3582ea7dcad5f5b
+  metadata.gz: c7839c5a74b6e12312fcf17729d3cf315e9242898d718c59f6501dae93bc34fd1da9cc8b1afe9ec1add479d4bd84115121931ead5a630c18caf54a99cac2d1f6
+  data.tar.gz: f27014af349f61a57484ed1f4d1d4fb1083c9ef84a0950b7e017f01d0ff82db75c547be623a71e2852fe9d604cc2c538e15d6a1a34ea29a6e5326bc3bada52f3

data/README.md

@@ -1,4 +1,4 @@
-# ``stibium-bundled`` [![Gem Version](https://badge.fury.io/rb/stibium-bundled.svg)][rubygems:stibium-bundled]
+# ``stibium-bundled`` [![Gem Version](https://badge.fury.io/rb/stibium-bundled.svg)][rubygems:stibium-bundled] [![Maintainability](https://api.codeclimate.com/v1/badges/7121242b44c7a3cc4f61/maintainability)](https://codeclimate.com/github/SwagDevOps/stibium-bundled/maintainability)
 
 This gem is intended to mimic Bundler's behavior and conform to [bundler configuration options][bundler:config].
 
@@ -62,6 +62,49 @@ module AwesomeGem
 end
 ```
 
+if ``stibium-bundled`` is not system wide installed, it can be necessary to
+locate it:
+
+```ruby
+# file: lib/awesome_gem.rb
+
+module AwesomeGem
+  Pathname.new("#{__dir__}/..").expand_path.tap do |basedir|
+    begin
+      require 'stibium/bundled'
+    rescue LoadError
+      basedir.join('{**/,}bundle', RUBY_ENGINE, RUBY_VERSION, '{bundler,}/gems/*/stibium-bundled.gemspec').tap do |s|
+        Pathname.glob(s).first&.dirname.tap { |gem_dir| require gem_dir.join('lib/stibium/bundled') }
+      end
+    end
+
+    include(::Stibium::Bundled).bundled_from(basedir, setup: true) do |bundle|
+      if bundle.locked? and bundle.installed? and Object.const_defined?(:Gem)
+        require 'fabulous/feature' if bundle.specifications.keep_if { |s| s.name == 'fabulous' }.any?
+      end
+    end
+  end
+end
+```
+
+## Benchmarks
+
+Using ``Stibium::Bundled`` setup leads to minor overhead compared to direct require for ``bundler/setup``,
+on the other hand ``Stibium::Bundled`` setup is compatible with standalone's bundler setup without code change.
+And ``bundle exec`` is known to be [slow][stackoverflow/running-scripts-with-bundle-exec-is-slow].
+
+Install [hypefine][sharkdp/hyperfine] and run benchmarks:
+
+```shell
+rake bench runs=20
+```
+
+| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
+|:---|---:|---:|---:|---:|
+| `bundler/setup` | 205.7 ± 7.1 | 200.1 | 232.5 | 1.00 ± 0.05 |
+| `bundled` | 205.7 ± 6.2 | 196.8 | 222.4 | 1.00 |
+| `bundle exec` | 559.4 ± 13.0 | 543.2 | 587.8 | 2.72 ± 0.10 |
+
 ## Install
 
 ```sh
@@ -76,3 +119,5 @@ bundle install --standalone
 [bundler:config]: https://bundler.io/v2.2/bundle_config.html
 [bundler:setup]: https://bundler.io/v1.5/bundler_setup.html
 [man:install#options]: https://bundler.io/man/bundle-install.1.html#OPTIONS
+[sharkdp/hyperfine]: https://github.com/sharkdp/hyperfine
+[stackoverflow/running-scripts-with-bundle-exec-is-slow]: https://stackoverflow.com/questions/13894966/running-scripts-with-bundle-exec-is-slow

data/lib/stibium/bundled.rb

@@ -69,12 +69,10 @@ module Stibium::Bundled
   # @see Stibium::Bundled::Bundle#setup
   def bundled_from(basedir, setup: false, env: ENV.to_h, ruby_config: {})
     # @type [Stibium::Bundled::Bundle] bundle
-    Stibium::Bundled.call(self, basedir: basedir, env: env, ruby_config: ruby_config).bundled.tap do |bundle|
-      unless bundle.nil?
-        bundle.__send__(:setup, **(setup.is_a?(Array) ? { guards: setup } : {})) if setup
+    Stibium::Bundled.call(self, basedir: basedir, env: env, ruby_config: ruby_config).bundled&.tap do |bundle|
+      bundle.__send__(:setup, **{ guards: setup.is_a?(Array) ? setup : nil }.compact) if setup
 
-        yield(bundle) if block_given?
-      end
+      yield(bundle) if block_given?
     end
   end
 
@@ -85,18 +83,29 @@ module Stibium::Bundled
     # @param ruby_config [Hash{Symbol => Object}]
     #
     # @return [Class, Module] given ``Class`` or ``Module``
-    def call(target, basedir:, env: ENV.to_h, ruby_config: {})
+    def call(target, basedir:, env: ENV.to_h, ruby_config: nil)
       target.tap do |t|
         t.singleton_class.tap do |sc|
           sc.singleton_class.__send__(:include, self)
           sc.define_method(:bundled?) { !bundled.nil? }
           sc.define_method(:bundled) do
-            # @type [Bundle] bundle
-            Bundle.new(basedir, env: env, ruby_config: ruby_config)
-                  .yield_self { |bundle| bundle.bundled? ? bundle : nil }
+            Stibium::Bundled.__send__(:bundler).call(basedir, env: env, ruby_config: ruby_config)
           end
         end
       end
     end
+
+    protected
+
+    # @api private
+    #
+    # @return [Proc]
+    def bundler
+      lambda do |basedir, env:, ruby_config: nil|
+        Bundle.new(basedir, env: env, ruby_config: ruby_config).yield_self do |bundle|
+          bundle.bundled? ? bundle : nil
+        end
+      end
+    end
   end
 end

data/lib/stibium/bundled/bundle.rb

@@ -67,7 +67,7 @@ class Stibium::Bundled::Bundle
   #
   # @return [Array<Gem::Specification>]
   def specifications
-    directory.specifications.map { |file| instance_eval(file.read, file.to_path) }
+    directory.specifications.map { |file| instance_eval(file.read, file.to_path) }.sort_by(&:name)
   end
 
   # Denote install seems to be happened (since specifications are present).
@@ -110,7 +110,7 @@ class Stibium::Bundled::Bundle
   #
   # @return [Boolean]
   def standalone?
-    !!bundler_setup
+    bundler_setup.yield_self { |fp| fp.file? and fp.readable? }
   end
 
   protected
@@ -119,14 +119,14 @@ class Stibium::Bundled::Bundle
   #
   # @return [self]
   #
-  # @raise [Errno::ENOENT]
+  # @raise [Errno::ENOENT, LoadError]
   def standalone!(&fallback)
-    self.tap do
-      # noinspection RubyResolve
-      bundler_setup.tap { |fp| require(fp.realpath) unless fp.nil? }
-    rescue Errno::ENOENT => e
-      fallback ? fallback.call(self) : raise(e)
-    end
+    # noinspection RubyResolve
+    require(bundler_setup.realpath)
+  rescue Errno::ENOENT, LoadError => e
+    fallback ? fallback.call(self) : raise(e)
+  ensure
+    self
   end
 
   # Load standalone setup if present, else fallback to <code>bundler/setup</code>.
@@ -146,12 +146,12 @@ class Stibium::Bundled::Bundle
   # @see https://github.com/ruby/ruby/blob/0e40cc9b194a5e46024d32b85a61e651372a65cb/lib/bundler/setup.rb
   # @see https://github.com/ruby/ruby/blob/69ed64949b0c02d4b195809fa104ff23dd100093/lib/bundler.rb#L11
   # @see https://github.com/ruby/ruby/blob/69ed64949b0c02d4b195809fa104ff23dd100093/lib/bundler/rubygems_integration.rb
-  def setup(guards: [:locked, :installed])
-    self.standalone! do
-      guards.map { |s| self.public_send('%s?' % s.to_s.gsub(/\?$/, '')) }.tap do |results|
-        require 'bundler/setup' if results.uniq == [true]
+  def setup(guards: [:bundled, :installed])
+    self.tap do
+      unless guards.map { |s| self.public_send('%s?' % s.to_s.gsub(/\?$/, '')) }.include?(false)
+        standalone! { require 'bundler/setup' }
       end
-    end.yield_self { self }
+    end
   end
 
   # Standalone setup file.
@@ -166,12 +166,10 @@ class Stibium::Bundled::Bundle
   # @see #standalone!
   # @see https://bundler.io/v2.2/man/bundle-install.1.html#OPTIONS
   #
-  # @return [Pathname, nil]
+  # @return [Pathname]
   def bundler_setup
     Pathname.new(config.fetch('BUNDLE_PATH')).yield_self do |bundle_path|
-      (bundle_path.absolute? ? bundle_path : path.join(bundle_path)).join('bundler/setup.rb').yield_self do |file|
-        (file.file? and file.readable?) ? file : nil # rubocop:disable Style/TernaryParentheses
-      end
+      (bundle_path.absolute? ? bundle_path : path.join(bundle_path)).join('bundler/setup.rb')
     end
   end
 end

data/lib/stibium/bundled/bundle/config.rb

@@ -27,6 +27,11 @@ require_relative '../bundle'
 # @see .defaults
 class Stibium::Bundled::Bundle::Config < ::Hash
   autoload(:Pathname, 'pathname')
+  autoload(:YAML, 'yaml')
+
+  {
+    Reader: 'reader',
+  }.each { |k, v| autoload(k, "#{__dir__}/config/#{v}") }
 
   # @param basedir [String, Pathname]
   # @param env [Hash{String => String}]
@@ -63,9 +68,6 @@ class Stibium::Bundled::Bundle::Config < ::Hash
   end
 
   class << self
-    autoload(:Pathname, 'pathname')
-    autoload(:YAML, 'yaml')
-
     # Default config values (as seen from an empty environment).
     #
     # ```shell
@@ -114,9 +116,7 @@ class Stibium::Bundled::Bundle::Config < ::Hash
       env['HOME'].yield_self do |home_path|
         return {} if home_path.nil?
 
-        Pathname.new(home_path).expand_path.join('.bundle/config').yield_self do |file|
-          self.read(file, env: env)
-        end
+        Pathname.new(home_path).expand_path.join('.bundle/config').yield_self { |file| self.read(file, env: env) }
       end
     end
 
@@ -143,12 +143,7 @@ class Stibium::Bundled::Bundle::Config < ::Hash
     #
     # @return [Hash{String => Object}]
     def read(file, env: ENV.to_h)
-      return {} if env(source: env).key?('BUNDLE_IGNORE_CONFIG')
-
-      return {} unless file.file? and file.readable?
-
-      (file.read.yield_self { |content| YAML.safe_load(content) })
-        .transform_values { |v| v.is_a?(String) ? YAML.safe_load(v) : v }
+      Reader.new(env: env).read(file)
     end
   end
 end

data/lib/stibium/bundled/bundle/config/reader.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2020-2021 Dimitri Arrigoni <dimitri@arrigoni.me>
+# License GPLv3+: GNU GPL version 3 or later
+# <http://www.gnu.org/licenses/gpl.html>.
+# This is free software: you are free to change and redistribute it.
+# There is NO WARRANTY, to the extent permitted by law.
+
+require_relative '../config'
+
+# Config file reader.
+class Stibium::Bundled::Bundle::Config::Reader
+  autoload(:YAML, 'yaml')
+
+  # @return [Hash{String => String}]
+  attr_reader :env
+
+  def initialize(env: ENV.to_h)
+    self.tap do
+      @env = env.dup.map { |k, v| [k.freeze, v.freeze] }.to_h.freeze
+    end.freeze
+  end
+
+  # @return [Boolean]
+  def ignore_config?
+    env.key?('BUNDLE_IGNORE_CONFIG')
+  end
+
+  # Read given config file.
+  #
+  # @param file [Pathname]
+  #
+  # @return [Hash{String => Object}]
+  def read(file)
+    scrutinize(file).transform_values { |v| v.is_a?(String) ? YAML.safe_load(v) : v }
+  end
+
+  protected
+
+  # @api private
+  #
+  # @param file [Pathname]
+  #
+  # @return [Hash{String => Object}]
+  def scrutinize(file)
+    return {} if ignore_config?
+
+    return {} unless file.file? and file.readable?
+
+    file.read.yield_self { |content| YAML.safe_load(content) }
+  end
+end

data/lib/stibium/bundled/bundle/directory.rb

@@ -35,11 +35,14 @@ class Stibium::Bundled::Bundle::Directory
 
   # @return [Array<Pathname>]
   def specifications
-    [ruby_config.fetch(:engine), ruby_config.fetch(:version), 'specifications', '*.gemspec'].yield_self do |parts|
+    [
+      [ruby_config.fetch(:engine), ruby_config.fetch(:version), 'specifications', '*.gemspec'],
+      [ruby_config.fetch(:engine), ruby_config.fetch(:version), 'bundler', 'gems', '*/*.gemspec'],
+    ].map do |parts|
       self.path.join(*parts).yield_self do |s|
         Dir.glob(s).sort.map { |fp| Pathname.new(fp) }.keep_if(&:file?)
       end
-    end
+    end.flatten.sort
   end
 
   protected

data/lib/stibium/bundled/version.rb

@@ -7,8 +7,24 @@
 # There is NO WARRANTY, to the extent permitted by law.
 
 require_relative '../bundled'
-require 'kamaze/version'
 
 Stibium::Bundled.instance_eval do
-  self.const_set(:VERSION, Kamaze::Version.new.freeze)
+  autoload(:YAML, 'yaml')
+  autoload(:Pathname, 'pathname')
+
+  Pathname.new(__dir__).join('version.yml').tap do |file|
+    YAML.safe_load(file.read).yield_self do |v|
+      %w[major minor patch].map { |key| v.fetch(key) }.join('.')
+    end.tap do |version|
+      lambda do
+        require 'kamaze/version'
+      rescue LoadError
+        # :nocov:
+        version
+        # :nocov:
+      else
+        Kamaze::Version.new.freeze
+      end.tap { |func| self.const_set(:VERSION, func.call) }
+    end
+  end
 end

data/lib/stibium/bundled/version.yml

@@ -1,12 +1,12 @@
 ---
 major: 0
 minor: 0
-patch: 3
+patch: 4
 authors: ['Dimitri Arrigoni']
 email: 'dimitri@arrigoni.me'
-date: '2021-01-22'
+date: '2021-02-07'
 summary: 'Denote bundle state'
-description: 'Denote bundle state, based on conventions.'
+description: 'Denote bundle state and (optionally) load bundler/setup according to the configuration.'
 homepage: 'https://github.com/SwagDevOps/stibium-bundled'
 licenses: ['GPL-3.0']
 license_header: |

metadata

@@ -1,30 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: stibium-bundled
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Dimitri Arrigoni
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-22 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: kamaze-version
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-description: Denote bundle state, based on conventions.
+date: 2021-02-07 00:00:00.000000000 Z
+dependencies: []
+description: Denote bundle state and (optionally) load bundler/setup according to
+  the configuration.
 email: dimitri@arrigoni.me
 executables: []
 extensions: []
@@ -36,6 +23,7 @@ files:
 - lib/stibium/bundled.rb
 - lib/stibium/bundled/bundle.rb
 - lib/stibium/bundled/bundle/config.rb
+- lib/stibium/bundled/bundle/config/reader.rb
 - lib/stibium/bundled/bundle/directory.rb
 - lib/stibium/bundled/version.rb
 - lib/stibium/bundled/version.yml