CHANGELOG.md 12.9 KB
Newer Older
1 2 3 4 5
*   Implements an evented file system monitor to asynchronously detect changes
    in the application source code, routes, locales, etc.

    To opt-in load the [listen](https://github.com/guard/listen) gem in `Gemfile`:

J
Jon Pascoe 已提交
6 7 8
        group :development do
          gem 'listen', '~> 3.0.4'
        end
9 10 11

    *Puneet Agarwal* and *Xavier Noria*

12 13
*   Added `Time#days_in_year` to return the number of days in the given year, or the
    current year if no argument is provided.
J
Jon Pascoe 已提交
14

15
    *Jon Pascoe*
J
Jon Pascoe 已提交
16

17
*   Updated `parameterize` to preserve the case of a string, optionally.
18 19 20

    Example:

21 22
        parameterize("Donald E. Knuth", separator: '_') # => "donald_e_knuth"
        parameterize("Donald E. Knuth", preserve_case: true) # => "Donald-E-Knuth"
23 24 25

    *Swaathi Kakarla*

26 27 28 29 30 31
*   `HashWithIndifferentAccess.new` respects the default value or proc on objects
    that respond to `#to_hash`. `.new_from_hash_copying_default` simply invokes `.new`.
    All calls to `.new_from_hash_copying_default` are replaced with `.new`.

    *Gordon Chan*

32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
*   Change Integer#year to return a Fixnum instead of a Float to improve
    consistency.

    Integer#years returned a Float while the rest of the accompanying methods
    (days, weeks, months, etc.) return a Fixnum.

    Before:

    1.year # => 31557600.0

    After:

    1.year # => 31557600

    *Konstantinos Rousis*

48 49 50 51 52 53 54 55 56
*   Handle invalid UTF-8 strings when HTML escaping

    Use `ActiveSupport::Multibyte::Unicode.tidy_bytes` to handle invalid UTF-8
    strings in `ERB::Util.unwrapped_html_escape` and `ERB::Util.html_escape_once`.
    Prevents user-entered input passed from a querystring into a form field from
    causing invalid byte sequence errors.

    *Grey Baker*

S
Sean Griffin 已提交
57 58 59 60 61
*   Update `ActiveSupport::Multibyte::Chars#slice!` to return `nil` if the
    arguments are out of bounds, to mirror the behavior of `String#slice!`

    *Gourav Tiwari*

62 63
*   Fix `number_to_human` so that 999999999 rounds to "1 Billion" instead of
    "1000 Million".
M
Max Jacobson 已提交
64 65 66

    *Max Jacobson*

67 68 69 70 71
*   Fix `ActiveSupport::Deprecation#deprecate_methods` to report using the
    current deprecator instance, where applicable.

    *Brandon Dunne*

72 73 74 75
*   `Cache#fetch` instrumentation marks whether it was a `:hit`.

    *Robin Clowers*

76 77 78 79 80 81 82 83 84 85 86
*   `assert_difference` and `assert_no_difference` now returns the result of the
    yielded block.

    Example:

      post = assert_difference -> { Post.count }, 1 do
        Post.create
      end

    *Lucas Mazza*

87 88 89 90 91 92
*   Short-circuit `blank?` on date and time values since they are never blank.

    Fixes #21657

    *Andrew White*

93 94 95 96 97
*   Replaced deprecated `ThreadSafe::Cache` with its successor `Concurrent::Map` now that
    the thread_safe gem has been merged into concurrent-ruby.

    *Jerry D'Antonio*

A
Anshul Sharma 已提交
98 99 100
*   Updated Unicode version to 8.0.0

    *Anshul Sharma*
101

102 103 104 105 106
*   `number_to_currency` and `number_with_delimiter` now accept custom `delimiter_pattern` option
     to handle placement of delimiter, to support currency formats like INR

     Example:

107
        number_to_currency(1230000, delimiter_pattern: /(\d+?)(?=(\d\d)+(\d)(?!\d))/, unit: '₹', format: "%u %n")
108 109
        # => '₹ 12,30,000.00'

110
    *Vipul A M*
111

112 113 114 115
*   Deprecate `:prefix` option of `number_to_human_size` with no replacement.

    *Jean Boussier*

116 117 118 119 120 121 122 123
*   Fix `TimeWithZone#eql?` to properly handle `TimeWithZone` created from `DateTime`:
        twz = DateTime.now.in_time_zone
        twz.eql?(twz.dup) => true

    Fixes #14178.

    *Roque Pinel*

124 125 126 127 128 129 130
*   ActiveSupport::HashWithIndifferentAccess `select` and `reject` will now return
    enumerator if called without block.

    Fixes #20095

    *Bernard Potocki*

131 132 133 134 135
*   Removed `ActiveSupport::Concurrency::Latch`, superseded by `Concurrent::CountDownLatch`
    from the concurrent-ruby gem.

    *Jerry D'Antonio*

Y
yuuji.yaginuma 已提交
136
*   Fix not calling `#default` on `HashWithIndifferentAccess#to_hash` when only
137 138 139 140
    `default_proc` is set, which could raise.

    *Simon Eskildsen*

141 142 143 144
*   Fix setting `default_proc` on `HashWithIndifferentAccess#dup`

    *Simon Eskildsen*

145 146 147 148
*   Fix a range of values for parameters of the Time#change

    *Nikolay Kondratyev*

K
Kevin Deisz 已提交
149 150 151 152 153 154 155
*   Add `Enumerable#pluck` to get the same values from arrays as from ActiveRecord
    associations.

    Fixes #20339.

    *Kevin Deisz*

156 157 158
*   Add a bang version to `ActiveSupport::OrderedOptions` get methods which will raise
    an `KeyError` if the value is `.blank?`

159 160
    Before:

A
Aditya Sanghi 已提交
161
        if (slack_url = Rails.application.secrets.slack_url).present?
162
          # Do something worthwhile
163
        else
164
          # Raise as important secret password is not specified
165 166 167 168 169 170 171 172
        end

    After:

        slack_url = Rails.application.secrets.slack_url!

    *Aditya Sanghi*, *Gaurish Sharma*

173 174
*   Remove deprecated `Class#superclass_delegating_accessor`.
    Use `Class#class_attribute` instead.
175 176 177

    *Akshay Vishnoi*

178
*   Patch `Delegator` to work with `#try`.
179

180
    Fixes #5790.
181 182 183

    *Nate Smith*

184 185 186 187
*   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?)`.
188 189 190

    *DHH*

191
*   Encoding `ActiveSupport::TimeWithZone` to YAML now preserves the timezone information.
192 193 194 195 196

    Fixes #9183.

    *Andrew White*

197 198 199 200 201
*   Added `ActiveSupport::TimeZone#strptime` to allow parsing times as if
    from a given timezone.

    *Paul A Jungwirth*

202 203 204 205 206
*   `ActiveSupport::Callbacks#skip_callback` now raises an `ArgumentError` if
    an unrecognized callback is removed.

    *Iain Beeston*

207
*   Added `ActiveSupport::ArrayInquirer` and `Array#inquiry`.
208 209 210 211 212 213 214 215 216 217 218 219 220 221

    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

222 223 224
    `Array#inquiry` is a shortcut for wrapping the receiving array in an
    `ArrayInquirer`.

225 226
    *George Claghorn*

Y
Yves Senn 已提交
227 228
*   Deprecate `alias_method_chain` in favour of `Module#prepend` introduced in
    Ruby 2.0.
229 230 231

    *Kir Shatrov*

T
Todd Bealmear 已提交
232 233 234 235 236
*   Added `#without` on `Enumerable` and `Array` to return a copy of an
    enumerable without the specified elements.

    *Todd Bealmear*

K
karanarora 已提交
237
*   Fixed a problem where `String#truncate_words` would get stuck with a complex
238 239 240 241
    string.

    *Henrik Nygren*

K
karanarora 已提交
242
*   Fixed a roundtrip problem with `AS::SafeBuffer` where primitive-like strings
243 244 245 246
    will be dumped as primitives:

    Before:

247 248 249 250 251
        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
252

253
    After:
254

255 256 257 258 259
        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"
260 261 262

    *Godfrey Chan*

263 264
*   Enable `number_to_percentage` to keep the number's precision by allowing
    `:precision` to be `nil`.
265

266
    *Jack Xu*
267

268
*   `config_accessor` became a private method, as with Ruby's `attr_accessor`.
269 270 271

    *Akira Matsuda*

272 273 274 275 276
*   `AS::Testing::TimeHelpers#travel_to` now changes `DateTime.now` as well as
    `Time.now` and `Date.today`.

    *Yuki Nishijima*

277 278 279 280 281 282 283 284
*   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*

285 286 287 288
*   Return value of yielded block in `File.atomic_write`.

    *Ian Ker-Seymer*

K
karanarora 已提交
289
*   Duplicate frozen array when assigning it to a `HashWithIndifferentAccess` so
290 291 292 293 294 295
    that it doesn't raise a `RuntimeError` when calling `map!` on it in `convert_value`.

    Fixes #18550.

    *Aditya Kapoor*

296 297 298 299 300
*   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 已提交
301 302
*   Add `SecureRandom.base58` for generation of random base58 strings.

303
    *Matthew Draper*, *Guillermo Iguaran*
G
Guillermo Iguaran 已提交
304

305 306 307 308 309
*   Add `#prev_day` and `#next_day` counterparts to `#yesterday` and
    `#tomorrow` for `Date`, `Time`, and `DateTime`.

    *George Claghorn*

310 311 312 313 314
*   Add `same_time` option to `#next_week` and `#prev_week` for `Date`, `Time`,
    and `DateTime`.

    *George Claghorn*

315 316 317
*   Add `#on_weekend?`, `#next_weekday`, `#prev_weekday` methods to `Date`,
    `Time`, and `DateTime`.

K
karanarora 已提交
318
    `#on_weekend?` returns `true` if the receiving date/time falls on a Saturday
319 320 321 322 323 324 325 326 327 328
    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*

329 330 331 332
*   Change the default test order from `:sorted` to `:random`.

    *Rafael Mendonça França*

333 334 335 336
*   Remove deprecated `ActiveSupport::JSON::Encoding::CircularReferenceError`.

    *Rafael Mendonça França*

337 338 339 340 341
*   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*

342 343 344 345
*   Remove deprecated `ActiveSupport::SafeBuffer#prepend`.

    *Rafael Mendonça França*

346 347 348 349 350 351
*   Remove deprecated methods at `Kernel`.

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

    *Rafael Mendonça França*

352 353 354 355 356
*   Remove deprecated `active_support/core_ext/big_decimal/yaml_conversions`
    file.

    *Rafael Mendonça França*

357 358 359 360 361
*   Remove deprecated methods `ActiveSupport::Cache::Store.instrument` and
    `ActiveSupport::Cache::Store.instrument=`.

    *Rafael Mendonça França*

362
*   Change the way in which callback chains can be halted.
363

364 365
    The preferred method to halt a callback chain from now on is to explicitly
    `throw(:abort)`.
366 367
    In the past, callbacks could only be halted by explicitly providing a
    terminator and by having a callback match the conditions of the terminator.
368

369
*   Add `ActiveSupport.halt_callback_chains_on_return_false`
370

371
    Setting `ActiveSupport.halt_callback_chains_on_return_false`
372
    to `true` will let an app support the deprecated way of halting Active Record,
373
    and Active Model callback chains by returning `false`.
374

K
karanarora 已提交
375
    Setting the value to `false` will tell the app to ignore any `false` value
376
    returned by those callbacks, and only halt the chain upon `throw(:abort)`.
377 378 379 380 381

    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.
382

383
    *claudiob*, *Roque Pinel*
384

K
karanarora 已提交
385
*   Changes arguments and default value of CallbackChain's `:terminator` option
386 387 388 389 390 391

    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
392
    terminator's expectation.
393 394 395

    *claudiob*

396 397 398 399 400 401 402
*   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 已提交
403 404
*   Add support for error dispatcher classes in `ActiveSupport::Rescuable`.
    Now it acts closer to Ruby's rescue.
405

406 407
    Example:

408 409 410 411 412 413 414 415 416 417 418 419 420 421
        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 已提交
422
*   Add `#verified` and `#valid_message?` methods to `ActiveSupport::MessageVerifier`
423

R
Robin Dupret 已提交
424 425 426 427
    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.
428

R
Robin Dupret 已提交
429 430 431
    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.
432

433 434
    *Logan Leger*

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