faker 2.19.0 → 2.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67dd53f62e56c7e1a3cd672bb2d81dbee5bdee8a31336ea5c76bcc53390a60f5
-  data.tar.gz: ceb4cbe305f9c16003719ebace13c1a6e4338ca8b9521dab82a22fa7ae1eb270
+  metadata.gz: 263e2d15636da915718fec1db63ac9595f87b2a075ddaa0e536ce89a57523b81
+  data.tar.gz: 677c2ee1537ece0e18820f72ac1a528c3581f60e298d51c125ff9d673d6e6022
 SHA512:
-  metadata.gz: 2cbd4a1b3d6dba3cfdc0ee005522c64f963c9954d3371a0362a03df7d3deec5b67e63ba2828aa11fe371f5aec228bc3d3f4fbc4f2c59505d68020f3d15086a00
-  data.tar.gz: b6e4e5a92e4f3719eabbd370e0278c30bd178960d4574bc84959bdab77551d5d3193373b3c584c46b8a6e0adf201f1c68c73cab5708331db7070955eca4ad68d
+  metadata.gz: ad45cb3518237236a31bf97d0bbe48214cef9ef1debca67f3d4ea5cb0c105c9d045d37fd22f33cc9da90be89ddb1ce8113d9a016f4f18098a679e5e9e53521d0
+  data.tar.gz: 449074010c194137d0f9bc77e4730f09058559016e780a4ca78c1bcb4f650002e22f8c6af0668f1f1d6ee43e25f11793855df496095ab0e314c8a24923daba29

data/README.md

@@ -136,6 +136,7 @@ gem 'faker', :git => 'https://github.com/faker-ruby/faker.git', :branch => 'mast
   - [Faker::Boolean](doc/default/boolean.md)
   - [Faker::BossaNova](doc/default/bossa_nova.md)
   - [Faker::Business](doc/default/business.md)
+  - [Faker::Camera](doc/default/camera.md)
   - [Faker::Cannabis](doc/default/cannabis.md)
   - [Faker::ChileRut](doc/default/chile_rut.md)
   - [Faker::ChuckNorris](doc/default/chuck_norris.md)
@@ -230,6 +231,7 @@ gem 'faker', :git => 'https://github.com/faker-ruby/faker.git', :branch => 'mast
   - [Faker::Books::CultureSeries](doc/books/culture_series.md)
   - [Faker::Books::Dune](doc/books/dune.md)
   - [Faker::Books::Lovecraft](doc/books/lovecraft.md)
+  - [Faker::Books::TheKingkillerChronicle](doc/books/the_kingkiller_chronicle.md)
 
 ### Fantasy
   - [Faker::Fantasy::Tolkien](doc/fantasy/tolkien.md)
@@ -274,6 +276,7 @@ gem 'faker', :git => 'https://github.com/faker-ruby/faker.git', :branch => 'mast
   - [Faker::JapaneseMedia::Naruto](doc/japanese_media/naruto.md)
   - [Faker::JapaneseMedia::Doraemon](doc/japanese_media/doraemon.md)
   - [Faker::JapaneseMedia::Conan](doc/japanese_media/conan.md)
+  - [Faker::JapaneseMedia::FmaBrotherhood](doc/japanese_media/fullmetal_alchemist_brotherhood.md)
 
 ### Movies
   - [Faker::Movie](doc/movies/movie.md)
@@ -318,6 +321,7 @@ gem 'faker', :git => 'https://github.com/faker-ruby/faker.git', :branch => 'mast
   - [Faker::TvShows::BigBangTheory](doc/tv_shows/big_bang_theory.md)
   - [Faker::TvShows::BojackHorseman](doc/tv_shows/bojack_horseman.md)
   - [Faker::TvShows::BreakingBad](doc/tv_shows/breaking_bad.md)
+  - [Faker::TvShows::BrooklynNineNine](doc/tv_shows/brooklyn_nine_nine.md)
   - [Faker::TvShows::Buffy](doc/tv_shows/buffy.md)
   - [Faker::TvShows::Community](doc/tv_shows/community.md)
   - [Faker::TvShows::DrWho](doc/tv_shows/dr_who.md)
@@ -354,9 +358,14 @@ Since you may want to make addresses and other types of data look different
 depending on where in the world you are (US postal codes vs. UK postal codes,
 for example), Faker uses the I18n gem to store strings (like state names) and
 formats (US postal codes are NNNNN while UK postal codes are AAN NAA),
-allowing you to get different formats by switching locales.  Just set
-Faker::Config.locale to the locale you want, and Faker will take care of the
-rest.
+allowing you to get different formats by switching locales.
+Just set the locale you want as shown below, and Faker will take care of the rest.
+
+```ruby
+Faker::Config.locale = 'es'
+# or
+Faker::Config.locale = :es
+```
 
 If your locale doesn't already exist, create it in the `lib/locales` directory
 and you can then override or add elements to suit your needs. See more about how to

data/lib/faker/books/the_kingkiller_chronicle.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Faker
+  class Books
+    class TheKingkillerChronicle < Base
+      class << self
+        ##
+        # Produces the name of a The Kingkiller Chronicle book.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::TheKingkillerChronicle.book #=> "The Name of the Wind"
+        #
+        # @faker.version next
+        def book
+          fetch('books.the_kingkiller_chronicle.books')
+        end
+
+        ##
+        # Produces the name of a The Kingkiller Chronicle character.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::TheKingkillerChronicle.character #=> "Kvothe"
+        #
+        # @faker.version next
+        def character
+          fetch('books.the_kingkiller_chronicle.characters')
+        end
+
+        ##
+        # Produces the name of a The Kingkiller Chronicle creature.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::TheKingkillerChronicle.creature #=> "Scrael"
+        #
+        # @faker.version next
+        def creature
+          fetch('books.the_kingkiller_chronicle.creatures')
+        end
+
+        ##
+        # Produces the name of a The Kingkiller Chronicle location.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::TheKingkillerChronicle.location #=> "Tarbean"
+        #
+        # @faker.version next
+        def location
+          fetch('books.the_kingkiller_chronicle.locations')
+        end
+      end
+    end
+  end
+end

data/lib/faker/default/company.rb

@@ -334,7 +334,7 @@ module Faker
       #
       # @faker.version 1.9.2
       def south_african_pty_ltd_registration_number
-        regexify(/\d{4}\/\d{4,10}\/07/)
+        regexify(%r{\d{4}/\d{4,10}/07})
       end
 
       ##
@@ -347,7 +347,7 @@ module Faker
       #
       # @faker.version 1.9.2
       def south_african_close_corporation_registration_number
-        regexify(/(CK\d{2}|\d{4})\/\d{4,10}\/23/)
+        regexify(%r{(CK\d{2}|\d{4})/\d{4,10}/23})
       end
 
       ##
@@ -360,7 +360,7 @@ module Faker
       #
       # @faker.version 1.9.2
       def south_african_listed_company_registration_number
-        regexify(/\d{4}\/\d{4,10}\/06/)
+        regexify(%r{\d{4}/\d{4,10}/06})
       end
 
       ##
@@ -373,7 +373,7 @@ module Faker
       #
       # @faker.version 1.9.2
       def south_african_trust_registration_number
-        regexify(/IT\d{2,4}\/\d{2,10}/)
+        regexify(%r{IT\d{2,4}/\d{2,10}})
       end
 
       ##
@@ -511,7 +511,6 @@ module Faker
         sum
       end
 
-      # rubocop:disable Style/AsciiComments
       #
       # For more on Russian tax number algorithm here:
       # https://ru.wikipedia.org/wiki/Идентификационный_номер_налогоплательщика#Вычисление_контрольных_цифр
@@ -526,7 +525,6 @@ module Faker
       #   Faker::Comnpany.russian_tax_number
       #   Faker::Comnpany.russian_tax_number(region: 'AZ')
       #   Faker::Comnpany.russian_tax_number(region: 'AZ', type: false)
-      # rubocop:enable Style/AsciiComments
       def inn_number(region, type)
         n10 = [2, 4, 10, 3, 5, 9, 4, 6, 8]
         n11 = [7, 2, 4, 10, 3, 5, 9, 4, 6, 8]

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
 
       ##
@@ -530,6 +536,35 @@ module Faker
         '%08x-%04x-%04x-%04x-%04x%08x' % ary # rubocop:disable Style/FormatString
       end
 
+      ##
+      # Produces a random string of alphabetic characters, (no digits)
+      #
+      # @param length [Integer] The length of the string to generate
+      # @param padding [Boolean] Toggles if a final equal '=' will be added.
+      # @param urlsafe [Boolean] Toggles charset to '-' and '_' instead of '+' and '/'.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Internet.base64
+      #     #=> "r_hbZ2DSD-ZACzZT"
+      # @example
+      #   Faker::Internet.base64(length: 4, padding: true, urlsafe: false)
+      #     #=> "x1/R="
+      #
+      # @faker.version 2.11.0
+      def base64(length: 16, padding: false, urlsafe: true)
+        char_range = [
+          Array('0'..'9'),
+          Array('A'..'Z'),
+          Array('a'..'z'),
+          urlsafe ? %w[- _] : %w[+ /]
+        ].flatten
+        s = Array.new(length) { sample(char_range) }.join
+        s += '=' if padding
+        s
+      end
+
       ##
       # Produces a randomized hash of internet user details
       # @example

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/religion.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Faker
+  module Religion
+  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/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/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

data/lib/faker/japanese_media/kamen_rider.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Faker
+  class JapaneseMedia
+    class KamenRider < Base
+      class << self
+        ERAS = %i[showa heisei reiwa].freeze
+
+        def eras=(new_eras)
+          selected_eras = ERAS & new_eras
+          @eras = selected_eras.empty? ? ERAS : selected_eras
+        end
+
+        ##
+        # Produces the name of a Kamen Rider from a series in the given era.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::JapaneseMedia::KamenRider.kamen_rider #=> "Kamen Rider Revice"
+        #
+        # @faker.version next
+        def kamen_rider(*eras)
+          from_eras(*eras, field: :kamen_riders)
+        end
+
+        ##
+        # Produces the name of a main user of Kamen Rider.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::JapaneseMedia::KamenRider.user #=> "Ikki Igarashi"
+        #
+        # @faker.version next
+        def user(*eras)
+          from_eras(*eras, field: :users)
+        end
+
+        ##
+        # Produces the name of a Kamen Rider series.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::JapaneseMedia::KamenRider.series #=> "Kamen Rider Revice"
+        #
+        # @faker.version next
+        def series(*eras)
+          from_eras(*eras, field: :series)
+        end
+
+        ##
+        # Produces the name of a collectible device from a Kamen Rider series.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::JapaneseMedia::KamenRider.collectible_device #=> "Vistamp"
+        #
+        # @faker.version next
+        def collectible_device(*eras)
+          from_eras(*eras, field: :collectible_devices) { |e| e.delete(:showa) }
+        end
+
+        # Produces the name of a transformation device used by a Kamen Rider
+        # from the given eras.
+        #
+        # @return [String]
+        #
+        # @example Faker::JapaneseMedia::KamenRider.transformation_device #=>
+        # "Revice Driver"
+        #
+        # @faker.version next
+        def transformation_device(*eras)
+          from_eras(*eras, field: :transformation_devices)
+        end
+
+        private
+
+        def eras
+          @eras ||= ERAS
+        end
+
+        def from_eras(*input_eras, field:)
+          selected_eras = (ERAS & input_eras).yield_self do |selected|
+            selected.empty? ? eras : selected
+          end.dup
+          yield(selected_eras) if block_given?
+
+          raise UnavailableInEra, "#{field} is unavailable in the selected eras." if selected_eras.empty?
+
+          selected_eras.sample.yield_self do |era|
+            fetch("kamen_rider.#{era}.#{field}")
+          end
+        end
+
+        class UnavailableInEra < StandardError; end
+      end
+    end
+  end
+end

data/lib/faker/religion/bible.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Faker
+  module Religion
+    class Bible < Base
+      flexible :bible
+
+      class << self
+        ##
+        # Returns a random bible character.
+        #
+        # @return [String]
+        #
+        # @example
+        # Faker::Religion::Bible.character #=> "Jesus"
+        #
+        # @faker.version next
+        def character
+          fetch('bible.character')
+        end
+
+        ##
+        # Returns a random location(city or town) from the bible
+        #
+        # @return [String]
+        #
+        # @example
+        # Faker::Religion::Bible.location #=> "Nasareth"
+        #
+        # @faker.version next
+        def location
+          fetch('bible.location')
+        end
+
+        ##
+        # Returns a random quote from the location.
+        #
+        # @return [String]
+        #
+        # @example
+        # Faker::Religion::Bible.quote #=> "Seek first the kingdom of God "
+        #
+        # @faker.version next
+        def quote
+          fetch('bible.quote')
+        end
+      end
+    end
+  end
+end

data/lib/faker/tv_shows/brooklyn_nine_nine.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Faker
+  class TvShows
+    class BrooklynNineNine < Base
+      flexible :brooklyn_nine_nine
+
+      class << self
+        ##
+        # Produces a character from Brooklyn Nine Nine.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::BrooklynNineNine.character #=> "Jake Peralta"
+        #
+        # @faker.version next
+        def character
+          fetch('brooklyn_nine_nine.characters')
+        end
+
+        ##
+        # Produces a quote from Brooklyn Nine Nine.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::TvShows::BrooklynNineNine.quote
+        #     #=> "Cool, cool, cool, cool, cool. No doubt, no doubt, no doubt."
+        #
+        # @faker.version next
+        def quote
+          fetch('brooklyn_nine_nine.quotes')
+        end
+      end
+    end
+  end
+end