faker 2.2.2 → 2.7.0

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

@@ -52,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/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}!",

data/lib/faker/default/house.rb

@@ -3,10 +3,28 @@
 module Faker
   class House < Base
     class << self
+      ##
+      # Produces the name of a piece of furniture.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::House.furniture #=> "chair"
+      #
+      # @faker.version 1.9.2
       def furniture
         fetch('house.furniture')
       end
 
+      ##
+      # Produces the name of a room in a house.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::House.room #=> "kitchen"
+      #
+      # @faker.version 1.9.2
       def room
         fetch('house.rooms')
       end

data/lib/faker/default/id_number.rb

@@ -16,6 +16,8 @@ module Faker
     BRAZILIAN_ID_FROM = 10_000_000
     BRAZILIAN_ID_TO = 99_999_999
 
+    CHILEAN_MODULO = 11
+
     class << self
       def valid
         _translate('valid')
@@ -105,8 +107,35 @@ module Faker
 
       alias brazilian_rg brazilian_id
 
+      def chilean_id
+        digits = Faker::Number.number(digits: 8)
+        verification_code = chilean_verification_code(digits)
+
+        digits.to_s + '-' + verification_code.to_s
+      end
+
       private
 
+      def chilean_verification_code(digits)
+        # First digit is multiplied by 3, second by 2, and so on
+        multiplication_rule = [3, 2, 7, 6, 5, 4, 3, 2]
+        digits_splitted = digits.to_s.chars.map(&:to_i)
+
+        sum = digits_splitted.map.with_index { |digit, index| digit * multiplication_rule[index] }.reduce(:+)
+
+        modulo = sum.modulo(CHILEAN_MODULO)
+        difference = CHILEAN_MODULO - modulo
+
+        case difference
+        when 0..9
+          difference
+        when 10
+          'K'
+        when 11
+          0
+        end
+      end
+
       def south_african_id_checksum_digit(id_number)
         value_parts = id_number.chars
         even_digits = value_parts

data/lib/faker/default/industry_segments.rb

@@ -5,18 +5,54 @@ module Faker
     flexible :industry_segments
 
     class << self
+      ##
+      # Produces the name of an industry.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::IndustrySegments.industry #=> "Basic Materials"
+      #
+      # @faker.version 1.9.2
       def industry
         fetch('industry_segments.industry')
       end
 
+      ##
+      # Produces the name of a super-sector of an industry.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::IndustrySegments.super_sector #=> "Basic Resources"
+      #
+      # @faker.version 1.9.2
       def super_sector
         fetch('industry_segments.super_sector')
       end
 
+      ##
+      # Produces the name of a sector of an industry.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::IndustrySegments.sector #=> "Industrial Metals & Mining"
+      #
+      # @faker.version 1.9.2
       def sector
         fetch('industry_segments.sector')
       end
 
+      ##
+      # Produces the name of a subsector of an industry.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::IndustrySegments.industry #=> "Basic Materials"
+      #
+      # @faker.version 1.9.2
       def sub_sector
         fetch('industry_segments.sub_sector')
       end