CHANGELOG.md 17.2 KB
Newer Older
1 2 3 4 5 6 7 8 9
*   Deprecate arguments on `assert_nothing_raised`.

    `assert_nothing_raised` does not assert the arguments that have been passed
    in (usually a specific exception class) since the method only yields the
    block. So as not to confuse the users that the arguments have meaning, they
    are being deprecated.

    *Tara Scherner de la Fuente*

10 11 12 13
*   Make `benchmark('something', silence: true)` actually work

    *DHH*

14 15 16 17
*   Add `#on_weekday?` method to `Date`, `Time`, and `DateTime`.

    `#on_weekday?` returns `true` if the receiving date/time does not fall on a Saturday
    or Sunday.
18

19 20
    *Vipul A M*

21 22 23 24
*   Add `Array#second_to_last` and `Array#third_to_last` methods.

    *Brian Christian*

25
*  Fix regression in `Hash#dig` for HashWithIndifferentAccess.
26

27 28
   *Jon Moss*

S
Sean Griffin 已提交
29 30
## Rails 5.0.0.beta2 (February 01, 2016) ##

31 32 33 34 35 36 37 38 39 40 41 42 43 44 45
*   Change number_to_currency behavior for checking negativity.

    Used `to_f.negative` instead of using `to_f.phase` for checking negativity
    of a number in number_to_currency helper.
    This change works same for all cases except when number is "-0.0".

        -0.0.to_f.negative? => false
        -0.0.to_f.phase? => 3.14

    This change reverts changes from https://github.com/rails/rails/pull/6512.
    But it should be acceptable as we could not find any currency which
    supports negative zeros.

    *Prathamesh Sonpatki*, *Rafael Mendonça França*

46
*   Match `HashWithIndifferentAccess#default`'s behaviour with `Hash#default`.
47 48 49

    *David Cornu*

50 51
*   Adds `:exception_object` key to `ActiveSupport::Notifications::Instrumenter`
    payload when an exception is raised.
52

53 54
    Adds new key/value pair to payload when an exception is raised:
    e.g. `:exception_object => #<RuntimeError: FAIL>`.
55 56 57

    *Ryan T. Hosford*

58 59 60 61
*   Support extended grapheme clusters and UAX 29.

    *Adam Roben*

62
*   Add petabyte and exabyte numeric conversion.
E
eileencodes 已提交
63 64 65

    *Akshay Vishnoi*

66 67
## Rails 5.0.0.beta1 (December 18, 2015) ##

68 69 70 71 72 73 74
*   Add thread_m/cattr_accessor/reader/writer suite of methods for declaring class and module variables that live per-thread.
    This makes it easy to declare per-thread globals that are encapsulated. Note: This is a sharp edge. A wild proliferation
    of globals is A Bad Thing. But like other sharp tools, when it's right, it's right.

    Here's an example of a simple event tracking system where the object being tracked needs not pass a creator that it
    doesn't need itself along:

75 76 77
        module Current
          thread_mattr_accessor :account
          thread_mattr_accessor :user
78

79 80
          def self.reset() self.account = self.user = nil end
        end
81

82 83 84
        class ApplicationController < ActionController::Base
          before_action :set_current
          after_action { Current.reset }
85

86 87 88 89 90
          private
            def set_current
              Current.account = Account.find(params[:account_id])
              Current.user    = Current.account.users.find(params[:user_id])
            end
91 92
        end

93 94 95 96 97
        class MessagesController < ApplicationController
          def create
            @message = Message.create!(message_params)
          end
        end
98

99 100 101
        class Message < ApplicationRecord
          has_many :events
          after_create :track_created
102

103 104 105 106
          private
            def track_created
              events.create! origin: self, action: :create
            end
107 108
        end

109 110 111 112
        class Event < ApplicationRecord
          belongs_to :creator, class_name: 'User'
          before_validation { self.creator ||= Current.user }
        end
113 114 115 116

    *DHH*


117 118 119 120 121
*   Deprecated `Module#qualified_const_` in favour of the builtin Module#const_
    methods.

    *Genadi Samokovarov*

122 123 124 125
*   Deprecate passing string to define callback.

    *Yuichiro Kaneko*

126 127 128
*   `ActiveSupport::Cache::Store#namespaced_key`,
    `ActiveSupport::Cache::MemCachedStore#escape_key`, and
    `ActiveSupport::Cache::FileStore#key_file_path`
129
    are deprecated and replaced with `normalize_key` that now calls `super`.
130

131
    `ActiveSupport::Cache::LocaleCache#set_cache_value` is deprecated and replaced with `write_cache_value`.
132

133 134
    *Michael Grosser*

135 136
*   Implements an evented file watcher to asynchronously detect changes in the
    application source code, routes, locales, etc.
137

138 139 140 141 142 143
    This watcher is disabled by default, applications my enable it in the configuration:

        # config/environments/development.rb
        config.file_watcher = ActiveSupport::EventedFileUpdateChecker

    This feature depends on the [listen](https://github.com/guard/listen) gem:
144

J
Jon Pascoe 已提交
145
        group :development do
146
          gem 'listen', '~> 3.0.5'
J
Jon Pascoe 已提交
147
        end
148 149 150

    *Puneet Agarwal* and *Xavier Noria*

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

154
    *Jon Pascoe*
J
Jon Pascoe 已提交
155

156
*   Updated `parameterize` to preserve the case of a string, optionally.
157 158 159

    Example:

160 161
        parameterize("Donald E. Knuth", separator: '_') # => "donald_e_knuth"
        parameterize("Donald E. Knuth", preserve_case: true) # => "Donald-E-Knuth"
162 163 164

    *Swaathi Kakarla*

165 166 167 168 169 170
*   `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*

171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
*   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*

187
*   Handle invalid UTF-8 strings when HTML escaping.
188 189 190 191 192 193 194 195

    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 已提交
196 197 198 199 200
*   Update `ActiveSupport::Multibyte::Chars#slice!` to return `nil` if the
    arguments are out of bounds, to mirror the behavior of `String#slice!`

    *Gourav Tiwari*

201 202
*   Fix `number_to_human` so that 999999999 rounds to "1 Billion" instead of
    "1000 Million".
M
Max Jacobson 已提交
203 204 205

    *Max Jacobson*

206 207 208 209 210
*   Fix `ActiveSupport::Deprecation#deprecate_methods` to report using the
    current deprecator instance, where applicable.

    *Brandon Dunne*

211 212 213 214
*   `Cache#fetch` instrumentation marks whether it was a `:hit`.

    *Robin Clowers*

215 216 217 218 219 220 221 222 223 224 225
*   `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*

226 227
*   Short-circuit `blank?` on date and time values since they are never blank.

228
    Fixes #21657.
229 230 231

    *Andrew White*

232 233 234 235 236
*   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 已提交
237 238 239
*   Updated Unicode version to 8.0.0

    *Anshul Sharma*
240

241 242 243 244 245
*   `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:

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

249
    *Vipul A M*
250

251 252 253 254
*   Deprecate `:prefix` option of `number_to_human_size` with no replacement.

    *Jean Boussier*

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

263 264 265
*   ActiveSupport::HashWithIndifferentAccess `select` and `reject` will now return
    enumerator if called without block.

266
    Fixes #20095.
267 268 269

    *Bernard Potocki*

270 271 272 273 274
*   Removed `ActiveSupport::Concurrency::Latch`, superseded by `Concurrent::CountDownLatch`
    from the concurrent-ruby gem.

    *Jerry D'Antonio*

Y
yuuji.yaginuma 已提交
275
*   Fix not calling `#default` on `HashWithIndifferentAccess#to_hash` when only
276 277 278 279
    `default_proc` is set, which could raise.

    *Simon Eskildsen*

280
*   Fix setting `default_proc` on `HashWithIndifferentAccess#dup`.
281 282 283

    *Simon Eskildsen*

284
*   Fix a range of values for parameters of the Time#change.
285 286 287

    *Nikolay Kondratyev*

K
Kevin Deisz 已提交
288 289 290 291 292 293 294
*   Add `Enumerable#pluck` to get the same values from arrays as from ActiveRecord
    associations.

    Fixes #20339.

    *Kevin Deisz*

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

298 299
    Before:

A
Aditya Sanghi 已提交
300
        if (slack_url = Rails.application.secrets.slack_url).present?
301
          # Do something worthwhile
302
        else
303
          # Raise as important secret password is not specified
304 305 306 307 308 309 310 311
        end

    After:

        slack_url = Rails.application.secrets.slack_url!

    *Aditya Sanghi*, *Gaurish Sharma*

312 313
*   Remove deprecated `Class#superclass_delegating_accessor`.
    Use `Class#class_attribute` instead.
314 315 316

    *Akshay Vishnoi*

317
*   Patch `Delegator` to work with `#try`.
318

319
    Fixes #5790.
320 321 322

    *Nate Smith*

323 324 325 326
*   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?)`.
327 328 329

    *DHH*

330
*   Encoding `ActiveSupport::TimeWithZone` to YAML now preserves the timezone information.
331 332 333 334 335

    Fixes #9183.

    *Andrew White*

336 337 338 339 340
*   Added `ActiveSupport::TimeZone#strptime` to allow parsing times as if
    from a given timezone.

    *Paul A Jungwirth*

341 342 343 344 345
*   `ActiveSupport::Callbacks#skip_callback` now raises an `ArgumentError` if
    an unrecognized callback is removed.

    *Iain Beeston*

346
*   Added `ActiveSupport::ArrayInquirer` and `Array#inquiry`.
347 348 349 350 351 352 353 354 355 356 357 358 359 360

    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

361 362 363
    `Array#inquiry` is a shortcut for wrapping the receiving array in an
    `ArrayInquirer`.

364 365
    *George Claghorn*

Y
Yves Senn 已提交
366 367
*   Deprecate `alias_method_chain` in favour of `Module#prepend` introduced in
    Ruby 2.0.
368 369 370

    *Kir Shatrov*

T
Todd Bealmear 已提交
371 372 373 374 375
*   Added `#without` on `Enumerable` and `Array` to return a copy of an
    enumerable without the specified elements.

    *Todd Bealmear*

K
karanarora 已提交
376
*   Fixed a problem where `String#truncate_words` would get stuck with a complex
377 378 379 380
    string.

    *Henrik Nygren*

K
karanarora 已提交
381
*   Fixed a roundtrip problem with `AS::SafeBuffer` where primitive-like strings
382 383 384 385
    will be dumped as primitives:

    Before:

386 387 388 389 390
        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
391

392
    After:
393

394 395 396 397 398
        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"
399 400 401

    *Godfrey Chan*

402 403
*   Enable `number_to_percentage` to keep the number's precision by allowing
    `:precision` to be `nil`.
404

405
    *Jack Xu*
406

407
*   `config_accessor` became a private method, as with Ruby's `attr_accessor`.
408 409 410

    *Akira Matsuda*

411 412 413 414 415
*   `AS::Testing::TimeHelpers#travel_to` now changes `DateTime.now` as well as
    `Time.now` and `Date.today`.

    *Yuki Nishijima*

416 417 418 419 420 421 422 423
*   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*

424 425 426 427
*   Return value of yielded block in `File.atomic_write`.

    *Ian Ker-Seymer*

K
karanarora 已提交
428
*   Duplicate frozen array when assigning it to a `HashWithIndifferentAccess` so
429 430 431 432 433 434
    that it doesn't raise a `RuntimeError` when calling `map!` on it in `convert_value`.

    Fixes #18550.

    *Aditya Kapoor*

435 436 437 438 439
*   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 已提交
440 441
*   Add `SecureRandom.base58` for generation of random base58 strings.

442
    *Matthew Draper*, *Guillermo Iguaran*
G
Guillermo Iguaran 已提交
443

444 445 446 447 448
*   Add `#prev_day` and `#next_day` counterparts to `#yesterday` and
    `#tomorrow` for `Date`, `Time`, and `DateTime`.

    *George Claghorn*

449 450 451 452 453
*   Add `same_time` option to `#next_week` and `#prev_week` for `Date`, `Time`,
    and `DateTime`.

    *George Claghorn*

454 455 456
*   Add `#on_weekend?`, `#next_weekday`, `#prev_weekday` methods to `Date`,
    `Time`, and `DateTime`.

K
karanarora 已提交
457
    `#on_weekend?` returns `true` if the receiving date/time falls on a Saturday
458 459 460 461 462 463 464 465 466 467
    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*

468 469 470 471
*   Change the default test order from `:sorted` to `:random`.

    *Rafael Mendonça França*

472 473 474 475
*   Remove deprecated `ActiveSupport::JSON::Encoding::CircularReferenceError`.

    *Rafael Mendonça França*

476 477 478 479 480
*   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*

481 482 483 484
*   Remove deprecated `ActiveSupport::SafeBuffer#prepend`.

    *Rafael Mendonça França*

485 486 487 488 489 490
*   Remove deprecated methods at `Kernel`.

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

    *Rafael Mendonça França*

491 492 493 494 495
*   Remove deprecated `active_support/core_ext/big_decimal/yaml_conversions`
    file.

    *Rafael Mendonça França*

496 497 498 499 500
*   Remove deprecated methods `ActiveSupport::Cache::Store.instrument` and
    `ActiveSupport::Cache::Store.instrument=`.

    *Rafael Mendonça França*

501
*   Change the way in which callback chains can be halted.
502

503 504
    The preferred method to halt a callback chain from now on is to explicitly
    `throw(:abort)`.
505 506
    In the past, callbacks could only be halted by explicitly providing a
    terminator and by having a callback match the conditions of the terminator.
507

508
*   Add `ActiveSupport.halt_callback_chains_on_return_false`
509

510
    Setting `ActiveSupport.halt_callback_chains_on_return_false`
511
    to `true` will let an app support the deprecated way of halting Active Record,
512
    and Active Model callback chains by returning `false`.
513

K
karanarora 已提交
514
    Setting the value to `false` will tell the app to ignore any `false` value
515
    returned by those callbacks, and only halt the chain upon `throw(:abort)`.
516 517 518 519 520

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

522
    *claudiob*, *Roque Pinel*
523

K
karanarora 已提交
524
*   Changes arguments and default value of CallbackChain's `:terminator` option
525 526 527 528 529 530

    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
531
    terminator's expectation.
532 533 534

    *claudiob*

535 536 537 538 539 540 541
*   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 已提交
542 543
*   Add support for error dispatcher classes in `ActiveSupport::Rescuable`.
    Now it acts closer to Ruby's rescue.
544

545 546
    Example:

547 548 549 550 551 552 553 554 555 556 557 558 559 560
        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 已提交
561
*   Add `#verified` and `#valid_message?` methods to `ActiveSupport::MessageVerifier`
562

R
Robin Dupret 已提交
563 564 565 566
    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.
567

R
Robin Dupret 已提交
568 569 570
    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.
571

572 573
    *Logan Leger*

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