toys-core 0.12.2 → 0.13.0

data/lib/toys/settings.rb

@@ -299,26 +299,16 @@ module Toys
   #     grandchild_settings.str        # => "value_from_root"
   #
   class Settings
+    # A special value indicating a type check failure.
+    ILLEGAL_VALUE = ::Object.new.freeze
+
+    # A special type specification indicating infer from the default value.
+    DEFAULT_TYPE = ::Object.new.freeze
+
     ##
     # Error raised when a value does not match the type constraint.
     #
     class FieldError < ::StandardError
-      # @private
-      def initialize(value, settings_class, field_name, type_description)
-        @value = value
-        @settings_class = settings_class
-        @field_name = field_name
-        @type_description = type_description
-        message = "unable to set #{settings_class}##{field_name}"
-        message =
-          if type_description
-            "#{message}: value #{value.inspect} does not match type #{type_description}"
-          else
-            "#{message}: field does not exist"
-          end
-        super(message)
-      end
-
       ##
       # The value that did not match
       # @return [Object]
@@ -342,13 +332,25 @@ module Toys
       # @return [String, nil]
       #
       attr_reader :type_description
-    end
 
-    # A special value indicating a type check failure.
-    ILLEGAL_VALUE = ::Object.new.freeze
-
-    # A special type specification indicating infer from the default value.
-    DEFAULT_TYPE = ::Object.new.freeze
+      ##
+      # @private
+      #
+      def initialize(value, settings_class, field_name, type_description)
+        @value = value
+        @settings_class = settings_class
+        @field_name = field_name
+        @type_description = type_description
+        message = "unable to set #{settings_class}##{field_name}"
+        message =
+          if type_description
+            "#{message}: value #{value.inspect} does not match type #{type_description}"
+          else
+            "#{message}: field does not exist"
+          end
+        super(message)
+      end
+    end
 
     ##
     # A type object that checks values.
@@ -558,7 +560,9 @@ module Toys
         end
       end
 
+      ##
       # @private
+      #
       CONVERTERS = {
         ::Date => date_converter,
         ::DateTime => datetime_converter,
@@ -570,51 +574,6 @@ module Toys
       }.freeze
     end
 
-    # @private
-    SETTINGS_TYPE = Type.new("(settings object)") do |val|
-      val.nil? || val.is_a?(Settings) ? val : ILLEGAL_VALUE
-    end
-
-    # @private
-    class Field
-      def initialize(container, name, type_spec, default_or_group_class)
-        @container = container
-        @name = name
-        if type_spec == SETTINGS_TYPE
-          @default = nil
-          @group_class = default_or_group_class
-          @type = type_spec
-        else
-          @group_class = nil
-          if type_spec == DEFAULT_TYPE
-            @default = default_or_group_class
-            @type = Type.for_default_value(@default)
-          else
-            @type = Type.for_type_spec(type_spec)
-            @default = validate(default_or_group_class)
-          end
-        end
-      end
-
-      attr_reader :container
-      attr_reader :name
-      attr_reader :type
-      attr_reader :default
-      attr_reader :group_class
-
-      def group?
-        !@group_class.nil?
-      end
-
-      def validate(value)
-        validated_value = @type.call(value)
-        if validated_value == ILLEGAL_VALUE
-          raise FieldError.new(value, container, name, @type.description)
-        end
-        validated_value
-      end
-    end
-
     ##
     # Create a settings instance.
     #
@@ -716,6 +675,7 @@ module Toys
 
     ##
     # @private
+    #
     # Internal get field value, with fallback to parents.
     #
     def get!(field)
@@ -743,6 +703,7 @@ module Toys
 
     ##
     # @private
+    #
     # Internal set field value, with validation.
     #
     def set!(field, value)
@@ -754,6 +715,7 @@ module Toys
 
     ##
     # @private
+    #
     # Internal determine if the field is set locally.
     #
     def set?(field)
@@ -764,6 +726,7 @@ module Toys
 
     ##
     # @private
+    #
     # Internal unset field value.
     #
     def unset!(field)
@@ -772,6 +735,55 @@ module Toys
       end
     end
 
+    ##
+    # @private
+    #
+    SETTINGS_TYPE = Type.new("(settings object)") do |val|
+      val.nil? || val.is_a?(Settings) ? val : ILLEGAL_VALUE
+    end
+
+    ##
+    # @private
+    #
+    class Field
+      def initialize(container, name, type_spec, default_or_group_class)
+        @container = container
+        @name = name
+        if type_spec == SETTINGS_TYPE
+          @default = nil
+          @group_class = default_or_group_class
+          @type = type_spec
+        else
+          @group_class = nil
+          if type_spec == DEFAULT_TYPE
+            @default = default_or_group_class
+            @type = Type.for_default_value(@default)
+          else
+            @type = Type.for_type_spec(type_spec)
+            @default = validate(default_or_group_class)
+          end
+        end
+      end
+
+      attr_reader :container
+      attr_reader :name
+      attr_reader :type
+      attr_reader :default
+      attr_reader :group_class
+
+      def group?
+        !@group_class.nil?
+      end
+
+      def validate(value)
+        validated_value = @type.call(value)
+        if validated_value == ILLEGAL_VALUE
+          raise FieldError.new(value, container, name, @type.description)
+        end
+        validated_value
+      end
+    end
+
     class << self
       ##
       # Add an attribute field.
@@ -824,6 +836,7 @@ module Toys
 
       ##
       # @private
+      #
       # Returns the fields hash. This is shared between the settings class and
       # all its instances.
       #
@@ -833,6 +846,7 @@ module Toys
 
       ##
       # @private
+      #
       # When this base class is inherited, if its enclosing module is also a
       # Settings, add the new class as a group in the enclosing class.
       #

data/lib/toys/source_info.rb

@@ -6,30 +6,6 @@ module Toys
   # or block that defined it.
   #
   class SourceInfo
-    ##
-    # Create a SourceInfo.
-    # @private
-    #
-    def initialize(parent, priority, context_directory, source_type, source_path, source_proc,
-                   git_remote, git_path, git_commit, source_name, data_dir_name, lib_dir_name)
-      @parent = parent
-      @root = parent&.root || self
-      @priority = priority
-      @context_directory = context_directory
-      @source_type = source_type
-      @source = source_type == :proc ? source_proc : source_path
-      @source_path = source_path
-      @source_proc = source_proc
-      @git_remote = git_remote
-      @git_path = git_path
-      @git_commit = git_commit
-      @source_name = source_name
-      @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
-
     ##
     # The parent of this SourceInfo.
     #
@@ -161,8 +137,34 @@ module Toys
       self
     end
 
+    ##
+    # Create a SourceInfo.
+    #
+    # @private
+    #
+    def initialize(parent, priority, context_directory, source_type, source_path, source_proc,
+                   git_remote, git_path, git_commit, source_name, data_dir_name, lib_dir_name)
+      @parent = parent
+      @root = parent&.root || self
+      @priority = priority
+      @context_directory = context_directory
+      @source_type = source_type
+      @source = source_type == :proc ? source_proc : source_path
+      @source_path = source_path
+      @source_proc = source_proc
+      @git_remote = git_remote
+      @git_path = git_path
+      @git_commit = git_commit
+      @source_name = source_name
+      @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
+
     ##
     # Create a child SourceInfo relative to the parent path.
+    #
     # @private
     #
     def relative_child(filename, source_name: nil)
@@ -186,6 +188,7 @@ module Toys
 
     ##
     # Create a child SourceInfo with an absolute path.
+    #
     # @private
     #
     def absolute_child(child_path, source_name: nil)
@@ -197,6 +200,7 @@ module Toys
 
     ##
     # Create a child SourceInfo with a git source.
+    #
     # @private
     #
     def git_child(child_git_remote, child_git_path, child_git_commit, child_path,
@@ -211,6 +215,7 @@ module Toys
 
     ##
     # Create a proc child SourceInfo
+    #
     # @private
     #
     def proc_child(child_proc, source_name: nil)
@@ -222,6 +227,7 @@ module Toys
 
     ##
     # Create a root source info for a file path.
+    #
     # @private
     #
     def self.create_path_root(source_path, priority,
@@ -243,6 +249,7 @@ module Toys
 
     ##
     # Create a root source info for a cached git repo.
+    #
     # @private
     #
     def self.create_git_root(git_remote, git_path, git_commit, source_path, priority,
@@ -258,6 +265,7 @@ module Toys
 
     ##
     # Create a root source info for a proc.
+    #
     # @private
     #
     def self.create_proc_root(source_proc, priority,
@@ -272,6 +280,7 @@ module Toys
 
     ##
     # Check a path and determine the canonical path and type.
+    #
     # @private
     #
     def self.check_path(path, lenient)

data/lib/toys/standard_middleware/add_verbosity_flags.rb

@@ -48,6 +48,7 @@ module Toys
 
       ##
       # Configure the tool flags.
+      #
       # @private
       #
       def config(tool, _loader)
@@ -63,6 +64,7 @@ module Toys
 
       INCREMENT_HANDLER = ->(_val, cur) { cur.to_i + 1 }
       DECREMENT_HANDLER = ->(_val, cur) { cur.to_i - 1 }
+      private_constant :INCREMENT_HANDLER, :DECREMENT_HANDLER
 
       def add_verbose_flags(tool)
         verbose_flags = resolve_flags_spec(@verbose_flags, tool, DEFAULT_VERBOSE_FLAGS)

data/lib/toys/standard_middleware/apply_config.rb

@@ -28,6 +28,7 @@ module Toys
 
       ##
       # Appends the configuration block.
+      #
       # @private
       #
       def config(tool, loader)

data/lib/toys/standard_middleware/handle_usage_errors.rb

@@ -33,6 +33,7 @@ module Toys
 
       ##
       # Intercept and handle usage errors during execution.
+      #
       # @private
       #
       def run(context)

data/lib/toys/standard_middleware/set_default_descriptions.rb

@@ -90,6 +90,7 @@ module Toys
 
       ##
       # Add default description text to tools.
+      #
       # @private
       #
       def config(tool, loader)

data/lib/toys/standard_middleware/show_help.rb

@@ -202,6 +202,7 @@ module Toys
 
       ##
       # Configure flags and default data.
+      #
       # @private
       #
       def config(tool, loader)
@@ -224,6 +225,7 @@ module Toys
 
       ##
       # Display help text if requested.
+      #
       # @private
       #
       def run(context)

data/lib/toys/standard_middleware/show_root_version.rb

@@ -46,6 +46,7 @@ module Toys
 
       ##
       # Adds the version flag if requested.
+      #
       # @private
       #
       def config(tool, _loader)
@@ -58,6 +59,7 @@ module Toys
 
       ##
       # This middleware displays the version.
+      #
       # @private
       #
       def run(context)

data/lib/toys/standard_mixins/bundler.rb

@@ -67,20 +67,6 @@ module Toys
     module Bundler
       include Mixin
 
-      on_initialize do |static: false, **kwargs|
-        unless static
-          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, **kwargs|
-        if static
-          ::Toys::StandardMixins::Bundler.setup_bundle(context_directory, source_info, **kwargs)
-        end
-      end
-
       ##
       # Default search directories for Gemfiles.
       # @return [Array<String,Symbol>]
@@ -93,7 +79,9 @@ module Toys
       #
       DEFAULT_TOYS_GEMFILE_NAMES = [".gems.rb", "Gemfile"].freeze
 
+      ##
       # @private
+      #
       def self.setup_bundle(context_directory,
                             source_info,
                             gemfile_path: nil,
@@ -118,9 +106,27 @@ module Toys
         gems.bundle(groups: groups, gemfile_path: gemfile_path, retries: retries)
       end
 
+      on_initialize do |static: false, **kwargs|
+        unless static
+          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, **kwargs|
+        if static
+          ::Toys::StandardMixins::Bundler.setup_bundle(context_directory, source_info, **kwargs)
+        end
+      end
+
+      ##
       # @private
+      #
       class GemfileFinder
+        ##
         # @private
+        #
         def initialize(context_directory, source_info, gemfile_names, toys_gemfile_names)
           @context_directory = context_directory
           @source_info = source_info
@@ -128,7 +134,9 @@ module Toys
           @toys_gemfile_names = toys_gemfile_names || DEFAULT_TOYS_GEMFILE_NAMES
         end
 
+        ##
         # @private
+        #
         def search(search_dir)
           case search_dir
           when ::Array

data/lib/toys/standard_mixins/exec.rb

@@ -229,20 +229,6 @@ module Toys
       #
       KEY = ::Object.new.freeze
 
-      on_initialize do |**opts|
-        require "toys/utils/exec"
-        context = self
-        opts = Exec._setup_exec_opts(opts, context)
-        context[KEY] = Utils::Exec.new(**opts) do |k|
-          case k
-          when :logger
-            context[Context::Key::LOGGER]
-          when :cli
-            context[Context::Key::CLI]
-          end
-        end
-      end
-
       ##
       # Set default configuration options.
       #
@@ -305,7 +291,7 @@ module Toys
       #
       # Execute a small script with warnings
       #
-      #     exec_ruby("-w", "-e", "(1..10).each { |i| puts i }")
+      #     exec_ruby(["-w", "-e", "(1..10).each { |i| puts i }"])
       #
       # @param args [String,Array<String>] The arguments to ruby.
       # @param opts [keywords] The command options. See the section on
@@ -397,6 +383,7 @@ module Toys
       def exec_tool(cmd, **opts, &block)
         func = Exec._make_tool_caller(cmd)
         opts = Exec._setup_exec_opts(opts, self)
+        opts = {log_cmd: "exec tool: #{cmd.inspect}"}.merge(opts)
         self[KEY].exec_proc(func, **opts, &block)
       end
 
@@ -675,13 +662,17 @@ module Toys
         0
       end
 
-      ## @private
+      ##
+      # @private
+      #
       def self._make_tool_caller(cmd)
         cmd = ::Shellwords.split(cmd) if cmd.is_a?(::String)
         proc { |config| ::Kernel.exit(config[:cli].run(*cmd)) }
       end
 
-      ## @private
+      ##
+      # @private
+      #
       def self._setup_exec_opts(opts, context)
         count = 0
         result_callback = nil
@@ -704,7 +695,9 @@ module Toys
         opts
       end
 
-      ## @private
+      ##
+      # @private
+      #
       def self._interpret_e(value, context)
         return nil unless value
         proc do |result|
@@ -718,7 +711,9 @@ module Toys
         end
       end
 
-      ## @private
+      ##
+      # @private
+      #
       def self._interpret_result_callback(value, context)
         if value.is_a?(::Symbol)
           context.method(value)
@@ -731,7 +726,9 @@ module Toys
         end
       end
 
-      ## @private
+      ##
+      # @private
+      #
       def self._setup_clean_process(cmd)
         raise ::ArgumentError, "Toys process is unknown" unless ::Toys.executable_path
         cmd = ::Shellwords.split(cmd) if cmd.is_a?(::String)
@@ -746,6 +743,20 @@ module Toys
           yield(cmd)
         end
       end
+
+      on_initialize do |**opts|
+        require "toys/utils/exec"
+        context = self
+        opts = Exec._setup_exec_opts(opts, context)
+        context[KEY] = Utils::Exec.new(**opts) do |k|
+          case k
+          when :logger
+            context[Context::Key::LOGGER]
+          when :cli
+            context[Context::Key::CLI]
+          end
+        end
+      end
     end
   end
 end

data/lib/toys/standard_mixins/fileutils.rb

@@ -16,7 +16,9 @@ module Toys
     module Fileutils
       include Mixin
 
-      ## @private
+      ##
+      # @private
+      #
       def self.included(mod)
         mod.include(::FileUtils)
       end

data/lib/toys/standard_mixins/gems.rb

@@ -25,23 +25,6 @@ module Toys
     module Gems
       include Mixin
 
-      on_include do |**opts|
-        @__gems_opts = opts
-
-        ## @private
-        def self.gems
-          require "toys/utils/gems"
-          # rubocop:disable Naming/MemoizedInstanceVariableName
-          @__gems ||= Utils::Gems.new(**@__gems_opts)
-          # rubocop:enable Naming/MemoizedInstanceVariableName
-        end
-
-        ## @private
-        def self.gem(name, *requirements)
-          gems.activate(name, *requirements)
-        end
-      end
-
       ##
       # A tool-wide instance of {Toys::Utils::Gems}.
       # @return [Toys::Utils::Gems]
@@ -60,6 +43,27 @@ module Toys
       def gem(name, *requirements)
         self.class.gems.activate(name, *requirements)
       end
+
+      on_include do |**opts|
+        @__gems_opts = opts
+
+        ##
+        # @private
+        #
+        def self.gems
+          require "toys/utils/gems"
+          # rubocop:disable Naming/MemoizedInstanceVariableName
+          @__gems ||= Utils::Gems.new(**@__gems_opts)
+          # rubocop:enable Naming/MemoizedInstanceVariableName
+        end
+
+        ##
+        # @private
+        #
+        def self.gem(name, *requirements)
+          gems.activate(name, *requirements)
+        end
+      end
     end
   end
 end

data/lib/toys/standard_mixins/git_cache.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "fileutils"
-
 module Toys
   module StandardMixins
     ##
@@ -30,11 +28,6 @@ module Toys
       #
       KEY = ::Object.new.freeze
 
-      on_initialize do
-        require "toys/utils/git_cache"
-        self[KEY] = Utils::GitCache.new
-      end
-
       ##
       # Access the builtin GitCache.
       #
@@ -43,6 +36,11 @@ module Toys
       def git_cache
         self[KEY]
       end
+
+      on_initialize do
+        require "toys/utils/git_cache"
+        self[KEY] = Utils::GitCache.new
+      end
     end
   end
 end