refinements 7.3.0 → 7.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07f6d846bc9cd533e7c5b7fae5eb8c5e9fbe9d496f5abe6c32443e49d1e4c74b
-  data.tar.gz: f5c01757545c4fb8f11f5485695ec4ecdaa5061966945161e8bdb7c53cfe5d19
+  metadata.gz: dd72c4e1fda257b53dcd80a052db0ce99cd5b2987e531bea93f577e6b3b131f9
+  data.tar.gz: 67b83319903a39425640eb0534eab280e7cb138e588476c635c5192afb08758d
 SHA512:
-  metadata.gz: 2787e284a26eb3e5db5cd3c33024163440220c1fba90a81c887b166eadf6b54ab73b5f369b3b1a03042a65abcbd886a093ff304a240315a14ec58e3ab1cd83a3
-  data.tar.gz: 6838f0cc48d65154bcb0761c4446bea18447a7571ec6a0836b58cff7c259f97365162bd636310a82fe6d1a9b8625edbb7cdba99521115ccee0c0059ba23c21cb
+  metadata.gz: 8fab91775e301f8765dd3156ab91e6abdf9395bdf767fbf859f80a5d3ea2bbebabef8dbe9e5e5a65e33443082a13e127ce3d85c1384b3939d753347384dea99e
+  data.tar.gz: 74934f4fbb6336ad4c434961c865b826675a71b76f846faae7635e6e09d3aa99bd74a9c74d6f0289f2d63a0c3352c9e21aecb60e35c2485664879520b20a755d

checksums.yaml.gz.sig

@@ -1,2 +1,3 @@
-̤�)#��TK��;� w!F>7�K������wI��	eC���x�<�P�?�Y�Ѩo.?�I�]�oB��S��I��c�>���5`&�����P��߯�[�����򷄔�yi���s<�"�ҭ`�N�5�D[�	VM�ዺ��z�8���M�T[zIx6޼���+��2lYӉ9
-^��8y��P���~p��C�մ�8WWla�A׹�bϓ�Q
+!�������PW�F�nk���~9�z��Z�3�o�GŚ��kw�+�~�� X�P���r4x�vq�p]���Ͱ�?��AMJM�
�Oc�y.π���i�Ql�P^��΅g�7��d �	:�/oJ��ݱ�Fl_N_:kI':�M���KE�W�P!
+�k2����]
+�RC���^��&��.����7W��T8-��:!��	/�?��5"Ix+��nOho�컎��r+���F���6m��%2P��f�

data/README.adoc

@@ -18,6 +18,8 @@ toc::[]
 * *Arrays*:
 ** `#compress` - Removes `nil` and empty values without modifying itself.
 ** `#compress!` - Removes `nil` and empty values while modifying itself.
+** `#include` - Adds given array or elements without modifying itself.
+** `#exclude` - Removes given array or elements without 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.
@@ -27,25 +29,39 @@ toc::[]
 ** `#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*:
-** `#except` - Answers new hash with given keys removed without modifying calling hash.
-** `#except!` - Answers new hash with given keys removed while modifying calling hash.
+** `.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.
-** `#reverse_merge` - Merges calling hash into passed in hash without modifying calling hash.
-** `#reverse_merge!` - Merges calling hash into passed in hash while modifying calling hash.
+** `#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.
-** `#relative_parent_from` - Answers relative path from parent directory. This is a complement to
+** `#files` - Answers all or filtered files for current path.
+** `#gsub` - Same behavior as `String#gsub` but answers a path with patterns replaced with desired
+   substitutes.
+** `#relative_parent` - 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 to current time for path.
+** `#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.
@@ -56,12 +72,15 @@ manipulation and immediate writing back to the same file.
 ** `#camelcase` - Answers a camelcased string.
 ** `#snakecase` - Answers a snakecased string.
 ** `#titleize` - Answers titleized string.
+** `#to_bool` - Answers string as a boolean.
+* *String IOs*:
+** `#reread` - Answers full string by rewinding to beginning of string and reading all content.
 
 == Requirements
 
-. https://www.ruby-lang.org[Ruby 2.7.x].
-. A solid understanding of https://www.youtube.com/watch?v=qXC9Gk4dCEw[Ruby refinements and lexical
-scope].
+. https://www.ruby-lang.org[Ruby].
+. A solid understanding of link:https://www.alchemists.io/articles/ruby_refinements[Ruby refinements
+  and lexical scope].
 
 == Setup
 
@@ -156,6 +175,12 @@ example = ["An", nil, "", "Example"]
 example.compress! # => ["An", "Example"]
 example # => ["An", "Example"]
 
+[1, 2, 3].include [4, 5] # => [1, 2, 3, 4, 5]
+[1, 2, 3].include 4, 5 # => [1, 2, 3, 4, 5]
+
+[1, 2, 3, 4, 5].exclude [4, 5] # => [1, 2, 3]
+[1, 2, 3, 4, 5].include 4, 5 # => [1, 2, 3, 4, 5]
+
 example = [1, 2, 3]
 example.ring # => #<Enumerator: ...>
 example.ring { |(before, current, after)| puts "#{before} #{current} #{after}" }
@@ -189,6 +214,15 @@ File.rewrite("/test.txt") { |content| content.gsub "[placeholder]", "example" }
 
 [source,ruby]
 ----
+example = Hash.infinite
+example[:a] # => {}
+example[:a][:b][:c] # => {}
+
+example = Hash.with_default ""
+example[:a] # => ""
+example = Hash.with_default []
+example[:b] # => []
+
 example = {a: 1, b: 2, c: 3}
 example.except :a, :b # => {c: 3}
 example # => {a: 1, b: 2, c: 3}
@@ -221,6 +255,26 @@ 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 = {"a" => {"b" => 2}}
+example.deep_symbolize_keys # => {a: {b: 1}}
+example # => {"a" => {"b" => 2}}
+
+example = {"a" => {"b" => 2}}
+example.deep_symbolize_keys! # => {a: {b: 1}}
+example # => {a: {b: 1}}
+
+example = {"a" => {"b" => 1}}
+example.recurse(&:symbolize_keys) # => {a: {b: 1}}
+example.recurse(&:invert) # => {{"b" => 1} => "a"}
+
+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 = {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 = {a: 1, b: 2}
 example.reverse_merge a: 0, c: 3 # => {a: 1, b: 2, c: 3}
 example # => {a: 1, b: 2}
@@ -237,12 +291,25 @@ example.use { |unit, street| "#{unit} #{street}" } # => "221B Baker Street"
 
 [source,ruby]
 ----
+Pathname(nil) # => Pathname("")
+
 Pathname("example.txt").name # => Pathname("example")
 
 Pathname("input.txt").copy Pathname("output.txt")
 
+Pathname("/example").directories # => [Pathname("a"), Pathname("b")]
+Pathname("/example").directories "a*" # => [Pathname("a")]
+Pathname("/example").directories flag: File::FNM_DOTMATCH # => [Pathname(".."), Pathname(".")]
+
 Pathname("example.txt.erb").extensions # => [".txt", ".erb"]
 
+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")]
+
+Pathname("/a/path/some/path").gsub("path", "test") # => Pathname("/a/test/some/test")
+Pathname("/%placeholder%/some/%placeholder%").gsub("%placeholder%", "test") # => Pathname("/test/some/test")
+
 Pathname("/one/two/three").relative_parent_from("/one") # => Pathname "two"
 
 Pathname("/one/two").make_ancestors
@@ -252,7 +319,7 @@ Pathname("/one/two").exist? # => false
 Pathname("/test.txt").rewrite { |content| content.sub "[placeholder]", "example" }
 
 Pathname("example.txt").touch
-Pathname("example.txt").touch accessed_at: Time.now - 1, modified_at: Time.now - 1
+Pathname("example.txt").touch at: Time.now - 1
 ----
 
 ==== String
@@ -266,11 +333,37 @@ Pathname("example.txt").touch accessed_at: Time.now - 1, modified_at: Time.now -
 "instant".last 3 # => "ant"
 
 " \n\t\r".blank? # => true
+
 "example".up # => "Example"
+
 "EXAMPLE".down # => "eXAMPLE"
+
 "this_is_an_example".camelcase # => "ThisIsAnExample"
+
 "ThisIsAnExample".snakecase # => "this_is_an_example"
+
 "ThisIsAnExample".titleize # => "This Is An Example"
+
+"true".to_bool # => true
+"yes".to_bool # => true
+"1".to_bool # => true
+"".to_bool # => false
+"example".to_bool # => false
+----
+
+==== String IO
+
+[source,ruby]
+----
+io = StringIO.new
+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."
 ----
 
 == Tests

data/lib/refinements.rb

@@ -8,3 +8,4 @@ require "refinements/files"
 require "refinements/hashes"
 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/files.rb

@@ -4,6 +4,7 @@ module Refinements
   module Files
     refine File.singleton_class do
       def rewrite path
+        warn "[DEPRECATION]: File.rewrite is deprecated, use Pathname#rewrite instead."
         read(path).then { |content| write path, yield(content) }
       end
     end

data/lib/refinements/hashes.rb

@@ -2,6 +2,16 @@
 
 module Refinements
   module Hashes
+    refine Hash.singleton_class do
+      def infinite
+        new { |new_hash, missing_key| new_hash[missing_key] = new(&new_hash.default_proc) }
+      end
+
+      def with_default value
+        new { |new_hash, missing_key| new_hash[missing_key] = value }
+      end
+    end
+
     refine Hash do
       def except *keys
         reject { |key, _value| keys.include? key }
@@ -23,10 +33,11 @@ module Refinements
         dup.deep_merge! other
       end
 
-      # :reek:FeatureEnvy
       def deep_merge! other
+        clazz = self.class
+
         merge! other do |_key, this_value, other_value|
-          if this_value.is_a?(Hash) && other_value.is_a?(Hash)
+          if this_value.is_a?(clazz) && other_value.is_a?(clazz)
             this_value.deep_merge other_value
           else
             other_value
@@ -34,11 +45,41 @@ module Refinements
         end
       end
 
+      def deep_symbolize_keys
+        recurse(&:symbolize_keys)
+      end
+
+      def deep_symbolize_keys!
+        recurse(&:symbolize_keys!)
+      end
+
+      def recurse &block
+        return self unless block_given?
+
+        transform = yield self
+
+        transform.each do |key, value|
+          transform[key] = value.recurse(&block) if value.is_a? self.class
+        end
+      end
+
+      def rekey mapping = {}
+        return self if mapping.empty?
+
+        transform_keys { |key| mapping[key] || key }
+      end
+
+      def rekey! mapping = {}
+        replace rekey(mapping)
+      end
+
       def reverse_merge other
+        warn "[DEPRECATION]: #reverse_merge is deprecated, use #merge instead."
         other.merge self
       end
 
       def reverse_merge! other
+        warn "[DEPRECATION]: #reverse_merge! is deprecated, use #merge! instead."
         merge!(other) { |_key, old_value, _new_value| old_value }
       end
 

data/lib/refinements/identity.rb

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

data/lib/refinements/pathnames.rb

@@ -4,6 +4,14 @@ require "pathname"
 
 module Refinements
   module Pathnames
+    refine Kernel do
+      def Pathname object
+        return super(String(object)) unless object
+
+        super
+      end
+    end
+
     refine Pathname do
       def name
         basename extname
@@ -15,12 +23,30 @@ module Refinements
         self
       end
 
+      def directories pattern = "*", flag: File::FNM_SYSCASE
+        glob(pattern, flag).select(&:directory?).sort
+      end
+
       def extensions
         basename.to_s.split(/(?=\.)+/).tap(&:shift)
       end
 
-      def relative_parent_from root
-        relative_path_from(root).parent
+      def files pattern = "*", flag: File::FNM_SYSCASE
+        glob(pattern, flag).select(&:file?).sort
+      end
+
+      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
 
@@ -17,20 +20,18 @@ module Refinements
         return self[0] if max.zero?
         return "" if max.negative?
 
-        self[0..(max - 1)]
+        self[..(max - 1)]
       end
 
-      # :reek:TooManyStatements
       def last number = 0
         return self if empty?
 
         min = Integer number
-        max = size - 1
 
-        return self[max] if min.zero?
+        return self[size - 1] if min.zero?
         return "" if min.negative?
 
-        self[(min + 1)..max]
+        self[(min + 1)..]
       end
 
       def blank?
@@ -50,33 +51,31 @@ module Refinements
       end
 
       def camelcase
-        if match? self.class.delimiters
-          split(%r(\s*\-\s*|\s*\/\s*|\s*\:+\s*)).then { |parts| combine parts, :up, "::" }
-                                                .then { |text| text.split(/\s*\_\s*|\s+/) }
-                                                .then { |parts| combine parts, :up }
-        else
-          up
-        end
+        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+/) }
+                                           .then { |parts| combine parts, :up }
       end
 
       def snakecase
-        if match? self.class.delimiters
-          split(%r(\s*\-\s*|\s*\/\s*|\s*\:+\s*)).then { |parts| combine parts, :down, "/" }
-                                                .then { |txt| txt.split(/(?=[A-Z])|\s*\_\s*|\s+/) }
-                                                .then { |parts| combine parts, :down, "_" }
-        else
-          downcase
-        end
+        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+/) }
+                                           .then { |parts| combine parts, :down, "_" }
       end
 
       def titleize
-        if match? self.class.delimiters
-          split(/(?=[A-Z])|\s*\_\s*|\s*\-\s*|\s+/).then { |parts| combine parts, :up, " " }
-                                                  .then { |text| text.split %r(\s*\/\s*|\s*\:+\s*) }
-                                                  .then { |parts| combine parts, :up, "/" }
-        else
-          capitalize
-        end
+        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*) }
+                                              .then { |parts| combine parts, :up, "/" }
+      end
+
+      def to_bool
+        %w[true yes on t y 1].include? downcase.strip
       end
 
       private

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: refinements
 version: !ruby/object:Gem::Version
-  version: 7.3.0
+  version: 7.8.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -28,7 +28,7 @@ cert_chain:
   2XV8FRa7/JimI07sPLC13eLY3xd/aYTi85Z782KIA4j0G8XEEWAX0ouBhlXPocZv
   QWc=
   -----END CERTIFICATE-----
-date: 2020-05-13 00:00:00.000000000 Z
+date: 2020-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -50,28 +50,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '14.0'
+        version: '14.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '14.0'
+        version: '14.2'
 - !ruby/object:Gem::Dependency
-  name: git-cop
+  name: git-lint
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -226,7 +226,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.18'
-description: 
+description:
 email:
 - brooke@alchemists.io
 executables: []
@@ -245,6 +245,7 @@ files:
 - lib/refinements/hashes.rb
 - lib/refinements/identity.rb
 - lib/refinements/pathnames.rb
+- lib/refinements/string_ios.rb
 - lib/refinements/strings.rb
 homepage: https://www.alchemists.io/projects/refinements
 licenses:
@@ -254,7 +255,7 @@ metadata:
   changelog_uri: https://www.alchemists.io/projects/refinements/changes.html
   documentation_uri: https://www.alchemists.io/projects/refinements
   source_code_uri: https://github.com/bkuhlmann/refinements
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -269,8 +270,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: A collection of refinements to core Ruby objects.
 test_files: []