toys-core 0.15.6 → 0.17.0

data/lib/toys/utils/exec.rb

@@ -304,7 +304,7 @@ module Toys
           if cmd.is_a?(::Array)
             if cmd.size > 1
               binary = canonical_binary_spec(cmd.first, exec_opts)
-              [binary] + cmd[1..-1].map(&:to_s)
+              [binary] + cmd[1..].map(&:to_s)
             else
               [canonical_binary_spec(Array(cmd.first), exec_opts)]
             end
@@ -521,14 +521,12 @@ module Toys
         def capture(which)
           stream = stream_for(which)
           @join_threads << ::Thread.new do
-            begin
-              data = stream.read
-              @mutex.synchronize do
-                @captures[which] = data
-              end
-            ensure
-              stream.close
+            data = stream.read
+            @mutex.synchronize do
+              @captures[which] = data
             end
+          ensure
+            stream.close
           end
           self
         end
@@ -577,16 +575,14 @@ module Toys
           end
           stream = stream_for(which, allow_in: true)
           @join_threads << ::Thread.new do
-            begin
-              if which == :in
-                ::IO.copy_stream(io, stream)
-              else
-                ::IO.copy_stream(stream, io)
-              end
-            ensure
-              stream.close
-              io.close
+            if which == :in
+              ::IO.copy_stream(io, stream)
+            else
+              ::IO.copy_stream(stream, io)
             end
+          ensure
+            stream.close
+            io.close
           end
           self
         end
@@ -1065,7 +1061,7 @@ module Toys
             else
               cmd_binary = @spawn_cmd.first
               cmd_binary = cmd_binary.first if cmd_binary.is_a?(::Array)
-              "exec: #{([cmd_binary] + @spawn_cmd[1..-1]).inspect}"
+              "exec: #{([cmd_binary] + @spawn_cmd[1..]).inspect}"
             end
           end
         end
@@ -1218,7 +1214,7 @@ module Toys
 
         def interpret_in_array(setting)
           if setting.first.is_a?(::Symbol)
-            setup_in_stream_of_type(setting.first, setting[1..-1])
+            setup_in_stream_of_type(setting.first, setting[1..])
           elsif setting.first.is_a?(::String)
             setup_in_stream_of_type(:file, setting)
           elsif setting.size == 2 && setting.first.is_a?(::IO) && setting.last.is_a?(::IO)
@@ -1292,7 +1288,7 @@ module Toys
 
         def interpret_out_array(key, setting)
           if setting.first.is_a?(::Symbol)
-            setup_out_stream_of_type(key, setting.first, setting[1..-1])
+            setup_out_stream_of_type(key, setting.first, setting[1..])
           elsif setting.first.is_a?(::String)
             setup_out_stream_of_type(key, :file, setting)
           elsif setting.size == 2 && setting.first.is_a?(::IO) && setting.last.is_a?(::IO)
@@ -1381,7 +1377,7 @@ module Toys
              (arg.first == :autoclose || arg.first.is_a?(::IO))
             [arg.last, :close]
           else
-            arg = arg[1..-1] if arg.first == :file
+            arg = arg[1..] if arg.first == :file
             if arg.empty? || !arg.first.is_a?(::String)
               raise "Expected file name for #{key} tee argument"
             end
@@ -1498,49 +1494,41 @@ module Toys
         def write_string_thread(string)
           stream = make_in_pipe
           @join_threads << ::Thread.new do
-            begin
-              stream.write string
-            ensure
-              stream.close
-            end
+            stream.write string
+          ensure
+            stream.close
           end
         end
 
         def copy_to_in_thread(io)
           stream = make_in_pipe
           @join_threads << ::Thread.new do
-            begin
-              ::IO.copy_stream(io, stream)
-            ensure
-              stream.close
-              io.close
-            end
+            ::IO.copy_stream(io, stream)
+          ensure
+            stream.close
+            io.close
           end
         end
 
         def copy_from_out_thread(key, io)
           stream = make_out_pipe(key)
           @join_threads << ::Thread.new do
-            begin
-              ::IO.copy_stream(stream, io)
-            ensure
-              stream.close
-              io.close
-            end
+            ::IO.copy_stream(stream, io)
+          ensure
+            stream.close
+            io.close
           end
         end
 
         def capture_stream_thread(key)
           stream = make_out_pipe(key)
           @join_threads << ::Thread.new do
-            begin
-              data = stream.read
-              @mutex.synchronize do
-                @captures[key] = data
-              end
-            ensure
-              stream.close
+            data = stream.read
+            @mutex.synchronize do
+              @captures[key] = data
             end
+          ensure
+            stream.close
           end
         end
       end

data/lib/toys/utils/gems.rb

@@ -146,11 +146,9 @@ module Toys
       #
       def activate(name, *requirements)
         Gems.synchronize do
-          begin
-            gem(name, *requirements)
-          rescue ::Gem::LoadError => e
-            handle_activation_error(e, name, requirements)
-          end
+          gem(name, *requirements)
+        rescue ::Gem::LoadError => e
+          handle_activation_error(e, name, requirements)
         end
       end
 
@@ -395,7 +393,7 @@ module Toys
         modified_lockfile_path = find_lockfile_path(modified_gemfile_path)
         if ::File.readable?(lockfile_path)
           lockfile_content = ::File.read(lockfile_path)
-          ::File.open(modified_lockfile_path, "w") { |file| file.write(lockfile_content) }
+          ::File.write(modified_lockfile_path, lockfile_content)
         end
         modified_gemfile_path
       end
@@ -423,9 +421,11 @@ module Toys
       end
 
       def delete_modified_gemfile(modified_gemfile_path)
+        # rubocop:disable Lint/NonAtomicFileOperation
         ::File.delete(modified_gemfile_path) if ::File.exist?(modified_gemfile_path)
         modified_lockfile_path = find_lockfile_path(modified_gemfile_path)
         ::File.delete(modified_lockfile_path) if ::File.exist?(modified_lockfile_path)
+        # rubocop:enable Lint/NonAtomicFileOperation
       end
 
       def restore_toys_libs
@@ -465,7 +465,7 @@ module Toys
         return if result.success?
         terminal.puts("Failed to update. Trying update with clean lockfile...")
         lockfile_path = find_lockfile_path(gemfile_path)
-        ::File.delete(lockfile_path) if ::File.exist?(lockfile_path)
+        ::File.delete(lockfile_path) if ::File.exist?(lockfile_path) # rubocop:disable Lint/NonAtomicFileOperation
         result = exec_util.exec_ruby([bundler_bin, "update"] + args)
         return if result.success?
         raise ::Bundler::InstallError, "Failed to install or update bundle: #{gemfile_path}"

data/lib/toys/utils/git_cache.rb

@@ -274,6 +274,21 @@ module Toys
         end
       end
 
+      ##
+      # Returns whether shared source files are writable by default.
+      # Normally, shared sources are made read-only to protect them from being
+      # modified accidentally since multiple clients may be accessing them.
+      # However, you can disable this feature by setting the environment
+      # variable `TOYS_GIT_CACHE_WRITABLE` to any non-empty value. This can be
+      # useful in environments that want to clean up temporary directories and
+      # are being hindered by read-only files.
+      #
+      # @return [boolean]
+      #
+      def self.sources_writable?
+        !::ENV["TOYS_GIT_CACHE_WRITABLE"].to_s.empty?
+      end
+
       ##
       # Access a git cache.
       #
@@ -318,7 +333,7 @@ module Toys
       # @param into [String] If provided, copies the specified files into the
       #     given directory path. If omitted or `nil`, populates and returns a
       #     shared source file or directory.
-      # @param update [Boolean,Integer] Whether to update of non-SHA commit
+      # @param update [Boolean,Integer] Whether to update non-SHA commit
       #     references if they were previously loaded. This is useful, for
       #     example, if the commit is `HEAD` or a branch name. Pass `true` or
       #     `false` to specify whether to update, or an integer to update if
@@ -545,7 +560,7 @@ module Toys
         repo_dir = ::File.join(dir, REPO_DIR_NAME)
         is_sha = commit =~ /^[0-9a-f]{40}$/
         update = repo_lock.ref_stale?(commit, update) unless is_sha
-        if update && !is_sha || !commit_exists?(repo_dir, local_commit)
+        if (update && !is_sha) || !commit_exists?(repo_dir, local_commit)
           git(repo_dir, ["fetch", "--depth=1", "--force", "origin", "#{commit}:#{local_commit}"],
               error_message: "Unable to fetch commit: #{commit}")
           repo_lock.update_ref!(commit)
@@ -569,7 +584,7 @@ module Toys
           ::FileUtils.mkdir_p(source_path)
           ::FileUtils.chmod_R("u+w", source_path, force: true)
           copy_from_repo(repo_path, source_path, sha, path)
-          ::FileUtils.chmod_R("a-w", source_path, force: true)
+          ::FileUtils.chmod_R("a-w", source_path, force: true) unless GitCache.sources_writable?
         end
         repo_lock.access_source!(sha, path)
         path == "." ? source_path : ::File.join(source_path, path)
@@ -579,7 +594,7 @@ module Toys
         repo_path = ::File.join(dir, REPO_DIR_NAME)
         ::FileUtils.mkdir_p(into)
         ::FileUtils.chmod_R("u+w", into, force: true)
-        Compat.dir_children(into).each { |child| ::FileUtils.rm_rf(::File.join(into, child)) }
+        ::Dir.children(into).each { |child| ::FileUtils.rm_rf(::File.join(into, child)) }
         result = copy_from_repo(repo_path, into, sha, path)
         repo_lock.access_repo!
         result
@@ -588,7 +603,7 @@ module Toys
       def copy_from_repo(repo_dir, into, sha, path)
         git(repo_dir, ["checkout", sha])
         if path == "."
-          Compat.dir_children(repo_dir).each do |entry|
+          ::Dir.children(repo_dir).each do |entry|
             next if entry == ".git"
             to_path = ::File.join(into, entry)
             unless ::File.exist?(to_path)
@@ -746,6 +761,9 @@ module Toys
           @data["sources"][sha]&.fetch(path, nil)
         end
 
+        ##
+        # @private
+        #
         def find_sources(paths: nil, shas: nil)
           results = []
           @data["sources"].each do |sha, sha_data|

data/lib/toys/utils/help_text.rb

@@ -312,7 +312,7 @@ module Toys
           remaining_doc = desc
           if initial.size <= @indent + @left_column_width
             @lines << "#{initial} #{desc.first}"
-            remaining_doc = desc[1..-1] || []
+            remaining_doc = desc[1..] || []
           else
             @lines << initial
           end
@@ -398,7 +398,7 @@ module Toys
           else
             desc = wrap_indent_indent2(WrappableString.new(["#{prefix} -"] + desc.fragments))
             @lines << indent_str(desc[0])
-            desc[1..-1].each do |line|
+            desc[1..].each do |line|
               @lines << indent2_str(line)
             end
           end
@@ -523,7 +523,7 @@ module Toys
               desc += delegate.long_desc
             end
           end
-          desc = desc[1..-1] if desc.first == ""
+          desc = desc[1..] if desc.first == ""
           desc = wrap_indent(desc)
           return if desc.empty?
           @lines << ""
@@ -728,7 +728,7 @@ module Toys
           else
             desc = wrap_indent(WrappableString.new(["#{prefix} -"] + desc.fragments))
             @lines << desc[0]
-            desc[1..-1].each do |line|
+            desc[1..].each do |line|
               @lines << indent_str(line)
             end
           end

data/lib/toys/utils/pager.rb

@@ -64,11 +64,9 @@ module Toys
       def start
         if @command
           result = @exec_service.exec(@command, in: :controller) do |controller|
-            begin
-              yield controller.in if controller.pid
-            rescue ::Errno::EPIPE => e
-              raise e unless @rescue_broken_pipes
-            end
+            yield controller.in if controller.pid
+          rescue ::Errno::EPIPE => e
+            raise e unless @rescue_broken_pipes
           end
           return result.exit_code unless result.failed?
         end

data/lib/toys/utils/terminal.rb

@@ -155,12 +155,10 @@ module Toys
       #
       def write(str = "", *styles)
         @output_mutex.synchronize do
-          begin
-            output&.write(apply_styles(str.to_s, *styles))
-            output&.flush
-          rescue ::IOError
-            nil
-          end
+          output&.write(apply_styles(str.to_s, *styles))
+          output&.flush
+        rescue ::IOError
+          nil
         end
         self
       end
@@ -173,11 +171,9 @@ module Toys
       #
       def readline
         @input_mutex.synchronize do
-          begin
-            input&.gets
-          rescue ::IOError
-            nil
-          end
+          input&.gets
+        rescue ::IOError
+          nil
         end
       end
 
@@ -470,7 +466,7 @@ module Toys
                 @terminal.write(@frames[@cur_frame][0])
                 @cond.wait(@frame_length)
                 size = @frames[@cur_frame][1]
-                @terminal.write("\b" * size + " " * size + "\b" * size)
+                @terminal.write(("\b" * size) + (" " * size) + ("\b" * size))
                 @cur_frame += 1
                 @cur_frame = 0 if @cur_frame >= @frames.size
               end

data/lib/toys/utils/xdg.rb

@@ -260,7 +260,7 @@ module Toys
 
       def validate_dir_env(name)
         path = @env[name].to_s
-        !path.empty? && Compat.absolute_path?(path) ? path : nil
+        !path.empty? && ::File.absolute_path?(path) ? path : nil
       end
 
       def validate_dirs_env(name)
@@ -268,7 +268,7 @@ module Toys
       end
 
       def validate_dirs(paths)
-        paths = paths.find_all { |path| Compat.absolute_path?(path) }
+        paths = paths.find_all { |path| ::File.absolute_path?(path) }
         paths.empty? ? nil : paths
       end
 

data/lib/toys-core.rb

@@ -120,10 +120,11 @@ module Toys
   CORE_LIB_PATH = __dir__
 end
 
+require "toys/compat"
+
 require "toys/acceptor"
 require "toys/arg_parser"
 require "toys/cli"
-require "toys/compat"
 require "toys/completion"
 require "toys/context"
 require "toys/core"

metadata

@@ -1,15 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: toys-core
 version: !ruby/object:Gem::Version
-  version: 0.15.6
+  version: 0.17.0
 platform: ruby
 authors:
 - Daniel Azuma
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-15 00:00:00.000000000 Z
-dependencies: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 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.
 email:
@@ -79,11 +92,10 @@ homepage: https://github.com/dazuma/toys
 licenses:
 - MIT
 metadata:
-  changelog_uri: https://dazuma.github.io/toys/gems/toys-core/v0.15.6/file.CHANGELOG.html
+  changelog_uri: https://dazuma.github.io/toys/gems/toys-core/v0.17.0/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.15.6
-post_install_message: 
+  documentation_uri: https://dazuma.github.io/toys/gems/toys-core/v0.17.0
 rdoc_options: []
 require_paths:
 - lib
@@ -91,15 +103,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Framework for creating command line executables
 test_files: []