toys-core 0.10.4 → 0.11.3

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

data/lib/toys/standard_mixins/bundler.rb

@@ -11,32 +11,51 @@ module Toys
     #     defining the tool. If `false` (the default), installs the bundle just
     #     before the tool runs.
     #
-    #  *  `:groups` (Array<String>) The groups to include in setup
+    #  *  `:groups` (Array\<String\>) The groups to include in setup.
     #
-    #  *  `:search_dirs` (Array<String,Symbol>) Directories to search for a
-    #     Gemfile.
+    #  *  `:gemfile_path` (String) The path to the Gemfile to use. If `nil` or
+    #     not given, the `:search_dirs` will be searched for a Gemfile.
+    #
+    #  *  `:search_dirs` (String,Symbol,Array\<String,Symbol\>) Directories to
+    #     search for a Gemfile.
     #
     #     You can pass full directory paths, and/or any of the following:
-    #      *  `:context` - the current context directory
-    #      *  `:current` - the current working directory
-    #      *  `:toys` - the Toys directory containing the tool definition
+    #      *  `:context` - the current context directory.
+    #      *  `:current` - the current working directory.
+    #      *  `:toys` - the Toys directory containing the tool definition, and
+    #         any of its parents within the Toys directory hierarchy.
     #
     #     The default is to search `[:toys, :context, :current]` in that order.
+    #     See {DEFAULT_SEARCH_DIRS}.
+    #
+    #     For most directories, the bundler mixin will look for the files
+    #     ".gems.rb", "gems.rb", and "Gemfile", in that order. In `:toys`
+    #     directories, it will look only for ".gems.rb" and "Gemfile", in that
+    #     order. These can be overridden by setting the `:gemfile_names` and/or
+    #     `:toys_gemfile_names` arguments.
+    #
+    #  *  `:gemfile_names` (Array\<String\>) File names that are recognized as
+    #     Gemfiles when searching in directories other than Toys directories.
+    #     Defaults to {Toys::Utils::Gems::DEFAULT_GEMFILE_NAMES}.
+    #
+    #  *  `:toys_gemfile_names` (Array\<String\>) File names that are
+    #     recognized as Gemfiles when wearching in Toys directories.
+    #     Defaults to {DEFAULT_TOYS_GEMFILE_NAMES}.
     #
     #  *  `:on_missing` (Symbol) What to do if a needed gem is not installed.
     #
     #     Supported values:
-    #      *  `:confirm` - prompt the user on whether to install (default)
-    #      *  `:error` - raise an exception
-    #      *  `:install` - just install the gem
+    #      *  `:confirm` - prompt the user on whether to install (default).
+    #      *  `:error` - raise an exception.
+    #      *  `:install` - just install the gem.
     #
     #  *  `:on_conflict` (Symbol) What to do if bundler has already been run
     #     with a different Gemfile.
     #
     #     Supported values:
-    #      *  `:error` - raise an exception (default)
-    #      *  `:ignore` - just silently proceed without bundling again
-    #      *  `:warn` - print a warning and proceed without bundling again
+    #      *  `:error` - raise an exception (default).
+    #      *  `:ignore` - just silently proceed without bundling again.
+    #      *  `:warn` - print a warning and proceed without bundling again.
     #
     #  *  `:terminal` (Toys::Utils::Terminal) Terminal to use (optional)
     #  *  `:input` (IO) Input IO (optional, defaults to STDIN)
@@ -45,68 +64,106 @@ module Toys
     module Bundler
       include Mixin
 
-      on_initialize do |static: false, search_dirs: nil, **kwargs|
+      on_initialize do |static: false, **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)
+          context_directory = self[::Toys::Context::Key::CONTEXT_DIRECTORY]
+          source_info = self[::Toys::Context::Key::TOOL_SOURCE]
+          ::Toys::StandardMixins::Bundler.setup_bundle(context_directory, source_info, **kwargs)
         end
       end
 
-      on_include do |static: false, search_dirs: nil, **kwargs|
+      on_include do |static: false, **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)
+          ::Toys::StandardMixins::Bundler.setup_bundle(context_directory, source_info, **kwargs)
         end
       end
 
-      ## @private
-      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_dir
-          when :current
-            ::Dir.getwd
-          when :toys
-            toys_dir_stack(source_info)
-          when ::String
-            dir
-          else
-            raise ::ArgumentError, "Unrecognized search_dir: #{dir.inspect}"
-          end
-        end
-      end
+      ##
+      # Default search directories for Gemfiles.
+      # @return [Array<String,Symbol>]
+      #
+      DEFAULT_SEARCH_DIRS = [:toys, :context, :current].freeze
 
-      ## @private
-      def self.toys_dir_stack(source_info)
-        dirs = []
-        while source_info
-          dirs << source_info.source_path if source_info.source_type == :directory
-          source_info = source_info.parent
-        end
-        dirs
-      end
+      ##
+      # The gemfile names that are searched by default in Toys directories.
+      # @return [Array<String>]
+      #
+      DEFAULT_TOYS_GEMFILE_NAMES = [".gems.rb", "Gemfile"].freeze
 
-      ## @private
-      def self.setup_bundle(search_dirs,
+      # @private
+      def self.setup_bundle(context_directory,
+                            source_info,
+                            gemfile_path: nil,
+                            search_dirs: nil,
+                            gemfile_names: nil,
+                            toys_gemfile_names: nil,
                             groups: nil,
                             on_missing: nil,
                             on_conflict: nil,
                             terminal: nil,
                             input: nil,
                             output: nil)
+        require "toys/utils/gems"
+        gemfile_path ||= begin
+          gemfile_finder = GemfileFinder.new(context_directory, source_info,
+                                             gemfile_names, toys_gemfile_names)
+          gemfile_finder.search(search_dirs || DEFAULT_SEARCH_DIRS)
+        end
         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)
+        gems.bundle(groups: groups, gemfile_path: gemfile_path)
+      end
+
+      # @private
+      class GemfileFinder
+        # @private
+        def initialize(context_directory, source_info, gemfile_names, toys_gemfile_names)
+          @context_directory = context_directory
+          @source_info = source_info
+          @gemfile_names = gemfile_names
+          @toys_gemfile_names = toys_gemfile_names || DEFAULT_TOYS_GEMFILE_NAMES
+        end
+
+        # @private
+        def search(search_dir)
+          case search_dir
+          when ::Array
+            search_array(search_dir)
+          when ::String
+            ::Toys::Utils::Gems.find_gemfile(search_dir, gemfile_names: @gemfile_names)
+          when :context
+            search(@context_directory)
+          when :current
+            search(::Dir.getwd)
+          when :toys
+            search_toys
+          else
+            raise ::ArgumentError, "Unrecognized search_dir: #{dir.inspect}"
+          end
+        end
+
+        private
+
+        def search_array(search_dirs)
+          search_dirs.each do |search_dir|
+            result = search(search_dir)
+            return result if result
+          end
+          nil
+        end
+
+        def search_toys
+          source_info = @source_info
+          while source_info
+            if source_info.source_type == :directory
+              result = ::Toys::Utils::Gems.find_gemfile(source_info.source_path,
+                                                        gemfile_names: @toys_gemfile_names)
+              return result if result
+            end
+            source_info = source_info.parent
+          end
+          nil
+        end
       end
     end
   end