faker 2.2.0 → 2.6.0

data/lib/faker/default/demographic.rb

@@ -24,9 +24,8 @@ module Faker
       end
 
       def height(legacy_unit = NOT_GIVEN, unit: :metric)
-        if legacy_unit != NOT_GIVEN
-          warn_with_uplevel 'Passing `unit` with the 1st argument of `Demographic.height` is deprecated. Use keyword argument like `Demographic.height(unit: ...)` instead.', uplevel: 1
-          unit = legacy_unit
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :unit if legacy_unit != NOT_GIVEN
         end
 
         case unit

data/lib/faker/default/dessert.rb

@@ -5,14 +5,41 @@ module Faker
     flexible :dessert
 
     class << self
+      ##
+      # Produces the name of a dessert variety.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Dessert.variety #=> "Cake"
+      #
+      # @faker.version 1.8.0
       def variety
         fetch('dessert.variety')
       end
 
+      ##
+      # Produces the name of a dessert topping.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Dessert.topping #=> "Gummy Bears"
+      #
+      # @faker.version 1.8.0
       def topping
         fetch('dessert.topping')
       end
 
+      ##
+      # Produces the name of a dessert flavor.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Dessert.flavor #=> "Salted Caramel"
+      #
+      # @faker.version 1.8.0
       def flavor
         fetch('dessert.flavor')
       end

data/lib/faker/default/device.rb

@@ -3,26 +3,80 @@
 module Faker
   class Device < Base
     class << self
+      ##
+      # Produces a build number between 1 and 500.
+      #
+      # @return [Integer]
+      #
+      # @example
+      #   Faker::Device.build_number #=> 5
+      #
+      # @faker.version 1.9.0
       def build_number
         Faker::Number.between(from: 1, to: 500)
       end
 
+      ##
+      # Produces the name of a manufacturer for a device.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Device.manufacturer #=> "Apple"
+      #
+      # @faker.version 1.9.0
       def manufacturer
         fetch('device.manufacturer')
       end
 
+      ##
+      # Produces a model name for a device.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Device.model_name #=> "iPhone 4"
+      #
+      # @faker.version 1.9.0
       def model_name
         fetch('device.model_name')
       end
 
+      ##
+      # Produces the name of a platform for a device.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Device.platform #=> "webOS"
+      #
+      # @faker.version 1.9.0
       def platform
         fetch('device.platform')
       end
 
+      ##
+      # Produces a serial code for a device.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Device.serial #=> "ejfjnRNInxh0363JC2WM"
+      #
+      # @faker.version 1.9.0
       def serial
         fetch('device.serial')
       end
 
+      ##
+      # Produces a version number between 1 and 1000.
+      #
+      # @return [Integer]
+      #
+      # @example
+      #   Faker::Device.version #=> 42
+      #
+      # @faker.version 1.9.0
       def version
         Faker::Number.between(from: 1, to: 1000)
       end

data/lib/faker/default/driving_licence.rb

@@ -9,21 +9,11 @@ module Faker
       # rubocop:disable Metrics/ParameterLists
       def british_driving_licence(legacy_last_name = NOT_GIVEN, legacy_initials = NOT_GIVEN, legacy_gender = NOT_GIVEN, legacy_date_of_birth = NOT_GIVEN, last_name: Faker::Name.last_name, initials: Faker::Name.initials, gender: random_gender, date_of_birth: Faker::Date.birthday(min_age: 18, max_age: 65))
         # rubocop:enable Metrics/ParameterLists
-        if legacy_last_name != NOT_GIVEN
-          warn_with_uplevel 'Passing `last_name` with the 1st argument of `DrivingLicence.british_driving_licence` is deprecated. Use keyword argument like `DrivingLicence.british_driving_licence(last_name: ...)` instead.', uplevel: 1
-          last_name = legacy_last_name
-        end
-        if legacy_initials != NOT_GIVEN
-          warn_with_uplevel 'Passing `initials` with the 2nd argument of `DrivingLicence.british_driving_licence` is deprecated. Use keyword argument like `DrivingLicence.british_driving_licence(initials: ...)` instead.', uplevel: 1
-          initials = legacy_initials
-        end
-        if legacy_gender != NOT_GIVEN
-          warn_with_uplevel 'Passing `gender` with the 3rd argument of `DrivingLicence.british_driving_licence` is deprecated. Use keyword argument like `DrivingLicence.british_driving_licence(gender: ...)` instead.', uplevel: 1
-          gender = legacy_gender
-        end
-        if legacy_date_of_birth != NOT_GIVEN
-          warn_with_uplevel 'Passing `date_of_birth` with the 4th argument of `DrivingLicence.british_driving_licence` is deprecated. Use keyword argument like `DrivingLicence.british_driving_licence(date_of_birth: ...)` instead.', uplevel: 1
-          date_of_birth = legacy_date_of_birth
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :last_name if legacy_last_name != NOT_GIVEN
+          keywords << :initials if legacy_initials != NOT_GIVEN
+          keywords << :gender if legacy_gender != NOT_GIVEN
+          keywords << :date_of_birth if legacy_date_of_birth != NOT_GIVEN
         end
 
         [
@@ -62,9 +52,9 @@ module Faker
         year = dob.year % 10
         month = gender == :female ? dob.month + 50 : dob.month
         # Rubocop's preferred formatting is pretty gory
-        # rubocop:disable FormatString
+        # rubocop:disable Style/FormatString
         "#{decade}#{'%02d' % month}#{'%02d' % dob.day}#{year}"
-        # rubocop:enable FormatString
+        # rubocop:enable Style/FormatString
       end
 
       def gb_licence_checksum

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

@@ -6,17 +6,10 @@ module Faker
       # 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
+        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
@@ -38,21 +31,11 @@ module Faker
       # 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
+        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)

data/lib/faker/default/fillmurray.rb

@@ -6,17 +6,10 @@ module Faker
       # rubocop:disable Metrics/ParameterLists
       def image(legacy_grayscale = NOT_GIVEN, legacy_width = NOT_GIVEN, legacy_height = NOT_GIVEN, grayscale: false, width: 200, height: 200)
         # rubocop:enable Metrics/ParameterLists
-        if legacy_grayscale != NOT_GIVEN
-          warn_with_uplevel 'Passing `grayscale` with the 1st argument of `Fillmurray.image` is deprecated. Use keyword argument like `Fillmurray.image(grayscale: ...)` instead.', uplevel: 1
-          grayscale = legacy_grayscale
-        end
-        if legacy_width != NOT_GIVEN
-          warn_with_uplevel 'Passing `width` with the 2nd argument of `Fillmurray.image` is deprecated. Use keyword argument like `Fillmurray.image(width: ...)` instead.', uplevel: 1
-          width = legacy_width
-        end
-        if legacy_height != NOT_GIVEN
-          warn_with_uplevel 'Passing `height` with the 3rd argument of `Fillmurray.image` is deprecated. Use keyword argument like `Fillmurray.image(height: ...)` instead.', uplevel: 1
-          height = legacy_height
+        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+$/

data/lib/faker/default/finance.rb

@@ -27,9 +27,8 @@ module Faker
       end
 
       def vat_number(legacy_country = NOT_GIVEN, country: 'BR')
-        if legacy_country != NOT_GIVEN
-          warn_with_uplevel 'Passing `country` with the 1st argument of `Finance.vat_number` is deprecated. Use keyword argument like `Finance.vat_number(country: ...)` instead.', uplevel: 1
-          country = legacy_country
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :country if legacy_country != NOT_GIVEN
         end
 
         numerify(fetch("finance.vat_number.#{country}"))

data/lib/faker/default/gender.rb

@@ -3,10 +3,28 @@
 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

data/lib/faker/default/greek_philosophers.rb

@@ -3,10 +3,28 @@
 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

data/lib/faker/default/hacker.rb

@@ -1,35 +1,93 @@
 # frozen_string_literal: true
 
-# Port of http://shinytoylabs.com/jargon/
 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}!",