toys-core 0.7.0 → 0.8.0

data/lib/toys/flag_group.rb

@@ -0,0 +1,282 @@
+# frozen_string_literal: true
+
+# Copyright 2019 Daniel Azuma
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+;
+
+module Toys
+  ##
+  # A FlagGroup is a group of flags with the same requirement settings.
+  #
+  module FlagGroup
+    ##
+    # Create a flag group object of the given type.
+    #
+    # The type should be one of the following symbols:
+    #  *  `:optional` All flags in the group are optional
+    #  *  `:required` All flags in the group are required
+    #  *  `:exactly_one` Exactly one flag in the group must be provided
+    #  *  `:at_least_one` At least one flag in the group must be provided
+    #  *  `:at_most_one` At most one flag in the group must be provided
+    #
+    # @param type [Symbol] The type of group. Default is `:optional`.
+    # @param desc [String,Array<String>,Toys::WrappableString] Short
+    #     description for the group. See {Toys::Tool#desc=} for a description
+    #     of allowed formats. Defaults to `"Flags"`.
+    # @param long_desc [Array<String,Array<String>,Toys::WrappableString>]
+    #     Long description for the flag group. See {Toys::Tool#long_desc=} for
+    #     a description of allowed formats. Defaults to the empty array.
+    # @param name [String,Symbol,nil] The name of the group, or nil for no
+    #     name.
+    # @return [Toys::FlagGroup::Base] A flag group of the correct subclass.
+    #
+    def self.create(type: nil, name: nil, desc: nil, long_desc: nil)
+      type ||= Optional
+      unless type.is_a?(::Class)
+        class_name = ModuleLookup.to_module_name(type)
+        type =
+          begin
+            FlagGroup.const_get(class_name)
+          rescue ::NameError
+            raise ToolDefinitionError, "Unknown flag group type: #{type}"
+          end
+      end
+      unless type.ancestors.include?(Base)
+        raise ToolDefinitionError, "Unknown flag group type: #{type}"
+      end
+      type.new(name, desc, long_desc)
+    end
+
+    ##
+    # The base class of a FlagGroup, implementing everything except validation.
+    # The base class effectively behaves as an Optional group. And the default
+    # group that contains flags not otherwise assigned to a group, is of this
+    # type. However, you should use {Toys::FlagGroup::Optional} when creating
+    # an explicit optional group.
+    #
+    class Base
+      ##
+      # Create a flag group.
+      # This argument list is subject to change. Use {Toys::FlagGroup.create}
+      # instead for a more stable interface.
+      # @private
+      #
+      def initialize(name, desc, long_desc)
+        @name = name
+        @desc = WrappableString.make(desc)
+        @long_desc = WrappableString.make_array(long_desc)
+        @flags = []
+      end
+
+      ##
+      # The symbolic name for this group
+      # @return [String,Symbol,nil]
+      #
+      attr_reader :name
+
+      ##
+      # The short description string.
+      #
+      # When reading, this is always returned as a {Toys::WrappableString}.
+      #
+      # When setting, the description may be provided as any of the following:
+      #  *  A {Toys::WrappableString}.
+      #  *  A normal String, which will be transformed into a
+      #     {Toys::WrappableString} using spaces as word delimiters.
+      #  *  An Array of String, which will be transformed into a
+      #     {Toys::WrappableString} where each array element represents an
+      #     individual word for wrapping.
+      #
+      # @return [Toys::WrappableString]
+      #
+      attr_reader :desc
+
+      ##
+      # The long description strings.
+      #
+      # When reading, this is returned as an Array of {Toys::WrappableString}
+      # representing the lines in the description.
+      #
+      # When setting, the description must be provided as an Array where *each
+      # element* may be any of the following:
+      #  *  A {Toys::WrappableString} representing one line.
+      #  *  A normal String representing a line. This will be transformed into
+      #     a {Toys::WrappableString} using spaces as word delimiters.
+      #  *  An Array of String representing a line. This will be transformed
+      #     into a {Toys::WrappableString} where each array element represents
+      #     an individual word for wrapping.
+      #
+      # @return [Array<Toys::WrappableString>]
+      #
+      attr_reader :long_desc
+
+      ##
+      # An array of flags that are in this group.
+      # Do not modify the returned array.
+      # @return [Array<Toys::Flag>]
+      #
+      attr_reader :flags
+
+      ##
+      # Returns true if this group is empty
+      # @return [Boolean]
+      #
+      def empty?
+        flags.empty?
+      end
+
+      ##
+      # Returns a string summarizing this group. This is generally either the
+      # short description or a representation of all the flags included.
+      # @return [String]
+      #
+      def summary
+        return desc.to_s.inspect unless desc.empty?
+        flags.map(&:display_name).inspect
+      end
+
+      ##
+      # Set the short description string.
+      #
+      # See {#desc} for details.
+      #
+      # @param desc [Toys::WrappableString,String,Array<String>]
+      #
+      def desc=(desc)
+        @desc = WrappableString.make(desc)
+      end
+
+      ##
+      # Set the long description strings.
+      #
+      # See {#long_desc} for details.
+      #
+      # @param long_desc [Array<Toys::WrappableString,String,Array<String>>]
+      #
+      def long_desc=(long_desc)
+        @long_desc = WrappableString.make_array(long_desc)
+      end
+
+      ##
+      # Append long description strings.
+      #
+      # You must pass an array of lines in the long description. See {#long_desc}
+      # for details on how each line may be represented.
+      #
+      # @param long_desc [Array<Toys::WrappableString,String,Array<String>>]
+      # @return [self]
+      #
+      def append_long_desc(long_desc)
+        @long_desc.concat(WrappableString.make_array(long_desc))
+        self
+      end
+
+      ## @private
+      def <<(flag)
+        flags << flag
+      end
+
+      ## @private
+      def validation_errors(_seen)
+        []
+      end
+    end
+
+    ##
+    # A FlagGroup containing all required flags
+    #
+    class Required < Base
+      ## @private
+      def validation_errors(seen)
+        results = []
+        flags.each do |flag|
+          unless seen.include?(flag.key)
+            str = "Flag \"#{flag.display_name}\" is required."
+            results << ArgParser::FlagGroupConstraintError.new(str)
+          end
+        end
+        results
+      end
+    end
+
+    ##
+    # A FlagGroup containing all optional flags
+    #
+    class Optional < Base
+    end
+
+    ##
+    # A FlagGroup in which exactly one flag must be set
+    #
+    class ExactlyOne < Base
+      ## @private
+      def validation_errors(seen)
+        seen_names = []
+        flags.each do |flag|
+          seen_names << flag.display_name if seen.include?(flag.key)
+        end
+        if seen_names.size > 1
+          str = "Exactly one flag out of group #{summary} is required, but #{seen_names.size}" \
+                " were provided: #{seen_names.inspect}."
+          [ArgParser::FlagGroupConstraintError.new(str)]
+        elsif seen_names.empty?
+          str = "Exactly one flag out of group #{summary} is required, but none were provided."
+          [ArgParser::FlagGroupConstraintError.new(str)]
+        else
+          []
+        end
+      end
+    end
+
+    ##
+    # A FlagGroup in which at most one flag must be set
+    #
+    class AtMostOne < Base
+      ## @private
+      def validation_errors(seen)
+        seen_names = []
+        flags.each do |flag|
+          seen_names << flag.display_name if seen.include?(flag.key)
+        end
+        if seen_names.size > 1
+          str = "At most one flag out of group #{summary} is required, but #{seen_names.size}" \
+                " were provided: #{seen_names.inspect}."
+          [ArgParser::FlagGroupConstraintError.new(str)]
+        else
+          []
+        end
+      end
+    end
+
+    ##
+    # A FlagGroup in which at least one flag must be set
+    #
+    class AtLeastOne < Base
+      ## @private
+      def validation_errors(seen)
+        flags.each do |flag|
+          return [] if seen.include?(flag.key)
+        end
+        str = "At least one flag out of group #{summary} is required, but none were provided."
+        [ArgParser::FlagGroupConstraintError.new(str)]
+      end
+    end
+  end
+end

data/lib/toys/input_file.rb

@@ -1,32 +1,24 @@
 # frozen_string_literal: true
 
-# Copyright 2018 Daniel Azuma
+# Copyright 2019 Daniel Azuma
 #
-# All rights reserved.
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
 #
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
 #
-# * Redistributions of source code must retain the above copyright notice,
-#   this list of conditions and the following disclaimer.
-# * Redistributions in binary form must reproduce the above copyright notice,
-#   this list of conditions and the following disclaimer in the documentation
-#   and/or other materials provided with the distribution.
-# * Neither the name of the copyright holder, nor the names of any other
-#   contributors to this software, may be used to endorse or promote products
-#   derived from this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-# POSSIBILITY OF SUCH DAMAGE.
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
 ;
 
 ##
@@ -43,7 +35,7 @@ module Toys::InputFile # rubocop:disable Style/ClassAndModuleChildren
   def self.evaluate(tool_class, remaining_words, source)
     namespace = ::Module.new
     namespace.module_eval do
-      include ::Toys::Tool::Keys
+      include ::Toys::Context::Key
       @tool_class = tool_class
     end
     path = source.source_path
@@ -55,7 +47,7 @@ module Toys::InputFile # rubocop:disable Style/ClassAndModuleChildren
       ::Toys::DSL::Tool.prepare(tool_class, remaining_words, source) do
         ::Toys::ContextualError.capture_path("Error while loading Toys config!", path) do
           # rubocop:disable Security/Eval
-          eval(str, __binding, path, 0)
+          eval(str, __binding, path, -2)
           # rubocop:enable Security/Eval
         end
       end

data/lib/toys/loader.rb

@@ -1,32 +1,24 @@
 # frozen_string_literal: true
 
-# Copyright 2018 Daniel Azuma
+# Copyright 2019 Daniel Azuma
 #
-# All rights reserved.
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
 #
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
 #
-# * Redistributions of source code must retain the above copyright notice,
-#   this list of conditions and the following disclaimer.
-# * Redistributions in binary form must reproduce the above copyright notice,
-#   this list of conditions and the following disclaimer in the documentation
-#   and/or other materials provided with the distribution.
-# * Neither the name of the copyright holder, nor the names of any other
-#   contributors to this software, may be used to endorse or promote products
-#   derived from this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-# POSSIBILITY OF SUCH DAMAGE.
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
 ;
 
 module Toys
@@ -39,10 +31,12 @@ module Toys
   class Loader
     ## @private
     ToolData = ::Struct.new(:definitions, :top_priority, :active_priority) do
+      ## @private
       def top_definition
         top_priority ? definitions[top_priority] : nil
       end
 
+      ## @private
       def active_definition
         active_priority ? definitions[active_priority] : nil
       end
@@ -51,66 +45,67 @@ module Toys
     ##
     # Create a Loader
     #
-    # @param [String,nil] index_file_name A file with this name that appears
+    # @param index_file_name [String,nil] A file with this name that appears
     #     in any configuration directory (not just a toplevel directory) is
     #     loaded first as a standalone configuration file. If not provided,
     #     standalone configuration files are disabled.
-    # @param [String,nil] preload_file_name A file with this name that appears
+    # @param preload_file_name [String,nil] A file with this name that appears
     #     in any configuration directory is preloaded before any tools in that
     #     configuration directory are defined.
-    # @param [String,nil] preload_directory_name A directory with this name
-    #     that appears in any configuration directory is searched for Ruby
-    #     files, which are preloaded before any tools in that configuration
-    #     directory are defined.
-    # @param [String,nil] data_directory_name A directory with this name that
-    #     appears in any configuration directory is added to the data directory
-    #     search path for any tool file in that directory.
-    # @param [Array] middleware_stack An array of middleware that will be used
+    # @param preload_dir_name [String,nil] A directory with this name that
+    #     appears in any configuration directory is searched for Ruby files,
+    #     which are preloaded before any tools in that configuration directory
+    #     are defined.
+    # @param data_dir_name [String,nil] A directory with this name that appears
+    #     in any configuration directory is added to the data directory search
+    #     path for any tool file in that directory.
+    # @param middleware_stack [Array] An array of middleware that will be used
     #     by default for all tools loaded by this loader.
-    # @param [String] extra_delimiters A string containing characters that can
+    # @param extra_delimiters [String] A string containing characters that can
     #     function as delimiters in a tool name. Defaults to empty. Allowed
     #     characters are period, colon, and slash.
-    # @param [Toys::Utils::ModuleLookup] mixin_lookup A lookup for well-known
+    # @param mixin_lookup [Toys::ModuleLookup] A lookup for well-known
     #     mixin modules. Defaults to an empty lookup.
-    # @param [Toys::Utils::ModuleLookup] middleware_lookup A lookup for
+    # @param middleware_lookup [Toys::ModuleLookup] A lookup for
     #     well-known middleware classes. Defaults to an empty lookup.
-    # @param [Toys::Utils::ModuleLookup] template_lookup A lookup for
+    # @param template_lookup [Toys::ModuleLookup] A lookup for
     #     well-known template classes. Defaults to an empty lookup.
     #
-    def initialize(index_file_name: nil, preload_directory_name: nil, preload_file_name: nil,
-                   data_directory_name: nil, middleware_stack: [], extra_delimiters: "",
+    def initialize(index_file_name: nil, preload_dir_name: nil, preload_file_name: nil,
+                   data_dir_name: nil, middleware_stack: [], extra_delimiters: "",
                    mixin_lookup: nil, middleware_lookup: nil, template_lookup: nil)
       if index_file_name && ::File.extname(index_file_name) != ".rb"
         raise ::ArgumentError, "Illegal index file name #{index_file_name.inspect}"
       end
-      @mixin_lookup = mixin_lookup || Utils::ModuleLookup.new
-      @middleware_lookup = middleware_lookup || Utils::ModuleLookup.new
-      @template_lookup = template_lookup || Utils::ModuleLookup.new
+      @mixin_lookup = mixin_lookup || ModuleLookup.new
+      @middleware_lookup = middleware_lookup || ModuleLookup.new
+      @template_lookup = template_lookup || ModuleLookup.new
       @index_file_name = index_file_name
       @preload_file_name = preload_file_name
-      @preload_directory_name = preload_directory_name
-      @data_directory_name = data_directory_name
+      @preload_dir_name = preload_dir_name
+      @data_dir_name = data_dir_name
       @middleware_stack = middleware_stack
       @worklist = []
       @tool_data = {}
       @max_priority = @min_priority = 0
       @extra_delimiters = process_extra_delimiters(extra_delimiters)
-      get_tool_definition([], -999_999)
+      get_tool([], -999_999)
     end
 
     ##
     # Add a configuration file/directory to the loader.
     #
-    # @param [String,Array<String>] paths One or more paths to add.
-    # @param [Boolean] high_priority If true, add this path at the top of the
+    # @param paths [String,Array<String>] One or more paths to add.
+    # @param high_priority [Boolean] If true, add this path at the top of the
     #     priority list. Defaults to false, indicating the new path should be
     #     at the bottom of the priority list.
+    # @return [self]
     #
     def add_path(paths, high_priority: false)
       paths = Array(paths)
       priority = high_priority ? (@max_priority += 1) : (@min_priority -= 1)
       paths.each do |path|
-        source = Definition::SourceInfo.create_path_root(path)
+        source = SourceInfo.create_path_root(path)
         @worklist << [source, [], priority]
       end
       self
@@ -119,17 +114,20 @@ module Toys
     ##
     # Add a configuration block to the loader.
     #
-    # @param [Boolean] high_priority If true, add this block at the top of the
+    # @param high_priority [Boolean] If true, add this block at the top of the
     #     priority list. Defaults to false, indicating the block should be at
     #     the bottom of the priority list.
-    # @param [String] name The source name that will be shown in documentation
+    # @param name [String] The source name that will be shown in documentation
     #     for tools defined in this block. If omitted, a default unique string
     #     will be generated.
+    # @param block [Proc] The block of configuration, executed in the context
+    #     of the tool DSL {Toys::DSL::Tool}.
+    # @return [self]
     #
     def add_block(high_priority: false, name: nil, &block)
       name ||= "(Code block #{block.object_id})"
       priority = high_priority ? (@max_priority += 1) : (@min_priority -= 1)
-      source = Definition::SourceInfo.create_proc_root(block, name)
+      source = SourceInfo.create_proc_root(block, name)
       @worklist << [source, [], priority]
       self
     end
@@ -140,13 +138,13 @@ module Toys
     # following aliases.
     # This always returns a tool. If the specific tool path is not defined and
     # cannot be found in any configuration, it finds the nearest namespace that
-    # _would_ contain that tool, up to the root tool.
+    # *would* contain that tool, up to the root tool.
     #
     # Returns a tuple of the found tool, and the array of remaining arguments
     # that are not part of the tool name and should be passed as tool args.
     #
-    # @param [Array<String>] args Command line arguments
-    # @return [Array(Toys::Definition::Tool,Array<String>)]
+    # @param args [Array<String>] Command line arguments
+    # @return [Array(Toys::Tool,Array<String>)]
     #
     def lookup(args)
       orig_prefix, args = find_orig_prefix(args)
@@ -155,10 +153,10 @@ module Toys
         load_for_prefix(cur_prefix)
         prefix = orig_prefix
         loop do
-          tool_definition = get_active_tool(prefix, [])
-          if tool_definition
-            finish_definitions_in_tree(tool_definition.full_name)
-            return [tool_definition, args.slice(prefix.length..-1)]
+          tool = get_active_tool(prefix, [])
+          if tool
+            finish_definitions_in_tree(tool.full_name)
+            return [tool, args.slice(prefix.length..-1)]
           end
           break if prefix.empty? || prefix.length <= cur_prefix.length
           prefix = prefix.slice(0..-2)
@@ -172,12 +170,13 @@ module Toys
     # Returns a list of subtools for the given path, loading from the
     # configuration if necessary.
     #
-    # @param [Array<String>] words The name of the parent tool
-    # @param [Boolean] recursive If true, return all subtools recursively
+    # @param words [Array<String>] The name of the parent tool
+    # @param recursive [Boolean] If true, return all subtools recursively
     #     rather than just the immediate children (the default)
-    # @param [Boolean] include_hidden If true, include hidden subtools,
+    # @param include_hidden [Boolean] If true, include hidden subtools,
     #     e.g. names beginning with underscores.
-    # @return [Array<Toys::Definition::Tool,Toys::Definition::Alias>]
+    # @return [Array<Toys::Tool,Toys::Alias>] An array of subtools, which may
+    #     be tools or aliases.
     #
     def list_subtools(words, recursive: false, include_hidden: false)
       load_for_prefix(words)
@@ -201,14 +200,16 @@ module Toys
     # Returns true if the given path has at least one subtool. Loads from the
     # configuration if necessary.
     #
-    # @param [Array<String>] words The name of the parent tool
+    # @param words [Array<String>] The name of the parent tool
     # @return [Boolean]
     #
-    def has_subtools?(words)
+    def has_subtools?(words) # rubocop:disable Naming/PredicateName
       load_for_prefix(words)
       len = words.length
-      @tool_data.each_key do |n|
-        return true if !n.empty? && n.length > len && n.slice(0, len) == words
+      @tool_data.each do |n, td|
+        if !n.empty? && n.length > len && n.slice(0, len) == words && !td.definitions.empty?
+          return true
+        end
       end
       false
     end
@@ -220,29 +221,31 @@ module Toys
     # the active priority, returns `nil`. If the given priority is higher than
     # the active priority, returns and activates a new tool.
     #
-    # @param [Array<String>] words The name of the tool.
-    # @param [Integer] priority The priority of the request.
-    # @return [Toys::Definition::Tool,Toys::Definition::Alias,nil] The tool or
-    #     alias, or `nil` if the given priority is insufficient.
+    # @param words [Array<String>] The name of the tool.
+    # @param priority [Integer] The priority of the request.
+    #
+    # @return [Toys::Tool] The tool found.
+    # @return [Toys::Alias] The alias found.
+    # @return [nil] if the given priority is insufficient.
     #
     # @private
     #
-    def activate_tool_definition(words, priority)
+    def activate_tool(words, priority)
       tool_data = get_tool_data(words)
       return tool_data.active_definition if tool_data.active_priority == priority
       return nil if tool_data.active_priority && tool_data.active_priority > priority
       tool_data.active_priority = priority
-      get_tool_definition(words, priority)
+      get_tool(words, priority)
     end
 
     ##
     # Sets the given name as an alias to the given target.
     #
-    # @param [Array<String>] words The alias name
-    # @param [Array<String>] target The alias target name
-    # @param [Integer] priority The priority of the request
+    # @param words [Array<String>] The alias name
+    # @param target [Array<String>] The alias target name
+    # @param priority [Integer] The priority of the request
     #
-    # @return [Toys::Definition::Alias] The alias created
+    # @return [Toys::Alias] The alias created
     #
     # @private
     #
@@ -252,9 +255,9 @@ module Toys
         raise ToolDefinitionError,
               "Cannot make #{words.inspect} an alias because it is already defined"
       end
-      alias_def = Definition::Alias.new(self, words, target, priority)
+      alias_def = Alias.new(self, words, target, priority)
       tool_data.definitions[priority] = alias_def
-      activate_tool_definition(words, priority)
+      activate_tool(words, priority)
       alias_def
     end
 
@@ -262,7 +265,7 @@ module Toys
     # Returns true if the given tool name currently exists in the loader.
     # Does not load the tool if not found.
     #
-    # @param [Array<String>] words The name of the tool.
+    # @param words [Array<String>] The name of the tool.
     # @return [Boolean]
     #
     # @private
@@ -277,9 +280,9 @@ module Toys
     #
     # @private
     #
-    def get_tool_definition(words, priority)
-      parent = words.empty? ? nil : get_tool_definition(words.slice(0..-2), priority)
-      if parent.is_a?(Definition::Alias)
+    def get_tool(words, priority)
+      parent = words.empty? ? nil : get_tool(words.slice(0..-2), priority)
+      if parent.is_a?(Alias)
         raise ToolDefinitionError,
               "Cannot create children of #{parent.display_name.inspect} because it is an alias"
       end
@@ -289,15 +292,18 @@ module Toys
       end
       tool_data.definitions[priority] ||= begin
         middlewares = @middleware_stack.map { |m| resolve_middleware(m) }
-        Definition::Tool.new(self, parent, words, priority, middlewares)
+        Tool.new(self, parent, words, priority, middlewares)
       end
     end
 
     ##
     # Attempt to get a well-known mixin module for the given symbolic name.
     #
-    # @param [Symbol] name Mixin name
-    # @return [Module,nil] The mixin, or `nil` if not found.
+    # @param name [Symbol] Mixin name
+    # @return [Module] The mixin
+    # @return [nil] if not found.
+    #
+    # @private
     #
     def resolve_standard_mixin(name)
       @mixin_lookup.lookup(name)
@@ -306,8 +312,11 @@ module Toys
     ##
     # Attempt to get a well-known template class for the given symbolic name.
     #
-    # @param [Symbol] name Template name
-    # @return [Class,nil] The template, or `nil` if not found.
+    # @param name [Symbol] Template name
+    # @return [Class] The template.
+    # @return [nil] if not found.
+    #
+    # @private
     #
     def resolve_standard_template(name)
       @template_lookup.lookup(name)
@@ -342,6 +351,7 @@ module Toys
     private
 
     ALLOWED_DELIMITERS = %r{^[\./:]*$}.freeze
+    private_constant :ALLOWED_DELIMITERS
 
     def process_extra_delimiters(input)
       unless ALLOWED_DELIMITERS =~ input
@@ -378,9 +388,9 @@ module Toys
       tool_data = get_tool_data(words)
       result = tool_data.active_definition
       case result
-      when Definition::Alias
+      when Alias
         resolve_alias(result, looked_up)
-      when Definition::Tool
+      when Tool
         result
       else
         tool_data.top_definition
@@ -428,7 +438,7 @@ module Toys
       @tool_data.each do |n, td|
         next if n.length < len || n.slice(0, len) != words
         tool = td.active_definition || td.top_definition
-        tool.finish_definition(self) if tool.is_a?(Definition::Tool)
+        tool.finish_definition(self) if tool.is_a?(Tool)
       end
     end
 
@@ -447,7 +457,7 @@ module Toys
 
     def load_proc(source, words, remaining_words, priority)
       if remaining_words
-        tool_class = get_tool_definition(words, priority).tool_class
+        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
             tool_class.class_eval(&source.source_proc)
@@ -468,7 +478,7 @@ module Toys
 
     def load_relevant_path(source, words, remaining_words, priority)
       if source.source_type == :file
-        tool_class = get_tool_definition(words, priority).tool_class
+        tool_class = get_tool(words, priority).tool_class
         InputFile.evaluate(tool_class, remaining_words, source)
       else
         do_preload(source.source_path)
@@ -481,15 +491,15 @@ 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_directory_name)
+      index_source = source.relative_child(@index_file_name, @data_dir_name)
       load_relevant_path(index_source, words, remaining_words, priority) if index_source
     end
 
     def load_child_in(source, child, words, remaining_words, priority)
       return if child.start_with?(".") || child == @index_file_name ||
-                child == @preload_file_name || child == @preload_directory_name ||
-                child == @data_directory_name
-      child_source = source.relative_child(child, @data_directory_name)
+                child == @preload_file_name || child == @preload_dir_name ||
+                child == @data_dir_name
+      child_source = source.relative_child(child, @data_dir_name)
       child_word = ::File.basename(child, ".rb")
       next_words = words + [child_word]
       next_remaining = Loader.next_remaining_words(remaining_words, child_word)
@@ -503,8 +513,8 @@ module Toys
           require preload_file
         end
       end
-      if @preload_directory_name
-        preload_dir = ::File.join(path, @preload_directory_name)
+      if @preload_dir_name
+        preload_dir = ::File.join(path, @preload_dir_name)
         if ::File.directory?(preload_dir) && ::File.readable?(preload_dir)
           ::Dir.entries(preload_dir).each do |child|
             next unless ::File.extname(child) == ".rb"
@@ -538,7 +548,7 @@ module Toys
 
     def tool_hidden?(tool, next_tool)
       return true if tool.full_name.any? { |n| n.start_with?("_") }
-      return tool_hidden?(resolve_alias(tool), nil) if tool.is_a? Definition::Alias
+      return tool_hidden?(resolve_alias(tool), nil) if tool.is_a?(Alias)
       !tool.runnable? && next_tool && next_tool.full_name.slice(0..-2) == tool.full_name
     end