faker 2.2.2 → 2.3.0

data/lib/faker/default/house.rb

@@ -3,10 +3,28 @@
 module Faker
   class House < Base
     class << self
+      ##
+      # Produces the name of a piece of furniture.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::House.furniture #=> "chair"
+      #
+      # @faker.version 1.9.2
       def furniture
         fetch('house.furniture')
       end
 
+      ##
+      # Produces the name of a room in a house.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::House.room #=> "kitchen"
+      #
+      # @faker.version 1.9.2
       def room
         fetch('house.rooms')
       end

data/lib/faker/default/internet.rb

@@ -74,20 +74,25 @@ module Faker
       end
 
       ##
-      # Produces a randomized string of characters
+      # Produces a randomized string of characters suitable for passwords
       #
-      # @param [Integer] min_length
-      # @param [Integer] max_length
-      # @param [Boolean] mix_case
-      # @param [Boolean] special_characters
+      # @param min_length [Integer] The minimum length of the password
+      # @param max_length [Integer] The maximum length of the password
+      # @param mix_case [Boolean] Toggles if uppercased letters are allowed. If true, at least one will be added.
+      # @param special_characters [Boolean] Toggles if special characters are allowed. If true, at least one will be added.
       #
       # @return [String]
       #
-      # @example Faker::Internet.password #=> "Vg5mSvY1UeRg7"
-      # @example Faker::Internet.password(min_length: 8) #=> "YfGjIk0hGzDqS0"
-      # @example Faker::Internet.password(min_length: 10, max_length: 20) #=> "EoC9ShWd1hWq4vBgFw"
-      # @example Faker::Internet.password(min_length: 10, max_length: 20, mix_case: true) #=> "3k5qS15aNmG"
-      # @example Faker::Internet.password(min_length: 10, max_length: 20, mix_case: true, special_characters: true) #=> "*%NkOnJsH4"
+      # @example
+      #   Faker::Internet.password #=> "Vg5mSvY1UeRg7"
+      # @example
+      #   Faker::Internet.password(min_length: 8) #=> "YfGjIk0hGzDqS0"
+      # @example
+      #   Faker::Internet.password(min_length: 10, max_length: 20) #=> "EoC9ShWd1hWq4vBgFw"
+      # @example
+      #   Faker::Internet.password(min_length: 10, max_length: 20, mix_case: true) #=> "3k5qS15aNmG"
+      # @example
+      #   Faker::Internet.password(min_length: 10, max_length: 20, mix_case: true, special_characters: true) #=> "*%NkOnJsH4"
       #
       # @faker.version 2.1.3
       # rubocop:disable Metrics/ParameterLists

data/lib/faker/default/lorem.rb

@@ -30,16 +30,17 @@ module Faker
       ##
       # Produces a random string of alphanumeric characters
       #
-      # @param [Integer] number
-      # @param [Integer] min_alpha
-      # @param [Integer] min_numeric
+      # @param number [Integer] The number of characters to generate
+      # @param min_alpha [Integer] The minimum number of alphabetic to add to the string
+      # @param min_numeric [Integer] The minimum number of numbers to add to the string
       #
       # @return [String]
       #
-      # @example Faker::Lorem.characters #=> "uw1ep04lhs0c4d931n1jmrspprf5wrj85fefue0y7y6m56b6omquh7br7dhqijwlawejpl765nb1716idmp3xnfo85v349pzy2o9rir23y2qhflwr71c1585fnynguiphkjm8p0vktwitcsm16lny7jzp9t4drwav3qmhz4yjq4k04x14gl6p148hulyqioo72tf8nwrxxcclfypz2lc58lsibgfe5w5p0xv95peafjjmm2frkhdc6duoky0aha"
-      # @example Faker::Lorem.characters(number: 10) #=> "ang9cbhoa8"
-      # @example Faker::Lorem.characters(number: 10, min_alpha: 4) #=> "ang9cbhoa8"
-      # @example Faker::Lorem.characters(number: 10, min_alpha: 4, min_numeric: 1) #=> "ang9cbhoa8"
+      # @example
+      #   Faker::Lorem.characters #=> "uw1ep04lhs0c4d931n1jmrspprf5w..."
+      #   Faker::Lorem.characters(number: 10) #=> "ang9cbhoa8"
+      #   Faker::Lorem.characters(number: 10, min_alpha: 4) #=> "ang9cbhoa8"
+      #   Faker::Lorem.characters(number: 10, min_alpha: 4, min_numeric: 1) #=> "ang9cbhoa8"
       #
       # @faker.version 2.1.3
       def characters(legacy_number = NOT_GIVEN, number: 255, min_alpha: 0, min_numeric: 0)

data/lib/faker/default/omniauth.rb

@@ -341,6 +341,48 @@ module Faker
         }
       end
 
+      ##
+      # Generate a mock Omniauth response from Apple
+      #
+      # @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-apple
+      def apple(name: nil, email: nil, uid: nil)
+        uid ||= "#{Number.number(digits: 6)}.#{Number.hexadecimal(digits: 32)}.#{Number.number(digits: 4)}"
+        auth = Omniauth.new(name: name, email: email)
+        {
+          provider: 'apple',
+          uid: uid,
+          info: {
+            sub: uid,
+            email: auth.email,
+            first_name: auth.first_name,
+            last_name: auth.last_name
+          },
+          credentials: {
+            token: Crypto.md5,
+            refresh_token: Crypto.md5,
+            expires_at: Time.forward.to_i,
+            expires: true
+          },
+          extra: {
+            raw_info: {
+              iss: 'https://appleid.apple.com',
+              aud: 'CLIENT_ID',
+              exp: Time.forward.to_i,
+              iat: Time.forward.to_i,
+              sub: uid,
+              at_hash: Crypto.md5,
+              auth_time: Time.forward.to_i,
+              email: auth.email,
+              email_verified: true
+            }
+          }
+        }
+      end
+
       private
 
       def gender

data/lib/faker/default/programming_language.rb

@@ -3,10 +3,28 @@
 module Faker
   class ProgrammingLanguage < Base
     class << self
+      ##
+      # Produces the name of a programming language.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::ProgrammingLanguage.name #=> "Ruby"
+      #
+      # @faker.version 1.8.5
       def name
         fetch('programming_language.name')
       end
 
+      ##
+      # Produces the name of a programming language's creator.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::ProgrammingLanguage.creator #=> "Yukihiro Matsumoto"
+      #
+      # @faker.version 1.8.5
       def creator
         fetch('programming_language.creator')
       end

data/lib/faker/default/source.rb

@@ -3,6 +3,20 @@
 module Faker
   class Source < Base
     class << self
+      ##
+      # Produces source code for Hello World in a given language.
+      #
+      # @param lang [Symbol] The programming language to use
+      # @return [String]
+      #
+      # @example
+      #   Faker::Source.hello_world #=> "puts 'Hello World!'"
+      #
+      # @example
+      #   Faker::Source.hello_world(lang: :javascript)
+      #     #=> "alert('Hello World!');"
+      #
+      # @faker.version 1.9.0
       def hello_world(legacy_lang = NOT_GIVEN, lang: :ruby)
         warn_for_deprecated_arguments do |keywords|
           keywords << :lang if legacy_lang != NOT_GIVEN
@@ -11,6 +25,20 @@ module Faker
         fetch("source.hello_world.#{lang}")
       end
 
+      ##
+      # Produces source code for printing a string in a given language.
+      #
+      # @param str [String] The string to print
+      # @param lang [Symbol] The programming language to use
+      # @return [String]
+      #
+      # @example
+      #   Faker::Source.print #=> "puts 'faker_string_to_print'"
+      # @example
+      #   Faker::Source.print(str: 'foo bar', lang: :javascript)
+      #     #=> "console.log('foo bar');"
+      #
+      # @faker.version 1.9.0
       def print(legacy_str = NOT_GIVEN, legacy_lang = NOT_GIVEN, str: 'some string', lang: :ruby)
         warn_for_deprecated_arguments do |keywords|
           keywords << :str if legacy_str != NOT_GIVEN
@@ -18,16 +46,29 @@ module Faker
         warn_for_deprecated_arguments do |keywords|
           keywords << :lang if legacy_lang != NOT_GIVEN
         end
-
         code = fetch("source.print.#{lang}")
         code.gsub('faker_string_to_print', str)
       end
 
+      ##
+      # Produces source code for printing 1 through 10 in a given language.
+      #
+      # @param lang [Symbol] The programming language to use
+      # @return [String]
+      #
+      # @example
+      #   Faker::Source.print_1_to_10 #=> "(1..10).each { |i| puts i }"
+      # @example
+      #   Faker::Source.print_1_to_10(lang: :javascript)
+      #   # => "for (let i=0; i<10; i++) {
+      #   #       console.log(i);
+      #   #    }"
+      #
+      # @faker.version 1.9.0
       def print_1_to_10(legacy_lang = NOT_GIVEN, lang: :ruby)
         warn_for_deprecated_arguments do |keywords|
           keywords << :lang if legacy_lang != NOT_GIVEN
         end
-
         fetch("source.print_1_to_10.#{lang}")
       end
     end

data/lib/faker/games/elder_scrolls.rb

@@ -4,34 +4,106 @@ module Faker
   class Games
     class ElderScrolls < Base
       class << self
+        ##
+        # Produces the name of a race from the Elder Scrolls universe.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ElderScrolls.race #=> "Argonian"
+        #
+        # @faker.version 1.9.2
         def race
           fetch('games.elder_scrolls.race')
         end
 
+        ##
+        # Produces the name of a city from the Elder Scrolls universe.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ElderScrolls.city #=> "Whiterun"
+        #
+        # @faker.version 1.9.2
         def city
           fetch('games.elder_scrolls.city')
         end
 
+        ##
+        # Produces the name of a creature from the Elder Scrolls universe.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ElderScrolls.creature #=> "Frost Troll"
+        #
+        # @faker.version 1.9.2
         def creature
           fetch('games.elder_scrolls.creature')
         end
 
+        ##
+        # Produces the name of a region from the Elder Scrolls universe.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ElderScrolls.region #=> "Cyrodiil"
+        #
+        # @faker.version 1.9.2
         def region
           fetch('games.elder_scrolls.region')
         end
 
+        ##
+        # Produces the name of a dragon from the Elder Scrolls universe.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ElderScrolls.dragon #=> "Blood Dragon"
+        #
+        # @faker.version 1.9.2
         def dragon
           fetch('games.elder_scrolls.dragon')
         end
 
+        ##
+        # Produces a randomly generated name from the Elder Scrolls universe.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ElderScrolls.name #=> "Balgruuf The Old"
+        #
+        # @faker.version 1.9.2
         def name
           "#{fetch('games.elder_scrolls.first_name')} #{fetch('games.elder_scrolls.last_name')}"
         end
 
+        ##
+        # Produces a first name from the Elder Scrolls universe.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ElderScrolls.first_name #=> "Balgruuf"
+        #
+        # @faker.version 1.9.2
         def first_name
           fetch('games.elder_scrolls.first_name')
         end
 
+        ##
+        # Produces a last name from the Elder Scrolls universe.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ElderScrolls.last_name #=> "The Old"
+        #
+        # @faker.version 1.9.2
         def last_name
           fetch('games.elder_scrolls.last_name')
         end

data/lib/faker/games/fallout.rb

@@ -4,18 +4,55 @@ module Faker
   class Games
     class Fallout < Base
       class << self
+        ##
+        # Produces the name of a character from the Fallout games.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Fallout.character #=> "Liberty Prime"
+        #
+        # @faker.version 1.9.2
         def character
           fetch('games.fallout.characters')
         end
 
+        ##
+        # Produces the name of a faction from the Fallout games.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Fallout.faction #=> "Brotherhood of Steel"
+        #
+        # @faker.version 1.9.2
         def faction
           fetch('games.fallout.factions')
         end
 
+        ##
+        # Produces the name of a location from the Fallout games.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Fallout.location #=> "New Vegas"
+        #
+        # @faker.version 1.9.2
         def location
           fetch('games.fallout.locations')
         end
 
+        ##
+        # Produces a quote from the Fallout games.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Fallout.quote
+        #     #=> "Democracy is non-negotiable"
+        #
+        # @faker.version 1.9.2
         def quote
           fetch('games.fallout.quotes')
         end

data/lib/faker/games/game.rb

@@ -5,14 +5,41 @@ module Faker
     flexible :game
 
     class << self
+      ##
+      # Produces the name of a video game.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Game.title #=> "Half-Life 2"
+      #
+      # @faker.version 1.9.4
       def title
         fetch('game.title')
       end
 
+      ##
+      # Produces the name of a video game genre.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Game.genre #=> "Real-time strategy"
+      #
+      # @faker.version 1.9.4
       def genre
         fetch('game.genre')
       end
 
+      ##
+      # Produces the name of a video game console or platform.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Game.platform #=> "Nintendo Switch"
+      #
+      # @faker.version 1.9.4
       def platform
         fetch('game.platform')
       end