faker 2.2.0 → 3.2.2

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

@@ -5,30 +5,97 @@ module Faker
     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.name')} #{fetch('educator.tertiary.type')}"
+        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
-        "#{fetch('educator.tertiary.degree.type')} #{fetch('educator.tertiary.degree.subject')}"
+        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.tertiary.degree.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
-        "#{fetch('educator.tertiary.degree.subject')} #{numerify(fetch('educator.tertiary.degree.course_number'))}"
+        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.name')} #{fetch('educator.secondary')}"
+        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.name')} Campus"
+        parse('educator.campus')
       end
     end
   end

data/lib/faker/default/electrical_components.rb

@@ -5,14 +5,41 @@ module Faker
     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

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/esport.rb

@@ -3,22 +3,67 @@
 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

data/lib/faker/default/file.rb

@@ -3,22 +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: '/')
-        # rubocop:enable Metrics/ParameterLists
-        if legacy_segment_count != NOT_GIVEN
-          warn_with_uplevel 'Passing `segment_count` with the 1st argument of `File.dir` is deprecated. Use keyword argument like `File.dir(segment_count: ...)` instead.', uplevel: 1
-          segment_count = legacy_segment_count
-        end
-        if legacy_root != NOT_GIVEN
-          warn_with_uplevel 'Passing `root` with the 2nd argument of `File.dir` is deprecated. Use keyword argument like `File.dir(root: ...)` instead.', uplevel: 1
-          root = legacy_root
-        end
-        if legacy_directory_separator != NOT_GIVEN
-          warn_with_uplevel 'Passing `directory_separator` with the 3rd argument of `File.dir` is deprecated. Use keyword argument like `File.dir(directory_separator: ...)` instead.', uplevel: 1
-          directory_separator = legacy_directory_separator
-        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)
@@ -27,34 +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: '/')
-        # rubocop:enable Metrics/ParameterLists
-        if legacy_dir != NOT_GIVEN
-          warn_with_uplevel 'Passing `dir` with the 1st argument of `File.file_name` is deprecated. Use keyword argument like `File.file_name(dir: ...)` instead.', uplevel: 1
-          dir = legacy_dir
-        end
-        if legacy_name != NOT_GIVEN
-          warn_with_uplevel 'Passing `name` with the 2nd argument of `File.file_name` is deprecated. Use keyword argument like `File.file_name(name: ...)` instead.', uplevel: 1
-          name = legacy_name
-        end
-        if legacy_ext != NOT_GIVEN
-          warn_with_uplevel 'Passing `ext` with the 3rd argument of `File.file_name` is deprecated. Use keyword argument like `File.file_name(ext: ...)` instead.', uplevel: 1
-          ext = legacy_ext
-        end
-        if legacy_directory_separator != NOT_GIVEN
-          warn_with_uplevel 'Passing `directory_separator` with the 4th argument of `File.file_name` is deprecated. Use keyword argument like `File.file_name(directory_separator: ...)` instead.', uplevel: 1
-          directory_separator = legacy_directory_separator
-        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