faker 2.11.0 → 3.2.0

data/lib/faker/default/crypto.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'digest'
+require 'openssl'
 
 module Faker
   class Crypto < Base
@@ -15,7 +15,7 @@ module Faker
       #
       # @faker.version 1.6.4
       def md5
-        Digest::MD5.hexdigest(Lorem.characters)
+        OpenSSL::Digest::MD5.hexdigest(Lorem.characters)
       end
 
       ##
@@ -28,7 +28,7 @@ module Faker
       #
       # @faker.version 1.6.4
       def sha1
-        Digest::SHA1.hexdigest(Lorem.characters)
+        OpenSSL::Digest::SHA1.hexdigest(Lorem.characters)
       end
 
       ##
@@ -41,7 +41,20 @@ module Faker
       #
       # @faker.version 1.6.4
       def sha256
-        Digest::SHA256.hexdigest(Lorem.characters)
+        OpenSSL::Digest::SHA256.hexdigest(Lorem.characters)
+      end
+
+      ##
+      # Produces a SHA512 hash.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Crypto.sha512 #=> "7b9fc82a6642874833d01b74a7b4fae3d15373193b55cfba47327f8f0afdc8d0ea155b58639a03a887009ef997dab8dd8d36767620d430f6e787e5996e26da80"
+      #
+      # @faker.version next
+      def sha512
+        OpenSSL::Digest::SHA512.hexdigest(Lorem.characters)
       end
     end
   end

data/lib/faker/default/crypto_coin.rb

@@ -7,34 +7,67 @@ module Faker
       ACRONYM = 1
       URL_LOGO = 2
 
-      def coin_name(legacy_coin = NOT_GIVEN, coin: coin_array)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :coin if legacy_coin != NOT_GIVEN
-        end
-
+      ##
+      # Produces a random crypto coin name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::CryptoCoin.coin_name #=> "Bitcoin"
+      #
+      # @faker.version 1.9.2
+      def coin_name(coin: coin_array)
         coin[COIN_NAME]
       end
 
-      def acronym(legacy_coin = NOT_GIVEN, coin: coin_array)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :coin if legacy_coin != NOT_GIVEN
-        end
-
+      ##
+      # Produces a random crypto coin acronym.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::CryptoCoin.acronym #=> "BTC"
+      #
+      # @faker.version 1.9.2
+      def acronym(coin: coin_array)
         coin[ACRONYM]
       end
 
-      def url_logo(legacy_coin = NOT_GIVEN, coin: coin_array)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :coin if legacy_coin != NOT_GIVEN
-        end
-
+      ##
+      # Produces a random crypto coin logo url.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::CryptoCoin.url_logo #=> "https://i.imgur.com/EFz61Ei.png"
+      #
+      # @faker.version 1.9.2
+      def url_logo(coin: coin_array)
         coin[URL_LOGO]
       end
 
+      ##
+      # Produces a random crypto coin's name, acronym and logo in an array.
+      #
+      # @return [Array<String>]
+      #
+      # @example
+      #   Faker::CryptoCoin.coin_array #=> ["Dash", "DASH", "https://i.imgur.com/2uX91cb.png"]
+      #
+      # @faker.version 1.9.2
       def coin_array
         fetch('crypto_coin.coin').split(',').map(&:strip)
       end
 
+      ##
+      # Produces a random crypto coin's name, acronym and logo in a hash.
+      #
+      # @return [Hash]
+      #
+      # @example
+      #   Faker::CryptoCoin.coin_hash {:name=>"Ethereum", :acronym=>"ETH", :url_logo=>"https://i.imgur.com/uOPFCXj.png"}
+      #
+      # @faker.version 1.9.2
       def coin_hash
         coin = coin_array
 

data/lib/faker/default/date.rb

@@ -6,53 +6,40 @@ module Faker
       ##
       # 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,7 +49,6 @@ 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).
@@ -74,11 +60,7 @@ module Faker
       #   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
-
+      def forward(days: 365)
         from = ::Date.today + 1
         to   = ::Date.today + days
 
@@ -95,11 +77,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 +95,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 +120,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)

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
@@ -62,4 +112,10 @@ module Faker
       end
     end
   end
+
+  class InvalidStatePassed < StandardError
+    def initialize(msg = 'Invalid state code passed')
+      super
+    end
+  end
 end