faker 2.15.1 → 3.4.2

data/lib/faker/default/drone.rb

@@ -147,7 +147,7 @@ module Faker
       end
 
       ##
-      # Returns operating temprature for drone in Fahrenheit
+      # Returns operating temperature for drone in Fahrenheit
       #
       # @return [String]
       #

data/lib/faker/default/educator.rb

@@ -72,6 +72,19 @@ module Faker
         parse('educator.secondary_school')
       end
 
+      ##
+      # Produces a primary school.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Educator.primary_school #=> "Brighthurst Elementary School"
+      #
+      # @faker.version next
+      def primary_school
+        parse('educator.primary_school')
+      end
+
       ##
       # Produces a campus name.
       #

data/lib/faker/default/emotion.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Faker
+  class Emotion < Base
+    class << self
+      ##
+      # Produces an emotion noun.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Emotion.noun #=> "amazement"
+      #
+      # @faker.version next
+      def noun
+        fetch('emotion.noun')
+      end
+
+      ##
+      # Produces an emotion adjective.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Emotion.adjective # => "nonplussed"
+      #
+      # @faker.version next
+      def adjective
+        fetch('emotion.adjective')
+      end
+    end
+  end
+end

data/lib/faker/default/file.rb

@@ -18,15 +18,7 @@ module Faker
       #   Faker::File.dir(segment_count: 3, root: nil, directory_separator: '\\') #=> "aut-ullam\\quia_quisquam\\ut-eos"
       #
       # @faker.version 1.6.4
-      # rubocop:disable Metrics/ParameterLists
-      def dir(legacy_segment_count = NOT_GIVEN, legacy_root = NOT_GIVEN, legacy_directory_separator = NOT_GIVEN, segment_count: 3, root: nil, directory_separator: ::File::Separator)
-        # rubocop:enable Metrics/ParameterLists
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :segment_count if legacy_segment_count != NOT_GIVEN
-          keywords << :root if legacy_root != NOT_GIVEN
-          keywords << :directory_separator if legacy_directory_separator != NOT_GIVEN
-        end
-
+      def dir(segment_count: 3, root: nil, directory_separator: ::File::Separator)
         Array
           .new(segment_count) { Faker::Internet.slug }
           .unshift(root)
@@ -56,9 +48,9 @@ module Faker
       # @example
       #   Faker::File.mime_type #=> "application/pdf"
       #
-      # @faker.version 1.6.4
-      def mime_type
-        fetch('file.mime_type')
+      # @faker.version next
+      def mime_type(media_type: nil)
+        media_type ? fetch("file.mime_type.#{media_type}") : sample(sample(translate('faker.file.mime_type').values))
       end
 
       ##
@@ -77,16 +69,7 @@ module Faker
       #   Faker::File.file_name(dir: 'foo/bar', name: 'baz', ext: 'mp3', directory_separator: '\\') #=> "foo/bar\\baz.mp3"
       #
       # @faker.version 1.6.4
-      # rubocop:disable Metrics/ParameterLists
-      def file_name(legacy_dir = NOT_GIVEN, legacy_name = NOT_GIVEN, legacy_ext = NOT_GIVEN, legacy_directory_separator = NOT_GIVEN, dir: nil, name: nil, ext: nil, directory_separator: ::File::Separator)
-        # rubocop:enable Metrics/ParameterLists
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :dir if legacy_dir != NOT_GIVEN
-          keywords << :name if legacy_name != NOT_GIVEN
-          keywords << :ext if legacy_ext != NOT_GIVEN
-          keywords << :directory_separator if legacy_directory_separator != NOT_GIVEN
-        end
-
+      def file_name(dir: nil, name: nil, ext: nil, directory_separator: ::File::Separator)
         dir ||= dir(segment_count: 1)
         name ||= Faker::Lorem.word.downcase
         ext ||= extension

data/lib/faker/default/finance.rb

@@ -28,9 +28,9 @@ module Faker
 
         # calculate the luhn checksum digit
         multiplier = 1
-        luhn_sum = template.gsub(/[^0-9]/, '').split('').reverse.map(&:to_i).inject(0) do |sum, digit|
+        luhn_sum = template.gsub(/[^0-9]/, '').chars.reverse.map(&:to_i).inject(0) do |sum, digit|
           multiplier = (multiplier == 2 ? 1 : 2)
-          sum + (digit * multiplier).to_s.split('').map(&:to_i).inject(0) { |digit_sum, cur| digit_sum + cur }
+          sum + (digit * multiplier).to_s.chars.map(&:to_i).inject(0) { |digit_sum, cur| digit_sum + cur }
         end
 
         # the sum plus whatever the last digit is must be a multiple of 10. So, the
@@ -52,11 +52,7 @@ module Faker
       #   Faker::Finance.vat_number('ZA') #=> "ZA79494416181"
       #
       # @faker.version 1.9.2
-      def vat_number(legacy_country = NOT_GIVEN, country: 'BR')
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :country if legacy_country != NOT_GIVEN
-        end
-
+      def vat_number(country: 'BR')
         numerify(fetch("finance.vat_number.#{country}"))
       rescue I18n::MissingTranslationData
         raise ArgumentError, "Could not find vat number for #{country}"
@@ -84,6 +80,33 @@ module Faker
       rescue I18n::MissingTranslationData
         raise ArgumentError, "Could not find market named #{market}"
       end
+
+      ##
+      # Returns a randomly-selected stock market.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Finance.stock_market #=> 'NASDAQ'
+      #
+      # @faker.version next
+      def stock_market
+        fetch('finance.stock_market')
+      end
+
+      ##
+      # Returns a random condominium fiscal code.
+      #
+      # @param country [String] Two capital letter country code to use for the vat number.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Finance.condominium_fiscal_code #=> "012345678"
+      #
+      # @faker.version next
+      def condominium_fiscal_code(country: 'IT')
+        numerify(fetch("finance.condominium_fiscal_code.#{country}"))
+      end
     end
   end
 end

data/lib/faker/default/food.rb

@@ -5,6 +5,19 @@ module Faker
     flexible :food
 
     class << self
+      ##
+      # Retrieves an allergen.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Food.allergen #=> "Peanuts"
+      #
+      # @faker.version next
+      def allergen
+        fetch('food.allergens')
+      end
+
       ##
       # Retrieves a typical dish from each country.
       #
@@ -97,7 +110,7 @@ module Faker
       end
 
       ##
-      # Retrieves metric mesurements
+      # Retrieves metric measurements
       #
       # @return [String]
       #
@@ -108,6 +121,19 @@ module Faker
       def metric_measurement
         fetch('food.metric_measurements')
       end
+
+      ##
+      # Retrieves ethnic category
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Food.ethnic_category #=> "Indian cuisine"
+      #
+      # @faker.version next
+      def ethnic_category
+        fetch('food.ethnic_category')
+      end
     end
   end
 end

data/lib/faker/default/hipster.rb

@@ -32,25 +32,16 @@ module Faker
       #   Faker::Hipster.words(number: 4, supplemental: true, spaces_allowed: true) #=> ["qui", "magni", "craft beer", "est"]
       #
       # @faker.version 1.6.0
-      # rubocop:disable Metrics/ParameterLists
-      def words(legacy_number = NOT_GIVEN, legacy_supplemental = NOT_GIVEN, legacy_spaces_allowed = NOT_GIVEN, number: 3, supplemental: false, spaces_allowed: false)
-        # rubocop:enable Metrics/ParameterLists
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :number if legacy_number != NOT_GIVEN
-          keywords << :supplemental if legacy_supplemental != NOT_GIVEN
-          keywords << :spaces_allowed if legacy_spaces_allowed != NOT_GIVEN
-        end
-
+      def words(number: 3, supplemental: false, spaces_allowed: false)
         resolved_num = resolve(number)
         word_list = (
           translate('faker.hipster.words') +
           (supplemental ? translate('faker.lorem.words') : [])
         )
         word_list *= ((resolved_num / word_list.length) + 1)
+        words = sample(word_list, resolved_num)
+        return words if spaces_allowed
 
-        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
 
@@ -73,15 +64,7 @@ module Faker
       #   Faker::Hipster.sentence(word_count: 3, supplemental: true, random_words_to_add: 0, open_compounds_allowed: false) #=> "Dreamcatcher umami fixie."
       #
       # @faker.version 1.6.0
-      # rubocop:disable Metrics/ParameterLists
-      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: 6, open_compounds_allowed: true)
-        # rubocop:enable Metrics/ParameterLists
-        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
-
+      def sentence(word_count: 4, supplemental: false, random_words_to_add: 6, open_compounds_allowed: true)
         "#{words(number: word_count + rand(random_words_to_add.to_i).to_i, supplemental: supplemental, spaces_allowed: open_compounds_allowed).join(' ').capitalize}."
       end
 
@@ -98,12 +81,7 @@ module Faker
       #   Faker::Hipster.sentences(number: 1, supplemental: true) #=> ["Et sustainable optio aesthetic et."]
       #
       # @faker.version 1.6.0
-      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
-
+      def sentences(number: 3, supplemental: false)
         [].tap do |sentences|
           1.upto(resolve(number)) do
             sentences << sentence(word_count: 3, supplemental: supplemental)
@@ -127,15 +105,7 @@ module Faker
       #   Faker::Hipster.paragraph(sentence_count: 2, supplemental: true, random_sentences_to_add: 4) #=> "Deep v gluten-free unde waistcoat aperiam migas voluptas dolorum. Aut drinking illo sustainable sapiente. Direct trade fanny pack kale chips ennui semiotics."
       #
       # @faker.version 1.6.0
-      # rubocop:disable Metrics/ParameterLists
-      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: 3)
-        # rubocop:enable Metrics/ParameterLists
-        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
-
+      def paragraph(sentence_count: 3, supplemental: false, random_sentences_to_add: 3)
         sentences(number: resolve(sentence_count) + rand(random_sentences_to_add.to_i).to_i, supplemental: supplemental).join(' ')
       end
 
@@ -152,12 +122,7 @@ module Faker
       #   Faker::Hipster.paragraphs(number: 1, supplemental: true) #=> ["Quae direct trade pbr&b quo taxidermy autem loko. Umami quas ratione migas cardigan sriracha minima. Tenetur perspiciatis pickled sed eum doloribus truffaut. Excepturi dreamcatcher meditation."]
       #
       # @faker.version 1.6.0
-      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
-          keywords << :supplemental if legacy_supplemental != NOT_GIVEN
-        end
-
+      def paragraphs(number: 3, supplemental: false)
         [].tap do |paragraphs|
           1.upto(resolve(number)) do
             paragraphs << paragraph(sentence_count: 3, supplemental: supplemental)
@@ -177,12 +142,7 @@ module Faker
       #   Faker::Hipster.paragraph_by_chars(characters: 256, supplemental: false) #=> "Hella kogi blog narwhal sartorial selfies mustache schlitz. Bespoke normcore kitsch cred hella fixie. Park aesthetic fixie migas twee. Cliche mustache brunch tumblr fixie godard. Drinking pop-up synth hoodie dreamcatcher typewriter. Kitsch biodiesel green."
       #
       # @faker.version 1.6.0
-      def paragraph_by_chars(legacy_characters = NOT_GIVEN, legacy_supplemental = NOT_GIVEN, characters: 256, supplemental: false)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :characters if legacy_characters != NOT_GIVEN
-          keywords << :supplemental if legacy_supplemental != NOT_GIVEN
-        end
-
+      def paragraph_by_chars(characters: 256, supplemental: false)
         paragraph = paragraph(sentence_count: 3, supplemental: supplemental)
 
         paragraph += " #{paragraph(sentence_count: 3, supplemental: supplemental)}" while paragraph.length < characters

data/lib/faker/default/hobby.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Faker
+  class Hobby < Base
+    flexible :hobby
+
+    class << self
+      ##
+      # Retrieves a typical hobby activity.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Hobby.activity #=> "Cooking"
+      #
+      # @faker.version next
+      def activity
+        fetch('hobby.activity')
+      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