faker 1.8.7 → 2.17.0

data/lib/faker/blockchain/ethereum.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Faker
+  class Blockchain
+    class Ethereum < Base
+      class << self
+        ##
+        # Produces a random Ethereum wallet address
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Blockchain::Ethereum.address
+        #     #=> "0xd392b0c0500700d02d27ab30805ec80ddd3320ff"
+        #
+        # @faker.version 1.9.1
+        def address
+          hex_alphabet = '0123456789abcdef'
+          var = +'0x'
+          40.times { var << sample(shuffle(hex_alphabet.split(''))) }
+          var
+        end
+      end
+    end
+  end
+end

data/lib/faker/blockchain/tezos.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require 'openssl'
+require 'securerandom'
+
+module Faker
+  class Blockchain
+    class Tezos < Base
+      class << self
+        # @private
+        PREFIXES = {
+          tz1: [6, 161, 159],
+          KT1: [2, 90, 121],
+          edpk: [13, 15, 37, 217],
+          edsk: [13, 15, 58, 7],
+          edsig: [9, 245, 205, 134, 18],
+          B: [1, 52],
+          o: [5, 116]
+        }.freeze
+
+        ##
+        # Produces a random Tezos account address
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Blockchain::Tezos.account
+        #     #=> "tz1eUsgK6aj752Fbxwk5sAoEFvSDnPjZ4qvk"
+        #
+        # @faker.version 1.9.2
+        def account
+          encode_tz(:tz1, 20)
+        end
+
+        ##
+        # Produces a random Tezos contract
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Blockchain::Tezos.contract
+        #     #=> "KT1MroqeP15nnitB4CnNfkqHYa2NErhPPLWF"
+        #
+        # @faker.version 1.9.2
+        def contract
+          encode_tz(:KT1, 20)
+        end
+
+        ##
+        # Produces a random Tezos operation
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Blockchain::Tezos.operation
+        #     #=> "onygWYXJX3xNstFLv9PcCrhQdCkENC795xwSinmTEc1jsDN4VDa"
+        #
+        # @faker.version 1.9.2
+        def operation
+          encode_tz(:o, 32)
+        end
+
+        ##
+        # Produces a random Tezos block
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Blockchain::Tezos.block
+        #     #=> "BMbhs2rkY1dvAkAyRytvPsjFQ2RiPrBhYkxvWpY65dzkdSuw58a"
+        #
+        # @faker.version 1.9.4
+        def block
+          encode_tz(:B, 32)
+        end
+
+        ##
+        # Produces a random Tezos signature
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Blockchain::Tezos.signature
+        #     #=> "edsigu165B7VFf3Dpw2QABVzEtCxJY2gsNBNcE3Ti7rRxtDUjqTFRpg67EdAQmY6YWPE5tKJDMnSTJDFu65gic8uLjbW2YwGvAZ"
+        #
+        # @faker.version 1.9.2
+        def signature
+          encode_tz(:edsig, 64)
+        end
+
+        ##
+        # Produces a random Tezos public key
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Blockchain::Tezos.public_key
+        #     #=> "edpkuib9x8QXRc5nWwHUg7U1dXsVmaUrUNU5sX9pVEEvwbMVdfMCeq"
+        #
+        # @faker.version 2.15.2
+        def public_key
+          encode_tz(:edpk, 32)
+        end
+
+        ##
+        # Produces a random Tezos public key
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Blockchain::Tezos.secret_key
+        #     #=> "edsk3HZCAGEGpzQPnQUwQeFY4ESanFhQCgLpKriQw8GHyhKCrjHawv"
+        #
+        # @faker.version 2.15.2
+        def secret_key
+          encode_tz(:edsk, 32)
+        end
+
+        protected
+
+        ##
+        # @param prefix [Symbol]
+        # @param payload_size [Integer] The size of the payload
+        #
+        # @return [String]
+        def encode_tz(prefix, payload_size)
+          prefix = PREFIXES.fetch(prefix)
+          packed = prefix.map(&:chr).join('') + Faker::Config.random.bytes(payload_size)
+          checksum = OpenSSL::Digest::SHA256.digest(OpenSSL::Digest::SHA256.digest(packed))[0..3]
+          Faker::Base58.encode(packed + checksum)
+        end
+      end
+    end
+  end
+end

data/lib/faker/books/book.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Faker
+  class Book < Base
+    flexible :book
+
+    class << self
+      ##
+      # Produces a random book title
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Book.title #=> "The Odd Sister"
+      #
+      # @faker.version 1.9.3
+      def title
+        fetch('book.title')
+      end
+
+      ##
+      # Produces a random book author
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Book.author #=> "Alysha Olsen"
+      #
+      # @faker.version 1.9.3
+      def author
+        parse('book.author')
+      end
+
+      ##
+      # Produces a random book publisher
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Book.publisher #=> "Opus Reader"
+      #
+      # @faker.version 1.9.3
+      def publisher
+        fetch('book.publisher')
+      end
+
+      ##
+      # Produces a random genre
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Book.genre #=> "Mystery"
+      #
+      # @faker.version 1.9.3
+      def genre
+        fetch('book.genre')
+      end
+    end
+  end
+end

data/lib/faker/books/culture_series.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Faker
+  class Books
+    class CultureSeries < Base
+      flexible :culture_series
+
+      class << self
+        ##
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::CultureSeries.book
+        #     #=> "The Player of Games"
+        #
+        # @faker.version 1.9.3
+        def book
+          fetch('culture_series.books')
+        end
+
+        ##
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::CultureSeries.culture_ship
+        #     #=> "Fate Amenable To Change"
+        #
+        # @faker.version 1.9.3
+        def culture_ship
+          fetch('culture_series.culture_ships')
+        end
+
+        ##
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::CultureSeries.culture_ship_class
+        #     #=> "General Systems Vehicle"
+        #
+        # @faker.version 1.9.3
+        def culture_ship_class
+          fetch('culture_series.culture_ship_classes')
+        end
+
+        ##
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::CultureSeries.culture_ship_class_abv
+        #     #=> "The Odd Sister"
+        #
+        # @faker.version 1.9.3
+        def culture_ship_class_abv
+          fetch('culture_series.culture_ship_class_abvs')
+        end
+
+        ##
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::CultureSeries.civ
+        #     #=> "Culture"
+        #
+        # @faker.version 1.9.3
+        def civ
+          fetch('culture_series.civs')
+        end
+
+        ##
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::CultureSeries.planet
+        #     #=> "Xinth"
+        #
+        # @faker.version 1.9.3
+        def planet
+          fetch('culture_series.planets')
+        end
+      end
+    end
+  end
+end

data/lib/faker/books/dune.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module Faker
+  class Books
+    ##
+    # A Faker module beyond your dreams, test data beyond your imagination.
+    class Dune < Base
+      class << self
+        ##
+        # Produces the name of a character from Dune
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::Dune.character #=> "Leto Atreides"
+        #
+        # @faker.version 1.9.3
+        def character
+          fetch('dune.characters')
+        end
+
+        ##
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::Dune.title #=> "Duke"
+        #
+        # @faker.version 1.9.3
+        def title
+          fetch('dune.titles')
+        end
+
+        ##
+        # Produces the name of a city from Dune
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::Dune.city #=> "Arrakeen"
+        #
+        # @faker.version next
+        def city
+          fetch('dune.cities')
+        end
+
+        ##
+        # Produces the name of a planet from Dune
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::Dune.planet #=> "Caladan"
+        #
+        # @faker.version 1.9.3
+        def planet
+          fetch('dune.planets')
+        end
+
+        ##
+        # Produces a quote from Dune
+        #
+        # @param character [String] The name of the character that the quote should be from
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::Dune.quote
+        #     #=> "A dead man, surely, no longer requires that water."
+        # @example
+        #   Faker::Books::Dune.quote(character: "baron_harkonnen")
+        #     #=> "He who controls the spice, controls the universe!"
+        #
+        # @faker.version 1.9.3
+        def quote(legacy_character = NOT_GIVEN, character: nil)
+          warn_for_deprecated_arguments do |keywords|
+            keywords << :character if legacy_character != NOT_GIVEN
+          end
+
+          quoted_characters = translate('faker.dune.quotes').keys
+
+          if character.nil?
+            character = sample(quoted_characters).to_s
+          else
+            character = character.to_s.downcase
+
+            unless quoted_characters.include?(character.to_sym)
+              raise ArgumentError,
+                    "Characters quoted can be left blank or #{quoted_characters.join(', ')}"
+            end
+          end
+
+          fetch("dune.quotes.#{character}")
+        end
+
+        ##
+        # Produces a saying from Dune
+        #
+        # @param source [String]
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Books::Dune.saying #=> "You do not beg the sun for mercy."
+        # @example
+        #   Faker::Books::Dune.saying(source: "fremen")
+        #     #=> "May thy knife chip and shatter."
+        #
+        # @faker.version 1.9.3
+        def saying(legacy_source = NOT_GIVEN, source: nil)
+          warn_for_deprecated_arguments do |keywords|
+            keywords << :source if legacy_source != NOT_GIVEN
+          end
+
+          sourced_sayings = translate('faker.dune.sayings').keys
+
+          if source.nil?
+            source = sample(sourced_sayings).to_s
+          else
+            source = source.to_s.downcase
+
+            unless sourced_sayings.include?(source.to_sym)
+              raise ArgumentError,
+                    "Sources quoted in sayings can be left blank or #{sourced_sayings.join(', ')}"
+            end
+          end
+
+          fetch("dune.sayings.#{source}")
+        end
+      end
+    end
+  end
+end

data/lib/faker/books/lovecraft.rb

@@ -0,0 +1,280 @@
+# frozen_string_literal: true
+
+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
+
+        ##
+        # @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(legacy_number = NOT_GIVEN, number: 1)
+          warn_for_deprecated_arguments do |keywords|
+            keywords << :number if legacy_number != NOT_GIVEN
+          end
+
+          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
+
+        ##
+        # 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(legacy_word_count = NOT_GIVEN, legacy_random_words_to_add = NOT_GIVEN, word_count: 4, random_words_to_add: 6, open_compounds_allowed: true)
+          warn_for_deprecated_arguments do |keywords|
+            keywords << :word_count if legacy_word_count != NOT_GIVEN
+            keywords << :random_words_to_add if legacy_random_words_to_add != NOT_GIVEN
+          end
+
+          "#{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
+
+        ##
+        # 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(legacy_number = NOT_GIVEN, legacy_spaces_allowed = NOT_GIVEN, number: 3, spaces_allowed: false)
+          warn_for_deprecated_arguments do |keywords|
+            keywords << :number if legacy_number != NOT_GIVEN
+            keywords << :spaces_allowed if legacy_spaces_allowed != NOT_GIVEN
+          end
+
+          resolved_num = resolve(number)
+          word_list = translate('faker.lovecraft.words')
+          word_list *= ((resolved_num / word_list.length) + 1)
+
+          return shuffle(word_list)[0, resolved_num] if spaces_allowed
+
+          words = shuffle(word_list)[0, resolved_num]
+          words.each_with_index { |w, i| words[i] = word if w =~ /\s/ }
+        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(legacy_number = NOT_GIVEN, number: 3)
+          warn_for_deprecated_arguments do |keywords|
+            keywords << :number if legacy_number != NOT_GIVEN
+          end
+
+          [].tap do |sentences|
+            1.upto(resolve(number)) do
+              sentences << sentence(word_count: 3)
+            end
+          end
+        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(legacy_sentence_count = NOT_GIVEN, legacy_random_sentences_to_add = NOT_GIVEN, sentence_count: 3, random_sentences_to_add: 3)
+          warn_for_deprecated_arguments do |keywords|
+            keywords << :sentence_count if legacy_sentence_count != NOT_GIVEN
+            keywords << :random_sentences_to_add if legacy_random_sentences_to_add != NOT_GIVEN
+          end
+
+          sentences(number: resolve(sentence_count) + rand(random_sentences_to_add.to_i).to_i).join(' ')
+        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(legacy_number = NOT_GIVEN, number: 3)
+          warn_for_deprecated_arguments do |keywords|
+            keywords << :number if legacy_number != NOT_GIVEN
+          end
+
+          [].tap do |paragraphs|
+            1.upto(resolve(number)) do
+              paragraphs << paragraph(sentence_count: 3)
+            end
+          end
+        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(legacy_characters = NOT_GIVEN, characters: 256)
+          warn_for_deprecated_arguments do |keywords|
+            keywords << :characters if legacy_characters != NOT_GIVEN
+          end
+
+          paragraph = paragraph(sentence_count: 3)
+
+          paragraph += " #{paragraph(sentence_count: 3)}" while paragraph.length < characters
+
+          "#{paragraph[0...characters - 1]}."
+        end
+      end
+    end
+  end
+end