attributor 6.1 → 6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a27077cb0a67b6ab8fdde19c88a993ba648c6deb38d5a83766df49b7199338d
-  data.tar.gz: 99bf9996744d757817fd167fa510b462fab6ee1dd3b52992594d06768966bd53
+  metadata.gz: b30fd80bf80e1fba073207107cc6ee008d8f7f5edc3acd49863d58d27c9b2caa
+  data.tar.gz: 7549362dfe5fb7f1eb654ab7927996baee065f4b37cbdb74fcfb472189b8ea17
 SHA512:
-  metadata.gz: e91ad1a7759be0e56c66f53bafbe6d22f1a2ce724fc777ade2649987d6bf19d184eb0fc5f43d00dcbf2310bbae72359199f34d25c38aa65cc69f38cc28d33a55
-  data.tar.gz: 947764564827d2d05e967f60ccc100d42eedf219fddab8ffff56bb8f61c0264c67e9bdd77d3a3585b99d80e5e54f22ef2a6e3424c3ba83549df0932874b0c0af
+  metadata.gz: 46fb615c0952564d354ed67e9ed4e794bead86868111cf3a1447f1aab92e9a8106addca135673b59acb67f58dfdbbc5ed8a49d9f5f5cebdf5a2439719c495768
+  data.tar.gz: 726a29e1f6a30025f51a62dfb63fc8331e3202a3553f031ad776679ee7a525a7e689feb75ed184d0eb306b6bbe6b7c03605bb6b396fd5e234e0ddc1fa751b2e8

data/CHANGELOG.md

@@ -1,7 +1,15 @@
 # Attributor Changelog
 
 ## next
-- added support for enum's out of values in json_schema generation
+
+## 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.
 
 ## 6.1 (1/7/2022)
 - added support for enum's out of values in json_schema generation

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/types/model.rb

@@ -179,6 +179,11 @@ module Attributor
     ensure
       @dumping = false
     end
+
+    # This allows the splatting of these instances into method calls (top level hash conversion only)
+    def to_hash
+      @contents
+    end
   end
 
   # Override the generic way to get a value from an instance (models need to call the method)

data/lib/attributor/types/object.rb

@@ -13,10 +13,20 @@ module Attributor
     def self.example(_context = nil, options: {})
       'An Object'
     end
-        
+
+    # Not really used (we override as_json_schema to represent this as an Any Type),
+    # but if it _were_ used, this would be accurate.
     def self.json_schema_type
-      :object #FIXME: not sure this is the most appropriate, since an Attributor::Object can be anything
+      :object
     end
 
+    # Represents Object as an OpenAPI Any Type.
+    #
+    # @see https://swagger.io/docs/specification/data-models/data-types/#any
+    def self.as_json_schema(**kwargs)
+      schema = super(**kwargs)
+      schema.delete(:type)
+      schema
+    end
   end
 end

data/lib/attributor/version.rb

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

data/spec/support/objects.rb

@@ -0,0 +1,2 @@
+class UntypedObject < Attributor::Object
+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

data/spec/types/model_spec.rb

@@ -523,4 +523,26 @@ describe Attributor::Model do
       expect(example.dump).to eq({})
     end
   end
+
+  context '#to_hash' do
+    let(:model_type) do
+      Class.new(Attributor::Model) do
+        attributes do
+          attribute :name, String
+          attribute :subkey do
+            attribute :id, Integer
+          end
+        end
+      end
+    end
+
+    subject { model_type.new(name: 'Praxis', subkey: { id: 1 }).to_hash }
+    it 'returns the top keys as a hash' do
+      expect(subject.keys).to eq([:name, :subkey])
+    end
+    it 'does not recurse down' do
+      expect(subject[:subkey]).to be_kind_of Attributor::Struct
+    end
+  end
+
 end

data/spec/types/object_spec.rb

@@ -0,0 +1,14 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper.rb')
+
+describe Attributor::Object do
+  context 'JSON Schema representation' do
+    subject { UntypedObject.as_json_schema }
+    it 'is an Any Type' do
+      # "A schema without a type matches any data type – numbers, strings, objects, and so on."
+      # c.f. https://swagger.io/docs/specification/data-models/data-types/#any
+      expect(subject).not_to have_key(:type)
+      # but we still preserve Ruby type name, if anyone is curious
+      expect(subject[:"x-type_name"]).to eq("UntypedObject")
+    end
+  end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: attributor
 version: !ruby/object:Gem::Version
-  version: '6.1'
+  version: '6.3'
 platform: ruby
 authors:
 - Josep M. Blanquer
 - Dane Jensen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-07 00:00:00.000000000 Z
+date: 2022-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -291,7 +291,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - blanquer@gmail.com
 - dane.jensen@gmail.com
@@ -361,6 +361,7 @@ files:
 - spec/support/hashes.rb
 - spec/support/integers.rb
 - spec/support/models.rb
+- spec/support/objects.rb
 - spec/support/polymorphics.rb
 - spec/type_spec.rb
 - spec/types/bigdecimal_spec.rb
@@ -377,6 +378,7 @@ files:
 - spec/types/ids_spec.rb
 - spec/types/integer_spec.rb
 - spec/types/model_spec.rb
+- spec/types/object_spec.rb
 - spec/types/polymorphic_spec.rb
 - spec/types/regexp_spec.rb
 - spec/types/string_spec.rb
@@ -390,7 +392,7 @@ homepage: https://github.com/rightscale/attributor
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -406,7 +408,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A powerful attribute and type management library for Ruby
 test_files:
@@ -422,6 +424,7 @@ test_files:
 - spec/support/hashes.rb
 - spec/support/integers.rb
 - spec/support/models.rb
+- spec/support/objects.rb
 - spec/support/polymorphics.rb
 - spec/type_spec.rb
 - spec/types/bigdecimal_spec.rb
@@ -438,6 +441,7 @@ test_files:
 - spec/types/ids_spec.rb
 - spec/types/integer_spec.rb
 - spec/types/model_spec.rb
+- spec/types/object_spec.rb
 - spec/types/polymorphic_spec.rb
 - spec/types/regexp_spec.rb
 - spec/types/string_spec.rb