class Faker::Lorem

Based on Perl's Text::Lorem

Public Class Methods

character() click to toggle source

Generates single character

@return [String]

@example

Faker::Lorem.character    #=> "e"

@faker.version 2.1.3

# File lib/faker/default/lorem.rb, line 57
def character
  sample(Types::CHARACTERS)
end
characters(legacy_number = NOT_GIVEN, number: 255, min_alpha: 0, min_numeric: 0) click to toggle source

Produces a random string of alphanumeric characters

@param number [Integer] The number of characters to generate @param min_alpha [Integer] The minimum number of alphabetic to add to the string @param min_numeric [Integer] The minimum number of numbers to add to the string

@return [String]

@example

Faker::Lorem.characters #=> "uw1ep04lhs0c4d931n1jmrspprf5w..."
Faker::Lorem.characters(number: 10) #=> "ang9cbhoa8"
Faker::Lorem.characters(number: 10, min_alpha: 4) #=> "ang9cbhoa8"
Faker::Lorem.characters(number: 10, min_alpha: 4, min_numeric: 1) #=> "ang9cbhoa8"

@faker.version 2.1.3

# File lib/faker/default/lorem.rb, line 77
def characters(legacy_number = NOT_GIVEN, number: 255, min_alpha: 0, min_numeric: 0)
  warn_for_deprecated_arguments do |keywords|
    keywords << :number if legacy_number != NOT_GIVEN
  end

  Alphanumeric.alphanumeric(number: number, min_alpha: min_alpha, min_numeric: min_numeric)
end
multibyte() click to toggle source

Generates the emoji

@return [String]

@example

Faker::Lorem.multibyte  #=> "😀"
Faker::Lorem.multibyte  #=> "❤"

@faker.version 2.1.3

# File lib/faker/default/lorem.rb, line 97
def multibyte
  sample(translate('faker.lorem.multibyte')).pack('C*').force_encoding('utf-8')
end
paragraph(legacy_sentence_count = NOT_GIVEN, legacy_supplemental = NOT_GIVEN, legacy_random_sentences_to_add = NOT_GIVEN, sentence_count: 3, supplemental: false, random_sentences_to_add: 0) click to toggle source

Generates three sentence paragraph

@param sentence_count [Integer] Number of sentences in the paragraph @param supplemental [Boolean] @param random_sentences_to_add [Integer]

@return [String]

@example

Faker::Lorem.paragraph
  #=> "Impedit et est. Aliquid deleniti necessitatibus. Et aspernatur minima."
Faker::Lorem.paragraph(sentence_count: 2)
  #=> "Rerum fugit vitae. Et atque autem."
Faker::Lorem.paragraph(sentence_count: 2, supplemental: true)
  #=> "Terreo coerceo utor. Vester sunt cogito."
Faker::Lorem.paragraph(sentence_count: 2, supplemental: true, random_sentences_to_add: 2)
  #=> "Texo tantillus tamisium. Tribuo amissio tamisium. Facere aut canis."

@faker.version 2.1.3

# File lib/faker/default/lorem.rb, line 176
def paragraph(legacy_sentence_count = NOT_GIVEN, legacy_supplemental = NOT_GIVEN, legacy_random_sentences_to_add = NOT_GIVEN, sentence_count: 3, supplemental: false, random_sentences_to_add: 0)
  warn_for_deprecated_arguments do |keywords|
    keywords << :sentence_count if legacy_sentence_count != NOT_GIVEN
    keywords << :supplemental if legacy_supplemental != 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), supplemental: supplemental).join(locale_space)
end
paragraph_by_chars(legacy_number = NOT_GIVEN, legacy_supplemental = NOT_GIVEN, number: 256, supplemental: false) click to toggle source

Generates paragraph with 256 characters

@param number [Integer] @param supplemental [Boolean]

@return [String]

@example

Faker::Lorem.paragraph_by_chars
Faker::Lorem.paragraph_by_chars(number: 20)                       #=> "Sit modi alias. Imp."
Faker::Lorem.paragraph_by_chars(number: 20, supplemental: true)   #=> "Certus aveho admove."

@faker.version 2.1.3

# File lib/faker/default/lorem.rb, line 226
def paragraph_by_chars(legacy_number = NOT_GIVEN, legacy_supplemental = NOT_GIVEN, number: 256, supplemental: false)
  warn_for_deprecated_arguments do |keywords|
    keywords << :number if legacy_number != NOT_GIVEN
    keywords << :supplemental if legacy_supplemental != NOT_GIVEN
  end

  paragraph = paragraph(sentence_count: 3, supplemental: supplemental)

  paragraph += " #{paragraph(sentence_count: 3, supplemental: supplemental)}" while paragraph.length < number

  "#{paragraph[0...number - 1]}."
end
paragraphs(legacy_number = NOT_GIVEN, legacy_supplemental = NOT_GIVEN, number: 3, supplemental: false) click to toggle source

Generates three paragraphs

@param number [Integer] @param supplemental [Boolean]

@return [Array]

@example

Faker::Lorem.paragraphs
Faker::Lorem.paragraphs(number:2)
Faker::Lorem.paragraphs(number:2, supplemental: true)

@faker.version 2.1.3

# File lib/faker/default/lorem.rb, line 201
def paragraphs(legacy_number = NOT_GIVEN, legacy_supplemental = NOT_GIVEN, number: 3, supplemental: false)
  warn_for_deprecated_arguments do |keywords|
    keywords << :number if legacy_number != NOT_GIVEN
  end
  warn_for_deprecated_arguments do |keywords|
    keywords << :supplemental if legacy_supplemental != NOT_GIVEN
  end

  1.upto(resolve(number)).collect { paragraph(sentence_count: 3, supplemental: supplemental) }
end
question(legacy_word_count = NOT_GIVEN, legacy_supplemental = NOT_GIVEN, legacy_random_words_to_add = NOT_GIVEN, word_count: 4, supplemental: false, random_words_to_add: 0) click to toggle source

Returns the question with 4 words

@param word_count [Integer] @param supplemental [Boolean] @param random_words_to_add [Integer]

@return [String]

@example

Faker::Lorem.question                                                               #=> "Natus deleniti sequi laudantium?"
Faker::Lorem.question(word_count: 2)                                                #=> "Quo ut?"
Faker::Lorem.question(word_count: 2, supplemental: true)                            #=> "Terga consequatur?"
Faker::Lorem.question(word_count: 2, supplemental: true, random_words_to_add: 2)    #=> "Depulso uter ut?"

@faker.version 2.1.3

# File lib/faker/default/lorem.rb, line 257
def question(legacy_word_count = NOT_GIVEN, legacy_supplemental = NOT_GIVEN, legacy_random_words_to_add = NOT_GIVEN, word_count: 4, supplemental: false, random_words_to_add: 0)
  warn_for_deprecated_arguments do |keywords|
    keywords << :word_count if legacy_word_count != NOT_GIVEN
    keywords << :supplemental if legacy_supplemental != 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), supplemental: supplemental).join(' ').capitalize + locale_question_mark
end
questions(legacy_number = NOT_GIVEN, legacy_supplemental = NOT_GIVEN, number: 3, supplemental: false) click to toggle source

Generates array of three questions

@param number [Integer] @param supplemental [Boolean]

@return [Array]

@example

Faker::Lorem.questions                                  #=> ["Amet culpa enim?", "Voluptatem deleniti numquam?", "Veniam non cum?"]
Faker::Lorem.questions(number: 2)                       #=> ["Minus occaecati nobis?", "Veniam et alias?"]
Faker::Lorem.questions(number: 2, supplemental: true)   #=> ["Acceptus subito cetera?", "Aro sulum cubicularis?"]

@faker.version 2.1.3

# File lib/faker/default/lorem.rb, line 282
def questions(legacy_number = NOT_GIVEN, legacy_supplemental = NOT_GIVEN, number: 3, supplemental: false)
  warn_for_deprecated_arguments do |keywords|
    keywords << :number if legacy_number != NOT_GIVEN
    keywords << :supplemental if legacy_supplemental != NOT_GIVEN
  end

  1.upto(resolve(number)).collect { question(word_count: 3, supplemental: supplemental) }
end
sentence(legacy_word_count = NOT_GIVEN, legacy_supplemental = NOT_GIVEN, legacy_random_words_to_add = NOT_GIVEN, word_count: 4, supplemental: false, random_words_to_add: 0) click to toggle source

Generates sentence

@param word_count [Integer] How many words should be there in a sentence, default to 4 @param supplemental [Boolean] Add supplemental words, default to false @param random_words_to_add [Integer] Add any random words, default to 0

@return [String]

@example

Faker::Lorem.sentence                                                             #=> "Magnam qui aut quidem."
Faker::Lorem.sentence(word_count: 5)                                              #=> "Voluptas rerum aut aliquam velit."
Faker::Lorem.sentence(word_count: 5, supplemental: true)                          #=> "Aut viscus curtus votum iusto."
Faker::Lorem.sentence(word_count: 5, supplemental: true, random_words_to_add:2)   #=> "Crinis quo cruentus velit animi vomer."

@faker.version 2.1.3

# File lib/faker/default/lorem.rb, line 120
def sentence(legacy_word_count = NOT_GIVEN, legacy_supplemental = NOT_GIVEN, legacy_random_words_to_add = NOT_GIVEN, word_count: 4, supplemental: false, random_words_to_add: 0)
  warn_for_deprecated_arguments do |keywords|
    keywords << :word_count if legacy_word_count != NOT_GIVEN
    keywords << :supplemental if legacy_supplemental != 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), supplemental: supplemental).join(locale_space).capitalize + locale_period
end
sentences(legacy_number = NOT_GIVEN, legacy_supplemental = NOT_GIVEN, number: 3, supplemental: false) click to toggle source

Generates three sentences

@param number [Integer] How many sentences to be generated, default to 3 @param supplemental [Boolean] Should add supplemental words, defaults to false

@return [Array] Returns array for sentences.

@example

Faker::Lorem.sentences                                  #=> ["Possimus non tenetur.", "Nulla non excepturi.", "Quisquam rerum facilis."]
Faker::Lorem.sentences(number: 2)                       #=> ["Nulla est natus.", "Perferendis autem cum."]
Faker::Lorem.sentences(number: 2, supplemental: true)   #=> ["Cito cena ad.", "Solvo animus allatus."]

@faker.version 2.1.3

# File lib/faker/default/lorem.rb, line 145
def sentences(legacy_number = NOT_GIVEN, legacy_supplemental = NOT_GIVEN, number: 3, supplemental: false)
  warn_for_deprecated_arguments do |keywords|
    keywords << :number if legacy_number != NOT_GIVEN
    keywords << :supplemental if legacy_supplemental != NOT_GIVEN
  end

  1.upto(resolve(number)).collect { sentence(word_count: 3, supplemental: supplemental) }
end
word() click to toggle source

Returs the random word @return [String]

@example

Faker::Lorem.word   #=> "soluto"

@faker.version 2.1.3

# File lib/faker/default/lorem.rb, line 15
def word
  sample(translate('faker.lorem.words'))
end
words(legacy_number = NOT_GIVEN, legacy_supplemental = NOT_GIVEN, number: 3, supplemental: false) click to toggle source

Generates random 3 words

@param number [Integer] Number of words to be generated @param supplemental [Boolean] Whether to attach supplemental words at the end, default is false

@return [Array] Array for words

@example

Faker::Lorem.words                                    #=> ["hic", "quia", "nihil"]
Faker::Lorem.words(number: 4)                         #=> ["est", "temporibus", "et", "quaerat"]
Faker::Lorem.words(number: 4, supplemental: true)    #=> ["nisi", "sit", "allatus", "consequatur"]

@faker.version 2.1.3

# File lib/faker/default/lorem.rb, line 33
def words(legacy_number = NOT_GIVEN, legacy_supplemental = NOT_GIVEN, number: 3, supplemental: false)
  warn_for_deprecated_arguments do |keywords|
    keywords << :number if legacy_number != NOT_GIVEN
    keywords << :supplemental if legacy_supplemental != NOT_GIVEN
  end

  resolved_num = resolve(number)
  word_list = (
    translate('faker.lorem.words') +
    (supplemental ? translate('faker.lorem.supplemental') : [])
  )
  word_list *= ((resolved_num / word_list.length) + 1)
  shuffle(word_list)[0, resolved_num]
end

Private Class Methods

locale_period() click to toggle source
# File lib/faker/default/lorem.rb, line 293
def locale_period
  translate('faker.lorem.punctuation.period') || '.'
end
locale_question_mark() click to toggle source
# File lib/faker/default/lorem.rb, line 301
def locale_question_mark
  translate('faker.lorem.punctuation.question_mark') || '?'
end
locale_space() click to toggle source
# File lib/faker/default/lorem.rb, line 297
def locale_space
  translate('faker.lorem.punctuation.space') || ' '
end