refinements 7.10.0 → 7.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b7b36399c299675bc98b26334acc2466c5c506849e34b36534f21d2eed72e57
-  data.tar.gz: 0d00c8e399a0d43c21dafef5985e9d0eb51fe7d544fbe93f4d184eafa75018a8
+  metadata.gz: a5a299dfa7a3355d5cb068cc6638ed41ca9ac4980ed69f6aabb0e1608cc96e95
+  data.tar.gz: 4b12b5237fc97f5609677b8f010156ef9a1d00d5004fe48d1cfa4d32df15f602
 SHA512:
-  metadata.gz: 558191fc552ba160302b9189b8bd2e3ed17ceaee226426cf9453c0c65b8ca0e771b9e85be1e5453c8c1438bc52511a45afc218c72329c17570a6036b65e9f91f
-  data.tar.gz: 69436b5353f1541b644f9ca72346da713bd8bb1c0f9595983392881727f06ea46ecacdea1412a929981ee24e0243865c6ac9274e747f04d3584c85216e7e300b
+  metadata.gz: 248e66b7141e5e29f68c60aae0a3eac49934830053e9e5ce7082b0164e63b42ee9c536d8b46d4f86c7f570a85f1838415939b5955d66bd93f5df2eeefe66a5d7
+  data.tar.gz: 399fc17b0857236d4d58668857d690ddb63deba8fd9de10c372f2d3618c93edb31a9574f166c01d6aee884d4d856f067dfc2b68eddedb80d90d70a656595d82d

data/README.adoc

@@ -22,6 +22,7 @@ Enhances the following objects:
 * DateTime
 * File
 * Hash
+* IO
 * Pathname
 * String
 * StringIO
@@ -79,7 +80,7 @@ If all refinements are not desired, add the following to your `+Gemfile+` instea
 gem "refinements", require: false
 ----
 
-…then require the specific refinement, as needed. Example:
+...then require the specific refinement, as needed. Example:
 
 [source,ruby]
 ----
@@ -88,6 +89,7 @@ require "refinements/big_decimals"
 require "refinements/date_times"
 require "refinements/files"
 require "refinements/hashes"
+require "refinements/ios"
 require "refinements/pathnames"
 require "refinements/strings"
 require "refinements/string_ios"
@@ -106,6 +108,7 @@ class Example
   using Refinements::DateTimes
   using Refinements::Files
   using Refinements::Hashes
+  using Refinements::IOs
   using Refinements::Pathnames
   using Refinements::Strings
   using Refinements::StringIOs
@@ -463,6 +466,69 @@ example = {unit: "221B", street: "Baker Street", city: "London", country: "UK"}
 example.use { |unit, street| "#{unit} #{street}" } # => "221B Baker Street"
 ----
 
+==== IO
+
+===== .void
+
+Answers an IO stream which points to `/dev/null` in order to ignore any reads or writes to the
+stream. When given a block, the stream will automatically close upon block exit. When not given a
+block, you'll need to close the stream manually.
+
+[source,ruby]
+----
+io = IO.void
+io.closed? # => false
+
+io = IO.void { |void| void.write "nevermore" }
+io.closed? # => true
+----
+
+===== #squelch
+
+Temporarily ignores any reads/writes for current stream for all code executed within the block. When
+not given a block, it answers itself.
+
+[source,ruby]
+----
+io = IO.new IO.sysopen(Pathname("test.txt").to_s, "w+")
+io.squelch { io.write "Test" }
+io.reread # => ""
+----
+
+===== #redirect
+
+Redirects current stream to other stream when given a block. Without a block, the original stream is
+answered instead.
+
+[source,ruby]
+----
+io = IO.new IO.sysopen(Pathname("test.txt").to_s, "w+")
+other = IO.new IO.sysopen(Pathname("other.txt").to_s, "w+")
+
+io.redirect other # => `io`
+
+io.redirect(other) { |stream| stream.write "test" }
+  .close    # => ""
+other.close # => "test"
+----
+
+===== #reread
+
+Answers full stream by rewinding to beginning of stream and reading all content.
+
+[source,ruby]
+----
+io = IO.new IO.sysopen(Pathname("test.txt").to_s, "w+")
+io.write "This is a test."
+
+io.reread    # => "This is a test."
+io.reread 4  # => "This"
+
+buffer = "".dup
+io.reread(buffer: buffer)
+buffer # => "This is a test."
+----
+
 ==== Pathname
 
 ===== Pathname

data/lib/refinements.rb

@@ -6,6 +6,7 @@ require "refinements/big_decimals"
 require "refinements/date_times"
 require "refinements/files"
 require "refinements/hashes"
+require "refinements/ios"
 require "refinements/pathnames"
 require "refinements/strings"
 require "refinements/string_ios"

data/lib/refinements/identity.rb

@@ -5,7 +5,7 @@ module Refinements
   module Identity
     NAME = "refinements"
     LABEL = "Refinements"
-    VERSION = "7.10.0"
+    VERSION = "7.11.0"
     VERSION_LABEL = "#{LABEL} #{VERSION}"
   end
 end

data/lib/refinements/ios.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Refinements
+  module IOs
+    refine IO.singleton_class do
+      def void
+        new(sysopen("/dev/null", "w+")).then do |io|
+          return io unless block_given?
+
+          yield io
+          io.tap(&:close)
+        end
+      end
+    end
+
+    refine IO do
+      def squelch &block
+        self.class.void.then { |void| redirect(void, &block) }
+      end
+
+      def redirect other
+        return self unless block_given?
+
+        backup = dup
+        reopen other
+        yield self
+        reopen backup
+      end
+
+      def reread length = nil, buffer: nil
+        tap(&:rewind).read length, buffer
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: refinements
 version: !ruby/object:Gem::Version
-  version: 7.10.0
+  version: 7.11.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   2XV8FRa7/JimI07sPLC13eLY3xd/aYTi85Z782KIA4j0G8XEEWAX0ouBhlXPocZv
   QWc=
   -----END CERTIFICATE-----
-date: 2020-09-27 00:00:00.000000000 Z
+date: 2020-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -244,6 +244,7 @@ files:
 - lib/refinements/files.rb
 - lib/refinements/hashes.rb
 - lib/refinements/identity.rb
+- lib/refinements/ios.rb
 - lib/refinements/pathnames.rb
 - lib/refinements/string_ios.rb
 - lib/refinements/strings.rb