attributor 6.1 → 6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a27077cb0a67b6ab8fdde19c88a993ba648c6deb38d5a83766df49b7199338d
-  data.tar.gz: 99bf9996744d757817fd167fa510b462fab6ee1dd3b52992594d06768966bd53
+  metadata.gz: 82e7c7fa061464ff15336123c9809e743e2111da05c7155b2e20f6ece94196e3
+  data.tar.gz: 0cfdbaf2baa22792c3ccbaceffed7950131d9e2b4a7d67d5723e080e40e13873
 SHA512:
-  metadata.gz: e91ad1a7759be0e56c66f53bafbe6d22f1a2ce724fc777ade2649987d6bf19d184eb0fc5f43d00dcbf2310bbae72359199f34d25c38aa65cc69f38cc28d33a55
-  data.tar.gz: 947764564827d2d05e967f60ccc100d42eedf219fddab8ffff56bb8f61c0264c67e9bdd77d3a3585b99d80e5e54f22ef2a6e3424c3ba83549df0932874b0c0af
+  metadata.gz: ccc3cc9e5ca7ae70b69501831559e616e5a631b7fe6b67b59c099399d7f1ee53479f657c5d951e0f20b84eb12e0a19643f8a83060e50684925652c25b5ec4527
+  data.tar.gz: e01d93ff03633e0a3361236fa2a76aa450880bd2f0594cbc2348da0daf9ecc7ec1c821d69fd4c020609a53e1ec4cac9886d84e9b4864c4def46f6a0c02174e69

data/CHANGELOG.md

@@ -1,7 +1,9 @@
 # Attributor Changelog
 
 ## next
-- added support for enum's out of values in json_schema generation
+
+## 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/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.2'.freeze
 end

data/spec/support/objects.rb

@@ -0,0 +1,2 @@
+class UntypedObject < Attributor::Object
+end

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.2'
 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-05-11 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