faker 2.10.2 → 2.15.0

data/lib/faker/default/barcode.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module Faker
+  class Barcode < Base
+    class << self
+      ## Returns a EAN 8 or 13 digit format barcode number with check digit
+      #  @returns [String]
+      #
+      #  @example
+      #     Faker::Barcode.ean      => "85657526"
+      #     Faker::Barcode.ean(8)   => "30152700"
+      #     Faker::Barcode.ean(13)  => "2115190480285"
+      #
+      # @faker.version 2.14.0
+      def ean(length = 8)
+        generate_barcode("barcode.ean_#{Integer(length)}")
+      end
+
+      ## Returns a EAN 8 or 13 digit format barcode number with composite string attached with check digit
+      #  @returns [String]
+      #
+      #  @example
+      #     Faker::Barcode.ean_with_composite_sumbology      => "41007624|JHOC6649"
+      #     Faker::Barcode.ean_with_composite_sumbology(8)   => "38357961|XUYJ3266"
+      #     Faker::Barcode.ean_with_composite_sumbology(13)  => "9530722443911|CKHWQHID"
+      #
+      # @faker.version 2.14.0
+      def ean_with_composite_symbology(length = 8)
+        "#{ean(length)}|#{bothify(parse('barcode.composite_symbol'))}"
+      end
+
+      ## Returns a UPC_A format barcode number with check digit
+      #  @returns [String]
+      #
+      #  @example
+      #     Faker::Barcode.upc_a      => "766807541831"
+      #
+      # @faker.version 2.14.0
+      def upc_a
+        generate_barcode('barcode.upc_a')
+      end
+
+      ## Returns a UPC_E format barcode number with check digit
+      #  @returns [String]
+      #
+      #  @example
+      #     Faker::Barcode.upc_e      => "03746820"
+      #
+      # @faker.version 2.14.0
+      def upc_e
+        generate_barcode('barcode.upc_e')
+      end
+
+      ## Returns a UPC_A format barcode number with composite string attached with check digit
+      #  @returns [String]
+      #
+      #  @example
+      #     Faker::Barcode.upc_a_with_composite_symbology      => "790670155765|JOVG6208"
+      #
+      # @faker.version 2.14.0
+      def upc_a_with_composite_symbology
+        "#{upc_a}|#{bothify(parse('barcode.composite_symbol'))}"
+      end
+
+      ## Returns a UPC_E format barcode number with composite string attached with check digit
+      #  @returns [String]
+      #
+      #  @example
+      #     Faker::Barcode.upc_e_with_composite_symbology      => "05149247|BKZX9722"
+      #
+      # @faker.version 2.14.0
+      def upc_e_with_composite_symbology
+        "#{upc_e}|#{bothify(parse('barcode.composite_symbol'))}"
+      end
+
+      ## Returns a ISBN format barcode number with check digit
+      #  @returns [String]
+      #
+      #  @example
+      #     Faker::Barcode.isbn      => "9798363807732"
+      #
+      # @faker.version 2.14.0
+      def isbn
+        generate_barcode('barcode.isbn')
+      end
+
+      ## Returns a ISMN format barcode number with check digit
+      #  @returns [String]
+      #
+      #  @example
+      #     Faker::Barcode.ismn      => "9790527672897"
+      #
+      # @faker.version 2.14.0
+      def ismn
+        generate_barcode('barcode.ismn')
+      end
+
+      ## Returns a ISSN format barcode number with check digit
+      #  @returns [String]
+      #
+      #  @example
+      #     Faker::Barcode.issn      => "9775541703338"
+      #
+      # @faker.version 2.14.0
+      def issn
+        generate_barcode('barcode.issn')
+      end
+
+      private
+
+      def generate_barcode(key)
+        barcode = parse(key)
+        check_digit = generate_check_digit(*sum_even_odd(barcode))
+        "#{barcode}#{check_digit}"
+      end
+
+      ## Returns the sum of even and odd numbers from value passed
+      #
+      # @returns [Array]
+      #
+      # @example
+      #   Faker::Barcode.send(:sum_even_odd, 12345)   => [9, 5]
+      #   Faker::Barcode.send(:sum_even_odd, 87465)   => [17, 13]
+      #
+      # @faker.version 2.14.0
+      def sum_even_odd(fake_num)
+        number = fake_num.to_i
+        sum_even, sum_odd = 0, 0, index = 1
+
+        while number != 0
+          index.even? ? sum_even += number % 10 : sum_odd += number % 10
+
+          number /= 10
+          index += 1
+        end
+
+        [sum_odd, sum_even]
+      end
+
+      ## Generates the check digits from sum passed
+      #
+      # @returns [Integer]
+      #
+      # @example
+      #   Faker::Barcode.send(:generate_check_digit, 12, 4)   => 0
+      #   Faker::Barcode.send(:generate_check_digit, 23, 5)   => 6
+      #
+      # @faker.version 2.14.0
+      def generate_check_digit(odd_sum, even_sum)
+        (10 - (odd_sum * 3 + even_sum) % 10) % 10
+      end
+    end
+  end
+end

data/lib/faker/default/beer.rb

@@ -80,7 +80,7 @@ module Faker
       #
       # @faker.version 1.6.2
       def ibu
-        rand(10..100).to_s + ' IBU'
+        "#{rand(10..100)} IBU"
       end
 
       ##
@@ -93,7 +93,7 @@ module Faker
       #
       # @faker.version 1.6.2
       def alcohol
-        rand(2.0..10.0).round(1).to_s + '%'
+        "#{rand(2.0..10.0).round(1)}%"
       end
 
       ##
@@ -106,7 +106,7 @@ module Faker
       #
       # @faker.version 1.6.2
       def blg
-        rand(5.0..20.0).round(1).to_s + '°Blg'
+        "#{rand(5.0..20.0).round(1)}°Blg"
       end
     end
   end

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

@@ -26,7 +26,7 @@ module Faker
       # @return [Date]
       #
       # @example
-      #   Faker::Business.credit_card_number #=> <Date: 2015-11-11 ((2457338j,0s,0n),+0s,2299161j)>
+      #   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

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,122 @@
 
 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,7 +5,19 @@ module Faker
     class << self
       @last_rut = nil
 
-      # Fixed param added for testing a specific RUT and check digit combination.
+      ##
+      # Produces a random Chilean RUT (Rol Unico Tributario, ID with 8 digits).
+      #
+      # @param min_rut [Integer] Specifies the minimum 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: 20890156) #=> 31853211
+      #   Faker::ChileRut.rut(min_rut: 20890156, fixed: true) #=> 20890156
+      #
+      # @faker.version 1.9.2
       def rut(legacy_min_rut = NOT_GIVEN, legacy_fixed = NOT_GIVEN, min_rut: 1, fixed: false)
         warn_for_deprecated_arguments do |keywords|
           keywords << :min_rut if legacy_min_rut != NOT_GIVEN
@@ -15,6 +27,15 @@ module Faker
         @last_rut = fixed ? min_rut : rand_in_range(min_rut, 99_999_999)
       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('')
         seq = [2, 3, 4, 5, 6, 7]
@@ -25,20 +46,43 @@ 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
 
+      ##
+      # 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 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: 20890156) #=> "30686957-4"
+      #   Faker::ChileRut.full_rut(min_rut: 30686957, fixed: true) #=> "30686957-4"
+      #
+      # @faker.version 1.9.2
       def full_rut(legacy_min_rut = NOT_GIVEN, legacy_fixed = NOT_GIVEN, min_rut: 0, fixed: false)
         warn_for_deprecated_arguments do |keywords|
           keywords << :min_rut if legacy_min_rut != NOT_GIVEN