refinements 7.15.1 → 7.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4efd7acd4d8da05214aa7947c0f61f3a04c8ece8733c2bdc4dc48ce9cbad371
-  data.tar.gz: 5025123a8cc9e8fe23d1a0436e265c173a89477e6b5194a159a1ed9e5cb5ec9c
+  metadata.gz: 27c7f3818bd1f3d0d3fc39cb4c8721097d5003176b54710888deba6d012b4f77
+  data.tar.gz: f607fea47fce94c11c3ab7dcc6603b169567133fbbe6ca76fb0af0c9fa0196e4
 SHA512:
-  metadata.gz: 48228ed81040b9e9b18f7e743d3cdb64885ea53515de5d588817a8969d6d02781e7404b8a6e33e7f24c70f982c3b3f5fd72b61ceb1c87a5d2c8eb8117e544641
-  data.tar.gz: 1d0a4c17a13822cea9d33b2dbdc937e1ea34559910821224b41230b1ac5ab4873f55b423d456fde87866befad8494972963f92dcddf188c996a6d04e8488ba2b
+  metadata.gz: da5ff60dc1e6d4055adc850bbe7aa48d02c148f17fb42c9e50f939d577d506097603c2790cf5ce040cce1cb8389e28ebd363d3318d1224d06df4fc6d36e56b3f
+  data.tar.gz: a5a96d51b0e95d1f603262ca8ce767969e3faca18645327f368d8ee03aed7d0fa27211d9e35a8af30bcc6ca86d6dad33d804a4c9f1b830789b39b06dc0791793

data/README.adoc

@@ -546,10 +546,79 @@ construct a valid path.
 Pathname(nil) # => Pathname("")
 ----
 
+===== .home
+
+Answers user home directory.
+
+[source,ruby]
+----
+Pathname.home  # => Pathname "/Users/bkuhlmann"
+----
+
+===== .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 automatidally 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 files in given root path and corresponding nested tree structure. All files are sorted
+before being required to ensure consistent behavior. Example:
+
+[source,rby]
+----
+# Before
+Dir[File.join(__dir__, "support/shared_contexts/**/*.rb")].sort.each { |path| require path }
+
+# After
+Pathname.require_tree __dir__, "support/shared_contexts/**/*.rb"
+----
+
+The following are further examples of potential usage:
+
+[source,ruby]
+----
+# Requires all files in root directory and below.
+Pathname.require_tree __dir__
+
+# Requires all files in `/test/**/*.rb` and below.
+Pathname.require_tree "/test"
+
+# Requires all files in RSpec shared examples directory structure.
+Pathname.require_tree Bundler.root.join("spec"), "support/shared_examples/**/*.rb"
+----
+
+===== .root
+
+Answers operating system root path.
+
+[source,ruby]
+----
+Pathname.root  # => Pathname "/"
+----
+
 ===== #change_dir
 
-Inherits and wraps `Dir.chdir` behavior by changing to directory of current path. See
-link:https://rubyapi.org/2.7/o/s?q=Dir.chdir[Dir.chdir] for details.
+Wraps `Dir.chdir` behavior by changing to directory of current path. See
+link:https://rubyapi.org/o/Dir.chdir#method-c-chdir[Dir.chdir] for details.
 
 [source,ruby]
 ----

data/lib/refinements/identity.rb

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

data/lib/refinements/pathnames.rb

@@ -12,6 +12,24 @@ module Refinements
       end
     end
 
+    refine Pathname.singleton_class do
+      def home
+        new ENV["HOME"]
+      end
+
+      def make_temp_dir prefix: "temp-", suffix: nil, root: nil
+        Dir.mktmpdir([prefix, suffix], root) { |path| block_given? ? yield(new path) : new(path) }
+      end
+
+      def require_tree root, pattern = "**/*.rb"
+        new(root).files(pattern).each { |path| require path.to_s }
+      end
+
+      def root
+        new "/"
+      end
+    end
+
     refine Pathname do
       def change_dir &block
         block ? Dir.chdir(self, &block) : (Dir.chdir self and self)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: refinements
 version: !ruby/object:Gem::Version
-  version: 7.15.1
+  version: 7.16.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   2XV8FRa7/JimI07sPLC13eLY3xd/aYTi85Z782KIA4j0G8XEEWAX0ouBhlXPocZv
   QWc=
   -----END CERTIFICATE-----
-date: 2020-11-21 00:00:00.000000000 Z
+date: 2020-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit