faker 2.2.0 → 3.2.2

data/lib/faker/default/blood.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Faker
+  class Blood < Base
+    flexible :blood
+
+    class << self
+      ##
+      # Produces a random blood type.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Blood.type #=> "AB"
+      #
+      # @faker.version 2.13.0
+      def type
+        fetch('blood.type')
+      end
+
+      ##
+      # Produces a random blood RH-Factor.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Blood.rh_factor #=> "-"
+      #
+      # @faker.version 2.13.0
+      def rh_factor
+        fetch('blood.rh_factor')
+      end
+
+      ##
+      # Produces a random blood group name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Blood.group #=> "AB-"
+      #
+      # @faker.version 2.13.0
+      def group
+        parse('blood.group')
+      end
+    end
+  end
+end

data/lib/faker/default/boolean.rb

@@ -3,12 +3,19 @@
 module Faker
   class Boolean < Base
     class << self
-      def boolean(legacy_true_ratio = NOT_GIVEN, true_ratio: 0.5)
-        if legacy_true_ratio != NOT_GIVEN
-          warn_with_uplevel 'Passing `true_ratio` with the 1st argument of `Boolean.boolean` is deprecated. Use keyword argument like `Boolean.boolean(true_ratio: ...)` instead.', uplevel: 1
-          true_ratio = legacy_true_ratio
-        end
-
+      ##
+      # Produces a boolean
+      #
+      # @param true_ratio [Float] The likelihood (as a float, out of 1.0) for the method to return `true`.
+      # @return [Boolean]
+      #
+      # @example
+      #   Faker::Boolean.boolean #=> true
+      # @example
+      #   Faker::Boolean.boolean(true_ratio: 0.2) #=> false
+      #
+      # @faker.version 1.6.2
+      def boolean(true_ratio: 0.5)
         (rand < true_ratio)
       end
     end

data/lib/faker/default/bossa_nova.rb

@@ -3,10 +3,28 @@
 module Faker
   class BossaNova < Base
     class << self
+      ##
+      # Produces the name of a bossa nova artist.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::BossaNova.artist #=> "Tom Jobin"
+      #
+      # @faker.version 1.8.3
       def artist
         fetch('bossa_nova.artists')
       end
 
+      ##
+      # Produces a bossa nova song.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::BossaNova.song #=> "Chega de Saudade"
+      #
+      # @faker.version 1.8.3
       def song
         fetch('bossa_nova.songs')
       end

data/lib/faker/default/business.rb

@@ -7,14 +7,41 @@ module Faker
     flexible :business
 
     class << self
+      ##
+      # Produces a credit card number.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Business.credit_card_number #=> "1228-1221-1221-1431"
+      #
+      # @faker.version 1.2.0
       def credit_card_number
         fetch('business.credit_card_numbers')
       end
 
+      ##
+      # Produces a credit card expiration date.
+      #
+      # @return [Date]
+      #
+      # @example
+      #   Faker::Business.credit_card_expiry_date #=> <Date: 2015-11-11 ((2457338j,0s,0n),+0s,2299161j)>
+      #
+      # @faker.version 1.2.0
       def credit_card_expiry_date
         ::Date.today + (365 * rand(1..4))
       end
 
+      ##
+      # Produces a type of credit card.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Business.credit_card_type #=> "visa"
+      #
+      # @faker.version 1.2.0
       def credit_card_type
         fetch('business.credit_card_types')
       end

data/lib/faker/default/camera.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Faker
+  class Camera < Base
+    class << self
+      ##
+      # Produces a brand of a camera
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Camera.brand #=> "Canon"
+      #
+      # @faker.version next
+      def brand
+        fetch('camera.brand')
+      end
+
+      ##
+      # Produces a model of camera
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Camera.model #=> "450D"
+      #
+      # @faker.version next
+      def model
+        fetch('camera.model')
+      end
+
+      ##
+      # Produces a brand with model
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Camera.brand_with_model #=> "Canon 450D"
+      #
+      # @faker.version next
+      def brand_with_model
+        fetch('camera.brand_with_model')
+      end
+    end
+  end
+end

data/lib/faker/default/cannabis.rb

@@ -2,42 +2,132 @@
 
 module Faker
   class Cannabis < Base
+    ##
+    # Produces a random strain.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::Cannabis.strain #=> "Super Glue"
+    #
+    # @faker.version 1.9.1
     def self.strain
       fetch('cannabis.strains')
     end
 
+    ##
+    # Produces a random abbreviation.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::Cannabis.cannabinoid_abbreviation #=> "CBGa"
+    #
+    # @faker.version 1.9.1
     def self.cannabinoid_abbreviation
       fetch('cannabis.cannabinoid_abbreviations')
     end
 
+    ##
+    # Produces a random cannabinoid type.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::Cannabis.cannabinoid #=> "Cannabinolic Acid"
+    #
+    # @faker.version 1.9.1
     def self.cannabinoid
       fetch('cannabis.cannabinoids')
     end
 
+    ##
+    # Produces a random terpene type.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::Cannabis.terpene #=> "Terpinene"
+    #
+    # @faker.version 1.9.1
     def self.terpene
       fetch('cannabis.terpenes')
     end
 
+    ##
+    # Produces a random kind of medical use.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::Cannabis.medical_use #=> "anti-cancer"
+    #
+    # @faker.version 1.9.1
     def self.medical_use
       fetch('cannabis.medical_uses')
     end
 
+    ##
+    # Produces a random health benefit.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::Cannabis.health_benefit #=> "prevents infection"
+    #
+    # @faker.version 1.9.1
     def self.health_benefit
       fetch('cannabis.health_benefits')
     end
 
+    ##
+    # Produces a random category.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::Cannabis.category #=> "crystalline"
+    #
+    # @faker.version 1.9.1
     def self.category
       fetch('cannabis.categories')
     end
 
+    ##
+    # Produces a random type.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::Cannabis.type #=> "indica"
+    #
+    # @faker.version 1.9.1
     def self.type
       fetch('cannabis.types')
     end
 
+    ##
+    # Produces a random buzzword.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::Cannabis.buzzword #=> "high"
+    #
+    # @faker.version 1.9.1
     def self.buzzword
       fetch('cannabis.buzzwords')
     end
 
+    ##
+    # Produces a random brand.
+    #
+    # @return [String]
+    #
+    # @example
+    #   Faker::Cannabis.brand #=> "Cannavore Confections"
+    #
+    # @faker.version 1.9.1
     def self.brand
       fetch('cannabis.brands')
     end

data/lib/faker/default/chile_rut.rb

@@ -5,22 +5,35 @@ module Faker
     class << self
       @last_rut = nil
 
-      # Fixed param added for testing a specific RUT and check digit combination.
-      def rut(legacy_min_rut = NOT_GIVEN, legacy_fixed = NOT_GIVEN, min_rut: 1, fixed: false)
-        if legacy_min_rut != NOT_GIVEN
-          warn_with_uplevel 'Passing `min_rut` with the 1st argument of `ChileRut.rut` is deprecated. Use keyword argument like `ChileRut.rut(min_rut: ...)` instead.', uplevel: 1
-          min_rut = legacy_min_rut
-        end
-        if legacy_fixed != NOT_GIVEN
-          warn_with_uplevel 'Passing `fixed` with the 2nd argument of `ChileRut.rut` is deprecated. Use keyword argument like `ChileRut.rut(fixed: ...)` instead.', uplevel: 1
-          fixed = legacy_fixed
-        end
-
-        @last_rut = fixed ? min_rut : rand_in_range(min_rut, 99_999_999)
+      ##
+      # Produces a random Chilean RUT (Rol Unico Tributario, ID with 8 digits).
+      #
+      # @param min_rut [Integer] Specifies the minimum value of the RUT.
+      # @param max_rut [Integer] Specifies the maximum value of the RUT.
+      # @param fixed [Boolean] Determines if the RUT is fixed (returns the min_rut value).
+      # @return [Number]
+      #
+      # @example
+      #   Faker::ChileRut.rut #=> 11235813
+      #   Faker::ChileRut.rut(min_rut: 10_000_000, max_rut: 30_000_000) #=> 21853211
+      #   Faker::ChileRut.rut(min_rut: 20_890_156, fixed: true) #=> 20890156
+      #
+      # @faker.version next
+      def rut(min_rut: 1, max_rut: 99_999_999, fixed: false)
+        @last_rut = fixed ? min_rut : rand_in_range(min_rut, max_rut)
       end
 
+      ##
+      # Produces a random Chilean digito verificador (check-digit).
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::ChileRut.dv #=> "k"
+      #
+      # @faker.version 1.9.2
       def dv
-        split_reversed_rut = @last_rut.to_s.reverse.split('')
+        split_reversed_rut = @last_rut.to_s.reverse.chars
         seq = [2, 3, 4, 5, 6, 7]
         i = 0
         digit_sum = split_reversed_rut.reduce(0) do |sum, n|
@@ -29,34 +42,57 @@ module Faker
           partial_result
         end
         partial_check_digit = 11 - (digit_sum % 11)
-        if partial_check_digit == 11
+        case partial_check_digit
+        when 11
           '0'
-        elsif partial_check_digit == 10
+        when 10
           'k'
         else
           partial_check_digit.to_s
         end
       end
 
+      ##
+      # Produces a random Chilean digito verificador (check-digit).
       # Alias for english speaking devs.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::ChileRut.check_digit #=> "5"
+      #
+      # @faker.version 1.9.2
       def check_digit
         dv
       end
 
-      def full_rut(legacy_min_rut = NOT_GIVEN, legacy_fixed = NOT_GIVEN, min_rut: 0, fixed: false)
-        if legacy_min_rut != NOT_GIVEN
-          warn_with_uplevel 'Passing `min_rut` with the 1st argument of `ChileRut.full_rut` is deprecated. Use keyword argument like `ChileRut.full_rut(min_rut: ...)` instead.', uplevel: 1
-          min_rut = legacy_min_rut
-        end
-        if legacy_fixed != NOT_GIVEN
-          warn_with_uplevel 'Passing `fixed` with the 2nd argument of `ChileRut.full_rut` is deprecated. Use keyword argument like `ChileRut.full_rut(fixed: ...)` instead.', uplevel: 1
-          fixed = legacy_fixed
-        end
-
-        "#{rut(min_rut: min_rut, fixed: fixed)}-#{dv}"
+      ##
+      # Produces a random Chilean RUT (Rol Unico Tributario, ID with 8 digits) with a dv (digito verificador, check-digit).
+      #
+      # @param min_rut [Integer] Specifies the minimum value of the RUT.
+      # @param max_rut [Integer] Specifies the maximum value of the RUT.
+      # @param fixed [Boolean] Determines if the RUT is fixed (returns the min_rut value).
+      # @return [String]
+      #
+      # @example
+      #   Faker::ChileRut.full_rut #=> "30686957-4"
+      #   Faker::ChileRut.full_rut(min_rut: 10_000_000, max_rut: 30_000_000) #=> "20686957-4"
+      #   Faker::ChileRut.full_rut(min_rut: 30_686_957, fixed: true) #=> "30686957-4"
+      #
+      # @faker.version next
+      def full_rut(min_rut: 1, max_rut: 99_999_999, fixed: false, formatted: false)
+        this_rut = rut(min_rut: min_rut, max_rut: max_rut, fixed: fixed)
+        this_rut = format_rut(this_rut) if formatted
+        "#{this_rut}-#{dv}"
       end
 
       attr_reader :last_rut
+
+      private
+
+      def format_rut(rut)
+        rut.to_s.reverse.gsub(/(\d{3})(?=\d)/, '\\1.').reverse
+      end
     end
   end
 end

data/lib/faker/default/chuck_norris.rb

@@ -2,10 +2,21 @@
 
 module Faker
   class ChuckNorris < Base
-    flexible :name
+    flexible :chuck_norris
 
     class << self
-      # from: https://github.com/jenkinsci/chucknorris-plugin/blob/master/src/main/java/hudson/plugins/chucknorris/FactGenerator.java
+      ##
+      # Produces a Chuck Norris Fact.
+      # Original list of facts:
+      # https://github.com/jenkinsci/chucknorris-plugin/blob/master/src/main/java/hudson/plugins/chucknorris/FactGenerator.java
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::ChuckNorris.fact
+      #     #=> "Chuck Norris can solve the Towers of Hanoi in one move."
+      #
+      # @faker.version 1.6.4
       def fact
         fetch('chuck_norris.fact')
       end