CHANGELOG.md 16.7 KB
Newer Older
1 2 3 4 5 6 7
*   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.
    
    *Vipul A M*

8 9 10 11
*   Add `Array#second_to_last` and `Array#third_to_last` methods.

    *Brian Christian*

12
*  Fix regression in `Hash#dig` for HashWithIndifferentAccess.
13

14 15
   *Jon Moss*

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

18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
*   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*

33
*   Match `HashWithIndifferentAccess#default`'s behaviour with `Hash#default`.
34 35 36

    *David Cornu*

37 38
*   Adds `:exception_object` key to `ActiveSupport::Notifications::Instrumenter`
    payload when an exception is raised.
39

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

    *Ryan T. Hosford*

45 46 47 48
*   Support extended grapheme clusters and UAX 29.

    *Adam Roben*

49
*   Add petabyte and exabyte numeric conversion.
E
eileencodes 已提交
50 51 52

    *Akshay Vishnoi*

53 54
## Rails 5.0.0.beta1 (December 18, 2015) ##

55 56 57 58 59 60 61
*   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:

62 63 64
        module Current
          thread_mattr_accessor :account
          thread_mattr_accessor :user
65

66 67
          def self.reset() self.account = self.user = nil end
        end
68

69 70 71
        class ApplicationController < ActionController::Base
          before_action :set_current
          after_action { Current.reset }
72

73 74 75 76 77
          private
            def set_current
              Current.account = Account.find(params[:account_id])
              Current.user    = Current.account.users.find(params[:user_id])
            end
78 79
        end

80 81 82 83 84
        class MessagesController < ApplicationController
          def create
            @message = Message.create!(message_params)
          end
        end
85

86 87 88
        class Message < ApplicationRecord
          has_many :events
          after_create :track_created
89

90 91 92 93
          private
            def track_created
              events.create! origin: self, action: :create
            end
94 95
        end

96 97 98 99
        class Event < ApplicationRecord
          belongs_to :creator, class_name: 'User'
          before_validation { self.creator ||= Current.user }
        end
100 101 102 103

    *DHH*


104 105 106 107 108
*   Deprecated `Module#qualified_const_` in favour of the builtin Module#const_
    methods.

    *Genadi Samokovarov*

109 110 111 112
*   Deprecate passing string to define callback.

    *Yuichiro Kaneko*

113 114 115
*   `ActiveSupport::Cache::Store#namespaced_key`,
    `ActiveSupport::Cache::MemCachedStore#escape_key`, and
    `ActiveSupport::Cache::FileStore#key_file_path`
116
    are deprecated and replaced with `normalize_key` that now calls `super`.
117

118
    `ActiveSupport::Cache::LocaleCache#set_cache_value` is deprecated and replaced with `write_cache_value`.
119

120 121
    *Michael Grosser*

122 123
*   Implements an evented file watcher to asynchronously detect changes in the
    application source code, routes, locales, etc.
124

125 126 127 128 129 130
    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:
131

J
Jon Pascoe 已提交
132
        group :development do
133
          gem 'listen', '~> 3.0.5'
J
Jon Pascoe 已提交
134
        end
135 136 137

    *Puneet Agarwal* and *Xavier Noria*

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

141
    *Jon Pascoe*
J
Jon Pascoe 已提交
142

143
*   Updated `parameterize` to preserve the case of a string, optionally.
144 145 146

    Example:

147 148
        parameterize("Donald E. Knuth", separator: '_') # => "donald_e_knuth"
        parameterize("Donald E. Knuth", preserve_case: true) # => "Donald-E-Knuth"
149 150 151

    *Swaathi Kakarla*

152 153 154 155 156 157
*   `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*

158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
*   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*

174
*   Handle invalid UTF-8 strings when HTML escaping.
175 176 177 178 179 180 181 182

    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 已提交
183 184 185 186 187
*   Update `ActiveSupport::Multibyte::Chars#slice!` to return `nil` if the
    arguments are out of bounds, to mirror the behavior of `String#slice!`

    *Gourav Tiwari*

188 189
*   Fix `number_to_human` so that 999999999 rounds to "1 Billion" instead of
    "1000 Million".
M
Max Jacobson 已提交
190 191 192

    *Max Jacobson*

193 194 195 196 197
*   Fix `ActiveSupport::Deprecation#deprecate_methods` to report using the
    current deprecator instance, where applicable.

    *Brandon Dunne*

198 199 200 201
*   `Cache#fetch` instrumentation marks whether it was a `:hit`.

    *Robin Clowers*

202 203 204 205 206 207 208 209 210 211 212
*   `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*

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

215
    Fixes #21657.
216 217 218

    *Andrew White*

219 220 221 222 223
*   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 已提交
224 225 226
*   Updated Unicode version to 8.0.0

    *Anshul Sharma*
227

228 229 230 231 232
*   `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:

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

236
    *Vipul A M*
237

238 239 240 241
*   Deprecate `:prefix` option of `number_to_human_size` with no replacement.

    *Jean Boussier*

242 243 244 245 246 247 248 249
*   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*

250 251 252
*   ActiveSupport::HashWithIndifferentAccess `select` and `reject` will now return
    enumerator if called without block.

253
    Fixes #20095.
254 255 256

    *Bernard Potocki*

257 258 259 260 261
*   Removed `ActiveSupport::Concurrency::Latch`, superseded by `Concurrent::CountDownLatch`
    from the concurrent-ruby gem.

    *Jerry D'Antonio*

Y
yuuji.yaginuma 已提交
262
*   Fix not calling `#default` on `HashWithIndifferentAccess#to_hash` when only
263 264 265 266
    `default_proc` is set, which could raise.

    *Simon Eskildsen*

267
*   Fix setting `default_proc` on `HashWithIndifferentAccess#dup`.
268 269 270

    *Simon Eskildsen*

271
*   Fix a range of values for parameters of the Time#change.
272 273 274

    *Nikolay Kondratyev*

K
Kevin Deisz 已提交
275 276 277 278 279 280 281
*   Add `Enumerable#pluck` to get the same values from arrays as from ActiveRecord
    associations.

    Fixes #20339.

    *Kevin Deisz*

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

285 286
    Before:

A
Aditya Sanghi 已提交
287
        if (slack_url = Rails.application.secrets.slack_url).present?
288
          # Do something worthwhile
289
        else
290
          # Raise as important secret password is not specified
291 292 293 294 295 296 297 298
        end

    After:

        slack_url = Rails.application.secrets.slack_url!

    *Aditya Sanghi*, *Gaurish Sharma*

299 300
*   Remove deprecated `Class#superclass_delegating_accessor`.
    Use `Class#class_attribute` instead.
301 302 303

    *Akshay Vishnoi*

304
*   Patch `Delegator` to work with `#try`.
305

306
    Fixes #5790.
307 308 309

    *Nate Smith*

310 311 312 313
*   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?)`.
314 315 316

    *DHH*

317
*   Encoding `ActiveSupport::TimeWithZone` to YAML now preserves the timezone information.
318 319 320 321 322

    Fixes #9183.

    *Andrew White*

323 324 325 326 327
*   Added `ActiveSupport::TimeZone#strptime` to allow parsing times as if
    from a given timezone.

    *Paul A Jungwirth*

328 329 330 331 332
*   `ActiveSupport::Callbacks#skip_callback` now raises an `ArgumentError` if
    an unrecognized callback is removed.

    *Iain Beeston*

333
*   Added `ActiveSupport::ArrayInquirer` and `Array#inquiry`.
334 335 336 337 338 339 340 341 342 343 344 345 346 347

    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

348 349 350
    `Array#inquiry` is a shortcut for wrapping the receiving array in an
    `ArrayInquirer`.

351 352
    *George Claghorn*

Y
Yves Senn 已提交
353 354
*   Deprecate `alias_method_chain` in favour of `Module#prepend` introduced in
    Ruby 2.0.
355 356 357

    *Kir Shatrov*

T
Todd Bealmear 已提交
358 359 360 361 362
*   Added `#without` on `Enumerable` and `Array` to return a copy of an
    enumerable without the specified elements.

    *Todd Bealmear*

K
karanarora 已提交
363
*   Fixed a problem where `String#truncate_words` would get stuck with a complex
364 365 366 367
    string.

    *Henrik Nygren*

K
karanarora 已提交
368
*   Fixed a roundtrip problem with `AS::SafeBuffer` where primitive-like strings
369 370 371 372
    will be dumped as primitives:

    Before:

373 374 375 376 377
        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
378

379
    After:
380

381 382 383 384 385
        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"
386 387 388

    *Godfrey Chan*

389 390
*   Enable `number_to_percentage` to keep the number's precision by allowing
    `:precision` to be `nil`.
391

392
    *Jack Xu*
393

394
*   `config_accessor` became a private method, as with Ruby's `attr_accessor`.
395 396 397

    *Akira Matsuda*

398 399 400 401 402
*   `AS::Testing::TimeHelpers#travel_to` now changes `DateTime.now` as well as
    `Time.now` and `Date.today`.

    *Yuki Nishijima*

403 404 405 406 407 408 409 410
*   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*

411 412 413 414
*   Return value of yielded block in `File.atomic_write`.

    *Ian Ker-Seymer*

K
karanarora 已提交
415
*   Duplicate frozen array when assigning it to a `HashWithIndifferentAccess` so
416 417 418 419 420 421
    that it doesn't raise a `RuntimeError` when calling `map!` on it in `convert_value`.

    Fixes #18550.

    *Aditya Kapoor*

422 423 424 425 426
*   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 已提交
427 428
*   Add `SecureRandom.base58` for generation of random base58 strings.

429
    *Matthew Draper*, *Guillermo Iguaran*
G
Guillermo Iguaran 已提交
430

431 432 433 434 435
*   Add `#prev_day` and `#next_day` counterparts to `#yesterday` and
    `#tomorrow` for `Date`, `Time`, and `DateTime`.

    *George Claghorn*

436 437 438 439 440
*   Add `same_time` option to `#next_week` and `#prev_week` for `Date`, `Time`,
    and `DateTime`.

    *George Claghorn*

441 442 443
*   Add `#on_weekend?`, `#next_weekday`, `#prev_weekday` methods to `Date`,
    `Time`, and `DateTime`.

K
karanarora 已提交
444
    `#on_weekend?` returns `true` if the receiving date/time falls on a Saturday
445 446 447 448 449 450 451 452 453 454
    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*

455 456 457 458
*   Change the default test order from `:sorted` to `:random`.

    *Rafael Mendonça França*

459 460 461 462
*   Remove deprecated `ActiveSupport::JSON::Encoding::CircularReferenceError`.

    *Rafael Mendonça França*

463 464 465 466 467
*   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*

468 469 470 471
*   Remove deprecated `ActiveSupport::SafeBuffer#prepend`.

    *Rafael Mendonça França*

472 473 474 475 476 477
*   Remove deprecated methods at `Kernel`.

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

    *Rafael Mendonça França*

478 479 480 481 482
*   Remove deprecated `active_support/core_ext/big_decimal/yaml_conversions`
    file.

    *Rafael Mendonça França*

483 484 485 486 487
*   Remove deprecated methods `ActiveSupport::Cache::Store.instrument` and
    `ActiveSupport::Cache::Store.instrument=`.

    *Rafael Mendonça França*

488
*   Change the way in which callback chains can be halted.
489

490 491
    The preferred method to halt a callback chain from now on is to explicitly
    `throw(:abort)`.
492 493
    In the past, callbacks could only be halted by explicitly providing a
    terminator and by having a callback match the conditions of the terminator.
494

495
*   Add `ActiveSupport.halt_callback_chains_on_return_false`
496

497
    Setting `ActiveSupport.halt_callback_chains_on_return_false`
498
    to `true` will let an app support the deprecated way of halting Active Record,
499
    and Active Model callback chains by returning `false`.
500

K
karanarora 已提交
501
    Setting the value to `false` will tell the app to ignore any `false` value
502
    returned by those callbacks, and only halt the chain upon `throw(:abort)`.
503 504 505 506 507

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

509
    *claudiob*, *Roque Pinel*
510

K
karanarora 已提交
511
*   Changes arguments and default value of CallbackChain's `:terminator` option
512 513 514 515 516 517

    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
518
    terminator's expectation.
519 520 521

    *claudiob*

522 523 524 525 526 527 528
*   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 已提交
529 530
*   Add support for error dispatcher classes in `ActiveSupport::Rescuable`.
    Now it acts closer to Ruby's rescue.
531

532 533
    Example:

534 535 536 537 538 539 540 541 542 543 544 545 546 547
        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 已提交
548
*   Add `#verified` and `#valid_message?` methods to `ActiveSupport::MessageVerifier`
549

R
Robin Dupret 已提交
550 551 552 553
    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.
554

R
Robin Dupret 已提交
555 556 557
    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.
558

559 560
    *Logan Leger*

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