CHANGELOG.md 7.7 KB
Newer Older
A
Akira Matsuda 已提交
1 2 3 4
*   `Hash#slice` now falls back to Ruby 2.5+'s built-in definition if defined.

    *Akira Matsuda*

5 6 7 8 9 10 11 12 13 14 15 16
*   Deprecate `secrets.secret_token`.

    The architecture for secrets had a big upgrade between Rails 3 and Rails 4,
    when the default changed from using `secret_token` to `secret_key_base`.

    `secret_token` has been soft deprecated in documentation for four years
    but is still in place to support apps created before Rails 4.
    Deprecation warnings have been added to help developers upgrade their
    applications to `secret_key_base`.

    *claudiob*, *Kasper Timm Hansen*

17 18 19 20
*   Return an instance of `HashWithIndifferentAccess` from `HashWithIndifferentAccess#transform_keys`.

    *Yuji Yaginuma*

21 22 23 24 25 26 27 28 29 30 31
*   Add key rotation support to `MessageEncryptor` and `MessageVerifier`

    This change introduces a `rotate` method to both the `MessageEncryptor` and
    `MessageVerifier` classes. This method accepts the same arguments and
    options as the given classes' constructor. The `encrypt_and_verify` method
    for `MessageEncryptor` and the `verified` method for `MessageVerifier` also
    accept an optional keyword argument `:on_rotation` block which is called
    when a rotated instance is used to decrypt or verify the message.

    *Michael J Coyne*

32 33 34 35
*   Deprecate `Module#reachable?` method.

    *bogdanvlviv*

36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
*   Add `config/credentials.yml.enc` to store production app secrets.

    Allows saving any authentication credentials for third party services
    directly in repo encrypted with `config/master.key` or `ENV["RAILS_MASTER_KEY"]`.

    This will eventually replace `Rails.application.secrets` and the encrypted
    secrets introduced in Rails 5.1.

    *DHH*, *Kasper Timm Hansen*

*   Add `ActiveSupport::EncryptedFile` and `ActiveSupport::EncryptedConfiguration`.

    Allows for stashing encrypted files or configuration directly in repo by
    encrypting it with a key.

    Backs the new credentials setup above, but can also be used independently.

    *DHH*, *Kasper Timm Hansen*

55 56 57 58 59
*   `Module#delegate_missing_to` now raises `DelegationError` if target is nil,
    similar to `Module#delegate`.

    *Anton Khamets*

60
*   Update `String#camelize` to provide feedback when wrong option is passed
61

62
    `String#camelize` was returning nil without any feedback when an
J
Jon Moss 已提交
63
    invalid option was passed as a parameter.
64 65 66 67

    Previously:

        'one_two'.camelize(true)
R
Ryuta Kamizono 已提交
68
        # => nil
69 70 71 72

    Now:

        'one_two'.camelize(true)
R
Ryuta Kamizono 已提交
73
        # => ArgumentError: Invalid option, use either :upper or :lower.
74 75 76

    *Ricardo Díaz*

77 78
*   Fix modulo operations involving durations

J
Jon Moss 已提交
79 80 81
    Rails 5.1 introduced `ActiveSupport::Duration::Scalar` as a wrapper
    around numeric values as a way of ensuring a duration was the outcome of
    an expression. However, the implementation was missing support for modulo
82 83 84 85 86 87
    operations. This support has now been added and should result in a duration
    being returned from expressions involving modulo operations.

    Prior to Rails 5.1:

        5.minutes % 2.minutes
R
Ryuta Kamizono 已提交
88
        # => 60
89 90 91 92

    Now:

        5.minutes % 2.minutes
R
Ryuta Kamizono 已提交
93
        # => 1 minute
94 95 96 97 98

    Fixes #29603 and #29743.

    *Sayan Chakraborty*, *Andrew White*

99 100 101 102 103 104 105 106 107 108
*   Fix division where a duration is the denominator

    PR #29163 introduced a change in behavior when a duration was the denominator
    in a calculation - this was incorrect as dividing by a duration should always
    return a `Numeric`. The behavior of previous versions of Rails has been restored.

    Fixes #29592.

    *Andrew White*

109 110
*   Add purpose and expiry support to `ActiveSupport::MessageVerifier` &
   `ActiveSupport::MessageEncryptor`.
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130

    For instance, to ensure a message is only usable for one intended purpose:

        token = @verifier.generate("x", purpose: :shipping)

        @verifier.verified(token, purpose: :shipping) # => "x"
        @verifier.verified(token)                     # => nil

    Or make it expire after a set time:

        @verifier.generate("x", expires_in: 1.month)
        @verifier.generate("y", expires_at: Time.now.end_of_year)

    Showcased with `ActiveSupport::MessageVerifier`, but works the same for
    `ActiveSupport::MessageEncryptor`'s `encrypt_and_sign` and `decrypt_and_verify`.

    Pull requests: #29599, #29854

    *Assain Jaleel*

E
Erol Fornoles 已提交
131 132 133 134
*   Make the order of `Hash#reverse_merge!` consistent with `HashWithIndifferentAccess`.

    *Erol Fornoles*

135
*   Add `freeze_time` helper which freezes time to `Time.now` in tests.
136

137
    *Prathamesh Sonpatki*
138

139
*   Default `ActiveSupport::MessageEncryptor` to use AES 256 GCM encryption.
140

141 142
    On for new Rails 5.2 apps. Upgrading apps can find the config as a new
    framework default.
143

144
    *Assain Jaleel*
145

J
Jeremy Daer 已提交
146
*   Cache: `write_multi`
147

J
Jeremy Daer 已提交
148
        Rails.cache.write_multi foo: 'bar', baz: 'qux'
149

J
Jeremy Daer 已提交
150 151 152
    Plus faster fetch_multi with stores that implement `write_multi_entries`.
    Keys that aren't found may be written to the cache store in one shot
    instead of separate writes.
153

J
Jeremy Daer 已提交
154 155 156
    The default implementation simply calls `write_entry` for each entry.
    Stores may override if they're capable of one-shot bulk writes, like
    Redis `MSET`.
157

J
Jeremy Daer 已提交
158
    *Jeremy Daer*
159

160
*   Add default option to module and class attribute accessors.
161

162
        mattr_accessor :settings, default: {}
163

164 165
    Works for `mattr_reader`, `mattr_writer`, `cattr_accessor`, `cattr_reader`,
    and `cattr_writer` as well.
166

167
    *Genadi Samokovarov*
168

169
*   Add `Date#prev_occurring` and `Date#next_occurring` to return specified next/previous occurring day of week.
170

171
    *Shota Iguchi*
172

173
*   Add default option to `class_attribute`.
174 175 176

    Before:

J
Jon Moss 已提交
177 178
        class_attribute :settings
        self.settings = {}
A
Andrew White 已提交
179

180
    Now:
181

J
Jon Moss 已提交
182
        class_attribute :settings, default: {}
183

184
    *DHH*
185

186
*   `#singularize` and `#pluralize` now respect uncountables for the specified locale.
187

188
    *Eilis Hamilton*
189

J
Jon Moss 已提交
190
*   Add `ActiveSupport::CurrentAttributes` to provide a thread-isolated attributes singleton.
191
    Primary use case is keeping all the per-request attributes easily available to the whole system.
192

193
    *DHH*
194

195
*   Fix implicit coercion calculations with scalars and durations
196

J
Jon Moss 已提交
197 198
    Previously, calculations where the scalar is first would be converted to a duration
    of seconds, but this causes issues with dates being converted to times, e.g:
199

200 201 202 203
        Time.zone = "Beijing"           # => Asia/Shanghai
        date = Date.civil(2017, 5, 20)  # => Mon, 20 May 2017
        2 * 1.day                       # => 172800 seconds
        date + 2 * 1.day                # => Mon, 22 May 2017 00:00:00 CST +08:00
204

J
Jon Moss 已提交
205
    Now, the `ActiveSupport::Duration::Scalar` calculation methods will try to maintain
206
    the part structure of the duration where possible, e.g:
207

208 209 210 211
        Time.zone = "Beijing"           # => Asia/Shanghai
        date = Date.civil(2017, 5, 20)  # => Mon, 20 May 2017
        2 * 1.day                       # => 2 days
        date + 2 * 1.day                # => Mon, 22 May 2017
212

213
    Fixes #29160, #28970.
A
Andrew White 已提交
214 215 216

    *Andrew White*

217
*   Add support for versioned cache entries. This enables the cache stores to recycle cache keys, greatly saving
R
Ryuta Kamizono 已提交
218
    on storage in cases with frequent churn. Works together with the separation of `#cache_key` and `#cache_version`
219
    in Active Record and its use in Action Pack's fragment caching.
A
Andrew White 已提交
220

221
    *DHH*
A
Andrew White 已提交
222

223
*   Pass gem name and deprecation horizon to deprecation notifications.
A
Andrew White 已提交
224

225
    *Willem van Bergen*
A
Andrew White 已提交
226

227
*   Add support for `:offset` and `:zone` to `ActiveSupport::TimeWithZone#change`
A
Andrew White 已提交
228 229 230

    *Andrew White*

231
*   Add support for `:offset` to `Time#change`
A
Andrew White 已提交
232

233
    Fixes #28723.
A
Andrew White 已提交
234 235 236

    *Andrew White*

237
*   Add `fetch_values` for `HashWithIndifferentAccess`
A
Andrew White 已提交
238

239
    The method was originally added to `Hash` in Ruby 2.3.0.
A
Andrew White 已提交
240

241
    *Josh Pencheon*
A
Andrew White 已提交
242

243

244
Please check [5-1-stable](https://github.com/rails/rails/blob/5-1-stable/activesupport/CHANGELOG.md) for previous changes.