faker 1.1.2 → 3.2.0

data/lib/faker/default/finance.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Faker
+  class Finance < Base
+    CREDIT_CARD_TYPES = %i[visa mastercard discover american_express
+                           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)
+        template = numerify(fetch("finance.credit_card.#{type}"))
+
+        # calculate the luhn checksum digit
+        multiplier = 1
+        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.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
+        # last digit must be 10 - the last digit of the sum.
+        luhn_digit = (10 - (luhn_sum % 10)) % 10
+
+        template.gsub('L', luhn_digit.to_s)
+      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}"
+      end
+
+      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

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module Faker
+  class Food < Base
+    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.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Food.dish #=> "Feijoada"
+      #
+      # @faker.version 1.8.0
+      def dish
+        fetch('food.dish')
+      end
+
+      ##
+      # Retrieves a description about some dish
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Food.description #=> "Breaded fried chicken with waffles. Served with maple syrup."
+      #
+      # @faker.version 1.9.0
+      def description
+        fetch('food.descriptions')
+      end
+
+      ##
+      # Retrieves an ingredient
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Food.ingredient #=> "Olives"
+      #
+      # @faker.version 1.7.0
+      def ingredient
+        fetch('food.ingredients')
+      end
+
+      ##
+      # Retrieves a fruit
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Food.fruits #=> "Papaya"
+      #
+      # @faker.version 1.9.0
+      def fruits
+        fetch('food.fruits')
+      end
+
+      ##
+      # Retrieves a vegetable
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Food.vegetables #=> "Broccolini"
+      #
+      # @faker.version 1.9.0
+      def vegetables
+        fetch('food.vegetables')
+      end
+
+      ##
+      # Retrieves some random spice
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Food.spice #=> "Garlic Chips"
+      #
+      # @faker.version 1.7.0
+      def spice
+        fetch('food.spices')
+      end
+
+      ##
+      # Retrieves cooking measures
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Food.measurement #=> "1/3"
+      #
+      # @faker.version 1.7.0
+      def measurement
+        "#{fetch('food.measurement_sizes')} #{fetch('food.measurements')}"
+      end
+
+      ##
+      # Retrieves metric measurements
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Food.metric_measurement #=> "centiliter"
+      #
+      # @faker.version 1.8.3
+      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/funny_name.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Faker
+  class FunnyName < Base
+    flexible :funny_name
+
+    class << self
+      ##
+      # Retrieves a funny name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::FunnyName.name #=> "Sam Pull"
+      #
+      # @faker.version 1.8.0
+      def name
+        fetch('funny_name.name')
+      end
+
+      ##
+      # Retrieves a funny two word name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::FunnyName.two_word_name #=> "Shirley Knot"
+      #
+      # @faker.version 1.8.0
+      def two_word_name
+        two_word_names = fetch_all('funny_name.name').select do |name|
+          name.count(' ') == 1
+        end
+
+        sample(two_word_names)
+      end
+
+      ##
+      # Retrieves a funny three word name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::FunnyName.three_word_name #=> "Carson O. Gin"
+      #
+      # @faker.version 1.8.0
+      def three_word_name
+        three_word_names = fetch_all('funny_name.name').select do |name|
+          name.count(' ') == 2
+        end
+
+        sample(three_word_names)
+      end
+
+      ##
+      # Retrieves a funny four word name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::FunnyName.four_word_name #=> "Maude L. T. Ford"
+      #
+      # @faker.version 1.8.0
+      def four_word_name
+        four_word_names = fetch_all('funny_name.name').select do |name|
+          name.count(' ') == 3
+        end
+
+        sample(four_word_names)
+      end
+
+      ##
+      # Retrieves a funny name with an initial.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::FunnyName.name_with_initial #=> "Heather N. Yonn"
+      #
+      # @faker.version 1.8.0
+      def name_with_initial
+        names_with_initials = fetch_all('funny_name.name').select do |name|
+          name.count('.').positive?
+        end
+
+        sample(names_with_initials)
+      end
+    end
+  end
+end

data/lib/faker/default/gender.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Faker
+  class Gender < Base
+    class << self
+      ##
+      # Produces the name of a gender identity.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Gender.type #=> "Non-binary"
+      #
+      # @faker.version 1.9.0
+      def type
+        fetch('gender.types')
+      end
+
+      ##
+      # Produces either 'Male' or 'Female'.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Gender.binary_type #=> "Female"
+      #
+      # @faker.version 1.9.0
+      def binary_type
+        fetch('gender.binary_types')
+      end
+
+      ##
+      # Produces either 'f' or 'm'.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Gender.short_binary_type #=> "f"
+      #
+      # @faker.version 2.13.0
+      def short_binary_type
+        fetch('gender.short_binary_types')
+      end
+    end
+  end
+end

data/lib/faker/default/greek_philosophers.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Faker
+  class GreekPhilosophers < Base
+    class << self
+      ##
+      # Produces the name of a Greek philosopher.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::GreekPhilosophers.name #=> "Socrates"
+      #
+      # @faker.version 1.9.0
+      def name
+        fetch('greek_philosophers.names')
+      end
+
+      ##
+      # Produces a quote from a Greek philosopher.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::GreekPhilosophers.quote #=> "Only the educated are free."
+      #
+      # @faker.version 1.9.0
+      def quote
+        fetch('greek_philosophers.quotes')
+      end
+    end
+  end
+end

data/lib/faker/default/hacker.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module Faker
+  # Port of http://shinytoylabs.com/jargon/
+  # Are you having trouble writing tech-savvy dialogue for your latest screenplay?
+  # Worry not! Hollywood-grade technical talk is ready to fill out any form where you need to look smart.
+  class Hacker < Base
+    flexible :hacker
+
+    class << self
+      ##
+      # Produces something smart.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Hacker.say_something_smart
+      #     #=> "Try to compress the SQL interface, maybe it will program the back-end hard drive!"
+      #
+      # @faker.version 1.4.0
+      def say_something_smart
+        sample(phrases)
+      end
+
+      ##
+      # Short technical abbreviations.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Hacker.abbreviation #=> "RAM"
+      #
+      # @faker.version 1.4.0
+      def abbreviation
+        fetch('hacker.abbreviation')
+      end
+
+      ##
+      # Hacker-centric adjectives.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Hacker.adjective #=> "open-source"
+      #
+      # @faker.version 1.4.0
+      def adjective
+        fetch('hacker.adjective')
+      end
+
+      ##
+      # Only the best hacker-related nouns.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Hacker.noun #=> "bandwidth"
+      #
+      # @faker.version 1.4.0
+      def noun
+        fetch('hacker.noun')
+      end
+
+      ##
+      # Actions that hackers take.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Hacker.verb #=> "bypass"
+      #
+      # @faker.version 1.4.0
+      def verb
+        fetch('hacker.verb')
+      end
+
+      ##
+      # Produces a verb that ends with '-ing'.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Hacker.ingverb #=> "synthesizing"
+      #
+      # @faker.version 1.4.0
+      def ingverb
+        fetch('hacker.ingverb')
+      end
+
+      # @private
+      def phrases
+        ["If we #{verb} the #{noun}, we can get to the #{abbreviation} #{noun} through the #{adjective} #{abbreviation} #{noun}!",
+         "We need to #{verb} the #{adjective} #{abbreviation} #{noun}!",
+         "Try to #{verb} the #{abbreviation} #{noun}, maybe it will #{verb} the #{adjective} #{noun}!",
+         "You can't #{verb} the #{noun} without #{ingverb} the #{adjective} #{abbreviation} #{noun}!",
+         "Use the #{adjective} #{abbreviation} #{noun}, then you can #{verb} the #{adjective} #{noun}!",
+         "The #{abbreviation} #{noun} is down, #{verb} the #{adjective} #{noun} so we can #{verb} the #{abbreviation} #{noun}!",
+         "#{ingverb} the #{noun} won't do anything, we need to #{verb} the #{adjective} #{abbreviation} #{noun}!".capitalize,
+         "I'll #{verb} the #{adjective} #{abbreviation} #{noun}, that should #{noun} the #{abbreviation} #{noun}!"]
+      end
+    end
+  end
+end

data/lib/faker/default/hipster.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+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
+
+      ##
+      # 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)
+
+        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
+
+      ##
+      # 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
+
+      ##
+      # 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)
+          end
+        end
+      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
+
+      ##
+      # 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)
+          end
+        end
+      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[0...characters - 1]}."
+      end
+    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