faker 2.3.0 → 2.4.0

data/lib/faker/default/nato_phonetic_alphabet.rb

@@ -3,6 +3,15 @@
 module Faker
   class NatoPhoneticAlphabet < Base
     class << self
+      ##
+      # Produces a code word from the NATO phonetic alphabet.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::NatoPhoneticAlphabet.code_word #=> "Hotel"
+      #
+      # @faker.version 1.9.0
       def code_word
         fetch('nato_phonetic_alphabet.code_word')
       end

data/lib/faker/default/science.rb

@@ -3,14 +3,41 @@
 module Faker
   class Science < Base
     class << self
+      ##
+      # Produces the name of a element.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Science.element #=> "Carbon"
+      #
+      # @faker.version 1.8.5
       def element
         fetch('science.element')
       end
 
+      ##
+      # Produces the symbol of an element.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Science.element_symbol #=> "Pb"
+      #
+      # @faker.version 1.9.0
       def element_symbol
         fetch('science.element_symbol')
       end
 
+      ##
+      # Produces the name of a scientist.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Science.scientist #=> "Isaac Newton"
+      #
+      # @faker.version 1.8.5
       def scientist
         fetch('science.scientist')
       end

data/lib/faker/default/subscription.rb

@@ -2,22 +2,67 @@
 
 module Faker
   class Subscription < Base
+    ##
+    # Produces the name of a subscription plan.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::Subscription.plan #=> "Platinum"
+    #
+    # @faker.version 1.9.2
     def self.plan
       fetch('subscription.plans')
     end
 
+    ##
+    # Produces a subscription status.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::Subscription.status #=> "Active"
+    #
+    # @faker.version 1.9.2
     def self.status
       fetch('subscription.statuses')
     end
 
+    ##
+    # Produces the name of a payment method.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::Subscription.payment_method #=> "PayPal"
+    #
+    # @faker.version 1.9.2
     def self.payment_method
       fetch('subscription.payment_methods')
     end
 
+    ##
+    # Produces the name of a subscription term.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::Subscription.subscription_term #=> "Annual"
+    #
+    # @faker.version 1.9.2
     def self.subscription_term
       fetch('subscription.subscription_terms')
     end
 
+    ##
+    # Produces the name of a payment term.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::Subscription.payment_term #=> "Monthly"
+    #
+    # @faker.version 1.9.2
     def self.payment_term
       fetch('subscription.payment_terms')
     end

data/lib/faker/default/superhero.rb

@@ -3,22 +3,67 @@
 module Faker
   class Superhero < Base
     class << self
+      ##
+      # Produces a superpower.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Superhero.power #=> "Photokinesis"
+      #
+      # @faker.version 1.6.2
       def power
         fetch('superhero.power')
       end
 
+      ##
+      # Produces a superhero name prefix.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Superhero.prefix #=> "the Fated"
+      #
+      # @faker.version 1.6.2
       def prefix
         fetch('superhero.prefix')
       end
 
+      ##
+      # Produces a superhero name suffix.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Superhero.suffix #=> "Captain"
+      #
+      # @faker.version 1.6.2
       def suffix
         fetch('superhero.suffix')
       end
 
+      ##
+      # Produces a superhero descriptor.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Superhero.descriptor #=> "Bizarro"
+      #
+      # @faker.version 1.6.2
       def descriptor
         fetch('superhero.descriptor')
       end
 
+      ##
+      # Produces a random superhero name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Superhero.name #=> "Magnificent Shatterstar"
+      #
+      # @faker.version 1.6.2
       def name
         parse('superhero.name')
       end

data/lib/faker/games/dota.rb

@@ -4,22 +4,69 @@ module Faker
   class Games
     class Dota < Base
       class << self
+        ##
+        # Produces the name of a hero from Dota.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Dota.hero #=> "Abaddon"
+        #
+        # @faker.version 1.9.0
         def hero
           fetch('games.dota.hero')
         end
 
+        ##
+        # Produces the name of an item from Dota.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Dota.item #=> "Armlet of Mordiggian"
+        #
+        # @faker.version 1.9.0
         def item
           fetch('games.dota.item')
         end
 
+        ##
+        # Produces the name of a professional Dota team.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Dota.team #=> "Evil Geniuses"
+        #
+        # @faker.version 1.9.0
         def team
           fetch('games.dota.team')
         end
 
+        ##
+        # Produces the name of a professional Dota player.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Dota.player #=> "Dendi"
+        #
+        # @faker.version 1.9.0
         def player
           fetch('games.dota.player')
         end
 
+        ##
+        # Produces the name of a hero from Dota.
+        #
+        # @param hero [String] The name of a Dota hero.
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Dota.quote #=> "You have called death upon yourself."
+        #   Faker::Games::Dota.quote(hero: 'alchemist') #=> "Better living through alchemy!"
+        #
+        # @faker.version 1.9.0
         def quote(legacy_hero = NOT_GIVEN, hero: 'abaddon')
           warn_for_deprecated_arguments do |keywords|
             keywords << :hero if legacy_hero != NOT_GIVEN

data/lib/faker/games/heroes.rb

@@ -4,14 +4,41 @@ module Faker
   class Games
     class Heroes < Base
       class << self
+        ##
+        # Produces the name of a hero from Heroes 3.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Heroes.name #=> "Christian"
+        #
+        # @faker.version 1.9.2
         def name
           fetch('heroes.names')
         end
 
+        ##
+        # Produces the name of a specialty from Heroes 3.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Heroes.specialty #=> "Ballista"
+        #
+        # @faker.version 1.9.2
         def specialty
           fetch('heroes.specialties')
         end
 
+        ##
+        # Produces the name of a class from Heroes 3.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Heroes.klass #=> "Knight"
+        #
+        # @faker.version 1.9.2
         def klass
           fetch('heroes.klasses')
         end

data/lib/faker/games/heroes_of_the_storm.rb

@@ -4,18 +4,54 @@ module Faker
   class Games
     class HeroesOfTheStorm < Base
       class << self
+        ##
+        # Produces a battleground from Heroes of the Storm.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::HeroesOfTheStorm.battleground #=> "Towers of Doom"
+        #
+        # @faker.version 1.9.2
         def battleground
           fetch('heroes_of_the_storm.battlegrounds')
         end
 
+        ##
+        # Produces a class from Heroes of the Storm.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::HeroesOfTheStorm.class #=> "Support"
+        #
+        # @faker.version 1.9.2
         def class
           fetch('heroes_of_the_storm.classes')
         end
 
+        ##
+        # Produces a hero from Heroes of the Storm.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::HeroesOfTheStorm.hero #=> "Illidan"
+        #
+        # @faker.version 1.9.2
         def hero
           fetch('heroes_of_the_storm.heroes')
         end
 
+        ##
+        # Produces a quote from Heroes of the Storm.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::HeroesOfTheStorm.quote #=> "MEAT!!!"
+        #
+        # @faker.version 1.9.2
         def quote
           fetch('heroes_of_the_storm.quotes')
         end

data/lib/faker/games/league_of_legends.rb

@@ -4,26 +4,80 @@ module Faker
   class Games
     class LeagueOfLegends < Base
       class << self
+        ##
+        # Produces the name of a champion from League of Legends.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::LeagueOfLegends.champion #=> "Jarvan IV"
+        #
+        # @faker.version 1.8.0
         def champion
           fetch('games.league_of_legends.champion')
         end
 
+        ##
+        # Produces a location from League of Legends.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::LeagueOfLegends.location #=> "Demacia"
+        #
+        # @faker.version 1.8.0
         def location
           fetch('games.league_of_legends.location')
         end
 
+        ##
+        # Produces a quote from League of Legends.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::LeagueOfLegends.quote #=> "Purge the unjust."
+        #
+        # @faker.version 1.8.0
         def quote
           fetch('games.league_of_legends.quote')
         end
 
+        ##
+        # Produces a summoner spell from League of Legends.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::LeagueOfLegends.summoner_spell #=> "Flash"
+        #
+        # @faker.version 1.8.0
         def summoner_spell
           fetch('games.league_of_legends.summoner_spell')
         end
 
+        ##
+        # Produces a mastery from League of Legends.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::LeagueOfLegends.masteries #=> "Double Edged Sword"
+        #
+        # @faker.version 1.8.0
         def masteries
           fetch('games.league_of_legends.masteries')
         end
 
+        ##
+        # Produces a rank from League of Legends.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::LeagueOfLegends.rank #=> "Bronze V"
+        #
+        # @faker.version 1.8.0
         def rank
           fetch('games.league_of_legends.rank')
         end

data/lib/faker/games/myst.rb

@@ -4,22 +4,67 @@ module Faker
   class Games
     class Myst < Base
       class << self
+        ##
+        # Produces the name of a game from the Myst series.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Myst.game #=> "Myst III: Exile"
+        #
+        # @faker.version 1.9.0
         def game
           fetch('games.myst.games')
         end
 
+        ##
+        # Produces the name of a creature from Myst.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Myst.creature #=> "squee"
+        #
+        # @faker.version 1.9.0
         def creature
           fetch('games.myst.creatures')
         end
 
+        ##
+        # Produces the name of an age from Myst.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Myst.age #=> "Relto"
+        #
+        # @faker.version 1.9.0
         def age
           fetch('games.myst.ages')
         end
 
+        ##
+        # Produces the name of a chracter from Myst.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Myst.character #=> "Gehn"
+        #
+        # @faker.version 1.9.0
         def character
           fetch('games.myst.characters')
         end
 
+        ##
+        # Produces a quote from Myst.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Myst.quote #=> "I realized, the moment I fell into the fissure, that the Book would not be destroyed as I had planned."
+        #
+        # @faker.version 1.9.0
         def quote
           fetch('games.myst.quotes')
         end