CHANGELOG.md 15.6 KB
Newer Older
1 2 3 4 5
*   Support extended grapheme clusters and UAX 29.

    *Adam Roben*


6 7
## Rails 5.0.0.beta1 (December 18, 2015) ##

8
*   Add petabyte and exabyte numeric conversion.
E
eileencodes 已提交
9 10 11

    *Akshay Vishnoi*

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

    module Current
      thread_mattr_accessor :account
      thread_mattr_accessor :user
22

23 24 25
      def self.reset() self.account = self.user = nil end
    end

26
    class ApplicationController < ActionController::Base
27 28
      before_action :set_current
      after_action { Current.reset }
29

30 31 32
      private
        def set_current
          Current.account = Account.find(params[:account_id])
33
          Current.user    = Current.account.users.find(params[:user_id])
34 35 36 37 38 39 40 41 42 43 44 45
        end
    end

    class MessagesController < ApplicationController
      def create
        @message = Message.create!(message_params)
      end
    end

    class Message < ApplicationRecord
      has_many :events
      after_create :track_created
46

47 48 49 50 51 52 53
      private
        def track_created
          events.create! origin: self, action: :create
        end
    end

    class Event < ApplicationRecord
54 55
      belongs_to :creator, class_name: 'User'
      before_validation { self.creator ||= Current.user }
56 57 58 59 60
    end

    *DHH*


61 62 63 64 65
*   Deprecated `Module#qualified_const_` in favour of the builtin Module#const_
    methods.

    *Genadi Samokovarov*

66 67 68 69
*   Deprecate passing string to define callback.

    *Yuichiro Kaneko*

70 71 72
*   `ActiveSupport::Cache::Store#namespaced_key`,
    `ActiveSupport::Cache::MemCachedStore#escape_key`, and
    `ActiveSupport::Cache::FileStore#key_file_path`
73
    are deprecated and replaced with `normalize_key` that now calls `super`.
74

75
    `ActiveSupport::Cache::LocaleCache#set_cache_value` is deprecated and replaced with `write_cache_value`.
76

77 78
    *Michael Grosser*

79 80
*   Implements an evented file watcher to asynchronously detect changes in the
    application source code, routes, locales, etc.
81

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

J
Jon Pascoe 已提交
89
        group :development do
90
          gem 'listen', '~> 3.0.5'
J
Jon Pascoe 已提交
91
        end
92 93 94

    *Puneet Agarwal* and *Xavier Noria*

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

98
    *Jon Pascoe*
J
Jon Pascoe 已提交
99

100
*   Updated `parameterize` to preserve the case of a string, optionally.
101 102 103

    Example:

104 105
        parameterize("Donald E. Knuth", separator: '_') # => "donald_e_knuth"
        parameterize("Donald E. Knuth", preserve_case: true) # => "Donald-E-Knuth"
106 107 108

    *Swaathi Kakarla*

109 110 111 112 113 114
*   `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*

115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
*   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*

131
*   Handle invalid UTF-8 strings when HTML escaping.
132 133 134 135 136 137 138 139

    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 已提交
140 141 142 143 144
*   Update `ActiveSupport::Multibyte::Chars#slice!` to return `nil` if the
    arguments are out of bounds, to mirror the behavior of `String#slice!`

    *Gourav Tiwari*

145 146
*   Fix `number_to_human` so that 999999999 rounds to "1 Billion" instead of
    "1000 Million".
M
Max Jacobson 已提交
147 148 149

    *Max Jacobson*

150 151 152 153 154
*   Fix `ActiveSupport::Deprecation#deprecate_methods` to report using the
    current deprecator instance, where applicable.

    *Brandon Dunne*

155 156 157 158
*   `Cache#fetch` instrumentation marks whether it was a `:hit`.

    *Robin Clowers*

159 160 161 162 163 164 165 166 167 168 169
*   `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*

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

172
    Fixes #21657.
173 174 175

    *Andrew White*

176 177 178 179 180
*   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 已提交
181 182 183
*   Updated Unicode version to 8.0.0

    *Anshul Sharma*
184

185 186 187 188 189
*   `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:

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

193
    *Vipul A M*
194

195 196 197 198
*   Deprecate `:prefix` option of `number_to_human_size` with no replacement.

    *Jean Boussier*

199 200 201 202 203 204 205 206
*   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*

207 208 209
*   ActiveSupport::HashWithIndifferentAccess `select` and `reject` will now return
    enumerator if called without block.

210
    Fixes #20095.
211 212 213

    *Bernard Potocki*

214 215 216 217 218
*   Removed `ActiveSupport::Concurrency::Latch`, superseded by `Concurrent::CountDownLatch`
    from the concurrent-ruby gem.

    *Jerry D'Antonio*

Y
yuuji.yaginuma 已提交
219
*   Fix not calling `#default` on `HashWithIndifferentAccess#to_hash` when only
220 221 222 223
    `default_proc` is set, which could raise.

    *Simon Eskildsen*

224
*   Fix setting `default_proc` on `HashWithIndifferentAccess#dup`.
225 226 227

    *Simon Eskildsen*

228
*   Fix a range of values for parameters of the Time#change.
229 230 231

    *Nikolay Kondratyev*

K
Kevin Deisz 已提交
232 233 234 235 236 237 238
*   Add `Enumerable#pluck` to get the same values from arrays as from ActiveRecord
    associations.

    Fixes #20339.

    *Kevin Deisz*

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

242 243
    Before:

A
Aditya Sanghi 已提交
244
        if (slack_url = Rails.application.secrets.slack_url).present?
245
          # Do something worthwhile
246
        else
247
          # Raise as important secret password is not specified
248 249 250 251 252 253 254 255
        end

    After:

        slack_url = Rails.application.secrets.slack_url!

    *Aditya Sanghi*, *Gaurish Sharma*

256 257
*   Remove deprecated `Class#superclass_delegating_accessor`.
    Use `Class#class_attribute` instead.
258 259 260

    *Akshay Vishnoi*

261
*   Patch `Delegator` to work with `#try`.
262

263
    Fixes #5790.
264 265 266

    *Nate Smith*

267 268 269 270
*   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?)`.
271 272 273

    *DHH*

274
*   Encoding `ActiveSupport::TimeWithZone` to YAML now preserves the timezone information.
275 276 277 278 279

    Fixes #9183.

    *Andrew White*

280 281 282 283 284
*   Added `ActiveSupport::TimeZone#strptime` to allow parsing times as if
    from a given timezone.

    *Paul A Jungwirth*

285 286 287 288 289
*   `ActiveSupport::Callbacks#skip_callback` now raises an `ArgumentError` if
    an unrecognized callback is removed.

    *Iain Beeston*

290
*   Added `ActiveSupport::ArrayInquirer` and `Array#inquiry`.
291 292 293 294 295 296 297 298 299 300 301 302 303 304

    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

305 306 307
    `Array#inquiry` is a shortcut for wrapping the receiving array in an
    `ArrayInquirer`.

308 309
    *George Claghorn*

Y
Yves Senn 已提交
310 311
*   Deprecate `alias_method_chain` in favour of `Module#prepend` introduced in
    Ruby 2.0.
312 313 314

    *Kir Shatrov*

T
Todd Bealmear 已提交
315 316 317 318 319
*   Added `#without` on `Enumerable` and `Array` to return a copy of an
    enumerable without the specified elements.

    *Todd Bealmear*

K
karanarora 已提交
320
*   Fixed a problem where `String#truncate_words` would get stuck with a complex
321 322 323 324
    string.

    *Henrik Nygren*

K
karanarora 已提交
325
*   Fixed a roundtrip problem with `AS::SafeBuffer` where primitive-like strings
326 327 328 329
    will be dumped as primitives:

    Before:

330 331 332 333 334
        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
335

336
    After:
337

338 339 340 341 342
        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"
343 344 345

    *Godfrey Chan*

346 347
*   Enable `number_to_percentage` to keep the number's precision by allowing
    `:precision` to be `nil`.
348

349
    *Jack Xu*
350

351
*   `config_accessor` became a private method, as with Ruby's `attr_accessor`.
352 353 354

    *Akira Matsuda*

355 356 357 358 359
*   `AS::Testing::TimeHelpers#travel_to` now changes `DateTime.now` as well as
    `Time.now` and `Date.today`.

    *Yuki Nishijima*

360 361 362 363 364 365 366 367
*   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*

368 369 370 371
*   Return value of yielded block in `File.atomic_write`.

    *Ian Ker-Seymer*

K
karanarora 已提交
372
*   Duplicate frozen array when assigning it to a `HashWithIndifferentAccess` so
373 374 375 376 377 378
    that it doesn't raise a `RuntimeError` when calling `map!` on it in `convert_value`.

    Fixes #18550.

    *Aditya Kapoor*

379 380 381 382 383
*   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 已提交
384 385
*   Add `SecureRandom.base58` for generation of random base58 strings.

386
    *Matthew Draper*, *Guillermo Iguaran*
G
Guillermo Iguaran 已提交
387

388 389 390 391 392
*   Add `#prev_day` and `#next_day` counterparts to `#yesterday` and
    `#tomorrow` for `Date`, `Time`, and `DateTime`.

    *George Claghorn*

393 394 395 396 397
*   Add `same_time` option to `#next_week` and `#prev_week` for `Date`, `Time`,
    and `DateTime`.

    *George Claghorn*

398 399 400
*   Add `#on_weekend?`, `#next_weekday`, `#prev_weekday` methods to `Date`,
    `Time`, and `DateTime`.

K
karanarora 已提交
401
    `#on_weekend?` returns `true` if the receiving date/time falls on a Saturday
402 403 404 405 406 407 408 409 410 411
    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*

412 413 414 415
*   Change the default test order from `:sorted` to `:random`.

    *Rafael Mendonça França*

416 417 418 419
*   Remove deprecated `ActiveSupport::JSON::Encoding::CircularReferenceError`.

    *Rafael Mendonça França*

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

425 426 427 428
*   Remove deprecated `ActiveSupport::SafeBuffer#prepend`.

    *Rafael Mendonça França*

429 430 431 432 433 434
*   Remove deprecated methods at `Kernel`.

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

    *Rafael Mendonça França*

435 436 437 438 439
*   Remove deprecated `active_support/core_ext/big_decimal/yaml_conversions`
    file.

    *Rafael Mendonça França*

440 441 442 443 444
*   Remove deprecated methods `ActiveSupport::Cache::Store.instrument` and
    `ActiveSupport::Cache::Store.instrument=`.

    *Rafael Mendonça França*

445
*   Change the way in which callback chains can be halted.
446

447 448
    The preferred method to halt a callback chain from now on is to explicitly
    `throw(:abort)`.
449 450
    In the past, callbacks could only be halted by explicitly providing a
    terminator and by having a callback match the conditions of the terminator.
451

452
*   Add `ActiveSupport.halt_callback_chains_on_return_false`
453

454
    Setting `ActiveSupport.halt_callback_chains_on_return_false`
455
    to `true` will let an app support the deprecated way of halting Active Record,
456
    and Active Model callback chains by returning `false`.
457

K
karanarora 已提交
458
    Setting the value to `false` will tell the app to ignore any `false` value
459
    returned by those callbacks, and only halt the chain upon `throw(:abort)`.
460 461 462 463 464

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

466
    *claudiob*, *Roque Pinel*
467

K
karanarora 已提交
468
*   Changes arguments and default value of CallbackChain's `:terminator` option
469 470 471 472 473 474

    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
475
    terminator's expectation.
476 477 478

    *claudiob*

479 480 481 482 483 484 485
*   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 已提交
486 487
*   Add support for error dispatcher classes in `ActiveSupport::Rescuable`.
    Now it acts closer to Ruby's rescue.
488

489 490
    Example:

491 492 493 494 495 496 497 498 499 500 501 502 503 504
        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 已提交
505
*   Add `#verified` and `#valid_message?` methods to `ActiveSupport::MessageVerifier`
506

R
Robin Dupret 已提交
507 508 509 510
    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.
511

R
Robin Dupret 已提交
512 513 514
    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.
515

516 517
    *Logan Leger*

518 519 520 521 522 523
*   Adds `:exception_object` key to ActiveSupport::Notifications::Instrumenter payload when an exception is raised

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

    *Ryan T. Hosford*

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