CHANGELOG.md 17.5 KB
Newer Older
Y
yui-knk 已提交
1 2 3 4
*   Deprecate `Module.local_constants`. Please use `Module.constants(false)` instead.

    *Yuichiro Kaneko*

5 6 7 8 9 10 11
*   Publish ActiveSupport::Executor and ActiveSupport::Reloader APIs to allow
    components and libraries to manage, and participate in, the execution of
    application code, and the application reloading process.

    *Matthew Draper*


E
eileencodes 已提交
12 13
## Rails 5.0.0.beta3 (February 24, 2016) ##

14 15 16 17 18 19 20 21 22
*   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*

23 24 25 26
*   Make `benchmark('something', silence: true)` actually work

    *DHH*

27 28 29 30
*   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.
31

32 33
    *Vipul A M*

34 35 36 37
*   Add `Array#second_to_last` and `Array#third_to_last` methods.

    *Brian Christian*

38
*  Fix regression in `Hash#dig` for HashWithIndifferentAccess.
39

40 41
   *Jon Moss*

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

44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
*   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*

59
*   Match `HashWithIndifferentAccess#default`'s behaviour with `Hash#default`.
60 61 62

    *David Cornu*

63 64
*   Adds `:exception_object` key to `ActiveSupport::Notifications::Instrumenter`
    payload when an exception is raised.
65

66 67
    Adds new key/value pair to payload when an exception is raised:
    e.g. `:exception_object => #<RuntimeError: FAIL>`.
68 69 70

    *Ryan T. Hosford*

71 72 73 74
*   Support extended grapheme clusters and UAX 29.

    *Adam Roben*

75
*   Add petabyte and exabyte numeric conversion.
E
eileencodes 已提交
76 77 78

    *Akshay Vishnoi*

79 80
## Rails 5.0.0.beta1 (December 18, 2015) ##

81 82 83 84 85 86 87
*   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:

88 89 90
        module Current
          thread_mattr_accessor :account
          thread_mattr_accessor :user
91

92 93
          def self.reset() self.account = self.user = nil end
        end
94

95 96 97
        class ApplicationController < ActionController::Base
          before_action :set_current
          after_action { Current.reset }
98

99 100 101 102 103
          private
            def set_current
              Current.account = Account.find(params[:account_id])
              Current.user    = Current.account.users.find(params[:user_id])
            end
104 105
        end

106 107 108 109 110
        class MessagesController < ApplicationController
          def create
            @message = Message.create!(message_params)
          end
        end
111

112 113 114
        class Message < ApplicationRecord
          has_many :events
          after_create :track_created
115

116 117 118 119
          private
            def track_created
              events.create! origin: self, action: :create
            end
120 121
        end

122 123 124 125
        class Event < ApplicationRecord
          belongs_to :creator, class_name: 'User'
          before_validation { self.creator ||= Current.user }
        end
126 127 128 129

    *DHH*


130 131 132 133 134
*   Deprecated `Module#qualified_const_` in favour of the builtin Module#const_
    methods.

    *Genadi Samokovarov*

135 136 137 138
*   Deprecate passing string to define callback.

    *Yuichiro Kaneko*

139 140 141
*   `ActiveSupport::Cache::Store#namespaced_key`,
    `ActiveSupport::Cache::MemCachedStore#escape_key`, and
    `ActiveSupport::Cache::FileStore#key_file_path`
142
    are deprecated and replaced with `normalize_key` that now calls `super`.
143

144
    `ActiveSupport::Cache::LocaleCache#set_cache_value` is deprecated and replaced with `write_cache_value`.
145

146 147
    *Michael Grosser*

148 149
*   Implements an evented file watcher to asynchronously detect changes in the
    application source code, routes, locales, etc.
150

151 152 153 154 155 156
    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:
157

J
Jon Pascoe 已提交
158
        group :development do
159
          gem 'listen', '~> 3.0.5'
J
Jon Pascoe 已提交
160
        end
161 162 163

    *Puneet Agarwal* and *Xavier Noria*

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

167
    *Jon Pascoe*
J
Jon Pascoe 已提交
168

169
*   Updated `parameterize` to preserve the case of a string, optionally.
170 171 172

    Example:

173 174
        parameterize("Donald E. Knuth", separator: '_') # => "donald_e_knuth"
        parameterize("Donald E. Knuth", preserve_case: true) # => "Donald-E-Knuth"
175 176 177

    *Swaathi Kakarla*

178 179 180 181 182 183
*   `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*

184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
*   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*

200
*   Handle invalid UTF-8 strings when HTML escaping.
201 202 203 204 205 206 207 208

    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 已提交
209 210 211 212 213
*   Update `ActiveSupport::Multibyte::Chars#slice!` to return `nil` if the
    arguments are out of bounds, to mirror the behavior of `String#slice!`

    *Gourav Tiwari*

214 215
*   Fix `number_to_human` so that 999999999 rounds to "1 Billion" instead of
    "1000 Million".
M
Max Jacobson 已提交
216 217 218

    *Max Jacobson*

219 220 221 222 223
*   Fix `ActiveSupport::Deprecation#deprecate_methods` to report using the
    current deprecator instance, where applicable.

    *Brandon Dunne*

224 225 226 227
*   `Cache#fetch` instrumentation marks whether it was a `:hit`.

    *Robin Clowers*

228 229 230 231 232 233 234 235 236 237 238
*   `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*

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

241
    Fixes #21657.
242 243 244

    *Andrew White*

245 246 247 248 249
*   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 已提交
250 251 252
*   Updated Unicode version to 8.0.0

    *Anshul Sharma*
253

254 255 256 257 258
*   `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:

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

262
    *Vipul A M*
263

264 265 266 267
*   Deprecate `:prefix` option of `number_to_human_size` with no replacement.

    *Jean Boussier*

268 269 270 271 272 273 274 275
*   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*

276 277 278
*   ActiveSupport::HashWithIndifferentAccess `select` and `reject` will now return
    enumerator if called without block.

279
    Fixes #20095.
280 281 282

    *Bernard Potocki*

283 284 285 286 287
*   Removed `ActiveSupport::Concurrency::Latch`, superseded by `Concurrent::CountDownLatch`
    from the concurrent-ruby gem.

    *Jerry D'Antonio*

Y
yuuji.yaginuma 已提交
288
*   Fix not calling `#default` on `HashWithIndifferentAccess#to_hash` when only
289 290 291 292
    `default_proc` is set, which could raise.

    *Simon Eskildsen*

293
*   Fix setting `default_proc` on `HashWithIndifferentAccess#dup`.
294 295 296

    *Simon Eskildsen*

297
*   Fix a range of values for parameters of the Time#change.
298 299 300

    *Nikolay Kondratyev*

K
Kevin Deisz 已提交
301 302 303 304 305 306 307
*   Add `Enumerable#pluck` to get the same values from arrays as from ActiveRecord
    associations.

    Fixes #20339.

    *Kevin Deisz*

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

311 312
    Before:

A
Aditya Sanghi 已提交
313
        if (slack_url = Rails.application.secrets.slack_url).present?
314
          # Do something worthwhile
315
        else
316
          # Raise as important secret password is not specified
317 318 319 320 321 322 323 324
        end

    After:

        slack_url = Rails.application.secrets.slack_url!

    *Aditya Sanghi*, *Gaurish Sharma*

325 326
*   Remove deprecated `Class#superclass_delegating_accessor`.
    Use `Class#class_attribute` instead.
327 328 329

    *Akshay Vishnoi*

330
*   Patch `Delegator` to work with `#try`.
331

332
    Fixes #5790.
333 334 335

    *Nate Smith*

336 337 338 339
*   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?)`.
340 341 342

    *DHH*

343
*   Encoding `ActiveSupport::TimeWithZone` to YAML now preserves the timezone information.
344 345 346 347 348

    Fixes #9183.

    *Andrew White*

349 350 351 352 353
*   Added `ActiveSupport::TimeZone#strptime` to allow parsing times as if
    from a given timezone.

    *Paul A Jungwirth*

354 355 356 357 358
*   `ActiveSupport::Callbacks#skip_callback` now raises an `ArgumentError` if
    an unrecognized callback is removed.

    *Iain Beeston*

359
*   Added `ActiveSupport::ArrayInquirer` and `Array#inquiry`.
360 361 362 363 364 365 366 367 368 369 370 371 372 373

    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

374 375 376
    `Array#inquiry` is a shortcut for wrapping the receiving array in an
    `ArrayInquirer`.

377 378
    *George Claghorn*

Y
Yves Senn 已提交
379 380
*   Deprecate `alias_method_chain` in favour of `Module#prepend` introduced in
    Ruby 2.0.
381 382 383

    *Kir Shatrov*

T
Todd Bealmear 已提交
384 385 386 387 388
*   Added `#without` on `Enumerable` and `Array` to return a copy of an
    enumerable without the specified elements.

    *Todd Bealmear*

K
karanarora 已提交
389
*   Fixed a problem where `String#truncate_words` would get stuck with a complex
390 391 392 393
    string.

    *Henrik Nygren*

K
karanarora 已提交
394
*   Fixed a roundtrip problem with `AS::SafeBuffer` where primitive-like strings
395 396 397 398
    will be dumped as primitives:

    Before:

399 400 401 402 403
        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
404

405
    After:
406

407 408 409 410 411
        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"
412 413 414

    *Godfrey Chan*

415 416
*   Enable `number_to_percentage` to keep the number's precision by allowing
    `:precision` to be `nil`.
417

418
    *Jack Xu*
419

420
*   `config_accessor` became a private method, as with Ruby's `attr_accessor`.
421 422 423

    *Akira Matsuda*

424 425 426 427 428
*   `AS::Testing::TimeHelpers#travel_to` now changes `DateTime.now` as well as
    `Time.now` and `Date.today`.

    *Yuki Nishijima*

429 430 431 432 433 434 435 436
*   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*

437 438 439 440
*   Return value of yielded block in `File.atomic_write`.

    *Ian Ker-Seymer*

K
karanarora 已提交
441
*   Duplicate frozen array when assigning it to a `HashWithIndifferentAccess` so
442 443 444 445 446 447
    that it doesn't raise a `RuntimeError` when calling `map!` on it in `convert_value`.

    Fixes #18550.

    *Aditya Kapoor*

448 449 450 451 452
*   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 已提交
453 454
*   Add `SecureRandom.base58` for generation of random base58 strings.

455
    *Matthew Draper*, *Guillermo Iguaran*
G
Guillermo Iguaran 已提交
456

457 458 459 460 461
*   Add `#prev_day` and `#next_day` counterparts to `#yesterday` and
    `#tomorrow` for `Date`, `Time`, and `DateTime`.

    *George Claghorn*

462 463 464 465 466
*   Add `same_time` option to `#next_week` and `#prev_week` for `Date`, `Time`,
    and `DateTime`.

    *George Claghorn*

467 468 469
*   Add `#on_weekend?`, `#next_weekday`, `#prev_weekday` methods to `Date`,
    `Time`, and `DateTime`.

K
karanarora 已提交
470
    `#on_weekend?` returns `true` if the receiving date/time falls on a Saturday
471 472 473 474 475 476 477 478 479 480
    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*

481 482 483 484
*   Change the default test order from `:sorted` to `:random`.

    *Rafael Mendonça França*

485 486 487 488
*   Remove deprecated `ActiveSupport::JSON::Encoding::CircularReferenceError`.

    *Rafael Mendonça França*

489 490 491 492 493
*   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*

494 495 496 497
*   Remove deprecated `ActiveSupport::SafeBuffer#prepend`.

    *Rafael Mendonça França*

498 499 500 501 502 503
*   Remove deprecated methods at `Kernel`.

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

    *Rafael Mendonça França*

504 505 506 507 508
*   Remove deprecated `active_support/core_ext/big_decimal/yaml_conversions`
    file.

    *Rafael Mendonça França*

509 510 511 512 513
*   Remove deprecated methods `ActiveSupport::Cache::Store.instrument` and
    `ActiveSupport::Cache::Store.instrument=`.

    *Rafael Mendonça França*

514
*   Change the way in which callback chains can be halted.
515

516 517
    The preferred method to halt a callback chain from now on is to explicitly
    `throw(:abort)`.
518 519
    In the past, callbacks could only be halted by explicitly providing a
    terminator and by having a callback match the conditions of the terminator.
520

521
*   Add `ActiveSupport.halt_callback_chains_on_return_false`
522

523
    Setting `ActiveSupport.halt_callback_chains_on_return_false`
524
    to `true` will let an app support the deprecated way of halting Active Record,
525
    and Active Model callback chains by returning `false`.
526

K
karanarora 已提交
527
    Setting the value to `false` will tell the app to ignore any `false` value
528
    returned by those callbacks, and only halt the chain upon `throw(:abort)`.
529 530 531 532 533

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

535
    *claudiob*, *Roque Pinel*
536

K
karanarora 已提交
537
*   Changes arguments and default value of CallbackChain's `:terminator` option
538 539 540 541 542 543

    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
544
    terminator's expectation.
545 546 547

    *claudiob*

548 549 550 551 552 553 554
*   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 已提交
555 556
*   Add support for error dispatcher classes in `ActiveSupport::Rescuable`.
    Now it acts closer to Ruby's rescue.
557

558 559
    Example:

560 561 562 563 564 565 566 567 568 569 570 571 572 573
        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 已提交
574
*   Add `#verified` and `#valid_message?` methods to `ActiveSupport::MessageVerifier`
575

R
Robin Dupret 已提交
576 577 578 579
    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.
580

R
Robin Dupret 已提交
581 582 583
    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.
584

585 586
    *Logan Leger*

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