faker 1.8.7 → 2.17.0

data/lib/faker/default/demographic.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Faker
+  class Demographic < Base
+    class << self
+      ##
+      # Produces the name of a race.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Demographic.race #=> "Native Hawaiian or Other Pacific Islander"
+      #
+      # @faker.version 1.7.3
+      def race
+        fetch('demographic.race')
+      end
+
+      ##
+      # Produces a level of educational attainment.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Demographic.educational_attainment #=> "GED or alternative credential"
+      #
+      # @faker.version 1.7.3
+      def educational_attainment
+        fetch('demographic.educational_attainment')
+      end
+
+      ##
+      # Produces a denonym.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Demographic.denonym #=> "Panamanian"
+      #
+      # @faker.version 1.7.3
+      def demonym
+        fetch('demographic.demonym')
+      end
+
+      ##
+      # Produces a marital status.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Demographic.marital_status #=> "Widowed"
+      #
+      # @faker.version 1.7.3
+      def marital_status
+        fetch('demographic.marital_status')
+      end
+
+      ##
+      # Produces a sex for demographic purposes.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Demographic.sex #=> "Female"
+      #
+      # @faker.version 1.7.3
+      def sex
+        fetch('demographic.sex')
+      end
+
+      ##
+      # Produces a height as a string.
+      #
+      # @param unit [Symbol] either `:metric` or `imperial`.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Demographic.height #=> "1.61"
+      # @example
+      #   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
+
+        case unit
+        when :imperial
+          inches = rand_in_range(57, 86)
+          "#{inches / 12} ft, #{inches % 12} in"
+        when :metric
+          rand_in_range(1.45, 2.13).round(2).to_s
+        end
+      end
+    end
+  end
+end

data/lib/faker/default/dessert.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Faker
+  class Dessert < Base
+    flexible :dessert
+
+    class << self
+      ##
+      # Produces the name of a dessert variety.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Dessert.variety #=> "Cake"
+      #
+      # @faker.version 1.8.0
+      def variety
+        fetch('dessert.variety')
+      end
+
+      ##
+      # Produces the name of a dessert topping.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Dessert.topping #=> "Gummy Bears"
+      #
+      # @faker.version 1.8.0
+      def topping
+        fetch('dessert.topping')
+      end
+
+      ##
+      # Produces the name of a dessert flavor.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Dessert.flavor #=> "Salted Caramel"
+      #
+      # @faker.version 1.8.0
+      def flavor
+        fetch('dessert.flavor')
+      end
+    end
+  end
+end

data/lib/faker/default/device.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Faker
+  class Device < Base
+    class << self
+      ##
+      # Produces a build number between 1 and 500.
+      #
+      # @return [Integer]
+      #
+      # @example
+      #   Faker::Device.build_number #=> 5
+      #
+      # @faker.version 1.9.0
+      def build_number
+        Faker::Number.between(from: 1, to: 500)
+      end
+
+      ##
+      # Produces the name of a manufacturer for a device.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Device.manufacturer #=> "Apple"
+      #
+      # @faker.version 1.9.0
+      def manufacturer
+        fetch('device.manufacturer')
+      end
+
+      ##
+      # Produces a model name for a device.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Device.model_name #=> "iPhone 4"
+      #
+      # @faker.version 1.9.0
+      def model_name
+        fetch('device.model_name')
+      end
+
+      ##
+      # Produces the name of a platform for a device.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Device.platform #=> "webOS"
+      #
+      # @faker.version 1.9.0
+      def platform
+        fetch('device.platform')
+      end
+
+      ##
+      # Produces a serial code for a device.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Device.serial #=> "ejfjnRNInxh0363JC2WM"
+      #
+      # @faker.version 1.9.0
+      def serial
+        fetch('device.serial')
+      end
+
+      ##
+      # Produces a version number between 1 and 1000.
+      #
+      # @return [Integer]
+      #
+      # @example
+      #   Faker::Device.version #=> 42
+      #
+      # @faker.version 1.9.0
+      def version
+        Faker::Number.between(from: 1, to: 1000)
+      end
+    end
+  end
+end

data/lib/faker/default/driving_licence.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Faker
+  class DrivingLicence < Base
+    GB_PADDING = '9999'
+    NI_CHANCE = 0.03 # NI Pop is about 3% of total UK population
+
+    class << self
+      # rubocop:disable Metrics/ParameterLists
+
+      ##
+      # 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(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))
+        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
+
+        [
+          gb_licence_padding(last_name, 5),
+          gb_licence_year(date_of_birth, gender),
+          gb_licence_padding(initials, 2),
+          gb_licence_checksum
+        ].join
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      ##
+      # 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
+        else
+          british_driving_licence(*args)
+        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
+        %i[male female].sample(random: Faker::Config.random)
+      end
+
+      def gb_licence_padding(str, num_chars)
+        prepped = str.upcase.gsub(%r{[^A-Z]}, '') + GB_PADDING
+        prepped[0..(num_chars - 1)]
+      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
+      end
+
+      def gb_licence_checksum
+        regexify(/[0-9][A-Z][A-Z]/)
+      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 temprature 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