The following was added to the `ActiveJob::Callbacks`,
`ActiveModel::Callbacks` and `AbstractController:Callbacks` docs
in #29072:
> NOTE: Calling the same callback multiple times will overwrite
> previous callback definitions.
The comment refers to "calling" callbacks but seems to be about defining
callbacks, as mentioned in the PR description.
In the ActiveJob and AbstractController docs, I believe this will be
misinterpreted as referring to setting callbacks, which, as far as I can
tell, does not have such a restriction.
In the ActiveModel docs, I believe it would be slightly clearer to
replace "calling" with "defining".
The Rails documentation uses the `:include:` directive to inline the
README of the framework into the main documentation page. As the
README's aren't in the root directory from where SDoc is run we need to
add the framework path to the include:
# :include: activesupport/README.md
This results in a warning when installing the gems as generating the rdoc for the gem is run from the gem/framework root:
Couldn't find file to include 'activesupport/README.rdoc' from lib/active_support.rb
The `:include:` RDoc directive supports includes relative to the current
file as well:
# :include: ../README.md
This makes sure it works for the Rails API docs and the separate gems.
Co-authored-by: Jonathan Hefner <jonathan@hefner.pro>
When the TZ in the given string contains minus offset, both hour and minute
value has to be negated, but the current code negates hour only.
Hence, for instance in Newfoundland Time Zone (UTC−03:30), it used to return
1 hour advanced value.
Co-authored-by: Nobuyoshi Nakada <nobu@ruby-lang.org>
`ActiveModel::AttributeRegistration` is marked `:nodoc:`, so
`type_for_attribute` must be documented under `ActiveModel::Attributes`,
which includes `ActiveModel::AttributeRegistration`.
Also, RDoc does not correctly interpret `:method:` docs when they are
immediately followed by a visibility keyword. Therefore, this commit
adds delimiter comments before the keywords, similar to
4726b1ab47.
Now that we dropped support for Ruby 2.7, we no longer
need to check if variables are defined before accessing them
to avoid the undefined variable warning.
Now that we no longer support Ruby 2.7, many `ruby2_keyword` calls
can be eliminated.
The ones that are left could be eliminated but would end up substantially
slower or more compliacated so I left them for now.
Until now, Rails only droped compatibility with older
rubies on new majors, but I propose to change this policy
because it causes us to either keep compatibility with long
EOLed rubies or to bump the Rails major more often, and to
drop multiple Ruby versions at once when we bump the major.
In my opinion it's a bad alignments of incentives. And we'd
be much better to just drop support in new minors whenever they
go EOL (so 3 years).
Also Ruby being an upstream dependency, it's not even
a semver violation AFAICT.
Since Rails 7.2 isn't planned before a few months, we
can already drop Ruby 3.0 as it will be EOL in March.
Follow-up to #49995.
Prior to this commit, `link:classes/...` URLs were used in `README.rdoc`
files so that the URLs would be versioned when rendered at
api.rubyonrails.org. However, outside of api.rubyonrails.org, such URLs
aren't properly resolved.
Since rails/sdoc#345, `https://api.rubyonrails.org/classes/...` URLs
will also be versioned when rendered at api.rubyonrails.org, and such
URLs are properly resolved everywhere. Therefore, this commit converts
`link:classes/...` URLs to that form.
This commit ports `ActiveRecord::AttributeMethods::BeforeTypeCast` to
`ActiveModel::BeforeTypeCast` and includes it in `ActiveModel::Attributes`.
Thus, classes that include `ActiveModel::Attributes` will now
automatically define methods such as `*_before_type_cast`, just as
Active Record models do.
The `ActiveRecord::AttributeMethods::BeforeTypeCast` module is kept for
backward compatibility, but it now merely includes
`ActiveModel::BeforeTypeCast`.
Co-authored-by: Petrik <petrik@deheus.net>
This moves `type_for_attribute` from `ActiveRecord::ModelSchema::ClassMethods`
to `ActiveModel::AttributeRegistration::ClassMethods`, where
`attribute_types` is also defined.
Co-authored-by: Petrik <petrik@deheus.net>
Kernel#respond_to? is generally slow, and so it should be avoided
especially in hot loops. In this case, assign_attributes ends up calling
respond_to? for each attribute being assigned. The purpose of the check
here is to raise UnknownAttributeError when the attribute setter method
doesn't exist.
This commit moves the respond_to? inside a rescue. For a single
attribute being assigned, the performance is about the same. However,
the performance is ~10% better for 10 attributes being assigned and
~30% better for 100 attributes. There is a tradeoff here since using
rescue for control flow is generally not good for performance, however
in this case the ~10% decrease in performance only applies to the
exceptional case when attempting to assign an unknown attribute.
This also partially reverts a225d4bec5.
The commit message doesn't have much info so it's unclear to me why this
was changed.
Benchmark:
```
require "active_record"
require "benchmark/ips"
require "logger"
ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
ActiveRecord::Base.logger = Logger.new(STDOUT)
ActiveRecord::Schema.define do
create_table :posts, force: true do |t|
100.times do |i|
t.text :"body_#{i}"
end
end
end
class Post < ActiveRecord::Base
end
one_attribute = { "body_1" => "1" }
ten_attributes = {}
hundered_attributes = {}
invalid_attribute = { "body__1" => "1" }
100.times do |i|
ten_attributes["body_#{i}"] = i.to_s if i < 11
hundered_attributes["body_#{i}"] = i.to_s
end
Benchmark.ips do |x|
x.report("1 attribute") { Post.new(one_attribute) }
x.report("10 attribute") { Post.new(ten_attributes) }
x.report("100 attribute") { Post.new(hundered_attributes) }
x.report("invalid attribute") do
Post.new(invalid_attribute)
rescue ActiveModel::UnknownAttributeError
end
end
```
Before:
```
Warming up --------------------------------------
1 attribute 1.090k i/100ms
10 attribute 805.000 i/100ms
100 attribute 251.000 i/100ms
invalid attribute 966.000 i/100ms
Calculating -------------------------------------
1 attribute 10.882k (± 1.3%) i/s - 54.500k in 5.009085s
10 attribute 8.070k (± 1.2%) i/s - 41.055k in 5.088110s
100 attribute 2.548k (± 1.6%) i/s - 12.801k in 5.026321s
invalid attribute 9.687k (± 2.5%) i/s - 49.266k in 5.089246s
```
After:
```
Warming up --------------------------------------
1 attribute 1.098k i/100ms
10 attribute 884.000 i/100ms
100 attribute 341.000 i/100ms
invalid attribute 868.000 i/100ms
Calculating -------------------------------------
1 attribute 11.004k (± 1.1%) i/s - 55.998k in 5.089635s
10 attribute 8.817k (± 1.8%) i/s - 44.200k in 5.014699s
100 attribute 3.410k (± 0.4%) i/s - 17.391k in 5.100166s
invalid attribute 8.695k (± 0.9%) i/s - 44.268k in 5.091846s
```
Follow-up to #46282.
The purpose of the optimization from #46282 is to avoid unnecessary
`deserialize` / `cast` / `serialize` calls associated with invoking
`value_for_database` on an attribute that has not changed. `dup`ing the
attribute accomplishes that, but `dup`ing the attribute's value is not
appropriate for some value types. For example, a value of the type
`ActiveModel::Type::ImmutableString` requires `clone` instead of `dup`,
and a value of the type `ActiveRecord::Type::Json` likely requires
`deep_dup`. In some cases the only appropriate method may be
`deserialize(serialize(value))`, such as when a serializer for the type
`ActiveRecord::Type::Serialized` deserializes `ActiveRecord::Base`
instances. (In that case, `dup`ing the value would clear its `id`, and
`clone`ing the value would only produce a shallow copy.) However,
`deserialize(serialize(value))` is expensive and would defeat the
purpose of the optimization.
Instead of `dup`ing the attribute, this commit changes the optimization
to use `with_value_from_database(value_before_type_cast)`, which
parallels `with_value_from_database(value_for_database)` in the base
implementation. This drops the (cast) value entirely, causing a fresh
copy to be deserialized if the attribute is subsequently read. In cases
where the attribute is _not_ subsequently read, this will actually be
more efficient since no extra work is performed. And in cases where the
attribute _is_ subsequently read, it will still be more efficient than
`deserialize(serialize(value))`.
Fixes#49809.
For better or worse, the Rails guide settled on double quotes
and a large part of the community also use rubocop which enforce
them by default.
So we might as well try to follow that style when providing code
snippets in the documentation or error messages.
Fix: https://github.com/rails/rails/issues/49822
I certainly didn't get them all, but consistency should be significantly
improved.
This refactors the `ActiveRecord::Attributes` module to use
`ActiveModel::AttributeRegistration`. This also replaces the block form
of the `attribute` method (which was support by only Active Record) with
`decorate_attributes` (which is supported by both Active Model and
Active Record). The block form of the `attribute` method was a private
API, so no deprecation is necessary.
This adds a `decorate_attributes` method to Active Model to support
attribute type decoration. `decorate_attributes` is a private,
low-level API that is intended to be wrapped by high-level APIs like
`ActiveRecord::Base::normalizes` and `ActiveRecord::Base::enum`.
This change would force a lot of existing applications and libraries
to update their tests.
We included it in the beta to collect feedback from the community and
we had some comments about how negative this change would be.
Developers that care about the typography of their error messages
can easily change it in their applications using the translation
files, so there is no need to inflict pain in the upgrade process
by changing the default in the framework.
Revert "Merge PR #45463"
This reverts commit 9f60cd8dc7, reversing
changes made to 35d574dbfd.
There are assertions that expected/actual arguments are passed in the
reversed order by mistake. Enabling the LiteralAsActualArgument rule
prevents this mistake from happening.
The existing tests were auto-corrected by rubocop with a bit of
indentation adjustment.
Co-authored-by: Jonathan Hefner <jonathan@hefner.pro>
Rafael Mendonça França