CHANGELOG.md 7.1 KB
Newer Older
1 2 3 4
*   Return an instance of `HashWithIndifferentAccess` from `HashWithIndifferentAccess#transform_keys`.

    *Yuji Yaginuma*

5 6 7 8 9 10 11 12 13 14 15
*   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*

16 17 18 19
*   Deprecate `Module#reachable?` method.

    *bogdanvlviv*

20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
*   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*

39 40 41 42 43
*   `Module#delegate_missing_to` now raises `DelegationError` if target is nil,
    similar to `Module#delegate`.

    *Anton Khamets*

44
*   Update `String#camelize` to provide feedback when wrong option is passed
45

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

    Previously:

        'one_two'.camelize(true)
        => nil

    Now:

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

    *Ricardo Díaz*

61 62
*   Fix modulo operations involving durations

J
Jon Moss 已提交
63 64 65
    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
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
    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*

83 84 85 86 87 88 89 90 91 92
*   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*

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

    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 已提交
115 116 117 118
*   Make the order of `Hash#reverse_merge!` consistent with `HashWithIndifferentAccess`.

    *Erol Fornoles*

119
*   Add `freeze_time` helper which freezes time to `Time.now` in tests.
120

121
    *Prathamesh Sonpatki*
122

123
*   Default `ActiveSupport::MessageEncryptor` to use AES 256 GCM encryption.
124

125 126
    On for new Rails 5.2 apps. Upgrading apps can find the config as a new
    framework default.
127

128
    *Assain Jaleel*
129

J
Jeremy Daer 已提交
130
*   Cache: `write_multi`
131

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

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

J
Jeremy Daer 已提交
138 139 140
    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`.
141

J
Jeremy Daer 已提交
142
    *Jeremy Daer*
143

144
*   Add default option to module and class attribute accessors.
145

146
        mattr_accessor :settings, default: {}
147

148 149
    Works for `mattr_reader`, `mattr_writer`, `cattr_accessor`, `cattr_reader`,
    and `cattr_writer` as well.
150

151
    *Genadi Samokovarov*
152

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

155
    *Shota Iguchi*
156

157
*   Add default option to `class_attribute`.
158 159 160

    Before:

J
Jon Moss 已提交
161 162
        class_attribute :settings
        self.settings = {}
A
Andrew White 已提交
163

164
    Now:
165

J
Jon Moss 已提交
166
        class_attribute :settings, default: {}
167

168
    *DHH*
169

170
*   `#singularize` and `#pluralize` now respect uncountables for the specified locale.
171

172
    *Eilis Hamilton*
173

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

177
    *DHH*
178

179
*   Fix implicit coercion calculations with scalars and durations
180

J
Jon Moss 已提交
181 182
    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:
183

184 185 186 187
        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
188

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

192 193 194 195
        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
196

197
    Fixes #29160, #28970.
A
Andrew White 已提交
198 199 200

    *Andrew White*

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

205
    *DHH*
A
Andrew White 已提交
206

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

209
    *Willem van Bergen*
A
Andrew White 已提交
210

211
*   Add support for `:offset` and `:zone` to `ActiveSupport::TimeWithZone#change`
A
Andrew White 已提交
212 213 214

    *Andrew White*

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

217
    Fixes #28723.
A
Andrew White 已提交
218 219 220

    *Andrew White*

221
*   Add `fetch_values` for `HashWithIndifferentAccess`
A
Andrew White 已提交
222

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

225
    *Josh Pencheon*
A
Andrew White 已提交
226

227

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