faker 3.2.0 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96ec3715aa40eae20241ea0235f17234c691cbd808a5a5f523e2600979bc1c18
-  data.tar.gz: e57effe991fbdbc74562d35066f8db66f46be5d3d441e7b650c720a072c23a94
+  metadata.gz: 5d53bbdb52aa714d065ea68bcddd91aad8ca346b3e00ce828e5a95a7f32fb9cc
+  data.tar.gz: 05fa5f30f28a2b00825253650e23ea433f26457c43bf822117628f7494b660a1
 SHA512:
-  metadata.gz: 9a12b535d55c2e3d5559228f6b9eafd98a383692165670c7a80f4a986d1c3b23637d59faa69fcc2b06142ee2445e88ce4b8057bdf72f71eafd0c86baeb9147ed
-  data.tar.gz: 844caa61e4c4be1975f0fc8355302627ff9ead7cf7d423dd78313a4876190482fcb471a95fb43509e0e761d0bac671484851edbaf3cf98325d7864c591b83e6e
+  metadata.gz: 253c37f13596516e56f85bfbd7e509ececcfa1dd77d9ceec3cd92d127fed1249a4197dbd1ccbb0699ee9895870eaa30d61f59288bc0d954fa9805f3526346539
+  data.tar.gz: 2e1f76f104cd9b0a3852366c26847692620129e795bb321ada197829b2d981a0a0e21f723597c741971a78a540597a84d0c86a2b9bda5fdf059e05f1f2b57c7f

data/README.md

@@ -169,9 +169,7 @@ Faker::Config.locale = 'es'
 Faker::Config.locale = :es
 ```
 
-Note: Overriding the default locale might not be thread-safe. See [Locale setting can be ignored #2563](https://github.com/faker-ruby/faker/issues/2563) for more details.
-
-To override Faker's locales,
+To override Faker's locales, and set it on threaded server environments
 check out the [locales README](lib/locales/README.md).
 
 ### Minitest and Faker >= 2.22
@@ -325,6 +323,7 @@ gem 'faker', :git => 'https://github.com/faker-ruby/faker.git', :branch => 'main
   <summary>Travel</summary>
 
   - [Faker:Travel::Airport](doc/travel/airport.md)
+  - [Faker:Travel::TrainStation](doc/travel/train_station.md)
 </details>
 
 <details>
@@ -346,6 +345,7 @@ gem 'faker', :git => 'https://github.com/faker-ruby/faker.git', :branch => 'main
   - [Faker::Games::Dota](doc/games/dota.md)
   - [Faker::Games::ElderScrolls](doc/games/elder_scrolls.md)
   - [Faker::Games::Fallout](doc/games/fallout.md)
+  - [Faker::Games::FinalFantasyXIV](doc/games/final_fantasy_xiv.md)
   - [Faker::Games::HalfLife](doc/games/half_life.md)
   - [Faker::Games::Heroes](doc/games/heroes.md)
   - [Faker::Games::HeroesOfTheStorm](doc/games/heroes_of_the_storm.md)
@@ -438,6 +438,7 @@ gem 'faker', :git => 'https://github.com/faker-ruby/faker.git', :branch => 'main
   <summary>Tv Shows</summary>
 
   - [Faker::TvShows::AquaTeenHungerForce](doc/tv_shows/aqua_teen_hunger_force.md)
+  - [Faker::TvShows::Archer](doc/tv_shows/archer.md)
   - [Faker::TvShows::BigBangTheory](doc/tv_shows/big_bang_theory.md)
   - [Faker::TvShows::BojackHorseman](doc/tv_shows/bojack_horseman.md)
   - [Faker::TvShows::BreakingBad](doc/tv_shows/breaking_bad.md)

data/lib/faker/default/chile_rut.rb

@@ -8,18 +8,19 @@ module Faker
       ##
       # Produces a random Chilean RUT (Rol Unico Tributario, ID with 8 digits).
       #
-      # @param min_rut [Integer] Specifies the minimum value of the rut.
-      # @param fixed [Boolean] Determines if the rut is fixed (returns the min_rut value).
+      # @param min_rut [Integer] Specifies the minimum value of the RUT.
+      # @param max_rut [Integer] Specifies the maximum value of the RUT.
+      # @param fixed [Boolean] Determines if the RUT is fixed (returns the min_rut value).
       # @return [Number]
       #
       # @example
       #   Faker::ChileRut.rut #=> 11235813
-      #   Faker::ChileRut.rut(min_rut: 20890156) #=> 31853211
-      #   Faker::ChileRut.rut(min_rut: 20890156, fixed: true) #=> 20890156
+      #   Faker::ChileRut.rut(min_rut: 10_000_000, max_rut: 30_000_000) #=> 21853211
+      #   Faker::ChileRut.rut(min_rut: 20_890_156, fixed: true) #=> 20890156
       #
-      # @faker.version 1.9.2
-      def rut(min_rut: 1, fixed: false)
-        @last_rut = fixed ? min_rut : rand_in_range(min_rut, 99_999_999)
+      # @faker.version next
+      def rut(min_rut: 1, max_rut: 99_999_999, fixed: false)
+        @last_rut = fixed ? min_rut : rand_in_range(min_rut, max_rut)
       end
 
       ##
@@ -68,25 +69,30 @@ module Faker
       ##
       # Produces a random Chilean RUT (Rol Unico Tributario, ID with 8 digits) with a dv (digito verificador, check-digit).
       #
-      # @param min_rut [Integer] Specifies the minimum value of the rut.
-      # @param fixed [Boolean] Determines if the rut is fixed (returns the min_rut value).
+      # @param min_rut [Integer] Specifies the minimum value of the RUT.
+      # @param max_rut [Integer] Specifies the maximum value of the RUT.
+      # @param fixed [Boolean] Determines if the RUT is fixed (returns the min_rut value).
       # @return [String]
       #
       # @example
       #   Faker::ChileRut.full_rut #=> "30686957-4"
-      #   Faker::ChileRut.full_rut(min_rut: 20890156) #=> "30686957-4"
-      #   Faker::ChileRut.full_rut(min_rut: 30686957, fixed: true) #=> "30686957-4"
+      #   Faker::ChileRut.full_rut(min_rut: 10_000_000, max_rut: 30_000_000) #=> "20686957-4"
+      #   Faker::ChileRut.full_rut(min_rut: 30_686_957, fixed: true) #=> "30686957-4"
       #
       # @faker.version next
-      def full_rut(min_rut: 0, fixed: false, formatted: false)
-        if formatted
-          "#{rut(min_rut: min_rut, fixed: fixed).to_s.reverse.gsub(/(\d{3})(?=\d)/, '\\1.').reverse}-#{dv}"
-        else
-          "#{rut(min_rut: min_rut, fixed: fixed)}-#{dv}"
-        end
+      def full_rut(min_rut: 1, max_rut: 99_999_999, fixed: false, formatted: false)
+        this_rut = rut(min_rut: min_rut, max_rut: max_rut, fixed: fixed)
+        this_rut = format_rut(this_rut) if formatted
+        "#{this_rut}-#{dv}"
       end
 
       attr_reader :last_rut
+
+      private
+
+      def format_rut(rut)
+        rut.to_s.reverse.gsub(/(\d{3})(?=\d)/, '\\1.').reverse
+      end
     end
   end
 end

data/lib/faker/default/code.rb

@@ -93,11 +93,23 @@ module Faker
       # @faker.version 2.2.0
       def nric(min_age: 18, max_age: 65)
         birthyear = Date.birthday(min_age: min_age, max_age: max_age).year
-        prefix = birthyear < 2000 ? 'S' : 'T'
-        values = birthyear.to_s[-2..]
-        values << regexify(/\d{5}/)
-        check_alpha = generate_nric_check_alphabet(values, prefix)
-        "#{prefix}#{values}#{check_alpha}"
+
+        generate(:string) do |g|
+          g.computed(name: :prefix) do
+            if birthyear < 2000
+              'S'
+            else
+              'T'
+            end
+          end
+          g.computed(name: :yy) do
+            birthyear.to_s[-2..]
+          end
+          g.int(name: :values, length: 5)
+          g.computed(name: :check, deps: %i[prefix yy values]) do |prefix, yy, values|
+            generate_nric_check_alphabet("#{yy}#{values}", prefix)
+          end
+        end
       end
 
       ##
@@ -197,15 +209,29 @@ module Faker
       end
 
       def generate_base10_isbn
-        values = regexify(/\d{9}/)
-        remainder = sum(values) { |value, index| (index + 1) * value.to_i } % 11
-        values << "-#{remainder == 10 ? 'X' : remainder}"
+        generate(:string) do |g|
+          g.int(name: :values, length: 9)
+          g.lit('-')
+          g.computed(name: :checksum, deps: [:values]) do |values|
+            remainder = sum(values.to_s) { |value, offset| (offset + 1) * value.to_i } % 11
+            if remainder == 10
+              'X'
+            else
+              remainder.to_s
+            end
+          end
+        end
       end
 
       def generate_base13_isbn
-        values = regexify(/\d{12}/)
-        remainder = sum(values) { |value, index| index.even? ? value.to_i : value.to_i * 3 } % 10
-        values << "-#{(10 - remainder) % 10}"
+        generate(:string) do |g|
+          g.int(name: :values, length: 12)
+          g.lit('-')
+          g.computed(name: :checksum, deps: [:values]) do |values|
+            remainder = sum(values.to_s) { |value, offset| offset.even? ? value.to_i : value.to_i * 3 } % 10
+            (10 - remainder) % 10
+          end
+        end
       end
 
       def sum(values)
@@ -215,15 +241,31 @@ module Faker
       end
 
       def generate_base8_ean
-        values = regexify(/\d{7}/)
-        check_digit = 10 - values.chars.each_with_index.inject(0) { |s, (v, i)| s + v.to_i * EAN_CHECK_DIGIT8[i] } % 10
-        values << (check_digit == 10 ? 0 : check_digit).to_s
+        generate(:string) do |g|
+          g.int(name: :values, length: 7)
+          g.computed(name: :checksum, deps: [:values]) do |values|
+            check_digit = 10 - values.to_s.chars.each_with_index.inject(0) { |s, (v, i)| s + v.to_i * EAN_CHECK_DIGIT8[i] } % 10
+            if check_digit == 10
+              0
+            else
+              check_digit
+            end
+          end
+        end
       end
 
       def generate_base13_ean
-        values = regexify(/\d{12}/)
-        check_digit = 10 - values.chars.each_with_index.inject(0) { |s, (v, i)| s + v.to_i * EAN_CHECK_DIGIT13[i] } % 10
-        values << (check_digit == 10 ? 0 : check_digit).to_s
+        generate(:string) do |g|
+          g.int(name: :values, length: 12)
+          g.computed(name: :checksum, deps: [:values]) do |values|
+            check_digit = 10 - values.to_s.chars.each_with_index.inject(0) { |s, (v, i)| s + v.to_i * EAN_CHECK_DIGIT13[i] } % 10
+            if check_digit == 10
+              0
+            else
+              check_digit
+            end
+          end
+        end
       end
 
       EAN_CHECK_DIGIT8 = [3, 1, 3, 1, 3, 1, 3].freeze
@@ -231,7 +273,7 @@ module Faker
 
       def rut_verificator_digit(rut)
         total = rut.to_s.rjust(8, '0').chars.zip(%w[3 2 7 6 5 4 3 2]).collect { |a, b| a.to_i * b.to_i }.inject(:+)
-        (11 - total % 11).to_s.gsub(/10/, 'k').gsub(/11/, '0')
+        (11 - total % 11).to_s.gsub('10', 'k').gsub('11', '0')
       end
 
       def generate_nric_check_alphabet(values, prefix)

data/lib/faker/default/company.rb

@@ -343,7 +343,12 @@ module Faker
       #
       # @faker.version 1.9.2
       def south_african_pty_ltd_registration_number
-        regexify(%r{\d{4}/\d{4,10}/07})
+        generate(:string) do |g|
+          g.int(length: 4)
+          g.lit('/')
+          g.int(ranges: [1000..9_999_999_999])
+          g.lit('/07')
+        end
       end
 
       ##
@@ -356,7 +361,18 @@ module Faker
       #
       # @faker.version 1.9.2
       def south_african_close_corporation_registration_number
-        regexify(%r{(CK\d{2}|\d{4})/\d{4,10}/23})
+        generate(:string) do |g|
+          g.oneof do |one|
+            one.group do |g_|
+              g_.lit('CK')
+              g_.int(length: 2)
+            end
+            one.int(length: 4)
+          end
+          g.lit('/')
+          g.int(ranges: [1000..9_999_999_999])
+          g.lit('/23')
+        end
       end
 
       ##
@@ -369,7 +385,12 @@ module Faker
       #
       # @faker.version 1.9.2
       def south_african_listed_company_registration_number
-        regexify(%r{\d{4}/\d{4,10}/06})
+        generate(:string) do |g|
+          g.int(length: 4)
+          g.lit('/')
+          g.int(ranges: [1000..9_999_999_999])
+          g.lit('/06')
+        end
       end
 
       ##
@@ -382,7 +403,12 @@ module Faker
       #
       # @faker.version 1.9.2
       def south_african_trust_registration_number
-        regexify(%r{IT\d{2,4}/\d{2,10}})
+        generate(:string) do |g|
+          g.lit('IT')
+          g.int(ranges: [10..9999])
+          g.lit('/')
+          g.int(ranges: [10..9_999_999_999])
+        end
       end
 
       ##
@@ -567,7 +593,7 @@ module Faker
         end
 
         control = control.to_s[-1].to_i
-        control = control.zero? ? control : 10 - control
+        control = 10 - control unless control.zero?
 
         %w[A B C D E F G H J U V].include?(organization_type) ? control : letters[control]
       end

data/lib/faker/default/date.rb

@@ -2,6 +2,8 @@
 
 module Faker
   class Date < Base
+    DAYS_OF_WEEK = %i[sunday monday tuesday wednesday thursday friday saturday].freeze
+
     class << self
       ##
       # Produce a random date between two dates.
@@ -53,18 +55,26 @@ module Faker
       ##
       # Produce a random date in the future (up to N days).
       #
+      # @param from [Integer] The start of the usable forward date range.
       # @param days [Integer] The maximum number of days to go into the future.
       # @return [Date]
       #
-      # @example
+      # @example if used with or without Rails (Active Support)
       #   Faker::Date.forward(days: 23) #=> #<Date: 2014-10-03>
       #
+      # @example if used with Rails (Active Support)
+      #  Faker::Date.forward(from: Date.current, days: 17) #=> #<Date: 2022-06-22>
+      #
+      # @example if used with or without Rails (Active Support)
+      #   Faker::Date.forward(from: '2022-06-03', days: 10) #=> #<Date: 2022-10-13>
+      #
       # @faker.version 1.0.0
-      def forward(days: 365)
-        from = ::Date.today + 1
-        to   = ::Date.today + days
+      def forward(from: ::Date.today, days: 365)
+        start_date = get_date_object(from)
+        since = start_date + 1
+        to = start_date + days
 
-        between(from: from, to: to).to_date
+        between(from: since, to: to).to_date
       end
 
       ##
@@ -128,6 +138,52 @@ module Faker
         between(from: from, to: to).to_date
       end
 
+      ##
+      # Produce a random date at given day(s) of the week between two dates.
+      #
+      # @param day [Symbol, Array<Symbol>] # The day(s) of the week. See {DAYS_OF_WEEK}.
+      # @param from [Date, String] The start of the usable date range.
+      # @param to [Date, String] The end of the usable date range.
+      # @return [Date]
+      #
+      # @example if used with or without Rails (Active Support)
+      #   Faker::Date.on_day_of_week_between(day: :tuesday, from: '2023-01-01', to: '2023-02-01') #=> #<Date: 2032-01-10>
+      #
+      # @example if used with Rails (Active Support)
+      #   Faker::Date.on_day_of_week_between(day: [:saturday, :sunday], from: 1.month.ago, to: Date.today) #=> #<Date: 2014-09-24>
+      #
+      # @faker.version next
+      def on_day_of_week_between(day:, from:, to:)
+        days = [day].flatten
+        raise ArgumentError, 'Day of week cannot be empty' if days.empty?
+
+        # Convert given days of the week to numbers used by `Date#wday` method
+        numeric_weekdays = days.map do |d|
+          DAYS_OF_WEEK.index(d.to_sym.downcase) || raise(ArgumentError, "#{d} is not a valid day of the week")
+        end
+
+        from = get_date_object(from)
+        to   = get_date_object(to)
+        date = Faker::Base.rand_in_range(from, to)
+
+        # If the initial date is not on one of the wanted days of the week...
+        unless numeric_weekdays.include? date.wday
+          # ...pick a date nearby that is on one of the wanted days of the week instead
+          date += sample(numeric_weekdays) - date.wday
+
+          # Move date 1 week earlier or later if the adjusted date is now outside the date range
+          date += 7 if date < from
+          date -= 7 if date > to
+
+          if date > to || date < from
+            raise ArgumentError,
+                  "There is no #{DAYS_OF_WEEK[date.wday].capitalize} between #{from} and #{to}. Increase the from/to date range or choose a different day of the week."
+          end
+        end
+
+        date
+      end
+
       private
 
       def birthday_date(date, age)

data/lib/faker/default/driving_licence.rb

@@ -98,17 +98,28 @@ module Faker
       end
 
       def gb_licence_year(dob, gender)
-        decade = (dob.year / 10) % 10
-        year = dob.year % 10
-        month = gender == :female ? dob.month + 50 : dob.month
-        # Rubocop's preferred formatting is pretty gory
-        # rubocop:disable Style/FormatString
-        "#{decade}#{'%02d' % month}#{'%02d' % dob.day}#{year}"
-        # rubocop:enable Style/FormatString
+        generate(:string) do |g|
+          g.computed do
+            (dob.year / 10) % 10
+          end
+          g.computed do
+            gender_marker = gender == :female ? 50 : 0
+            format('%02d', (dob.month + gender_marker))
+          end
+          g.computed do
+            format('%02d', dob.day)
+          end
+          g.computed do
+            dob.year % 10
+          end
+        end
       end
 
       def gb_licence_checksum
-        regexify(/[0-9][A-Z][A-Z]/)
+        generate(:string) do |g|
+          g.int
+          g.letter(ranges: ['A'..'Z'], length: 2)
+        end
       end
     end
   end

data/lib/faker/default/html.rb

@@ -0,0 +1,230 @@
+# frozen_string_literal: true
+
+module Faker
+  class HTML < Base
+    class << self
+      ##
+      # Produces a random HTML header format.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::HTML.heading #=> "<h5>Autem</h5>"
+      #
+      # @faker.version 3.2.1
+      def heading
+        level = rand(1..6)
+        "<h#{level}>#{Lorem.word.capitalize}</h#{level}>"
+      end
+
+      ##
+      # Produces a random HTML paragraph format.
+      #
+      # @param sentence_count [Integer] The number of sentences in the paragraph.
+      # @param supplemental [Boolean] Include supplemental text.
+      # @param random_sentences_to_add [Integer] The number of random sentences to add to the paragraph.
+      # @param exclude_words [Array<String>] Words to exclude from the generated paragraph.
+      # @return [String]
+      #
+      # @example
+      #   Faker::HTML.paragraph #=> "<p>Incidunt atque quis</p>"
+      #
+      # @faker.version 3.2.1
+      def paragraph(sentence_count: 3, supplemental: false, random_sentences_to_add: 0, exclude_words: nil)
+        "<p>#{Faker::Lorem.paragraph(sentence_count: sentence_count, supplemental: supplemental, random_sentences_to_add: random_sentences_to_add, exclude_words: exclude_words)}</p>"
+      end
+
+      ##
+      # Produces a random emphasis formatting on a random word in two HTML paragraphs.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::HTML.emphasis #=> "<em>repellat id impedit</em>"
+      #
+      # @faker.version 3.2.1
+      def emphasis
+        "<em>#{Faker::Lorem.paragraph(sentence_count: 1)}</em>"
+      end
+
+      ##
+      # Produces a random ordered list in HTML format, with at least one element.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::HTML.ordered_list #=> "<ol>\n<li>Qui reiciendis non consequatur atque.</li>\n<li>Quo doloremque veritatis tempora aut.</li>\n<li>Aspernatur.</li>\n<li>Ea ab.</li>\n<li>Qui.</li>\n<li>Sit pariatur nemo eveniet.</li>\n<li>Molestiae aut.</li>\n<li>Nihil molestias iure placeat.</li>\n<li>Dolore autem quisquam.</li>\n</ol>"
+      #
+      # @faker.version 3.2.1
+      def ordered_list
+        number = rand(1..10)
+
+        items = []
+        number.times do
+          items << "<li>#{Faker::Lorem.sentence(word_count: 1)}</li>"
+        end
+
+        "<ol>\n#{items.join("\n")}\n</ol>"
+      end
+
+      ##
+      # Produces a random unordered list of items between 1 and 10 randomly in HTML format.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::HTML.unordered_list #=> "<ul>\n<li>Voluptatum aliquid tempora molestiae facilis non sed.</li>\n<li>Nostrum omnis iste impedit voluptatum dolor.</li>\n<li>Esse quidem et facere.</li>\n</ul>"
+      #
+      # @faker.version 3.2.1
+      def unordered_list
+        number = rand(1..10)
+
+        items = []
+        number.times do
+          items << "<li>#{Faker::Lorem.sentence(word_count: 1)}</li>"
+        end
+
+        "<ul>\n#{items.join("\n")}\n</ul>"
+      end
+
+      ##
+      # Produces a random code block formatted in HTML.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::HTML.code #=> "<code>Eos quasi qui.</code>"
+      #
+      # @faker.version 3.2.1
+      def code
+        "<code>#{Lorem.sentence(word_count: 1)}</code>"
+      end
+
+      ##
+      # Produces a random HTML table.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::HTML.table #=> "<table>\n<thead>\n<th>ad</th>\n<th>similique</th>\n<th>voluptatem</th>\n</thead>\n<tbody>\n<td>corrupti</td>\n<td>est</td>\n<td>rerum</td>\n<td>molestiae</td>\n<td>quidem</td>\n<td>et</td>\n<td>in</td>\n<td>tempora</td>\n<td>at</td>\n<\tbody>\n<tfoot>\n<td>voluptatem</td>\n<td>debitis</td>\n<td>rem</td>\n</tfoot>\n</table>"
+      #
+      # @faker.version 3.2.1
+      def table
+        header_row = generate_table_row('th', 3)
+        footer_row = generate_table_row('td', 3)
+
+        body_rows = []
+        3.times do
+          row = generate_table_row('td', 3)
+          body_rows << row
+        end
+
+        thead = "<thead>\n#{header_row}</thead>"
+        tbody = "<tbody>\n#{body_rows.join("\n")}</tbody>"
+        tfoot = "<tfoot>\n#{footer_row}</tfoot>"
+
+        "<table>\n#{thead}\n#{tbody}\n#{tfoot}\n</table>"
+      end
+
+      ##
+      # Generates a random <script> tag with the `src` attribute set to a random URL.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::HTML.script #=> "<script src=\"http://gulgowski.name/jordan.weimann.js\"></script>"
+      #
+      # @faker.version 3.2.1
+      def script
+        "<script src=\"#{Faker::Internet.url}.js\"></script>"
+      end
+
+      ##
+      # Generates a random <link> tag with the `rel` attribute set to "stylesheet" and the `href` attribute set to a random URL.
+      #
+      # @param rel [String] The rel of the link tag.
+      # @return [String]
+      #
+      # @example
+      #   Faker::HTML.link #=> "<link rel=\"stylesheet\" href=\"http://fay.io/darryl.barrows.css\">"
+      #
+      # @faker.version 3.2.1
+      def link(rel: 'stylesheet')
+        "<link rel=\"#{rel}\" href=\"#{Faker::Internet.url}.css\">"
+      end
+
+      ##
+      # Generates HTML content with customizable attributes for any HTML tag.
+      #
+      # @param tag [String] The HTML tag to generate.
+      # @param content [String] The Content of the HTML tag.
+      # @param attributes [Hash] The attributes to include in the tag.
+      # @return [String]
+      #
+      # @example
+      #   Faker::HTML.element(tag: 'div', content: "This is a div with XSS attributes.", attributes: {class: 'xss', onclick: "alert('XSS')"}) #=> "<div class=\"xss\" onclick=\"alert('XSS')\">This is a div with XSS attributes.</div>"
+      #
+      # @faker.version 3.2.1
+      def element(tag: 'div', content: Lorem.sentence(word_count: 3), attributes: { class: Lorem.word, onclick: "#{Lorem.word}()" })
+        attribute_string = attributes.map { |key, value| "#{key}=\"#{value}\"" }.join(' ')
+        "<#{tag} #{attribute_string}>#{content}</#{tag}>"
+      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]
+      #
+      # @example
+      #   Faker::HTML.random #=> returns output from a single method outlined above
+      #   Faker::HTML.random(exclude: [:table]) #=> returns output from any single method outlined above except for "table"
+      #   Faker::HTML.random(exclude: [:ordered_list, :unordered_list]) #=> returns output from any single method outlined above except for either ordered_list and unordered_list
+      #
+      # @faker.version 3.2.1
+      def random(exclude: [])
+        method_list = available_methods
+        exclude.each { |ex| method_list.delete_if { |meth| meth == ex.to_sym } }
+        send(method_list[Faker::Config.random.rand(0..method_list.length - 1)])
+      end
+
+      ##
+      # Generates a random HTML content sandwich, starting with a header, followed by paragraphs, and random elements.
+      #
+      # @param sentences [Integer] The number of sentences in each paragraph.
+      # @param repeat [Integer] The number of times to repeat the pattern (header, paragraph, random).
+      # @return [String]
+      #
+      # @example
+      #   Faker::HTML.sandwich(sentences: 3, repeat: 2) #=> returns a sandwich of HTML content with 2 repetitions, each having a header, paragraph, and random element
+      #
+      # @faker.version 3.2.1
+      def sandwich(sentences: 3, repeat: 1)
+        text_block = []
+        text_block << heading
+        repeat.times do
+          text_block << paragraph(sentence_count: sentences)
+          text_block << random(exclude: %i[script link])
+        end
+        text_block.join("\n")
+      end
+
+      private
+
+      def available_methods
+        (HTML.public_methods(false) - Base.methods).sort
+      end
+
+      def generate_table_row(tag, cell_count)
+        row = "<tr>\n"
+        cell_count.times do
+          row += "<#{tag == 'th' ? 'th' : 'td'}>#{Lorem.word}</#{tag == 'th' ? 'th' : 'td'}>\n"
+        end
+        row += "</tr>\n"
+        row
+      end
+    end
+  end
+end