faker 1.8.7 → 2.17.0

data/lib/faker/default/educator.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Faker
+  class Educator < Base
+    flexible :educator
+
+    class << self
+      ##
+      # Produces a university name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Educator.university #=> "Mallowtown Technical College"
+      #
+      # @faker.version 1.6.4
+      def university
+        parse('educator.university')
+      end
+
+      ##
+      # Produces a university degree.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Educator.degree #=> "Associate Degree in Criminology"
+      #
+      # @faker.version 1.9.2
+      def degree
+        parse('educator.degree')
+      end
+
+      alias course degree
+
+      ##
+      # Produces a university subject.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Educator.subject #=> "Criminology"
+      #
+      # @faker.version 1.9.2
+      def subject
+        fetch('educator.subject')
+      end
+
+      ##
+      # Produces a course name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Educator.course_name #=> "Criminology 101"
+      #
+      # @faker.version 1.9.2
+      def course_name
+        numerify(parse('educator.course_name'))
+      end
+
+      ##
+      # Produces a secondary school.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Educator.secondary_school #=> "Iceborough Secondary College"
+      #
+      # @faker.version 1.6.4
+      def secondary_school
+        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.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Educator.campus #=> "Vertapple Campus"
+      #
+      # @faker.version 1.6.4
+      def campus
+        parse('educator.campus')
+      end
+    end
+  end
+end

data/lib/faker/default/electrical_components.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Faker
+  class ElectricalComponents < Base
+    flexible :electrical_components
+
+    class << self
+      ##
+      # Produces an active electrical component.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::ElectricalComponents.active #=> "Transistor"
+      #
+      # @faker.version 1.9.0
+      def active
+        fetch('electrical_components.active')
+      end
+
+      ##
+      # Produces a passive electrical component.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::ElectricalComponents.passive #=> "Resistor"
+      #
+      # @faker.version 1.9.0
+      def passive
+        fetch('electrical_components.passive')
+      end
+
+      ##
+      # Produces an electromechanical electrical component.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::ElectricalComponents.electromechanical #=> "Toggle Switch"
+      #
+      # @faker.version 1.9.0
+      def electromechanical
+        fetch('electrical_components.electromechanical')
+      end
+    end
+  end
+end

data/lib/faker/default/esport.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Faker
+  class Esport < Base
+    class << self
+      ##
+      # Produces the name of a professional eSports player.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Esport.player #=> "Crimsix"
+      #
+      # @faker.version 1.7.0
+      def player
+        fetch('esport.players')
+      end
+
+      ##
+      # Produces the name of an eSports team.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Esport.team #=> "CLG"
+      #
+      # @faker.version 1.7.0
+      def team
+        fetch('esport.teams')
+      end
+
+      ##
+      # Produces the name of an eSports league.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Esport.league #=> "IEM"
+      #
+      # @faker.version 1.7.0
+      def league
+        fetch('esport.leagues')
+      end
+
+      ##
+      # Produces the name of an eSports event.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Esport.event #=> "ESL Cologne"
+      #
+      # @faker.version 1.7.0
+      def event
+        fetch('esport.events')
+      end
+
+      ##
+      # Produces the name of a game played as an eSport.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Esport.game #=> "Dota 2"
+      #
+      # @faker.version 1.7.0
+      def game
+        fetch('esport.games')
+      end
+    end
+  end
+end

data/lib/faker/default/faker_adjective.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Faker
+  class Adjective < Base
+    flexible :adjective
+
+    class << self
+      ##
+      # Produces a positive adjective.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Adjective.positive #=> "Kind"
+      #
+      # @faker.version next
+      def positive
+        fetch('adjective.positive')
+      end
+
+      ##
+      # Produces a negative adjective.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Adjective.negative #=> "Creepy"
+      #
+      # @faker.version next
+      def negative
+        fetch('adjective.negative')
+      end
+    end
+  end
+end

data/lib/faker/default/file.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Faker
+  class File < Base
+    class << self
+      # rubocop:disable Metrics/ParameterLists
+
+      ##
+      # 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(legacy_segment_count = NOT_GIVEN, legacy_root = NOT_GIVEN, legacy_directory_separator = NOT_GIVEN, segment_count: 3, root: nil, directory_separator: ::File::Separator)
+        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
+
+        Array
+          .new(segment_count) { Faker::Internet.slug }
+          .unshift(root)
+          .compact
+          .join(directory_separator)
+          .squeeze(directory_separator)
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      ##
+      # Produces a random file extension.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::File.extension #=> "mp3"
+      #
+      # @faker.version 1.6.4
+      def extension
+        fetch('file.extension')
+      end
+
+      ##
+      # Produces a random mime type.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::File.mime_type #=> "application/pdf"
+      #
+      # @faker.version 1.6.4
+      def mime_type
+        fetch('file.mime_type')
+      end
+
+      # rubocop:disable Metrics/ParameterLists
+
+      ##
+      # 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(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)
+        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
+
+        dir ||= dir(segment_count: 1)
+        name ||= Faker::Lorem.word.downcase
+        ext ||= extension
+
+        [dir, name].join(directory_separator) + ".#{ext}"
+      end
+      # rubocop:enable Metrics/ParameterLists
+    end
+  end
+end

data/lib/faker/default/fillmurray.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Faker
+  class Fillmurray < Base
+    class << self
+      # rubocop:disable Metrics/ParameterLists
+
+      ##
+      # Produces the URL of an image from Fill Murray, a site which hosts
+      # exclusively photographs of actor Bill Murray.
+      #
+      # @param grayscale [Boolean] Whether to return a grayscale image.
+      # @param width [Integer] The iamage width.
+      # @param height [Integer] The image height.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Fillmurray.image #=> "https://www.fillmurray.com/300/300"
+      #
+      # @example
+      #   Faker::Fillmurray.image(grayscale: true)
+      #     #=> "https://fillmurray.com/g/300/300"
+      #
+      # @example
+      #   Faker::Fillmurray.image(grayscale: false, width: 200, height: 400)
+      #     #=> "https://fillmurray.com/200/400"
+      #
+      # @faker.version 1.7.1
+      def image(legacy_grayscale = NOT_GIVEN, legacy_width = NOT_GIVEN, legacy_height = NOT_GIVEN, grayscale: false, width: 200, height: 200)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :grayscale if legacy_grayscale != NOT_GIVEN
+          keywords << :width if legacy_width != NOT_GIVEN
+          keywords << :height if legacy_height != NOT_GIVEN
+        end
+
+        raise ArgumentError, 'Width should be a number' unless width.to_s =~ /^\d+$/
+        raise ArgumentError, 'Height should be a number' unless height.to_s =~ /^\d+$/
+        raise ArgumentError, 'Grayscale should be a boolean' unless [true, false].include?(grayscale)
+
+        "https://www.fillmurray.com#{'/g' if grayscale == true}/#{width}/#{height}"
+      end
+      # rubocop:enable Metrics/ParameterLists
+    end
+  end
+end

data/lib/faker/default/finance.rb

@@ -0,0 +1,89 @@
+# 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]/, '').split('').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 }
+        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(legacy_country = NOT_GIVEN, country: 'BR')
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :country if legacy_country != NOT_GIVEN
+        end
+
+        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
+    end
+  end
+end