faker 1.8.2 → 2.23.0

data/lib/faker/default/lorem.rb

@@ -0,0 +1,302 @@
+# frozen_string_literal: true
+
+module Faker
+  # Based on Perl's Text::Lorem
+  class Lorem < Base
+    class << self
+      ##
+      # Returs the random word
+      # @return [String]
+      #
+      # @example
+      #   Faker::Lorem.word   #=> "soluto"
+      #
+      # @faker.version 2.1.3
+      def word
+        sample(translate('faker.lorem.words'))
+      end
+
+      ##
+      # 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
+      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
+
+      ##
+      # Generates single character
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Lorem.character    #=> "e"
+      #
+      # @faker.version 2.1.3
+      def character
+        sample(Types::CHARACTERS)
+      end
+
+      ##
+      # 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
+      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
+
+      ##
+      # Generates the emoji
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Lorem.multibyte  #=> "😀"
+      #   Faker::Lorem.multibyte  #=> "❤"
+      #
+      # @faker.version 2.1.3
+      def multibyte
+        sample(translate('faker.lorem.multibyte')).pack('C*').force_encoding('utf-8')
+      end
+      # rubocop:disable Metrics/ParameterLists
+
+      ##
+      # 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
+      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
+      # rubocop:enable Metrics/ParameterLists
+
+      ##
+      # 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
+      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
+
+      # rubocop:disable Metrics/ParameterLists
+
+      ##
+      # 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
+      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
+      # rubocop:enable Metrics/ParameterLists
+
+      ##
+      # 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
+      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
+
+      ##
+      # 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
+      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
+
+      # rubocop:disable Metrics/ParameterLists
+
+      ##
+      # 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
+      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
+      # rubocop:enable Metrics/ParameterLists
+
+      ##
+      # 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
+      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
+
+      private
+
+      def locale_period
+        translate('faker.lorem.punctuation.period') || '.'
+      end
+
+      def locale_space
+        translate('faker.lorem.punctuation.space') || ' '
+      end
+
+      def locale_question_mark
+        translate('faker.lorem.punctuation.question_mark') || '?'
+      end
+    end
+  end
+end

data/lib/faker/default/lorem_flickr.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module Faker
+  class LoremFlickr < Base
+    class << self
+      SUPPORTED_COLORIZATIONS = %w[red green blue].freeze
+
+      # rubocop:disable Metrics/ParameterLists
+
+      ##
+      # Produces a random image URL from loremflickr.com.
+      #
+      # @param size [String] Specifies the size of image to generate.
+      # @param search_terms [Array<String>] Adds search terms to the image URL.
+      # @param match_all [Boolean] Add "all" as part of the URL.
+      # @return [String]
+      #
+      # @example
+      #   Faker::LoremFlickr.image #=> "https://loremflickr.com/300/300"
+      #   Faker::LoremFlickr.image(size: "50x60") #=> "https://loremflickr.com/50/60"
+      #   Faker::LoremFlickr.image(size: "50x60", search_terms: ['sports']) #=> "https://loremflickr.com/50/60/sports"
+      #   Faker::LoremFlickr.image(size: "50x60", search_terms: ['sports', 'fitness']) #=> "https://loremflickr.com/50/60/sports,fitness"
+      #   Faker::LoremFlickr.image(size: "50x60", search_terms: ['sports', 'fitness'], match_all: true) #=> "https://loremflickr.com/50/60/sports,fitness/all"
+      #
+      # @faker.version 1.9.0
+      def image(legacy_size = NOT_GIVEN, legacy_search_terms = NOT_GIVEN, legacy_match_all = NOT_GIVEN, size: '300x300', search_terms: [], match_all: false)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :size if legacy_size != NOT_GIVEN
+          keywords << :search_terms if legacy_search_terms != NOT_GIVEN
+          keywords << :match_all if legacy_match_all != NOT_GIVEN
+        end
+
+        build_url(size, nil, search_terms, match_all)
+      end
+
+      ##
+      # Produces a random grayscale image URL from loremflickr.com.
+      #
+      # @param size [String] Specifies the size of image to generate.
+      # @param search_terms [Array<String>] Adds search terms to the image URL.
+      # @param match_all [Boolean] Add "all" as part of the URL.
+      # @return [String]
+      #
+      # @example
+      #   Faker::LoremFlickr.grayscale_image #=> "https://loremflickr.com/g/300/300/all"
+      #   Faker::LoremFlickr.grayscale_image(size: "50x60") #=> "https://loremflickr.com/g/50/60/all"
+      #   Faker::LoremFlickr.grayscale_image(size: "50x60", search_terms: ['sports']) #=> "https://loremflickr.com/g/50/60/sports"
+      #   Faker::LoremFlickr.grayscale_image(size: "50x60", search_terms: ['sports', 'fitness']) #=> "https://loremflickr.com/50/60/g/sports,fitness"
+      #   Faker::LoremFlickr.grayscale_image(size: "50x60", search_terms: ['sports', 'fitness'], match_all: true) #=> "https://loremflickr.com/g/50/60/sports,fitness/all"
+      #
+      # @faker.version 1.9.0
+      def grayscale_image(legacy_size = NOT_GIVEN, legacy_search_terms = NOT_GIVEN, legacy_match_all = NOT_GIVEN, size: '300x300', search_terms: ['all'], match_all: false)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :size if legacy_size != NOT_GIVEN
+          keywords << :search_terms if legacy_search_terms != NOT_GIVEN
+          keywords << :match_all if legacy_match_all != NOT_GIVEN
+        end
+
+        raise ArgumentError, 'Search terms must be specified for grayscale images' unless search_terms.any?
+
+        build_url(size, 'g', search_terms, match_all)
+      end
+
+      ##
+      # Produces a random pixelated image URL from loremflickr.com.
+      #
+      # @param size [String] Specifies the size of image to generate.
+      # @param search_terms [Array<String>] Adds search terms to the image URL.
+      # @param match_all [Boolean] Add "all" as part of the URL.
+      # @return [String]
+      #
+      # @example
+      #   Faker::LoremFlickr.pixelated_image #=> "https://loremflickr.com/p/300/300/all"
+      #   Faker::LoremFlickr.pixelated_image(size: "50x60") #=> "https://loremflickr.com/p/50/60/all"
+      #   Faker::LoremFlickr.pixelated_image(size: "50x60", search_terms: ['sports']) #=> "https://loremflickr.com/p/50/60/sports"
+      #   Faker::LoremFlickr.pixelated_image(size: "50x60", search_terms: ['sports', 'fitness']) #=> "https://loremflickr.com/p/50/60/sports,fitness"
+      #   Faker::LoremFlickr.pixelated_image(size: "50x60", search_terms: ['sports', 'fitness'], match_all: true) #=> "https://loremflickr.com/p/50/60/sports,fitness/all"
+      #
+      # @faker.version 1.9.0
+      def pixelated_image(legacy_size = NOT_GIVEN, legacy_search_terms = NOT_GIVEN, legacy_match_all = NOT_GIVEN, size: '300x300', search_terms: ['all'], match_all: false)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :size if legacy_size != NOT_GIVEN
+          keywords << :search_terms if legacy_search_terms != NOT_GIVEN
+          keywords << :match_all if legacy_match_all != NOT_GIVEN
+        end
+
+        raise ArgumentError, 'Search terms must be specified for pixelated images' unless search_terms.any?
+
+        build_url(size, 'p', search_terms, match_all)
+      end
+
+      ##
+      # Produces a random colorized image URL from loremflickr.com.
+      #
+      # @param size [String] Specifies the size of image to generate.
+      # @param color [String] Specifies the color of image to generate.
+      # @param search_terms [Array<String>] Adds search terms to the image URL.
+      # @param match_all [Boolean] Add "all" as part of the URL.
+      # @return [String]
+      #
+      # @example
+      #   Faker::LoremFlickr.image #=> "https://loremflickr.com/red/300/300/all"
+      #   Faker::LoremFlickr.image(size: "50x60", color: 'blue') #=> "https://loremflickr.com/blue/50/60/all"
+      #   Faker::LoremFlickr.image(size: "50x60", color: 'blue', search_terms: ['sports']) #=> "https://loremflickr.com/blue/50/60/sports"
+      #   Faker::LoremFlickr.image(size: "50x60", color: 'blue', search_terms: ['sports', 'fitness']) #=> "https://loremflickr.com/blue/50/60/sports,fitness"
+      #   Faker::LoremFlickr.image(size: "50x60", color: 'blue', search_terms: ['sports', 'fitness'], match_all: true) #=> "https://loremflickr.com/blue/50/60/sports,fitness/all"
+      #
+      # @faker.version 1.9.0
+      def colorized_image(legacy_size = NOT_GIVEN, legacy_color = NOT_GIVEN, legacy_search_terms = NOT_GIVEN, legacy_match_all = NOT_GIVEN, size: '300x300', color: 'red', search_terms: ['all'], match_all: false)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :size if legacy_size != NOT_GIVEN
+          keywords << :color if legacy_color != NOT_GIVEN
+          keywords << :search_terms if legacy_search_terms != NOT_GIVEN
+          keywords << :match_all if legacy_match_all != NOT_GIVEN
+        end
+
+        raise ArgumentError, 'Search terms must be specified for colorized images' unless search_terms.any?
+        raise ArgumentError, "Supported colorizations are #{SUPPORTED_COLORIZATIONS.join(', ')}" unless SUPPORTED_COLORIZATIONS.include?(color)
+
+        build_url(size, color, search_terms, match_all)
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      private
+
+      def build_url(size, format, search_terms, match_all)
+        raise ArgumentError, 'Size should be specified in format 300x300' unless size =~ /^[0-9]+x[0-9]+$/
+
+        url_parts = ['https://loremflickr.com']
+        url_parts << format
+        url_parts += size.split('x')
+        url_parts << search_terms.compact.join(',') if search_terms.any?
+        url_parts << 'all' if match_all
+        url_parts.compact.join('/')
+      end
+    end
+  end
+end

data/lib/faker/default/lorem_pixel.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Faker
+  class LoremPixel < Base
+    class << self
+      SUPPORTED_CATEGORIES = %w[abstract
+                                animals
+                                business
+                                cats
+                                city
+                                food
+                                nightlife
+                                fashion
+                                people
+                                nature
+                                sports
+                                technics
+                                transport].freeze
+
+      # rubocop:disable Metrics/ParameterLists
+
+      ##
+      # Produces a random image URL from lorempixel.com.
+      #
+      # @param size [String] Specifies the size of image to generate.
+      # @param is_gray [Boolean] Determines if the image is gray.
+      # @param category [Symbol] Adds the category of the generated image to the URL.
+      # @param number [Integer] Adds a number as part of the URL.
+      # @param text [Integer] Adds dummy text as part of the URL.
+      # @param secure [Boolean] Changes the image URL between http and https.
+      # @return [String]
+      #
+      # @example
+      #   Faker::LoremPixel.image #=> "https://lorempixel.com/300/300"
+      #   Faker::LoremPixel.image(size: "50x60") #=> "https://lorempixel.com/50/60"
+      #   Faker::LoremPixel.image(size: "50x60", is_gray: true) #=> "https://lorempixel.com/g/50/60"
+      #   Faker::LoremPixel.image(size: "50x60", is_gray: false, category: 'sports') #=> "https://lorempixel.com/50/60/sports"
+      #   Faker::LoremPixel.image(size: "50x60", is_gray: false, category: 'sports', number: 3) #=> "https://lorempixel.com/50/60/sports/3"
+      #   Faker::LoremPixel.image(size: "50x60", is_gray: false, category: 'sports', number: 3, text: 'Dummy-text') #=> "https://lorempixel.com/50/60/sports/3/Dummy-text"
+      #   Faker::LoremPixel.image(size: "50x60", is_gray: false, category: 'sports', number: nil, text: 'Dummy-text') #=> "https://lorempixel.com/50/60/sports/Dummy-text"
+      #   Faker::LoremPixel.image(secure: false) #=> "http://lorempixel.com/300/300"
+      #
+      # @faker.version 1.7.0
+      def image(legacy_size = NOT_GIVEN, legacy_is_gray = NOT_GIVEN, legacy_category = NOT_GIVEN, legacy_number = NOT_GIVEN, legacy_text = NOT_GIVEN, legacy_secure = NOT_GIVEN, size: '300x300', is_gray: false, category: nil, number: nil, text: nil, secure: true)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :size if legacy_size != NOT_GIVEN
+          keywords << :is_gray if legacy_is_gray != NOT_GIVEN
+          keywords << :category if legacy_category != NOT_GIVEN
+          keywords << :number if legacy_number != NOT_GIVEN
+          keywords << :text if legacy_text != NOT_GIVEN
+          keywords << :secure if legacy_secure != NOT_GIVEN
+        end
+
+        raise ArgumentError, 'Size should be specified in format 300x300' unless size =~ /^[0-9]+x[0-9]+$/
+        raise ArgumentError, "Supported categories are #{SUPPORTED_CATEGORIES.join(', ')}" unless category.nil? || SUPPORTED_CATEGORIES.include?(category)
+        raise ArgumentError, 'Category required when number is passed' if !number.nil? && category.nil?
+        raise ArgumentError, 'Number must be between 1 and 10' unless number.nil? || (1..10).cover?(number)
+        raise ArgumentError, 'Category and number must be passed when text is passed' if !text.nil? && number.nil? && category.nil?
+
+        url_parts = secure ? ['https:/'] : ['http:/']
+        url_parts << ['lorempixel.com']
+        url_parts << 'g' if is_gray
+        url_parts += size.split('x')
+        url_parts += [category, number, text].compact
+        url_parts.join('/')
+      end
+      # rubocop:enable Metrics/ParameterLists
+    end
+  end
+end

data/lib/faker/default/markdown.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+module Faker
+  class Markdown < Base
+    class << self
+      ##
+      # Produces a random header format.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Markdown.headers #=> "##### Autem"
+      #
+      # @faker.version 1.8.0
+      def headers
+        "#{fetch('markdown.headers')} #{Lorem.word.capitalize}"
+      end
+
+      ##
+      # Produces a random emphasis formatting on a random word in two sentences.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Markdown.emphasis #=> "_Incidunt atque quis repellat id impedit.  Quas numquam quod incidunt dicta non. Blanditiis delectus laudantium atque reiciendis qui._"
+      #
+      # @faker.version 1.8.0
+      def emphasis
+        paragraph = Faker::Lorem.paragraph(sentence_count: 3)
+        words = paragraph.split
+        position = rand(0..words.length - 1)
+        formatting = fetch('markdown.emphasis')
+        words[position] = "#{formatting}#{words[position]}#{formatting}"
+        words.join(' ')
+      end
+
+      ##
+      # Produces a random ordered list of items between 1 and 10 randomly.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Markdown.ordered_list #=> "1. Qui reiciendis non consequatur atque.\n2. Quo doloremque veritatis tempora aut.\n3. Aspernatur.\n4. Ea ab.\n5. Qui.\n6. Sit pariatur nemo eveniet.\n7. Molestiae aut.\n8. Nihil molestias iure placeat.\n9. Dolore autem quisquam."
+      #
+      # @faker.version 1.8.0
+      def ordered_list
+        number = rand(1..10)
+
+        result = []
+        number.times do |i|
+          result << "#{i}. #{Faker::Lorem.sentence(word_count: 1)} \n"
+        end
+        result.join
+      end
+
+      ##
+      # Produces a random unordered list of items between 1 and 10 randomly.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Markdown.unordered_list #=> "* Voluptatum aliquid tempora molestiae facilis non sed.\n* Nostrum omnis iste impedit voluptatum dolor.\n* Esse quidem et facere."
+      #
+      # @faker.version 1.8.0
+      def unordered_list
+        number = rand(1..10)
+
+        result = []
+        number.times do |_i|
+          result << "* #{Faker::Lorem.sentence(word_count: 1)} \n"
+        end
+        result.join
+      end
+
+      ##
+      # Produces a random inline code snippet between two sentences.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Markdown.inline_code #=> "Aut eos quis suscipit. `Dignissimos voluptatem expedita qui.` Quo doloremque veritatis tempora aut."
+      #
+      # @faker.version 1.8.0
+      def inline_code
+        "`#{Faker::Lorem.sentence(word_count: 1)}`"
+      end
+
+      ##
+      # Produces a random code block formatted in Ruby.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Markdown.block_code #=> "```ruby\nEos quasi qui.\n```"
+      #
+      # @faker.version 1.8.0
+      def block_code
+        "```ruby\n#{Lorem.sentence(word_count: 1)}\n```"
+      end
+
+      ##
+      # Produces a random 3x4 table with a row of headings, a row of hyphens and two rows of data
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Markdown.table #=> "ad | similique | voluptatem\n---- | ---- | ----\ncorrupti | est | rerum\nmolestiae | quidem | et"
+      #
+      # @faker.version 1.8.0
+      def table
+        table = []
+        3.times do
+          table << "#{Lorem.word} | #{Lorem.word} | #{Lorem.word}"
+        end
+        table.insert(1, '---- | ---- | ----')
+        table.join("\n")
+      end
+
+      ##
+      # Produces a random method from the methods above, excluding the methods listed in the arguments.
+      #
+      # @overload random(methods)
+      #   @param methods [Symbol] Specify which methods to exclude.
+      #
+      # @return [String, Array<String>]
+      #
+      # @example
+      #   Faker::Markdown.random #=> returns output from a single method outlined above
+      #   Faker::Markdown.random("table") #=> returns output from any single method outlined above except for "table"
+      #   Faker::Markdown.random("ordered_list", "unordered_list") #=> returns output from any single method outlined above except for either ordered_list and unordered_list
+      #
+      # @faker.version 1.8.0
+      def random(*args)
+        method_list = available_methods
+        args&.each { |ex| method_list.delete_if { |meth| meth == ex.to_sym } }
+        send(method_list[Faker::Config.random.rand(0..method_list.length - 1)])
+      end
+
+      ##
+      # Produces a simulated blog-esque text-heavy block in markdown
+      #
+      # Keyword arguments: sentences, repeat
+      # @param sentences [Integer] Specifies how many sentences make a text block.
+      # @param repeat [Integer] Specifies how many times the text block repeats.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Markdown.sandwich #=> returns newline separated content of 1 header, 1 default lorem paragraph, and 1 random markdown element
+      #   Faker::Markdown.sandwich(sentences: 5) #=> returns newline separated content of 1 header, 1 5-sentence lorem paragraph, and 1 random markdown element
+      #   Faker::Markdown.sandwich(sentences: 6, repeat: 3) #=> returns newline separated content of 1 header, and then 3 sections consisting of, here, 1 6-sentence lorem paragraph and 1 random markdown element. The random markdown element is chosen at random in each iteration of the paragraph-markdown pairing.
+      #
+      # @faker.version 1.8.0
+      def sandwich(legacy_sentences = NOT_GIVEN, legacy_repeat = NOT_GIVEN, sentences: 3, repeat: 1)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :sentences if legacy_sentences != NOT_GIVEN
+          keywords << :repeat if legacy_repeat != NOT_GIVEN
+        end
+
+        text_block = []
+        text_block << headers
+        repeat.times do
+          text_block << Faker::Lorem.paragraph(sentence_count: sentences)
+          text_block << random
+        end
+        text_block.join("\n")
+      end
+
+      private
+
+      def available_methods
+        (Markdown.public_methods(false) - Base.methods).sort
+      end
+    end
+  end
+end