attributor 6.2 → 6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82e7c7fa061464ff15336123c9809e743e2111da05c7155b2e20f6ece94196e3
-  data.tar.gz: 0cfdbaf2baa22792c3ccbaceffed7950131d9e2b4a7d67d5723e080e40e13873
+  metadata.gz: b30fd80bf80e1fba073207107cc6ee008d8f7f5edc3acd49863d58d27c9b2caa
+  data.tar.gz: 7549362dfe5fb7f1eb654ab7927996baee065f4b37cbdb74fcfb472189b8ea17
 SHA512:
-  metadata.gz: ccc3cc9e5ca7ae70b69501831559e616e5a631b7fe6b67b59c099399d7f1ee53479f657c5d951e0f20b84eb12e0a19643f8a83060e50684925652c25b5ec4527
-  data.tar.gz: e01d93ff03633e0a3361236fa2a76aa450880bd2f0594cbc2348da0daf9ecc7ec1c821d69fd4c020609a53e1ec4cac9886d84e9b4864c4def46f6a0c02174e69
+  metadata.gz: 46fb615c0952564d354ed67e9ed4e794bead86868111cf3a1447f1aab92e9a8106addca135673b59acb67f58dfdbbc5ed8a49d9f5f5cebdf5a2439719c495768
+  data.tar.gz: 726a29e1f6a30025f51a62dfb63fc8331e3202a3553f031ad776679ee7a525a7e689feb75ed184d0eb306b6bbe6b7c03605bb6b396fd5e234e0ddc1fa751b2e8

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## next
 
+## 6.3 (10/21/2022)
+- Added some small utility enhancements for dealing with attributes and types
+  * .duplicate an attribute, with a different inner type and/or options
+  * .slice a Hash/Model/Struct to reduce the number of keys that it holds
+  * .merge two Hash/Model/Struct keys into an existing one (even if the types differ)
+
 ## 6.2 (5/11/2022)
 - Added .to_hash for Model/Struct, which returns a symbolized key hash (without recursing). This allows to splat instances of Model/Structs into functions that have keyword arguments.
 

data/lib/attributor/attribute.rb

@@ -45,6 +45,13 @@ module Attributor
       check_options!
     end
 
+    def duplicate(type: nil, options: nil)
+      clone.tap do |cloned|
+        cloned.instance_variable_set(:@type, type) if type
+        cloned.instance_variable_set(:@options, options) if options
+      end
+    end
+
     def ==(other)
       raise ArgumentError, "can not compare Attribute with #{other.class.name}" unless other.is_a?(Attribute)
 

data/lib/attributor/types/hash.rb

@@ -41,6 +41,13 @@ module Attributor
     @error = false
     @requirements = []
 
+    def self.slice!(*keys)
+      missing_keys = keys - @keys.keys
+      raise AttributorException, "Cannot slice! this type, because it does not contain one or more of the requested keys: #{missing_keys}" unless missing_keys.empty?
+      instance_variable_set(:@keys, @keys.slice(*keys))
+      self
+    end
+
     def self.key_type=(key_type)
       @key_type = Attributor.resolve_type(key_type)
       @key_attribute = Attribute.new(@key_type)
@@ -461,6 +468,7 @@ module Attributor
       else
         hash[:value] = { type: value_type.describe(true) }
         hash[:example] = example if example
+        hash[:attributes] = {}
       end
 
       hash
@@ -567,7 +575,15 @@ module Attributor
       when self.class
         self.class.new(contents.merge(h.contents))
       when Attributor::Hash
-        raise ArgumentError, 'cannot merge Attributor::Hash instances of different types' unless h.is_a?(self.class)
+        source_key_type = self.class.key_type
+        source_value_type = self.class.value_type
+        # Allow merging hashes, but we'll need to coerce keys and/or values if they aren't the same type
+        coerced_contents = h.contents.each_with_object({}) do |(key, val), object|
+          k = (source_key_type && !k.is_a?(source_key_type)) ? source_key_type.load(key) : key
+          v = (source_value_type && !k.is_a?(source_value_type)) ? source_value_type.load(val) : val
+          object[k] = v
+        end
+        self.class.new(contents.merge(coerced_contents))
       else
         raise TypeError, "no implicit conversion of #{h.class} into Attributor::Hash"
       end

data/lib/attributor/version.rb

@@ -1,3 +1,3 @@
 module Attributor
-  VERSION = '6.2'.freeze
+  VERSION = '6.3'.freeze
 end

data/spec/types/hash_spec.rb

@@ -1189,16 +1189,15 @@ describe Attributor::Hash do
   end
 
   context '#merge' do
-    let(:hash_of_strings) { Attributor::Hash.of(key: String) }
-    let(:hash_of_symbols) { Attributor::Hash.of(key: Symbol) }
+    let(:hash_of_strings) { Attributor::Hash.of(key: String, value: Integer) }
+    let(:hash_of_symbols_and_string_vals) { Attributor::Hash.of(key: Symbol) }
 
     let(:merger) { hash_of_strings.load({'a' => 1},nil) }
     let(:good_mergee) { hash_of_strings.load({'b' => 2},nil) }
-    let(:bad_mergee) { hash_of_symbols.load({c: 3}) }
+    let(:different_hash_mergee) { hash_of_symbols_and_string_vals.load({c: '3'}) }
     let(:result) { hash_of_strings.load({'a' => 1, 'b' => 2},nil) }
 
     it 'validates that the mergee is of like type' do
-      expect { merger.merge(bad_mergee) }.to raise_error(ArgumentError)
       expect { merger.merge({}) }.to raise_error(TypeError)
       expect { merger.merge(nil) }.to raise_error(TypeError)
     end
@@ -1210,6 +1209,14 @@ describe Attributor::Hash do
     it 'merges' do
       expect(merger.merge(good_mergee)).to eq(result)
     end
+
+    it 'allows Hash merges, even if they come from different types, by coercing keys/values' do
+      merged = merger.merge(different_hash_mergee)
+      expect(merged).to be_a(hash_of_strings)
+      result = hash_of_strings.load({'a' => 1, 'c' => 3},nil)
+      # :c is coerced to 'c' and values are coerced to integers
+      expect(merged).to eq(result)
+    end
   end
 
   context Attributor::InvalidDefinition do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attributor
 version: !ruby/object:Gem::Version
-  version: '6.2'
+  version: '6.3'
 platform: ruby
 authors:
 - Josep M. Blanquer
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-11 00:00:00.000000000 Z
+date: 2022-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie