faker 2.8.0 → 2.8.1

data/lib/faker/default/food.rb

@@ -5,42 +5,106 @@ module Faker
     flexible :food
 
     class << self
-      # Retrieves a typical dish from each country
+      ##
+      # Retrieves a typical dish from each country.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Food.dish #=> "Feijoada"
+      #
+      # @faker.version 1.8.0
       def dish
         fetch('food.dish')
       end
 
+      ##
       # Retrieves a description about some dish
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Food.description #=> "Breaded fried chicken with waffles. Served with maple syrup."
+      #
+      # @faker.version 1.9.0
       def description
         fetch('food.descriptions')
       end
 
+      ##
       # Retrieves an ingredient
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Food.ingredient #=> "Olives"
+      #
+      # @faker.version 1.7.0
       def ingredient
         fetch('food.ingredients')
       end
 
+      ##
       # Retrieves a fruit
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Food.fruits #=> "Papaya"
+      #
+      # @faker.version 1.9.0
       def fruits
         fetch('food.fruits')
       end
 
+      ##
       # Retrieves a vegetable
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Food.vegetables #=> "Broccolini"
+      #
+      # @faker.version 1.9.0
       def vegetables
         fetch('food.vegetables')
       end
 
+      ##
       # Retrieves some random spice
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Food.spice #=> "Garlic Chips"
+      #
+      # @faker.version 1.7.0
       def spice
         fetch('food.spices')
       end
 
+      ##
       # Retrieves cooking measures
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Food.measurement #=> "1/3"
+      #
+      # @faker.version 1.7.0
       def measurement
         fetch('food.measurement_sizes') + ' ' + fetch('food.measurements')
       end
 
+      ##
       # Retrieves metric mesurements
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Food.metric_measurement #=> "centiliter"
+      #
+      # @faker.version 1.8.3
       def metric_measurement
         fetch('food.metric_measurements')
       end

data/lib/faker/default/internet.rb

@@ -141,10 +141,19 @@ module Faker
         end
 
         with_locale(:en) do
-          given_domain_word = domain || domain_word
-          domain_elements = [Char.prepare(given_domain_word), domain_suffix]
-          domain_elements.unshift(Char.prepare(given_domain_word)) if subdomain
-          domain_elements.join('.')
+          if domain
+            domain
+              .split('.')
+              .map { |domain_part| Char.prepare(domain_part) }
+              .tap do |domain_elements|
+                domain_elements << domain_suffix if domain_elements.length < 2
+                domain_elements.unshift(Char.prepare(domain_word)) if subdomain && domain_elements.length < 3
+              end.join('.')
+          else
+            [domain_word, domain_suffix].tap do |domain_elements|
+              domain_elements.unshift(Char.prepare(domain_word)) if subdomain
+            end.join('.')
+          end
         end
       end
 

data/lib/faker/default/kpop.rb

@@ -3,26 +3,80 @@
 module Faker
   class Kpop < Base
     class << self
+      ##
+      # Produces the name of a 1990's 'OG' K-Pop group.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Kpop.i_groups #=> "Seo Taiji and Boys"
+      #
+      # @faker.version 1.8.5
       def i_groups
         fetch('kpop.i_groups')
       end
 
+      ##
+      # Produces the name of a 2000's K-Pop group.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Kpop.ii_groups #=> "Girls' Generation"
+      #
+      # @faker.version 1.8.5
       def ii_groups
         fetch('kpop.ii_groups')
       end
 
+      ##
+      # Produces the name of a 2010's K-Pop group.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Kpop.iii_groups #=> "Trouble Maker"
+      #
+      # @faker.version 1.8.5
       def iii_groups
         fetch('kpop.iii_groups')
       end
 
+      ##
+      # Produces the name of a K-Pop girl group.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Kpop.girl_groups #=> "2NE1"
+      #
+      # @faker.version 1.8.5
       def girl_groups
         fetch('kpop.girl_groups')
       end
 
+      ##
+      # Produces the name of a K-Pop boy band.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Kpop.boy_bands #=> "Exo"
+      #
+      # @faker.version 1.8.5
       def boy_bands
         fetch('kpop.boy_bands')
       end
 
+      ##
+      # Produces the name of a solo K-Pop artist.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Kpop.solo #=> "T.O.P"
+      #
+      # @faker.version 1.8.5
       def solo
         fetch('kpop.solo')
       end

data/lib/faker/default/space.rb

@@ -3,59 +3,186 @@
 module Faker
   class Space < Base
     flexible :space
+
     class << self
+      ##
+      # Produces the name of a planet.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.planet #=> "Venus"
+      #
+      # @faker.version 1.6.4
       def planet
         fetch('space.planet')
       end
 
+      ##
+      # Produces the name of a moon.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.moon #=> "Europa"
+      #
+      # @faker.version 1.6.4
       def moon
         fetch('space.moon')
       end
 
+      ##
+      # Produces the name of a galaxy.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.galaxy #=> "Andromeda"
+      #
+      # @faker.version 1.6.4
       def galaxy
         fetch('space.galaxy')
       end
 
+      ##
+      # Produces the name of a nebula.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.nebula #=> "Triffid Nebula"
+      #
+      # @faker.version 1.6.4
       def nebula
         fetch('space.nebula')
       end
 
+      ##
+      # Produces the name of a star cluster.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.star_cluster #=> "Messier 70"
+      #
+      # @faker.version 1.6.4
       def star_cluster
         fetch('space.star_cluster')
       end
 
+      ##
+      # Produces the name of a constellation.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.constellation #=> "Orion"
+      #
+      # @faker.version 1.6.4
       def constellation
         fetch('space.constellation')
       end
 
+      ##
+      # Produces the name of a star.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.star #=> "Proxima Centauri"
+      #
+      # @faker.version 1.6.4
       def star
         fetch('space.star')
       end
 
+      ##
+      # Produces the name of a space agency.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.agency #=> "Japan Aerospace Exploration Agency"
+      #
+      # @faker.version 1.6.4
       def agency
         fetch('space.agency')
       end
 
+      ##
+      # Produces a space agency abbreviation.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.agency_abv #=> "NASA"
+      #
+      # @faker.version 1.6.4
       def agency_abv
         fetch('space.agency_abv')
       end
 
+      ##
+      # Produces the name of a NASA spacecraft.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.nasa_space_craft #=> "Endeavour"
+      #
+      # @faker.version 1.6.4
       def nasa_space_craft
         fetch('space.nasa_space_craft')
       end
 
+      ##
+      # Produces the name of a space company.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.company #=> "SpaceX"
+      #
+      # @faker.version 1.6.4
       def company
         fetch('space.company')
       end
 
+      ##
+      # Produces a distance measurement.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.distance_measurement #=> "15 parsecs"
+      #
+      # @faker.version 1.6.4
       def distance_measurement
         rand(10..100).to_s + ' ' + fetch('space.distance_measurement')
       end
 
+      ##
+      # Produces the name of a meteorite.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.meteorite #=> "Ensisheim"
+      #
+      # @faker.version 1.7.0
       def meteorite
         fetch('space.meteorite')
       end
 
+      ##
+      # Produces the name of a launch vehicle.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Space.launch_vehicle #=> "Saturn IV"
+      #
+      # @faker.version 1.9.0
       def launch_vehicle
         fetch('space.launch_vehicle')
       end

data/lib/faker/default/team.rb

@@ -5,22 +5,67 @@ module Faker
     flexible :team
 
     class << self
+      ##
+      # Produces a team name from a state and a creature.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Team.name #=> "Oregon vixens"
+      #
+      # @faker.version 1.3.0
       def name
         parse('team.name')
       end
 
+      ##
+      # Produces a team creature.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Team.creature #=> "geese"
+      #
+      # @faker.version 1.3.0
       def creature
         fetch('team.creature')
       end
 
+      ##
+      # Produces a team state.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Team.state #=> "Oregon"
+      #
+      # @faker.version 1.3.0
       def state
         fetch('address.state')
       end
 
+      ##
+      # Produces a team sport.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Team.sport #=> "Lacrosse"
+      #
+      # @faker.version 1.5.0
       def sport
         fetch('team.sport')
       end
 
+      ##
+      # Produces the name of a team mascot.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Team.mascot #=> "Hugo"
+      #
+      # @faker.version 1.8.1
       def mascot
         fetch('team.mascot')
       end