faker 2.17.0 → 2.20.0

data/lib/faker/default/food.rb

@@ -108,6 +108,19 @@ module Faker
       def metric_measurement
         fetch('food.metric_measurements')
       end
+
+      ##
+      # Retrieves ethnic category
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Food.ethnic_category #=> "Indian cuisine"
+      #
+      # @faker.version next
+      def ethnic_category
+        fetch('food.ethnic_category')
+      end
     end
   end
 end

data/lib/faker/default/hobby.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Faker
+  class Hobby < Base
+    flexible :hobby
+
+    class << self
+      ##
+      # Retrieves a typical hobby activity.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Hobby.activity #=> "Cooking"
+      #
+      # @faker.version next
+      def activity
+        fetch('hobby.activity')
+      end
+    end
+  end
+end

data/lib/faker/default/id_number.rb

@@ -200,8 +200,42 @@ module Faker
         "#{digits}-#{verification_code}"
       end
 
+      ##
+      # Produces a random Croatian ID number (OIB).
+      #
+      # @param international [Boolean] Specifies whether to add international prefix.
+      # @return [String]
+      #
+      # @example
+      #   Faker::IDNumber.croatian_id #=> "88467617508"
+      #   Faker::IDNumber.croatian_id(international: true) #=> "HR88467617508"
+      #
+      # @faker.version next
+      def croatian_id(international: false)
+        prefix = international ? 'HR' : ''
+        digits = Faker::Number.number(digits: 10).to_s
+        checksum_digit = croatian_id_checksum_digit(digits)
+
+        "#{prefix}#{digits}#{checksum_digit}"
+      end
+
       private
 
+      def croatian_id_checksum_digit(digits)
+        control_sum = 10
+
+        digits.chars.map(&:to_i).each do |digit|
+          control_sum += digit
+          control_sum %= 10
+          control_sum = 10 if control_sum.zero?
+          control_sum *= 2
+          control_sum %= 11
+        end
+
+        control_sum = 11 - control_sum
+        control_sum % 10
+      end
+
       def chilean_verification_code(digits)
         # First digit is multiplied by 3, second by 2, and so on
         multiplication_rule = [3, 2, 7, 6, 5, 4, 3, 2]

data/lib/faker/default/internet.rb

@@ -2,6 +2,18 @@
 
 module Faker
   class Internet < Base
+    # Private, Host, and Link-Local network address blocks as defined in https://en.wikipedia.org/wiki/IPv4#Special-use_addresses
+    PRIVATE_IPV4_ADDRESS_RANGES = [
+      [10..10,   0..255,   0..255, 1..255], # 10.0.0.0/8     - Used for local communications within a private network
+      [100..100, 64..127,  0..255, 1..255], # 100.64.0.0/10  - Shared address space for communications between an ISP and its subscribers
+      [127..127, 0..255,   0..255, 1..255], # 127.0.0.0/8    - Used for loopback addresses to the local host
+      [169..169, 254..254, 0..255, 1..255], # 169.254.0.0/16 - Used for link-local addresses between two hosts on a single link when
+      [172..172, 16..31,   0..255, 1..255], # 172.16.0.0/12  - Used for local communications within a private network
+      [192..192, 0..0,     0..0,   1..255], # 192.0.0.0/24   - IETF Protocol Assignments
+      [192..192, 168..168, 0..255, 1..255], # 192.168.0.0/16 - Used for local communications within a private network
+      [198..198, 18..19,   0..255, 1..255]  # 198.18.0.0/15  - Used for benchmark testing of inter-network communications between subnets
+    ].each(&:freeze).freeze
+
     class << self
       ##
       # Returns the email address
@@ -34,7 +46,7 @@ module Faker
       end
 
       ##
-      # Returns the email address with doamin either gmail.com, yahoo.com or hotmail.com
+      # Returns the email address with domain either gmail.com, yahoo.com or hotmail.com
       #
       # @return [String]
       #
@@ -80,10 +92,10 @@ module Faker
       #
       # @return [String]
       #
-      # @param specifier [Integer, Range] When int value passed it returns the username longer than specifier. Max value can be 10^6
-      # @param separator [Array]
+      # @param specifier [Integer, Range, String] When int value passed it returns the username longer than specifier. Max value can be 10^6
+      # @param separators [Array]
       #
-      # @wxample
+      # @example
       #   Faker::Internet.username(specifier: 10)                     #=> "lulu.goodwin"
       #   Faker::Internet.username(specifier: 5..10)                  #=> "morris"
       #   Faker::Internet.username(specifier: 5..10)                  #=> "berryberry"
@@ -227,8 +239,6 @@ module Faker
         end
       end
 
-      # rubocop:disable Style/AsciiComments
-
       ##
       # Fixes ä, ö, ü, ß characters in string passed with ae, oe, ue, ss resp.
       #
@@ -247,7 +257,6 @@ module Faker
 
         Char.fix_umlauts(string)
       end
-      # rubocop:enable Style/AsciiComments
 
       ##
       # Returns the domain word for internet
@@ -264,7 +273,7 @@ module Faker
       #
       # @return [String]
       #
-      # @wxample
+      # @example
       #   Faker::Internet.domain_suffix   #=> "com"
       #   Faker::Internet.domain_suffix   #=> "biz"
       def domain_suffix
@@ -311,12 +320,7 @@ module Faker
       # @example
       #   Faker::Internet.private_ip_v4_address   #=> "127.120.80.42"
       def private_ip_v4_address
-        addr = nil
-        loop do
-          addr = ip_v4_address
-          break if private_net_checker[addr]
-        end
-        addr
+        sample(PRIVATE_IPV4_ADDRESS_RANGES).map { |range| rand(range) }.join('.')
       end
 
       ##
@@ -387,7 +391,7 @@ module Faker
       end
 
       ##
-      # Returns lambda function to check address passed is reserverd or not
+      # Returns lambda function to check address passed is reserved or not
       #
       # @return [Lambda]
       #
@@ -479,7 +483,9 @@ module Faker
         end
 
         glue ||= sample(%w[- _])
-        (words || Faker::Lorem.words(number: 2).join(' ')).delete(',.').gsub(' ', glue).downcase
+        return words.delete(',.').gsub(' ', glue).downcase unless words.nil?
+
+        sample(translate('faker.internet.slug'), 2).join(glue)
       end
 
       ##
@@ -559,6 +565,24 @@ module Faker
         s
       end
 
+      ##
+      # Produces a randomized hash of internet user details
+      # @example
+      #   Faker::Internet.user #=> { username: 'alexie', email: 'alexie@example.net' }
+      #
+      # @example
+      #   Faker::Internet.user('username', 'email', 'password') #=> { username: 'alexie', email: 'alexie@example.net', password: 'DtEf9P8wS31iMyC' }
+      #
+      # @return [hash]
+      #
+      # @faker.version next
+      def user(*args)
+        user_hash = {}
+        args = %w[username email] if args.empty?
+        args.each { |arg| user_hash[:"#{arg}"] = send(arg) }
+        user_hash
+      end
+
       alias user_name username
 
       private

data/lib/faker/default/lorem.rb

@@ -82,8 +82,6 @@ module Faker
         Alphanumeric.alphanumeric(number: number, min_alpha: min_alpha, min_numeric: min_numeric)
       end
 
-      # rubocop:disable Style/AsciiComments
-
       ##
       # Generates the emoji
       #
@@ -97,8 +95,6 @@ module Faker
       def multibyte
         sample(translate('faker.lorem.multibyte')).pack('C*').force_encoding('utf-8')
       end
-      # rubocop:enable Style/AsciiComments
-
       # rubocop:disable Metrics/ParameterLists
 
       ##

data/lib/faker/default/nation.rb

@@ -17,8 +17,6 @@ module Faker
         fetch('nation.nationality')
       end
 
-      # rubocop:disable Style/AsciiComments
-
       ##
       # Produces a random national flag emoji.
       #
@@ -31,7 +29,6 @@ module Faker
       def flag
         sample(translate('faker.nation.flag')).pack('C*').force_encoding('utf-8')
       end
-      # rubocop:enable Style/AsciiComments
 
       ##
       # Produces a random national language.

data/lib/faker/default/omniauth.rb

@@ -65,7 +65,7 @@ module Faker
               picture: image,
               gender: gender,
               birthday: Date.backward(days: 36_400).strftime('%Y-%m-%d'),
-              local: 'en',
+              locale: 'en',
               hd: "#{Company.name.downcase}.com"
             },
             id_info: {
@@ -431,6 +431,50 @@ module Faker
         }
       end
 
+      ##
+      # Generate a mock Omniauth response from Auth0.
+      #
+      # @param name [String] A specific name to return in the response.
+      # @param email [String] A specific email to return in the response.
+      # @param uid [String] A specific UID to return in the response.
+      #
+      # @return [Hash] An auth hash in the format provided by omniauth-auth0.
+      #
+      # @faker.version next
+      def auth0(name: nil, email: nil, uid: nil)
+        uid ||= "auth0|#{Number.hexadecimal(digits: 24)}"
+        auth = Omniauth.new(name: name, email: email)
+        {
+          provider: 'auth0',
+          uid: uid,
+          info: {
+            name: uid,
+            nickname: auth.name,
+            email: auth.email,
+            image: image
+          },
+          credentials: {
+            expires_at: Time.forward.to_i,
+            expires: true,
+            token_type: 'Bearer',
+            id_token: Crypto.sha256,
+            token: Crypto.md5,
+            refresh_token: Crypto.md5
+          },
+          extra: {
+            raw_info: {
+              email: auth.email,
+              email_verified: true,
+              iss: 'https://auth0.com/',
+              sub: uid,
+              aud: 'Auth012345',
+              iat: Time.forward.to_i,
+              exp: Time.forward.to_i
+            }
+          }
+        }
+      end
+
       private
 
       def gender

data/lib/faker/default/placeholdit.rb

@@ -8,7 +8,7 @@ module Faker
       # rubocop:disable Metrics/ParameterLists
 
       ##
-      # Produces a random placeholder image from https://placehold.it.
+      # Produces a random placeholder image from https://via.placeholder.com.
       #
       # @param size [String] Specifies the image's size, dimensions separated by 'x'.
       # @param format [String] Specifies the image's extension.
@@ -19,13 +19,13 @@ module Faker
       #
       # @example
       #     # Keyword arguments: size, format, background_color, text_color, text
-      #   Faker::Placeholdit.image #=> "https://placehold.it/300x300.png"
-      #   Faker::Placeholdit.image(size: '50x50') #=> "https://placehold.it/50x50.png"
-      #   Faker::Placeholdit.image(size: '50x50', format: 'jpg') #=> "https://placehold.it/50x50.jpg"
-      #   Faker::Placeholdit.image(size: '50x50', format: 'gif', background_color: 'ffffff') #=> "https://placehold.it/50x50.gif/ffffff"
-      #   Faker::Placeholdit.image(size: '50x50', format: 'jpeg', background_color: :random) #=> "https://placehold.it/50x50.jpeg/39eba7"
-      #   Faker::Placeholdit.image(size: '50x50', format: 'jpeg', background_color: 'ffffff', text_color: '000') #=> "https://placehold.it/50x50.jpeg/ffffff/000"
-      #   Faker::Placeholdit.image(size: '50x50', format: 'jpg', background_color: 'ffffff', text_color: '000', text: 'Some Custom Text') #=> "https://placehold.it/50x50.jpg/ffffff/000?text=Some Custom Text"
+      #   Faker::Placeholdit.image #=> "https://via.placeholder.com/300x300.png"
+      #   Faker::Placeholdit.image(size: '50x50') #=> "https://via.placeholder.com/50x50.png"
+      #   Faker::Placeholdit.image(size: '50x50', format: 'jpg') #=> "https://via.placeholder.com/50x50.jpg"
+      #   Faker::Placeholdit.image(size: '50x50', format: 'gif', background_color: 'ffffff') #=> "https://via.placeholder.com/50x50.gif/ffffff"
+      #   Faker::Placeholdit.image(size: '50x50', format: 'jpeg', background_color: :random) #=> "https://via.placeholder.com/50x50.jpeg/39eba7"
+      #   Faker::Placeholdit.image(size: '50x50', format: 'jpeg', background_color: 'ffffff', text_color: '000') #=> "https://via.placeholder.com/50x50.jpeg/ffffff/000"
+      #   Faker::Placeholdit.image(size: '50x50', format: 'jpg', background_color: 'ffffff', text_color: '000', text: 'Some Custom Text') #=> "https://via.placeholder.com/50x50.jpg/ffffff/000?text=Some Custom Text"
       #
       # @faker.version 1.6.0
       def image(legacy_size = NOT_GIVEN, legacy_format = NOT_GIVEN, legacy_background_color = NOT_GIVEN, legacy_text_color = NOT_GIVEN, legacy_text = NOT_GIVEN, size: '300x300', format: 'png', background_color: nil, text_color: nil, text: nil)
@@ -45,7 +45,7 @@ module Faker
         raise ArgumentError, "background_color must be a hex value without '#'" unless background_color.nil? || background_color =~ /((?:^\h{3}$)|(?:^\h{6}$)){1}(?!.*\H)/
         raise ArgumentError, "text_color must be a hex value without '#'" unless text_color.nil? || text_color =~ /((?:^\h{3}$)|(?:^\h{6}$)){1}(?!.*\H)/
 
-        image_url = "https://placehold.it/#{size}.#{format}"
+        image_url = "https://via.placeholder.com/#{size}.#{format}"
         image_url += "/#{background_color}" if background_color
         image_url += "/#{text_color}" if text_color
         image_url += "?text=#{text}" if text

data/lib/faker/default/religion.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Faker
+  module Religion
+  end
+end

data/lib/faker/default/science.rb

@@ -3,6 +3,47 @@
 module Faker
   class Science < Base
     class << self
+      BRANCHES = {
+        empirical: %i[empirical_natural_basic empirical_natural_applied empirical_social_basic empirical_social_applied],
+        formal: %i[formal_basic formal_applied],
+        natural: %i[empirical_natural_basic empirical_natural_applied],
+        social: %i[empirical_social_basic empirical_social_applied],
+        basic: %i[empirical_natural_basic empirical_social_basic formal_basic],
+        applied: %i[empirical_natural_applied empirical_social_applied formal_applied]
+      }.freeze
+
+      ##
+      # Produces a name of a science
+      # You can optionally filter by specifying one or more of the following:
+      # `:empirical, :formal, :natural, :social, :basic, :applied`
+      # @see https://en.wikipedia.org/wiki/Science#Branches_of_science
+      # @see Faker::Educator.subject
+      #
+      # @param branches [Array<Symbol>]
+      # @return [String]
+      #
+      # @example
+      #   Faker::Science.science #=> "Space science"
+      #   Faker::Science.science(:natural, :applied) #=> "Engineering"
+      #   Faker::Science.science(:formal, :applied) #=> "Computer Science"
+      #
+      # @faker.version next
+      def science(*branches)
+        selected = BRANCHES.values.flatten.uniq
+        branches.each do |branch|
+          selected &= BRANCHES[branch] if BRANCHES.key? branch
+        end
+
+        raise ArgumentError, 'Filters do not match any sciences' if selected.empty?
+
+        sciences = []
+        selected.each do |branch|
+          sciences += translate("faker.science.branch.#{branch}")
+        end
+
+        sample(sciences)
+      end
+
       ##
       # Produces the name of a element.
       #
@@ -29,6 +70,32 @@ module Faker
         fetch('science.element_symbol')
       end
 
+      ##
+      # Produces the state of an element.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Science.element_state #=> "Liquid"
+      #
+      # @faker.version next
+      def element_state
+        fetch('science.element_state')
+      end
+
+      ##
+      # Produces the subcategory of an element.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Science.element_subcategory #=> "Reactive nonmetal"
+      #
+      # @faker.version next
+      def element_subcategory
+        fetch('science.element_subcategory')
+      end
+
       ##
       # Produces the name of a scientist.
       #
@@ -41,6 +108,47 @@ module Faker
       def scientist
         fetch('science.scientist')
       end
+
+      ##
+      # Produces a scientifically sounding word
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Science.modifier #=> "Quantum"
+      #   Faker::Science.modifier #=> "Superconductive"
+      #
+      # @faker.version next
+      def modifier
+        fetch('science.modifier')
+      end
+
+      ##
+      # Produces the name of a scientific tool.
+      # By default it uses a science word modifier to generate more diverse data, which can be disabled.
+      #
+      # @param simple [Boolean] Whether to generate simple realistic tool names, (no Q-word).
+      # @return [String]
+      #
+      # @example
+      #   Faker::Science.tool #=> "Superconductive Microcentrifuge"
+      #   Faker::Science.tool #=> "Portable Cryostat"
+      #   Faker::Science.tool #=> "Quantum Spectrophotometer"
+      #   Faker::Science.tool(simple: true) #=> "Microcentrifuge"
+      #
+      # @faker.version next
+      def tool(simple: false)
+        tool = fetch('science.tool')
+        return tool if simple
+
+        # Makes sure the modifier are different
+        loop do
+          modifier = self.modifier
+          break unless tool.start_with?(modifier)
+        end
+
+        "#{modifier} #{tool}"
+      end
     end
   end
 end

data/lib/faker/default/string.rb

@@ -3,8 +3,6 @@
 module Faker
   class String < Base
     class << self
-      # rubocop:disable Style/AsciiComments
-
       ##
       # Produces a random UTF-8 string with optional nested length selectors.
       #
@@ -26,7 +24,6 @@ module Faker
 
         utf8string select_a length
       end
-      # rubocop:enable Style/AsciiComments
 
       private
 

data/lib/faker/default/tea.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Faker
+  class Tea < Base
+    flexible :tea
+
+    class << self
+      ##
+      # Produces a random variety or blend of tea.
+      #
+      # @param type [String, nil] the type of tea to query for (valid types: 'Black', 'Green', 'Oolong', 'White', and 'Herbal')
+      # @return [String] a variety of tea
+      #
+      # @example
+      #   Faker::Tea.variety
+      #     #=> "Earl Grey"
+      #
+      # @example
+      #   Faker::Tea.variety(type: 'Green')
+      #     #=> "Jasmine"
+      # @faker.version next
+      def variety(type: nil)
+        type ||= fetch('tea.type')
+        fetch "tea.variety.#{type.downcase}"
+      end
+
+      ##
+      # Produces a random type of tea.
+      #
+      # @return [String] a type of tea
+      #
+      # @example
+      #   Faker::Tea.type
+      #     #=> "Green"
+      # @faker.version next
+      def type
+        fetch 'tea.type'
+      end
+    end
+  end
+end

data/lib/faker/default/time.rb

@@ -14,7 +14,6 @@ module Faker
 
     class << self
       # rubocop:disable Metrics/ParameterLists
-      # rubocop:disable Style/AsciiComments
 
       ##
       # Produce a random time between two times.
@@ -51,7 +50,6 @@ module Faker
         time = Faker::Base.rand_in_range(from, to)
         time_with_format(time, format)
       end
-      # rubocop:enable Style/AsciiComments
 
       ##
       # Produce a random time between two dates.

data/lib/faker/games/dota.rb

@@ -4,6 +4,19 @@ module Faker
   class Games
     class Dota < Base
       class << self
+        ##
+        # Produces the name of a building from Dota.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Dota.building #=> "Tower"
+        #
+        # @faker.version 1.9.0
+        def building
+          fetch('games.dota.building')
+        end
+
         ##
         # Produces the name of a hero from Dota.
         #

data/lib/faker/games/witcher.rb

@@ -81,6 +81,45 @@ module Faker
         def monster
           fetch('games.witcher.monsters')
         end
+
+        ##
+        # Produces the name of a sign from The Witcher.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Witcher.sign #=> "Igni"
+        #
+        # @faker.version 2.18.0
+        def sign
+          fetch('games.witcher.signs')
+        end
+
+        ##
+        # Produces the name of a potion from The Witcher.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Witcher.potion #=> "Gadwall"
+        #
+        # @faker.version 2.18.0
+        def potion
+          fetch('games.witcher.potions')
+        end
+
+        ##
+        # Produces the name of a book from The Witcher.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Witcher.book #=> "Sword of Destiny"
+        #
+        # @faker.version 2.18.0
+        def book
+          fetch('games.witcher.books')
+        end
       end
     end
   end

data/lib/faker/japanese_media/fullmetal_alchemist_brotherhood.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Faker
+  class JapaneseMedia
+    class FmaBrotherhood < Base
+      class << self
+        ##
+        # Produces a character from FmaBrotherhood.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::JapaneseMedia::FmaBrotherhood.character #=> "Edward Elric"
+        #
+        # @faker.version next
+        def character
+          fetch('fma_brotherhood.characters')
+        end
+
+        ##
+        # Produces a cities from FmaBrotherhood.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::JapaneseMedia::FmaBrotherhood.city #=> "Central City"
+        #
+        # @faker.version next
+        def city
+          fetch('fma_brotherhood.cities')
+        end
+
+        ##
+        # Produces a country from FmaBrotherhood.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::JapaneseMedia::FmaBrotherhood.country #=> "Xing"
+        #
+        # @faker.version next
+        def country
+          fetch('fma_brotherhood.countries')
+        end
+      end
+    end
+  end
+end