toys-core 0.9.4 → 0.10.0

data/lib/toys/standard_middleware/show_root_version.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
     ##
@@ -28,8 +7,6 @@ module Toys
     # `--version` flag is given.
     #
     class ShowRootVersion
-      include Middleware
-
       ##
       # Default version flags
       # @return [Array<String>]

data/lib/toys/standard_mixins/bundler.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Toys
+  module StandardMixins
+    ##
+    # Ensures that a bundle is installed and set up when this tool is run.
+    #
+    # The following parameters can be passed when including this mixin:
+    #
+    #  *  `:groups` (Array<String>) The groups to include in setup
+    #
+    #  *  `:search_dirs` (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
+    #
+    #     The default is to search `[:toys, :context, :current]` in that order.
+    #
+    #  *  `: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
+    #
+    #  *  `: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
+    #
+    #  *  `:terminal` (Toys::Utils::Terminal) Terminal to use (optional)
+    #  *  `:input` (IO) Input IO (optional, defaults to STDIN)
+    #  *  `:output` (IO) Output IO (optional, defaults to STDOUT)
+    #
+    module Bundler
+      include Mixin
+
+      on_initialize do
+        |groups: nil,
+         search_dirs: nil,
+         on_missing: nil,
+         on_conflict: nil,
+         terminal: nil,
+         input: nil,
+         output: nil|
+        require "toys/utils/gems"
+        search_dirs = ::Toys::StandardMixins::Bundler.resolve_search_dirs(search_dirs, self)
+        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)
+      end
+
+      ## @private
+      def self.resolve_search_dirs(search_dirs, context)
+        search_dirs ||= [:toys, :context, :current]
+        Array(search_dirs).flat_map do |dir|
+          case dir
+          when :context
+            context[::Toys::Context::Key::CONTEXT_DIRECTORY]
+          when :current
+            ::Dir.getwd
+          when :toys
+            toys_dir_stack(context[::Toys::Context::Key::TOOL_SOURCE])
+          when ::String
+            dir
+          else
+            raise ::ArgumentError, "Unrecognized search_dir: #{dir.inspect}"
+          end
+        end
+      end
+
+      ## @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
+    end
+  end
+end

data/lib/toys/standard_mixins/exec.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 StandardMixins
     ##
@@ -173,11 +152,14 @@ module Toys
       alias ruby exec_ruby
 
       ##
-      # Execute a proc in a subprocess.
+      # Execute a proc in a forked subprocess.
       #
       # If the process is not set to run in the background, and a block is
       # provided, a {Toys::Utils::Exec::Controller} will be yielded to it.
       #
+      # Beware that some Ruby environments (e.g. JRuby, and Ruby on Windows)
+      # do not support this method because they do not support fork.
+      #
       # @param func [Proc] The proc to call.
       # @param opts [keywords] The command options. Most options listed in the
       #     {Toys::Utils::Exec} documentation are supported, plus the
@@ -196,12 +178,17 @@ module Toys
       end
 
       ##
-      # Execute a tool. The command may be given as a single string or an array
-      # of strings, representing the tool to run and the arguments to pass.
+      # Execute a tool in the current CLI in a forked process.
+      #
+      # The command may be given as a single string or an array of strings,
+      # representing the tool to run and the arguments to pass.
       #
       # If the process is not set to run in the background, and a block is
       # provided, a {Toys::Utils::Exec::Controller} will be yielded to it.
       #
+      # Beware that some Ruby environments (e.g. JRuby, and Ruby on Windows)
+      # do not support this method because they do not support fork.
+      #
       # @param cmd [String,Array<String>] The tool to execute.
       # @param opts [keywords] The command options. Most options listed in the
       #     {Toys::Utils::Exec} documentation are supported, plus the
@@ -220,6 +207,46 @@ module Toys
         self[KEY].exec_proc(func, **opts, &block)
       end
 
+      ##
+      # Execute a tool in a separately spawned process.
+      #
+      # The command may be given as a single string or an array of strings,
+      # representing the tool to run and the arguments to pass.
+      #
+      # If the process is not set to run in the background, and a block is
+      # provided, a {Toys::Utils::Exec::Controller} will be yielded to it.
+      #
+      # An entirely separate spawned process is run for this tool, using the
+      # setting of {Toys.executable_path}. Thus, this method can be run only if
+      # that setting is present. The normal Toys gem does set it, but if you
+      # are writing your own executable using Toys-Core, you will need to set
+      # it explicitly for this method to work. Furthermore, Bundler, if
+      # present, is reset to its "unbundled" environment. Thus, the tool found,
+      # the behavior of the CLI, and the gem environment, might not be the same
+      # as those of the calling tool.
+      #
+      # This method is often used if you are already in a bundle and need to
+      # run a tool that uses a different bundle. It may also be necessary on
+      # environments without "fork" (such as JRuby or Ruby on Windows).
+      #
+      # @param cmd [String,Array<String>] The tool to execute.
+      # @param opts [keywords] The command options. Most options listed in the
+      #     {Toys::Utils::Exec} documentation are supported, plus the
+      #     `exit_on_nonzero_status` option.
+      # @yieldparam controller [Toys::Utils::Exec::Controller] A controller
+      #     for the subprocess streams.
+      #
+      # @return [Toys::Utils::Exec::Controller] The subprocess controller, if
+      #     the process is running in the background.
+      # @return [Toys::Utils::Exec::Result] The result, if the process ran in
+      #     the foreground.
+      #
+      def exec_separate_tool(cmd, **opts, &block)
+        Exec._setup_clean_process(cmd) do |clean_cmd|
+          exec(clean_cmd, **opts, &block)
+        end
+      end
+
       ##
       # Execute a command. The command may be given as a single string to pass
       # to a shell, or an array of strings indicating a posix command.
@@ -268,7 +295,7 @@ module Toys
       end
 
       ##
-      # Execute a proc in a subprocess.
+      # Execute a proc in a forked subprocess.
       #
       # Captures standard out and returns it as a string.
       # Cannot be run in the background.
@@ -276,6 +303,9 @@ module Toys
       # If a block is provided, a {Toys::Utils::Exec::Controller} will be
       # yielded to it.
       #
+      # Beware that some Ruby environments (e.g. JRuby, and Ruby on Windows)
+      # do not support this method because they do not support fork.
+      #
       # @param func [Proc] The proc to call.
       # @param opts [keywords] The command options. Most options listed in the
       #     {Toys::Utils::Exec} documentation are supported, plus the
@@ -291,15 +321,20 @@ module Toys
       end
 
       ##
-      # Execute a tool. The command may be given as a single string or an array
-      # of strings, representing the tool to run and the arguments to pass.
+      # Execute a tool in the current CLI in a forked process.
       #
       # Captures standard out and returns it as a string.
       # Cannot be run in the background.
       #
+      # The command may be given as a single string or an array of strings,
+      # representing the tool to run and the arguments to pass.
+      #
       # If a block is provided, a {Toys::Utils::Exec::Controller} will be
       # yielded to it.
       #
+      # Beware that some Ruby environments (e.g. JRuby, and Ruby on Windows)
+      # do not support this method because they do not support fork.
+      #
       # @param cmd [String,Array<String>] The tool to execute.
       # @param opts [keywords] The command options. Most options listed in the
       #     {Toys::Utils::Exec} documentation are supported, plus the
@@ -315,6 +350,46 @@ module Toys
         self[KEY].capture_proc(func, **opts, &block)
       end
 
+      ##
+      # Execute a tool in a separately spawned process.
+      #
+      # Captures standard out and returns it as a string.
+      # Cannot be run in the background.
+      #
+      # The command may be given as a single string or an array of strings,
+      # representing the tool to run and the arguments to pass.
+      #
+      # If a block is provided, a {Toys::Utils::Exec::Controller} will be
+      # yielded to it.
+      #
+      # An entirely separate spawned process is run for this tool, using the
+      # setting of {Toys.executable_path}. Thus, this method can be run only if
+      # that setting is present. The normal Toys gem does set it, but if you
+      # are writing your own executable using Toys-Core, you will need to set
+      # it explicitly for this method to work. Furthermore, Bundler, if
+      # present, is reset to its "unbundled" environment. Thus, the tool found,
+      # the behavior of the CLI, and the gem environment, might not be the same
+      # as those of the calling tool.
+      #
+      # This method is often used if you are already in a bundle and need to
+      # run a tool that uses a different bundle. It may also be necessary on
+      # environments without "fork" (such as JRuby or Ruby on Windows).
+      #
+      # @param cmd [String,Array<String>] The tool to execute.
+      # @param opts [keywords] The command options. Most options listed in the
+      #     {Toys::Utils::Exec} documentation are supported, plus the
+      #     `exit_on_nonzero_status` option.
+      # @yieldparam controller [Toys::Utils::Exec::Controller] A controller
+      #     for the subprocess streams.
+      #
+      # @return [String] What was written to standard out.
+      #
+      def capture_separate_tool(cmd, **opts, &block)
+        Exec._setup_clean_process(cmd) do |clean_cmd|
+          capture(clean_cmd, **opts, &block)
+        end
+      end
+
       ##
       # Execute the given string in a shell. Returns the exit code.
       # Cannot be run in the background.
@@ -368,14 +443,12 @@ module Toys
 
       ## @private
       def self._setup_e_option(opts, context)
-        result_callback =
-          if opts[:exit_on_nonzero_status] || opts[:e]
-            proc { |r| context.exit(r.exit_code) if r.error? }
-          end
-        opts = opts.merge(result_callback: result_callback)
-        opts.delete(:exit_on_nonzero_status)
-        opts.delete(:e)
-        opts
+        e_options = [:exit_on_nonzero_status, :e]
+        if e_options.any? { |k| opts[k] }
+          result_callback = proc { |r| context.exit(r.exit_code) if r.error? }
+          opts = opts.merge(result_callback: result_callback)
+        end
+        opts.reject { |k, _v| e_options.include?(k) }
       end
 
       ## @private
@@ -389,6 +462,22 @@ module Toys
           end
         opts.merge(result_callback: result_callback)
       end
+
+      ## @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)
+        cmd = Array(::Toys.executable_path) + cmd
+        if defined?(::Bundler)
+          if ::Bundler.respond_to?(:with_unbundled_env)
+            ::Bundler.with_unbundled_env { yield(cmd) }
+          else
+            ::Bundler.with_clean_env { yield(cmd) }
+          end
+        else
+          yield(cmd)
+        end
+      end
     end
   end
 end

data/lib/toys/standard_mixins/fileutils.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 "fileutils"
 
 module Toys

data/lib/toys/standard_mixins/gems.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 StandardMixins
     ##
@@ -39,10 +18,9 @@ module Toys
     # If you pass additional options to the include directive, those are used
     # to initialize settings for the gem install process. For example:
     #
-    #     include :gems, output: $stdout, default_confirm: false
+    #     include :gems, on_missing: :error
     #
-    # This is a frontend for {Toys::Utils::Gems}. More information is
-    # available in that class's documentation.
+    # See {Toys::Utils::Gems#initialize} for a list of supported options.
     #
     module Gems
       include Mixin

data/lib/toys/standard_mixins/highline.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 StandardMixins
     ##