refinements 12.10.0 → 13.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56d9d8ea056f8d22d211d5d9ad964b74e5fc86eb4be0b3476a1cd15c0ef74856
-  data.tar.gz: bd3d5e64e0dfd3ae296d81a6b96212390b223f79b91d14fd3af14eab2c2dd867
+  metadata.gz: fceef99a782c47ebc49c3838188470d7733a92df5402f94e4acb343963a3af88
+  data.tar.gz: 04b4536366245c5a31710d35830f8144271fdb369cd1a69d0a1ca0b6d609b95d
 SHA512:
-  metadata.gz: 63f889fedadba076370027afce7f0e176bd7e840d6b470d99043033a39f79277a4aebe7b0573e8d6c367432c59e98cb77b26ee62b5148f420121b632d86f8dfb
-  data.tar.gz: 47712bdf7aff52e05671f7fed297bd06f54dfa1e554e529723c3ab932b2204d30630a25906b757769f314c213e004014fc887bcdfd5b6ac36edf1949bd16335d
+  metadata.gz: d0ef79f4049cfe582f4516111c70f0568ade844a659c13e5e7d65b87651d14a8d938de3fcae525c274266f9bb66021babdc455f02f3cd9367f90dcd5b33f69ba
+  data.tar.gz: 50acd2a2dd7ff2a280cd978f2b37ae7edd71b54e41b0c4e6bdae31b955148daee2fd9980f8aefa21d61d47bcfa6e8ebe1df46281808a333482bdedd480f0d8af

data/README.adoc

@@ -18,8 +18,6 @@ Enhances the following objects:
 * DateTime
 * Hash
 * IO
-* LogDevice
-* Logger
 * Module
 * Object
 * Pathname
@@ -86,8 +84,6 @@ require "refinements/data"
 require "refinements/date_time"
 require "refinements/hash"
 require "refinements/io"
-require "refinements/log_device"
-require "refinements/logger"
 require "refinements/module"
 require "refinements/object"
 require "refinements/pathname"
@@ -111,8 +107,6 @@ class Example
   using Refinements::DateTime
   using Refinements::Hash
   using Refinements::IO
-  using Refinements::LogDevice
-  using Refinements::Logger
   using Refinements::Module
   using Refinements::Object
   using Refinements::Pathname
@@ -187,25 +181,6 @@ Removes given array or elements without mutating itself.
 [1, 2, 3, 4, 5].excluding 4, 5    # [1, 2, 3]
 ----
 
-===== #filter_find
-
-⚠️ _This is deprecated and will be removed in Version 13.0.0._
-
-Answers the first element which evaluates to true from a filtered collection.
-
-[source,ruby]
-----
-handlers = [
-  -> object { object if object == :b },
-  proc { false },
-  -> object { object if object == :a }
-]
-
-handlers.filter_find                                # Enumerator::Lazy
-handlers.filter_find { |handler| handler.call :a }  # :a
-handlers.filter_find { |handler| handler.call :x }  # nil
-----
-
 ===== #including
 
 Adds given array or elements without mutating itself.
@@ -922,69 +897,6 @@ io.squelch { io.write "Test" }  # "#<IO:fd 20>"
 io.reread                       # ""
 ----
 
-==== LogDevice
-
-===== #reread
-
-Answers previously written content by rewinding to beginning of device.
-
-[source,ruby]
-----
-# With File.
-device = Logger::LogDevice.new "test.log"
-device.write "Test."
-device.reread  # "Test."
-
-# With StringIO.
-device = Logger::LogDevice.new StringIO.new
-device.write "Test."
-device.reread  # "Test."
-
-# With STDOUT.
-device = Logger::LogDevice.new $stdout
-device.write "Test."
-device.reread  # ""
-----
-
-==== Logger
-
-===== #reread
-
-Answers previously written content by rewinding to beginning of log.
-
-[source,ruby]
-----
-# With File.
-logger = Logger.new "test.log"
-logger.write "Test."
-logger.reread  # "Test."
-
-# With StringIO.
-logger = Logger.new StringIO.new
-logger.write "Test."
-logger.reread  # "Test."
-
-# With STDOUT.
-logger = Logger.new $stdout
-logger.write "Test."
-logger.reread  # ""
-----
-
-===== #any
-
-Allows you to log _any_ message which is identical in behavior and functionality to the `Logger#unknown` method only this requires less typing and better matches the terminology used by the `#unknown` method.
-
-[source,ruby]
-----
-logger = Logger.new STDOUT
-
-logger.any "Test."
-# A, [2000-01-10T09:00:00.847428 #44925]   ANY -- : Test.
-
-logger.any { "Test." }
-A, [2000-01-10T09:00:00.330719 #44925]   ANY -- : Test.
-----
-
 ==== Module
 
 ===== #pseudonym
@@ -1083,29 +995,6 @@ Answers user home directory.
 Pathname.home  # Pathname "/Users/demo"
 ----
 
-===== .make_temp_dir
-
-Wraps `Dir.mktmpdir` with the following behavior (see
-link:https://rubyapi.org/o/Dir.mktmpdir#method-c-mktmpdir[Dir.mktmpdir] for details):
-
-* *Without Block* - Answers a newly created Pathname instance which is not automatically cleaned up.
-* *With Block*  Yields a Pathname instance, answers result of given block, and automatically cleans
-  up temporary directory after block exits.
-
-The following examples use truncated temporary directories for illustration purposes only. In
-reality, these paths will be longer depending on which operating system you are using.
-
-[source,ruby]
-----
-Pathname.make_temp_dir                                       # Pathname:/var/folders/T/temp-20200101-16940-r8
-Pathname.make_temp_dir prefix: "prefix-"                     # Pathname:/var/folders/T/prefix-20200101-16940-r8
-Pathname.make_temp_dir suffix: "-suffix"                     # Pathname:/var/folders/T/temp-20200101-16940-r8-suffix
-Pathname.make_temp_dir prefix: "prefix-", suffix: "-suffix"  # Pathname:/var/folders/T/prefix-20200101-16940-r8-suffix
-Pathname.make_temp_dir root: "/example"                      # Pathname:/example/temp-20200101-16940-r8
-Pathname.make_temp_dir { "I am a block result" }             # "I am a block result"
-Pathname.make_temp_dir { |path| path.join "sub_dir" }        # Pathname:/var/folders/T/temp-20200101-16940-r8/sub_dir
-----
-
 ===== .require_tree
 
 Requires all Ruby files in given root path and corresponding nested tree structure. All files are sorted before being required to ensure consistent behavior. Example:
@@ -1158,6 +1047,8 @@ custom.change_dir { |path| path }       # Pathname "$HOME/demo/test"
 Pathname.pwd                            # "$HOME/demo" (Present Working Directory)
 ----
 
+⚠️ This method is _not thread safe_ and suffers the same issues as found with native `Dir.chdir` functionality because the underlying native call is global. Use with care.
+
 ===== #copy
 
 Copies file from current location to new location while answering itself so it can be chained.
@@ -1231,7 +1122,7 @@ of contents. If a directory or file doesn't exist, it will be created.
 
 [source,ruby]
 ----
-directory = Pathname("test").make_path
+directory = Pathname("test").mkpath
 file = directory.join("test.txt").write("example")
 
 file.empty.read           # ""
@@ -1293,17 +1184,6 @@ Pathname("/one").make_dir           # Pathname("/one")
 Pathname("/one").make_dir.make_dir  # Pathname("/one")
 ----
 
-===== #make_path
-
-Provides alternative `#mkpath` behavior by always answering itself (even when full path exists) and
-not throwing errors when directory does exist in order to ensure the pathname can be chained.
-
-[source,ruby]
-----
-Pathname("/one/two/three").make_path            # Pathname("/one/two/three")
-Pathname("/one/two/three").make_path.make_path  # Pathname("/one/two/three")
-----
-
 ===== #name
 
 Answers file name without extension.
@@ -1347,27 +1227,6 @@ Pathname("/test").remove_dir                  # Pathname("/test")
 Pathname("/test").remove_dir.remove_dir       # Pathname("/test")
 ----
 
-===== #remove_tree
-
-Provides alternative `#rmtree` behavior by always answering itself (even when full path exists) and
-not throwing errors when directory does exist in order to ensure the pathname can be chained.
-
-[source,ruby]
-----
-parent_path = Pathname "/one"
-child_path = parent_path.join "two"
-
-child_path.make_path
-parent_path.remove_tree  # Pathname "/one"
-child_path.exist?        # false
-parent_path.exist?       # false
-
-child_path.make_path
-child_path.remove_tree   # Pathname "/one/two"
-child_path.exist?        # false
-parent_path.exist?       # true
-----
-
 ===== #rewrite
 
 When given a block, it provides the contents of the recently read file for manipulation and
@@ -1628,24 +1487,6 @@ io.to_str # "One, Two."
 
 ==== Struct
 
-===== .with_positions
-
-⚠️ _This is deprecated and will be removed in Version 13.0.0._
-
-Answers a struct instance with given positional arguments regardless of
-whether the struct was constructed with positional or keyword arguments.
-
-[source,ruby]
-----
-Example = Struct.new :a, :b, :c
-Example.with_positions 1, 2, 3  # #<struct a=1, b=2, c=3>
-Example.with_positions 1        # #<struct a=1, b=nil, c=nil>
-
-Example = Struct.new :a, :b, :c, keyword_init: true
-Example.with_positions 1, 2, 3  # #<struct a=1, b=2, c=3>
-Example.with_positions 1        # #<struct a=1, b=nil, c=nil>
-----
-
 ===== #diff
 
 Allows you to obtain the differences between two objects.
@@ -1700,47 +1541,6 @@ example.merge! a: 10, b: 20, c: 30  # #<struct Struct::Example a=10, b=20, c=30>
 example                             # #<struct Struct::Example a=10, b=20, c=30>
 ----
 
-===== #revalue
-
-Transforms values without mutating itself. An optional hash can be supplied to target specific
-attributes. In the event that a block isn't supplied, the struct will answer itself since there is
-nothing to operate on. Works regardless of whether the struct is constructed with
-positional or keyword arguments.
-
-[source,ruby]
-----
-example = Struct.new("Example", :a, :b, :c).new 1, 2, 3
-
-example.revalue { |value| value * 2 }                             # #<struct Struct::Example a=2, b=4, c=6>
-example.revalue(c: 2) { |previous, current| previous + current }  # #<struct Struct::Example a=1, b=2, c=5>
-example.revalue c: 2                                              # #<struct Struct::Example a=1, b=2, c=3>
-example.revalue                                                   # #<struct Struct::Example a=1, b=2, c=3>
-example                                                           # #<struct Struct::Example a=1, b=2, c=3>
-----
-
-===== #revalue!
-
-Transforms values while mutating itself. An optional hash can be supplied to target specific
-attributes. In the event that a block isn't supplied, the struct will answer itself since there is
-nothing to operate on. Works regardless of whether the struct is constructed with
-positional or keyword arguments.
-
-[source,ruby]
-----
-one = Struct.new("One", :a, :b, :c).new 1, 2, 3
-one.revalue! { |value| value * 2 }                             # #<struct Struct::One a=2, b=4, c=6>
-one                                                            # #<struct Struct::One a=2, b=4, c=6>
-
-two = Struct.new("Two", :a, :b, :c).new 1, 2, 3
-two.revalue!(c: 2) { |previous, current| previous + current }  # #<struct Struct::Two a=1, b=2, c=5>
-two                                                            # #<struct Struct::Two a=1, b=2, c=5>
-
-three = Struct.new("Three", :a, :b, :c).new 1, 2, 3
-three.revalue! c: 2                                            # #<struct Struct::Three a=1, b=2, c=3>
-three.revalue!                                                 # #<struct Struct::Three a=1, b=2, c=3>
-three                                                          # #<struct Struct::Three a=1, b=2, c=3>
-----
-
 ===== #transmute
 
 Transmutes given enumerable by using the foreign key map and merging those key values into the

data/lib/refinements/array.rb

@@ -19,13 +19,6 @@ module Refinements
 
       def excluding(*elements) = self - elements.flatten
 
-      def filter_find(&)
-        warn "`#{self.class}##{__method__}` is deprecated and will be removed in Version 13.0.0.",
-             category: :deprecated
-
-        block_given? ? lazy.map(&).find(&:itself) : lazy
-      end
-
       def including(*elements) = self + elements.flatten
 
       def intersperse(*elements) = product([elements]).tap(&:pop).flatten.push(last)

data/lib/refinements/hash.rb

@@ -88,8 +88,8 @@ module Refinements
 
       def transform_with(**) = dup.transform_with!(**)
 
-      def transform_with!(**operations)
-        operations.each { |key, function| self[key] = function.call self[key] if key? key }
+      def transform_with!(**mutations)
+        mutations.each { |key, function| transform_value! key, &function }
         self
       end
 

data/lib/refinements/io.rb

@@ -7,7 +7,7 @@ module Refinements
   module IO
     refine ::IO.singleton_class do
       def void
-        new(sysopen("/dev/null", "w+")).then do |io|
+        new(sysopen(File::NULL, "w+")).then do |io|
           return io unless block_given?
 
           yield io

data/lib/refinements/pathname.rb

@@ -16,14 +16,6 @@ module Refinements
     refine ::Pathname.singleton_class do
       def home = new ENV.fetch("HOME", "")
 
-      def make_temp_dir prefix: "temp-", suffix: nil, root: nil
-        if block_given?
-          Dir.mktmpdir([prefix, suffix], root) { |path| yield new(path) }
-        else
-          new Dir.mktmpdir([prefix, suffix], root)
-        end
-      end
-
       def require_tree(root) = new(root).files("**/*.rb").each { |path| require path.to_s }
 
       def root = new(File::SEPARATOR)
@@ -56,7 +48,7 @@ module Refinements
         glob(pattern, flag).select(&:directory?)
       end
 
-      def empty = file? ? (truncate(0) and self) : remove_tree.make_dir
+      def empty = file? ? (truncate(0) and self) : rmtree.make_dir
 
       def extensions = basename.to_s.split(/(?=\.)+/).tap(&:shift)
 
@@ -71,11 +63,6 @@ module Refinements
 
       def make_dir = exist? ? self : (mkdir and self)
 
-      def make_path
-        mkpath
-        self
-      end
-
       def name = basename extname
 
       def puts(content) = write "#{content}\n"
@@ -84,11 +71,6 @@ module Refinements
 
       def remove_dir = exist? ? (rmdir and self) : self
 
-      def remove_tree
-        rmtree if exist?
-        self
-      end
-
       def rewrite = read.then { |content| write yield(content) if block_given? }
 
       def touch at = Time.now

data/lib/refinements/struct.rb

@@ -5,15 +5,6 @@ require "refinements/shared/diff"
 module Refinements
   # Provides additional enhancements to the Struct primitive.
   module Struct
-    refine ::Struct.singleton_class do
-      def with_positions(*values)
-        warn "`#{self.class}##{__method__}` is deprecated and will be removed in Version 13.0.0.",
-             category: :deprecated
-
-        keyword_init? ? new(**members.zip(values).to_h) : new(*values)
-      end
-    end
-
     refine ::Struct do
       import_methods Shared::Diff
 
@@ -24,19 +15,6 @@ module Refinements
         self
       end
 
-      def revalue attributes = each_pair
-        return self unless block_given?
-
-        dup.tap { |copy| attributes.each { |key, value| copy[key] = yield self[key], value } }
-      end
-
-      def revalue! attributes = each_pair
-        return self unless block_given?
-
-        attributes.each { |key, value| self[key] = yield self[key], value }
-        self
-      end
-
       def transmute(...) = dup.transmute!(...)
 
       def transmute! object, **key_map

data/lib/refinements.rb

@@ -6,8 +6,6 @@ require "refinements/data"
 require "refinements/date_time"
 require "refinements/hash"
 require "refinements/io"
-require "refinements/log_device"
-require "refinements/logger"
 require "refinements/module"
 require "refinements/object"
 require "refinements/pathname"

data/refinements.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "refinements"
-  spec.version = "12.10.0"
+  spec.version = "13.0.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/refinements"
@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.signing_key = Gem.default_key_path
   spec.cert_chain = [Gem.default_cert_path]
 
-  spec.required_ruby_version = ">= 3.3", "<= 3.4"
+  spec.required_ruby_version = "~> 3.4"
 
   spec.files = Dir["*.gemspec", "lib/**/*"]
   spec.extra_rdoc_files = Dir["README*", "LICENSE*"]

metadata

@@ -1,11 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: refinements
 version: !ruby/object:Gem::Version
-  version: 12.10.0
+  version: 13.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
-autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -35,9 +34,8 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2024-10-22 00:00:00.000000000 Z
+date: 2024-12-27 00:00:00.000000000 Z
 dependencies: []
-description:
 email:
 - brooke@alchemists.io
 executables: []
@@ -55,8 +53,6 @@ files:
 - lib/refinements/date_time.rb
 - lib/refinements/hash.rb
 - lib/refinements/io.rb
-- lib/refinements/log_device.rb
-- lib/refinements/logger.rb
 - lib/refinements/module.rb
 - lib/refinements/object.rb
 - lib/refinements/pathname.rb
@@ -79,16 +75,12 @@ metadata:
   label: Refinements
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/bkuhlmann/refinements
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
-    - !ruby/object:Gem::Version
-      version: '3.3'
-  - - "<="
+  - - "~>"
     - !ruby/object:Gem::Version
       version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -97,8 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A collection of core object refinements.
 test_files: []

data/lib/refinements/log_device.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require "logger"
-require "refinements/string_io"
-
-module Refinements
-  # Provides additional enhancements to a log device.
-  module LogDevice
-    using StringIO
-
-    refine ::Logger::LogDevice do
-      def reread
-        case dev
-          when ::File then dev.class.new(dev).read
-          when ::StringIO then dev.reread
-          else ""
-        end
-      end
-    end
-  end
-end

data/lib/refinements/logger.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require "refinements/log_device"
-
-module Refinements
-  # Provides additional enhancements to a logger.
-  module Logger
-    using LogDevice
-
-    refine ::Logger do
-      def reread = @logdev.reread
-
-      alias_method :any, :unknown
-    end
-  end
-end