CHANGELOG.md 9.1 KB
Newer Older
1 2 3
*   Add a bang version to `ActiveSupport::OrderedOptions` get methods which will raise
    an `KeyError` if the value is `.blank?`

4 5 6
    Before:

        if (slack_url = Rails.application.secrets.slack_url).present?)
7
          # Do something worthwhile
8
        else
9
          # Raise as important secret password is not specified
10 11 12 13 14 15 16 17
        end

    After:

        slack_url = Rails.application.secrets.slack_url!

    *Aditya Sanghi*, *Gaurish Sharma*

18 19
*   Remove deprecated `Class#superclass_delegating_accessor`.
    Use `Class#class_attribute` instead.
20 21 22

    *Akshay Vishnoi*

23
*   Patch `Delegator` to work with `#try`.
24

25
    Fixes #5790.
26 27 28

    *Nate Smith*

29 30 31 32
*   Add `Integer#positive?` and `Integer#negative?` query methods
    in the vein of `Fixnum#zero?`.

    This makes it nicer to do things like `bunch_of_numbers.select(&:positive?)`.
33 34 35

    *DHH*

36
*   Encoding `ActiveSupport::TimeWithZone` to YAML now preserves the timezone information.
37 38 39 40 41

    Fixes #9183.

    *Andrew White*

42 43 44 45 46
*   Added `ActiveSupport::TimeZone#strptime` to allow parsing times as if
    from a given timezone.

    *Paul A Jungwirth*

47 48 49 50 51
*   `ActiveSupport::Callbacks#skip_callback` now raises an `ArgumentError` if
    an unrecognized callback is removed.

    *Iain Beeston*

52
*   Added `ActiveSupport::ArrayInquirer` and `Array#inquiry`.
53 54 55 56 57 58 59 60 61 62 63 64 65 66

    Wrapping an array in an `ArrayInquirer` gives a friendlier way to check its
    contents:

        variants = ActiveSupport::ArrayInquirer.new([:phone, :tablet])

        variants.phone?    # => true
        variants.tablet?   # => true
        variants.desktop?  # => false

        variants.any?(:phone, :tablet)   # => true
        variants.any?(:phone, :desktop)  # => true
        variants.any?(:desktop, :watch)  # => false

67 68 69
    `Array#inquiry` is a shortcut for wrapping the receiving array in an
    `ArrayInquirer`.

70 71
    *George Claghorn*

Y
Yves Senn 已提交
72 73
*   Deprecate `alias_method_chain` in favour of `Module#prepend` introduced in
    Ruby 2.0.
74 75 76

    *Kir Shatrov*

T
Todd Bealmear 已提交
77 78 79 80 81
*   Added `#without` on `Enumerable` and `Array` to return a copy of an
    enumerable without the specified elements.

    *Todd Bealmear*

K
karanarora 已提交
82
*   Fixed a problem where `String#truncate_words` would get stuck with a complex
83 84 85 86
    string.

    *Henrik Nygren*

K
karanarora 已提交
87
*   Fixed a roundtrip problem with `AS::SafeBuffer` where primitive-like strings
88 89 90 91
    will be dumped as primitives:

    Before:

92 93 94 95 96
        YAML.load ActiveSupport::SafeBuffer.new("Hello").to_yaml  # => "Hello"
        YAML.load ActiveSupport::SafeBuffer.new("true").to_yaml   # => true
        YAML.load ActiveSupport::SafeBuffer.new("false").to_yaml  # => false
        YAML.load ActiveSupport::SafeBuffer.new("1").to_yaml      # => 1
        YAML.load ActiveSupport::SafeBuffer.new("1.1").to_yaml    # => 1.1
97

98
    After:
99

100 101 102 103 104
        YAML.load ActiveSupport::SafeBuffer.new("Hello").to_yaml  # => "Hello"
        YAML.load ActiveSupport::SafeBuffer.new("true").to_yaml   # => "true"
        YAML.load ActiveSupport::SafeBuffer.new("false").to_yaml  # => "false"
        YAML.load ActiveSupport::SafeBuffer.new("1").to_yaml      # => "1"
        YAML.load ActiveSupport::SafeBuffer.new("1.1").to_yaml    # => "1.1"
105 106 107

    *Godfrey Chan*

108 109
*   Enable `number_to_percentage` to keep the number's precision by allowing
    `:precision` to be `nil`.
110

111
    *Jack Xu*
112

113
*   `config_accessor` became a private method, as with Ruby's `attr_accessor`.
114 115 116

    *Akira Matsuda*

117 118 119 120 121
*   `AS::Testing::TimeHelpers#travel_to` now changes `DateTime.now` as well as
    `Time.now` and `Date.today`.

    *Yuki Nishijima*

122 123 124 125 126 127 128 129
*   Add `file_fixture` to `ActiveSupport::TestCase`.
    It provides a simple mechanism to access sample files in your test cases.

    By default file fixtures are stored in `test/fixtures/files`. This can be
    configured per test-case using the `file_fixture_path` class attribute.

    *Yves Senn*

130 131 132 133
*   Return value of yielded block in `File.atomic_write`.

    *Ian Ker-Seymer*

K
karanarora 已提交
134
*   Duplicate frozen array when assigning it to a `HashWithIndifferentAccess` so
135 136 137 138 139 140
    that it doesn't raise a `RuntimeError` when calling `map!` on it in `convert_value`.

    Fixes #18550.

    *Aditya Kapoor*

141 142 143 144 145
*   Add missing time zone definitions for Russian Federation and sync them
    with `zone.tab` file from tzdata version 2014j (latest).

    *Andrey Novikov*

G
Guillermo Iguaran 已提交
146 147
*   Add `SecureRandom.base58` for generation of random base58 strings.

148
    *Matthew Draper*, *Guillermo Iguaran*
G
Guillermo Iguaran 已提交
149

150 151 152 153 154
*   Add `#prev_day` and `#next_day` counterparts to `#yesterday` and
    `#tomorrow` for `Date`, `Time`, and `DateTime`.

    *George Claghorn*

155 156 157 158 159
*   Add `same_time` option to `#next_week` and `#prev_week` for `Date`, `Time`,
    and `DateTime`.

    *George Claghorn*

160 161 162
*   Add `#on_weekend?`, `#next_weekday`, `#prev_weekday` methods to `Date`,
    `Time`, and `DateTime`.

K
karanarora 已提交
163
    `#on_weekend?` returns `true` if the receiving date/time falls on a Saturday
164 165 166 167 168 169 170 171 172 173
    or Sunday.

    `#next_weekday` returns a new date/time representing the next day that does
    not fall on a Saturday or Sunday.

    `#prev_weekday` returns a new date/time representing the previous day that
    does not fall on a Saturday or Sunday.

    *George Claghorn*

174 175 176 177
*   Change the default test order from `:sorted` to `:random`.

    *Rafael Mendonça França*

178 179 180 181
*   Remove deprecated `ActiveSupport::JSON::Encoding::CircularReferenceError`.

    *Rafael Mendonça França*

182 183 184 185 186
*   Remove deprecated methods `ActiveSupport::JSON::Encoding.encode_big_decimal_as_string=`
    and `ActiveSupport::JSON::Encoding.encode_big_decimal_as_string`.

    *Rafael Mendonça França*

187 188 189 190
*   Remove deprecated `ActiveSupport::SafeBuffer#prepend`.

    *Rafael Mendonça França*

191 192 193 194 195 196
*   Remove deprecated methods at `Kernel`.

    `silence_stderr`, `silence_stream`, `capture` and `quietly`.

    *Rafael Mendonça França*

197 198 199 200 201
*   Remove deprecated `active_support/core_ext/big_decimal/yaml_conversions`
    file.

    *Rafael Mendonça França*

202 203 204 205 206
*   Remove deprecated methods `ActiveSupport::Cache::Store.instrument` and
    `ActiveSupport::Cache::Store.instrument=`.

    *Rafael Mendonça França*

207
*   Change the way in which callback chains can be halted.
208

209 210 211 212 213 214 215 216
    The preferred method to halt a callback chain from now on is to explicitly
    `throw(:abort)`.
    In the past, returning `false` in an ActiveSupport callback had the side
    effect of halting the callback chain. This is not recommended anymore and,
    depending on the value of
    `Callbacks::CallbackChain.halt_and_display_warning_on_return_false`, will
    either not work at all or display a deprecation warning.

K
karanarora 已提交
217
*   Add `Callbacks::CallbackChain.halt_and_display_warning_on_return_false`
218 219

    Setting `Callbacks::CallbackChain.halt_and_display_warning_on_return_false`
K
karanarora 已提交
220
    to `true` will let an app support the deprecated way of halting callback
221 222
    chains by returning `false`.

K
karanarora 已提交
223
    Setting the value to `false` will tell the app to ignore any `false` value
224 225 226 227 228 229 230 231 232
    returned by callbacks, and only halt the chain upon `throw(:abort)`.

    The value can also be set with the Rails configuration option
    `config.active_support.halt_callback_chains_on_return_false`.

    When the configuration option is missing, its value is `true`, so older apps
    ported to Rails 5.0 will not break (but display a deprecation warning).
    For new Rails 5.0 apps, its value is set to `false` in an initializer, so
    these apps will support the new behavior by default.
233 234 235

    *claudiob*

K
karanarora 已提交
236
*   Changes arguments and default value of CallbackChain's `:terminator` option
237 238 239 240 241 242

    Chains of callbacks defined without an explicit `:terminator` option will
    now be halted as soon as a `before_` callback throws `:abort`.

    Chains of callbacks defined with a `:terminator` option will maintain their
    existing behavior of halting as soon as a `before_` callback matches the
243
    terminator's expectation.
244 245 246

    *claudiob*

247 248 249 250 251 252 253
*   Deprecate `MissingSourceFile` in favor of `LoadError`.

    `MissingSourceFile` was just an alias to `LoadError` and was not being
    raised inside the framework.

    *Rafael Mendonça França*

R
Robin Dupret 已提交
254 255
*   Add support for error dispatcher classes in `ActiveSupport::Rescuable`.
    Now it acts closer to Ruby's rescue.
256

257 258
    Example:

259 260 261 262 263 264 265 266 267 268 269 270 271 272
        class BaseController < ApplicationController
          module ErrorDispatcher
            def self.===(other)
              Exception === other && other.respond_to?(:status)
            end
          end

          rescue_from ErrorDispatcher do |error|
            render status: error.status, json: { error: error.to_s }
          end
        end

    *Genadi Samokovarov*

R
Robin Dupret 已提交
273
*   Add `#verified` and `#valid_message?` methods to `ActiveSupport::MessageVerifier`
274

R
Robin Dupret 已提交
275 276 277 278
    Previously, the only way to decode a message with `ActiveSupport::MessageVerifier`
    was to use `#verify`, which would raise an exception on invalid messages. Now
    `#verified` can also be used, which returns `nil` on messages that cannot be
    decoded.
279

R
Robin Dupret 已提交
280 281 282
    Previously, there was no way to check if a message's format was valid without
    attempting to decode it. `#valid_message?` is a boolean convenience method that
    checks whether the message is valid without actually decoding it.
283

284 285
    *Logan Leger*

286
Please check [4-2-stable](https://github.com/rails/rails/blob/4-2-stable/activesupport/CHANGELOG.md) for previous changes.