faker 2.11.0 → 3.4.2

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

@@ -3,15 +3,22 @@
 module Faker
   class File < Base
     class << self
-      # 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
-
+      ##
+      # Produces a random directory name.
+      #
+      # @param segment_count [Integer] Specifies the number of nested folders in the generated string.
+      # @param root [String] Specifies the root of the generated string.
+      # @param directory_separator [String] Specifies the separator between the segments.
+      # @return [String]
+      #
+      # @example
+      #   Faker::File.dir #=> "et_error/sint_voluptas/quas_veritatis"
+      #   Faker::File.dir(segment_count: 2) #=> "ea-suscipit/ut-deleniti"
+      #   Faker::File.dir(segment_count: 3, root: nil, directory_separator: '/') #=> "est_porro/fugit_eveniet/incidunt-autem"
+      #   Faker::File.dir(segment_count: 3, root: nil, directory_separator: '\\') #=> "aut-ullam\\quia_quisquam\\ut-eos"
+      #
+      # @faker.version 1.6.4
+      def dir(segment_count: 3, root: nil, directory_separator: ::File::Separator)
         Array
           .new(segment_count) { Faker::Internet.slug }
           .unshift(root)
@@ -20,24 +27,49 @@ module Faker
           .squeeze(directory_separator)
       end
 
+      ##
+      # Produces a random file extension.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::File.extension #=> "mp3"
+      #
+      # @faker.version 1.6.4
       def extension
         fetch('file.extension')
       end
 
-      def mime_type
-        fetch('file.mime_type')
+      ##
+      # Produces a random mime type.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::File.mime_type #=> "application/pdf"
+      #
+      # @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
 
-      # 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
-
+      ##
+      # Produces a random file name.
+      #
+      # @param dir [String] Specifies the path used for the generated file.
+      # @param name [String] Specifies the filename used for the generated file.
+      # @param ext [String] Specifies the extension used the generated file.
+      # @param directory_separator [String] Specifies the separator between the directory and name elements.
+      # @return [String]
+      #
+      # @example
+      #   Faker::File.file_name(dir: 'path/to') #=> "path/to/something_random.jpg"
+      #   Faker::File.file_name(dir: 'foo/bar', name: 'baz') #=> "foo/bar/baz.zip"
+      #   Faker::File.file_name(dir: 'foo/bar', name: 'baz', ext: 'doc') #=> "foo/bar/baz.doc"
+      #   Faker::File.file_name(dir: 'foo/bar', name: 'baz', ext: 'mp3', directory_separator: '\\') #=> "foo/bar\\baz.mp3"
+      #
+      # @faker.version 1.6.4
+      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

@@ -6,7 +6,21 @@ module Faker
                            diners_club jcb switch solo dankort
                            maestro forbrugsforeningen laser].freeze
 
+    MARKET_LIST = %i[nyse nasdaq].freeze
+
     class << self
+      ##
+      # Produces a random credit card number.
+      #
+      # @param types [String] Specific credit card type.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Finance.credit_card #=> "3018-348979-1853"
+      #   Faker::Finance.credit_card(:mastercard) #=> "6771-8921-2291-6236"
+      #   Faker::Finance.credit_card(:mastercard, :visa) #=> "4448-8934-1277-7195"
+      #
+      # @faker.version 1.2.0
       def credit_card(*types)
         types = CREDIT_CARD_TYPES if types.empty?
         type = sample(types)
@@ -14,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
@@ -26,11 +40,19 @@ module Faker
         template.gsub('L', luhn_digit.to_s)
       end
 
-      def vat_number(legacy_country = NOT_GIVEN, country: 'BR')
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :country if legacy_country != NOT_GIVEN
-        end
-
+      ##
+      # Produces a random vat number.
+      #
+      # @param country [String] Two capital letter country code to use for the vat number.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Finance.vat_number #=> "BR38.395.329/2471-83"
+      #   Faker::Finance.vat_number('DE') #=> "DE593306671"
+      #   Faker::Finance.vat_number('ZA') #=> "ZA79494416181"
+      #
+      # @faker.version 1.9.2
+      def vat_number(country: 'BR')
         numerify(fetch("finance.vat_number.#{country}"))
       rescue I18n::MissingTranslationData
         raise ArgumentError, "Could not find vat number for #{country}"
@@ -39,6 +61,52 @@ module Faker
       def vat_number_keys
         translate('faker.finance.vat_number').keys
       end
+
+      ##
+      # Returns a randomly-selected stock ticker from a specified market.
+      #
+      # @param markets [String] The name of the market to choose the ticker from (e.g. NYSE, NASDAQ)
+      # @return [String]
+      #
+      # @example
+      #   Faker::Finance.ticker #=> 'AMZN'
+      #   Faker::Finance.vat_number('NASDAQ') #=> 'GOOG'
+      #
+      # @faker.version next
+      def ticker(*markets)
+        markets = MARKET_LIST if markets.empty?
+        market = sample(markets)
+        fetch("finance.ticker.#{market}")
+      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.
       #
@@ -93,11 +106,11 @@ module Faker
       #
       # @faker.version 1.7.0
       def measurement
-        fetch('food.measurement_sizes') + ' ' + fetch('food.measurements')
+        "#{fetch('food.measurement_sizes')} #{fetch('food.measurements')}"
       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/gender.rb

@@ -37,7 +37,7 @@ module Faker
       # @example
       #   Faker::Gender.short_binary_type #=> "f"
       #
-      # @faker.version next
+      # @faker.version 2.13.0
       def short_binary_type
         fetch('gender.short_binary_types')
       end

data/lib/faker/default/hipster.rb

@@ -3,51 +3,85 @@
 module Faker
   class Hipster < Base
     class << self
+      ##
+      # Produces a random hipster word.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Hipster.word #=> "irony"
+      #
+      # @faker.version 1.6.0
       def word
         random_word = sample(translate('faker.hipster.words'))
         random_word =~ /\s/ ? word : random_word
       end
 
-      # 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
-
+      ##
+      # Produces a random hipster word.
+      #
+      # @param number [Integer] Specifies the number of words returned
+      # @param supplemental [Boolean] Specifies if the words are supplemental
+      # @param spaces_allowed [Boolean] Specifies if the words may contain spaces
+      # @return [Array<String>]
+      #
+      # @example
+      #   Faker::Hipster.words #=> ["pug", "pitchfork", "chia"]
+      #   Faker::Hipster.words(number: 4) #=> ["ugh", "cardigan", "poutine", "stumptown"]
+      #   Faker::Hipster.words(number: 4, supplemental: true) #=> ["iste", "seitan", "normcore", "provident"]
+      #   Faker::Hipster.words(number: 4, supplemental: true, spaces_allowed: true) #=> ["qui", "magni", "craft beer", "est"]
+      #
+      # @faker.version 1.6.0
+      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
 
-      # 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)
-        # 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
-
-        words(number: word_count + rand(random_words_to_add.to_i).to_i, supplemental: supplemental, spaces_allowed: true).join(' ').capitalize + '.'
+      ##
+      # Produces a random hipster sentence.
+      #
+      # @param word_count [Integer] Specifies the number of words in the sentence
+      # @param supplemental [Boolean] Specifies if the words are supplemental
+      # @param random_words_to_add [Integer] Specifies the number of random words to add
+      # @param open_compounds_allowed [Boolean] Specifies if the generated sentence can contain words having additional spaces
+      # @return [String]
+      #
+      # @example
+      #   Faker::Hipster.sentence #=> "Park iphone leggings put a bird on it."
+      #   Faker::Hipster.sentence(word_count: 3) #=> "Pour-over swag godard."
+      #   Faker::Hipster.sentence(word_count: 3, supplemental: true) #=> "Beard laboriosam sequi celiac."
+      #   Faker::Hipster.sentence(word_count: 3, supplemental: false, random_words_to_add: 4) #=> "Bitters retro mustache aesthetic biodiesel 8-bit."
+      #   Faker::Hipster.sentence(word_count: 3, supplemental: true, random_words_to_add: 4) #=> "Occaecati deleniti messenger bag meh crucifix autem."
+      #   Faker::Hipster.sentence(word_count: 3, supplemental: true, random_words_to_add: 0, open_compounds_allowed: true) #=> "Kale chips nihil eos."
+      #   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
+      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
 
-      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
-
+      ##
+      # Produces random hipster sentences.
+      #
+      # @param number [Integer] Specifies the number of sentences returned
+      # @param supplemental [Boolean] Specifies if the words are supplemental
+      # @return [Array<String>]
+      #
+      # @example
+      #   Faker::Hipster.sentences #=> ["Godard pitchfork vinegar chillwave everyday 90's whatever.", "Pour-over artisan distillery street waistcoat.", "Salvia yr leggings franzen blue bottle."]
+      #   Faker::Hipster.sentences(number: 1) #=> ["Before they sold out pinterest venmo umami try-hard ugh hoodie artisan."]
+      #   Faker::Hipster.sentences(number: 1, supplemental: true) #=> ["Et sustainable optio aesthetic et."]
+      #
+      # @faker.version 1.6.0
+      def sentences(number: 3, supplemental: false)
         [].tap do |sentences|
           1.upto(resolve(number)) do
             sentences << sentence(word_count: 3, supplemental: supplemental)
@@ -55,24 +89,40 @@ module Faker
         end
       end
 
-      # 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
-
+      ##
+      # Produces a random hipster paragraph.
+      #
+      # @param sentence_count [Integer] Specifies the number of sentences in the paragraph
+      # @param supplemental [Boolean] Specifies if the words are supplemental
+      # @param random_sentences_to_add [Boolean] Specifies the number of random sentences to add
+      # @return [String]
+      #
+      # @example
+      #   Faker::Hipster.paragraph #=> "Migas fingerstache pbr&b tofu. Polaroid distillery typewriter echo tofu actually. Slow-carb fanny pack pickled direct trade scenester mlkshk plaid. Banjo venmo chambray cold-pressed typewriter. Fap skateboard intelligentsia."
+      #   Faker::Hipster.paragraph(sentence_count: 2) #=> "Yolo tilde farm-to-table hashtag. Lomo kitsch disrupt forage +1."
+      #   Faker::Hipster.paragraph(sentence_count: 2, supplemental: true) #=> "Typewriter iste ut viral kombucha voluptatem. Sint voluptates saepe. Direct trade irony chia excepturi yuccie. Biodiesel esse listicle et quam suscipit."
+      #   Faker::Hipster.paragraph(sentence_count: 2, supplemental: false, random_sentences_to_add: 4) #=> "Selvage vhs chartreuse narwhal vinegar. Authentic vinyl truffaut carry vhs pop-up. Hammock everyday iphone locavore thundercats bitters vegan goth. Fashion axe banh mi shoreditch whatever artisan."
+      #   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
+      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
 
-      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
-
+      ##
+      # Produces random hipster paragraphs.
+      #
+      # @param number [Integer] Specifies the number of paragraphs
+      # @param supplemental [Boolean] Specifies if the words are supplemental
+      # @return [Array<String>]
+      #
+      # @example
+      #   Faker::Hipster.paragraphs #=> ["Tilde microdosing blog cliche meggings. Intelligentsia five dollar toast forage yuccie. Master kitsch knausgaard. Try-hard everyday trust fund mumblecore.", "Normcore viral pickled. Listicle humblebrag swag tote bag. Taxidermy street hammock neutra butcher cred kale chips. Blog portland humblebrag trust fund irony.", "Single-origin coffee fixie cleanse tofu xoxo. Post-ironic tote bag ramps gluten-free locavore mumblecore hammock. Umami loko twee. Ugh kitsch before they sold out."]
+      #   Faker::Hipster.paragraphs(number: 1) #=> ["Skateboard cronut synth +1 fashion axe. Pop-up polaroid skateboard asymmetrical. Ennui fingerstache shoreditch before they sold out. Tattooed pitchfork ramps. Photo booth yr messenger bag raw denim bespoke locavore lomo synth."]
+      #   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(number: 3, supplemental: false)
         [].tap do |paragraphs|
           1.upto(resolve(number)) do
             paragraphs << paragraph(sentence_count: 3, supplemental: supplemental)
@@ -80,17 +130,24 @@ module Faker
         end
       end
 
-      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
-
+      ##
+      # Produces a random hipster paragraph by characters.
+      #
+      # @param characters [Integer] Specifies the number of characters in the paragraph
+      # @param supplemental [Boolean] Specifies if the words are supplemental
+      # @return [String]
+      #
+      # @example
+      #   Faker::Hipster.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."
+      #   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(characters: 256, supplemental: false)
         paragraph = paragraph(sentence_count: 3, supplemental: supplemental)
 
-        paragraph += ' ' + paragraph(sentence_count: 3, supplemental: supplemental) while paragraph.length < characters
+        paragraph += " #{paragraph(sentence_count: 3, supplemental: supplemental)}" while paragraph.length < characters
 
-        paragraph[0...characters - 1] + '.'
+        "#{paragraph[0...characters - 1]}."
       end
     end
   end

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