toys-core 0.10.3 → 0.10.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b02cdff2a475e8868e2b657c16ced39c83f8b729552408cc09a22060f783ca5
-  data.tar.gz: 5a0d9db1a99cc425de54f12ea8b888ef8d91a15e2991fcbc782a1a1e0e85c137
+  metadata.gz: 73bf616783bbde0d72f5f62c57437220208bb4e06d46feb6eeea4507aae386a6
+  data.tar.gz: 3e526d1a50a7d03b8d42ef762b7bae02b5964efbc18a0b029dd39362876ff689
 SHA512:
-  metadata.gz: c7547679c269c0b882a82e0704d8d664b9e75872e72ca9368b673118fc3d20948fe5ab1588fea0b0e2c1def7685e4e378ea537ec1b7809e60809fee25bc0baf4
-  data.tar.gz: e6767c8ae11fd7bfbadbc0b4bb23f86ee055b5832a67577dd4d72109e7e0d9a015d7d7d92612893e292e6257d89014c86aba6fcbd769701196748822cb4b6869
+  metadata.gz: 90100efa91c07240449b8da3ce72c358c4e09766afa80bdae044e0769586a6c890815e4c71786526fa00851d2fbc32db82fec586b01bf0bf9877ab17fb7b2867
+  data.tar.gz: f45936daa1ec21ee4d5531f5bda027a27cc45f4d99d678636d2c529fe1e0f1592130e5cddee5ffd25f8750487a92b8697f77f7a86d96f85cae63aa2840908f68

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release History
 
+### 0.10.4 / 2020-07-11
+
+* IMPROVED: Bundler integration can now handle Toys itself being in the bundle, as long as the version requirements cover the running Toys version.
+* IMPROVED: Passing `static: true` to the `:bundler` mixin installs the bundle at definition rather than execution time.
+
 ### 0.10.3 / 2020-07-04
 
 * FIXED: The `exec_separate_tool` method in the `:exec` mixin no longer throws ENOEXEC on Windows.

data/lib/toys/core.rb

@@ -9,7 +9,7 @@ module Toys
     # Current version of Toys core.
     # @return [String]
     #
-    VERSION = "0.10.3"
+    VERSION = "0.10.4"
   end
 
   ## @private deprecated

data/lib/toys/standard_mixins/bundler.rb

@@ -7,6 +7,10 @@ module Toys
     #
     # The following parameters can be passed when including this mixin:
     #
+    #  *  `:static` (Boolean) If `true`, installs the bundle immediately, when
+    #     defining the tool. If `false` (the default), installs the bundle just
+    #     before the tool runs.
+    #
     #  *  `:groups` (Array<String>) The groups to include in setup
     #
     #  *  `:search_dirs` (Array<String,Symbol>) Directories to search for a
@@ -41,32 +45,39 @@ module Toys
     module Bundler
       include Mixin
 
-      on_initialize do
-        |groups: nil,
-         search_dirs: nil,
-         on_missing: nil,
-         on_conflict: nil,
-         terminal: nil,
-         input: nil,
-         output: nil|
-        require "toys/utils/gems"
-        search_dirs = ::Toys::StandardMixins::Bundler.resolve_search_dirs(search_dirs, self)
-        gems = ::Toys::Utils::Gems.new(on_missing: on_missing, on_conflict: on_conflict,
-                                       terminal: terminal, input: input, output: output)
-        gems.bundle(groups: groups, search_dirs: search_dirs)
+      on_initialize do |static: false, search_dirs: nil, **kwargs|
+        unless static
+          require "toys/utils/gems"
+          search_dirs = ::Toys::StandardMixins::Bundler.resolve_search_dirs(
+            search_dirs,
+            self[::Toys::Context::Key::CONTEXT_DIRECTORY],
+            self[::Toys::Context::Key::TOOL_SOURCE]
+          )
+          ::Toys::StandardMixins::Bundler.setup_bundle(search_dirs, **kwargs)
+        end
+      end
+
+      on_include do |static: false, search_dirs: nil, **kwargs|
+        if static
+          require "toys/utils/gems"
+          search_dirs = ::Toys::StandardMixins::Bundler.resolve_search_dirs(
+            search_dirs, context_directory, source_info
+          )
+          ::Toys::StandardMixins::Bundler.setup_bundle(search_dirs, **kwargs)
+        end
       end
 
       ## @private
-      def self.resolve_search_dirs(search_dirs, context)
+      def self.resolve_search_dirs(search_dirs, context_dir, source_info)
         search_dirs ||= [:toys, :context, :current]
         Array(search_dirs).flat_map do |dir|
           case dir
           when :context
-            context[::Toys::Context::Key::CONTEXT_DIRECTORY]
+            context_dir
           when :current
             ::Dir.getwd
           when :toys
-            toys_dir_stack(context[::Toys::Context::Key::TOOL_SOURCE])
+            toys_dir_stack(source_info)
           when ::String
             dir
           else
@@ -84,6 +95,19 @@ module Toys
         end
         dirs
       end
+
+      ## @private
+      def self.setup_bundle(search_dirs,
+                            groups: nil,
+                            on_missing: nil,
+                            on_conflict: nil,
+                            terminal: nil,
+                            input: nil,
+                            output: nil)
+        gems = ::Toys::Utils::Gems.new(on_missing: on_missing, on_conflict: on_conflict,
+                                       terminal: terminal, input: input, output: output)
+        gems.bundle(groups: groups, search_dirs: search_dirs)
+      end
     end
   end
 end

data/lib/toys/utils/gems.rb

@@ -81,16 +81,22 @@ module Toys
       #
       # @param on_missing [:confirm,:error,:install] What to do if a needed gem
       #     is not installed. Possible values:
+      #
       #      *  `:confirm` - prompt the user on whether to install
       #      *  `:error` - raise an exception
       #      *  `:install` - just install the gem
+      #
       #     The default is `:confirm`.
+      #
       # @param on_conflict [:error,:warn,:ignore] What to do if bundler has
       #     already been run with a different Gemfile. Possible values:
+      #
       #      *  `:error` - raise an exception
       #      *  `:ignore` - just silently proceed without bundling again
       #      *  `:warn` - print a warning and proceed without bundling again
+      #
       #     The default is `:error`.
+      #
       # @param terminal [Toys::Utils::Terminal] Terminal to use (optional)
       # @param input [IO] Input IO (optional, defaults to STDIN)
       # @param output [IO] Output IO (optional, defaults to STDOUT)
@@ -146,8 +152,9 @@ module Toys
                  search_dirs: nil)
         Gems.synchronize do
           gemfile_path = find_gemfile(Array(search_dirs))
-          activate("bundler", "~> 2.1")
           if configure_gemfile(gemfile_path)
+            activate("bundler", "~> 2.1")
+            require "bundler"
             setup_bundle(gemfile_path, groups || [])
           end
         end
@@ -184,14 +191,14 @@ module Toys
             error.message.include?("Could not find")
           end
         if !is_missing_spec || @on_missing == :error
-          report_error(name, requirements, error)
+          report_activation_error(name, requirements, error)
           return
         end
         confirm_and_install_gem(name, requirements)
         begin
           gem(name, *requirements)
         rescue ::Gem::LoadError => e
-          report_error(name, requirements, e)
+          report_activation_error(name, requirements, e)
         end
       end
 
@@ -215,7 +222,7 @@ module Toys
         ::Gem::Specification.reset
       end
 
-      def report_error(name, requirements, err)
+      def report_activation_error(name, requirements, err)
         if ::ENV["BUNDLE_GEMFILE"]
           raise GemfileUpdateNeededError.new(gem_requirements_text(name, requirements),
                                              ::ENV["BUNDLE_GEMFILE"])
@@ -233,12 +240,14 @@ module Toys
 
       def configure_gemfile(gemfile_path)
         old_path = ::ENV["BUNDLE_GEMFILE"]
-        if old_path && gemfile_path != old_path
-          case @on_conflict
-          when :warn
-            terminal.puts("Warning: could not set up bundler because it is already set up.", :red)
-          when :error
-            raise AlreadyBundledError, "Could not set up bundler because it is already set up"
+        if old_path
+          if gemfile_path != old_path
+            case @on_conflict
+            when :warn
+              terminal.puts("Warning: could not set up bundler because it is already set up.", :red)
+            when :error
+              raise AlreadyBundledError, "Could not set up bundler because it is already set up"
+            end
           end
           return false
         end
@@ -247,21 +256,47 @@ module Toys
       end
 
       def setup_bundle(gemfile_path, groups)
-        require "bundler"
         begin
+          modify_bundle_definition(gemfile_path)
           ::Bundler.setup(*groups)
         rescue ::Bundler::GemNotFound
           restore_toys_libs
           install_bundle(gemfile_path)
           ::Bundler.reset!
+          modify_bundle_definition(gemfile_path)
           ::Bundler.setup(*groups)
         end
         restore_toys_libs
       end
 
+      def modify_bundle_definition(gemfile_path)
+        builder = ::Bundler::Dsl.new
+        builder.eval_gemfile(gemfile_path)
+        begin
+          builder.eval_gemfile(::File.join(__dir__, "gems", "gemfile.rb"))
+        rescue ::Bundler::Dsl::DSLError
+          terminal.puts(
+            "WARNING: Unable to integrate your Gemfile into the Toys runtime.\n" \
+            "When using the Toys Bundler integration features, do NOT list\n" \
+            "the toys or toys-core gems directly in your Gemfile. They can be\n" \
+            "dependencies of another gem, but cannot be listed directly.",
+            :red
+          )
+          return
+        end
+        toys_gems = ["toys-core"]
+        toys_gems << "toys" if ::Toys.const_defined?(:VERSION)
+        definition = builder.to_definition(gemfile_path + ".lock", { gems: toys_gems })
+        ::Bundler.instance_variable_set(:@definition, definition)
+      end
+
       def restore_toys_libs
+        $LOAD_PATH.delete(::Toys::CORE_LIB_PATH)
         $LOAD_PATH.unshift(::Toys::CORE_LIB_PATH)
-        $LOAD_PATH.unshift(::Toys::LIB_PATH) if ::Toys.const_defined?(:LIB_PATH)
+        if ::Toys.const_defined?(:LIB_PATH)
+          $LOAD_PATH.delete(::Toys::LIB_PATH)
+          $LOAD_PATH.unshift(::Toys::LIB_PATH)
+        end
       end
 
       def permission_to_bundle?
@@ -271,7 +306,8 @@ module Toys
         when :error
           false
         else
-          terminal.confirm("Your bundle is not complete. Install? ", default: @default_confirm)
+          terminal.confirm("Your bundle requires additional gems. Install? ",
+                           default: @default_confirm)
         end
       end
 

data/lib/toys/utils/gems/gemfile.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+unless defined?(@__toys_dev_gemspec)
+  gem("toys-core", ::Toys::Core::VERSION)
+  gem("toys", ::Toys::VERSION) if ::Toys.const_defined?(:VERSION)
+end

data/lib/toys/utils/terminal.rb

@@ -5,7 +5,7 @@ require "monitor"
 
 begin
   require "io/console"
-rescue ::LoadError # rubocop:disable Lint/SuppressedException
+rescue ::LoadError
   # TODO: alternate methods of getting terminal size
 end
 

metadata

@@ -1,141 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: toys-core
 version: !ruby/object:Gem::Version
-  version: 0.10.3
+  version: 0.10.4
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-04 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: did_you_mean
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: highline
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.14'
-- !ruby/object:Gem::Dependency
-  name: minitest-focus
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: minitest-rg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.1.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.1.2
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.79.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.79.0
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.24
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.24
+date: 2020-07-11 00:00:00.000000000 Z
+dependencies: []
 description: Toys-Core is the command line tool framework underlying Toys. It can
   be used to create command line executables using the Toys DSL and classes.
 email:
@@ -188,6 +62,7 @@ files:
 - lib/toys/utils/completion_engine.rb
 - lib/toys/utils/exec.rb
 - lib/toys/utils/gems.rb
+- lib/toys/utils/gems/gemfile.rb
 - lib/toys/utils/help_text.rb
 - lib/toys/utils/terminal.rb
 - lib/toys/wrappable_string.rb
@@ -198,7 +73,7 @@ metadata:
   changelog_uri: https://github.com/dazuma/toys/blob/master/toys-core/CHANGELOG.md
   source_code_uri: https://github.com/dazuma/toys
   bug_tracker_uri: https://github.com/dazuma/toys/issues
-  documentation_uri: https://dazuma.github.io/toys/gems/toys-core/v0.10.3
+  documentation_uri: https://dazuma.github.io/toys/gems/toys-core/v0.10.4
 post_install_message: 
 rdoc_options: []
 require_paths: