toys-core 0.14.4 → 0.14.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98a66e07f9f052b2011ab3d960dd8b8bff11f3f03a3c6de67e0d14b1507421ee
-  data.tar.gz: c6712de855eb63cb80eba5b32c956590a2b50d2944079df0ad4e58c9c8e7c8c4
+  metadata.gz: 4a49ffadd96ca26cf194b2c779f91704490fe6f345e5eb306638f61215e15920
+  data.tar.gz: 79bfe7f58285f0881a16383ffb0ba5f6fcad79b6001e4efd2effea178d1cedd7
 SHA512:
-  metadata.gz: e6be869c95ca6a9c4a7451581b04a656fe8d11f4b10d7a9197c4719fda776720bc07124295683d21bf81a19a0d5a3366fb0b31f5ffd92dd6b518aab3a18cc6d8
-  data.tar.gz: 0f48bdb37ce11ee8f3ece13b7ba8e4f85633b566b68d2ba15cd18ef26ddcd9b0455b49e2f56bef7b0f240cfde4d5e461b81a05965ec77928cd4d09a974794c8d
+  metadata.gz: d3d8bc7d78af759121c749b06454b585404c2093342a7476655e8ff3ac1f5e7d52fc729402e5669b42e75820babdd7f997f36a53d462276f2c26da5eff83fd5c
+  data.tar.gz: f04c5b0fdcbeb344f6733611bf134230586fc35a3fe73ffddeaba4aa602c1ff86726b2f1cd832e2a00dfbded1b30a59eaa5851c75df06e908b126682da627a81

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History
 
+### v0.14.6 / 2023-06-29
+
+* FIXED: Fixed a GitCache exception when loading a repository containing a broken symlink
+
+### v0.14.5 / 2023-03-20
+
+* FIXED: Rescue broken pipe errors by default when running a pager
+
 ### v0.14.4 / 2023-01-23
 
 * FIXED: Fixed missing require when "toys/utils/xdg" or "toys/utils/git_cache" is required without the rest of toys-core

data/lib/toys/core.rb

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

data/lib/toys/standard_mixins/git_cache.rb

@@ -8,16 +8,16 @@ module Toys
     # This mixin provides an instance of {Toys::Utils::GitCache}, providing
     # cached access to files from a remote git repo.
     #
-    # Example usage:
+    # @example
     #
-    #     include :git_cache
+    #   include :git_cache
     #
-    #     def run
-    #       # Pull and cache the HEAD commit from the Toys repo.
-    #       dir = git_cache.find("https://github.com/dazuma/toys.git")
-    #       # Display the contents of the readme file.
-    #       puts File.read(File.join(dir, "README.md"))
-    #     end
+    #   def run
+    #     # Pull and cache the HEAD commit from the Toys repo.
+    #     dir = git_cache.get("https://github.com/dazuma/toys.git")
+    #     # Display the contents of the readme file.
+    #     puts File.read(File.join(dir, "README.md"))
+    #   end
     #
     module GitCache
       include Mixin

data/lib/toys/standard_mixins/pager.rb

@@ -8,6 +8,10 @@ module Toys
     # This mixin provides an instance of {Toys::Utils::Pager}, which invokes
     # an external pager for output.
     #
+    # You can also pass additional keyword arguments to the `include` directive
+    # to configure the pager object. These will be passed on to
+    # {Toys::Utils::Pager#initialize}.
+    #
     # @example
     #
     #   include :pager
@@ -44,13 +48,12 @@ module Toys
         self[KEY].start(&block)
       end
 
-      on_initialize do
+      on_initialize do |**opts|
         require "toys/utils/pager"
-        exec_service =
-          if defined?(::Toys::StandardMixins::Exec)
-            self[::Toys::StandardMixins::Exec::KEY]
-          end
-        self[KEY] = Utils::Pager.new(exec_service: exec_service)
+        if !opts.key?(:exec_service) && defined?(::Toys::StandardMixins::Exec)
+          opts[:exec_service] = self[::Toys::StandardMixins::Exec::KEY]
+        end
+        self[KEY] = Utils::Pager.new(**opts)
       end
     end
   end

data/lib/toys/utils/git_cache.rb

@@ -402,7 +402,7 @@ module Toys
         Array(remotes).map do |remote|
           dir = repo_base_dir_for(remote)
           if ::File.directory?(dir)
-            ::FileUtils.chmod_R("u+w", dir)
+            ::FileUtils.chmod_R("u+w", dir, force: true)
             ::FileUtils.rm_rf(dir)
             remote
           end
@@ -568,9 +568,9 @@ module Toys
         source_path = ::File.join(dir, sha)
         unless repo_lock.source_exists?(sha, path)
           ::FileUtils.mkdir_p(source_path)
-          ::FileUtils.chmod_R("u+w", 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)
+          ::FileUtils.chmod_R("a-w", source_path, force: true)
         end
         repo_lock.access_source!(sha, path)
         path == "." ? source_path : ::File.join(source_path, path)
@@ -579,7 +579,7 @@ module Toys
       def copy_files(dir, sha, path, repo_lock, into)
         repo_path = ::File.join(dir, REPO_DIR_NAME)
         ::FileUtils.mkdir_p(into)
-        ::FileUtils.chmod_R("u+w", into)
+        ::FileUtils.chmod_R("u+w", into, force: true)
         Compat.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!
@@ -594,7 +594,7 @@ module Toys
             to_path = ::File.join(into, entry)
             unless ::File.exist?(to_path)
               from_path = ::File.join(repo_dir, entry)
-              ::FileUtils.cp_r(from_path, to_path)
+              ::FileUtils.copy_entry(from_path, to_path)
             end
           end
           into
@@ -603,7 +603,7 @@ module Toys
           unless ::File.exist?(to_path)
             from_path = ::File.join(repo_dir, path)
             ::FileUtils.mkdir_p(::File.dirname(to_path))
-            ::FileUtils.cp_r(from_path, to_path)
+            ::FileUtils.copy_entry(from_path, to_path)
           end
           to_path
         end

data/lib/toys/utils/pager.rb

@@ -34,12 +34,18 @@ module Toys
       #     executing commands, or `nil` (the default) to use a default.
       # @param fallback_io [IO] An IO-like object to write to if the pager is
       #     disabled. Defaults to `$stdout`.
+      # @param rescue_broken_pipes [boolean] If `true` (the default), broken
+      #     pipes are silently rescued. This prevents the exception from
+      #     propagating out if the pager is interrupted. Set this parameter to
+      #     `false` to disable this behavior.
       #
-      def initialize(command: true, exec_service: nil, fallback_io: nil)
+      def initialize(command: true, exec_service: nil, fallback_io: nil,
+                     rescue_broken_pipes: true)
         @command = command == true ? Pager.default_command : command
         @command ||= nil
         @exec_service = exec_service || Pager.default_exec_service
         @fallback_io = fallback_io || $stdout
+        @rescue_broken_pipes = rescue_broken_pipes
       end
 
       ##
@@ -60,7 +66,11 @@ module Toys
       def start
         if @command
           result = @exec_service.exec(@command, in: :controller) do |controller|
-            yield controller.in if controller.pid
+            begin
+              yield controller.in if controller.pid
+            rescue ::Errno::EPIPE => e
+              raise e unless @rescue_broken_pipes
+            end
           end
           return result.exit_code unless result.failed?
         end
@@ -100,6 +110,10 @@ module Toys
         #     executing commands, or `nil` (the default) to use a default.
         # @param fallback_io [IO] An IO-like object to write to if the pager is
         #     disabled. Defaults to `$stdout`.
+        # @param rescue_broken_pipes [boolean] If `true` (the default), broken
+        #     pipes are silently rescued. This prevents the exception from
+        #     propagating out if the pager is interrupted. Set this parameter to
+        #     `false` to disable this behavior.
         # @return [Integer] The exit code of the pager process.
         #
         # @example
@@ -107,8 +121,14 @@ module Toys
         #   Toys::Utils::Pager.start do |io|
         #     io.puts "A long string\n"
         #   end
-        def start(command: true, exec_service: nil, fallback_io: nil, &block)
-          pager = new(command: command, exec_service: exec_service, fallback_io: fallback_io)
+        #
+        def start(command: true,
+                  exec_service: nil,
+                  fallback_io: nil,
+                  rescue_broken_pipes: true,
+                  &block)
+          pager = new(command: command, exec_service: exec_service, fallback_io: fallback_io,
+                      rescue_broken_pipes: rescue_broken_pipes)
           pager.start(&block)
         end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: toys-core
 version: !ruby/object:Gem::Version
-  version: 0.14.4
+  version: 0.14.6
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-23 00:00:00.000000000 Z
+date: 2023-06-29 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.4/file.CHANGELOG.html
+  changelog_uri: https://dazuma.github.io/toys/gems/toys-core/v0.14.6/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.4
+  documentation_uri: https://dazuma.github.io/toys/gems/toys-core/v0.14.6
 post_install_message: 
 rdoc_options: []
 require_paths: