[RF DOCS] Active Model Basics Documentation [ci-skip]

[Ridhwana]

Motivation / Background

This Pull Request has been created to update the Active Model Basics Documentation.

Detail

This Pull Request adds the following two sections:

• AttributeAssignment
• Attributes

It updates the rest of the sections by trying to provide more information, be more clear, and include more examples. In some parts, it references the API where more information about the methods can be provided.

I also addressed these as part of the changes:

There's the new ActiveModel::API module that was essentially a split from ActiveModel::Model, this difference can be better explained in the guides as it is in the original PR.

The Lint Tests section example shows ActiveModel::Model, it should probably be ActiveModel::API.

It's possible to expand validations with how to check for errors, and other common usage. As well as different types of callback examples.

Some examples use send, those can be updated to use public_send instead.

Checklist

Before submitting the PR make sure the following are checked:

• This Pull Request is related to one change. Changes that are unrelated should be opened in separate PRs.
• Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: [Fix #issue-number]
• Tests are added or updated if you fix a bug or add a feature.
• CHANGELOG files are updated for the changed libraries if there is a behavior change or additional feature. Minor bug fixes and documentation changes should not be included.

[rafaelfranca]

As this isn't included in API, should not this be only mentioned later?

[carlosantoniodasilva]

They feel like individual sections that can live on their own, I'm not sure there's need to follow "API" with only the modules that it includes, since you can navigate up/down via the links/anchors under the API section to learn more about the individual ones?

[MatheusRich]

IMO, a beginner will likely read this in order, so I'd love if the most common things appeared first in the document.

[brunoprietog]

Great work!

What do you think about adding a small section on how to customize the url that will generate the ActionView helper related to that model? I have seen that need when you have the model in a namespace, something like Student::Application, but for some reason you need the path to simply point to application (/applications/..., etc).

I don't know if there is a more idiomatic way to do it than this:

class Student::Application
  include ActiveModel::Model
  
  ...

  def self.model_name
    ActiveModel::Name.new(self, nil, "Application")
  end
end

Or maybe it's something very specific.

[carlosantoniodasilva]

Really nice work @Ridhwana. I had some last minute bits of feedback on a final pass, let me know if you have any questions.