CHANGELOG.md 17.2 KB
Newer Older
E
eileencodes 已提交
1 2
## Rails 5.0.0.beta3 (February 24, 2016) ##

3 4 5 6 7 8 9 10 11
*   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*

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

    *DHH*

16 17 18 19
*   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.
20

21 22
    *Vipul A M*

23 24 25 26
*   Add `Array#second_to_last` and `Array#third_to_last` methods.

    *Brian Christian*

27
*  Fix regression in `Hash#dig` for HashWithIndifferentAccess.
28

29 30
   *Jon Moss*

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

33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
*   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*

48
*   Match `HashWithIndifferentAccess#default`'s behaviour with `Hash#default`.
49 50 51

    *David Cornu*

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

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

    *Ryan T. Hosford*

60 61 62 63
*   Support extended grapheme clusters and UAX 29.

    *Adam Roben*

64
*   Add petabyte and exabyte numeric conversion.
E
eileencodes 已提交
65 66 67

    *Akshay Vishnoi*

68 69
## Rails 5.0.0.beta1 (December 18, 2015) ##

70 71 72 73 74 75 76
*   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:

77 78 79
        module Current
          thread_mattr_accessor :account
          thread_mattr_accessor :user
80

81 82
          def self.reset() self.account = self.user = nil end
        end
83

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

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

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

101 102 103
        class Message < ApplicationRecord
          has_many :events
          after_create :track_created
104

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

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

    *DHH*


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

    *Genadi Samokovarov*

124 125 126 127
*   Deprecate passing string to define callback.

    *Yuichiro Kaneko*

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

133
    `ActiveSupport::Cache::LocaleCache#set_cache_value` is deprecated and replaced with `write_cache_value`.
134

135 136
    *Michael Grosser*

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

140 141 142 143 144 145
    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:
146

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

    *Puneet Agarwal* and *Xavier Noria*

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

156
    *Jon Pascoe*
J
Jon Pascoe 已提交
157

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

    Example:

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

    *Swaathi Kakarla*

167 168 169 170 171 172
*   `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*

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

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

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

    *Gourav Tiwari*

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

    *Max Jacobson*

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

    *Brandon Dunne*

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

    *Robin Clowers*

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

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

230
    Fixes #21657.
231 232 233

    *Andrew White*

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

    *Anshul Sharma*
242

243 244 245 246 247
*   `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:

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

251
    *Vipul A M*
252

253 254 255 256
*   Deprecate `:prefix` option of `number_to_human_size` with no replacement.

    *Jean Boussier*

257 258 259 260 261 262 263 264
*   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*

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

268
    Fixes #20095.
269 270 271

    *Bernard Potocki*

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

    *Jerry D'Antonio*

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

    *Simon Eskildsen*

282
*   Fix setting `default_proc` on `HashWithIndifferentAccess#dup`.
283 284 285

    *Simon Eskildsen*

286
*   Fix a range of values for parameters of the Time#change.
287 288 289

    *Nikolay Kondratyev*

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

    Fixes #20339.

    *Kevin Deisz*

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

300 301
    Before:

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

    After:

        slack_url = Rails.application.secrets.slack_url!

    *Aditya Sanghi*, *Gaurish Sharma*

314 315
*   Remove deprecated `Class#superclass_delegating_accessor`.
    Use `Class#class_attribute` instead.
316 317 318

    *Akshay Vishnoi*

319
*   Patch `Delegator` to work with `#try`.
320

321
    Fixes #5790.
322 323 324

    *Nate Smith*

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

    *DHH*

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

    Fixes #9183.

    *Andrew White*

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

    *Paul A Jungwirth*

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

    *Iain Beeston*

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

    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

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

366 367
    *George Claghorn*

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

    *Kir Shatrov*

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

    *Todd Bealmear*

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

    *Henrik Nygren*

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

    Before:

388 389 390 391 392
        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
393

394
    After:
395

396 397 398 399 400
        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"
401 402 403

    *Godfrey Chan*

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

407
    *Jack Xu*
408

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

    *Akira Matsuda*

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

    *Yuki Nishijima*

418 419 420 421 422 423 424 425
*   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*

426 427 428 429
*   Return value of yielded block in `File.atomic_write`.

    *Ian Ker-Seymer*

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

    Fixes #18550.

    *Aditya Kapoor*

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

444
    *Matthew Draper*, *Guillermo Iguaran*
G
Guillermo Iguaran 已提交
445

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

    *George Claghorn*

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

    *George Claghorn*

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

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

470 471 472 473
*   Change the default test order from `:sorted` to `:random`.

    *Rafael Mendonça França*

474 475 476 477
*   Remove deprecated `ActiveSupport::JSON::Encoding::CircularReferenceError`.

    *Rafael Mendonça França*

478 479 480 481 482
*   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*

483 484 485 486
*   Remove deprecated `ActiveSupport::SafeBuffer#prepend`.

    *Rafael Mendonça França*

487 488 489 490 491 492
*   Remove deprecated methods at `Kernel`.

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

    *Rafael Mendonça França*

493 494 495 496 497
*   Remove deprecated `active_support/core_ext/big_decimal/yaml_conversions`
    file.

    *Rafael Mendonça França*

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

    *Rafael Mendonça França*

503
*   Change the way in which callback chains can be halted.
504

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

510
*   Add `ActiveSupport.halt_callback_chains_on_return_false`
511

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

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

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

524
    *claudiob*, *Roque Pinel*
525

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

    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
533
    terminator's expectation.
534 535 536

    *claudiob*

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

547 548
    Example:

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

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

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

574 575
    *Logan Leger*

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