toys-core 0.14.1 → 0.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49f6342ac835f193218570f20cc534fc7f1d4fab14742602df3a7174cfc8a554
-  data.tar.gz: 27b8298897b5c8fd08319fffec33540c057675ed8655700280b4837f413cc635
+  metadata.gz: de679852961f700752c16ccbec8b08bf28390070ce6e7a29f6d34bf6dd9a1ba3
+  data.tar.gz: b149a5af7458b8ef26bb2a12dcc3ede565af9450780e8de7d132576550c65217
 SHA512:
-  metadata.gz: 55dc00e57b5c6b3212ed24d45bb3a595dae8b5b6fd076ddefdbe4835d621dfeb70d58b8551ae69a8190dc3884a66968e78b800d93b07eed6b61d42eef70faea7
-  data.tar.gz: eb6b5c306c815947290a8fb99834a4a809052edf7e6c781f1b562c61217cf49c63a9609beb168b0e06c5e09ace51083bbb7da15ad58746e72fc5017e04f9546d
+  metadata.gz: f7dc86145d43b4c778da09c6f31195a89aa62eab6a2bb4ef2efe1100b18863b17854540f07711c255c9eb95f8f2232c53808bdef87e0237fd8ec541c0bbc79cd
+  data.tar.gz: 50f4c29636dca1fe75c94a7d53dc23315ba6f49e5f7e1ac39e13cd4f0459fbdf57b3eccee159558476042f9a8aaa831f7bcf3c86bb2dd976b02f63e029fe67a8

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History
 
+### v0.14.2 / 2022-10-09
+
+* ADDED: The tool directive supports the delegate_relative argument, as a preferred alternative over alias_tool.
+* FIXED: The toys file reference now properly appears in error messages on Ruby 3.1.
+* FIXED: Error messages show the correct toys file line number on TruffleRuby.
+* FIXED: Inspect strings for tool classes are less opaque and include the tool name.
+* FIXED: The presence of an acceptor forces an ambiguous flag to take a value rather than erroring.
+
 ### v0.14.1 / 2022-10-03
 
 * (No significant changes)

data/lib/toys/context.rb

@@ -338,12 +338,15 @@ module Toys
     end
 
     ##
+    # Include the tool name in the object inspection dump.
+    #
     # @private
     #
     def inspect
-      name = Array(@__data[Key::TOOL_NAME]).join(" ")
+      words = Array(@__data[Key::TOOL_NAME])
+      name = words.empty? ? "(root)" : words.join(" ").inspect
       id = object_id.to_s(16)
-      "#<Toys::Context id=0x#{id} #{name}>"
+      "#<Toys::Context id=0x#{id} tool=#{name}>"
     end
   end
 end

data/lib/toys/core.rb

@@ -9,7 +9,7 @@ module Toys
     # Current version of Toys core.
     # @return [String]
     #
-    VERSION = "0.14.1"
+    VERSION = "0.14.2"
   end
 
   ##

data/lib/toys/dsl/internal.rb

@@ -68,6 +68,24 @@ module Toys
           end
         end
 
+        ##
+        # Called by the DSL implementation to analyze the name of a new tool
+        # definition in context.
+        #
+        # @private
+        #
+        def analyze_name(tool_class, words)
+          loader = tool_class.instance_variable_get(:@__loader)
+          subtool_words = tool_class.instance_variable_get(:@__words).dup
+          next_remaining = tool_class.instance_variable_get(:@__remaining_words)
+          loader.split_path(words).each do |word|
+            word = word.to_s
+            subtool_words << word
+            next_remaining = Loader.next_remaining_words(next_remaining, word)
+          end
+          [subtool_words, next_remaining]
+        end
+
         ##
         # Called by the DSL implementation to add a getter to the tool class.
         #

data/lib/toys/dsl/tool.rb

@@ -273,7 +273,8 @@ module Toys
       #       end
       #     end
       #
-      # The following example defines a tool that runs one of its subtools.
+      # The following example uses `delegate_to` to define a tool that runs one
+      # of its subtools.
       #
       #     tool "test", delegate_to: ["test", "unit"] do
       #       tool "unit" do
@@ -294,17 +295,14 @@ module Toys
       #     delegate to another tool, specified by the full path. This path may
       #     be given as an array of strings, or a single string possibly
       #     delimited by path separators.
+      # @param delegate_relative [String,Array<String>] Optional. Similar to
+      #     delegate_to, but takes a delegate name relative to the context in
+      #     which this tool is being defined.
       # @param block [Proc] Defines the subtool.
       # @return [self]
       #
-      def tool(words, if_defined: :combine, delegate_to: nil, &block)
-        subtool_words = @__words.dup
-        next_remaining = @__remaining_words
-        @__loader.split_path(words).each do |word|
-          word = word.to_s
-          subtool_words << word
-          next_remaining = Loader.next_remaining_words(next_remaining, word)
-        end
+      def tool(words, if_defined: :combine, delegate_to: nil, delegate_relative: nil, &block)
+        subtool_words, next_remaining = DSL::Internal.analyze_name(self, words)
         subtool = @__loader.get_tool(subtool_words, @__priority)
         if subtool.includes_definition?
           case if_defined
@@ -314,9 +312,14 @@ module Toys
             subtool.reset_definition
           end
         end
-        if delegate_to
-          delegator = proc { self.delegate_to(delegate_to) }
-          @__loader.load_block(source_info, delegator, subtool_words, next_remaining, @__priority)
+        if delegate_to || delegate_relative
+          delegate_to2 = @__words + @__loader.split_path(delegate_relative) if delegate_relative
+          orig_block = block
+          block = proc do
+            self.delegate_to(delegate_to) if delegate_to
+            self.delegate_to(delegate_to2) if delegate_to2
+            instance_eval(&orig_block) if orig_block
+          end
         end
         if block
           @__loader.load_block(source_info, block, subtool_words, next_remaining, @__priority)
@@ -327,9 +330,9 @@ module Toys
       ##
       # Create an alias, representing an "alternate name" for a tool.
       #
-      # This is functionally equivalent to creating a subtool with the
-      # `delegate_to` option, except that `alias_tool` takes a _relative_ name
-      # for the delegate.
+      # Note: This is functionally equivalent to creating a tool with the
+      # `:delegate_relative` option. As such, `alias_tool` is considered
+      # deprecated.
       #
       # ### Example
       #
@@ -342,21 +345,25 @@ module Toys
       #       end
       #     end
       #     alias_tool "t", "test"
+      #     # Note: the following is preferred over alias_tool:
+      #     # tool "t", delegate_relative: "test"
       #
       # @param word [String] The name of the alias
       # @param target [String,Array<String>] Relative path to the target of the
       #     alias. This path may be given as an array of strings, or a single
       #     string possibly delimited by path separators.
       # @return [self]
+      # @deprecated Use {#tool} and pass `:delegate_relative` instead
       #
       def alias_tool(word, target)
-        tool(word, delegate_to: @__words + @__loader.split_path(target))
+        tool(word, delegate_relative: target)
         self
       end
 
       ##
-      # Causes the current tool to delegate to another tool. When run, it
-      # simply invokes the target tool with the same arguments.
+      # Causes the current tool to delegate to another tool, specified by the
+      # full tool name. When run, it simply invokes the target tool with the
+      # same arguments.
       #
       # ### Example
       #
@@ -1721,6 +1728,18 @@ module Toys
         super
         DSL::Internal.current_tool(self, true)&.check_definition_state(is_method: true)
       end
+
+      ##
+      # Include the tool name in the class inspection dump.
+      #
+      # @private
+      #
+      def inspect
+        return super unless defined? @__words
+        name = @__words.empty? ? "(root)" : @__words.join(" ").inspect
+        id = object_id.to_s(16)
+        "#<Class id=0x#{id} tool=#{name}>"
+      end
     end
   end
 end

data/lib/toys/errors.rb

@@ -172,7 +172,9 @@ module Toys
 
       def add_config_path_if_missing(error, path)
         if error.config_path.nil? && error.config_line.nil?
-          l = (error.cause.backtrace_locations || []).find { |b| b.absolute_path == path }
+          l = (error.cause.backtrace_locations || []).find do |b|
+            b.absolute_path == path || b.path == path
+          end
           if l
             error.config_path = path
             error.config_line = l.lineno

data/lib/toys/flag.rb

@@ -774,12 +774,15 @@ module Toys
       long_flag_syntax.reverse_each do |flag|
         analyze_flag_syntax(flag)
       end
-      @flag_type ||= :boolean
       if @flag_type == :boolean && @explicit_acceptor
         raise ToolDefinitionError,
               "Flag #{key.inspect} cannot have an acceptor because it does not take a value."
       end
-      @value_type ||= :required if @flag_type == :value
+      @flag_type ||= (@explicit_acceptor ? :value : :boolean)
+      if @flag_type == :value
+        @value_type ||= :required
+        @value_label ||= "VALUE"
+      end
       flag_syntax.each do |flag|
         flag.configure_canonical(@flag_type, @value_type, @value_label, @value_delim)
       end

data/lib/toys/input_file.rb

@@ -23,7 +23,7 @@ module Toys::InputFile # rubocop:disable Style/ClassAndModuleChildren
       ::Toys::DSL::Internal.prepare(tool_class, words, priority, remaining_words, source, loader) do
         ::Toys::ContextualError.capture_path("Error while loading Toys config!", path) do
           # rubocop:disable Security/Eval
-          eval(str, __binding, path, -2)
+          eval(str, __binding, path)
           # rubocop:enable Security/Eval
         end
       end
@@ -43,11 +43,9 @@ module Toys::InputFile # rubocop:disable Style/ClassAndModuleChildren
   def self.build_eval_string(module_name, string)
     index = string.index(/^\s*[^#\s]/)
     return nil if index.nil?
-    "#{string[0, index]}\n" \
-      "module #{module_name}\n" \
-      "@__tool_class.class_eval do\n" \
+    "#{string[0, index]}" \
+      "module #{module_name}; @__tool_class.class_eval do; " \
       "#{string[index..-1]}\n" \
-      "end\n" \
-      "end\n"
+      "end; end\n"
   end
 end

data/lib/toys/tool_definition.rb

@@ -1254,9 +1254,10 @@ module Toys
     #
     def delegate_to(target)
       if @delegate_target
+        return self if target == @delegate_target
         raise ToolDefinitionError,
-              "Cannot delegate tool #{display_name.inspect} because" \
-              " it already delegates to \"#{@delegate_target.join(' ')}\"."
+              "Cannot delegate tool #{display_name.inspect} to #{target.join(' ')} because it" \
+              " already delegates to \"#{@delegate_target.join(' ')}\"."
       end
       if includes_arguments?
         raise ToolDefinitionError,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: toys-core
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.14.2
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-03 00:00:00.000000000 Z
+date: 2022-10-09 00:00:00.000000000 Z
 dependencies: []
 description: Toys-Core is the command line tool framework underlying Toys. It can
   be used to create command line executables using the Toys DSL and classes.
@@ -78,10 +78,10 @@ homepage: https://github.com/dazuma/toys
 licenses:
 - MIT
 metadata:
-  changelog_uri: https://dazuma.github.io/toys/gems/toys-core/v0.14.1/file.CHANGELOG.html
+  changelog_uri: https://dazuma.github.io/toys/gems/toys-core/v0.14.2/file.CHANGELOG.html
   source_code_uri: https://github.com/dazuma/toys/tree/main/toys-core
   bug_tracker_uri: https://github.com/dazuma/toys/issues
-  documentation_uri: https://dazuma.github.io/toys/gems/toys-core/v0.14.1
+  documentation_uri: https://dazuma.github.io/toys/gems/toys-core/v0.14.2
 post_install_message: 
 rdoc_options: []
 require_paths: