New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow ActiveRecord::Base.as_json to accept a frozen Hash #27945

Merged
merged 1 commit into from Feb 8, 2017

Conversation

Projects
None yet
6 participants
@betesh
Contributor

betesh commented Feb 8, 2017

Summary

ActiveRecord::Base.as_json takes an options Hash, which is cloned. The clone is then modified.
Since Object#clone preserves frozen state, a frozen Hash will not work here.

This commit resolves that by changing clone to dup, which does not preserve frozen state.

Other Information

There are many situations where one would want to pass a frozen Hash to as_json. I came across this issue when trying to create a default JSON representation:

class User < ApplicationRecord
  DEFAULT_JSON = { only: [:name, :email] }.freeze

  def as_json(options = nil)
    super(options.presence || DEFAULT_JSON)
  end
end

Doing this in a seemingly innocuous and correct way, I got this stack trace:

 RuntimeError:
   can't modify frozen Hash
# ~/.rvm/gems/ruby-2.3.0/gems/activerecord-5.0.1/lib/active_record/serialization.rb:14:in `serializable_hash'
# ~/.rvm/gems/ruby-2.3.0/gems/activemodel-5.0.1/lib/active_model/serializers/json.rb:99:in `as_json'
# ./app/models/user.rb:5:in `as_json'
@rails-bot

This comment has been minimized.

rails-bot commented Feb 8, 2017

Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @schneems (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

This repository is being automatically checked for code quality issues using Code Climate. You can see results for this analysis in the PR status below. Newly introduced issues should be fixed before a Pull Request is considered ready to review.

Please see the contribution instructions for more information.

@rafaelfranca

Could you add a CHANGELOG entry?

@dennisbaskin

This comment has been minimized.

dennisbaskin commented Feb 8, 2017

👍

@betesh

This comment has been minimized.

Contributor

betesh commented Feb 8, 2017

Changelog entry added

@rafaelfranca

Could you squash your commits please?

@betesh betesh force-pushed the betesh:allow-frozen-hashes-to-as_json branch Feb 8, 2017

@betesh

This comment has been minimized.

Contributor

betesh commented Feb 8, 2017

There's a Rubocop violation. Should I squash the fix?

@rafaelfranca

This comment has been minimized.

Member

rafaelfranca commented Feb 8, 2017

If it is in your changeset, yes.

@betesh

This comment has been minimized.

Contributor

betesh commented Feb 8, 2017

Yes, it's in my changeset. Sorry that wasn't clear. Done.

@betesh betesh force-pushed the betesh:allow-frozen-hashes-to-as_json branch to c01f31f Feb 8, 2017

@rafaelfranca

This comment has been minimized.

Member

rafaelfranca commented Feb 8, 2017

Backported in 0f338df.

rafaelfranca added a commit that referenced this pull request Feb 8, 2017

Merge pull request #27945 from betesh/allow-frozen-hashes-to-as_json
Allow ActiveRecord::Base.as_json to accept a frozen Hash

@rafaelfranca rafaelfranca merged commit c01f31f into rails:master Feb 8, 2017

2 checks passed

codeclimate no new or fixed issues
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

rafaelfranca added a commit that referenced this pull request Feb 8, 2017

Merge pull request #27945 from betesh/allow-frozen-hashes-to-as_json
Allow ActiveRecord::Base.as_json to accept a frozen Hash

@betesh betesh deleted the betesh:allow-frozen-hashes-to-as_json branch Mar 17, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment