Spec-Zone.ru › Ruby on Rails 8.1

модуль ActiveSupport::Testing::TimeHelpers

Содержит вспомогательные методы для тестирования хода времени.

Публичные методы экземпляра

after_teardown () Показать исходный код
# File activesupport/lib/active_support/testing/time_helpers.rb, line 69
def after_teardown
  travel_back
  super
end
Вызывает метод суперкласса
freeze_time (date_or_time = Time.now, with_usec: false, &block) Показать исходный код
# File activesupport/lib/active_support/testing/time_helpers.rb, line 261
def freeze_time(date_or_time = Time.now, with_usec: false, &block)
  travel_to date_or_time, with_usec: with_usec, &block
end

Вызывает travel_to с date_or_time, значение по умолчанию — Time.now. Передаёт необязательный аргумент with_usec.

Time.current # => Sun, 09 Jul 2017 15:34:49 EST -05:00
freeze_time
sleep(1)
Time.current # => Sun, 09 Jul 2017 15:34:49 EST -05:00
freeze_time Time.current + 1.day
sleep(1)
Time.current # => Mon, 10 Jul 2017 15:34:49 EST -05:00

Этот метод также принимает блок, по завершении которого текущее время возвращается в исходное состояние:

Time.current # => Sun, 09 Jul 2017 15:34:49 EST -05:00
freeze_time do
  sleep(1)
  User.create.created_at # => Sun, 09 Jul 2017 15:34:49 EST -05:00
end
Time.current # => Sun, 09 Jul 2017 15:34:50 EST -05:00
travel (duration, with_usec: false, &block) Показать исходный код
# File activesupport/lib/active_support/testing/time_helpers.rb, line 97
def travel(duration, with_usec: false, &block)
  travel_to Time.now + duration, with_usec: with_usec, &block
end

Изменяет текущее время на заданный интервал в будущее или прошлое, подменяя Time.now, Date.today и DateTime.now. Подмены автоматически удаляются по завершении теста.

Обратите внимание: микросекунды результирующего времени будут равны 0, чтобы избежать ошибок округления при работе с внешними сервисами, например MySQL (который округляет, а не отбрасывает дробную часть, что может привести к ошибке на одну секунду), если только аргумент with_usec не установлен в true.

Time.current     # => Sat, 09 Nov 2013 15:34:49 EST -05:00
travel 1.day
Time.current     # => Sun, 10 Nov 2013 15:34:49 EST -05:00
Date.current     # => Sun, 10 Nov 2013
DateTime.current # => Sun, 10 Nov 2013 15:34:49 -0500

Этот метод также принимает блок, по завершении которого текущее время возвращается в исходное состояние:

Time.current # => Sat, 09 Nov 2013 15:34:49 EST -05:00
travel 1.day do
  User.create.created_at # => Sun, 10 Nov 2013 15:34:49 EST -05:00
end
Time.current # => Sat, 09 Nov 2013 15:34:49 EST -05:00
travel_back () { || ... } Показать исходный код
# File activesupport/lib/active_support/testing/time_helpers.rb, line 231
def travel_back
  stubbed_time = Time.current if block_given? && simple_stubs.stubbed?

  simple_stubs.unstub_all!
  yield if block_given?
ensure
  travel_to stubbed_time if stubbed_time
end

Возвращает текущее время в исходное состояние, удаляя подмены, добавленные методами travel, travel_to и freeze_time.

Time.current # => Sat, 09 Nov 2013 15:34:49 EST -05:00

travel_to Time.zone.local(2004, 11, 24, 1, 4, 44)
Time.current # => Wed, 24 Nov 2004 01:04:44 EST -05:00

travel_back
Time.current # => Sat, 09 Nov 2013 15:34:49 EST -05:00

Этот метод также принимает блок, по завершении которого подмены восстанавливаются:

Time.current # => Sat, 09 Nov 2013 15:34:49 EST -05:00

travel_to Time.zone.local(2004, 11, 24, 1, 4, 44)
Time.current # => Wed, 24 Nov 2004 01:04:44 EST -05:00

travel_back do
  Time.current # => Sat, 09 Nov 2013 15:34:49 EST -05:00
end

Time.current # => Wed, 24 Nov 2004 01:04:44 EST -05:00
Также имеет псевдоним: unfreeze_time
travel_to (date_or_time, with_usec: false) { || ... } Показать исходный код
# File activesupport/lib/active_support/testing/time_helpers.rb, line 133
      def travel_to(date_or_time, with_usec: false)
        if block_given? && in_block
          travel_to_nested_block_call = <<~MSG

      Calling `travel_to` with a block, when we have previously already made a call to `travel_to`, can lead to confusing time stubbing.

      Instead of:

         travel_to 2.days.from_now do
           # 2 days from today
           travel_to 3.days.from_now do
             # 5 days from today
           end
         end

      preferred way to achieve above is:

         travel 2.days do
           # 2 days from today
         end

         travel 5.days do
           # 5 days from today
         end

          MSG
          raise travel_to_nested_block_call
        end

        if date_or_time.is_a?(Date) && !date_or_time.is_a?(DateTime)
          now = date_or_time.midnight.to_time
        elsif date_or_time.is_a?(String)
          now = Time.zone.parse(date_or_time)
        else
          now = date_or_time
          now = now.to_time unless now.is_a?(Time)
        end

        now = now.change(usec: 0) unless with_usec

        # +now+ must be in local system timezone, because +Time.at(now)+
        # and +now.to_date+ (see stubs below) will use +now+'s timezone too!
        now = now.getlocal

        stubs = simple_stubs
        stubbed_time = Time.now if stubs.stubbing(Time, :now)
        stubs.stub_object(Time, :now) { at(now) }

        stubs.stub_object(Time, :new) do |*args, **options|
          if args.empty? && options.empty?
            at(now)
          else
            stub = stubs.stubbing(Time, :new)
            Time.send(stub.original_method, *args, **options)
          end
        end

        stubs.stub_object(Date, :today) { jd(now.to_date.jd) }
        stubs.stub_object(DateTime, :now) { jd(now.to_date.jd, now.hour, now.min, now.sec, Rational(now.utc_offset, 86400)) }

        if block_given?
          begin
            self.in_block = true
            yield
          ensure
            if stubbed_time
              travel_to stubbed_time
            else
              travel_back
            end
            self.in_block = false
          end
        end
      end

Изменяет текущее время на заданное, подменяя Time.now, Time.new, Date.today и DateTime.now так, чтобы они возвращали время или дату, переданные этому методу. Подмены автоматически удаляются по завершении теста.

Time.current     # => Sat, 09 Nov 2013 15:34:49 EST -05:00
travel_to Time.zone.local(2004, 11, 24, 1, 4, 44)
Time.current     # => Wed, 24 Nov 2004 01:04:44 EST -05:00
Date.current     # => Wed, 24 Nov 2004
DateTime.current # => Wed, 24 Nov 2004 01:04:44 -0500

Даты рассматриваются как временная метка в начале дня в часовом поясе приложения. Time.current возвращает эту временную метку, а Time.now — её эквивалент в системном часовом поясе. Аналогично, Date.current возвращает дату, равную аргументу, а Date.today — дату согласно Time.now, которая может отличаться. (Обратите внимание: обычно вам не нужно работать с Time.now или Date.today; чтобы учитывать часовой пояс приложения, всегда используйте Time.current и Date.current.)

Обратите внимание: микросекунды переданного времени будут равны 0, чтобы избежать ошибок округления при работе с внешними сервисами, например MySQL (который округляет, а не отбрасывает дробную часть, что может привести к ошибке на одну секунду), если только аргумент with_usec не установлен в true.

Этот метод также принимает блок, по завершении которого текущее время возвращается в исходное состояние:

Time.current # => Sat, 09 Nov 2013 15:34:49 EST -05:00
travel_to Time.zone.local(2004, 11, 24, 1, 4, 44) do
  Time.current # => Wed, 24 Nov 2004 01:04:44 EST -05:00
end
Time.current # => Sat, 09 Nov 2013 15:34:49 EST -05:00
unfreeze_time ()
Псевдоним для: travel_back

© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API