CHANGELOG.md 6.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
*   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*

12 13 14 15
*   Deprecate `Module#reachable?` method.

    *bogdanvlviv*

16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
*   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*

35 36 37 38 39
*   `Module#delegate_missing_to` now raises `DelegationError` if target is nil,
    similar to `Module#delegate`.

    *Anton Khamets*

40
*   Update `String#camelize` to provide feedback when wrong option is passed
41

42
    `String#camelize` was returning nil without any feedback when an
J
Jon Moss 已提交
43
    invalid option was passed as a parameter.
44 45 46 47 48 49 50 51 52 53 54 55 56

    Previously:

        'one_two'.camelize(true)
        => nil

    Now:

        'one_two'.camelize(true)
        => ArgumentError: Invalid option, use either :upper or :lower.

    *Ricardo Díaz*

57 58
*   Fix modulo operations involving durations

J
Jon Moss 已提交
59 60 61
    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
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
    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
        => 60

    Now:

        5.minutes % 2.minutes
        => 1 minute

    Fixes #29603 and #29743.

    *Sayan Chakraborty*, *Andrew White*

79 80 81 82 83 84 85 86 87 88
*   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*

89 90
*   Add purpose and expiry support to `ActiveSupport::MessageVerifier` &
   `ActiveSupport::MessageEncryptor`.
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110

    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 已提交
111 112 113 114
*   Make the order of `Hash#reverse_merge!` consistent with `HashWithIndifferentAccess`.

    *Erol Fornoles*

115
*   Add `freeze_time` helper which freezes time to `Time.now` in tests.
116

117
    *Prathamesh Sonpatki*
118

119
*   Default `ActiveSupport::MessageEncryptor` to use AES 256 GCM encryption.
120

121 122
    On for new Rails 5.2 apps. Upgrading apps can find the config as a new
    framework default.
123

124
    *Assain Jaleel*
125

J
Jeremy Daer 已提交
126
*   Cache: `write_multi`
127

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

J
Jeremy Daer 已提交
130 131 132
    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.
133

J
Jeremy Daer 已提交
134 135 136
    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`.
137

J
Jeremy Daer 已提交
138
    *Jeremy Daer*
139

140
*   Add default option to module and class attribute accessors.
141

142
        mattr_accessor :settings, default: {}
143

144 145
    Works for `mattr_reader`, `mattr_writer`, `cattr_accessor`, `cattr_reader`,
    and `cattr_writer` as well.
146

147
    *Genadi Samokovarov*
148

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

151
    *Shota Iguchi*
152

153
*   Add default option to `class_attribute`.
154 155 156

    Before:

J
Jon Moss 已提交
157 158
        class_attribute :settings
        self.settings = {}
A
Andrew White 已提交
159

160
    Now:
161

J
Jon Moss 已提交
162
        class_attribute :settings, default: {}
163

164
    *DHH*
165

166
*   `#singularize` and `#pluralize` now respect uncountables for the specified locale.
167

168
    *Eilis Hamilton*
169

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

173
    *DHH*
174

175
*   Fix implicit coercion calculations with scalars and durations
176

J
Jon Moss 已提交
177 178
    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:
179

180 181 182 183
        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
184

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

188 189 190 191
        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
192

193
    Fixes #29160, #28970.
A
Andrew White 已提交
194 195 196

    *Andrew White*

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

201
    *DHH*
A
Andrew White 已提交
202

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

205
    *Willem van Bergen*
A
Andrew White 已提交
206

207
*   Add support for `:offset` and `:zone` to `ActiveSupport::TimeWithZone#change`
A
Andrew White 已提交
208 209 210

    *Andrew White*

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

213
    Fixes #28723.
A
Andrew White 已提交
214 215 216

    *Andrew White*

217
*   Add `fetch_values` for `HashWithIndifferentAccess`
A
Andrew White 已提交
218

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

221
    *Josh Pencheon*
A
Andrew White 已提交
222

223

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