toys-core 0.14.4 → 0.14.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98a66e07f9f052b2011ab3d960dd8b8bff11f3f03a3c6de67e0d14b1507421ee
-  data.tar.gz: c6712de855eb63cb80eba5b32c956590a2b50d2944079df0ad4e58c9c8e7c8c4
+  metadata.gz: 8f37d61c7aa836f0cf61b8f16c3276cfb75b8aa0984f95e646ce4b5f0f75b434
+  data.tar.gz: 8030abe70c882204c75f0dc2098da59318e9c514bbb1fd1efdffcb28857e2410
 SHA512:
-  metadata.gz: e6be869c95ca6a9c4a7451581b04a656fe8d11f4b10d7a9197c4719fda776720bc07124295683d21bf81a19a0d5a3366fb0b31f5ffd92dd6b518aab3a18cc6d8
-  data.tar.gz: 0f48bdb37ce11ee8f3ece13b7ba8e4f85633b566b68d2ba15cd18ef26ddcd9b0455b49e2f56bef7b0f240cfde4d5e461b81a05965ec77928cd4d09a974794c8d
+  metadata.gz: b3e7f4918dc4ea6ed9b77506b0f298be2268264d3f4468378c4953f805bb7a9715af09d95fa0b0638bc5b9098e1919cee875beb6af549d70d9d4988e37307219
+  data.tar.gz: 1d71d7991acbfbc37e65c25f8507da1d6ed2e26798d2dbfd1117606983d647df8e4b8baac2887022374cf6b7a2fa31fa6e40e1085976acf27a19de1d9a495d0a

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History
 
+### 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.5"
   end
 
   ##

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/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.5
 platform: ruby
 authors:
 - Daniel Azuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-23 00:00:00.000000000 Z
+date: 2023-03-20 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.5/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.5
 post_install_message: 
 rdoc_options: []
 require_paths: