refinements 7.17.0 → 7.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a24d8f2e7c34e994169a0c99ee15bfd30a8ed20d3aed61b567190d76c82cb23c
-  data.tar.gz: cbf64daa1b7e41296ccb4ed1dd3e288fa958fc7a1df64f5661464c5d350cea3f
+  metadata.gz: 5dd9bd6cbc9800c0c66d8c1ae4ed93124143f196a4173723438bb7d9fc12957e
+  data.tar.gz: 9d6651c258900528aa68db2a8b26e1bd77aef9be70fe3fbeadf63e4c0580ab45
 SHA512:
-  metadata.gz: 73e908dc60bb232b21f8a5a670a42d803d8a69cf74034be74a65885761868f139db5e61362c4de33d08f0541d2716880e3b20f6772ddb6445c1ff545459fffec
-  data.tar.gz: 3843e65221606fc7671e2bf8696086de50be0561b2cde91f7e3d6e5b5ebdf604f018f2cb6bf132723ef68fa7079cfcdbf7dbae070574fb6e5f3144629f0a967d
+  metadata.gz: bad8de30ca4c07607013a08d8346d1390b3f6223b943588ac94ce1c7e44fb5f59ebb634c9adb4d0f1773929ede430ffc7025fa9e6fcdca6f055d3bfa4c5cbeb8
+  data.tar.gz: d81030c3b1a8db17fff6cafea12496041d2cb95e87452cf932c7cf03c60dea4971f1bbce59c30fde5b5a8d80f713b5a00fca1cbcbba6bbb1962f77e21984f9b0

data/README.adoc

@@ -171,6 +171,18 @@ Answers mean/average all elements within an array.
 [1.25, 1.5, 1.75].mean  # => 1.5
 ----
 
+===== #pad
+
+Answers new array padded with given value up to a maximum size. Useful in situations where an array
+needs to be a specific size with padded values.
+
+[source,ruby]
+----
+[1].pad 0             # => [1]
+[1].pad 0, max: 3     # => [1, 0, 0]
+[1, 2].pad 3, max: 3  # => [1, 2, 3]
+----
+
 ===== #ring
 
 Answers a circular array which can enumerate before, current, after elements.
@@ -924,6 +936,50 @@ buffer                     # => "This is a test."
 
 ==== Struct
 
+===== .keyworded?
+
+Answers whether a struct was constructed with keyword or positional arguments.
+
+[source,ruby]
+----
+Struct.new(:a, keyword_init: true).keyworded?  # => true
+Struct.new(:a).keyworded?                      # => false
+----
+
+===== .with_keywords
+
+Answers a struct instance with given keyword arguments regardless of
+whether the struct was constructed with positional or keyword arguments.
+
+[source,ruby]
+----
+Example = Struct.new :a, :b, :c
+Example.with_keywords a: 1, b: 2, c: 3  # => #<struct a=1, b=2, c=3>
+Example.with_keywords a: 1              # => #<struct a=1, b=nil, c=nil>
+Example.with_keywords c: 1              # => #<struct a=nil, b=nil, c=1>
+
+Example = Struct.new :a, :b, :c, keyword_init: true
+Example.with_keywords a: 1, b: 2, c: 3  # => #<struct a=1, b=2, c=3>
+Example.with_keywords a: 1              # => #<struct a=1, b=nil, c=nil>
+Example.with_keywords c: 1              # => #<struct a=nil, b=nil, c=1>
+----
+
+===== .with_positions
+
+Answers a struct instance with given positional arguments regardless of
+whether the struct was constructed with positional or keyword arguments.
+
+[source,ruby]
+----
+Example = Struct.new :a, :b, :c
+Example.with_positions 1, 2, 3  # => #<struct a=1, b=2, c=3>
+Example.with_positions 1        # => #<struct a=1, b=nil, c=nil>
+
+Example = Struct.new :a, :b, :c, keyword_init: true
+Example.with_positions 1, 2, 3  # => #<struct a=1, b=2, c=3>
+Example.with_positions 1        # => #<struct a=1, b=nil, c=nil>
+----
+
 ===== #merge
 
 Merges multiple attributes without mutating itself.
@@ -966,6 +1022,53 @@ example.merge! a: 10, b: 20, c: 30  # => #<struct a=10, b=20, c=30>
 example                             # => #<struct a=10, b=20, c=30>
 ----
 
+===== #revalue
+
+Transforms values without mutating itself. An optional hash can be supplied to pinpoint and
+transform specific attributes. In the event that a block isn't supplied, the struct will answer
+itself since there is nothing to operate on. Behavior is the same regardless of whether the struct
+is constructed using positional or keyword arguments. A positional struct is used in the examples
+below but a keyword struct would work too.
+
+[source,ruby]
+----
+Example = Struct.new :a, :b, :c
+
+example = Example[1, 2, 3]
+example.revalue { |value| value * 2 }                             # => #<struct a=2, b=4, c=6>
+example.revalue(c: 2) { |previous, current| previous + current }  # => #<struct a=1, b=2, c=5>
+example.revalue c: 2                                              # => #<struct a=1, b=2, c=3>
+example.revalue                                                   # => #<struct a=1, b=2, c=3>
+example                                                           # => #<struct a=1, b=2, c=3>
+
+----
+
+===== #revalue!
+
+Transforms values while mutating itself. An optional hash can be supplied to pinpoint and transform
+specific attributes. In the event that a block isn't supplied, the struct will answer itself since
+there is nothing to operate on. Behavior is the same regardless of whether the struct is constructed
+using positional or keyword arguments. A positional struct is used in the examples below but a
+keyword struct would work too.
+
+[source,ruby]
+----
+Example = Struct.new :a, :b, :c
+
+example = Example[1, 2, 3]
+example.revalue! { |value| value * 2 }                             # => #<struct a=2, b=4, c=6>
+example                                                            # => #<struct a=2, b=4, c=6>
+
+example = Example[1, 2, 3]
+example.revalue!(c: 2) { |previous, current| previous + current }  # => #<struct a=1, b=2, c=5>
+example                                                            # => #<struct a=1, b=2, c=5>
+
+example = Example[1, 2, 3]
+example.revalue! c: 2                                              # => #<struct a=1, b=2, c=3>
+example.revalue!                                                   # => #<struct a=1, b=2, c=3>
+example                                                            # => #<struct a=1, b=2, c=3>
+----
+
 == Development
 
 To contribute, run:

data/lib/refinements/arrays.rb

@@ -37,6 +37,10 @@ module Refinements
         size.zero? ? 0 : sum(0) / size
       end
 
+      def pad value, max: size
+        dup.fill value, size..(max - 1)
+      end
+
       def ring &block
         [last, *self, first].each_cons 3, &block
       end

data/lib/refinements/identity.rb

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

data/lib/refinements/structs.rb

@@ -2,6 +2,20 @@
 
 module Refinements
   module Structs
+    refine Struct.singleton_class do
+      def keyworded?
+        inspect.include? "keyword_init: true"
+      end
+
+      def with_keywords arguments
+        keyworded? ? new(arguments) : new.merge!(arguments)
+      end
+
+      def with_positions *values
+        keyworded? ? new(Hash[members.zip values]) : new(*values)
+      end
+    end
+
     refine Struct do
       def merge **attributes
         dup.merge! attributes
@@ -11,6 +25,21 @@ module Refinements
         to_h.merge(attributes).each { |key, value| self[key] = value }
         self
       end
+
+      def revalue attributes = each_pair
+        return self unless block_given?
+
+        dup.tap do |copy|
+          attributes.each { |key, value| copy[key] = yield self[key], value }
+        end
+      end
+
+      def revalue! attributes = each_pair
+        return self unless block_given?
+
+        attributes.each { |key, value| self[key] = yield self[key], value }
+        self
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: refinements
 version: !ruby/object:Gem::Version
-  version: 7.17.0
+  version: 7.18.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   2XV8FRa7/JimI07sPLC13eLY3xd/aYTi85Z782KIA4j0G8XEEWAX0ouBhlXPocZv
   QWc=
   -----END CERTIFICATE-----
-date: 2020-12-13 00:00:00.000000000 Z
+date: 2020-12-21 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0
+rubygems_version: 3.2.2
 signing_key:
 specification_version: 4
 summary: A collection of refinements to core Ruby objects.