toys-core 0.9.4 → 0.10.0

data/lib/toys/mixin.rb

@@ -1,26 +1,5 @@
 # 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 mixin definition. Mixin modules should include this module.

data/lib/toys/module_lookup.rb

@@ -1,26 +1,5 @@
 # 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.
-;
-
 require "monitor"
 
 module Toys
@@ -73,13 +52,11 @@ module Toys
       end
     end
 
-    include ::MonitorMixin
-
     ##
     # Create an empty ModuleLookup
     #
     def initialize
-      super()
+      @mutex = ::Monitor.new
       @paths = []
       @paths_locked = false
     end
@@ -96,7 +73,7 @@ module Toys
     #
     def add_path(path_base, module_base: nil, high_priority: false)
       module_base ||= ModuleLookup.path_to_module(path_base)
-      synchronize do
+      @mutex.synchronize do
         raise "You cannot add a path after a lookup has already occurred." if @paths_locked
         if high_priority
           @paths.unshift([path_base, module_base])
@@ -114,7 +91,7 @@ module Toys
     # @return [Module] The specified module
     #
     def lookup(name)
-      synchronize do
+      @mutex.synchronize do
         @paths_locked = true
         @paths.each do |path_base, module_base|
           path = "#{path_base}/#{ModuleLookup.to_path_name(name)}"

data/lib/toys/positional_arg.rb

@@ -1,26 +1,5 @@
 # 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
   ##
   # Representation of a formal positional argument

data/lib/toys/source_info.rb

@@ -1,26 +1,5 @@
 # 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
   ##
   # Information about source toys directories and files.
@@ -30,19 +9,17 @@ module Toys
     # Create a SourceInfo.
     # @private
     #
-    def initialize(parent, context_directory, source, source_type, source_name, data_dir_name)
+    def initialize(parent, context_directory, source_type, source_path, source_proc,
+                   source_name, data_dir, lib_dir)
       @parent = parent
       @context_directory = context_directory
-      @source = source
       @source_type = source_type
-      @source_path = source if source.is_a?(::String)
-      @source_proc = source if source.is_a?(::Proc)
+      @source = source_type == :proc ? source_proc : source_path
+      @source_path = source_path
+      @source_proc = source_proc
       @source_name = source_name
-      @data_dir =
-        if data_dir_name && @source_path
-          dir = ::File.join(::File.dirname(@source_path), data_dir_name)
-          dir if ::File.directory?(dir) && ::File.readable?(dir)
-        end
+      @data_dir = data_dir
+      @lib_dir = lib_dir
     end
 
     ##
@@ -82,7 +59,7 @@ module Toys
     # The path of the current source file or directory.
     #
     # @return [String] The source path
-    # @return [nil] if this source is not a file system path.
+    # @return [nil] if this source has no file system path.
     #
     attr_reader :source_path
 
@@ -90,7 +67,7 @@ module Toys
     # The source proc.
     #
     # @return [Proc] The source proc
-    # @return [nil] if this source is not a proc.
+    # @return [nil] if this source has no proc.
     #
     attr_reader :source_proc
 
@@ -126,16 +103,30 @@ module Toys
       parent&.find_data(path, type: type)
     end
 
+    ##
+    # Apply all lib paths in order from high to low priority
+    #
+    # @return [self]
+    #
+    def apply_lib_paths
+      parent&.apply_lib_paths
+      $LOAD_PATH.unshift(@lib_dir) if @lib_dir && !$LOAD_PATH.include?(@lib_dir)
+      self
+    end
+
     ##
     # Create a child SourceInfo relative to the parent path.
     # @private
     #
-    def relative_child(filename, data_dir_name)
-      raise "Cannot create relative child of a proc" unless source_path
+    def relative_child(filename, data_dir_name, lib_dir_name)
+      raise "no parent path for relative_child" unless source_path
       child_path = ::File.join(source_path, filename)
       child_path, type = SourceInfo.check_path(child_path, true)
       return nil unless child_path
-      SourceInfo.new(self, context_directory, child_path, type, child_path, data_dir_name)
+      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)
     end
 
     ##
@@ -144,7 +135,16 @@ module Toys
     #
     def absolute_child(child_path)
       child_path, type = SourceInfo.check_path(child_path, false)
-      SourceInfo.new(self, context_directory, child_path, type, child_path, nil)
+      SourceInfo.new(self, context_directory, type, child_path, source_proc, child_path, nil, nil)
+    end
+
+    ##
+    # Create a proc child SourceInfo
+    # @private
+    #
+    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)
     end
 
     ##
@@ -154,7 +154,7 @@ module Toys
     def self.create_path_root(source_path)
       source_path, type = check_path(source_path, false)
       context_directory = ::File.dirname(source_path)
-      new(nil, context_directory, source_path, type, source_path, nil)
+      new(nil, context_directory, type, source_path, nil, source_path, nil, nil)
     end
 
     ##
@@ -162,7 +162,7 @@ module Toys
     # @private
     #
     def self.create_proc_root(source_proc, source_name)
-      new(nil, nil, source_proc, :proc, source_name, nil)
+      new(nil, nil, :proc, nil, source_proc, source_name, nil, nil)
     end
 
     ##
@@ -188,5 +188,16 @@ module Toys
         [nil, nil]
       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)
+      dir if ::File.directory?(dir) && ::File.readable?(dir)
+    end
   end
 end

data/lib/toys/standard_middleware/add_verbosity_flags.rb

@@ -1,26 +1,5 @@
 # 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
   module StandardMiddleware
     ##
@@ -31,8 +10,6 @@ module Toys
     # {Toys::Context::Key::VERBOSITY}, and, thus, the logger level.
     #
     class AddVerbosityFlags
-      include Middleware
-
       ##
       # Default verbose flags
       # @return [Array<String>]

data/lib/toys/standard_middleware/apply_config.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Toys
+  module StandardMiddleware
+    ##
+    # A middleware that applies the given block to all tool configurations.
+    #
+    class ApplyConfig
+      ##
+      # Create an ApplyConfig middleware
+      #
+      # @param parent_source [Toys::SourceInfo] The SourceInfo corresponding to
+      #     the source where this block is provided, or `nil` (the default) if
+      #     the block does not come from a Toys file.
+      # @param source_name [String] A user-visible name for the source, or
+      #     `nil` to use the default.
+      # @param block [Proc] The configuration to apply.
+      #
+      def initialize(parent_source: nil, source_name: nil, &block)
+        @source_info =
+          if parent_source
+            parent_source.proc_child(block, source_name)
+          else
+            SourceInfo.create_proc_root(block, source_name)
+          end
+        @block = block
+      end
+
+      ##
+      # Appends the configuration block.
+      # @private
+      #
+      def config(tool, _loader)
+        tool_class = tool.tool_class
+        DSL::Tool.prepare(tool_class, nil, @source_info) do
+          tool_class.class_eval(&@block)
+        end
+        yield
+      end
+    end
+  end
+end

data/lib/toys/standard_middleware/handle_usage_errors.rb

@@ -1,26 +1,5 @@
 # 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
   module StandardMiddleware
     ##
@@ -30,8 +9,6 @@ module Toys
     # the short help string, and terminates execution with an error code.
     #
     class HandleUsageErrors
-      include Middleware
-
       ##
       # Exit code for usage error. (2 by convention)
       # @return [Integer]
@@ -49,9 +26,9 @@ module Toys
       #     a tty. Default is `nil`.
       #
       def initialize(exit_code: nil, stream: $stderr, styled_output: nil)
-        require "toys/utils/terminal"
         @exit_code = exit_code || USAGE_ERROR_EXIT_CODE
-        @terminal = Utils::Terminal.new(output: stream, styled: styled_output)
+        @stream = stream
+        @styled_output = styled_output
       end
 
       ##
@@ -61,11 +38,13 @@ module Toys
       def run(context)
         yield
       rescue ArgParsingError => e
+        require "toys/utils/terminal"
         require "toys/utils/help_text"
         help_text = Utils::HelpText.from_context(context)
-        @terminal.puts(e.usage_errors.join("\n"), :bright_red, :bold)
-        @terminal.puts("")
-        @terminal.puts(help_text.usage_string(wrap_width: @terminal.width))
+        terminal = Utils::Terminal.new(output: @stream, styled: @styled_output)
+        terminal.puts(e.usage_errors.join("\n"), :bright_red, :bold)
+        terminal.puts("")
+        terminal.puts(help_text.usage_string(wrap_width: terminal.width))
         Context.exit(@exit_code)
       end
     end

data/lib/toys/standard_middleware/set_default_descriptions.rb

@@ -1,26 +1,5 @@
 # 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
   module StandardMiddleware
     ##
@@ -32,8 +11,6 @@ module Toys
     # you can override methods to modify the description generation logic.
     #
     class SetDefaultDescriptions
-      include Middleware
-
       ##
       # The default description for tools.
       # @return [String]

data/lib/toys/standard_middleware/show_help.rb

@@ -1,26 +1,5 @@
 # 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
   module StandardMiddleware
     ##
@@ -34,8 +13,6 @@ module Toys
     # middleware can also search for keywords in its subtools.
     #
     class ShowHelp
-      include Middleware
-
       ##
       # Default help flags
       # @return [Array<String>]