CHANGELOG.md 15.2 KB
Newer Older
1
*   Changed default behaviour of `ActiveSupport::SecurityUtils.secure_compare`,
2
    to make it not leak length information even for variable length string.
3 4

    Renamed old `ActiveSupport::SecurityUtils.secure_compare` to `fixed_length_secure_compare`,
5 6 7
    and started raising `ArgumentError` in case of length mismatch of passed strings.

    *Vipul A M*
8

9 10 11 12 13 14 15
*   Make `ActiveSupport::TimeZone.all` return only time zones that are in
    `ActiveSupport::TimeZone::MAPPING`.

    Fixes #7245.

    *Chris LaRose*

16 17 18 19 20 21 22 23 24 25 26 27 28
*   MemCacheStore: Support expiring counters.

    Pass `expires_in: [seconds]` to `#increment` and `#decrement` options
    to set the Memcached TTL (time-to-live) if the counter doesn't exist.
    If the counter exists, Memcached doesn't extend its expiry when it's
    incremented or decremented.

    ```
    Rails.cache.increment("my_counter", 1, expires_in: 2.minutes)
    ```

    *Takumasa Ochi*

29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
*   Handle `TZInfo::AmbiguousTime` errors

    Make `ActiveSupport::TimeWithZone` match Ruby's handling of ambiguous
    times by choosing the later period, e.g.

    Ruby:
    ```
    ENV["TZ"] = "Europe/Moscow"
    Time.local(2014, 10, 26, 1, 0, 0)   # => 2014-10-26 01:00:00 +0300
    ```

    Before:
    ```
    >> "2014-10-26 01:00:00".in_time_zone("Moscow")
    TZInfo::AmbiguousTime: 26/10/2014 01:00 is an ambiguous local time.
    ```

    After:
    ```
    >> "2014-10-26 01:00:00".in_time_zone("Moscow")
    => Sun, 26 Oct 2014 01:00:00 MSK +03:00
    ```

    Fixes #17395.

    *Andrew White*

J
Jeremy Daer 已提交
56 57
*   Redis cache store.

58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
    ```
    # Defaults to `redis://localhost:6379/0`. Only use for dev/test.
    config.cache_store = :redis_cache_store

    # Supports all common cache store options (:namespace, :compress,
    # :compress_threshold, :expires_in, :race_condition_tool) and all
    # Redis options.
    cache_password = Rails.application.secrets.redis_cache_password
    config.cache_store = :redis_cache_store, driver: :hiredis,
      namespace: 'myapp-cache', compress: true, timeout: 1,
      url: "redis://:#{cache_password}@myapp-cache-1:6379/0"

    # Supports Redis::Distributed with multiple hosts
    config.cache_store = :redis_cache_store, driver: :hiredis
      namespace: 'myapp-cache', compress: true,
      url: %w[
        redis://myapp-cache-1:6379/0
        redis://myapp-cache-1:6380/0
        redis://myapp-cache-2:6379/0
        redis://myapp-cache-2:6380/0
        redis://myapp-cache-3:6379/0
        redis://myapp-cache-3:6380/0
      ]

    # Or pass a builder block
    config.cache_store = :redis_cache_store,
      namespace: 'myapp-cache', compress: true,
      redis: -> { Redis.new … }
    ```
J
Jeremy Daer 已提交
87 88 89 90 91 92 93 94 95

    Deployment note: Take care to use a *dedicated Redis cache* rather
    than pointing this at your existing Redis server. It won't cope well
    with mixed usage patterns and it won't expire cache entries by default.

    Redis cache server setup guide: https://redis.io/topics/lru-cache

    *Jeremy Daer*

96 97 98 99 100 101 102 103 104 105 106 107
*   Cache: Enable compression by default for values > 1kB.

    Compression has long been available, but opt-in and at a 16kB threshold.
    It wasn't enabled by default due to CPU cost. Today it's cheap and typical
    cache data is eminently compressible, such as HTML or JSON fragments.
    Compression dramatically reduces Memcached/Redis mem usage, which means
    the same cache servers can store more data, which means higher hit rates.

    To disable compression, pass `compress: false` to the initializer.

    *Jeremy Daer*

108 109 110 111 112 113 114 115
*   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 已提交
116

117
    Fixes #30799.
R
Ryuta Kamizono 已提交
118

119 120
    *Andrew White*

A
Andrew White 已提交
121 122 123 124 125 126 127 128 129 130 131
*   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*

132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
*   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*

159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
*   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*

186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
*   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*

213 214 215 216 217 218 219 220
*   `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*

221 222 223 224
*   Remove deprecated `halt_callback_chains_on_return_false` option.

    *Rafael Mendonça França*

225 226 227 228
*   Remove deprecated `:if` and `:unless` string filter for callbacks.

    *Rafael Mendonça França*

A
Akira Matsuda 已提交
229 230 231 232
*   `Hash#slice` now falls back to Ruby 2.5+'s built-in definition if defined.

    *Akira Matsuda*

233 234 235 236 237 238 239 240 241 242 243 244
*   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*

245 246 247 248
*   Return an instance of `HashWithIndifferentAccess` from `HashWithIndifferentAccess#transform_keys`.

    *Yuji Yaginuma*

249 250 251 252 253 254 255 256 257 258 259
*   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*

260 261 262 263
*   Deprecate `Module#reachable?` method.

    *bogdanvlviv*

264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
*   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*

283 284 285 286 287
*   `Module#delegate_missing_to` now raises `DelegationError` if target is nil,
    similar to `Module#delegate`.

    *Anton Khamets*

288
*   Update `String#camelize` to provide feedback when wrong option is passed
289

290
    `String#camelize` was returning nil without any feedback when an
J
Jon Moss 已提交
291
    invalid option was passed as a parameter.
292 293 294 295

    Previously:

        'one_two'.camelize(true)
R
Ryuta Kamizono 已提交
296
        # => nil
297 298 299 300

    Now:

        'one_two'.camelize(true)
R
Ryuta Kamizono 已提交
301
        # => ArgumentError: Invalid option, use either :upper or :lower.
302 303 304

    *Ricardo Díaz*

305 306
*   Fix modulo operations involving durations

J
Jon Moss 已提交
307 308 309
    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
310 311 312 313 314 315
    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 已提交
316
        # => 60
317 318 319 320

    Now:

        5.minutes % 2.minutes
R
Ryuta Kamizono 已提交
321
        # => 1 minute
322 323 324 325 326

    Fixes #29603 and #29743.

    *Sayan Chakraborty*, *Andrew White*

327 328 329 330 331 332 333 334 335 336
*   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*

337 338
*   Add purpose and expiry support to `ActiveSupport::MessageVerifier` &
   `ActiveSupport::MessageEncryptor`.
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358

    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 已提交
359 360 361 362
*   Make the order of `Hash#reverse_merge!` consistent with `HashWithIndifferentAccess`.

    *Erol Fornoles*

363
*   Add `freeze_time` helper which freezes time to `Time.now` in tests.
364

365
    *Prathamesh Sonpatki*
366

367
*   Default `ActiveSupport::MessageEncryptor` to use AES 256 GCM encryption.
368

369 370
    On for new Rails 5.2 apps. Upgrading apps can find the config as a new
    framework default.
371

372
    *Assain Jaleel*
373

J
Jeremy Daer 已提交
374
*   Cache: `write_multi`
375

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

J
Jeremy Daer 已提交
378 379 380
    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.
381

J
Jeremy Daer 已提交
382 383 384
    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`.
385

J
Jeremy Daer 已提交
386
    *Jeremy Daer*
387

388
*   Add default option to module and class attribute accessors.
389

390
        mattr_accessor :settings, default: {}
391

392 393
    Works for `mattr_reader`, `mattr_writer`, `cattr_accessor`, `cattr_reader`,
    and `cattr_writer` as well.
394

395
    *Genadi Samokovarov*
396

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

399
    *Shota Iguchi*
400

401
*   Add default option to `class_attribute`.
402 403 404

    Before:

J
Jon Moss 已提交
405 406
        class_attribute :settings
        self.settings = {}
A
Andrew White 已提交
407

408
    Now:
409

J
Jon Moss 已提交
410
        class_attribute :settings, default: {}
411

412
    *DHH*
413

414
*   `#singularize` and `#pluralize` now respect uncountables for the specified locale.
415

416
    *Eilis Hamilton*
417

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

421
    *DHH*
422

423
*   Fix implicit coercion calculations with scalars and durations
424

J
Jon Moss 已提交
425 426
    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:
427

428 429 430 431
        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
432

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

436 437 438 439
        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
440

441
    Fixes #29160, #28970.
A
Andrew White 已提交
442 443 444

    *Andrew White*

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

449
    *DHH*
A
Andrew White 已提交
450

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

453
    *Willem van Bergen*
A
Andrew White 已提交
454

455
*   Add support for `:offset` and `:zone` to `ActiveSupport::TimeWithZone#change`
A
Andrew White 已提交
456 457 458

    *Andrew White*

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

461
    Fixes #28723.
A
Andrew White 已提交
462 463 464

    *Andrew White*

465
*   Add `fetch_values` for `HashWithIndifferentAccess`
A
Andrew White 已提交
466

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

469
    *Josh Pencheon*
A
Andrew White 已提交
470

471

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