faker 2.15.1 → 3.4.2

data/lib/faker/games/touhou.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Faker
+  class Games
+    class Touhou < Base
+      flexible :touhou
+      class << self
+        ##
+        # Produces the name of a Touhou game.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Touhou.game #=> "Mountain of Faith"
+        #
+        # @faker.version next
+        def game
+          fetch('games.touhou.games')
+        end
+
+        ##
+        # Produces the name of a character from the Touhou games.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Touhou.character #=> "Sanae Kochiya"
+        #
+        # @faker.version next
+        def character
+          fetch('games.touhou.characters')
+        end
+
+        ##
+        # Produces the name of a location from the Touhou games.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Touhou.location #=> "Moriya Shrine"
+        #
+        # @faker.version next
+        def location
+          fetch('games.touhou.locations')
+        end
+
+        ##
+        # Produces the name of a spell card from the Touhou games.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Touhou.spell_card #=> 'Esoterica "Gray Thaumaturgy"'
+        #
+        # @faker.version next
+        def spell_card
+          fetch('games.touhou.spell_cards')
+        end
+
+        ##
+        # Produces the name of a song from the Touhou games.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Touhou.song #=> "Faith Is for the Transient People"
+        #
+        # @faker.version next
+        def song
+          fetch('games.touhou.songs')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Faker
+  class JapaneseMedia
+    class CowboyBebop < Base
+      class << self
+        ##
+        # Produces a character from Cowboy Bebop.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::JapaneseMedia::CowboyBebop.character #=> "Spike Spiegel"
+        #
+        # @faker.version next
+        def character
+          fetch('cowboy_bebop.character')
+        end
+
+        ##
+        # Produces an episode from Cowboy Bebop.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::JapaneseMedia::CowboyBebop.episode #=> "Honky Tonk Women"
+        #
+        # @faker.version next
+        def episode
+          fetch('cowboy_bebop.episode')
+        end
+
+        ##
+        # Produces a song title from Cowboy Bebop.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::JapaneseMedia::CowboyBebop.songs #=> "Live in Baghdad"
+        #
+        # @faker.version next
+        def song
+          fetch('cowboy_bebop.song')
+        end
+
+        ##
+        # Produces a quote from Cowboy Bebop.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::JapaneseMedia::CowboyBebop.quote #=> "Bang!!!"
+        #
+        # @faker.version next
+        def quote
+          fetch('cowboy_bebop.quote')
+        end
+      end
+    end
+  end
+end

data/lib/faker/japanese_media/fullmetal_alchemist_brotherhood.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Faker
+  class JapaneseMedia
+    class FullmetalAlchemistBrotherhood < Base
+      class << self
+        ##
+        # Produces a character from FullmetalAlchemistBrotherhood.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::JapaneseMedia::FullmetalAlchemistBrotherhood.character #=> "Edward Elric"
+        #
+        # @faker.version next
+        def character
+          fetch('fullmetal_alchemist_brotherhood.characters')
+        end
+
+        ##
+        # Produces a cities from FullmetalAlchemistBrotherhood.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::JapaneseMedia::FullmetalAlchemistBrotherhood.city #=> "Central City"
+        #
+        # @faker.version next
+        def city
+          fetch('fullmetal_alchemist_brotherhood.cities')
+        end
+
+        ##
+        # Produces a country from FullmetalAlchemistBrotherhood.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::JapaneseMedia::FullmetalAlchemistBrotherhood.country #=> "Xing"
+        #
+        # @faker.version next
+        def country
+          fetch('fullmetal_alchemist_brotherhood.countries')
+        end
+      end
+    end
+
+    include Faker::Deprecator
+    deprecate_generator('FmaBrotherhood', FullmetalAlchemistBrotherhood)
+  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).then 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.then do |era|
+            fetch("kamen_rider.#{era}.#{field}")
+          end
+        end
+
+        class UnavailableInEra < StandardError; end
+      end
+    end
+  end
+end

data/lib/faker/japanese_media/one_piece.rb

@@ -79,7 +79,7 @@ module Faker
         #
         # @faker.version 1.8.5
         def akuma_no_mi
-          fetch('one_piece.akumas_no_mi')
+          fetch('one_piece.akuma_no_mi')
         end
       end
     end

data/lib/faker/locations/australia.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Faker
+  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::Locations::Australia.state
+        #    #=> "New South Wales"
+        #
+        # @faker.version next
+        def state
+          fetch('locations.australia.states')
+        end
+      end
+    end
+  end
+
+  include Deprecator
+  deprecate_generator('Australia', Locations::Australia)
+end

data/lib/faker/movies/avatar.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Faker
+  class Movies
+    class Avatar < Base
+      class << self
+        ##
+        # Produces a character from Avatar.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Avatar.character #=> "Jake Sully"
+        #
+        # @faker.version next
+        def character
+          fetch('avatar.characters')
+        end
+
+        ##
+        # Produces a date from Avatar.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Avatar.date #=> "December 15, 2022"
+        #
+        # @faker.version next
+        def date
+          fetch('avatar.dates')
+        end
+
+        ##
+        # Produces a quote from Avatar.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Avatar.quote
+        #     #=> "If it ain't raining, we ain't training."
+        #
+        # @faker.version next
+        def quote
+          fetch('avatar.quotes')
+        end
+      end
+    end
+  end
+end

data/lib/faker/movies/hackers.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Faker
+  class Movies
+    class Hackers < Base
+      class << self
+        ##
+        # Produces a real character name from Hackers.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Hackers.character #=> "Dade Murphy"
+        #
+        # @faker.version next
+        def character
+          fetch('hackers.characters')
+        end
+
+        ##
+        # Produces a character hacker "handle" from Hackers.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Hackers.handle #=> "Zero Cool"
+        #
+        # @faker.version next
+        def handle
+          fetch('hackers.handles')
+        end
+
+        ##
+        # Produces a quote from Hackers.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Movies::Hackers.quote #=> "Hack the Planet!"
+        #
+        # @faker.version next
+        def quote
+          fetch('hackers.quotes')
+        end
+      end
+    end
+  end
+end

data/lib/faker/movies/star_wars.rb

@@ -138,11 +138,7 @@ module Faker
         #     #=> "Aren't you a little short for a Stormtrooper?"
         #
         # @faker.version 1.6.2
-        def quote(legacy_character = NOT_GIVEN, character: nil)
-          warn_for_deprecated_arguments do |keywords|
-            keywords << :character if legacy_character != NOT_GIVEN
-          end
-
+        def quote(character: nil)
           quoted_characters = translate('faker.star_wars.quotes')
 
           if character.nil?
@@ -161,34 +157,106 @@ module Faker
           fetch("star_wars.quotes.#{character}")
         end
 
+        ##
+        # Generates numbers array
+        #
+        # @return [Array]
+        #
+        # @example
+        #   Faker::Movies::StarWars.call_numbers  #=> ["Leader", "#"]
+        #
+        # @faker.version 1.6.2
         def call_numbers
           fetch_all('star_wars.call_numbers')
         end
 
+        ##
+        # Returns squadrons array
+        #
+        # @return [Array]
+        #
+        # @example
+        #   Faker::Movies::StarWars.call_squadrons  #=> ["Rogue", "Red", "Gray", "Green", "Blue", "Gold", "Black", "Yellow", "Phoenix"]
+        #
+        # @faker.version 1.6.2
         def call_squadrons
           fetch_all('star_wars.call_squadrons')
         end
 
+        ##
+        # Returns all character names in movie
+        #
+        # @return [Array]
+        #
+        # @example
+        #   Faker::Movies::StarWars.characters
+        #
+        # @faker.version 1.6.2
         def characters
           fetch_all('star_wars.characters')
         end
 
+        ##
+        # Returns droid list
+        #
+        # @return [Array]
+        #
+        # @example
+        #   Faker::Movies::StarWars.droids
+        #
+        # @faker.versionn 1.6.2
         def droids
           fetch_all('star_wars.droids')
         end
 
+        ##
+        # Lists out all planet names
+        #
+        # @return [Array]
+        #
+        # @example
+        #   Faker::Movies::StarWars.planets
+        #
+        # @faker.version 1.6.2
         def planets
           fetch_all('star_wars.planets')
         end
 
+        ##
+        # Returns name of all species
+        #
+        # @return [Array]
+        #
+        # @example
+        #   Faker::Movies::StarWars.species
+        #
+        # @faker.version 1.6.2
         def species
           fetch_all('star_wars.species')
         end
 
+        ##
+        # Lists out all vehicles
+        #
+        # @return [Array]
+        #
+        # @example
+        #   Faker::Movies::StarWars.vehicles
+        #
+        # @faker.version 1.6.2
         def vehicles
           fetch_all('star_wars.vehicles')
         end
 
+        ##
+        # All wookiee words
+        #
+        # @return [Array]
+        #
+        # @example
+        #   Faker::Movies::StarWars.wookiee_words
+        #
+        # @faker.version 1.6.2
         def wookiee_words
           fetch_all('star_wars.wookiee_words')
         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