refinements 9.0.1 → 9.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70acf2b8c8ba95ab2cb0189c0367b2292442abf3d9d81cbe6e820ef95c5a66b5
-  data.tar.gz: 48d5e2e7d1a7a3e8f076436faebc91f3bda04767a28eee1440d44e3d7b08f60b
+  metadata.gz: ad550aa0de5b7885133c4a146ff83f8df49184e10fdafc36c57a32511d4ca4e3
+  data.tar.gz: 52279fbf8e921a3500b5b341bd421b7827ad37f5f5cd0c0976042b33a2332885
 SHA512:
-  metadata.gz: 7b492840eacf8c27793979d6d8618dfc01802c9d4135056a49710a1e15fa10795d2d946c6133db444145701c822941ffaeccd1cddb5d4edf688e634af9ba76ee
-  data.tar.gz: 5ae2b2815f56b7b863b00ba18f8ec496bcd761d3919db52f5b805e5b3336cd30f4eaf4ef50b573507977ac09e54146aae577e1b44bded757472ece82de96f006
+  metadata.gz: '095faf7714a553a86654fbb302ebaebe964ba8c291f5e6bf4dc010a2f96ae74ddf2b4bc2fd3a537eb4f76ae38d8bfdc1f06d9a70ac62b039d8437cdbe6fddd0d'
+  data.tar.gz: d642f75675fa88cf809ea086e4965b43d091c90ff75f11b0d5878ba2f4e900ef427c849b18345b6f1804729a91e20d805ce67223c334fe4af44f1c104b34026e

data/README.adoc

@@ -11,12 +11,11 @@ image::https://img.shields.io/badge/code_style-alchemists-brightgreen.svg[Alchem
 [link=https://circleci.com/gh/bkuhlmann/refinements]
 image::https://circleci.com/gh/bkuhlmann/refinements.svg?style=svg[Circle CI Status]
 
-Refinements are a collection of enhancements to primitive Ruby objects without needing to resort to
-painful and hard to debug
-link:https://www.alchemists.io/articles/ruby_antipatterns/#_monkey_patches[monkey patches]. These
-refinements give you additional syntactic sugar to develop clean and concise implementations while
-using less code. By refining our code we can acquire the functionality we wish the core primitives
-had!
+Refinements are a collection primitive Ruby objects enhancements without needing to resort to hard
+to debug link:https://www.alchemists.io/articles/ruby_antipatterns/#_monkey_patches[monkey patches].
+These refinements give you additional syntactic sugar to develop clean and concise implementations
+while using less code. By refining our code we can acquire the functionality we wish the core
+primitives had!
 
 toc::[]
 
@@ -148,7 +147,7 @@ Removes given array or elements without mutating itself.
 
 ===== #filter_find
 
-Answers the first truthy and filtered result from a collection.
+Answers the first element which evaluates to true from a filtered collection.
 
 [source,ruby]
 ----
@@ -349,7 +348,7 @@ 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.
+Answers string keys of a nested hash without mutating itself. Does not handle nested arrays, though.
 
 [source,ruby]
 ----
@@ -360,7 +359,7 @@ example                      # {a: {b: 2}}
 
 ===== #deep_stringify_keys!
 
-Stringifies keys of nested hash while mutating itself. Does not handle nested arrays, though.
+Answers string keys of nested hash while mutating itself. Does not handle nested arrays, though.
 
 [source,ruby]
 ----
@@ -827,14 +826,14 @@ parent_path = Pathname "/one"
 child_path = parent_path.join "two"
 
 child_path.make_path
-child_path.remove_tree   # Pathname "/one/two"
+parent_path.remove_tree  # Pathname "/one"
 child_path.exist?        # false
-paremt_path.exist?       # true
+parent_path.exist?       # false
 
 child_path.make_path
-parent_path.remove_tree  # Pathname "/one"
+child_path.remove_tree   # Pathname "/one/two"
 child_path.exist?        # false
-parent_path.exist?       # false
+parent_path.exist?       # true
 ----
 
 ===== #rewrite
@@ -886,7 +885,7 @@ Answers `true`/`false` based on whether string is blank, `<space>`, `\n`, `\t`,
 
 ===== #camelcase
 
-Answers a camelcased string.
+Answers a camel cased string.
 
 [source,ruby]
 ----
@@ -895,7 +894,7 @@ Answers a camelcased string.
 
 ===== #down
 
-Answers string with only first letter downcased.
+Answers string with only first letter down cased.
 
 [source,ruby]
 ----
@@ -977,7 +976,7 @@ well in other languages.
 
 ===== #snakecase
 
-Answers a snakecased string.
+Answers a snake cased string.
 
 [source,ruby]
 ----
@@ -986,7 +985,7 @@ Answers a snakecased string.
 
 ===== #titleize
 
-Answers titleized string.
+Answers a title string with proper capitalization of each word.
 
 [source,ruby]
 ----
@@ -1008,7 +1007,7 @@ Answers string as a boolean.
 
 ===== #up
 
-Answers string with only first letter upcased.
+Answers string with only first letter capitalized.
 
 [source,ruby]
 ----
@@ -1038,6 +1037,8 @@ buffer                     # "This is a test."
 
 ===== .keyworded?
 
+⚠️ Will be removed in the next major version. Use `.keyword_init?` instead.
+
 Answers whether a struct was constructed with keyword or positional arguments.
 
 [source,ruby]

data/lib/refinements/identity.rb

@@ -5,7 +5,7 @@ module Refinements
   module Identity
     NAME = "refinements"
     LABEL = "Refinements"
-    VERSION = "9.0.1"
+    VERSION = "9.0.2"
     VERSION_LABEL = "#{LABEL} #{VERSION}".freeze
   end
 end

data/lib/refinements/pathnames.rb

@@ -17,7 +17,11 @@ module Refinements
       def home = new(ENV["HOME"])
 
       def make_temp_dir prefix: "temp-", suffix: nil, root: nil
-        Dir.mktmpdir([prefix, suffix], root) { |path| block_given? ? yield(new path) : new(path) }
+        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, pattern = "**/*.rb"

data/lib/refinements/structs.rb

@@ -4,11 +4,14 @@ module Refinements
   # Provides additional enhancements to the Struct primitive.
   module Structs
     refine Struct.singleton_class do
-      def keyworded? = inspect.include?("keyword_init: true")
+      def keyworded?
+        warn "[DEPRECATION]: .keyworded? is deprecated, use .keyword_init? instead."
+        inspect.include?("keyword_init: true")
+      end
 
-      def with_keywords(**arguments) = keyworded? ? new(**arguments) : new.merge!(**arguments)
+      def with_keywords(**arguments) = keyword_init? ? new(**arguments) : new.merge!(**arguments)
 
-      def with_positions(*values) = keyworded? ? new(**members.zip(values).to_h) : new(*values)
+      def with_positions(*values) = keyword_init? ? new(**members.zip(values).to_h) : new(*values)
     end
 
     refine Struct do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: refinements
 version: !ruby/object:Gem::Version
-  version: 9.0.1
+  version: 9.0.2
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   lkHilIrX69jq8wMPpBhlaw2mRmeSL50Wv5u6xVBvOHhXFSP1crXM95vfLhLyRYod
   W2A=
   -----END CERTIFICATE-----
-date: 2022-01-01 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies: []
 description:
 email: