CHANGELOG.md 9.0 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
*   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*

28 29 30 31 32 33 34 35
*   `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*

36 37 38 39
*   Remove deprecated `halt_callback_chains_on_return_false` option.

    *Rafael Mendonça França*

40 41 42 43
*   Remove deprecated `:if` and `:unless` string filter for callbacks.

    *Rafael Mendonça França*

A
Akira Matsuda 已提交
44 45 46 47
*   `Hash#slice` now falls back to Ruby 2.5+'s built-in definition if defined.

    *Akira Matsuda*

48 49 50 51 52 53 54 55 56 57 58 59
*   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*

60 61 62 63
*   Return an instance of `HashWithIndifferentAccess` from `HashWithIndifferentAccess#transform_keys`.

    *Yuji Yaginuma*

64 65 66 67 68 69 70 71 72 73 74
*   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*

75 76 77 78
*   Deprecate `Module#reachable?` method.

    *bogdanvlviv*

79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
*   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*

98 99 100 101 102
*   `Module#delegate_missing_to` now raises `DelegationError` if target is nil,
    similar to `Module#delegate`.

    *Anton Khamets*

103
*   Update `String#camelize` to provide feedback when wrong option is passed
104

105
    `String#camelize` was returning nil without any feedback when an
J
Jon Moss 已提交
106
    invalid option was passed as a parameter.
107 108 109 110

    Previously:

        'one_two'.camelize(true)
R
Ryuta Kamizono 已提交
111
        # => nil
112 113 114 115

    Now:

        'one_two'.camelize(true)
R
Ryuta Kamizono 已提交
116
        # => ArgumentError: Invalid option, use either :upper or :lower.
117 118 119

    *Ricardo Díaz*

120 121
*   Fix modulo operations involving durations

J
Jon Moss 已提交
122 123 124
    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
125 126 127 128 129 130
    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 已提交
131
        # => 60
132 133 134 135

    Now:

        5.minutes % 2.minutes
R
Ryuta Kamizono 已提交
136
        # => 1 minute
137 138 139 140 141

    Fixes #29603 and #29743.

    *Sayan Chakraborty*, *Andrew White*

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

152 153
*   Add purpose and expiry support to `ActiveSupport::MessageVerifier` &
   `ActiveSupport::MessageEncryptor`.
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173

    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 已提交
174 175 176 177
*   Make the order of `Hash#reverse_merge!` consistent with `HashWithIndifferentAccess`.

    *Erol Fornoles*

178
*   Add `freeze_time` helper which freezes time to `Time.now` in tests.
179

180
    *Prathamesh Sonpatki*
181

182
*   Default `ActiveSupport::MessageEncryptor` to use AES 256 GCM encryption.
183

184 185
    On for new Rails 5.2 apps. Upgrading apps can find the config as a new
    framework default.
186

187
    *Assain Jaleel*
188

J
Jeremy Daer 已提交
189
*   Cache: `write_multi`
190

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

J
Jeremy Daer 已提交
193 194 195
    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.
196

J
Jeremy Daer 已提交
197 198 199
    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`.
200

J
Jeremy Daer 已提交
201
    *Jeremy Daer*
202

203
*   Add default option to module and class attribute accessors.
204

205
        mattr_accessor :settings, default: {}
206

207 208
    Works for `mattr_reader`, `mattr_writer`, `cattr_accessor`, `cattr_reader`,
    and `cattr_writer` as well.
209

210
    *Genadi Samokovarov*
211

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

214
    *Shota Iguchi*
215

216
*   Add default option to `class_attribute`.
217 218 219

    Before:

J
Jon Moss 已提交
220 221
        class_attribute :settings
        self.settings = {}
A
Andrew White 已提交
222

223
    Now:
224

J
Jon Moss 已提交
225
        class_attribute :settings, default: {}
226

227
    *DHH*
228

229
*   `#singularize` and `#pluralize` now respect uncountables for the specified locale.
230

231
    *Eilis Hamilton*
232

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

236
    *DHH*
237

238
*   Fix implicit coercion calculations with scalars and durations
239

J
Jon Moss 已提交
240 241
    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:
242

243 244 245 246
        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
247

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

251 252 253 254
        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
255

256
    Fixes #29160, #28970.
A
Andrew White 已提交
257 258 259

    *Andrew White*

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

264
    *DHH*
A
Andrew White 已提交
265

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

268
    *Willem van Bergen*
A
Andrew White 已提交
269

270
*   Add support for `:offset` and `:zone` to `ActiveSupport::TimeWithZone#change`
A
Andrew White 已提交
271 272 273

    *Andrew White*

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

276
    Fixes #28723.
A
Andrew White 已提交
277 278 279

    *Andrew White*

280
*   Add `fetch_values` for `HashWithIndifferentAccess`
A
Andrew White 已提交
281

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

284
    *Josh Pencheon*
A
Andrew White 已提交
285

286

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