CHANGELOG.md 11.8 KB
Newer Older
1 2 3 4 5 6 7 8
*   Allow `Range#include?` on TWZ ranges

    In #11474 we prevented TWZ ranges being iterated over which matched
    Ruby's handling of Time ranges and as a consequence `include?`
    stopped working with both Time ranges and TWZ ranges. However in
    ruby/ruby@b061634 support was added for `include?` to use `cover?`
    for 'linear' objects. Since we have no way of making Ruby consider
    TWZ instances as 'linear' we have to override `Range#include?`.
R
Ryuta Kamizono 已提交
9

10
    Fixes #30799.
R
Ryuta Kamizono 已提交
11

12 13
    *Andrew White*

A
Andrew White 已提交
14 15 16 17 18 19 20 21 22 23 24
*   Fix acronym support in `humanize`

    Acronym inflections are stored with lowercase keys in the hash but
    the match wasn't being lowercased before being looked up in the hash.
    This shouldn't have any performance impact because before it would
    fail to find the acronym and perform the `downcase` operation anyway.

    Fixes #31052.

    *Andrew White*

25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
*   Add same method signature for `Time#prev_year` and `Time#next_year`
    in accordance with `Date#prev_year`, `Date#next_year`.

    Allows pass argument for `Time#prev_year` and `Time#next_year`.

    Before:
    ```
    Time.new(2017, 9, 16, 17, 0).prev_year    # => 2016-09-16 17:00:00 +0300
    Time.new(2017, 9, 16, 17, 0).prev_year(1)
    # => ArgumentError: wrong number of arguments (given 1, expected 0)

    Time.new(2017, 9, 16, 17, 0).next_year    # => 2018-09-16 17:00:00 +0300
    Time.new(2017, 9, 16, 17, 0).next_year(1)
    # => ArgumentError: wrong number of arguments (given 1, expected 0)
    ```

    After:
    ```
    Time.new(2017, 9, 16, 17, 0).prev_year    # => 2016-09-16 17:00:00 +0300
    Time.new(2017, 9, 16, 17, 0).prev_year(1) # => 2016-09-16 17:00:00 +0300

    Time.new(2017, 9, 16, 17, 0).next_year    # => 2018-09-16 17:00:00 +0300
    Time.new(2017, 9, 16, 17, 0).next_year(1) # => 2018-09-16 17:00:00 +0300
    ```

    *bogdanvlviv*

52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
*   Add same method signature for `Time#prev_month` and `Time#next_month`
    in accordance with `Date#prev_month`, `Date#next_month`.

    Allows pass argument for `Time#prev_month` and `Time#next_month`.

    Before:
    ```
    Time.new(2017, 9, 16, 17, 0).prev_month    # => 2017-08-16 17:00:00 +0300
    Time.new(2017, 9, 16, 17, 0).prev_month(1)
    # => ArgumentError: wrong number of arguments (given 1, expected 0)

    Time.new(2017, 9, 16, 17, 0).next_month    # => 2017-10-16 17:00:00 +0300
    Time.new(2017, 9, 16, 17, 0).next_month(1)
    # => ArgumentError: wrong number of arguments (given 1, expected 0)
    ```

    After:
    ```
    Time.new(2017, 9, 16, 17, 0).prev_month    # => 2017-08-16 17:00:00 +0300
    Time.new(2017, 9, 16, 17, 0).prev_month(1) # => 2017-08-16 17:00:00 +0300

    Time.new(2017, 9, 16, 17, 0).next_month    # => 2017-10-16 17:00:00 +0300
    Time.new(2017, 9, 16, 17, 0).next_month(1) # => 2017-10-16 17:00:00 +0300
    ```

    *bogdanvlviv*

79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
*   Add same method signature for `Time#prev_day` and `Time#next_day`
    in accordance with `Date#prev_day`, `Date#next_day`.

    Allows pass argument for `Time#prev_day` and `Time#next_day`.

    Before:
    ```
    Time.new(2017, 9, 16, 17, 0).prev_day    # => 2017-09-15 17:00:00 +0300
    Time.new(2017, 9, 16, 17, 0).prev_day(1)
    # => ArgumentError: wrong number of arguments (given 1, expected 0)

    Time.new(2017, 9, 16, 17, 0).next_day    # => 2017-09-17 17:00:00 +0300
    Time.new(2017, 9, 16, 17, 0).next_day(1)
    # => ArgumentError: wrong number of arguments (given 1, expected 0)
    ```

    After:
    ```
    Time.new(2017, 9, 16, 17, 0).prev_day    # => 2017-09-15 17:00:00 +0300
    Time.new(2017, 9, 16, 17, 0).prev_day(1) # => 2017-09-15 17:00:00 +0300

    Time.new(2017, 9, 16, 17, 0).next_day    # => 2017-09-17 17:00:00 +0300
    Time.new(2017, 9, 16, 17, 0).next_day(1) # => 2017-09-17 17:00:00 +0300
    ```

    *bogdanvlviv*

106 107 108 109 110 111 112 113
*   `IO#to_json` now returns the `to_s` representation, rather than
    attempting to convert to an array. This fixes a bug where `IO#to_json`
    would raise an `IOError` when called on an unreadable object.

    Fixes #26132.

    *Paul Kuruvilla*

114 115 116 117
*   Remove deprecated `halt_callback_chains_on_return_false` option.

    *Rafael Mendonça França*

118 119 120 121
*   Remove deprecated `:if` and `:unless` string filter for callbacks.

    *Rafael Mendonça França*

A
Akira Matsuda 已提交
122 123 124 125
*   `Hash#slice` now falls back to Ruby 2.5+'s built-in definition if defined.

    *Akira Matsuda*

126 127 128 129 130 131 132 133 134 135 136 137
*   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*

138 139 140 141
*   Return an instance of `HashWithIndifferentAccess` from `HashWithIndifferentAccess#transform_keys`.

    *Yuji Yaginuma*

142 143 144 145 146 147 148 149 150 151 152
*   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*

153 154 155 156
*   Deprecate `Module#reachable?` method.

    *bogdanvlviv*

157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
*   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*

176 177 178 179 180
*   `Module#delegate_missing_to` now raises `DelegationError` if target is nil,
    similar to `Module#delegate`.

    *Anton Khamets*

181
*   Update `String#camelize` to provide feedback when wrong option is passed
182

183
    `String#camelize` was returning nil without any feedback when an
J
Jon Moss 已提交
184
    invalid option was passed as a parameter.
185 186 187 188

    Previously:

        'one_two'.camelize(true)
R
Ryuta Kamizono 已提交
189
        # => nil
190 191 192 193

    Now:

        'one_two'.camelize(true)
R
Ryuta Kamizono 已提交
194
        # => ArgumentError: Invalid option, use either :upper or :lower.
195 196 197

    *Ricardo Díaz*

198 199
*   Fix modulo operations involving durations

J
Jon Moss 已提交
200 201 202
    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
203 204 205 206 207 208
    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 已提交
209
        # => 60
210 211 212 213

    Now:

        5.minutes % 2.minutes
R
Ryuta Kamizono 已提交
214
        # => 1 minute
215 216 217 218 219

    Fixes #29603 and #29743.

    *Sayan Chakraborty*, *Andrew White*

220 221 222 223 224 225 226 227 228 229
*   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*

230 231
*   Add purpose and expiry support to `ActiveSupport::MessageVerifier` &
   `ActiveSupport::MessageEncryptor`.
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251

    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 已提交
252 253 254 255
*   Make the order of `Hash#reverse_merge!` consistent with `HashWithIndifferentAccess`.

    *Erol Fornoles*

256
*   Add `freeze_time` helper which freezes time to `Time.now` in tests.
257

258
    *Prathamesh Sonpatki*
259

260
*   Default `ActiveSupport::MessageEncryptor` to use AES 256 GCM encryption.
261

262 263
    On for new Rails 5.2 apps. Upgrading apps can find the config as a new
    framework default.
264

265
    *Assain Jaleel*
266

J
Jeremy Daer 已提交
267
*   Cache: `write_multi`
268

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

J
Jeremy Daer 已提交
271 272 273
    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.
274

J
Jeremy Daer 已提交
275 276 277
    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`.
278

J
Jeremy Daer 已提交
279
    *Jeremy Daer*
280

281
*   Add default option to module and class attribute accessors.
282

283
        mattr_accessor :settings, default: {}
284

285 286
    Works for `mattr_reader`, `mattr_writer`, `cattr_accessor`, `cattr_reader`,
    and `cattr_writer` as well.
287

288
    *Genadi Samokovarov*
289

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

292
    *Shota Iguchi*
293

294
*   Add default option to `class_attribute`.
295 296 297

    Before:

J
Jon Moss 已提交
298 299
        class_attribute :settings
        self.settings = {}
A
Andrew White 已提交
300

301
    Now:
302

J
Jon Moss 已提交
303
        class_attribute :settings, default: {}
304

305
    *DHH*
306

307
*   `#singularize` and `#pluralize` now respect uncountables for the specified locale.
308

309
    *Eilis Hamilton*
310

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

314
    *DHH*
315

316
*   Fix implicit coercion calculations with scalars and durations
317

J
Jon Moss 已提交
318 319
    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:
320

321 322 323 324
        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
325

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

329 330 331 332
        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
333

334
    Fixes #29160, #28970.
A
Andrew White 已提交
335 336 337

    *Andrew White*

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

342
    *DHH*
A
Andrew White 已提交
343

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

346
    *Willem van Bergen*
A
Andrew White 已提交
347

348
*   Add support for `:offset` and `:zone` to `ActiveSupport::TimeWithZone#change`
A
Andrew White 已提交
349 350 351

    *Andrew White*

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

354
    Fixes #28723.
A
Andrew White 已提交
355 356 357

    *Andrew White*

358
*   Add `fetch_values` for `HashWithIndifferentAccess`
A
Andrew White 已提交
359

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

362
    *Josh Pencheon*
A
Andrew White 已提交
363

364

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