Fetching attributes of Class not logical

[thomaswitt]

Describe the feature

One would assume that getting all keys of a Model based on aws-record works via ClassName.attributes.keys. It actually is ClassName.attributes.attributes.keys:

>> Account.attributes.keys
`<main>': undefined method `keys' for an instance of Aws::Record::ModelAttributes (NoMethodError)
>> Account.attributes.attributes.keys
=>
[:hash_key,
[…]
>> Account.new.attributes
`<main>': undefined method `attributes' for an instance of Account (NoMethodError)

ClassName.attributes returns more of an internal data structure.

Use Case

To know the attributes of a Model.

Proposed Solution

Both methods should be supported e.g.:

• ClassName.new.attributes.keys
• ClassName.attributes.keys

If you want to make life easier for people who come from activerecord, you might also want to support the method attribute_names

Other Information

No response

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

aws-sdk-ruby-record version used

latest

Environment details (OS name and version, etc.)

latest

[alextwoods]

Thanks for submitting this - I do agree thats a little bit of a sharp edge. However, we can't change the behavior of the .attributes method without it being a breaking change.

We could instead add a .keys method to the ModelAttributes class to support ClassName.attributes.keys and add an #attributes instance method as well. We could also fairly easily add a .attribute_names method at the class/instance level.

[thomaswitt]

@alextwoods Maybe a bit of documentation also does the job. And adding .attribute_names would align it with other Rails standards and not break anything.

[github-actions]

This issue is now closed. Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.