faker 2.11.0 → 3.4.2

data/lib/faker/default/date.rb

@@ -2,57 +2,46 @@
 
 module Faker
   class Date < Base
+    DAYS_OF_WEEK = %i[sunday monday tuesday wednesday thursday friday saturday].freeze
+
     class << self
       ##
       # 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 from [Date, String] The start of the usable date range.
+      # @param to [Date, String] The end of the usable date range.
       # @return [Date]
       #
-      # @example
-      #   Faker::Date.between(from: 2.days.ago, to: Date.today)
-      #     #=> #<Date: 2014-09-24>
+      # @example if used with or without Rails (Active Support)
+      #   Faker::Date.between(from: '2014-09-23', to: '2014-09-25') #=> #<Date: 2014-09-24>
+      #
+      # @example if used with Rails (Active Support)
+      #   Faker::Date.between(from: 2.days.ago, to: Date.today) #=> #<Date: 2014-09-24>
       #
       # @faker.version 1.0.0
-      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
-
+      def between(from:, to:)
         from = get_date_object(from)
         to   = get_date_object(to)
 
         Faker::Base.rand_in_range(from, to)
       end
 
-      # rubocop:disable Metrics/ParameterLists
-
       ##
       # 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.
+      # @param from [Date, String] The start of the usable date range.
+      # @param to [Date, String] The end of the usable date range.
+      # @param excepted [Date, String] 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>
+      # @example if used with or without Rails (Active Support)
+      #   Faker::Date.between_except(from: '2014-09-23', to: '2015-09-25', excepted: '2015-01-24') #=> #<Date: 2014-10-03>
+      #
+      # @example if used with Rails (Active Support)
+      #   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
-      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
-
+      def between_except(from:, to:, excepted:)
         raise ArgumentError, 'From date, to date and excepted date must not be the same' if from == to && to == excepted
 
         excepted = get_date_object(excepted)
@@ -62,27 +51,30 @@ module Faker
           break date.to_date if date != excepted
         end
       end
-      # rubocop:enable Metrics/ParameterLists
 
       ##
       # Produce a random date in the future (up to N days).
       #
+      # @param from [Integer] The start of the usable forward date range.
       # @param days [Integer] The maximum number of days to go into the future.
       # @return [Date]
       #
-      # @example
+      # @example if used with or without Rails (Active Support)
       #   Faker::Date.forward(days: 23) #=> #<Date: 2014-10-03>
       #
+      # @example if used with Rails (Active Support)
+      #  Faker::Date.forward(from: Date.current, days: 17) #=> #<Date: 2022-06-22>
+      #
+      # @example if used with or without Rails (Active Support)
+      #   Faker::Date.forward(from: '2022-06-03', days: 10) #=> #<Date: 2022-10-13>
+      #
       # @faker.version 1.0.0
-      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
+      def forward(from: ::Date.today, days: 365)
+        start_date = get_date_object(from)
+        since = start_date + 1
+        to = start_date + days
 
-        between(from: from, to: to).to_date
+        between(from: since, to: to).to_date
       end
 
       ##
@@ -95,11 +87,7 @@ module Faker
       #   Faker::Date.backward(days: 14) #=> #<Date: 2019-09-12>
       #
       # @faker.version 1.0.0
-      def backward(legacy_days = NOT_GIVEN, days: 365)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :days if legacy_days != NOT_GIVEN
-        end
-
+      def backward(days: 365)
         from = ::Date.today - days
         to   = ::Date.today - 1
 
@@ -117,14 +105,7 @@ module Faker
       #   Faker::Date.birthday(min_age: 18, max_age: 65) #=> #<Date: 1986-03-28>
       #
       # @faker.version 1.4.3
-      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
-
+      def birthday(min_age: 18, max_age: 65)
         t = ::Date.today
 
         from = birthday_date(t, max_age)
@@ -149,7 +130,7 @@ module Faker
       # @example
       #   Faker::Date.in_date_period(month: 2) #=> #<Date: 2019-02-26>
       #
-      # @faker.version next
+      # @faker.version 2.13.0
       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)
@@ -157,6 +138,52 @@ module Faker
         between(from: from, to: to).to_date
       end
 
+      ##
+      # Produce a random date at given day(s) of the week between two dates.
+      #
+      # @param day [Symbol, Array<Symbol>] # The day(s) of the week. See {DAYS_OF_WEEK}.
+      # @param from [Date, String] The start of the usable date range.
+      # @param to [Date, String] The end of the usable date range.
+      # @return [Date]
+      #
+      # @example if used with or without Rails (Active Support)
+      #   Faker::Date.on_day_of_week_between(day: :tuesday, from: '2023-01-01', to: '2023-02-01') #=> #<Date: 2032-01-10>
+      #
+      # @example if used with Rails (Active Support)
+      #   Faker::Date.on_day_of_week_between(day: [:saturday, :sunday], from: 1.month.ago, to: Date.today) #=> #<Date: 2014-09-24>
+      #
+      # @faker.version next
+      def on_day_of_week_between(day:, from:, to:)
+        days = [day].flatten
+        raise ArgumentError, 'Day of week cannot be empty' if days.empty?
+
+        # Convert given days of the week to numbers used by `Date#wday` method
+        numeric_weekdays = days.map do |d|
+          DAYS_OF_WEEK.index(d.to_sym.downcase) || raise(ArgumentError, "#{d} is not a valid day of the week")
+        end
+
+        from = get_date_object(from)
+        to   = get_date_object(to)
+        date = Faker::Base.rand_in_range(from, to)
+
+        # If the initial date is not on one of the wanted days of the week...
+        unless numeric_weekdays.include? date.wday
+          # ...pick a date nearby that is on one of the wanted days of the week instead
+          date += sample(numeric_weekdays) - date.wday
+
+          # Move date 1 week earlier or later if the adjusted date is now outside the date range
+          date += 7 if date < from
+          date -= 7 if date > to
+
+          if date > to || date < from
+            raise ArgumentError,
+                  "There is no #{DAYS_OF_WEEK[date.wday].capitalize} between #{from} and #{to}. Increase the from/to date range or choose a different day of the week."
+          end
+        end
+
+        date
+      end
+
       private
 
       def birthday_date(date, age)

data/lib/faker/default/demographic.rb

@@ -80,11 +80,7 @@ module Faker
       #   Faker::Demographic.height(unit: :imperial) #=> "6 ft, 2 in"
       #
       # @faker.version 1.7.3
-      def height(legacy_unit = NOT_GIVEN, unit: :metric)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :unit if legacy_unit != NOT_GIVEN
-        end
-
+      def height(unit: :metric)
         case unit
         when :imperial
           inches = rand_in_range(57, 86)

data/lib/faker/default/driving_licence.rb

@@ -6,16 +6,24 @@ module Faker
     NI_CHANCE = 0.03 # NI Pop is about 3% of total UK population
 
     class << self
-      # rubocop:disable Metrics/ParameterLists
-      def british_driving_licence(legacy_last_name = NOT_GIVEN, legacy_initials = NOT_GIVEN, legacy_gender = NOT_GIVEN, legacy_date_of_birth = NOT_GIVEN, last_name: Faker::Name.last_name, initials: Faker::Name.initials, gender: random_gender, date_of_birth: Faker::Date.birthday(min_age: 18, max_age: 65))
-        # rubocop:enable Metrics/ParameterLists
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :last_name if legacy_last_name != NOT_GIVEN
-          keywords << :initials if legacy_initials != NOT_GIVEN
-          keywords << :gender if legacy_gender != NOT_GIVEN
-          keywords << :date_of_birth if legacy_date_of_birth != NOT_GIVEN
-        end
-
+      ##
+      # Produces a random British driving licence number.
+      #
+      # @param last_name [String] The last name of the driving licence's owner.
+      # @param initials [String] The initials of the driving licence's owner.
+      # @param gender [String] The gender of the driving licence's owner.
+      # @param date_of_birth [String] The date of birth of the driving licence's owner.
+      # @return [String]
+      #
+      # @example
+      #   Faker::DrivingLicence.british_driving_licence        #=> "MCDER712081VF7EK"
+      #   Faker::DrivingLicence.british_driving_licence(last_name: "O'Carroll",
+      #                                                 initials: "J",
+      #                                                 gender: :female,
+      #                                                 date_of_birth: Date.parse("1986-10-24")) #=> "OCARR815246J91HT"
+      #
+      # @faker.version 1.9.2
+      def british_driving_licence(last_name: Faker::Name.last_name, initials: Faker::Name.initials, gender: random_gender, date_of_birth: Faker::Date.birthday(min_age: 18, max_age: 65))
         [
           gb_licence_padding(last_name, 5),
           gb_licence_year(date_of_birth, gender),
@@ -24,10 +32,35 @@ module Faker
         ].join
       end
 
+      ##
+      # Produces a random Northern Irish licence number.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::DrivingLicence.northern_irish_driving_licence #=> "70702548"
+      #
+      # @faker.version 1.9.2
       def northern_irish_driving_licence
         Faker::Number.number(digits: 8).to_s
       end
 
+      ##
+      # Produces a random UK driving licence number in either GB or NI format, at a rate consistent with their relative populations
+      #
+      # @overload uk_driving_licence(last_name, initials, gender, date_of_birth)
+      #   @param last_name [String] The last name of the driving licence's owner.
+      #   @param initials [String] The initials of the driving licence's owner.
+      #   @param gender [String] The gender of the driving licence's owner.
+      #   @param date_of_birth [String] The date of birth of the driving licence's owner.
+      # @overload uk_driving_licence()
+      # @return [String]
+      #
+      # @example
+      #   Faker::DrivingLicence.uk_driving_licence             #=> "OCARR815246J91HT"
+      #   Faker::DrivingLicence.uk_driving_licence             #=> "70702548"
+      #
+      # @faker.version 1.9.2
       def uk_driving_licence(*args)
         if Faker::Config.random.rand < NI_CHANCE
           northern_irish_driving_licence
@@ -36,6 +69,23 @@ module Faker
         end
       end
 
+      ##
+      # Produces a random USA driving licence number by state code passed.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::DrivingLicence.usa_driving_licence                 #=> "V5598249"
+      #   Faker::DrivingLicence.usa_driving_licence('new mexico')   #=> "270692028"
+      #   Faker::DrivingLicence.usa_driving_licence('New Mexico')   #=> "68178637"
+      #
+      # @faker.version 2.14.0
+      def usa_driving_licence(state = 'California')
+        bothify(fetch("driving_licence.usa.#{state.to_s.strip.downcase.gsub(' ', '_')}"))
+      rescue I18n::MissingTranslationData => _e
+        raise InvalidStatePassed, "Invalid state code passed for USA, '#{state}'"
+      end
+
       private
 
       def random_gender
@@ -48,18 +98,35 @@ module Faker
       end
 
       def gb_licence_year(dob, gender)
-        decade = (dob.year / 10) % 10
-        year = dob.year % 10
-        month = gender == :female ? dob.month + 50 : dob.month
-        # Rubocop's preferred formatting is pretty gory
-        # rubocop:disable Style/FormatString
-        "#{decade}#{'%02d' % month}#{'%02d' % dob.day}#{year}"
-        # rubocop:enable Style/FormatString
+        generate(:string) do |g|
+          g.computed do
+            (dob.year / 10) % 10
+          end
+          g.computed do
+            gender_marker = gender == :female ? 50 : 0
+            format('%02d', (dob.month + gender_marker))
+          end
+          g.computed do
+            format('%02d', dob.day)
+          end
+          g.computed do
+            dob.year % 10
+          end
+        end
       end
 
       def gb_licence_checksum
-        regexify(/[0-9][A-Z][A-Z]/)
+        generate(:string) do |g|
+          g.int
+          g.letter(ranges: ['A'..'Z'], length: 2)
+        end
       end
     end
   end
+
+  class InvalidStatePassed < StandardError
+    def initialize(msg = 'Invalid state code passed')
+      super
+    end
+  end
 end

data/lib/faker/default/drone.rb

@@ -0,0 +1,332 @@
+# frozen_string_literal: true
+
+module Faker
+  class Drone < Base
+    class << self
+      ##
+      # Returns random drone name with company
+      #
+      # @return [string]
+      #
+      # @example
+      #   Faker::Drone.name #=> "DJI Mavic Air 2"
+      #
+      # @faker.version 2.14.0
+      def name
+        fetch('drone.name')
+      end
+
+      ##
+      # Returns total drone weight in grams
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.weight #=> "570 g"
+      #
+      # @faker.version 2.14.0
+      def weight
+        parse('drone.weight')
+      end
+
+      ##
+      # Returns maximum ascent speed for drone in m/s
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.max_ascent_speed #=> "4 m/s"
+      #
+      # @faker.version 2.14.0
+      def max_ascent_speed
+        parse('drone.max_ascent_speed')
+      end
+
+      ##
+      # Returns maximum descent speed for drone in m/s
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.max_descent_speed #=> "4 m/s"
+      #
+      # @faker.version 2.14.0
+      def max_descent_speed
+        parse('drone.max_descent_speed')
+      end
+
+      ##
+      # Returns max flight time for drone in optimal conditions
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.flight_time #=> "34 min"
+      #
+      # @faker.version 2.14.0
+      def flight_time
+        parse('drone.flight_time')
+      end
+
+      ##
+      # Returns max altitude drone can go above sea level in meters
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.max_altitude #=> "5000 m"
+      #
+      # @faker.version 2.14.0
+      def max_altitude
+        parse('drone.max_altitude')
+      end
+
+      ##
+      # Returns how far drone can go in optimal condition when full charged in meters
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.max_flight_distance #=> "18500 m"
+      #
+      # @faker.version 2.14.0
+      def max_flight_distance
+        parse('drone.max_flight_distance')
+      end
+
+      ##
+      # Returns max horizontal speed by drone in m/s
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.max_speed #=> "19 m/s"
+      #
+      # @faker.version 2.14.0
+      def max_speed
+        parse('drone.max_speed')
+      end
+
+      ##
+      # Returns max wind resistance by drone in m/s
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.max_wind_resistance #=> "10.5 m/s"
+      #
+      # @faker.version 2.14.0
+      def max_wind_resistance
+        parse('drone.max_wind_resistance')
+      end
+
+      ##
+      # Returns max angular velocity of drone in degrees/s
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.max_angular_velocity #=> "250 degree/s"
+      #
+      # @faker.version 2.14.0
+      def max_angular_velocity
+        parse('drone.max_angular_velocity')
+      end
+
+      ##
+      # Returns max tilt angle drone can go in degrees
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.max_tilt_angle #=> "35 degrees"
+      #
+      # @faker.version 2.14.0
+      def max_tilt_angle
+        parse('drone.max_tilt_angle')
+      end
+
+      ##
+      # Returns operating temperature for drone in Fahrenheit
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.operating_temperature #=> "14-104F"
+      #
+      # @faker.version 2.14.0
+      def operating_temperature
+        parse('drone.operating_temperature')
+      end
+
+      ##
+      # Returns the drone battery capacity
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.battery_capacity #=> "3500 mAh"
+      #
+      # @faker.version 2.14.0
+      def battery_capacity
+        parse('drone.battery_capacity')
+      end
+
+      ##
+      # Returns battery voltage
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.battery_voltage #=> "13.2V"
+      #
+      # @faker.version 2.14.0
+      def battery_voltage
+        parse('drone.battery_voltage')
+      end
+
+      ##
+      # Returns the battery type
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.battery_type #=> "LiPo 4S"
+      #
+      # @faker.version 2.14.0
+      def battery_type
+        parse('drone.battery_type')
+      end
+
+      ##
+      # Returns total battery weight in grams
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.battery_weight #=> "198 g"
+      #
+      # @faker.version 2.14.0
+      def battery_weight
+        parse('drone.battery_weight')
+      end
+
+      ##
+      # Returns charging temperature for battery in Fahrenheit
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.charging_temperature #=> "41-104F"
+      #
+      # @faker.version 2.14.0
+      def charging_temperature
+        parse('drone.charging_temperature')
+      end
+
+      ##
+      # Returns max chargin power required for battery
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.max_charging_power #=> "38W"
+      #
+      # @faker.version 2.14.0
+      def max_charging_power
+        parse('drone.max_charging_power')
+      end
+
+      ##
+      # Returns camera ISO range for drone
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.iso #=> "100-3200"
+      #
+      # @faker.version 2.14.0
+      def iso
+        parse('drone.iso')
+      end
+
+      ##
+      # Returns max camera resolution in MP"
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.max_resolution #=> "48MP"
+      #
+      # @faker.version 2.14.0
+      def max_resolution
+        parse('drone.max_resolution')
+      end
+
+      ##
+      # Returns photo format for drone
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.photo_format #=> "JPEG"
+      #
+      # @faker.version 2.14.0
+      def photo_format
+        parse('drone.photo_format')
+      end
+
+      ##
+      # Returns video format
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.video_format #=> "MP4"
+      #
+      # @faker.version 2.14.0
+      def video_format
+        parse('drone.video_format')
+      end
+
+      ##
+      # Returns max and min shutter speed for camera
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.shutter_speed_range #=> "8-1/8000s"
+      #
+      # @faker.version 2.14.0
+      def shutter_speed_range
+        "#{fetch('drone.max_shutter_speed')}-#{fetch('drone.min_shutter_speed')}#{fetch('drone.shutter_speed_units')}"
+      end
+
+      ##
+      # Returns max shutter speed for camera
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.max_shutter_speed #=> "60s"
+      #
+      # @faker.version 2.14.0
+      def max_shutter_speed
+        "#{fetch('drone.max_shutter_speed')}#{fetch('drone.shutter_speed_units')}"
+      end
+
+      ##
+      # Returns min shutter speed for camera
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.min_shutter_speed #=> "1/8000s"
+      #
+      # @faker.version 2.14.0
+      def min_shutter_speed
+        "#{fetch('drone.min_shutter_speed')}#{fetch('drone.shutter_speed_units')}"
+      end
+    end
+  end
+end