toys-core 0.23.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a09f479bfecbde001cec1076fdce57080117cbdeecfc2738879445a682b7363f
-  data.tar.gz: 277635722c80c2691759147cf7fc4b928755f0349a54fd970327c46bae443170
+  metadata.gz: fcfc1b86a084e30ed82bd6712d7c4e3d1c0e4754eb4b090181a00a1d0809810a
+  data.tar.gz: 8c8b9ec8d4186ff53e6a3d5a967db37c274bc5caa57da108207af6d5138f1458
 SHA512:
-  metadata.gz: 6cfaa55d28079f651f9eab9d8a693af1386ddc6d08e58553ab457c4c669265902da5bba6e0f336faa8113bf0a92b2fbbe2bde4b49480118fe1d63b00a38ba791
-  data.tar.gz: f8b6b6efcc6c978d1a1ce7cece9040eb5475eb7baa58c6b1527ba2dc5bb780c8401f30917e62fcc43999224ecd755b136d03d05d79c03fdc26622efc306e02d3
+  metadata.gz: 71071ccc6322724bac6c56d8ef7889588008a0b29a5119488815f1bc1073556392d0c0697c4762cdd118a93dc1cb605f38a94c81673dcbf7a8c0f756a6063cb6
+  data.tar.gz: 27b5e9b5b252e5db056ec9a7bb2bcba68fa8d8b1c8dc20ecdbf166ca1aae905d0a68c262bb9c3d3b3f69675c097c9b0f6612494bd61b445115d525d1aa167e6f

data/.yardopts

@@ -1,7 +1,6 @@
 --no-private
 --title=Toys Core
 --markup=markdown
---markup-provider redcarpet
 --main=README.md
 ./lib/toys/**/*.rb
 ./lib/toys-core.rb

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Release History
 
+### v0.24.0 / 2026-09-11
+
+Feature updates:
+
+* `SourceSpec::Gem` now includes optional `on_missing:` and `default_confirm:` fields to control how missing gems are handled.
+* The `load_gem` directive now takes optional `on_missing:` and `default_confirm:` arguments to control how missing gems are handled.
+* Passing options when activating a gem using the `:gems` mixin no longer clobbers options passed when instantiating the mixin.
+
+Removed some old deprecated items. (All technically breaking changes)
+
+* Removed deprecated `Toys::CORE_VERSION`. Use `Toys::Core::VERSION` instead.
+* Removed deprecated `alias_tool` directive. Pass `delegate_relative:` to the `tool` directive instead.
+* Removed deprecated `suppress_confirm:` argument to the `Gems` utility. Use `on_missing:` instead.
+
 ### v0.23.0 / 2026-09-09
 
 This is a major release, with several new features, a number of fixes, and a significant refactor of the tool loading and execution layers, including several breaking interface changes. It is a release candidate for the upcoming version 1.0.

data/lib/toys/core.rb

@@ -9,13 +9,6 @@ module Toys
     # Current version of Toys core.
     # @return [String]
     #
-    VERSION = "0.23.0"
+    VERSION = "0.24.0"
   end
-
-  ##
-  # Deprecated
-  #
-  # @private
-  #
-  CORE_VERSION = Core::VERSION
 end

data/lib/toys/dsl/tool.rb

@@ -329,39 +329,6 @@ module Toys
         self
       end
 
-      ##
-      # Create an alias, representing an "alternate name" for a tool.
-      #
-      # Note: This is functionally equivalent to creating a tool with the
-      # `:delegate_relative` option. As such, `alias_tool` is considered
-      # deprecated.
-      #
-      # ### Example
-      #
-      # This example defines a tool and an alias pointing to it. Both the tool
-      # name `test` and the alias `t` will then refer to the same tool.
-      #
-      #     tool "test" do
-      #       def run
-      #         puts "Running tests..."
-      #       end
-      #     end
-      #     alias_tool "t", "test"
-      #     # Note: the following is preferred over alias_tool:
-      #     # tool "t", delegate_relative: "test"
-      #
-      # @param word [String] The name of the alias
-      # @param target [String,Array<String>] Relative path to the target of the
-      #     alias. This path may be given as an array of strings, or a single
-      #     string possibly delimited by path separators.
-      # @return [self]
-      # @deprecated Use {#tool} and pass `:delegate_relative` instead
-      #
-      def alias_tool(word, target)
-        tool(word, delegate_relative: target)
-        self
-      end
-
       ##
       # Causes the current tool to delegate to another tool, specified by the
       # full tool name. When run, it simply invokes the target tool with the
@@ -508,6 +475,18 @@ module Toys
       #     Context directory paths should generally be absolute. Relative
       #     paths will be converted to absolute, using the current working
       #     directory at the time of loading.
+      # @param on_missing [:confirm,:error,:install] What to do if the
+      #     requested gem is not installed. Possible values:
+      #
+      #      *  `:confirm` - prompt the user on whether to install
+      #      *  `:error` - raise an exception
+      #      *  `:install` - just install the gem
+      #
+      #     Defaults to the setting in the {Toys::Utils::Gems} utility used to
+      #     activate the gem (usually `:confirm`).
+      # @param default_confirm [boolean] The default confirmation result, if
+      #     `on_missing` is set to `:confirm`. Defaults to the setting in the
+      #     {Toys::Utils::Gems} utility used to activate the gem (usually true).
       # @param as [String] Load into the given tool/namespace, relative to the
       #     current namespace. If omitted, tools will be loaded into the
       #     current namespace.
@@ -519,6 +498,8 @@ module Toys
                    path: nil,
                    toys_dir: nil,
                    context_directory: nil,
+                   on_missing: nil,
+                   default_confirm: nil,
                    as: nil)
         version = versions + Array(version)
         if as
@@ -527,7 +508,9 @@ module Toys
                      version: version,
                      path: path,
                      toys_dir: toys_dir,
-                     context_directory: context_directory)
+                     context_directory: context_directory,
+                     on_missing: on_missing,
+                     default_confirm: default_confirm)
           end
           return self
         end
@@ -535,7 +518,9 @@ module Toys
                               version: version,
                               path: path,
                               toys_dir: toys_dir,
-                              context_directory: context_directory)
+                              context_directory: context_directory,
+                              on_missing: on_missing,
+                              default_confirm: default_confirm)
         DSL::Internal.current_load_state(self).load_source(spec)
         self
       end

data/lib/toys/source_info.rb

@@ -345,6 +345,8 @@ module Toys
       end
 
       def resolve_gem_spec(spec, parent, priority, gems_util)
+        gems_util ||= default_gems_util
+        gems_util = gems_util.with(on_missing: spec.on_missing, default_confirm: spec.default_confirm)
         gem_version, gem_path, source_path =
           resolve_gem_info(gems_util, spec.name, spec.version, spec.path, spec.toys_dir)
         source_path, type = check_path(source_path, false)
@@ -486,7 +488,7 @@ module Toys
       def resolve_gem_info(gems_util, gem_name, gem_versions, gem_path, gem_toys_dir)
         require "toys/utils/gems"
         begin
-          (gems_util || default_gems_util).activate(gem_name, *gem_versions)
+          gems_util.activate(gem_name, *gem_versions)
         rescue ::Toys::Utils::Gems::ActivationFailedError => e
           raise ToolSourceError, e.message
         end

data/lib/toys/source_spec.rb

@@ -105,11 +105,25 @@ module Toys
       # @param source_name [String,nil] The source name that will be shown in
       #     documentation for tools loaded from this source. If omitted, a
       #     default is generated at resolution time.
+      # @param on_missing [:confirm,:error,:install] What to do if the
+      #     requested gem is not installed. Possible values:
+      #
+      #      *  `:confirm` - prompt the user on whether to install
+      #      *  `:error` - raise an exception
+      #      *  `:install` - just install the gem
+      #
+      #     Defaults to the setting in the {Toys::Utils::Gems} utility used to
+      #     activate the gem (usually `:confirm`).
+      # @param default_confirm [boolean] The default confirmation result, if
+      #     `on_missing` is set to `:confirm`. Defaults to the setting in the
+      #     {Toys::Utils::Gems} utility used to activate the gem (usually true).
+      #
       # @return [Toys::SourceSpec::Gem]
       # @raise [ArgumentError] if an argument is not a legal value.
       #
-      def gem(name, version: nil, path: nil, toys_dir: nil, context_directory: nil, source_name: nil)
-        Gem.new(name, version, path, toys_dir, context_directory, source_name)
+      def gem(name, version: nil, path: nil, toys_dir: nil, context_directory: nil, source_name: nil,
+              on_missing: nil, default_confirm: nil)
+        Gem.new(name, version, path, toys_dir, context_directory, source_name, on_missing, default_confirm)
       end
 
       ##
@@ -249,6 +263,16 @@ module Toys
       def check_optional_string(value, name)
         value.nil? ? nil : check_string(value, name)
       end
+
+      ##
+      # Returns the given value if it is equal to one of the given valid values,
+      # otherwise raise. The name is used only to describe the offending field
+      # in the error message.
+      #
+      def check_one_of(value, name, valid_values)
+        return value if valid_values.include?(value)
+        raise ::ArgumentError, "Illegal #{name} value: #{value.inspect}"
+      end
     end
 
     ##
@@ -385,11 +409,13 @@ module Toys
       #
       # @private
       #
-      def initialize(name, version, path, toys_dir, context_directory, source_name)
+      def initialize(name, version, path, toys_dir, context_directory, source_name, on_missing, default_confirm)
         @name = check_string(name, "name")
         @version = Array(version).map { |v| check_string(v, "version requirement") }.freeze
         @path = check_optional_string(path, "path")
         @toys_dir = check_optional_string(toys_dir, "toys_dir")
+        @on_missing = check_one_of(on_missing, "on_missing", [nil, :error, :confirm, :install])
+        @default_confirm = check_one_of(default_confirm, "default_confirm", [nil, true, false])
         super(context_directory, source_name)
       end
 
@@ -423,13 +449,31 @@ module Toys
       #
       attr_reader :toys_dir
 
+      ##
+      # What to do if the gem is not installed.
+      #
+      # @return [nil] to use the default behavior for the Gems util
+      # @return [:error] if an error should be raised
+      # @return [:confirm] if a confirmation prompt should be presented
+      # @return [:install] if the gem should be installed without confirmation
+      #
+      attr_reader :on_missing
+
+      ##
+      # The default response for a confirmation prompt
+      #
+      # @return [nil] to use the default behavior for the Gems util
+      # @return [boolean] to provide an override
+      #
+      attr_reader :default_confirm
+
       protected
 
       ##
       # @private
       #
       def equality_fields
-        super + [@name, @version, @path, @toys_dir]
+        super + [@name, @version, @path, @toys_dir, @on_missing, @default_confirm]
       end
     end
 

data/lib/toys/standard_mixins/gems.rb

@@ -80,8 +80,7 @@ module Toys
       # @raise [ActivationFailedError] if activation or install failed
       #
       def gem(name, *requirements, **options)
-        gems_util = options.empty? ? gems : Utils::Gems.new(**options)
-        gems_util.activate(name, *requirements)
+        gems.with(**options).activate(name, *requirements)
       end
 
       ##
@@ -114,8 +113,7 @@ module Toys
         # @raise [ActivationFailedError] if activation or install failed
         #
         def gem(name, *requirements, **options)
-          gems_util = options.empty? ? gems : Utils::Gems.new(**options)
-          gems_util.activate(name, *requirements)
+          gems.with(**options).activate(name, *requirements)
         end
       end
 

data/lib/toys/utils/gems.rb

@@ -160,7 +160,6 @@ module Toys
       #      *  `: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:
       #
@@ -169,40 +168,64 @@ module Toys
       #      *  `:warn` - print a warning and proceed without bundling again
       #
       #     The default is `:error`.
-      #
       # @param default_confirm [boolean] The default confirmation result, if
       #     `on_missing` is set to `:confirm`. Defaults to true.
       # @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)
-      # @param suppress_confirm [boolean] Deprecated. Use `on_missing` instead.
       #
       def initialize(on_missing: nil,
                      on_conflict: nil,
+                     default_confirm: nil,
                      terminal: nil,
                      input: nil,
-                     output: nil,
-                     suppress_confirm: nil,
-                     default_confirm: nil)
+                     output: nil)
         require "rubygems"
-        unless suppress_confirm.nil?
-          warn("The :suppress_confirm argument to Toys::Utils::Gems is deprecated. " \
-               "Use :on_missing instead.")
+        unless [nil, :confirm, :install, :error].include?(on_missing)
+          raise ::ArgumentError, "Illegal value for on_missing: #{on_missing.inspect}"
         end
-        default_confirm = true if default_confirm.nil?
-        @default_confirm = default_confirm ? true : false
-        @on_missing = on_missing ||
-                      if suppress_confirm
-                        @default_confirm ? :install : :error
-                      else
-                        :confirm
-                      end
+        unless [nil, :error, :warn, :ignore].include?(on_conflict)
+          raise ::ArgumentError, "Illegal value for on_conflict: #{on_conflict.inspect}"
+        end
+        unless [nil, true, false].include?(default_confirm)
+          raise ::ArgumentError, "Illegal value for default_confirm: #{default_confirm.inspect}"
+        end
+        @on_missing = on_missing || :confirm
         @on_conflict = on_conflict || :error
+        default_confirm = true if default_confirm.nil?
+        @default_confirm = default_confirm
+        # The terminal passed in is remembered separately from the one this
+        # object may later derive from the input and output, so that #with
+        # copies the former. Copying a derived terminal would silently defeat
+        # an input or output override.
+        @param_terminal = terminal
         @terminal = terminal
         @input = input || $stdin
         @output = output || $stdout
       end
 
+      ##
+      # Return a gem activator with the same settings as this one, except for
+      # the provided overrides. See the constructor for argument docs. If no
+      # non-nil overrides are provided, self is returned.
+      #
+      # @param overrides [Hash] Overrides. See the constructor for details.
+      # @return [Toys::Utils::Gems]
+      #
+      def with(**overrides)
+        overrides = overrides.compact
+        return self if overrides.empty?
+        current_settings = {
+          on_missing: @on_missing,
+          on_conflict: @on_conflict,
+          default_confirm: @default_confirm,
+          terminal: @param_terminal,
+          input: @input,
+          output: @output,
+        }
+        Gems.new(**current_settings, **overrides)
+      end
+
       ##
       # Activate the given gem. If it is not present, attempt to install it (or
       # inform the user to update the bundle).
@@ -262,7 +285,7 @@ module Toys
         raise GemfileNotFoundError, "Gemfile not found" unless gemfile_path
         gemfile_path = ::File.absolute_path(gemfile_path)
         Gems.synchronize do
-          setup_bundle(gemfile_path, groups: Array(groups), retries: retries)
+          setup_bundle(gemfile_path, Array(groups), retries)
         end
       end
 
@@ -369,7 +392,7 @@ module Toys
 
       # ---- Private methods as part of bundle install and setup ----
 
-      def setup_bundle(gemfile_path, groups: nil, retries: nil)
+      def setup_bundle(gemfile_path, groups, retries)
         configure_gemfile(gemfile_path) do
           activate_bundler
           check_gemfile_compatibility(gemfile_path)
@@ -391,7 +414,7 @@ module Toys
         rescue *bundler_exceptions
           ::Bundler.reset!
           restore_toys_libs
-          install_result = install_bundle(modified_gemfile_path, retries: retries)
+          install_result = install_bundle(modified_gemfile_path, retries)
           attempt_setup_bundle(modified_gemfile_path, groups)
           result = install_result
         ensure
@@ -702,7 +725,7 @@ module Toys
         end
       end
 
-      def install_bundle(gemfile_path, retries: nil)
+      def install_bundle(gemfile_path, retries)
         gemfile_dir = ::File.dirname(gemfile_path)
         unless permission_to_bundle?
           raise BundleNotInstalledError,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: toys-core
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.24.0
 platform: ruby
 authors:
 - Daniel Azuma
@@ -99,10 +99,10 @@ homepage: https://github.com/dazuma/toys
 licenses:
 - MIT
 metadata:
-  changelog_uri: https://dazuma.github.io/toys/gems/toys-core/v0.23.0/file.CHANGELOG.html
-  source_code_uri: https://github.com/dazuma/toys/tree/toys-core/v0.23.0/toys-core
+  changelog_uri: https://dazuma.github.io/toys/gems/toys-core/v0.24.0/file.CHANGELOG.html
+  source_code_uri: https://github.com/dazuma/toys/tree/toys-core/v0.24.0/toys-core
   bug_tracker_uri: https://github.com/dazuma/toys/issues
-  documentation_uri: https://dazuma.github.io/toys/gems/toys-core/v0.23.0
+  documentation_uri: https://dazuma.github.io/toys/gems/toys-core/v0.24.0
 rdoc_options: []
 require_paths:
 - lib