refinements 7.14.0 → 7.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4abbbd79616d97836ca58503bb4638e2638e14732e76e7c00b3f5c033f708edc
-  data.tar.gz: 516c79b5361a7512ca4e63c72303d8fb0d2cb85c693bc9aa13c36ef767580f10
+  metadata.gz: 756d9dcbbc60385370835ad8001dd4fb84f6848aba8ca51cbe949fcd2aaa72a4
+  data.tar.gz: f09562bfe5991533c166f5aa0aa215a3f2fe8df3604e85dd3404a7688df67980
 SHA512:
-  metadata.gz: 2f15aa4b466d6e610a2ffc45ad16285d27107c93a4260d214abcee42e66005951a5f2a708da6b04a28826ab3abd0a85ad0e1a707782b6ba5c51ef5cb0b705ec7
-  data.tar.gz: ec214191217bb870ca264fbfe3fa31d57b6c37c28e0f92806f779d3ea8400fbac11ee4aa38c82d6d10d7b07187a2360a7aa810ef802e6d219a217043cd76e69c
+  metadata.gz: b37235bf15f3b959dd295a22c3e9c89dff28faa4124da955b0e27b2bef7db505d3093dc56369550d2863e6dc2ca3d10bbfe248da1e7a70f0eaee7fb351bd4e9f
+  data.tar.gz: 0c7aeed58557e626cc6494d761e79c4a0bcb60f42e79d83cef01676c9fd5fbf838dd97f4b89c3234a978455d3acfb6bdd3f715ed55dfed05a92e5f0e86d7426d

data/README.adoc

@@ -28,6 +28,7 @@ Enhances the following objects:
 * Pathname
 * String
 * StringIO
+* Structs
 
 == Requirements
 
@@ -75,6 +76,7 @@ require "refinements/ios"
 require "refinements/pathnames"
 require "refinements/strings"
 require "refinements/string_ios"
+require "refinements/structs"
 ----
 
 === Using
@@ -94,6 +96,7 @@ class Example
   using Refinements::Pathnames
   using Refinements::Strings
   using Refinements::StringIOs
+  using Refinements::Structs
 end
 ----
 
@@ -481,11 +484,8 @@ 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
+io = IO.void                                    # => #<IO:fd 20>
+io = IO.void { |void| void.write "nevermore" }  # => #<IO:(closed)>
 ----
 
 ===== #redirect
@@ -498,11 +498,8 @@ answered instead.
 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"
+io.redirect other                                    # => #<IO:fd 20>
+io.redirect(other) { |stream| stream.write "test" }  # => #<IO:fd 21>
 ----
 
 ===== #reread
@@ -518,30 +515,31 @@ io.reread    # => "This is a test."
 io.reread 4  # => "This"
 
 buffer = "".dup
-io.reread(buffer: buffer)
-buffer # => "This is a test."
+io.reread(buffer: buffer)  # => "This is a test."
+buffer                     # => "This is a test."
 ----
 
 ===== #squelch
 
-Temporarily ignores any reads/writes for current stream for all code executed within the block. When
-not given a block, it answers itself.
+Temporarily ignores any reads/writes for code executed within a block. Answers itself without any
+arguments or when given a block.
 
 [source,ruby]
 ----
 io = IO.new IO.sysopen(Pathname("test.txt").to_s, "w+")
-io.squelch { io.write "Test" }
-io.reread # => ""
+io.squelch                      # => #<IO:fd 20>
+io.squelch { io.write "Test" }  # => #<IO:fd 20>
+io.reread                       # => ""
 ----
 
 ==== 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.
+Enhances the `Kernel` conversion function which casts `nil` into a pathname in order to avoid:
+`TypeError (no implicit conversion of nil into String)`. The pathname remains invalid but at least
+you have an instance of `Pathname`, which behaves like a _Null Object_, that can be used to
+construct a valid path.
 
 [source,ruby]
 ----
@@ -559,23 +557,23 @@ Pathname.pwd                           # => "/"
 Pathname("/test").make_dir.change_dir  # => Pathname "/test"
 Pathname.pwd                           # => "/test"
 
-Pathname.pwd                                                        # => "/"
-Pathname("/test").make_dir.change_dir { # Implementation details }  # => Pathname "/test"
-Pathname.pwd                                                        # => "/"
+Pathname.pwd                                         # => "/"
+Pathname("/test").make_dir.change_dir { "example" }  # => "example"
+Pathname.pwd                                         # => "/"
 ----
 
 ===== #copy
 
-Copies file from current location to new location.
+Copies file from current location to new location while answering itself so it can be chained.
 
 [source,ruby]
 ----
-Pathname("input.txt").copy Pathname("output.txt")
+Pathname("input.txt").copy Pathname("output.txt")  # => Pathname("input.txt")
 ----
 
 ===== #directories
 
-Answers all or filtered directories for current path.
+Answers all directories or filtered directories for current path.
 
 [source,ruby]
 ----
@@ -595,7 +593,7 @@ Pathname("example.txt.erb").extensions # => [".txt", ".erb"]
 
 ===== #files
 
-Answers all or filtered files for current path.
+Answers all files or filtered files for current path.
 
 [source,ruby]
 ----
@@ -623,9 +621,9 @@ 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/two").make_ancestors  # => Pathname("/one/two")
+Pathname("/one").exist?              # => true
+Pathname("/one/two").exist?          # => false
 ----
 
 ===== #make_dir
@@ -708,7 +706,8 @@ immediate writing back to the same file.
 
 [source,ruby]
 ----
-Pathname("/test.txt").rewrite { |content| content.sub "[placeholder]", "example" }
+Pathname("/test.txt").rewrite                                           # => Pathname("/test.txt")
+Pathname("/test.txt").rewrite { |body| body.sub "[token]", "example" }  # => Pathname("/test.txt")
 ----
 
 ===== #touch
@@ -717,8 +716,20 @@ 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
+Pathname("example.txt").touch                   # => Pathname("example.txt")
+Pathname("example.txt").touch at: Time.now - 1  # => Pathname("example.txt")
+----
+
+===== #write
+
+Writes to file and answers itself so it can be chained. See `IO.write` for details on additional
+options.
+
+[source,ruby]
+----
+Pathname("example.txt").write "test"             # => Pathname("example.txt")
+Pathname("example.txt").write "test", offset: 1  # => Pathname("example.txt")
+Pathname("example.txt").write "test", mode: "a"  # => Pathname("example.txt")
 ----
 
 ==== String
@@ -838,8 +849,52 @@ io.reread    # => "This is a test."
 io.reread 4  # => "This"
 
 buffer = "".dup
-io.reread(buffer: buffer)
-buffer # => "This is a test."
+io.reread(buffer: buffer)  # => "This is a test."
+buffer                     # => "This is a test."
+----
+
+==== Struct
+
+===== #merge
+
+Merges multiple attributes without mutating itself.
+
+[source,ruby]
+----
+Example = Struct.new :a, :b, :c
+example = Example[1, 2, 3]
+example.merge a: 10                # => #<struct a=10, b=2, c=3>
+example.merge a: 10, c: 30         # => #<struct a=10, b=2, c=30>
+example.merge a: 10, b: 20, c: 30  # => #<struct a=10, b=20, c=30>
+example                            # => #<struct a=1, b=2, c=3>
+
+Example = Struct.new :a, :b, :c, keyword_init: true
+example = Example[a: 1, b: 2, c: 3]
+example.merge a: 10                # => #<struct a=10, b=2, c=3>
+example.merge a: 10, c: 30         # => #<struct a=10, b=2, c=30>
+example.merge a: 10, b: 20, c: 30  # => #<struct a=10, b=20, c=30>
+example                            # => #<struct a=1, b=2, c=3>
+----
+
+===== #merge!
+
+Merges multiple attributes while mutating itself.
+
+[source,ruby]
+----
+Example = Struct.new :a, :b, :c
+example = Example[1, 2, 3]
+example.merge! a: 10                # => #<struct a=10, b=2, c=3>
+example.merge! a: 10, c: 30         # => #<struct a=10, b=2, c=30>
+example.merge! a: 10, b: 20, c: 30  # => #<struct a=10, b=20, c=30>
+example                             # => #<struct a=10, b=20, c=30>
+
+Example = Struct.new :a, :b, :c, keyword_init: true
+example = Example[a: 1, b: 2, c: 3]
+example.merge! a: 10                # => #<struct a=10, b=2, c=3>
+example.merge! a: 10, c: 30         # => #<struct a=10, b=2, c=30>
+example.merge! a: 10, b: 20, c: 30  # => #<struct a=10, b=20, c=30>
+example                             # => #<struct a=10, b=20, c=30>
 ----
 
 == Development

data/lib/refinements.rb

@@ -10,3 +10,4 @@ require "refinements/ios"
 require "refinements/pathnames"
 require "refinements/strings"
 require "refinements/string_ios"
+require "refinements/structs"

data/lib/refinements/hashes.rb

@@ -73,7 +73,7 @@ module Refinements
       end
 
       def recurse &block
-        return self unless block_given?
+        return self unless block
 
         transform = yield self
 
@@ -119,7 +119,7 @@ module Refinements
       end
 
       def use &block
-        return [] unless block_given?
+        return [] unless block
 
         block.parameters
              .map { |(_type, key)| self[key] }

data/lib/refinements/identity.rb

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

data/lib/refinements/pathnames.rb

@@ -14,7 +14,7 @@ module Refinements
 
     refine Pathname do
       def change_dir &block
-        block_given? ? Dir.chdir(self, &block) : (Dir.chdir self and self)
+        block ? Dir.chdir(self, &block) : (Dir.chdir self and self)
       end
 
       def copy to
@@ -82,13 +82,17 @@ module Refinements
 
       def rewrite
         read.then { |content| write yield(content) if block_given? }
-        self
       end
 
       def touch at: Time.now
         exist? ? utime(at, at) : write("")
         self
       end
+
+      def write content, offset: nil, **options
+        super content, offset, options
+        self
+      end
     end
   end
 end

data/lib/refinements/structs.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Refinements
+  module Structs
+    refine Struct do
+      def merge **attributes
+        dup.merge! attributes
+      end
+
+      def merge! **attributes
+        to_h.merge(attributes).each { |key, value| self[key] = value }
+        self
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: refinements
 version: !ruby/object:Gem::Version
-  version: 7.14.0
+  version: 7.15.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   2XV8FRa7/JimI07sPLC13eLY3xd/aYTi85Z782KIA4j0G8XEEWAX0ouBhlXPocZv
   QWc=
   -----END CERTIFICATE-----
-date: 2020-11-14 00:00:00.000000000 Z
+date: 2020-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -58,6 +58,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: gemsmith
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '14.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '14.8'
+- !ruby/object:Gem::Dependency
+  name: git-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -234,6 +262,7 @@ files:
 - lib/refinements/pathnames.rb
 - lib/refinements/string_ios.rb
 - lib/refinements/strings.rb
+- lib/refinements/structs.rb
 homepage: https://www.alchemists.io/projects/refinements
 licenses:
 - Apache-2.0