refinements 12.5.0 → 12.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4820c08dee6ea3a2f4a521ebe6ee9cfd778879b35f997c1cb9a82c4c4f56eb67
-  data.tar.gz: 15b35014f7462130864f3b35c7aab5908bd2bef21b75d25be70ec456b5065e38
+  metadata.gz: d95a713a69dbbeaec7c6c2f76c634f576d763e86d32b1f46bad9817ac6eacd70
+  data.tar.gz: 5d972fa9193dab8743c5ed1aa7980a9b11be3b34e951f885377d25742d791eb1
 SHA512:
-  metadata.gz: 53b1fda6b7ca55389d305c8e99d5a095405d50490cefe246ea77a56ea0daee8f46237afa3bafced988ef65e3b6f4f095dbf9e038e9aaafe55fdc6e67288ed89c
-  data.tar.gz: 882417652e5925b6c9c8d1a24ed8f756dae15f6b5a65692e159ccc147fb686cf530ada3c5b93f33a98afc5a3ef852c7e9ef34db6d07680910ac7bfd93ca30ea8
+  metadata.gz: cec359f8d82a7e98889f2913e8330857d15f9d7a99ae0024e3895b6b4ec61c7a6c6a17897fb19b3ae1f10224d02be2affca6c81093d7965c6acfdb58d0b5c535
+  data.tar.gz: b967aed2a285c8ca49b5ef6a54f830721a19ccdc7521ac7857bedcec849b781e7b6a357b770c4f99cd47fe4197f2f0b2cbecd149e89096cd4193c841a64dc623

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
@@ -1564,6 +1673,10 @@ a.transmute! c, c: :t                # #<struct Struct::A a=1, b=2, c=30>
 a                                    # #<struct Struct::A a=7, b=8, c=30>
 ----
 
+===== #with
+
+An alias of `#merge` and identical in behavior (see `#merge` documentation for details). Allows you to use `Struct` and `Data` objects more interchangeably since they share the same method.
+
 ==== Symbol
 
 ===== #call

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!(...)
 
@@ -38,6 +38,8 @@ module Refinements
         mapping = key_map.invert
         merge! object.to_h.slice(*mapping.keys).transform_keys!(mapping)
       end
+
+      alias_method :with, :merge
     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.5.0"
+  spec.version = "12.7.0"
   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.5.0
+  version: 12.7.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2024-06-22 00:00:00.000000000 Z
+date: 2024-07-15 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.14
+rubygems_version: 3.5.15
 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