Skip to content
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

Serialization and Cache Documentation #1260

Merged
merged 3 commits into from
Oct 22, 2015

Conversation

bf4
Copy link
Member

@bf4 bf4 commented Oct 9, 2015

  • Document Serializer and FragmentCache

(other work extracted into #1271 #1272)

@bf4 bf4 changed the title Docuemntation, add public serializable PORO, fix digest failure. Documentation, add public serializable PORO, fix digest failure. Oct 9, 2015
@NullVoxPopuli
Copy link
Contributor

yay documentation! omg :-)

@beauby
Copy link
Contributor

beauby commented Oct 9, 2015

@bf4 Any specific reason not to break it into 3 PRs?

@bf4
Copy link
Member Author

bf4 commented Oct 9, 2015

No, just kept writing and sometimes more is harder to review.

B mobile phone

On Oct 9, 2015, at 7:46 AM, Lucas Hosseini notifications@github.com wrote:

@bf4 Any specific reason not to break it into 3 PRs?


Reply to this email directly or view it on GitHub.

@@ -127,6 +199,9 @@ def self.get_serializer_for(klass)
attr_accessor :object, :root, :scope
class_attribute :_type, instance_writer: false

# `scope_name` is set as :current_user by default in the controller.
# If the instance does not have a method nameed `scope_name`, it
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"nameed" -> "named"

class << self
attr_accessor :_attributes
attr_accessor :_attributes_keys
# Hashes contents of file for +_cache_digest+
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you elaborate (just for my personal understanding) on which practical situations the error is thrown?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry I didn't call this out better. I included it in the PR description for the change: #1176

@bf4 bf4 changed the title Documentation, add public serializable PORO, fix digest failure. Serialization and Cache Documentation Oct 15, 2015
end

serializer.class_attribute :_cache # @api private : the cache object
serializer.class_attribute :_fragmented # @api private :
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing description

@beauby
Copy link
Contributor

beauby commented Oct 19, 2015

A few minor comments but great work nonetheless.

@bf4
Copy link
Member Author

bf4 commented Oct 22, 2015

Look good?

@NullVoxPopuli
Copy link
Contributor

omg, yes.
a rebase and good to go :-)

bf4 added a commit that referenced this pull request Oct 22, 2015
Serialization and Cache Documentation
@bf4 bf4 merged commit 86fa7a9 into rails-api:master Oct 22, 2015
@bf4 bf4 deleted the serializer_cache_digest branch October 22, 2015 16:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants