faker 1.8.2 → 2.23.0

data/lib/faker/default/date.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+module Faker
+  class Date < Base
+    class << self
+      ##
+      # Produce a random date between two dates.
+      #
+      # @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.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
+
+        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, 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 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
+
+        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
+      # rubocop:enable Metrics/ParameterLists
+
+      ##
+      # 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
+      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
+
+      ##
+      # 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
+      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 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
+      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
+
+      ##
+      # 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 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)
+
+        between(from: from, to: to).to_date
+      end
+
+      private
+
+      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
+
+      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
+    end
+  end
+end

data/lib/faker/default/dc_comics.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Faker
+  class DcComics < Base
+    ##
+    # Produces a hero name from DC Comics
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::DcComics.hero #=> "Batman"
+    #
+    # @faker.version 1.9.2
+    def self.hero
+      fetch('dc_comics.hero')
+    end
+
+    ##
+    # Produces a heroine name from DC Comics
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::DcComics.heroine #=> "Supergirl"
+    #
+    # @faker.version 1.9.2
+    def self.heroine
+      fetch('dc_comics.heroine')
+    end
+
+    ##
+    # Produces a villain name from DC Comics
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::DcComics.villain #=> "The Joker"
+    #
+    # @faker.version 1.9.2
+    def self.villain
+      fetch('dc_comics.villain')
+    end
+
+    ##
+    # Produces a character name from DC Comics
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::DcComics.name #=> "Clark Kent"
+    #
+    # @faker.version 1.9.2
+    def self.name
+      fetch('dc_comics.name')
+    end
+
+    ##
+    # Produces a comic book title from DC Comics
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::DcComics.title #=> "Batman: The Long Halloween"
+    #
+    # @faker.version 1.9.2
+    def self.title
+      fetch('dc_comics.title')
+    end
+  end
+end

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