faker 1.8.7 → 2.17.0

data/lib/faker/default/crypto.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'openssl'
+
+module Faker
+  class Crypto < Base
+    class << self
+      ##
+      # Produces an MD5 hash.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Crypto.md5 #=> "6b5ed240042e8a65c55ddb826c3408e6"
+      #
+      # @faker.version 1.6.4
+      def md5
+        OpenSSL::Digest::MD5.hexdigest(Lorem.characters)
+      end
+
+      ##
+      # Produces a SHA1 hash.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Crypto.sha1 #=> "4e99e31c51eef8b2d290e709f757f92e558a503f"
+      #
+      # @faker.version 1.6.4
+      def sha1
+        OpenSSL::Digest::SHA1.hexdigest(Lorem.characters)
+      end
+
+      ##
+      # Produces a SHA256 hash.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Crypto.sha256 #=> "51e4dbb424cd9db1ec5fb989514f2a35652ececef33f21c8dd1fd61bb8e3929d"
+      #
+      # @faker.version 1.6.4
+      def sha256
+        OpenSSL::Digest::SHA256.hexdigest(Lorem.characters)
+      end
+    end
+  end
+end

data/lib/faker/default/crypto_coin.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Faker
+  class CryptoCoin < Base
+    class << self
+      COIN_NAME = 0
+      ACRONYM = 1
+      URL_LOGO = 2
+
+      ##
+      # Produces a random crypto coin name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::CryptoCoin.coin_name #=> "Bitcoin"
+      #
+      # @faker.version 1.9.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
+
+        coin[COIN_NAME]
+      end
+
+      ##
+      # Produces a random crypto coin acronym.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::CryptoCoin.acronym #=> "BTC"
+      #
+      # @faker.version 1.9.2
+      def acronym(legacy_coin = NOT_GIVEN, coin: coin_array)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :coin if legacy_coin != NOT_GIVEN
+        end
+
+        coin[ACRONYM]
+      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(legacy_coin = NOT_GIVEN, coin: coin_array)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :coin if legacy_coin != NOT_GIVEN
+        end
+
+        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
+
+        {
+          name: coin_name(coin: coin),
+          acronym: acronym(coin: coin),
+          url_logo: url_logo(coin: coin)
+        }
+      end
+    end
+  end
+end

data/lib/faker/default/currency.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Faker
+  class Currency < Base
+    class << self
+      ##
+      # Produces the name of a currency.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Currency.name #=> "Swedish Krona"
+      #
+      # @faker.version 1.9.0
+      def name
+        fetch('currency.name')
+      end
+
+      ##
+      # Produces a currency code.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Currency.code #=> "USD"
+      #
+      # @faker.version 1.9.0
+      def code
+        fetch('currency.code')
+      end
+
+      ##
+      # Produces a currency symbol.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Currency.symbol #=> "$"
+      #
+      # @faker.version 1.9.0
+      def symbol
+        fetch('currency.symbol')
+      end
+    end
+  end
+end

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