toys-core 0.10.4 → 0.11.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73bf616783bbde0d72f5f62c57437220208bb4e06d46feb6eeea4507aae386a6
-  data.tar.gz: 3e526d1a50a7d03b8d42ef762b7bae02b5964efbc18a0b029dd39362876ff689
+  metadata.gz: 2345d22178ad2ca256a6099f3b359abaf6641248c3a29256000e40204c618802
+  data.tar.gz: e9874795dd5057d7eca70164f221ec923c0ac17862146f1a9f15cba3c1cfc4e8
 SHA512:
-  metadata.gz: 90100efa91c07240449b8da3ce72c358c4e09766afa80bdae044e0769586a6c890815e4c71786526fa00851d2fbc32db82fec586b01bf0bf9877ab17fb7b2867
-  data.tar.gz: f45936daa1ec21ee4d5531f5bda027a27cc45f4d99d678636d2c529fe1e0f1592130e5cddee5ffd25f8750487a92b8697f77f7a86d96f85cae63aa2840908f68
+  metadata.gz: 852717f2545a44143185d168c374d871ba9495ccece98161b880d8fdf75b0f5929a97998f3d193c700963717c406567f3f365d73f9c6ad5af13270317b2a5a74
+  data.tar.gz: 3c2bb70a9512f058a9ead3feb55c4c658f7ac3357c51f39c47cb9bef081c1c5f876d08f8f45a2d0d716e6a884d22b156c64664177306041e85e411a18075ebd0

data/CHANGELOG.md

@@ -1,23 +1,53 @@
 # Release History
 
-### 0.10.4 / 2020-07-11
+### v0.11.3 / 2020-09-13
+
+* FIXED: The Exec library recognizes the argv0 option, and logs it appropriately 
+
+### v0.11.2 / 2020-09-06
+
+* FIXED: Fix a JRuby-specific race condition when capturing exec streams 
+
+### v0.11.1 / 2020-08-24
+
+* DOCS: Minor documentation tweaks.
+
+### v0.11.0 / 2020-08-21
+
+* ADDED: The load path can be truncated using the `truncate_load_path!` directive.
+* IMPROVED: Generated help for delegates now includes the information for the target tool, plus subtools of the delegate.
+* IMPROVED: The `:bundler` mixin searches for `gems.rb` and `.gems.rb` in addition to `Gemfile`.
+* IMPROVED: The `:budnler` mixin can load a specific Gemfile path.
+* FIXED: The loader can now find data and lib directories at the root level of a Toys directory.
+* FIXED: Exec::Result correctly reports processes that terminated due to signals.
+* FIXED: Fixed a rare Exec capture failure that resulted from a race condition when closing streams.
+
+### v0.10.5 / 2020-07-18
+
+* IMPROVED: The bundler mixin silences bundler output during bundle setup.
+* IMPROVED: The bundler mixin allows toys and toys-core to be in the Gemfile. It checks their version requirements against the running Toys version, and either adds the corret version to the bundle or raises IncompatibleToysError.
+* IMPROVED: The bundler mixin automatically updates the bundle if install fails (typically because a transitive dependency has been explicitly updated.)
+* FIXED: Some cases of transitive dependency handling by the bundler mixin.
+* FIXED: Fixed a crash when computing suggestions, when running with a bundle on Ruby 2.6 or earlier.
+
+### v0.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
+### v0.10.3 / 2020-07-04
 
 * FIXED: The `exec_separate_tool` method in the `:exec` mixin no longer throws ENOEXEC on Windows.
 
-### 0.10.2 / 2020-07-03
+### v0.10.2 / 2020-07-03
 
 * FIXED: The load path no longer loses the toys and toys-core directories after a bundle install.
 
-### 0.10.1 / 2020-03-07
+### v0.10.1 / 2020-03-07
 
 * FIXED: Setting `:exit_on_nonzero_status` explicitly to false now works as expected.
 
-### 0.10.0 / 2020-02-24
+### v0.10.0 / 2020-02-24
 
 Functional changes:
 
@@ -47,16 +77,16 @@ Internal interface changes:
 * CHANGED: `Toys::CLI.default_logger` removed and replaced with `Toys::CLI.default_logger_factory`. In general, global loggers for CLI are now discouraged because they are not thread-safe.
 * CHANGED: `Toys::Loader` uses an internal monitor rather than including `MonitorMixin`.
 
-### 0.9.4 / 2020-01-26
+### v0.9.4 / 2020-01-26
 
 * FIXED: Crash in the loader when a non-ruby file appears in a toys directory
 
-### 0.9.3 / 2020-01-05
+### v0.9.3 / 2020-01-05
 
 * FIXED: `delegate_to` directive could crash if an overriding tool has already been defined.
 * FIXED: A Ruby 2.7 warning when reporting a Toys file syntax error.
 
-### 0.9.2 / 2020-01-03
+### v0.9.2 / 2020-01-03
 
 * IMPROVED: Mixins can now take real keyword arguments, and will pass them on properly to `on_initialize` and `on_include` blocks.
 * CHANGED: `Toys::Utils::Exec` and the `:exec` mixin methods now take real keyword arguments rather than an `opts` hash. This means you should use keywords (or the double-splat operator) to avoid a deprecation warning on Ruby 2.7.
@@ -64,11 +94,11 @@ Internal interface changes:
 * IMPROVED: `Toys::Loader` is now thread-safe. This means it is now possible for a single `Toys::CLI` to run multiple tools in different threads.
 * IMPROVED: There is now a class for middleware specs, making possible a nicer syntax for building a middleware stack.
 
-### 0.9.1 / 2019-12-22
+### v0.9.1 / 2019-12-22
 
 * IMPROVED: `delegate_to` and `alias_tool` can take symbols as well as strings.
 
-### 0.9.0 / 2019-12-02
+### v0.9.0 / 2019-12-02
 
 Functional changes:
 
@@ -91,12 +121,12 @@ Internal interface changes:
 * ADDED: `Toys::Tool#delegate_to` causes the tool to delegate to another tool.
 * ADDED: The `Toys::Context::Key::DELEGATED_FROM` key provides the delegating context, if any.
 
-### 0.8.1 / 2019-11-19
+### v0.8.1 / 2019-11-19
 
 * FIXED: Listing subtools would crash if a broken alias was present.
 * DOCUMENTATION: Switched from redcarpet to kramdown, and tried to make some structural fixes.
 
-### 0.8.0 / 2019-06-20
+### v0.8.0 / 2019-06-20
 
 This is a major update with significant new features and a bunch of fixes. It also includes a significant amount of internal reorganization and cleanup, some of which resulted in backward incompatible changes. Basic use should not be affected. All signifiant features planned for beta are now implemented.
 
@@ -195,17 +225,17 @@ Changes to internal interfaces:
     * ADDED: Range acceptor (`Acceptor::Range`) which validates against a range.
     * ADDED: Class methods `Acceptor.create` and `Acceptor.lookup_well_known`.
 
-### 0.7.0 / 2019-01-23
+### v0.7.0 / 2019-01-23
 
 * ADDED: Flag groups, which enforce policies around which flags are required.
 * CHANGED: Flags within a group are sorted in help screens.
 * CHANGED: Canonical flag within a flag definition is now the first rather than the last.
 
-### 0.6.1 / 2019-01-07
+### v0.6.1 / 2019-01-07
 
 * FIXED: The presence of aliases caused subtool listing to crash.
 
-### 0.6.0 / 2018-10-22
+### v0.6.0 / 2018-10-22
 
 * CHANGED: Replaced Toys::Definition::DataFinder with Toys::Definition::SourceInfo.
 * CHANGED: Removed Toys::Definition#find_data. Use Toys::Definition#source_info and call find_data.
@@ -214,7 +244,7 @@ Changes to internal interfaces:
   from subtool lists.
 * IMPROVED: Optionally omit non-runnable namespaces from recursive subtool lists.
 
-### 0.5.0 / 2018-10-07
+### v0.5.0 / 2018-10-07
 
 * FIXED: Template instantiation was failing if the hosting tool was priority-masked.
 * ADDED: Several additional characters can optionally be used as tool path delimiters.
@@ -224,31 +254,31 @@ Changes to internal interfaces:
 * IMPROVED: The tool directive can now take an array as the tool name.
 * IMPROVED: The tool directive can now take an `if_defined` argument.
 
-### 0.4.5 / 2018-08-05
+### v0.4.5 / 2018-08-05
 
 * CHANGED: Dropped preload file feature
 
-### 0.4.4 / 2018-07-21
+### v0.4.4 / 2018-07-21
 
 * FIXED: Utils::Exec wasn't closing streams after copying.
 * IMPROVED: Utils::Exec::Controller can capture or redirect the remainder of a controlled stream.
 * ADDED: Terminal#ask
 
-### 0.4.3 / 2018-07-13
+### v0.4.3 / 2018-07-13
 
 * IMPROVED: Utils::Exec methods can now spawn subprocesses in the background
 * IMPROVED: Utils::Exec capture methods can now yield a controller
 
-### 0.4.2 / 2018-07-08
+### v0.4.2 / 2018-07-08
 
 * FIXED: Raise an error rather than cause unexpected behavior if a mixin is included twice.
 * IMPROVED: The `include?` method extended to support mixin names in a tool dsl.
 
-### 0.4.1 / 2018-07-03
+### v0.4.1 / 2018-07-03
 
 * FIXED: Terminal#confirm uppercased "N" for the wrong default.
 
-### 0.4.0 / 2018-07-03
+### v0.4.0 / 2018-07-03
 
 Now declaring this alpha quality. Backward-incompatible changes are still
 possible from this point, but I'll try to avoid them.
@@ -260,13 +290,13 @@ possible from this point, but I'll try to avoid them.
 * IMPROVED: Utils::Gems installation is now much faster.
 * FIXED: Utils::Gems didn't reset the specifications on Ruby 2.3.
 
-### 0.3.11 / 2018-07-02
+### v0.3.11 / 2018-07-02
 
 * CHANGED: Require Ruby 2.3 or later
 * CHANGED: Renamed "set" directive to "static" to reduce confusion with Tool#set.
 * ADDED: Convenience methods for getting option values
 
-### 0.3.10 / 2018-06-30
+### v0.3.10 / 2018-06-30
 
 * CHANGED: Dropped Tool#option. Use Tool#get instead.
 * CHANGED: "run" directive renamed to "to_run"
@@ -275,11 +305,11 @@ possible from this point, but I'll try to avoid them.
 * ADDED: Mixins can provide initializers
 * ADDED: Loader can load an inline block
 
-### 0.3.9.1 / 2018-06-24
+### v0.3.9.1 / 2018-06-24
 
 * FIXED: Built-in flags were interfering with disable_argument_parsing
 
-### 0.3.9 / 2018-06-24
+### v0.3.9 / 2018-06-24
 
 * CHANGED: Cli#add_search_path_hierarchy changed the behavior of the base/terminate param
 * CHANGED: Removed alias_as directive since it's incompatible with selective loading.
@@ -288,7 +318,7 @@ possible from this point, but I'll try to avoid them.
 * ADDED: Exec#exec_proc and Exec#exec_tool that supports all the stream redirects
 * IMPROVED: Acceptors can be looked up recursively in the same way as mixins and templates
 
-### 0.3.8 / 2018-06-10
+### v0.3.8 / 2018-06-10
 
 * CHANGED: Renamed helpers to mixins.
 * CHANGED: ModuleLookup is now a customizable class and can have multiple sources.
@@ -298,11 +328,11 @@ possible from this point, but I'll try to avoid them.
 * IMPROVED: Exec raises an error if passed an unknown option.
 * IMPROVED: Exec now accepts nearly all the same stream specifications as Process#spawn.
 
-### 0.3.7.1 / 2018-05-30
+### v0.3.7.1 / 2018-05-30
 
 * No changes.
 
-### 0.3.7 / 2018-05-30
+### v0.3.7 / 2018-05-30
 
 * CHANGED: Execution runs in the same scope as the DSL, which lets us use normal methods instead of helper-blocks.
 * CHANGED: Renamed "script" to "run", and allow setting of runnable by defining a "run" method
@@ -315,7 +345,7 @@ possible from this point, but I'll try to avoid them.
 * ADDED: Helper modules scoped to the tool hierarchy
 * ADDED: Utility that installs and activates third-party gems.
 
-### 0.3.6 / 2018-05-21
+### v0.3.6 / 2018-05-21
 
 * CHANGED: Renamed show_version middleware to show_root_version.
 * CHANGED: Reworked set_default_descriptions interface for more flexibility.
@@ -327,14 +357,14 @@ possible from this point, but I'll try to avoid them.
 * IMPROVED: Support custom acceptors.
 * IMPROVED: Highline helper automatically sets use_color based on the type of stdout.
 
-### 0.3.5 / 2018-05-15
+### v0.3.5 / 2018-05-15
 
 * CHANGED: Exec logic now lives in a utils class.
 * CHANGED: Moved flag and arg blocks from Tool into the DSL.
 * CHANGED: Renamed `execute do` to `script do`, and Tool#executor to Tool#script.
 * IMPROVED: Help display can use `less` if available.
 
-### 0.3.4 / 2018-05-14
+### v0.3.4 / 2018-05-14
 
 * CHANGED: Renamed switch to flag
 * CHANGED: Renamed Utils::Usage to Utils::HelpText
@@ -356,7 +386,7 @@ possible from this point, but I'll try to avoid them.
 * ADDED: Alias DSL methods `required`, `optional`, and `remaining`.
 * FIXED: Finish definitions for subtools since the desc may depend on it
 
-### 0.3.3 / 2018-05-09
+### v0.3.3 / 2018-05-09
 
 * CHANGED: Renamed file_utils helper to fileutils.
 * CHANGED: Renamed `doc:` parameter to `docs:`.
@@ -369,7 +399,7 @@ possible from this point, but I'll try to avoid them.
 * IMPROVED: Usage can now customize the left column width and indent
 * IMPROVED: Newlines in documentation are properly indented
 
-### 0.3.2 / 2018-05-07
+### v0.3.2 / 2018-05-07
 
 * CHANGED: Split core engine out into "toys-core" from the "toys" gem.
 * CHANGED: Renamed path types to "search" and "config" paths, and restricted the former to the CLI.

data/README.md

@@ -258,7 +258,7 @@ itself. However, the `toys-core` gem is a dependency, and your users will need
 to have it installed. You could alleviate this by wrapping your executable in a
 gem that can declare `toys-core` as a dependency explicitly.
 
-The [examples directory](https://github.com/dazuma/toys/tree/master/toys-core/examples)
+The [examples directory](https://github.com/dazuma/toys/tree/main/toys-core/examples)
 includes a few simple examples that you can use as a starting point.
 
 To experiment with the examples, clone the Toys repo from GitHub:
@@ -272,7 +272,7 @@ Navigate to the simple-gem example:
 
 This example wraps the simple "greet" executable that we
 [covered earlier](#Add_some_functionality) in a gem. You can see the
-[executable file](https://github.com/dazuma/toys/tree/master/toys-core/examples/simple-gem/bin/toys-core-simple-example)
+[executable file](https://github.com/dazuma/toys/tree/main/toys-core/examples/simple-gem/bin/toys-core-simple-example)
 in the bin directory.
 
 Try it out by building and installing the gem. From the `examples/simple-gem`
@@ -297,16 +297,16 @@ break it up into multiple files. The multi-file gem example demonstrates this.
     $ cd ../multi-file-gem
 
 This executable's implementation resides in its
-[lib directory](https://github.com/dazuma/toys/tree/master/toys-core/examples/multi-file-gem/lib),
+[lib directory](https://github.com/dazuma/toys/tree/main/toys-core/examples/multi-file-gem/lib),
 a technique that may be familiar to writers of command line executables. More
 interestingly, the tools themselves are no longer defined in a block passed to
 the CLI object, but have been moved into a separate
-["tools" directory](https://github.com/dazuma/toys/tree/master/toys-core/examples/multi-file-gem/tools).
+["tools" directory](https://github.com/dazuma/toys/tree/main/toys-core/examples/multi-file-gem/tools).
 This directory has the same structure and supports the same features that are
 available when writing complex sets of tools in a `.toys` directory. You then
 configure the CLI object to look in this directory for its tools definitions,
 as you can see in
-[the code](https://github.com/dazuma/toys/tree/master/toys-core/examples/multi-file-gem/lib/toys-core-multi-gem-example.rb).
+[the code](https://github.com/dazuma/toys/tree/main/toys-core/examples/multi-file-gem/lib/toys-core-multi-gem-example.rb).
 
 Try it out now. From the `examples/multi-file-gem` directory, run:
 

data/docs/guide.md

@@ -1,4 +1,6 @@
+<!--
 # @title Toys-Core User Guide
+-->
 
 # Toys-Core User Guide
 

data/lib/toys/acceptor.rb

@@ -498,7 +498,7 @@ module Toys
       #     well-known acceptor.
       #
       # @param spec [Object] See the description for recognized values.
-      # @param options [Hash] Additional options to pass to the completion.
+      # @param options [Hash] Additional options to pass to the acceptor.
       # @param block [Proc] See the description for recognized forms.
       # @return [Toys::Acceptor::Base,Proc]
       #

data/lib/toys/compat.rb

@@ -33,7 +33,11 @@ module Toys
           require "did_you_mean"
         rescue ::LoadError
           require "rubygems"
-          require "did_you_mean" rescue nil # rubocop:disable Style/RescueModifier
+          begin
+            require "did_you_mean"
+          rescue ::LoadError
+            # Oh well, it's not available
+          end
         end
         @supports_suggestions = defined?(::DidYouMean::SpellChecker)
       end

data/lib/toys/core.rb

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

data/lib/toys/dsl/flag.rb

@@ -75,8 +75,8 @@ module Toys
       #     string (e.g. `"foo"`) is taken as the value. Otherwise, the
       #     following argument is taken as the value (e.g. for `--abc foo`, the
       #     value is set to `"foo"`.) The following argument is treated as the
-      #     value even if it looks like a flag (e.g. `--abc --abc` causes the
-      #     string `"--abc"` to be taken as the value.)
+      #     value even if it looks like a flag (e.g. `--abc --def` causes the
+      #     string `"--def"` to be taken as the value.)
       #  *  `--abc[=VAL]` : A long flag that takes an optional value. If this
       #     argument appears with a value attached (e.g. `--abc=foo`), the
       #     attached string (e.g. `"foo"`) is taken as the value. Otherwise,

data/lib/toys/dsl/flag_group.rb

@@ -79,8 +79,8 @@ module Toys
       #     string (e.g. `"foo"`) is taken as the value. Otherwise, the
       #     following argument is taken as the value (e.g. for `--abc foo`, the
       #     value is set to `"foo"`.) The following argument is treated as the
-      #     value even if it looks like a flag (e.g. `--abc --abc` causes the
-      #     string `"--abc"` to be taken as the value.)
+      #     value even if it looks like a flag (e.g. `--abc --def` causes the
+      #     string `"--def"` to be taken as the value.)
       #  *  `--abc[=VAL]` : A long flag that takes an optional value. If this
       #     argument appears with a value attached (e.g. `--abc=foo`), the
       #     attached string (e.g. `"foo"`) is taken as the value. Otherwise,

data/lib/toys/dsl/tool.rb

@@ -814,8 +814,8 @@ module Toys
       #     string (e.g. `"foo"`) is taken as the value. Otherwise, the
       #     following argument is taken as the value (e.g. for `--abc foo`, the
       #     value is set to `"foo"`.) The following argument is treated as the
-      #     value even if it looks like a flag (e.g. `--abc --abc` causes the
-      #     string `"--abc"` to be taken as the value.)
+      #     value even if it looks like a flag (e.g. `--abc --def` causes the
+      #     string `"--def"` to be taken as the value.)
       #  *  `--abc[=VAL]` : A long flag that takes an optional value. If this
       #     argument appears with a value attached (e.g. `--abc=foo`), the
       #     attached string (e.g. `"foo"`) is taken as the value. Otherwise,
@@ -884,7 +884,8 @@ module Toys
       # @param flags [String...] The flags in OptionParser format.
       # @param accept [Object] An acceptor that validates and/or converts the
       #     value. You may provide either the name of an acceptor you have
-      #     defined, or one of the default acceptors provided by OptionParser.
+      #     defined, one of the default acceptors provided by OptionParser, or
+      #     any other specification recognized by {Toys::Acceptor.create}.
       #     Optional. If not specified, accepts any value as a string.
       # @param default [Object] The default value. This is the value that will
       #     be set in the context if this flag is not provided on the command
@@ -979,7 +980,8 @@ module Toys
       #     the execution context.
       # @param accept [Object] An acceptor that validates and/or converts the
       #     value. You may provide either the name of an acceptor you have
-      #     defined, or one of the default acceptors provided by OptionParser.
+      #     defined, one of the default acceptors provided by OptionParser, or
+      #     any other specification recognized by {Toys::Acceptor.create}.
       #     Optional. If not specified, accepts any value as a string.
       # @param complete [Object] A specifier for shell tab completion for
       #     values of this arg. This is the empty completion by default. To
@@ -1050,7 +1052,8 @@ module Toys
       #     line. Defaults to `nil`.
       # @param accept [Object] An acceptor that validates and/or converts the
       #     value. You may provide either the name of an acceptor you have
-      #     defined, or one of the default acceptors provided by OptionParser.
+      #     defined, one of the default acceptors provided by OptionParser, or
+      #     any other specification recognized by {Toys::Acceptor.create}.
       #     Optional. If not specified, accepts any value as a string.
       # @param complete [Object] A specifier for shell tab completion for
       #     values of this arg. This is the empty completion by default. To
@@ -1121,7 +1124,8 @@ module Toys
       #     command line. Defaults to the empty array `[]`.
       # @param accept [Object] An acceptor that validates and/or converts the
       #     value. You may provide either the name of an acceptor you have
-      #     defined, or one of the default acceptors provided by OptionParser.
+      #     defined, one of the default acceptors provided by OptionParser, or
+      #     any other specification recognized by {Toys::Acceptor.create}.
       #     Optional. If not specified, accepts any value as a string.
       # @param complete [Object] A specifier for shell tab completion for
       #     values of this arg. This is the empty completion by default. To
@@ -1619,6 +1623,23 @@ module Toys
         self
       end
 
+      ##
+      # Remove lower-priority sources from the load path. This prevents lower-
+      # priority sources (such as Toys files from parent or global directories)
+      # from executing or defining tools.
+      #
+      # This works only if no such sources have already loaded yet.
+      #
+      # @raise [Toys::ToolDefinitionError] if any lower-priority tools have
+      #     already been loaded.
+      #
+      def truncate_load_path!
+        unless @__loader.stop_loading_at_priority(@__priority)
+          raise ToolDefinitionError,
+                "Cannot truncate load path because tools have already been loaded"
+        end
+      end
+
       ##
       # Determines whether the current Toys version satisfies the given
       # requirements.