CHANGELOG.md 11.3 KB
Newer Older
A
Andrew White 已提交
1 2 3 4 5 6 7 8 9 10 11
*   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*

12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
*   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*

39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
*   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*

66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
*   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*

93 94 95 96 97 98 99 100
*   `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*

101 102 103 104
*   Remove deprecated `halt_callback_chains_on_return_false` option.

    *Rafael Mendonça França*

105 106 107 108
*   Remove deprecated `:if` and `:unless` string filter for callbacks.

    *Rafael Mendonça França*

A
Akira Matsuda 已提交
109 110 111 112
*   `Hash#slice` now falls back to Ruby 2.5+'s built-in definition if defined.

    *Akira Matsuda*

113 114 115 116 117 118 119 120 121 122 123 124
*   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*

125 126 127 128
*   Return an instance of `HashWithIndifferentAccess` from `HashWithIndifferentAccess#transform_keys`.

    *Yuji Yaginuma*

129 130 131 132 133 134 135 136 137 138 139
*   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*

140 141 142 143
*   Deprecate `Module#reachable?` method.

    *bogdanvlviv*

144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
*   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*

163 164 165 166 167
*   `Module#delegate_missing_to` now raises `DelegationError` if target is nil,
    similar to `Module#delegate`.

    *Anton Khamets*

168
*   Update `String#camelize` to provide feedback when wrong option is passed
169

170
    `String#camelize` was returning nil without any feedback when an
J
Jon Moss 已提交
171
    invalid option was passed as a parameter.
172 173 174 175

    Previously:

        'one_two'.camelize(true)
R
Ryuta Kamizono 已提交
176
        # => nil
177 178 179 180

    Now:

        'one_two'.camelize(true)
R
Ryuta Kamizono 已提交
181
        # => ArgumentError: Invalid option, use either :upper or :lower.
182 183 184

    *Ricardo Díaz*

185 186
*   Fix modulo operations involving durations

J
Jon Moss 已提交
187 188 189
    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
190 191 192 193 194 195
    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 已提交
196
        # => 60
197 198 199 200

    Now:

        5.minutes % 2.minutes
R
Ryuta Kamizono 已提交
201
        # => 1 minute
202 203 204 205 206

    Fixes #29603 and #29743.

    *Sayan Chakraborty*, *Andrew White*

207 208 209 210 211 212 213 214 215 216
*   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*

217 218
*   Add purpose and expiry support to `ActiveSupport::MessageVerifier` &
   `ActiveSupport::MessageEncryptor`.
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238

    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 已提交
239 240 241 242
*   Make the order of `Hash#reverse_merge!` consistent with `HashWithIndifferentAccess`.

    *Erol Fornoles*

243
*   Add `freeze_time` helper which freezes time to `Time.now` in tests.
244

245
    *Prathamesh Sonpatki*
246

247
*   Default `ActiveSupport::MessageEncryptor` to use AES 256 GCM encryption.
248

249 250
    On for new Rails 5.2 apps. Upgrading apps can find the config as a new
    framework default.
251

252
    *Assain Jaleel*
253

J
Jeremy Daer 已提交
254
*   Cache: `write_multi`
255

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

J
Jeremy Daer 已提交
258 259 260
    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.
261

J
Jeremy Daer 已提交
262 263 264
    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`.
265

J
Jeremy Daer 已提交
266
    *Jeremy Daer*
267

268
*   Add default option to module and class attribute accessors.
269

270
        mattr_accessor :settings, default: {}
271

272 273
    Works for `mattr_reader`, `mattr_writer`, `cattr_accessor`, `cattr_reader`,
    and `cattr_writer` as well.
274

275
    *Genadi Samokovarov*
276

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

279
    *Shota Iguchi*
280

281
*   Add default option to `class_attribute`.
282 283 284

    Before:

J
Jon Moss 已提交
285 286
        class_attribute :settings
        self.settings = {}
A
Andrew White 已提交
287

288
    Now:
289

J
Jon Moss 已提交
290
        class_attribute :settings, default: {}
291

292
    *DHH*
293

294
*   `#singularize` and `#pluralize` now respect uncountables for the specified locale.
295

296
    *Eilis Hamilton*
297

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

301
    *DHH*
302

303
*   Fix implicit coercion calculations with scalars and durations
304

J
Jon Moss 已提交
305 306
    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:
307

308 309 310 311
        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
312

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

316 317 318 319
        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
320

321
    Fixes #29160, #28970.
A
Andrew White 已提交
322 323 324

    *Andrew White*

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

329
    *DHH*
A
Andrew White 已提交
330

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

333
    *Willem van Bergen*
A
Andrew White 已提交
334

335
*   Add support for `:offset` and `:zone` to `ActiveSupport::TimeWithZone#change`
A
Andrew White 已提交
336 337 338

    *Andrew White*

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

341
    Fixes #28723.
A
Andrew White 已提交
342 343 344

    *Andrew White*

345
*   Add `fetch_values` for `HashWithIndifferentAccess`
A
Andrew White 已提交
346

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

349
    *Josh Pencheon*
A
Andrew White 已提交
350

351

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