refinements 12.6.0 → 12.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e32b598b948abb097125834b408d41c1fa4313a671615b89475c101089fbb870
-  data.tar.gz: 9fb3a2380ac0effbe2ac0ca5045e736b9730b2c57162c927f3f0577d04e4da81
+  metadata.gz: 81242c43b3aad6b04319273228ac9a83e1dde30677f95bafe56629552e9a2aff
+  data.tar.gz: 350fbedab3dba89b6506b73b1ee1eb029d0fab302d347caddccfb53af865bc8b
 SHA512:
-  metadata.gz: dd4fcab10575c3b0933edbf5290b29fbd2498225f40ff038a626d72dda70462f5b24f1ae76f885d7be5134953d050336024de70bdd3d8545010a3fd4d173e4b3
-  data.tar.gz: 1c2a09c4a735be01b6d471548a1621f09d75c394c0a6afcea599cce7c812fb9d2ee4e0510ff8e24cd9d0c6110233d1d764bbc0767b81c287b849ab80241eb826
+  metadata.gz: 3b52ff2d707ddca982386b1f65d49f21a080faa3f5985adead49c3c15c3bed2ebc4c5587c0bedbbe2fcc3a0b80e97946c5b895fb365d39eeeabf02922b0388a0
+  data.tar.gz: f7eaf17a912a7ddfdf05117da9a13f0bd699aae9238f6df8e8dcc26f963f431781710a20f39775162547c44fe847d04edd6304da3bbaea90412e74db35f2c72f

data/README.adoc

@@ -13,16 +13,19 @@ toc::[]
 Enhances the following objects:
 
 * Array
+* Binding
 * Data
 * DateTime
 * Hash
 * IO
 * LogDevice
 * Logger
+* Object
 * Pathname
 * String
 * StringIO
 * Struct
+* Symbol
 
 == Requirements
 
@@ -77,12 +80,14 @@ gem "refinements", require: false
 [source,ruby]
 ----
 require "refinements/array"
+require "refinements/binding"
 require "refinements/data"
 require "refinements/date_time"
 require "refinements/hash"
 require "refinements/io"
 require "refinements/log_device"
 require "refinements/logger"
+require "refinements/object"
 require "refinements/pathname"
 require "refinements/string"
 require "refinements/string_io"
@@ -99,12 +104,14 @@ refinement(s):
 ----
 class Example
   using Refinements::Array
+  using Refinements::Binding
   using Refinements::Data
   using Refinements::DateTime
   using Refinements::Hash
   using Refinements::IO
   using Refinements::LogDevice
   using Refinements::Logger
+  using Refinements::Object
   using Refinements::Pathname
   using Refinements::String
   using Refinements::StringIO
@@ -394,6 +401,59 @@ Further enhances `#to_sentence` by answering a sentence where all elements are i
 
 💡 You can use a string or a symbol for the conjunction (i.e. `"and"` or `:and`).
 
+==== Binding
+
+===== #[]
+
+Allows you to obtain a local variable. This is an alias to `#local_variable_get`.
+
+[source,ruby]
+----
+a = 1
+binding[:a]      # 1
+binding[:bogus]  # `bogus' is not defined (NameError)
+----
+
+===== #[]=
+
+Allows you to set a local variable. This is an alias to `#local_variable_set`.
+
+[source,ruby]
+----
+a = 1
+binding[:a] = 5
+binding[:bogus] = "bad"
+
+binding[:a]      # 5
+binding[:bogus]  # # `bogus' is not defined (NameError)
+----
+
+===== #local?
+
+Allows you to check if local variable is defined. This is an alias to `#local_variable_defined?`.
+
+[source,ruby]
+----
+a = 1
+
+binding.local? :a  # true
+binding.local? :b  # false
+----
+
+===== #locals
+
+Allows you to acquire all locally defined variables. This is an alias to `#local_variables`.
+
+[source,ruby]
+----
+binding.locals  # []
+
+a = 1
+b = 2
+
+binding.locals  # [:a, :b]
+----
+
 ==== Data
 
 ===== #diff
@@ -875,6 +935,55 @@ logger.any { "Test." }
 A, [2000-01-10T09:00:00.330719 #44925]   ANY -- : Test.
 ```
 
+==== Object
+
+===== #in?
+
+Allows you to know if `self` is included in, or an element of, the target object.
+
+[source,ruby]
+----
+1.in? [1, 2, 3]             # true
+9.in? [1, 2, 3]             # false
+
+"a".in? %w[a b c]           # true
+"z".in? %w[a b c]           # false
+
+:a.in? %i[a b c]            # true
+:z.in? %i[a b c]            # false
+
+:a.in? %i[a b c].to_enum    # true
+:z.in? %i[a b c].to_enum    # false
+
+:a.in?({a: 1, b: 2, c: 3})  # true
+:z.in?({a: 1, b: 2, c: 3})  # false
+
+1.in? 1..5                  # true
+9.in? 1..5                  # false
+
+1.in? Set[1, 2, 3]          # true
+9.in? Set[1, 2, 3]          # false
+
+"a".in? "abcde"             # true
+"z".in? "abcde"             # false
+
+"z".in? Object.new          # `String#include?` must be implemented. (NoMethodError)
+----
+
+===== #to_proc
+
+Allows you to cast any object to a proc.
+
+[source,ruby]
+----
+one = Class.new { def call = :test }
+           .new
+two = Object.new
+
+one.to_proc  # #<Proc:0x0000000124019580 (lambda)>
+two.to_proc  # `Object#call` must be implemented. (NoMethodError)
+----
+
 ==== Pathname
 
 ===== Pathname
@@ -1572,19 +1681,19 @@ An alias of `#merge` and identical in behavior (see `#merge` documentation for d
 
 ===== #call
 
-Enhances symbol-to-proc by allowing you to send additional arguments and/or a block. This only works
-with public methods in order to not break encapsulation.
+Enhances symbol-to-proc functionality by allowing you to send positional, keyword, and/or a block arguments. This only works with public methods in order to not break encapsulation.
 
 [source,ruby]
 ----
+
 %w[clue crow cow].map(&:tr.call("c", "b"))                              # ["blue", "brow", "bow"]
+[1.3, 1.5, 1.9].map(&:round.call(half: :up))                            # [1, 2, 2]
 [%w[a b c], %w[c a b]].map(&:index.call { |element| element == "b" })   # [1, 2]
-%w[1.outside 2.inside].map(&:sub.call(/\./) { |bullet| bullet + " " })  # ["1. outside", "2. inside"]
+%w[1.out 2.in].map(&:sub.call(/\./) { |bullet| bullet + " " })          # ["1. out", "2. in"]
 [1, 2, 3].map(&:to_s.call)                                              # ["1", "2", "3"]
 ----
 
-⚠️ Use of `#call` without any arguments or block should be avoided in order to not incur extra
-processing costs since the original symbol-to-proc call can be used instead.
+⚠️ Use of `#call` without any arguments should be avoided in order to not incur extra processing costs since the original symbol-to-proc call can be used instead.
 
 == Development
 

data/lib/refinements/array.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require "refinements/shared/enumerables/many"
+require "refinements/shared/many"
 
 module Refinements
   # Provides additional enhancements to the Array primitive.
   module Array
     refine ::Array do
-      import_methods Shared::Enumerables::Many
+      import_methods Shared::Many
 
       def combinatorial?(other) = !other.empty? && size == union(other).size
 

data/lib/refinements/binding.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Refinements
+  # Provides additional enhancements to the Binding class.
+  module Binding
+    refine ::Binding do
+      alias_method :[], :local_variable_get
+      alias_method :[]=, :local_variable_set
+      alias_method :local?, :local_variable_defined?
+      alias_method :locals, :local_variables
+    end
+  end
+end

data/lib/refinements/data.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require "refinements/shared/values/diff"
+require "refinements/shared/diff"
 
 module Refinements
   # Provides additional enhancements to the Struct primitive.
   module Data
     refine ::Data do
-      import_methods Shared::Values::Diff
+      import_methods Shared::Diff
     end
   end
 end

data/lib/refinements/hash.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "refinements/shared/enumerables/many"
+require "refinements/shared/many"
 
 module Refinements
   # Provides additional enhancements to the Hash primitive.
@@ -12,7 +12,7 @@ module Refinements
     end
 
     refine ::Hash do
-      import_methods Shared::Enumerables::Many
+      import_methods Shared::Many
 
       def compress = compact.delete_if { |_key, value| value.respond_to?(:empty?) && value.empty? }
 

data/lib/refinements/io.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "refinements/shared/ios/reread"
+require "refinements/shared/reread"
 
 module Refinements
   # Provides additional enhancements to the IO primitive.
@@ -17,7 +17,7 @@ module Refinements
     end
 
     refine ::IO do
-      import_methods Shared::IOs::Reread
+      import_methods Shared::Reread
 
       def redirect other
         return self unless block_given?

data/lib/refinements/object.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Refinements
+  # Provides additional enhancements to the Object class.
+  module Object
+    refine ::Object do
+      def in? other
+        case other
+          when Range then other.cover? self
+          when ::Array, Enumerable, ::Hash, Set, ::String then other.include? self
+          else fail NoMethodError, "`#{self.class}#include?` must be implemented."
+        end
+      end
+
+      def to_proc
+        return method(:call).to_proc if respond_to? :call
+
+        fail NoMethodError, "`#{self.class}#call` must be implemented."
+      end
+    end
+  end
+end

data/lib/refinements/shared/diff.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Refinements
+  module Shared
+    # Provides functionality for knowing the difference between two whole value objects.
+    module Diff
+      def diff other
+        if other.is_a? self.class
+          to_h.merge(other.to_h) { |_, one, two| [one, two].uniq }
+              .select { |_, diff| diff.size == 2 }
+        else
+          to_h.each.with_object({}) { |(key, value), diff| diff[key] = [value, nil] }
+        end
+      end
+    end
+  end
+end

data/lib/refinements/shared/many.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Refinements
+  module Shared
+    # Provides functionality for knowing whether an enumerable has many elements or not.
+    module Many
+      def many?
+        return size > 1 unless block_given?
+
+        total = reduce(0) { |count, item| yield(item) ? count + 1 : count }
+        total > 1
+      end
+    end
+  end
+end

data/lib/refinements/shared/reread.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Refinements
+  module Shared
+    # Provides functionality for I/O object rewinding.
+    module Reread
+      def reread(length = nil, buffer: nil) = tap(&:rewind).read(length, buffer)
+    end
+  end
+end

data/lib/refinements/string_io.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require "refinements/shared/ios/reread"
+require "refinements/shared/reread"
 require "stringio"
 
 module Refinements
   # Provides additional enhancements to the StringIO primitive.
   module StringIO
     refine ::StringIO do
-      import_methods Shared::IOs::Reread
+      import_methods Shared::Reread
     end
   end
 end

data/lib/refinements/struct.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "refinements/shared/values/diff"
+require "refinements/shared/diff"
 
 module Refinements
   # Provides additional enhancements to the Struct primitive.
@@ -10,7 +10,7 @@ module Refinements
     end
 
     refine ::Struct do
-      import_methods Shared::Values::Diff
+      import_methods Shared::Diff
 
       def merge(...) = dup.merge!(...)
 

data/lib/refinements/symbol.rb

@@ -4,8 +4,8 @@ module Refinements
   # Provides additional enhancements to the Symbol primitive.
   module Symbol
     refine ::Symbol do
-      def call(*arguments, &block)
-        proc { |receiver| receiver.public_send self, *arguments, &block }
+      def call(*positionals, **keywords, &block)
+        proc { |receiver| receiver.public_send self, *positionals, **keywords, &block }
       end
     end
   end

data/lib/refinements.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 require "refinements/array"
+require "refinements/binding"
 require "refinements/data"
 require "refinements/date_time"
 require "refinements/hash"
 require "refinements/io"
 require "refinements/log_device"
 require "refinements/logger"
+require "refinements/object"
 require "refinements/pathname"
 require "refinements/string"
 require "refinements/string_io"

data/refinements.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "refinements"
-  spec.version = "12.6.0"
+  spec.version = "12.7.1"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/refinements"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: refinements
 version: !ruby/object:Gem::Version
-  version: 12.6.0
+  version: 12.7.1
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2024-07-13 00:00:00.000000000 Z
+date: 2024-08-03 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -50,16 +50,18 @@ files:
 - README.adoc
 - lib/refinements.rb
 - lib/refinements/array.rb
+- lib/refinements/binding.rb
 - lib/refinements/data.rb
 - lib/refinements/date_time.rb
 - lib/refinements/hash.rb
 - lib/refinements/io.rb
 - lib/refinements/log_device.rb
 - lib/refinements/logger.rb
+- lib/refinements/object.rb
 - lib/refinements/pathname.rb
-- lib/refinements/shared/enumerables/many.rb
-- lib/refinements/shared/ios/reread.rb
-- lib/refinements/shared/values/diff.rb
+- lib/refinements/shared/diff.rb
+- lib/refinements/shared/many.rb
+- lib/refinements/shared/reread.rb
 - lib/refinements/string.rb
 - lib/refinements/string_io.rb
 - lib/refinements/struct.rb
@@ -91,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.15
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: A collection of core object refinements.

data/lib/refinements/shared/enumerables/many.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Refinements
-  module Shared
-    module Enumerables
-      # Provides shared functionality for knowing whether an enumerable has many elements or not.
-      module Many
-        def many?
-          return size > 1 unless block_given?
-
-          total = reduce(0) { |count, item| yield(item) ? count + 1 : count }
-          total > 1
-        end
-      end
-    end
-  end
-end

data/lib/refinements/shared/ios/reread.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Refinements
-  module Shared
-    module IOs
-      # Provides shared functionality for I/O object rewinding.
-      module Reread
-        def reread(length = nil, buffer: nil) = tap(&:rewind).read(length, buffer)
-      end
-    end
-  end
-end

data/lib/refinements/shared/values/diff.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Refinements
-  module Shared
-    module Values
-      # Provides shared whole value functionality for knowing the difference between two objects.
-      module Diff
-        def diff other
-          if other.is_a? self.class
-            to_h.merge(other.to_h) { |_, one, two| [one, two].uniq }
-                .select { |_, diff| diff.size == 2 }
-          else
-            to_h.each.with_object({}) { |(key, value), diff| diff[key] = [value, nil] }
-          end
-        end
-      end
-    end
-  end
-end