refinements 7.6.0 → 7.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b33464363d548d0cc888f7f3b1efac924eb2490a3846353589d892900d03de0d
-  data.tar.gz: da1d401505c092c0b2e8850f476affb1932b79db770b4f11c263300e208f3457
+  metadata.gz: a5a299dfa7a3355d5cb068cc6638ed41ca9ac4980ed69f6aabb0e1608cc96e95
+  data.tar.gz: 4b12b5237fc97f5609677b8f010156ef9a1d00d5004fe48d1cfa4d32df15f602
 SHA512:
-  metadata.gz: 6c8072c3a3d8348e871ed72c7519295fb4ade95e2463bf56424f42689909dc7113805fbc817012196a395442af811f4d215a5bc89cf8952bd4506b0a4cd49536
-  data.tar.gz: 7797a5f506eb95d5999234c6e506ef9b0f4b949cfa41f831fcf883425fea7cb3da3b3ff3ef72f5c218236c006c38aeb2a957127ccf5177748fc3cac4291498ba
+  metadata.gz: 248e66b7141e5e29f68c60aae0a3eac49934830053e9e5ce7082b0164e63b42ee9c536d8b46d4f86c7f570a85f1838415939b5955d66bd93f5df2eeefe66a5d7
+  data.tar.gz: 399fc17b0857236d4d58668857d690ddb63deba8fd9de10c372f2d3618c93edb31a9574f166c01d6aee884d4d856f067dfc2b68eddedb80d90d70a656595d82d

checksums.yaml.gz.sig

@@ -1,2 +1,2 @@
-���8X�oF���A�>����L�d�oG)KV���h���u�o���ڊziˍ�`����\��~R
�U��
-ǧ6�kQ)õ���;+���GOD��tw�ůlV�� j���i��z`���)&�&�`�t�'������rY��O�
��vb�A�/b]
���?B_DR#S��V�w��c�(�C�ӯn�?�r�։������VC�Sw)�{Їa$c~#��}� �Ow&�#;�">��"B�Cm��l9��=i�o��
+^%���b�ץ���nyo��Df���Z�v���D��zK�w��OVbO
+��p��V�/x��W��:"�Tz.�\�͙�*卪�%�NՇf�Y�!�YH��(i
��M��J4��Ļ����͗�~-w�y�(���&^K*L��{_�2ɻ�W��Ie%���ڳqH��J��9~t��{W�d�zؘR�N\H�����q/C�yy��h��UV�B���	�����X�����]��~�u�A�	,N

data/README.adoc

@@ -9,66 +9,23 @@ image::https://badge.fury.io/rb/refinements.svg[Gem Version]
 [link=https://circleci.com/gh/bkuhlmann/refinements]
 image::https://circleci.com/gh/bkuhlmann/refinements.svg?style=svg[Circle CI Status]
 
-A collection of refinements (enhancements) to core Ruby objects.
+A collection of refinements (enhancements) to primitive Ruby objects.
 
 toc::[]
 
 == Features
 
-* *Arrays*:
-** `#compress` - Removes `nil` and empty values without modifying itself.
-** `#compress!` - Removes `nil` and empty values while modifying itself.
-** `#ring` - Answers a circular array which can enumerate before, current, after elements.
-* *BigDecimals*:
-** `#inspect` - Allows one to inspect a big decimal with numeric representation.
-* *DateTimes*:
-** `.utc` - Answers new DateTime object for current UTC date/time.
-* *Files*:
-** `#rewrite` - When given a file path and a block, it provides the contents of the recently read
-file for manipulation and immediate writing back to the same file.
-* *Hashes*:
-** `.infinite` - Answers new hash where missing keys, even deeply nested, answer an empty hash.
-** `.with_default` - Answers new hash where every top-level missing key has the same default value.
-** `#except` - Answers new hash with given keys removed without modifying itself.
-** `#except!` - Answers new hash with given keys removed while modifying itself.
-** `#symbolize_keys` - Converts keys to symbols without modifying itself.
-** `#symbolize_keys!` - Converts keys to symbols while modifying itself.
-** `#deep_merge` - Merges deeply nested hashes together without modifying itself.
-** `#deep_merge!` - Merges deeply nested hashes together while modifying itself.
-** `#deep_symbolize_keys` - Symbolizes keys of nested hash without modifying itself. Does not handle
-   nested arrays, though.
-** `#deep_symbolize_keys!` - Symbolizes keys of nested hash while modifying itself. Does not handle
-   nested arrays, though.
-** `#recurse` - Applies block to nested hash. Does not handle nested arrays, though.
-** `#rekey` - Transforms keys per mapping (size of mapping can vary) without modifying itself.
-** `#rekey!` - Transforms keys per mapping (size of mapping can vary) while modifying itself.
-** `#reverse_merge` - Merges calling hash into passed in hash without modifying itself.
-** `#reverse_merge!` - Merges calling hash into passed in hash while modifying itself.
-** `#use` - Passes each hash value as a block argument for further processing.
-* *Pathnames*:
-** `Pathname` - Conversion function (refined from `Kernel`) which can cast `nil` into a pathname.
-** `#name` - Answers file name without extension.
-** `#copy` - Copies file from current location to new location.
-** `#directories` - Answers all or filtered directories for current path.
-** `#extensions` - Answers file extensions as an array.
-** `#files` - Answers all or filtered files for current path.
-** `#relative_parent_from` - Answers relative path from parent directory. This is a complement to
-   `#relative_path_from`.
-** `#make_ancestors` - Ensures all ancestor directories are created for a path.
-** `#rewrite` - When given a block, it provides the contents of the recently read file for
-manipulation and immediate writing back to the same file.
-** `#touch` - Updates access and modification times for path. Defaults to current time.
-* *Strings*:
-** `#first` - Answers first character of a string or first set of characters if given a number.
-** `#last` - Answers last character of a string or last set of characters if given a number.
-** `#blank?` - Answers `true`/`false` based on whether string is blank or not
-(i.e. `<space>`, `\n`, `\t`, `\r`).
-** `#up` - Answers string with only first letter upcased.
-** `#down` - Answers string with only first letter downcased.
-** `#camelcase` - Answers a camelcased string.
-** `#snakecase` - Answers a snakecased string.
-** `#titleize` - Answers titleized string.
-** `#to_bool` - Answers string as a boolean.
+Enhances the following objects:
+
+* Array
+* BigDecimal
+* DateTime
+* File
+* Hash
+* IO
+* Pathname
+* String
+* StringIO
 
 == Requirements
 
@@ -123,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]
 ----
@@ -132,13 +89,16 @@ 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"
 ----
 
 === Using
 
-Much like including/extending a module, you’ll need modify your object(s) to use the refinement(s):
+Much like including/extending a module, you’ll need to modify your object(s) to use the
+refinement(s):
 
 [source,ruby]
 ----
@@ -148,8 +108,10 @@ class Example
   using Refinements::DateTimes
   using Refinements::Files
   using Refinements::Hashes
+  using Refinements::IOs
   using Refinements::Pathnames
   using Refinements::Strings
+  using Refinements::StringIOs
 end
 ----
 
@@ -159,19 +121,58 @@ The following sections demonstrate how each refinement enriches your objects wit
 
 ==== Array
 
+===== #compress
+
+Removes `nil` and empty values without mutating itself.
+
 [source,ruby]
 ----
 example = ["An", nil, "", "Example"]
-example.compress # => ["An", "Example"]
-example # => ["An", nil, "", "Example"]
+example.compress  # => ["An", "Example"]
+example           # => ["An", nil, "", "Example"]
+----
 
+===== #compress!
+
+Removes `nil` and empty values while mutating itself.
+
+[source,ruby]
+----
 example = ["An", nil, "", "Example"]
-example.compress! # => ["An", "Example"]
-example # => ["An", "Example"]
+example.compress!  # => ["An", "Example"]
+example            # => ["An", "Example"]
+----
 
+===== #include
+
+Adds given array or elements without mutating itself.
+
+[source,ruby]
+----
+[1, 2, 3].include [4, 5]  # => [1, 2, 3, 4, 5]
+[1, 2, 3].include 4, 5    # => [1, 2, 3, 4, 5]
+----
+
+===== #exclude
+
+Removes given array or elements without mutating itself.
+
+[source,ruby]
+----
+[1, 2, 3, 4, 5].exclude [4, 5]  # => [1, 2, 3]
+[1, 2, 3, 4, 5].exclude 4, 5    # => [1, 2, 3]
+----
+
+===== #ring
+
+Answers a circular array which can enumerate before, current, after elements.
+
+[source,ruby]
+----
 example = [1, 2, 3]
 example.ring # => #<Enumerator: ...>
 example.ring { |(before, current, after)| puts "#{before} #{current} #{after}" }
+
 # [3 1 2]
 # [1 2 3]
 # [2 3 1]
@@ -179,6 +180,10 @@ example.ring { |(before, current, after)| puts "#{before} #{current} #{after}" }
 
 ==== Big Decimal
 
+===== #inspect
+
+Allows one to inspect a big decimal with numeric representation.
+
 [source,ruby]
 ----
 BigDecimal.new("5.0E-10").inspect # => "#<BigDecimal:3fd3d458fe84 0.0000000005>"
@@ -186,6 +191,10 @@ BigDecimal.new("5.0E-10").inspect # => "#<BigDecimal:3fd3d458fe84 0.0000000005>"
 
 ==== DateTime
 
+===== .utc
+
+Answers new DateTime object for current UTC date/time.
+
 [source,ruby]
 ----
 DateTime.utc # => #<DateTime: 2019-12-31T18:17:00+00:00 ((2458849j,65820s,181867000n),+0s,2299161j)>
@@ -193,6 +202,11 @@ DateTime.utc # => #<DateTime: 2019-12-31T18:17:00+00:00 ((2458849j,65820s,181867
 
 ==== File
 
+===== .rewrite
+
+When given a file path and a block, it provides the contents of the recently read file for
+manipulation and immediate writing back to the same file.
+
 [source,ruby]
 ----
 File.rewrite("/test.txt") { |content| content.gsub "[placeholder]", "example" }
@@ -200,138 +214,556 @@ File.rewrite("/test.txt") { |content| content.gsub "[placeholder]", "example" }
 
 ==== Hash
 
+===== .infinite
+
+Answers new hash where missing keys, even deeply nested, answer an empty hash.
+
 [source,ruby]
 ----
 example = Hash.infinite
-example[:a] # => {}
-example[:a][:b][:c] # => {}
+example[:a]          # => {}
+example[:a][:b][:c]  # => {}
+----
 
+===== .with_default
+
+Answers new hash where every top-level missing key has the same default value.
+
+[source,ruby]
+----
 example = Hash.with_default ""
 example[:a] # => ""
+
 example = Hash.with_default []
 example[:b] # => []
+----
+
+===== #except
+
+Answers new hash with given keys removed without mutating itself.
 
+[source,ruby]
+----
 example = {a: 1, b: 2, c: 3}
-example.except :a, :b # => {c: 3}
-example # => {a: 1, b: 2, c: 3}
+example.except :a, :b  # => {c: 3}
+example                # => {a: 1, b: 2, c: 3}
+----
+
+===== #except!
+
+Answers new hash with given keys removed while mutating itself.
 
+[source,ruby]
+----
 example = {a: 1, b: 2, c: 3}
-example.except! :a, :b # => {c: 3}
-example # => {c: 3}
+example.except! :a, :b  # => {c: 3}
+example                 # => {c: 3}
+----
+
+===== #flatten_keys
+
+Flattens nested keys as top-level keys without mutating itself. Does not handle nested arrays,
+though.
+
+[source,ruby]
+----
+{a: {b: 1}}.flatten_keys prefix: :test  # => {test_a_b: 1}
+{a: {b: 1}}.flatten_keys delimiter: :|  # => {:"a|b" => 1}
+
+{a: {b: 1}}.flatten_keys cast: :to_s            # => {"a_b" => 1}
+{"a" => {"b" => 1}}.flatten_keys cast: :to_sym  # => {a_b: 1}
+
+example = {a: {b: 1}}
+example.flatten_keys  # => {a_b: 1}
+example               # => {a: {b: 1}}
+----
+
+===== #flatten_keys!
+
+Flattens nested keys as top-level keys while mutating itself. Does not handle nested arrays,
+though.
+
+[source,ruby]
+----
+example = {a: {b: 1}}
+example.flatten_keys!  # => {a_b: 1}
+example                # => {a_b: 1}
+----
+
+===== #stringify_keys
+
+Converts keys to strings without mutating itself.
+
+[source,ruby]
+----
+example = {a: 1, b: 2}
+example.stringify_keys  # => {"a" => 1, "b" => 2}
+example                 # => {a: 1, b: 2}
+----
 
+===== #stringify_keys!
+
+Converts keys to strings while mutating itself.
+
+[source,ruby]
+----
+example = {a: 1, b: 2}
+example.stringify_keys!  # => {"a" => 1, "b" => 2}
+example                  # => {"a" => 1, "b" => 2}
+----
+
+===== #symbolize_keys
+
+Converts keys to symbols without mutating itself.
+
+[source,ruby]
+----
 example = {"a" => 1, "b" => 2}
-example.symbolize_keys # => {a: 1, b: 2}
-example # => {"a" => 1, "b" => 2}
+example.symbolize_keys  # => {a: 1, b: 2}
+example                 # => {"a" => 1, "b" => 2}
+----
+
+===== #symbolize_keys!
 
+Converts keys to symbols while mutating itself.
+
+[source,ruby]
+----
 example = {"a" => 1, "b" => 2}
-example.symbolize_keys! # => {a: 1, b: 2}
-example # => {a: 1, b: 2}
+example.symbolize_keys!  # => {a: 1, b: 2}
+example                  # => {a: 1, b: 2}
+----
 
-example = {a: 1, b: 2, c: 3}
-example.slice :a, :c # => {a: 1, c: 3}
-example # => {a: 1, b: 2, c: 3}
+===== #deep_merge
 
-example = {a: 1, b: 2, c: 3}
-example.slice! :a, :c # => {a: 1, c: 3}
-example # => {a: 1, c: 3}
+Merges deeply nested hashes together without mutating itself.
 
+[source,ruby]
+----
 example = {a: "A", b: {one: "One", two: "Two"}}
-example.deep_merge b: {one: 1} # => {a: "A", b: {one: 1, two: "Two"}}
-example # => {a: "A", b: {one: "One", two: "Two"}}
+example.deep_merge b: {one: 1}  # => {a: "A", b: {one: 1, two: "Two"}}
+example                         # => {a: "A", b: {one: "One", two: "Two"}}
+----
+
+===== #deep_merge!
+
+Merges deeply nested hashes together while mutating itself.
 
+[source,ruby]
+----
 example = {a: "A", b: {one: "One", two: "Two"}}
-example.deep_merge! b: {one: 1} # => {a: "A", b: {one: 1, two: "Two"}}
-example # => {a: "A", b: {one: 1, two: "Two"}}
+example.deep_merge! b: {one: 1}  # => {a: "A", b: {one: 1, two: "Two"}}
+example                          # => {a: "A", b: {one: 1, two: "Two"}}
+----
+
+===== #deep_stringify_keys
 
+Stringifies keys of nested hash without mutating itself. Does not handle nested arrays, though.
+
+[source,ruby]
+----
+example = {a: {b: 2}}
+example.deep_stringify_keys  # => {"a" => {"b" => 1}}
+example                      # => {a: {b: 2}}
+----
+
+===== #deep_stringify_keys!
+
+Stringifies keys of nested hash while mutating itself. Does not handle nested arrays, though.
+
+[source,ruby]
+----
+example = {a: {b: 2}}
+example.deep_stringify_keys!  # => {"a" => {"b" => 1}}
+example                       # => {"a" => {"b" => 1}}
+----
+
+===== #deep_symbolize_keys
+
+Symbolizes keys of nested hash without mutating itself. Does not handle nested arrays, though.
+
+[source,ruby]
+----
 example = {"a" => {"b" => 2}}
-example.deep_symbolize_keys # => {a: {b: 1}}
-example # => {"a" => {"b" => 2}}
+example.deep_symbolize_keys  # => {a: {b: 1}}
+example                      # => {"a" => {"b" => 2}}
+----
+
+===== #deep_symbolize_keys!
+
+Symbolizes keys of nested hash while mutating itself. Does not handle nested arrays, though.
 
+[source,ruby]
+----
 example = {"a" => {"b" => 2}}
-example.deep_symbolize_keys! # => {a: {b: 1}}
-example # => {a: {b: 1}}
+example.deep_symbolize_keys!  # => {a: {b: 1}}
+example                       # => {a: {b: 1}}
+----
+
+===== #recurse
+
+Recursively iterates over the hash and any hash value by applying the given block to it. Does not
+handle nested arrays, though.
 
+[source,ruby]
+----
 example = {"a" => {"b" => 1}}
-example.recurse(&:symbolize_keys) # => {a: {b: 1}}
-example.recurse(&:invert) # => {{"b" => 1} => "a"}
+example.recurse(&:symbolize_keys)  # => {a: {b: 1}}
+example.recurse(&:invert)          # => {{"b" => 1} => "a"}
+----
+
+===== #rekey
 
+Transforms keys per mapping (size of mapping can vary) without mutating itself.
+
+[source,ruby]
+----
 example = {a: 1, b: 2, c: 3}
-example.rekey a: :amber, b: :blue # => {amber: 1, blue: 2, c: 3}
-example # => {a: 1, b: 2, c: 3}
+example.rekey a: :amber, b: :blue  # => {amber: 1, blue: 2, c: 3}
+example                            # => {a: 1, b: 2, c: 3}
+----
+
+===== #rekey!
 
+Transforms keys per mapping (size of mapping can vary) while mutating itself.
+
+[source,ruby]
+----
 example = {a: 1, b: 2, c: 3}
-example.rekey! a: :amber, b: :blue # => {amber: 1, blue: 2, c: 3}
-example # => {amber: 1, blue: 2, c: 3}
+example.rekey! a: :amber, b: :blue  # => {amber: 1, blue: 2, c: 3}
+example                             # => {amber: 1, blue: 2, c: 3}
+----
 
+===== #reverse_merge
+
+Merges calling hash into passed in hash without mutating itself.
+
+[source,ruby]
+----
 example = {a: 1, b: 2}
-example.reverse_merge a: 0, c: 3 # => {a: 1, b: 2, c: 3}
-example # => {a: 1, b: 2}
+example.reverse_merge a: 0, c: 3  # => {a: 1, b: 2, c: 3}
+example                           # => {a: 1, b: 2}
+----
 
+===== #reverse_merge!
+
+Merges calling hash into passed in hash while mutating itself.
+
+[source,ruby]
+----
 example = {a: 1, b: 2}
-example.reverse_merge! a: 0, c: 3 # => {a: 1, b: 2, c: 3}
-example # => {a: 1, b: 2, c: 3}
+example.reverse_merge! a: 0, c: 3  # => {a: 1, b: 2, c: 3}
+example                            # => {a: 1, b: 2, c: 3}
+----
+
+===== #use
+
+Passes each hash value as a block argument for further processing.
 
+[source,ruby]
+----
 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
+
+Enhances the conversion function -- refined from `Kernel` -- which casts `nil` into a pathname in
+order to avoid: `TypeError (no implicit conversion of nil into String)`. The pathname is still
+invalid but at least you have an instance of `Pathname`, which behaves like a _Null Object_, that
+can still be used to construct a valid path.
+
 [source,ruby]
 ----
 Pathname(nil) # => Pathname("")
+----
+
+===== #name
+
+Answers file name without extension.
 
+[source,ruby]
+----
 Pathname("example.txt").name # => Pathname("example")
+----
+
+===== #copy
 
+Copies file from current location to new location.
+
+[source,ruby]
+----
 Pathname("input.txt").copy Pathname("output.txt")
+----
+
+===== #directories
+
+Answers all or filtered directories for current path.
+
+[source,ruby]
+----
+Pathname("/example").directories                           # => [Pathname("a"), Pathname("b")]
+Pathname("/example").directories "a*"                      # => [Pathname("a")]
+Pathname("/example").directories flag: File::FNM_DOTMATCH  # => [Pathname(".."), Pathname(".")]
+----
+
+===== #extensions
 
-Pathname("/example").directories # => [Pathname("a"), Pathname("b")]
-Pathname("/example").directories "a*" # => [Pathname("a")]
+Answers file extensions as an array.
 
+[source,ruby]
+----
 Pathname("example.txt.erb").extensions # => [".txt", ".erb"]
+----
+
+===== #files
+
+Answers all or filtered files for current path.
+
+[source,ruby]
+----
+Pathname("/example").files                           # => [Pathname("a.txt"), Pathname("a.png")]
+Pathname("/example").files "*.png"                   # => [Pathname("a.png")]
+Pathname("/example").files flag: File::FNM_DOTMATCH  # => [Pathname(".ruby-version")]
+----
+
+===== #gsub
+
+Same behavior as `String#gsub` but answers a path with patterns replaced with desired substitutes.
+
+[source,ruby]
+----
+Pathname("/a/path/some/path").gsub("path", "test")
+# => Pathname("/a/test/some/test")
+
+Pathname("/%placeholder%/some/%placeholder%").gsub("%placeholder%", "test")
+# => Pathname("/test/some/test")
+----
+
+===== #relative_parent
+
+Answers relative path from parent directory. This is a complement to `#relative_path_from`.
 
-Pathname("/example").files # => [Pathname("a.txt"), Pathname("a.png")]
-Pathname("/example").files "*.png" # => [Pathname("a.png")]
+[source,ruby]
+----
+Pathname("/one/two/three").relative_parent("/one") # => Pathname "two"
+----
 
-Pathname("/one/two/three").relative_parent_from("/one") # => Pathname "two"
+===== #make_ancestors
 
+Ensures all ancestor directories are created for a path.
+
+[source,ruby]
+----
 Pathname("/one/two").make_ancestors
-Pathname("/one").exist? # => true
-Pathname("/one/two").exist? # => false
+Pathname("/one").exist?      # => true
+Pathname("/one/two").exist?  # => false
+----
+
+===== #rewrite
 
+When given a block, it provides the contents of the recently read file for manipulation and
+immediate writing back to the same file.
+
+[source,ruby]
+----
 Pathname("/test.txt").rewrite { |content| content.sub "[placeholder]", "example" }
+----
+
+===== #touch
 
+Updates access and modification times for path. Defaults to current time.
+
+[source,ruby]
+----
 Pathname("example.txt").touch
 Pathname("example.txt").touch at: Time.now - 1
 ----
 
 ==== String
 
+===== #first
+
+Answers first character of a string or first set of characters if given a number.
+
 [source,ruby]
 ----
-"example".first # => "e"
-"example".first 4 # => "exam"
+"example".first    # => "e"
+"example".first 4  # => "exam"
+----
 
-"instant".last # => "t"
-"instant".last 3 # => "ant"
+===== #last
 
+Answers last character of a string or last set of characters if given a number.
+
+[source,ruby]
+----
+"instant".last    # => "t"
+"instant".last 3  # => "ant"
+----
+
+===== #blank?
+
+Answers `true`/`false` based on whether string is blank, `<space>`, `\n`, `\t`, and/or `\r`.
+
+[source,ruby]
+----
 " \n\t\r".blank? # => true
+----
+
+===== #up
+
+Answers string with only first letter upcased.
 
+[source,ruby]
+----
 "example".up # => "Example"
+----
+
+===== #down
 
+Answers string with only first letter downcased.
+
+[source,ruby]
+----
 "EXAMPLE".down # => "eXAMPLE"
+----
+
+===== #indent
+
+Answers string indented by two spaces by default.
+
+[source,ruby]
+----
+"example".indent                  # => "  example"
+"example".indent 0                # => "example"
+"example".indent -1               # => "example"
+"example".indent 2                # => "    example"
+"example".indent 3, padding: " "  # => "   example"
+----
+
+===== #camelcase
 
+Answers a camelcased string.
+
+[source,ruby]
+----
 "this_is_an_example".camelcase # => "ThisIsAnExample"
+----
+
+===== #snakecase
 
+Answers a snakecased string.
+
+[source,ruby]
+----
 "ThisIsAnExample".snakecase # => "this_is_an_example"
+----
 
+===== #titleize
+
+Answers titleized string.
+
+[source,ruby]
+----
 "ThisIsAnExample".titleize # => "This Is An Example"
+----
+
+===== #to_bool
+
+Answers string as a boolean.
+
+[source,ruby]
+----
+"true".to_bool     # => true
+"yes".to_bool      # => true
+"1".to_bool        # => true
+"".to_bool         # => false
+"example".to_bool  # => false
+----
+
+==== String IO
+
+===== #reread
+
+Answers full string by rewinding to beginning of string and reading all content.
+
+[source,ruby]
+----
+io = StringIO.new
+io.write "This is a test."
+
+io.reread    # => "This is a test."
+io.reread 4  # => "This"
 
-"true".to_bool # => true
-"yes".to_bool # => true
-"1".to_bool # => true
-"".to_bool # => false
-"example".to_bool # => false
+buffer = "".dup
+io.reread(buffer: buffer)
+buffer # => "This is a test."
 ----
 
 == Tests

data/lib/refinements.rb

@@ -6,5 +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/arrays.rb

@@ -11,6 +11,14 @@ module Refinements
         replace compress
       end
 
+      def include *elements
+        self + elements.flatten
+      end
+
+      def exclude *elements
+        self - elements.flatten
+      end
+
       def ring &block
         [last, *self, first].each_cons 3, &block
       end

data/lib/refinements/hashes.rb

@@ -21,6 +21,33 @@ module Refinements
         replace except(*keys)
       end
 
+      # :reek:TooManyStatements
+      def flatten_keys prefix: nil, delimiter: "_", cast: :to_sym
+        fail StandardError, "Unknown cast: #{cast}." unless %i[to_sym to_s].include? cast
+
+        reduce({}) do |flat, (key, value)|
+          flat_key = prefix ? "#{prefix}#{delimiter}#{key}" : key
+
+          next flat.merge flat_key.public_send(cast) => value unless value.is_a? self.class
+
+          flat.merge(
+            recurse { value.flatten_keys prefix: flat_key, delimiter: delimiter, cast: cast }
+          )
+        end
+      end
+
+      def flatten_keys! prefix: nil, delimiter: "_", cast: :to_sym
+        replace flatten_keys(prefix: prefix, delimiter: delimiter, cast: cast)
+      end
+
+      def stringify_keys
+        reduce({}) { |hash, (key, value)| hash.merge key.to_s => value }
+      end
+
+      def stringify_keys!
+        replace stringify_keys
+      end
+
       def symbolize_keys
         reduce({}) { |hash, (key, value)| hash.merge key.to_sym => value }
       end
@@ -30,13 +57,9 @@ module Refinements
       end
 
       def deep_merge other
-        dup.deep_merge! other
-      end
-
-      def deep_merge! other
         clazz = self.class
 
-        merge! other do |_key, this_value, other_value|
+        merge other do |_key, this_value, other_value|
           if this_value.is_a?(clazz) && other_value.is_a?(clazz)
             this_value.deep_merge other_value
           else
@@ -45,12 +68,24 @@ module Refinements
         end
       end
 
+      def deep_merge! other
+        replace deep_merge(other)
+      end
+
+      def deep_stringify_keys
+        recurse(&:stringify_keys)
+      end
+
+      def deep_stringify_keys!
+        replace deep_stringify_keys
+      end
+
       def deep_symbolize_keys
         recurse(&:symbolize_keys)
       end
 
       def deep_symbolize_keys!
-        recurse(&:symbolize_keys!)
+        replace deep_symbolize_keys
       end
 
       def recurse &block
@@ -75,12 +110,12 @@ module Refinements
 
       def reverse_merge other
         warn "[DEPRECATION]: #reverse_merge is deprecated, use #merge instead."
-        other.merge self
+        merge(other) { |_key, old_value, _new_value| old_value }
       end
 
       def reverse_merge! other
         warn "[DEPRECATION]: #reverse_merge! is deprecated, use #merge! instead."
-        merge!(other) { |_key, old_value, _new_value| old_value }
+        replace reverse_merge(other)
       end
 
       def use &block

data/lib/refinements/identity.rb

@@ -5,7 +5,7 @@ module Refinements
   module Identity
     NAME = "refinements"
     LABEL = "Refinements"
-    VERSION = "7.6.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

data/lib/refinements/pathnames.rb

@@ -23,20 +23,30 @@ module Refinements
         self
       end
 
-      def directories pattern = "*"
-        glob(pattern).select(&:directory?).sort
+      def directories pattern = "*", flag: File::FNM_SYSCASE
+        glob(pattern, flag).select(&:directory?).sort
       end
 
       def extensions
         basename.to_s.split(/(?=\.)+/).tap(&:shift)
       end
 
-      def files pattern = "*"
-        glob(pattern).select(&:file?).sort
+      def files pattern = "*", flag: File::FNM_SYSCASE
+        glob(pattern, flag).select(&:file?).sort
       end
 
-      def relative_parent_from root
-        relative_path_from(root).parent
+      def gsub pattern, replacement
+        self.class.new to_s.gsub(pattern, replacement)
+      end
+
+      def relative_parent root_dir
+        relative_path_from(root_dir).parent
+      end
+
+      def relative_parent_from root_dir
+        warn "[DEPRECATION]: Pathname#relative_parent_from is deprecated, " \
+             "use Pathname#relative_parent instead."
+        relative_parent root_dir
       end
 
       def make_ancestors

data/lib/refinements/string_ios.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "stringio"
+
+module Refinements
+  module StringIOs
+    refine StringIO do
+      def reread length = nil, buffer: nil
+        tap(&:rewind).read length, buffer
+      end
+    end
+  end
+end

data/lib/refinements/strings.rb

@@ -2,9 +2,12 @@
 
 module Refinements
   module Strings
+    DELIMITERS = %r([a-z][A-Z]|\s*-\s*|\s*/\s*|\s*:+\s*|\s*_\s*|\s+).freeze
+
     refine String.singleton_class do
       def delimiters
-        %r([a-z][A-Z]|\s*-\s*|\s*/\s*|\s*:+\s*|\s*_\s*|\s+)
+        warn "[DEPRECATION]: .delimiters is deprecated, use DELIMITERS instead."
+        DELIMITERS
       end
     end
 
@@ -47,8 +50,14 @@ module Refinements
         first.downcase + self[1, size]
       end
 
+      def indent multiplier = 1, padding: "  "
+        return self if multiplier.negative?
+
+        padding * multiplier + self
+      end
+
       def camelcase
-        return up unless match? self.class.delimiters
+        return up unless match? DELIMITERS
 
         split(%r(\s*-\s*|\s*/\s*|\s*:+\s*)).then { |parts| combine parts, :up, "::" }
                                            .then { |text| text.split(/\s*_\s*|\s+/) }
@@ -56,7 +65,7 @@ module Refinements
       end
 
       def snakecase
-        return downcase unless match? self.class.delimiters
+        return downcase unless match? DELIMITERS
 
         split(%r(\s*-\s*|\s*/\s*|\s*:+\s*)).then { |parts| combine parts, :down, "/" }
                                            .then { |text| text.split(/(?=[A-Z])|\s*_\s*|\s+/) }
@@ -64,7 +73,7 @@ module Refinements
       end
 
       def titleize
-        return capitalize unless match? self.class.delimiters
+        return capitalize unless match? DELIMITERS
 
         split(/(?=[A-Z])|\s*_\s*|\s*-\s*|\s+/).then { |parts| combine parts, :up, " " }
                                               .then { |text| text.split %r(\s*/\s*|\s*:+\s*) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: refinements
 version: !ruby/object:Gem::Version
-  version: 7.6.0
+  version: 7.11.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   2XV8FRa7/JimI07sPLC13eLY3xd/aYTi85Z782KIA4j0G8XEEWAX0ouBhlXPocZv
   QWc=
   -----END CERTIFICATE-----
-date: 2020-07-04 00:00:00.000000000 Z
+date: 2020-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -162,14 +162,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.83'
+        version: '0.89'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.83'
+        version: '0.89'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -218,14 +218,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.19'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.19'
 description:
 email:
 - brooke@alchemists.io
@@ -244,7 +244,9 @@ 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
 homepage: https://www.alchemists.io/projects/refinements
 licenses: