faker 2.2.0 → 3.2.2

data/lib/faker/books/lovecraft.rb

@@ -4,55 +4,132 @@ module Faker
   class Books
     class Lovecraft < Base
       class << self
+        ##
+        # Produces the name of a location
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::Lovecraft.location #=> "Kingsport"
+        #
+        # @faker.version 1.9.3
         def location
           fetch('lovecraft.location')
         end
 
-        def fhtagn(legacy_number = NOT_GIVEN, number: 1)
-          if legacy_number != NOT_GIVEN
-            warn_with_uplevel 'Passing `number` with the 1st argument of `Lovecraft.fhtagn` is deprecated. Use keyword argument like `Lovecraft.fhtagn(number: ...)` instead.', uplevel: 1
-            number = legacy_number
-          end
-
+        ##
+        # @param number [Integer] The number of times to repeat the chant
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::Lovecraft.fhtagn
+        #     #=> "Ph'nglui mglw'nafh Cthulhu R'lyeh wgah'nagl fhtagn"
+        # @example
+        #   Faker::Books::Lovecraft.fhtagn(number: 3)
+        #     #=> "Ph'nglui mglw'nafh Cthulhu R'lyeh wgah'nagl fht...
+        #
+        # @faker.version 1.9.3
+        def fhtagn(number: 1)
           Array.new(number) { fetch('lovecraft.fhtagn') }.join('. ')
         end
 
+        ##
+        # Produces the name of a deity
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::Lovecraft.deity #=> "Shub-Niggurath"
+        #
+        # @faker.version 1.9.3
         def deity
           fetch('lovecraft.deity')
         end
 
+        ##
+        # Produces the name of a tome
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::Lovecraft.tome #=> "Book of Eibon"
+        #
+        # @faker.version 1.9.3
         def tome
           fetch('lovecraft.tome')
         end
 
-        def sentence(legacy_word_count = NOT_GIVEN, legacy_random_words_to_add = NOT_GIVEN, word_count: 4, random_words_to_add: 6)
-          if legacy_word_count != NOT_GIVEN
-            warn_with_uplevel 'Passing `word_count` with the 1st argument of `Lovecraft.sentence` is deprecated. Use keyword argument like `Lovecraft.sentence(word_count: ...)` instead.', uplevel: 1
-            word_count = legacy_word_count
-          end
-          if legacy_random_words_to_add != NOT_GIVEN
-            warn_with_uplevel 'Passing `random_words_to_add` with the 2nd argument of `Lovecraft.sentence` is deprecated. Use keyword argument like `Lovecraft.sentence(random_words_to_add: ...)` instead.', uplevel: 1
-            random_words_to_add = legacy_random_words_to_add
-          end
-
-          words(number: word_count + rand(random_words_to_add.to_i).to_i, spaces_allowed: true).join(' ').capitalize + '.'
+        ##
+        # Produces a random sentence
+        #
+        # @param word_count [Integer] The number of words to have in the sentence
+        # @param random_words_to_add [Integer]
+        # @param open_compounds_allowed [Boolean] If true, generated sentence can contain words having additional spaces
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::Lovecraft.sentence
+        #     #=> "Furtive antiquarian squamous dank cat loathsome amorphous lurk."
+        # @example
+        #   Faker::Books::Lovecraft.sentence(word_count: 3)
+        #     #=> "Daemoniac antediluvian fainted squamous comprehension gambrel nameless singular."
+        # @example
+        #   Faker::Books::Lovecraft.sentence(word_count: 3, random_words_to_add: 1)
+        #     #=> "Amorphous indescribable tenebrous."
+        # @example
+        #   Faker::Books::Lovecraft.sentence(word_count: 3, random_words_to_add: 0, open_compounds_allowed: true)
+        #     #=> "Effulgence unmentionable gambrel."
+        #
+        # @faker.version 1.9.3
+        def sentence(word_count: 4, random_words_to_add: 6, open_compounds_allowed: true)
+          "#{words(number: word_count + rand(random_words_to_add.to_i).to_i, spaces_allowed: open_compounds_allowed).join(' ').capitalize}."
         end
 
+        ##
+        # Produces a random word
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::Lovecraft.word #=> "furtive"
+        #
+        # @faker.version 1.9.3
         def word
           random_word = sample(translate('faker.lovecraft.words'))
           random_word =~ /\s/ ? word : random_word
         end
 
-        def words(legacy_number = NOT_GIVEN, legacy_spaces_allowed = NOT_GIVEN, number: 3, spaces_allowed: false)
-          if legacy_number != NOT_GIVEN
-            warn_with_uplevel 'Passing `number` with the 1st argument of `Lovecraft.words` is deprecated. Use keyword argument like `Lovecraft.words(number: ...)` instead.', uplevel: 1
-            number = legacy_number
-          end
-          if legacy_spaces_allowed != NOT_GIVEN
-            warn_with_uplevel 'Passing `spaces_allowed` with the 2nd argument of `Lovecraft.words` is deprecated. Use keyword argument like `Lovecraft.words(spaces_allowed: ...)` instead.', uplevel: 1
-            spaces_allowed = legacy_spaces_allowed
-          end
-
+        ##
+        # Produces a array of random words
+        #
+        # @param number [Integer] Number of words to generate
+        # @param spaces_allowed [Boolean] If true, generated words can contain spaces
+        #
+        # @return [Array<String>]
+        #
+        # @example
+        #   Faker::Books::Lovecraft.words
+        #   #=> [
+        #   #     "manuscript",
+        #   #     "abnormal",
+        #   #     "singular",
+        #   #   ]
+        # @example
+        #   Faker::Books::Lovecraft.words(number: 2)
+        #   #=> [
+        #   #     "daemoniac",
+        #   #     "cat",
+        #   #   ]
+        # @example
+        #   Faker::Books::Lovecraft.words(number: 2, spaces_allowed: 1)
+        #   #=> [
+        #   #     "lurk",
+        #   #     "charnel",
+        #   #   ]
+        #
+        # @faker.version 1.9.3
+        def words(number: 3, spaces_allowed: false)
           resolved_num = resolve(number)
           word_list = translate('faker.lovecraft.words')
           word_list *= ((resolved_num / word_list.length) + 1)
@@ -63,12 +140,29 @@ module Faker
           words.each_with_index { |w, i| words[i] = word if w =~ /\s/ }
         end
 
-        def sentences(legacy_number = NOT_GIVEN, number: 3)
-          if legacy_number != NOT_GIVEN
-            warn_with_uplevel 'Passing `number` with the 1st argument of `Lovecraft.sentences` is deprecated. Use keyword argument like `Lovecraft.sentences(number: ...)` instead.', uplevel: 1
-            number = legacy_number
-          end
-
+        ##
+        # Produces a array of random sentences
+        #
+        # @param number [Integer] Number of sentences to generate
+        #
+        # @return [Array<String>]
+        #
+        # @example
+        #   Faker::Books::Lovecraft.sentences
+        #   #=> [
+        #   #     "Nameless loathsome decadent gambrel.",
+        #   #     "Ululate swarthy immemorial cat madness gibbous unmentionable unnamable.",
+        #   #     "Decadent antediluvian non-euclidean tentacles amorphous tenebrous.",
+        #   #   ]
+        # @example
+        #   Faker::Books::Lovecraft.sentences(number: 2)
+        #   #=> [
+        #   #     "Antediluvian amorphous unmentionable singular accursed squamous immemorial.",
+        #   #     "Gambrel daemoniac gibbous stygian shunned ululate iridescence abnormal.",
+        #   #   ]
+        #
+        # @faker.version 1.9.3
+        def sentences(number: 3)
           [].tap do |sentences|
             1.upto(resolve(number)) do
               sentences << sentence(word_count: 3)
@@ -76,25 +170,52 @@ module Faker
           end
         end
 
-        def paragraph(legacy_sentence_count = NOT_GIVEN, legacy_random_sentences_to_add = NOT_GIVEN, sentence_count: 3, random_sentences_to_add: 3)
-          if legacy_sentence_count != NOT_GIVEN
-            warn_with_uplevel 'Passing `sentence_count` with the 1st argument of `Lovecraft.paragraph` is deprecated. Use keyword argument like `Lovecraft.paragraph(sentence_count: ...)` instead.', uplevel: 1
-            sentence_count = legacy_sentence_count
-          end
-          if legacy_random_sentences_to_add != NOT_GIVEN
-            warn_with_uplevel 'Passing `random_sentences_to_add` with the 2nd argument of `Lovecraft.paragraph` is deprecated. Use keyword argument like `Lovecraft.paragraph(random_sentences_to_add: ...)` instead.', uplevel: 1
-            random_sentences_to_add = legacy_random_sentences_to_add
-          end
-
+        ##
+        # Produces a random paragraph
+        #
+        # @param sentence_count [Integer] Number of sentences to generate
+        # @param random_sentences_to_add [Integer]
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::Lovecraft.paragraph
+        #     #=> "Squamous nameless daemoniac fungus ululate. Cyclopean stygian decadent loathsome manuscript tenebrous. Foetid abnormal stench. Dank non-euclidean comprehension eldritch. Charnel singular shunned lurk effulgence fungus."
+        # @example
+        #   Faker::Books::Lovecraft.paragraph(sentence_count: 2)
+        #     #=> "Decadent lurk tenebrous loathsome furtive spectral amorphous gibbous. Gambrel eldritch daemoniac cat madness comprehension stygian effulgence."
+        # @example
+        #   Faker::Books::Lovecraft.paragraph(sentence_count: 1, random_sentences_to_add: 1)
+        #     #=> "Stench cyclopean fainted antiquarian nameless. Antiquarian ululate tenebrous non-euclidean effulgence."
+        #
+        # @faker.version 1.9.3
+        def paragraph(sentence_count: 3, random_sentences_to_add: 3)
           sentences(number: resolve(sentence_count) + rand(random_sentences_to_add.to_i).to_i).join(' ')
         end
 
-        def paragraphs(legacy_number = NOT_GIVEN, number: 3)
-          if legacy_number != NOT_GIVEN
-            warn_with_uplevel 'Passing `number` with the 1st argument of `Lovecraft.paragraphs` is deprecated. Use keyword argument like `Lovecraft.paragraphs(number: ...)` instead.', uplevel: 1
-            number = legacy_number
-          end
-
+        ##
+        # Produces a array of random paragraphs
+        #
+        # @param number [Integer] Number of paragraphs to generate
+        #
+        # @return [Array<String>]
+        #
+        # @example
+        #   Faker::Books::Lovecraft.paragraphs
+        #   #=> [
+        #   #     "Noisome daemoniac gibbous abnormal antediluvian. Unutterable fung...
+        #   #     "Non-euclidean immemorial indescribable accursed furtive. Dank unn...
+        #   #     "Charnel antediluvian unnamable cat blasphemous comprehension tene...
+        #   #   ]
+        # @example
+        #   Faker::Books::Lovecraft.paragraphs(number: 2)
+        #   #=> [
+        #   #     "Hideous amorphous manuscript antediluvian non-euclidean cat eldri...
+        #   #     "Tenebrous unnamable comprehension antediluvian lurk. Lurk spectra...
+        #   #   ]
+        #
+        # @faker.version 1.9.3
+        def paragraphs(number: 3)
           [].tap do |paragraphs|
             1.upto(resolve(number)) do
               paragraphs << paragraph(sentence_count: 3)
@@ -102,17 +223,25 @@ module Faker
           end
         end
 
-        def paragraph_by_chars(legacy_characters = NOT_GIVEN, characters: 256)
-          if legacy_characters != NOT_GIVEN
-            warn_with_uplevel 'Passing `characters` with the 1st argument of `Lovecraft.paragraph_by_chars` is deprecated. Use keyword argument like `Lovecraft.paragraph_by_chars(characters: ...)` instead.', uplevel: 1
-            characters = legacy_characters
-          end
-
+        ##
+        # @param characters [Integer] Number of characters to generate in the paragraph
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::Lovecraft.paragraph_by_chars
+        #     #=> "Truffaut stumptown trust fund 8-bit messenger bag portland. Meh kombucha selvage swag biodiesel. Lomo kinfolk jean shorts asymmetrical diy. Wayfarers portland twee stumptown. Wes anderson biodiesel retro 90's pabst. Diy echo 90's mixtape semiotics. Cornho."
+        # @example
+        #   Faker::Books::Lovecraft.paragraph_by_chars(characters: 128)
+        #     #=> "Effulgence madness noisome. Fungus stygian mortal madness amorphous dank. Decadent noisome hideous effulgence. Tentacles charne."
+        #
+        # @faker.version 1.9.3
+        def paragraph_by_chars(characters: 256)
           paragraph = paragraph(sentence_count: 3)
 
-          paragraph += ' ' + paragraph(sentence_count: 3) while paragraph.length < characters
+          paragraph += " #{paragraph(sentence_count: 3)}" while paragraph.length < characters
 
-          paragraph[0...characters - 1] + '.'
+          "#{paragraph[0...characters - 1]}."
         end
       end
     end

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/creature/animal.rb

@@ -4,6 +4,15 @@ module Faker
   class Creature
     class Animal < Base
       class << self
+        ##
+        # Produces a random animal name
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Animal.name #=> "fly"
+        #
+        # @faker.version 1.9.2
         def name
           fetch('creature.animal.name')
         end

data/lib/faker/creature/bird.rb

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+module Faker
+  class Creature
+    class Bird < Base
+      flexible :bird
+
+      class << self
+        ##
+        # Produces a random common family name of a bird.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.common_family_name #=> "Owls"
+        #
+        # @faker.version next
+        def common_family_name
+          fetch('creature.bird.common_family_name')
+        end
+
+        ##
+        # Produces a random common taxonomic order from the class Aves
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.order #=> "Passeriformes"
+        #
+        # @faker.version next
+        def order
+          orders = I18n.translate('faker.creature.bird.order_common_map').keys
+          sample(orders).to_s
+        end
+
+        ##
+        # Produces a random bird anatomy word
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.anatomy #=> "rump"
+        #
+        # @faker.version next
+        def anatomy
+          fetch('creature.bird.anatomy')
+        end
+
+        ##
+        # Produces a random, past tensed bird anatomy word
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.anatomy #=> "breasted"
+        #
+        # @faker.version next
+        def anatomy_past_tense
+          fetch('creature.bird.anatomy_past_tense')
+        end
+
+        ##
+        # Produces a random geographical word used in describing birds
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.geo #=> "Eurasian"
+        #
+        # @faker.version next
+        def geo
+          fetch('creature.bird.geo')
+        end
+
+        ##
+        # Produces a random color word used in describing birds
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.color #=> "ferruginous"
+        #
+        # @faker.version next
+        def color
+          fetch('creature.bird.colors')
+        end
+
+        ##
+        # Produces a random adjective used to described birds
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.adjective #=> 'common'
+        #
+        # @faker.version next
+        def adjective
+          fetch('creature.bird.adjectives')
+        end
+
+        ##
+        # Produces a random emotional adjective NOT used to described birds
+        # ...but could be
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.emotional_adjective #=> 'cantankerous'
+        #
+        # @faker.version next
+        def emotional_adjective
+          fetch('creature.bird.emotional_adjectives')
+        end
+
+        ##
+        # Produces a random adjective NOT used to described birds
+        # ...but probably shouldn't
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.silly_adjective #=> 'drunk'
+        #
+        # @faker.version next
+        def silly_adjective
+          fetch('creature.bird.silly_adjectives')
+        end
+
+        ##
+        # Produces a random common name for a bird
+        #
+        # @param [String | Symbol | nil] tax_order Tax
+        # @return [String]
+        # @raises TypeError If `tax_order` cannot be converted into a Symbol
+        # @raises ArgumentError If `tax_order` is not a valid taxonomic order
+        #
+        # @example
+        #   Faker::Creature::Bird.common_name #=> 'wren'
+        #
+        # @faker.version next
+        def common_name(tax_order = nil)
+          map = translate('faker.creature.bird.order_common_map')
+          if tax_order.nil?
+            sample(map.values.flatten).downcase
+          else
+            raise TypeError, 'tax_order parameter must be symbolizable' \
+              unless tax_order.respond_to?(:to_sym)
+            raise ArgumentError, "#{tax_order} is not a valid taxonomic order" \
+                                 unless map.keys.include?(tax_order.to_sym)
+
+            the_order = translate('faker.creature.bird.order_common_map')[tax_order.to_sym]
+            sample(the_order).downcase
+          end
+        end
+
+        ##
+        # Produces a random and plausible common name for a bird
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.plausible_common_name #=> 'Hellinger's Wren'
+        #
+        # @faker.version next
+        def plausible_common_name
+          parse('creature.bird.plausible_common_names').capitalize
+        end
+
+        ##
+        # Produces a random and IMplausible common name for a bird
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.implausible_common_name #=> 'Hellinger's Cantankerous Chickadee'
+        #
+        # @faker.version next
+        def implausible_common_name
+          parse('creature.bird.implausible_common_names').capitalize
+        end
+
+        ##
+        # Produces a hash entry with a random order and a random common name
+        # that is of that order
+        #
+        # @return [Hash<order,common_name>]
+        #
+        # @example
+        #  Faker::Creature::Bird.order_with_common_name #=> {
+        #    order: ''Accipitriformes',
+        #    common_name: 'Osprey'
+        # }
+        #
+        # @faker.version next
+        def order_with_common_name(tax_order = nil)
+          map = I18n.translate('faker.creature.bird.order_common_map')
+          o = tax_order.nil? ? order : tax_order
+          { order: o, common_name: sample(map[o.to_sym]) }
+        end
+      end
+    end
+  end
+end

data/lib/faker/creature/cat.rb

@@ -6,14 +6,41 @@ module Faker
       flexible :cat
 
       class << self
+        ##
+        # Produces a random name for a cat
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Cat.name #=> "Felix"
+        #
+        # @faker.version 1.9.2
         def name
           fetch('creature.cat.name')
         end
 
+        ##
+        # Produces a random cat breed
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Cat.breed #=> "Scottish Fold"
+        #
+        # @faker.version 1.9.2
         def breed
           fetch('creature.cat.breed')
         end
 
+        ##
+        # Produces a random cat breed registry
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Cat.registry #=> "Fancy Southern Africa Cat Council"
+        #
+        # @faker.version 1.9.2
         def registry
           fetch('creature.cat.registry')
         end