faker 2.0.0 → 3.8.0

data/lib/faker/default/x.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+module Faker
+  class X < Base
+    class << self
+      ##
+      # Produces a random X user based on X's v2 API.
+      #
+      # @return [Hash]
+      #
+      # @example
+      #   Faker::X.user #=>  { data: [{:id=>"8821452687517076614", :name=>"Lincoln Paucek", :screen_name=>"cody"...
+      #
+      # @faker.version 1.7.3
+      def user
+        author_id = Faker::Number.between(from: 1, to: 9_223_372_036_854_775_807)
+
+        {
+          data: [
+            {
+              author_id: author_id.to_s,
+              id: id.to_s,
+              text: Faker::Lorem.sentence
+            }
+          ],
+          includes: {
+            users: [
+              {
+                public_metrics: {
+                  followers_count: Faker::Number.between(to: 1, from: 1_000),
+                  following_count: Faker::Number.between(to: 1, from: 200),
+                  tweet_count: Faker::Number.between(to: 1, from: 10_000),
+                  listed_count: Faker::Number.between(to: 1, from: 1_000)
+                },
+                username: screen_name,
+                pinned_tweet_id: Faker::Number.between(from: 1, to: 9_223_372_036_854_775_807).to_s,
+                entities: user_entities,
+                description: Faker::Lorem.sentence,
+                name: Faker::Name.name,
+                verified: Faker::Boolean.boolean(true_ratio: 0.1),
+                location: Faker::Internet.public_ip_v4_address,
+                id: author_id.to_s,
+                protected: Faker::Boolean.boolean(true_ratio: 0.1),
+                url: url,
+                profile_image_url: Faker::Avatar.image(slug: id, size: '48x48'),
+                created_at: created_at
+              }
+            ]
+          }
+        }
+      end
+
+      ##
+      # Produces a random X tweet with default attributes.
+      #
+      # @param include_user [Boolean] Include user details
+      # @param include_media [Boolean] Include user media (photo) details
+      # @return [Hash]
+      #
+      # @example
+      #   Faker::X.tweet #=> { data: [{:id=>"8821452687517076614", :text=>"Ea et laboriosam vel non."...
+      #   Faker::X.tweet(include_media: true) # Get a tweet object with a photo media attachment
+      #   Faker::X.tweet(include_user: true) # Get a tweet object with an user details
+      #
+      # @faker.version 1.7.3
+      def tweet(include_media: false, include_user: false)
+        tweet = {}
+        tweet_object = tweet_item
+        includes = {}
+
+        if include_media
+          media_key = Faker::Number.between(from: 1, to: 9_223_372_036_854_775_807).to_s
+
+          includes[:media] = media(media_key)
+          tweet_object[:attachments] = { media_keys: [media_key] }
+        end
+
+        includes[:users] = user[:includes][:users] if include_user
+
+        tweet[:data] = [
+          tweet_object
+        ]
+
+        unless includes.empty?
+          tweet[:includes] = includes
+        end
+
+        tweet
+      end
+
+      ##
+      # Produces a random screen_name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::X.screen_name #=> "audreanne_hackett"
+      #
+      # @faker.version 1.7.3
+      def screen_name
+        Faker::Internet.username(specifier: nil, separators: ['_'])[0...20]
+      end
+
+      private
+
+      def id
+        Faker::Number.between(from: 1, to: 9_223_372_036_854_775_807)
+      end
+
+      def created_at
+        Faker::Date.between(from: '2006-03-21', to: ::Date.today).to_time.utc.iso8601(3)
+      end
+
+      def url
+        "https://t.co/#{Faker::Lorem.characters(number: 10)}"
+      end
+
+      def user_entities
+        entities = tweet_entities
+
+        {
+          url: {
+            urls: entities[:urls]
+          },
+          description: {
+            hashtags: entities[:hashtags]
+          }
+        }
+      end
+
+      def tweet_entities
+        display_url = Faker::Internet.url(host: 'example.com')
+
+        {
+          urls: [
+            {
+              start: 0,
+              end: 5,
+              url: url,
+              expanded_url: display_url,
+              display_url: display_url.sub('http://', '')
+            }
+          ],
+          hashtags: [
+            {
+              start: 0,
+              end: 5,
+              tag: Faker::Lorem.word.capitalize
+            }
+          ]
+        }
+      end
+
+      def media(media_key)
+        expanded_url = Faker::LoremFlickr.image(size: '1064x600')
+
+        [{
+          height: Faker::Number.between(to: 1, from: 1000),
+          media_key: media_key,
+          type: 'photo',
+          preview_image_url: expanded_url,
+          width: Faker::Number.between(to: 1, from: 2000),
+          alt_text: Faker::Lorem.sentence
+        }]
+      end
+
+      def tweet_item
+        conversation_id = id.to_s
+
+        {
+          id: conversation_id,
+          text: Faker::Lorem.sentence,
+          lang: sample(%w[en fr es pt it ja]),
+          conversation_id: conversation_id,
+          created_at: created_at,
+          author_id: Faker::Number.between(from: 1, to: 9_223_372_036_854_775_807).to_s,
+          public_metrics: {
+            retweet_count: Faker::Number.between(to: 1, from: 100),
+            reply_count: Faker::Number.between(to: 1, from: 20),
+            like_count: Faker::Number.between(to: 1, from: 25),
+            quote_count: Faker::Number.between(to: 1, from: 10)
+          },
+          possibly_sensitive: Faker::Boolean.boolean(true_ratio: 0.1),
+          entities: tweet_entities
+        }
+      end
+    end
+  end
+end

data/lib/faker/default.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Faker
+  class Default
+    if Faker::Config.lazy_loading?
+      Faker.lazy_load(self)
+    end
+  end
+end

data/lib/faker/fantasy/tolkien.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Faker
+  class Fantasy
+    class Tolkien < Base
+      flexible :tolkien
+
+      class << self
+        ##
+        # Produces a character from Tolkien's legendarium
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Fantasy::Tolkien.character
+        #    #=> "Goldberry"
+        #
+        # @faker.version next
+        def character
+          fetch('tolkien.characters')
+        end
+
+        ##
+        # Produces a location from Tolkien's legendarium
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Fantasy::Tolkien.location
+        #    #=> "Helm's Deep"
+        #
+        # @faker.version next
+        def location
+          fetch('tolkien.locations')
+        end
+
+        ##
+        # Produces a race from Tolkien's legendarium
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Fantasy::Tolkien.race
+        #     #=> "Uruk-hai"
+        #
+        # @faker.version next
+        def race
+          fetch('tolkien.races')
+        end
+
+        ##
+        # Produces the name of a poem from Tolkien's legendarium
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Fantasy::Tolkien.poem
+        #     #=> "Chip the glasses and crack the plates"
+        #
+        # @faker.version next
+        def poem
+          fetch('tolkien.poems')
+        end
+      end
+    end
+  end
+end

data/lib/faker/fantasy.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Faker
+  class Fantasy
+    if Faker::Config.lazy_loading?
+      Faker.lazy_load(self)
+    end
+  end
+end

data/lib/faker/games/clash_of_clans.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Faker
+  class Games
+    class ClashOfClans < Base
+      class << self
+        ##
+        # Produces the name of a troop from Clash of Clans.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ClashOfClans.troop #=> "Barbarian"
+        #
+        # @faker.version next
+        def troop
+          fetch('games.clash_of_clans.troops')
+        end
+
+        ##
+        # Produces the name of a rank from Clash Of Clans.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ClashOfClans.rank #=> "Legend"
+        #
+        # @faker.version next
+        def rank
+          fetch('games.clash_of_clans.ranks')
+        end
+
+        ##
+        # Produces the name of a defensive building from Clash Of Clans.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ClashOfClans.defensive_building #=> "Cannon"
+        #
+        # @faker.version next
+        def defensive_building
+          fetch('games.clash_of_clans.defensive_buildings')
+        end
+      end
+    end
+  end
+end

data/lib/faker/games/control.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Faker
+  class Games
+    class Control < Base
+      class << self
+        ##
+        # Produces the name of a character from Control.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Control.character #=> "Jesse Faden"
+        #
+        # @faker.version 2.13.0
+        def character
+          fetch('games.control.character')
+        end
+
+        ##
+        # Produces the name of a location from Control.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Control.location #=> "Dimensional Research"
+        #
+        # @faker.version 2.13.0
+        def location
+          fetch('games.control.location')
+        end
+
+        ##
+        # Produces the name of an Object of Power (OoP)
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Control.object_of_power #=> "Hotline"
+        #
+        # @faker.version 2.13.0
+        def object_of_power
+          fetch('games.control.object_of_power')
+        end
+
+        ##
+        # Produces the name of an Altered Item
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Control.altered_item #=> "Rubber Duck"
+        #
+        # @faker.version 2.13.0
+        def altered_item
+          fetch('games.control.altered_item')
+        end
+
+        ##
+        # Produces the location of an Altered World Event (AWE)
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Control.altered_world_event #=> "Ordinary, Wisconsin"
+        #
+        # @faker.version 2.13.0
+        def altered_world_event
+          fetch('games.control.altered_world_event')
+        end
+
+        ##
+        # Produces a line from the Hiss incantation
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Control.hiss #=> "Push the fingers through the surface into the wet."
+        #
+        # @faker.version 2.13.0
+        def hiss
+          fetch('games.control.hiss')
+        end
+
+        ##
+        # < Produces a line/quote/message from The Board >
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Control.the_board #=> "< You/We wield the Gun/You. The Board appoints you. Congratulations, Director. >"
+        #
+        # @faker.version 2.13.0
+        def the_board
+          fetch('games.control.the_board')
+        end
+
+        ##
+        # Produces a quote from Control
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Control.quote #=> "He never liked fridge duty"
+        #
+        # @faker.version 2.13.0
+        def quote
+          fetch('games.control.quote')
+        end
+      end
+    end
+  end
+end

data/lib/faker/games/dnd.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+module Faker
+  class Games
+    class DnD < Base
+      class << self
+        ##
+        # Produces the name of an alignment from Dungeons and Dragons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.alignment #=> "Lawful Neutral"
+        #
+        # @faker.version 2.13.0
+        def alignment
+          fetch('dnd.alignments')
+        end
+
+        ##
+        # Produces the name of a background from Dungeons and Dragons (PHB).
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.background #=> "Urchin"
+        #
+        # @faker.version 2.13.0
+        def background
+          fetch('dnd.backgrounds')
+        end
+
+        ##
+        # Produces the name of a city from Dungeons and Dragons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.city #=> "Earthfast"
+        #
+        # @faker.version 2.14.0
+        def city
+          fetch('dnd.cities')
+        end
+
+        ##
+        # Produces the first name of a character or monster from Dungeons and Dragons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.name #=> "Eilonwy"
+        #
+        # @faker.version next
+        def first_name
+          fetch('dnd.name.first_name')
+        end
+
+        ##
+        # Produces the name of a class from Dungeons and Dragons (PHB).
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.klass #=> "Warlock"
+        #
+        # @faker.version 2.13.0
+        def klass
+          fetch('dnd.klasses')
+        end
+
+        ##
+        # Produces the name of a language from Dungeons and Dragons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.language #=> "Gnomish"
+        #
+        # @faker.version 2.14.0
+        def language
+          fetch('dnd.languages')
+        end
+
+        ##
+        # Produces a last name from Dungeons and Dragons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.last_name #=> "Leafwhisper"
+        #
+        # @faker.version next
+        def last_name
+          fetch('dnd.name.last_name')
+        end
+
+        ##
+        # Produces the name of a melee weapon from Dungeons and Dragons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.melee_weapon #=> "Handaxe"
+        #
+        # @faker.version 2.14.0
+        def melee_weapon
+          fetch('dnd.melee_weapons')
+        end
+
+        ##
+        # Produces the name of a monster from Dungeons and Dragons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.monster #=> "Manticore"
+        #
+        # @faker.version 2.14.0
+        def monster
+          fetch('dnd.monsters')
+        end
+
+        ##
+        # Produces a full name from Dungeons and Dragons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.name #=> "Drakon Blackthorn"
+        #
+        # @faker.version next
+        def name
+          "#{fetch('dnd.name.first_name')} #{fetch('dnd.name.last_name')}"
+        end
+
+        ##
+        # Produces the name of a race from Dungeons and Dragons (PHB).
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.races #=> "Dwarf"
+        #
+        # @faker.version 2.14.0
+        def race
+          fetch('dnd.races')
+        end
+
+        ##
+        # Produces the name of a ranged weapon from Dungeons and Dragons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.ranged_weapon #=> "Shortbow"
+        #
+        # @faker.version 2.14.0
+        def ranged_weapon
+          fetch('dnd.ranged_weapons')
+        end
+
+        ##
+        # Produces a last name from Dungeons and Dragons.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::DnD.title_name #=> "Corvus the Cunning"
+        #
+        # @faker.version next
+        def title_name
+          "#{fetch('dnd.name.first_name')} #{fetch('dnd.name.title')}"
+        end
+      end
+    end
+  end
+end

data/lib/faker/games/dota.rb

@@ -4,22 +4,82 @@ module Faker
   class Games
     class Dota < Base
       class << self
+        ##
+        # Produces the name of a building from Dota.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::Dota.building #=> "Tower"
+        #
+        # @faker.version 1.9.0
+        def building
+          fetch('games.dota.building')
+        end
+
+        ##
+        # 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(hero: 'abaddon')
           fetch("games.dota.#{hero}.quote")
         end