toys-core 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b63889a0ce44a42d805bba363f2051c1b1f82c6c50e70138b35cab077441dcdd
-  data.tar.gz: 0403e5af7269879d468baae34bbae1664c1f83dfef4ec91c1545079502db5c86
+  metadata.gz: 1cf20d64fb78cfa559000a8007d3f0567db38d1c66ea220daaf8a33f1275fcad
+  data.tar.gz: da6b5f0f2e7d7bef30ded0a45b17014e0adc623583b7221f67b6b44fc9ca3805
 SHA512:
-  metadata.gz: 401d695bc0375db501df082733813925f229def58bea2b65f947c453b5b0f2989712b27c0a7d8f4d0f19c7e5f90293210a8c8755985a1584efae54bc35e90d2b
-  data.tar.gz: 258f2466dab53c45d1541f4608af756d9cddf3a7af555d1c11e329ad7de3cb9ce5e52831347cb417e97bb4628a6563220d2fc486669597c38df0f0184bd6aa89
+  metadata.gz: e429973defa957eb444c1395c9d6c235052f7f365978d216e7fc4633ebbb7361242ce649845304cd96c47d5227e563d79021c41bd0d2529e9d9b4695edb09ae6
+  data.tar.gz: 4cc2e28b0309130bd8c524a6ab3c17018e9160db4251225ad88aa082cf1ab1226eabda6d0e1ba8691d7ee2c107e8c6b4ea661265422d045a3a27692ce4b5745a

data/CHANGELOG.md

@@ -1,5 +1,36 @@
 # Release History
 
+### 0.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.
+
+### 0.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.
+
+### 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.
+
+### 0.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
 
 * FIXED: Setting `:exit_on_nonzero_status` explicitly to false now works as expected.

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-core.rb

@@ -58,6 +58,9 @@ module Toys
     #
     attr_accessor :executable_path
   end
+
+  # @private
+  CORE_LIB_PATH = __dir__
 end
 
 require "toys/acceptor"

data/lib/toys/compat.rb

@@ -16,21 +16,30 @@ module Toys
       ::RUBY_PLATFORM == "java"
     end
 
+    # @private
+    def self.windows?
+      ::RbConfig::CONFIG["host_os"] =~ /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+    end
+
     # @private
     def self.allow_fork?
-      !jruby? && ::RbConfig::CONFIG["host_os"] !~ /mswin/
+      !jruby? && !windows?
     end
 
     # @private
     def self.supports_suggestions?
       unless defined?(@supports_suggestions)
-        require "rubygems"
         begin
           require "did_you_mean"
-          @supports_suggestions = defined?(::DidYouMean::SpellChecker)
         rescue ::LoadError
-          @supports_suggestions = false
+          require "rubygems"
+          begin
+            require "did_you_mean"
+          rescue ::LoadError
+            # Oh well, it's not available
+          end
         end
+        @supports_suggestions = defined?(::DidYouMean::SpellChecker)
       end
       @supports_suggestions
     end

data/lib/toys/core.rb

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

data/lib/toys/dsl/tool.rb

@@ -1619,6 +1619,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.

data/lib/toys/loader.rb

@@ -8,6 +8,9 @@ module Toys
   # appropriate tool given a set of command line arguments.
   #
   class Loader
+    # @private
+    BASE_PRIORITY = -999_999
+
     ##
     # Create a Loader
     #
@@ -69,9 +72,11 @@ module Toys
       @worklist = []
       @tool_data = {}
       @max_priority = @min_priority = 0
+      @stop_priority = BASE_PRIORITY
+      @min_loaded_priority = 999_999
       @middleware_stack = Middleware.stack(middleware_stack)
       @delimiter_handler = DelimiterHandler.new(extra_delimiters)
-      get_tool([], -999_999)
+      get_tool([], BASE_PRIORITY)
     end
 
     ##
@@ -89,7 +94,7 @@ module Toys
         raise "Cannot add a path after tool loading has started" if @loading_started
         priority = high_priority ? (@max_priority += 1) : (@min_priority -= 1)
         paths.each do |path|
-          source = SourceInfo.create_path_root(path)
+          source = SourceInfo.create_path_root(path, @data_dir_name, @lib_dir_name)
           @worklist << [source, [], priority]
         end
       end
@@ -114,7 +119,7 @@ module Toys
       @mutex.synchronize do
         raise "Cannot add a block after tool loading has started" if @loading_started
         priority = high_priority ? (@max_priority += 1) : (@min_priority -= 1)
-        source = SourceInfo.create_proc_root(block, name)
+        source = SourceInfo.create_proc_root(block, name, @data_dir_name, @lib_dir_name)
         @worklist << [source, [], priority]
       end
       self
@@ -178,15 +183,15 @@ module Toys
       load_for_prefix(words)
       found_tools = []
       len = words.length
-      tool_data_snapshot.each do |n, td|
-        next if n.empty?
+      all_cur_definitions.each do |tool|
+        name = tool.full_name
+        next if name.empty?
         if recursive
-          next if n.length <= len || n.slice(0, len) != words
+          next if name.length <= len || name.slice(0, len) != words
         else
-          next unless n.slice(0..-2) == words
+          next unless name.slice(0..-2) == words
         end
-        tool = td.cur_definition
-        found_tools << tool unless tool.nil?
+        found_tools << tool
       end
       sort_tools_by_name(found_tools)
       include_hidden ? found_tools : filter_hidden_subtools(found_tools)
@@ -202,8 +207,9 @@ module Toys
     def has_subtools?(words) # rubocop:disable Naming/PredicateName
       load_for_prefix(words)
       len = words.length
-      tool_data_snapshot.each do |n, td|
-        if !n.empty? && n.length > len && n.slice(0, len) == words && !td.empty?
+      all_cur_definitions.each do |tool|
+        name = tool.full_name
+        if !name.empty? && name.length > len && name.slice(0, len) == words
           return true
         end
       end
@@ -267,6 +273,20 @@ module Toys
       Tool.new(self, parent, words, priority, middleware_stack, @middleware_lookup)
     end
 
+    ##
+    # Stop search at the given priority. Returns true if successful.
+    # Called only from the DSL.
+    #
+    # @private
+    #
+    def stop_loading_at_priority(priority)
+      @mutex.synchronize do
+        return false if priority > @min_loaded_priority || priority < @stop_priority
+        @stop_priority = priority
+        true
+      end
+    end
+
     ##
     # Loads the subtree under the given prefix.
     #
@@ -278,6 +298,7 @@ module Toys
         cur_worklist = @worklist
         @worklist = []
         cur_worklist.each do |source, words, priority|
+          next if priority < @stop_priority
           remaining_words = calc_remaining_words(prefix, words)
           if source.source_proc
             load_proc(source, words, remaining_words, priority)
@@ -349,8 +370,15 @@ module Toys
 
     private
 
-    def tool_data_snapshot
-      @mutex.synchronize { @tool_data.dup }
+    def all_cur_definitions
+      result = []
+      @mutex.synchronize do
+        @tool_data.map do |_name, td|
+          tool = td.cur_definition
+          result << tool unless tool.nil?
+        end
+      end
+      result
     end
 
     def get_tool_data(words)
@@ -364,14 +392,16 @@ module Toys
     def finish_definitions_in_tree(words)
       load_for_prefix(words)
       len = words.length
-      tool_data_snapshot.each do |n, td|
-        next if n.length < len || n.slice(0, len) != words
-        td.cur_definition&.finish_definition(self)
+      all_cur_definitions.each do |tool|
+        name = tool.full_name
+        next if name.length < len || name.slice(0, len) != words
+        tool.finish_definition(self)
       end
     end
 
     def load_proc(source, words, remaining_words, priority)
       if remaining_words
+        update_min_loaded_priority(priority)
         tool_class = get_tool(words, priority).tool_class
         DSL::Tool.prepare(tool_class, remaining_words, source) do
           ContextualError.capture("Error while loading Toys config!") do
@@ -393,6 +423,7 @@ module Toys
 
     def load_relevant_path(source, words, remaining_words, priority)
       if source.source_type == :file
+        update_min_loaded_priority(priority)
         tool_class = get_tool(words, priority).tool_class
         InputFile.evaluate(tool_class, remaining_words, source)
       else
@@ -406,7 +437,7 @@ module Toys
 
     def load_index_in(source, words, remaining_words, priority)
       return unless @index_file_name
-      index_source = source.relative_child(@index_file_name, @data_dir_name, @lib_dir_name)
+      index_source = source.relative_child(@index_file_name)
       load_relevant_path(index_source, words, remaining_words, priority) if index_source
     end
 
@@ -414,7 +445,7 @@ module Toys
       return if child.start_with?(".") || child == @index_file_name ||
                 child == @preload_file_name || child == @preload_dir_name ||
                 child == @data_dir_name || child == @lib_dir_name
-      child_source = source.relative_child(child, @data_dir_name, @lib_dir_name)
+      child_source = source.relative_child(child)
       return unless child_source
       child_word = ::File.basename(child, ".rb")
       next_words = words + [child_word]
@@ -422,6 +453,10 @@ module Toys
       load_validated_path(child_source, next_words, next_remaining, priority)
     end
 
+    def update_min_loaded_priority(priority)
+      @min_loaded_priority = priority if @min_loaded_priority > priority
+    end
+
     def do_preload(path)
       if @preload_file_name
         preload_file = ::File.join(path, @preload_file_name)
@@ -483,37 +518,42 @@ module Toys
     # @private
     #
     class ToolData
-      ## @private
+      # @private
       def initialize(words)
         @words = words
         @definitions = {}
         @top_priority = @active_priority = nil
+        @mutex = ::Monitor.new
       end
 
-      ## @private
+      # @private
       def cur_definition
-        active_definition || top_definition
+        @mutex.synchronize { active_definition || top_definition }
       end
 
-      ## @private
+      # @private
       def empty?
         @definitions.empty?
       end
 
-      ## @private
+      # @private
       def get_tool(priority, loader)
-        if @top_priority.nil? || @top_priority < priority
-          @top_priority = priority
+        @mutex.synchronize do
+          if @top_priority.nil? || @top_priority < priority
+            @top_priority = priority
+          end
+          @definitions[priority] ||= loader.build_tool(@words, priority)
         end
-        @definitions[priority] ||= loader.build_tool(@words, priority)
       end
 
-      ## @private
+      # @private
       def activate_tool(priority, loader)
-        return active_definition if @active_priority == priority
-        return nil if @active_priority && @active_priority > priority
-        @active_priority = priority
-        get_tool(priority, loader)
+        @mutex.synchronize do
+          return active_definition if @active_priority == priority
+          return nil if @active_priority && @active_priority > priority
+          @active_priority = priority
+          get_tool(priority, loader)
+        end
       end
 
       private

data/lib/toys/source_info.rb

@@ -10,7 +10,7 @@ module Toys
     # @private
     #
     def initialize(parent, context_directory, source_type, source_path, source_proc,
-                   source_name, data_dir, lib_dir)
+                   source_name, data_dir_name, lib_dir_name)
       @parent = parent
       @context_directory = context_directory
       @source_type = source_type
@@ -18,8 +18,10 @@ module Toys
       @source_path = source_path
       @source_proc = source_proc
       @source_name = source_name
-      @data_dir = data_dir
-      @lib_dir = lib_dir
+      @data_dir_name = data_dir_name
+      @lib_dir_name = lib_dir_name
+      @data_dir = find_special_dir(data_dir_name)
+      @lib_dir = find_special_dir(lib_dir_name)
     end
 
     ##
@@ -118,15 +120,13 @@ module Toys
     # Create a child SourceInfo relative to the parent path.
     # @private
     #
-    def relative_child(filename, data_dir_name, lib_dir_name)
-      raise "no parent path for relative_child" unless source_path
+    def relative_child(filename)
+      raise "relative_child is valid only on a directory source" unless source_type == :directory
       child_path = ::File.join(source_path, filename)
       child_path, type = SourceInfo.check_path(child_path, true)
       return nil unless child_path
-      data_dir = SourceInfo.find_special_dir(type, child_path, data_dir_name)
-      lib_dir = SourceInfo.find_special_dir(type, child_path, lib_dir_name)
-      SourceInfo.new(self, context_directory, type, child_path, source_proc, child_path,
-                     data_dir, lib_dir)
+      SourceInfo.new(self, context_directory, type, child_path, nil, child_path,
+                     @data_dir_name, @lib_dir_name)
     end
 
     ##
@@ -135,7 +135,8 @@ module Toys
     #
     def absolute_child(child_path)
       child_path, type = SourceInfo.check_path(child_path, false)
-      SourceInfo.new(self, context_directory, type, child_path, source_proc, child_path, nil, nil)
+      SourceInfo.new(self, context_directory, type, child_path, nil, child_path,
+                     @data_dir_name, @lib_dir_name)
     end
 
     ##
@@ -144,25 +145,26 @@ module Toys
     #
     def proc_child(child_proc, source_name = nil)
       source_name ||= self.source_name
-      SourceInfo.new(self, context_directory, :proc, source_path, child_proc, source_name, nil, nil)
+      SourceInfo.new(self, context_directory, :proc, source_path, child_proc, source_name,
+                     @data_dir_name, @lib_dir_name)
     end
 
     ##
     # Create a root source info for a file path.
     # @private
     #
-    def self.create_path_root(source_path)
+    def self.create_path_root(source_path, data_dir_name, lib_dir_name)
       source_path, type = check_path(source_path, false)
       context_directory = ::File.dirname(source_path)
-      new(nil, context_directory, type, source_path, nil, source_path, nil, nil)
+      new(nil, context_directory, type, source_path, nil, source_path, data_dir_name, lib_dir_name)
     end
 
     ##
     # Create a root source info for a proc.
     # @private
     #
-    def self.create_proc_root(source_proc, source_name)
-      new(nil, nil, :proc, nil, source_proc, source_name, nil, nil)
+    def self.create_proc_root(source_proc, source_name, data_dir_name, lib_dir_name)
+      new(nil, nil, :proc, nil, source_proc, source_name, data_dir_name, lib_dir_name)
     end
 
     ##
@@ -189,14 +191,11 @@ module Toys
       end
     end
 
-    ##
-    # Determine the data directory path, if any.
-    # @private
-    #
-    def self.find_special_dir(type, source_path, dir_name)
-      return nil if source_path.nil? || dir_name.nil?
-      source_path = ::File.dirname(source_path) if type == :file
-      dir = ::File.join(source_path, dir_name)
+    private
+
+    def find_special_dir(dir_name)
+      return nil if @source_type != :directory || dir_name.nil?
+      dir = ::File.join(@source_path, dir_name)
       dir if ::File.directory?(dir) && ::File.readable?(dir)
     end
   end