faker 2.11.0 → 3.2.0

data/lib/faker/default/drone.rb

@@ -0,0 +1,332 @@
+# frozen_string_literal: true
+
+module Faker
+  class Drone < Base
+    class << self
+      ##
+      # Returns random drone name with company
+      #
+      # @return [string]
+      #
+      # @example
+      #   Faker::Drone.name #=> "DJI Mavic Air 2"
+      #
+      # @faker.version 2.14.0
+      def name
+        fetch('drone.name')
+      end
+
+      ##
+      # Returns total drone weight in grams
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.weight #=> "570 g"
+      #
+      # @faker.version 2.14.0
+      def weight
+        parse('drone.weight')
+      end
+
+      ##
+      # Returns maximum ascent speed for drone in m/s
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.max_ascent_speed #=> "4 m/s"
+      #
+      # @faker.version 2.14.0
+      def max_ascent_speed
+        parse('drone.max_ascent_speed')
+      end
+
+      ##
+      # Returns maximum descent speed for drone in m/s
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.max_descent_speed #=> "4 m/s"
+      #
+      # @faker.version 2.14.0
+      def max_descent_speed
+        parse('drone.max_descent_speed')
+      end
+
+      ##
+      # Returns max flight time for drone in optimal conditions
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.flight_time #=> "34 min"
+      #
+      # @faker.version 2.14.0
+      def flight_time
+        parse('drone.flight_time')
+      end
+
+      ##
+      # Returns max altitude drone can go above sea level in meters
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.max_altitude #=> "5000 m"
+      #
+      # @faker.version 2.14.0
+      def max_altitude
+        parse('drone.max_altitude')
+      end
+
+      ##
+      # Returns how far drone can go in optimal condition when full charged in meters
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.max_flight_distance #=> "18500 m"
+      #
+      # @faker.version 2.14.0
+      def max_flight_distance
+        parse('drone.max_flight_distance')
+      end
+
+      ##
+      # Returns max horizontal speed by drone in m/s
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.max_speed #=> "19 m/s"
+      #
+      # @faker.version 2.14.0
+      def max_speed
+        parse('drone.max_speed')
+      end
+
+      ##
+      # Returns max wind resistance by drone in m/s
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.max_wind_resistance #=> "10.5 m/s"
+      #
+      # @faker.version 2.14.0
+      def max_wind_resistance
+        parse('drone.max_wind_resistance')
+      end
+
+      ##
+      # Returns max angular velocity of drone in degrees/s
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.max_angular_velocity #=> "250 degree/s"
+      #
+      # @faker.version 2.14.0
+      def max_angular_velocity
+        parse('drone.max_angular_velocity')
+      end
+
+      ##
+      # Returns max tilt angle drone can go in degrees
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.max_tilt_angle #=> "35 degrees"
+      #
+      # @faker.version 2.14.0
+      def max_tilt_angle
+        parse('drone.max_tilt_angle')
+      end
+
+      ##
+      # Returns operating temperature for drone in Fahrenheit
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.operating_temperature #=> "14-104F"
+      #
+      # @faker.version 2.14.0
+      def operating_temperature
+        parse('drone.operating_temperature')
+      end
+
+      ##
+      # Returns the drone battery capacity
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.battery_capacity #=> "3500 mAh"
+      #
+      # @faker.version 2.14.0
+      def battery_capacity
+        parse('drone.battery_capacity')
+      end
+
+      ##
+      # Returns battery voltage
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.battery_voltage #=> "13.2V"
+      #
+      # @faker.version 2.14.0
+      def battery_voltage
+        parse('drone.battery_voltage')
+      end
+
+      ##
+      # Returns the battery type
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.battery_type #=> "LiPo 4S"
+      #
+      # @faker.version 2.14.0
+      def battery_type
+        parse('drone.battery_type')
+      end
+
+      ##
+      # Returns total battery weight in grams
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.battery_weight #=> "198 g"
+      #
+      # @faker.version 2.14.0
+      def battery_weight
+        parse('drone.battery_weight')
+      end
+
+      ##
+      # Returns charging temperature for battery in Fahrenheit
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.charging_temperature #=> "41-104F"
+      #
+      # @faker.version 2.14.0
+      def charging_temperature
+        parse('drone.charging_temperature')
+      end
+
+      ##
+      # Returns max chargin power required for battery
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.max_charging_power #=> "38W"
+      #
+      # @faker.version 2.14.0
+      def max_charging_power
+        parse('drone.max_charging_power')
+      end
+
+      ##
+      # Returns camera ISO range for drone
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.iso #=> "100-3200"
+      #
+      # @faker.version 2.14.0
+      def iso
+        parse('drone.iso')
+      end
+
+      ##
+      # Returns max camera resolution in MP"
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.max_resolution #=> "48MP"
+      #
+      # @faker.version 2.14.0
+      def max_resolution
+        parse('drone.max_resolution')
+      end
+
+      ##
+      # Returns photo format for drone
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.photo_format #=> "JPEG"
+      #
+      # @faker.version 2.14.0
+      def photo_format
+        parse('drone.photo_format')
+      end
+
+      ##
+      # Returns video format
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.video_format #=> "MP4"
+      #
+      # @faker.version 2.14.0
+      def video_format
+        parse('drone.video_format')
+      end
+
+      ##
+      # Returns max and min shutter speed for camera
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.shutter_speed_range #=> "8-1/8000s"
+      #
+      # @faker.version 2.14.0
+      def shutter_speed_range
+        "#{fetch('drone.max_shutter_speed')}-#{fetch('drone.min_shutter_speed')}#{fetch('drone.shutter_speed_units')}"
+      end
+
+      ##
+      # Returns max shutter speed for camera
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.max_shutter_speed #=> "60s"
+      #
+      # @faker.version 2.14.0
+      def max_shutter_speed
+        "#{fetch('drone.max_shutter_speed')}#{fetch('drone.shutter_speed_units')}"
+      end
+
+      ##
+      # Returns min shutter speed for camera
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Drone.min_shutter_speed #=> "1/8000s"
+      #
+      # @faker.version 2.14.0
+      def min_shutter_speed
+        "#{fetch('drone.min_shutter_speed')}#{fetch('drone.shutter_speed_units')}"
+      end
+    end
+  end
+end

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