class Faker::Date
Public Class Methods
Produce a random date in the past (up to N days).
@param days [Integer] The maximum number of days to go into the past. @return [Date]
@example
Faker::Date.backward(days: 14) #=> #<Date: 2019-09-12>
@faker.version 1.0.0
# File lib/faker/default/date.rb, line 98 def backward(legacy_days = NOT_GIVEN, days: 365) warn_for_deprecated_arguments do |keywords| keywords << :days if legacy_days != NOT_GIVEN end from = ::Date.today - days to = ::Date.today - 1 between(from: from, to: to).to_date end
Produce a random date between two dates.
@param from [Date] The start of the usable date range. @param to [Date] The end of the usable date range. @return [Date]
@example
Faker::Date.between(from: 2.days.ago, to: Date.today) #=> #<Date: 2014-09-24>
@faker.version 1.0.0
# File lib/faker/default/date.rb, line 18 def between(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, from:, to:) warn_for_deprecated_arguments do |keywords| keywords << :from if legacy_from != NOT_GIVEN keywords << :to if legacy_to != NOT_GIVEN end from = get_date_object(from) to = get_date_object(to) Faker::Base.rand_in_range(from, to) end
Produce a random date between two dates.
@param from [Date] The start of the usable date range. @param to [Date] The end of the usable date range. @param excepted [Date] A date to exclude. @return [Date]
@example
Faker::Date.between_except(from: 1.year.ago, to: 1.year.from_now, excepted: Date.today) #=> #<Date: 2014-10-03>
@faker.version 1.6.2
# File lib/faker/default/date.rb, line 45 def between_except(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, legacy_excepted = NOT_GIVEN, from:, to:, excepted:) warn_for_deprecated_arguments do |keywords| keywords << :from if legacy_from != NOT_GIVEN end warn_for_deprecated_arguments do |keywords| keywords << :to if legacy_to != NOT_GIVEN end warn_for_deprecated_arguments do |keywords| keywords << :excepted if legacy_excepted != NOT_GIVEN end raise ArgumentError, 'From date, to date and excepted date must not be the same' if from == to && to == excepted excepted = get_date_object(excepted) loop do date = between(from: from, to: to) break date.to_date if date != excepted end end
Produce a random date in the past (up to N days).
@param min_age [Integer] The minimum age that the birthday would imply. @param max_age [Integer] The maximum age that the birthday would imply. @return [Date]
@example
Faker::Date.birthday(min_age: 18, max_age: 65) #=> #<Date: 1986-03-28>
@faker.version 1.4.3
# File lib/faker/default/date.rb, line 120 def birthday(legacy_min_age = NOT_GIVEN, legacy_max_age = NOT_GIVEN, min_age: 18, max_age: 65) warn_for_deprecated_arguments do |keywords| keywords << :min_age if legacy_min_age != NOT_GIVEN end warn_for_deprecated_arguments do |keywords| keywords << :max_age if legacy_max_age != NOT_GIVEN end t = ::Date.today from = birthday_date(t, max_age) to = birthday_date(t, min_age) between(from: from, to: to).to_date end
Produce a random date in the future (up to N days).
@param days [Integer] The maximum number of days to go into the future. @return [Date]
@example
Faker::Date.forward(days: 23) #=> #<Date: 2014-10-03>
@faker.version 1.0.0
# File lib/faker/default/date.rb, line 77 def forward(legacy_days = NOT_GIVEN, days: 365) warn_for_deprecated_arguments do |keywords| keywords << :days if legacy_days != NOT_GIVEN end from = ::Date.today + 1 to = ::Date.today + days between(from: from, to: to).to_date end
Produces a date in the year and/or month specified.
@param month [Integer] represents the month of the date @param year [Integer] represents the year of the date @return [Date]
@example
Faker::Date.in_date_period #=> #<Date: 2019-09-01>
@example
Faker::Date.in_date_period(year: 2018, month: 2) #=> #<Date: 2018-02-26>
@example
Faker::Date.in_date_period(month: 2) #=> #<Date: 2019-02-26>
@faker.version next
# File lib/faker/default/date.rb, line 153 def in_date_period(month: nil, year: ::Date.today.year) from = ::Date.new(year, month || 1, 1) to = ::Date.new(year, month || 12, ::Date.civil(year, month || 12, -1).day) between(from: from, to: to).to_date end
Private Class Methods
# File lib/faker/default/date.rb, line 162 def birthday_date(date, age) year = date.year - age day = if date.day == 29 && date.month == 2 && !::Date.leap?(year) 28 else date.day end ::Date.new(year, date.month, day) end
# File lib/faker/default/date.rb, line 175 def get_date_object(date) date = ::Date.parse(date) if date.is_a?(::String) date = date.to_date if date.respond_to?(:to_date) date end