faker 2.2.0 → 3.2.2

data/lib/faker/quotes/chiquito.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Faker
+  class Quotes
+    class Chiquito < Base
+      class << self
+        ##
+        # Produces an Expression from Chiquito
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Chiquito.expression # => "Ereh un torpedo!"
+        #
+        # @faker.version 2.11.0
+        def expression
+          sample(expressions)
+        end
+
+        ##
+        # Produces a concept from Chiquito
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Chiquito.term # => "Fistro"
+        #
+        # @faker.version 2.11.0
+        def term
+          sample(terms)
+        end
+
+        ##
+        # Produces a joke from Chiquito
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Chiquito.joke # => "- Papar papar llevame al circo!
+        #                                      - Noorl! El que quiera verte que venga a la casa"
+        #
+        # @faker.version 2.11.0
+        def joke
+          sample(jokes)
+        end
+
+        ##
+        # Produces a sentence from Chiquito
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Chiquito.sentence # => "Te llamo trigo por no llamarte Rodrigo"
+        #
+        # @faker.version 2.11.0
+        def sentence
+          sample(sentences)
+        end
+
+        private
+
+        def expressions
+          fetch('chiquito.expressions')
+        end
+
+        def terms
+          fetch('chiquito.terms')
+        end
+
+        def jokes
+          fetch('chiquito.jokes')
+        end
+
+        def sentences
+          fetch('chiquito.sentences')
+        end
+      end
+    end
+  end
+end

data/lib/faker/quotes/quote.rb

@@ -3,30 +3,122 @@
 module Faker
   class Quote < Base
     class << self
+      ##
+      # Produces a famous last words quote.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Quote.famous_last_words #=> "My vocabulary did this to me. Your love will let you go on..."
+      #
+      # @faker.version 1.9.0
       def famous_last_words
         fetch('quote.famous_last_words')
       end
 
+      ##
+      # Produces a quote from Deep Thoughts by Jack Handey.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Quote.jack_handey # => "I hope life isn't a big joke, because I don't get it."
+      #
+      # @faker.version next
+      def jack_handey
+        fetch('quote.jack_handey')
+      end
+
+      ##
+      # Produces a quote from Matz.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Quote.matz #=> "You want to enjoy life, don't you? If you get your job done quickly and your job is fun, that's good isn't it? That's the purpose of life, partly. Your life is better."
+      #
+      # @faker.version 1.9.0
       def matz
         fetch('quote.matz')
       end
 
+      ##
+      # Produces a quote about the most interesting man in the world.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Quote.most_interesting_man_in_the_world #=> "He can speak Russian... in French"
+      #
+      # @faker.version 1.9.0
       def most_interesting_man_in_the_world
         fetch('quote.most_interesting_man_in_the_world')
       end
 
+      ##
+      # Produces a Robin quote.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Quote.robin #=> "Holy Razors Edge"
+      #
+      # @faker.version 1.9.0
       def robin
         fetch('quote.robin')
       end
 
+      ##
+      # Produces a singular siegler quote.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Quote.singular_siegler #=> "Texas!"
+      #
+      # @faker.version 1.9.0
       def singular_siegler
         fetch('quote.singular_siegler')
       end
 
-      # from: http://morecoolquotes.com/famous-yoda-quotes/
+      ##
+      # Produces a quote from Yoda.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Quote.yoda #=> "Use your feelings, Obi-Wan, and find him you will."
+      #
+      # @faker.version 1.9.0
       def yoda
         fetch('quote.yoda')
       end
+
+      ##
+      # Produces a quote from a fortune cookie.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Quote.fortune_cookie #=> "This cookie senses that you are superstitious; it is an inclination that is bad for your mental health."
+      #
+      # @faker.version next
+      def fortune_cookie
+        fetch('quote.fortune_cookie')
+      end
+
+      ##
+      # Produces a quote from comedian Mitch Hedberg.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Quote.mitch_hedberg # => "I like Kit-Kats, unless I'm with four or more people."
+      #
+      # @faker.version next
+      def mitch_hedberg
+        fetch('quote.mitch_hedberg')
+      end
     end
   end
 end

data/lib/faker/quotes/rajnikanth.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Faker
+  class Quotes
+    class Rajnikanth < Base
+      flexible :rajnikanth
+
+      class << self
+        ##
+        # Produces a Rajnikanth.
+        # Original list of jokes:
+        # http://www.rajinikanthjokes.com/
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Rajnikanth.joke
+        #     #=> "Rajinikanth is so fast that he always comes yesterday."
+        #
+        # @faker.version 2.11.0
+        def joke
+          fetch('rajnikanth.joke')
+        end
+      end
+    end
+  end
+end

data/lib/faker/quotes/shakespeare.rb

@@ -4,34 +4,104 @@ module Faker
   class Quotes
     class Shakespeare < Base
       class << self
+        ##
+        # Produces a Shakespeare quote from Hamlet.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare.hamlet_quote # => "To be, or not to be: that is the question."
+        #
+        # @faker.version 1.9.2
         def hamlet_quote
           sample(hamlet)
         end
 
+        ##
+        # Produces a Shakespeare quote from As You Like It.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare.as_you_like_it_quote # => "Can one desire too much of a good thing?."
+        #
+        # @faker.version 1.9.2
         def as_you_like_it_quote
           sample(as_you_like_it)
         end
 
+        ##
+        # Produces a Shakespeare quote from King Richard III.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare.king_richard_iii_quote # => "Now is the winter of our discontent."
+        #
+        # @faker.version 1.9.2
         def king_richard_iii_quote
           sample(king_richard_iii)
         end
 
+        ##
+        # Produces a Shakespeare quote from Romeo And Juliet.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare.romeo_and_juliet_quote # => "O Romeo, Romeo! wherefore art thou Romeo?."
+        #
+        # @faker.version 1.9.2
         def romeo_and_juliet_quote
           sample(romeo_and_juliet)
         end
 
+        ##
+        # Generates quote from Hamlet
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare.hamlet   #=> "A little more than kin, and less than kind."
+        #
+        # @faker.version 1.9.2
         def hamlet
           fetch('shakespeare.hamlet')
         end
 
+        ##
+        # Generates quote from 'As you like it!'
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare.as_you_like_it   #=> "How bitter a thing it is to look into happiness through another man's eyes!"
+        #
+        # @faker.version 1.9.2
         def as_you_like_it
           fetch('shakespeare.as_you_like_it')
         end
 
+        ##
+        # Returns quote from 'King Rechard III'
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare  #=> "The king's name is a tower of strength."
         def king_richard_iii
           fetch('shakespeare.king_richard_iii')
         end
 
+        ##
+        # Quote from 'Romeo and Juliet'
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Quotes::Shakespeare.romeo_and_juliet  #=> "Wisely and slow; they stumble that run fast."
+        #
+        # @faker.version 1.9.2
         def romeo_and_juliet
           fetch('shakespeare.romeo_and_juliet')
         end

data/lib/faker/religion/bible.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Faker
+  module Religion
+    class Bible < Base
+      flexible :bible
+
+      class << self
+        ##
+        # Returns a random bible character.
+        #
+        # @return [String]
+        #
+        # @example
+        # Faker::Religion::Bible.character #=> "Jesus"
+        #
+        # @faker.version next
+        def character
+          fetch('bible.character')
+        end
+
+        ##
+        # Returns a random location(city or town) from the bible
+        #
+        # @return [String]
+        #
+        # @example
+        # Faker::Religion::Bible.location #=> "Nasareth"
+        #
+        # @faker.version next
+        def location
+          fetch('bible.location')
+        end
+
+        ##
+        # Returns a random quote from the location.
+        #
+        # @return [String]
+        #
+        # @example
+        # Faker::Religion::Bible.quote #=> "Seek first the kingdom of God "
+        #
+        # @faker.version next
+        def quote
+          fetch('bible.quote')
+        end
+      end
+    end
+  end
+end

data/lib/faker/sports/basketball.rb

@@ -4,18 +4,54 @@ module Faker
   class Sports
     class Basketball < Base
       class << self
+        ##
+        # Produces the name of a basketball team.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Basketball.team #=> "Golden State Warriors"
+        #
+        # @faker.version 1.9.4
         def team
           fetch('basketball.teams')
         end
 
+        ##
+        # Produces the name of a basketball player.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Basketball.player #=> "LeBron James"
+        #
+        # @faker.version 1.9.4
         def player
           fetch('basketball.players')
         end
 
+        ##
+        # Produces the name of a basketball coach.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Basketball.coach #=> "Gregg Popovich"
+        #
+        # @faker.version 1.9.4
         def coach
           fetch('basketball.coaches')
         end
 
+        ##
+        # Produces a position in basketball.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Basketball.position #=> "Point Guard"
+        #
+        # @faker.version 1.9.4
         def position
           fetch('basketball.positions')
         end

data/lib/faker/sports/chess.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Faker
+  class Sports
+    class Chess < Base
+      class << self
+        ##
+        # Produces the name of a chess player name.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Chess.player #=> "Golden State Warriors"
+        #
+        # @faker.version next
+        def player
+          fetch('chess.players')
+        end
+
+        ##
+        # Produces a long (alpha-3) ISO 3166 country code.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Chess.federation #=> "COL"
+        #
+        # @faker.version next
+        def federation
+          Faker::Address.country_code_long
+        end
+
+        def tournament
+          ##
+          # Produces the name of a famous chess tournament name.
+          #
+          # @return [String]
+          #
+          # @example
+          #   Faker::Chess.tournament #=> "Khanty-Mansisyk (Candidates Tournament)"
+          #
+          # @faker.version next
+          fetch('chess.tournaments')
+        end
+
+        def rating(from: 2000, to: 2900)
+          ##
+          # Produces a rating between two provided values. Boundaries are inclusive.
+          #
+          # @param from [Numeric] The lowest number to include.
+          # @param to [Numeric] The highest number to include.
+          # @return [Numeric]
+          #
+          # @example
+          #   Faker::Sports::Chess.rating #=> 2734
+          #   Faker::Sports::Chess.rating(from: 2400, to: 2700) #=> 2580
+          #
+          # @faker.version next
+          Faker::Base.rand_in_range(from, to)
+        end
+
+        ##
+        # Produces the name of a chess opening.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Chess.opening #=> "Giuoco Piano"
+        #
+        # @faker.version next
+        def opening
+          fetch('chess.openings')
+        end
+
+        ##
+        # Produces a chess title.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Chess.title #=> "GM"
+        #
+        # @faker.version next
+        def title
+          fetch('chess.titles')
+        end
+      end
+    end
+  end
+end

data/lib/faker/sports/football.rb

@@ -4,22 +4,67 @@ module Faker
   class Sports
     class Football < Base
       class << self
+        ##
+        # Produces the name of a football team.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Football.team #=> "Manchester United"
+        #
+        # @faker.version 1.9.0
         def team
           fetch('football.teams')
         end
 
+        ##
+        # Produces the name of a football player.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Football.player #=> "Lionel Messi"
+        #
+        # @faker.version 1.9.0
         def player
           fetch('football.players')
         end
 
+        ##
+        # Produces the name of a football coach.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Football.coach #=> "Jose Mourinho"
+        #
+        # @faker.version 1.9.0
         def coach
           fetch('football.coaches')
         end
 
+        ##
+        # Produces a football competition.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Football.competition #=> "FIFA World Cup"
+        #
+        # @faker.version 1.9.0
         def competition
           fetch('football.competitions')
         end
 
+        ##
+        # Produces a position in football.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Football.position #=> "Defensive Midfielder"
+        #
+        # @faker.version 1.9.2
         def position
           fetch('football.positions')
         end

data/lib/faker/sports/mountaineering.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Faker
+  class Sports
+    class Mountaineering < Base
+      class << self
+        ##
+        # Produces the name of a Mountaineer.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Sports::Mountaineering.mountaineer #=> "Junko Tabei"
+        #
+        # @faker.version next
+        def mountaineer
+          fetch('mountaineering.mountaineer')
+        end
+      end
+    end
+  end
+end