faker 3.2.3 → 3.3.1

data/lib/faker/default/phone_number.rb

@@ -4,12 +4,14 @@ module Faker
   class PhoneNumber < Base
     class << self
       ##
-      # Produces a random phone number in a random format (may or may not have a country code, extension and can have different dividers).
+      # Produces a phone number in a random format without the country code and it can have different dividers.
       #
       # @return [String]
       #
       # @example
-      #   Faker::PhoneNumber.phone_number #=> "397.693.1309 x4321"
+      #   Faker::PhoneNumber.phone_number #=> "(504) 113-1705"
+      #   Faker::PhoneNumber.phone_number #=> "662.291.7201"
+      #   Faker::PhoneNumber.phone_number #=> "9415283713"
       #
       # @faker.version 0.3.0
       def phone_number
@@ -17,12 +19,14 @@ module Faker
       end
 
       ##
-      # Produces a random cell phone number in a random format (may or may not have a country code and can have different dividers).
+      # Produces a random cell phone number in a random format without the country code and it can have different dividers.
       #
       # @return [String]
       #
       # @example
-      #   Faker::PhoneNumber.cell_phone #=> "(186)285-7925"
+      #   Faker::PhoneNumber.cell_phone #=> "(836) 115-8995"
+      #   Faker::PhoneNumber.cell_phone #=> "382-597-5739"
+      #   Faker::PhoneNumber.cell_phone #=> "316.828.1822"
       #
       # @faker.version 1.0.0
       def cell_phone
@@ -36,10 +40,12 @@ module Faker
       #
       # @example
       #   Faker::PhoneNumber.country_code #=> "+20"
+      #   Faker::PhoneNumber.country_code #=> "+39"
+      #   Faker::PhoneNumber.country_code #=> "+852"
       #
       # @faker.version 1.9.2
       def country_code
-        "+#{fetch('country_code')}"
+        "+#{fetch('phone_number.country_code')}"
       end
 
       ##
@@ -48,7 +54,9 @@ module Faker
       # @return [String]
       #
       # @example
-      #   Faker::PhoneNumber.phone_number_with_country_code #=> "+95 1-672-173-8153"
+      #   Faker::PhoneNumber.phone_number_with_country_code #=> "+55 466-746-6882"
+      #   Faker::PhoneNumber.phone_number_with_country_code #=> "+81 3718219558"
+      #   Faker::PhoneNumber.phone_number_with_country_code #=> "+49 140 957 9846"
       #
       # @faker.version 1.9.2
       def phone_number_with_country_code
@@ -61,7 +69,9 @@ module Faker
       # @return [String]
       #
       # @example
-      #   Faker::PhoneNumber.cell_phone_with_country_code #=> "+974 (190) 987-9034"
+      #   Faker::PhoneNumber.cell_phone_with_country_code #=> "+852 (190) 987-9034"
+      #   Faker::PhoneNumber.cell_phone_with_country_code #=> "+64 (820) 583-6474"
+      #   Faker::PhoneNumber.cell_phone_with_country_code #=> "+1 591.871.7985"
       #
       # @faker.version 1.9.2
       def cell_phone_with_country_code
@@ -69,12 +79,14 @@ module Faker
       end
 
       ##
-      # Produces a random phone number in e164 format.
+      # Produces a random phone number in e164 format, i.e., without any dividers.
       #
       # @return [String]
       #
       # @example
-      #   Faker::PhoneNumber.cell_phone_in_e164 #=> "+944937040625"
+      #   Faker::PhoneNumber.cell_phone_in_e164 #=> "+542024834991"
+      #   Faker::PhoneNumber.cell_phone_in_e164 #=> "+8522846847703"
+      #   Faker::PhoneNumber.cell_phone_in_e164 #=> "+649477546575"
       #
       # @faker.version 1.9.2
       def cell_phone_in_e164
@@ -82,49 +94,56 @@ module Faker
       end
 
       ##
-      # Produces a random US or Canada-based area code.
+      # Produces a random area code.
       #
       # @return [String]
       #
       # @example
       #   Faker::PhoneNumber.area_code #=> "201"
+      #   Faker::PhoneNumber.area_code #=> "613"
+      #   Faker::PhoneNumber.area_code #=> "321"
       #
       # @faker.version 1.3.0
       def area_code
         fetch('phone_number.area_code')
-      rescue I18n::MissingTranslationData
-        nil
       end
 
       ##
-      # Produces a random US or Canada-based exchange code.
+      # Produces a random exchange code.
       #
       # @return [String]
       #
       # @example
       #   Faker::PhoneNumber.exchange_code #=> "208"
+      #   Faker::PhoneNumber.exchange_code #=> "415"
+      #   Faker::PhoneNumber.exchange_code #=> "652"
       #
       # @faker.version 1.3.0
       def exchange_code
         fetch('phone_number.exchange_code')
-      rescue I18n::MissingTranslationData
-        nil
       end
 
       ##
-      # Produces a random US or Canada-based extension / subscriber number. Can be used for both extensions and last four digits of phone number.
+      # Produces a random extension / subscriber number. Can be used for both extensions and last four digits of phone number.
       #
-      # @param length [Integer] Specifies the length of the return value.
+      # @param length [Integer] Specifies the length of the return value. Defaults to 4.
       # @return [String]
       #
       # @example
       #   Faker::PhoneNumber.subscriber_number #=> "3873"
       #   Faker::PhoneNumber.subscriber_number(length: 2) #=> "39"
       #   Faker::PhoneNumber.extension #=> "3764"
+      #   Faker::PhoneNumber.extension(length: 2) => "37"
       #
       # @faker.version 1.3.0
       def subscriber_number(length: 4)
-        rand.to_s[2..(1 + length)]
+        if !length.is_a?(Integer) || length > 10
+          raise ArgumentError, 'length must be an Integer and be lesser than 10'
+        end
+
+        generate(:string) do |g|
+          g.int(length: length)
+        end
       end
 
       alias extension subscriber_number

data/lib/faker/default/south_africa.rb

@@ -13,7 +13,7 @@ module Faker
       #
       # @faker.version 1.9.2
       def id_number
-        Faker::IDNumber.south_african_id_number
+        Faker::IdNumber.south_african_id_number
       end
 
       ##
@@ -26,7 +26,7 @@ module Faker
       #
       # @faker.version 1.9.2
       def valid_id_number
-        Faker::IDNumber.valid_south_african_id_number
+        Faker::IdNumber.valid_south_african_id_number
       end
 
       ##
@@ -39,7 +39,7 @@ module Faker
       #
       # @faker.version 1.9.2
       def invalid_id_number
-        Faker::IDNumber.invalid_south_african_id_number
+        Faker::IdNumber.invalid_south_african_id_number
       end
 
       ##

data/lib/faker/{music/show.rb → default/theater.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Faker
-  class Show < Base
+  class Theater < Base
     class << self
       ##
       # Produces the name of a musical for an older audience
@@ -9,12 +9,12 @@ module Faker
       # @return [String]
       #
       # @example
-      #   Faker::Alphanumeric.alpha
-      #     #=> "West Side Story"
+      #   Faker::Theater.adult_musical
+      #     #=> "Mamma Mia!"
       #
       # @faker.version 2.13.0
       def adult_musical
-        fetch('show.adult_musical')
+        fetch('theater.adult_musical')
       end
 
       ##
@@ -23,12 +23,12 @@ module Faker
       # @return [String]
       #
       # @example
-      #   Faker::Alphanumeric.alpha
+      #   Faker::Theater.kids_musical
       #     #=> "Into the Woods JR."
       #
       # @faker.version 2.13.0
       def kids_musical
-        fetch('show.kids_musical')
+        fetch('theater.kids_musical')
       end
 
       ##
@@ -37,13 +37,16 @@ module Faker
       # @return [String]
       #
       # @example
-      #   Faker::Alphanumeric.alpha
+      #   Faker::Theater.play
       #     #=> "Death of a Salesman"
       #
       # @faker.version 2.13.0
       def play
-        fetch('show.play')
+        fetch('theater.play')
       end
     end
   end
+
+  include Faker::Deprecator
+  deprecate_generator('Show', Theater)
 end

data/lib/faker/japanese_media/fullmetal_alchemist_brotherhood.rb

@@ -2,47 +2,50 @@
 
 module Faker
   class JapaneseMedia
-    class FmaBrotherhood < Base
+    class FullmetalAlchemistBrotherhood < Base
       class << self
         ##
-        # Produces a character from FmaBrotherhood.
+        # Produces a character from FullmetalAlchemistBrotherhood.
         #
         # @return [String]
         #
         # @example
-        #   Faker::JapaneseMedia::FmaBrotherhood.character #=> "Edward Elric"
+        #   Faker::JapaneseMedia::FullmetalAlchemistBrotherhood.character #=> "Edward Elric"
         #
         # @faker.version next
         def character
-          fetch('fma_brotherhood.characters')
+          fetch('fullmetal_alchemist_brotherhood.characters')
         end
 
         ##
-        # Produces a cities from FmaBrotherhood.
+        # Produces a cities from FullmetalAlchemistBrotherhood.
         #
         # @return [String]
         #
         # @example
-        #   Faker::JapaneseMedia::FmaBrotherhood.city #=> "Central City"
+        #   Faker::JapaneseMedia::FullmetalAlchemistBrotherhood.city #=> "Central City"
         #
         # @faker.version next
         def city
-          fetch('fma_brotherhood.cities')
+          fetch('fullmetal_alchemist_brotherhood.cities')
         end
 
         ##
-        # Produces a country from FmaBrotherhood.
+        # Produces a country from FullmetalAlchemistBrotherhood.
         #
         # @return [String]
         #
         # @example
-        #   Faker::JapaneseMedia::FmaBrotherhood.country #=> "Xing"
+        #   Faker::JapaneseMedia::FullmetalAlchemistBrotherhood.country #=> "Xing"
         #
         # @faker.version next
         def country
-          fetch('fma_brotherhood.countries')
+          fetch('fullmetal_alchemist_brotherhood.countries')
         end
       end
     end
+
+    include Faker::Deprecator
+    deprecate_generator('FmaBrotherhood', FullmetalAlchemistBrotherhood)
   end
 end

data/lib/faker/locations/australia.rb

@@ -1,47 +1,52 @@
 # frozen_string_literal: true
 
 module Faker
-  class Australia < Base
-    class << self
-      ##
-      # Produces a location in Australia
-      #
-      # @return [String]
-      #
-      # @example
-      #   Faker::Australia.location
-      #    #=> "Sydney"
-      #
-      # @faker.version next
-      def location
-        fetch('australia.locations')
-      end
+  extend Deprecator
 
-      # Produces an Australian animal
-      #
-      # @return [String]
-      #
-      # @example
-      #   Faker::Australia.animal
-      #    #=> "Dingo"
-      #
-      # @faker.version next
-      def animal
-        fetch('australia.animals')
-      end
+  class Locations
+    class Australia < Base
+      class << self
+        ##
+        # Produces a location in Australia
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Locations::Australia.location
+        #    #=> "Sydney"
+        #
+        # @faker.version next
+        def location
+          fetch('locations.australia.locations')
+        end
+
+        # Produces an Australian animal
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Locations::Australia.animal
+        #    #=> "Dingo"
+        #
+        # @faker.version next
+        def animal
+          fetch('locations.australia.animals')
+        end
 
-      # Produces an Australian State or Territory
-      #
-      # @return [String]
-      #
-      # @example
-      #   Faker::Australia.state
-      #    #=> "New South Wales"
-      #
-      # @faker.version next
-      def state
-        fetch('australia.states')
+        # Produces an Australian State or Territory
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Locations::Australia.state
+        #    #=> "New South Wales"
+        #
+        # @faker.version next
+        def state
+          fetch('locations.australia.states')
+        end
       end
     end
   end
+  deprecate_generator('Australia', Locations::Australia)
 end

data/lib/faker/movies/{room.rb → the_room.rb}

@@ -14,7 +14,7 @@ module Faker
         #
         # @faker.version next
         def actor
-          fetch('room.actors')
+          fetch('the_room.actors')
         end
 
         ##
@@ -27,7 +27,7 @@ module Faker
         #
         # @faker.version next
         def character
-          fetch('room.characters')
+          fetch('the_room.characters')
         end
 
         ##
@@ -40,7 +40,7 @@ module Faker
         #
         # @faker.version next
         def location
-          fetch('room.locations')
+          fetch('the_room.locations')
         end
 
         ##
@@ -55,7 +55,7 @@ module Faker
         #
         # @faker.version next
         def quote
-          fetch('room.quotes')
+          fetch('the_room.quotes')
         end
       end
     end

data/lib/faker/music/smashing_pumpkins.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative 'music'
+
+module Faker
+  class Music
+    class SmashingPumpkins < Base
+      class << self
+        ##
+        # Produces the name of a member of the Smashing Pumpkins (current and former)
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::SmashingPumpkins.musician #=> "Billy Corgan"
+        #
+        # @faker.version next
+        def musician
+          fetch('smashing_pumpkins.musicians')
+        end
+
+        ##
+        # Produces the name of an album by the Smashing Pumpkins.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::SmashingPumpkins.album #=> "Siamese Dream"
+        #
+        # @faker.version next
+        def album
+          fetch('smashing_pumpkins.albums')
+        end
+
+        ##
+        # Produces a random Smashing Pumpkins song lyric.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::SmashingPumpkins.lyric #=> "Despite all my rage, I am still just a rat in a cage"
+        #   Faker::Music::SmashingPumpkins.lyric #=> "Breathin' underwater, and livin' under glass"
+        #
+        # @faker.version next
+        def lyric
+          fetch('smashing_pumpkins.lyric')
+        end
+
+        ##
+        # Produces the name of a song by the Smashing Pumpkins.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::SmashingPumpkins.song #=> "Stand Inside My Love"
+        #
+        # @faker.version next
+        def song
+          fetch('smashing_pumpkins.songs')
+        end
+      end
+    end
+  end
+end

data/lib/faker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Faker # :nodoc:
-  VERSION = '3.2.3'
+  VERSION = '3.3.1'
 end

data/lib/helpers/deprecator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Based on Rails ActiveSupport Deprecator
+# https://github.com/rails/rails/blob/6f0d1ad14b92b9f5906e44740fce8b4f1c7075dc/activesupport/lib/active_support/deprecation/constant_accessor.rb
+
+# rubocop:disable Style/ClassVars
+module Faker
+  module Deprecator
+    def self.included(base)
+      extension = Module.new do
+        def const_missing(missing_const_name)
+          if class_variable_defined?(:@@_deprecated_constants) && (replacement = class_variable_get(:@@_deprecated_constants)[missing_const_name.to_s])
+            $stdout.puts("DEPRECATION WARNING: #{name}::#{replacement[:old_generator]} is deprecated. Use #{replacement[:new_constant]} instead.")
+            return replacement[:new_constant]
+          end
+
+          super
+        end
+
+        def deprecate_generator(old_generator_name, new_generator_constant)
+          class_variable_set(:@@_deprecated_constants, {}) unless class_variable_defined?(:@@_deprecated_constants)
+          class_variable_get(:@@_deprecated_constants)[old_generator_name] = { new_constant: new_generator_constant, old_generator: old_generator_name }
+        end
+      end
+
+      base.singleton_class.prepend extension
+    end
+  end
+end
+# rubocop:enable Style/ClassVars

data/lib/locales/bg.yml

@@ -17,7 +17,6 @@ bg:
       default_country: [България]
       default_country_code: ["BG"]
     internet:
-      free_email: [abv.bg, mail.bg, dir.bg, gmail.com, yahoo.com, hotmail.com]
       domain_suffix: [com, bg, info, бг, net, org]
 
     name: