faker 2.13.0 → 2.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 419bb77c9f0a8bc8f7c1b7ea5d93ba7d407bf7c437598eb91413f062f67494ce
-  data.tar.gz: 6566078b00ceb18763960551f913a341393858c2458cec01fcb4b0f0163d2e4b
+  metadata.gz: c20404a4d9474978940db437ddac9984deddd352fdf7cf9313d038a7e9c0ce54
+  data.tar.gz: d52491d45e9dbc7525cf078789e84c10219d2c8e428de4541a1e73dfa6246569
 SHA512:
-  metadata.gz: 694b65a586f50b801f47a456954dd6f2fba39a82b9a643153bb140f9bd3467b7e3080c49a63f0a8562db10c6442bc7c5c578928ddde129054cb070d2a81658e3
-  data.tar.gz: eb6812f2f21c5a1930ad987ad8023efeb9168a6f6ec909fcd86d3deeb5e8720d82f457be58fc08f907d502571656ee6768bc21cbb6395a5366c2410d65e358cf
+  metadata.gz: ee17e0c0333a8e5456d167ed3f7ccc26be29c5f95efdcf6aa866cc2b80789afb95a910922af3405f9d3484b0c266c5217fa40fb593c08eefcc8aab0159b83f91
+  data.tar.gz: 66fa28264c8fbe299c025e6bd566a55870fd9059bda1863dfbe3d03c7fe56a176f04432c784f3d1a079429bb375cc18c56da6d38341b2167edce1f3abbae9074

data/CHANGELOG.md

@@ -1,5 +1,54 @@
 # Change Log
 
+## [v2.14.0](https://github.com/faker-ruby/faker/tree/v2.14.0) (2020-09-15)
+
+## Bug/Fixes
+
+- [PR #2119](https://github.com/faker-ruby/faker/pull/2119) Fixed failing spec for phone number
+
+## Chores
+
+- [PR #2088](https://github.com/faker-ruby/faker/pull/2088) Remove the space in the word "turtle" in the Creature::Animals faker
+- [PR #2081](https://github.com/faker-ruby/faker/pull/2081) Remove redundant condition branch for Ruby 2.4
+- [PR #2077](https://github.com/faker-ruby/faker/pull/2077) Rename tests according to the `test*.rb` pattern so that they run
+
+## Documentation
+
+- [PR #2095](https://github.com/faker-ruby/faker/pull/2095) Fix a typo for `Games::DnD.species`
+- [PR #2094](https://github.com/faker-ruby/faker/pull/2094) Correct method name from race to species in DnD doc
+- [PR #2079](https://github.com/faker-ruby/faker/pull/2079) Add `Music::PearlJam` to Readme
+- [PR #2058](https://github.com/faker-ruby/faker/pull/2058) Add YARD doc for `Faker::Code`
+
+## Feature Request
+
+- [PR #2117](https://github.com/faker-ruby/faker/pull/2117) Add Truffleruby head to CI
+- [PR #2104](https://github.com/faker-ruby/faker/pull/2104) 2097 Added barcodes
+- [PR #2090](https://github.com/faker-ruby/faker/pull/2090) 1693 USA driving license
+- [PR #2098](https://github.com/faker-ruby/faker/pull/2098) Update DnD generator
+- [PR #2096](https://github.com/faker-ruby/faker/pull/2096) 2091 faker drones
+- [PR #2092](https://github.com/faker-ruby/faker/pull/2092) Add a street fighter generator
+- [PR #2082](https://github.com/faker-ruby/faker/pull/2082) Enable `Lint/UnifiedInteger` cop
+
+## Update locales
+
+- [PR #2100](https://github.com/faker-ruby/faker/pull/2100) Remove Gaylord
+- [PR #2087](https://github.com/faker-ruby/faker/pull/2087) Fix/remove country code from phone numbers
+- [PR #2086](https://github.com/faker-ruby/faker/pull/2086) removing country code from phone numbers to `fr-CH`
+- [PR #2084](https://github.com/faker-ruby/faker/pull/2084) removed extra + sign from country codes
+- [PR #2078](https://github.com/faker-ruby/faker/pull/2078) Removed 07624 from UK mobile numbers
+- [PR #2073](https://github.com/faker-ruby/faker/pull/2073) Add missing azimuth field for fr locale
+- [PR #2072](https://github.com/faker-ruby/faker/pull/2072) Remove time formats from file
+
+Update local dependencies
+
+- Update rubocop requirement from = 0.87.1 to = 0.88.0 (#2080)
+- Update rubocop requirement from = 0.87.0 to = 0.87.1 (#2075)
+- Update rubocop requirement from = 0.86.0 to = 0.87.0 (#2074)
+- Bumps i18n from 1.8.4 to 1.8.5 (#2089)
+- Bumps i18n from 1.8.3 to 1.8.4 (#2083)
+
+------------------------------------------------------------------------------
+
 ## [v2.13.0](https://github.com/faker-ruby/faker/tree/v2.13.0) (2020-06-24)
 
 This version:

data/README.md

@@ -130,6 +130,7 @@ gem 'faker', :git => 'https://github.com/faker-ruby/faker.git', :branch => 'mast
   - [Faker::Artist](doc/default/artist.md)
   - [Faker::Avatar](doc/default/avatar.md)
   - [Faker::Bank](doc/default/bank.md)
+  - [Faker::Barcode](doc/default/barcode.md)
   - [Faker::Beer](doc/default/beer.md)
   - [Faker::Blood](doc/default/blood.md)
   - [Faker::Boolean](doc/default/boolean.md)
@@ -157,6 +158,7 @@ gem 'faker', :git => 'https://github.com/faker-ruby/faker.git', :branch => 'mast
   - [Faker::Dessert](doc/default/dessert.md)
   - [Faker::Device](doc/default/device.md)
   - [Faker::DrivingLicence](doc/default/driving_licence.md)
+  - [Faker::Drone](doc/drone/drone.md)
   - [Faker::Educator](doc/default/educator.md)
   - [Faker::ElectricalComponents](doc/default/electrical_components.md)
   - [Faker::Esport](doc/default/esport.md)
@@ -245,6 +247,7 @@ gem 'faker', :git => 'https://github.com/faker-ruby/faker.git', :branch => 'mast
   - [Faker::Games::Overwatch](doc/games/overwatch.md)
   - [Faker::Games::Pokemon](doc/games/pokemon.md)
   - [Faker::Games::SonicTheHedgehog](doc/games/sonic_the_hedgehog.md)
+  - [Faker::Games::StreetFighter](doc/games/street_fighter.md)
   - [Faker::Games::SuperSmashBros](doc/games/super_smash_bros.md)
   - [Faker::Games::WarhammerFantasy](doc/games/warhammer_fantasy.md)
   - [Faker::Games::Witcher](doc/games/witcher.md)
@@ -274,6 +277,7 @@ gem 'faker', :git => 'https://github.com/faker-ruby/faker.git', :branch => 'mast
   - [Faker::Music](doc/music/music.md)
   - [Faker::Music::GratefulDead](doc/music/grateful_dead.md)
   - [Faker::Music::Opera](doc/music/opera.md)
+  - [Faker::Music::PearlJam](doc/music/pearl_jam.md)
   - [Faker::Music::Phish](doc/music/phish.md)
   - [Faker::Music::Prince](doc/music/prince.md)
   - [Faker::Music::RockBand](doc/music/rock_band.md)

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 next
+      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 next
+      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 next
+      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 next
+      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 next
+      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 next
+      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 next
+      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 next
+      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 next
+      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 next
+      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 next
+      def generate_check_digit(odd_sum, even_sum)
+        (10 - (odd_sum * 3 + even_sum) % 10) % 10
+      end
+    end
+  end
+end

data/lib/faker/default/code.rb

@@ -4,32 +4,76 @@ module Faker
   class Code < Base
     flexible :code
     class << self
-      # Generates a 10 digit NPI (National Provider Identifier
-      # issued to health care providers in the United States)
+      ##
+      # Produces a random NPI (National Provider Identifer) code.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Code.npi #=> "9804062802"
+      #
+      # @faker.version 1.9.4
       def npi
         rand(10**10).to_s.rjust(10, '0')
       end
 
-      # By default generates 10 sign isbn code in format 123456789-X
-      # You can pass 13 to generate new 13 sign code
+      ##
+      # Produces a random ISBN (International Standard Book Number) code.
+      #
+      # @param base [Integer] the length of the code to generate (either 10 or 13)
+      # @return [String]
+      #
+      # @example
+      #   Faker::Code.isbn(base: 13) #=> "896579606969-8"
+      # @example
+      #   Faker::Code.isbn #=> "170366802-2"
+      #
+      # @faker.version 2.2.0
       def isbn(legacy_base = NOT_GIVEN, base: 10)
         warn_for_deprecated_arguments do |keywords|
           keywords << :base if legacy_base != NOT_GIVEN
         end
 
-        base == 13 ? generate_base13_isbn : generate_base10_isbn
+        case base
+        when 10 then generate_base10_isbn
+        when 13 then generate_base13_isbn
+        else raise ArgumentError, 'base must be 10 or 13'
+        end
       end
 
-      # By default generates 13 sign ean code in format 1234567890123
-      # You can pass 8 to generate ean8 code
+      ##
+      # Produces a random EAN (European Article Number) code.
+      #
+      # @param base [Integer] the length of the code to generate (either 8 or 13)
+      # @return [String]
+      #
+      # @example
+      #   Faker::Code.ean(base: 8) #=> "36941070"
+      # @example
+      #   Faker::Code.ean #=> "9941880131907"
+      #
+      # @faker.version 2.2.0
       def ean(legacy_base = NOT_GIVEN, base: 13)
         warn_for_deprecated_arguments do |keywords|
           keywords << :base if legacy_base != NOT_GIVEN
         end
 
-        base == 8 ? generate_base8_ean : generate_base13_ean
+        case base
+        when 8 then generate_base8_ean
+        when 13 then generate_base13_ean
+        else raise ArgumentError, 'base must be 3 or 13'
+        end
       end
 
+      ##
+      # Produces a random RUT (Rol Unico Nacional) code.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Code.rut #=> "91611842-2"
+      #
+      # @faker.version 1.9.4
       def rut
         value = Number.number(digits: 8).to_s
         vd = rut_verificator_digit(value)
@@ -38,6 +82,23 @@ module Faker
 
       # By default generates a Singaporean NRIC ID for someone
       # who is born between the age of 18 and 65.
+      #
+      # Produces a random NRIC (National Registry Identity Card) code.
+      #
+      # @param min_age [Integer] the min age of the person in years
+      # @param max_age [Integer] the max age of the person in years
+      # @return [String]
+      #
+      # @example
+      #   Faker::Code.nric(min_age: 25, max_age: 50) #=> "S9347283G"
+      # @example
+      #   Faker::Code.nric(max_age: 55) #=> "S7876903C"
+      # @example
+      #   Faker::Code.nric(min_age: 25) #=> "S6281697Z"
+      # @example
+      #   Faker::Code.nric #=> "S6372958B"
+      #
+      # @faker.version 2.2.0
       def nric(legacy_min_age = NOT_GIVEN, legacy_max_age = NOT_GIVEN, min_age: 18, max_age: 65)
         warn_for_deprecated_arguments do |keywords|
           keywords << :min_age if legacy_min_age != NOT_GIVEN
@@ -52,19 +113,41 @@ module Faker
         "#{prefix}#{values}#{check_alpha}"
       end
 
-      # Generate GSM modem, device or mobile phone 15 digit IMEI number.
+      ##
+      # Produces a random IMEI (International Mobile Equipment Number) code.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Code.imei #=> "492033129092256"
+      #
+      # @faker.version 1.9.4
       def imei
         generate_imei
       end
 
-      # Retrieves a real Amazon ASIN code list taken from
-      # https://archive.org/details/asin_listing
+      ##
+      # Retrieves a real Amazon ASIN code from https://archive.org/details/asin_listing
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Code.asin #=> "B000MZW1GE"
+      #
+      # @faker.version 1.9.4
       def asin
         fetch('code.asin')
       end
 
-      # Generates Social Insurance Number issued in Canada
-      # https://en.wikipedia.org/wiki/Social_Insurance_Number
+      ##
+      # Produces a random SIN (Social Insurance Number for Canada) code.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Code.sin #=> "996586962"
+      #
+      # @faker.version 1.9.4
       def sin
         # 1   - province or temporary resident
         # 2-8 - random numbers
@@ -90,8 +173,6 @@ module Faker
       def generate_imei
         str = Array.new(15, 0)
         sum = 0
-        t = 0
-        len_offset = 0
         len = 15
 
         # Fill in the first two values of the string based with the specified prefix.

data/lib/faker/default/driving_licence.rb

@@ -78,6 +78,23 @@ module Faker
         end
       end
 
+      ##
+      # Produces a random USA driving licence number by state code passed.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::DrivingLicence.usa_driving_licence                 #=> "V5598249"
+      #   Faker::DrivingLicence.usa_driving_licence('new mexico')   #=> "270692028"
+      #   Faker::DrivingLicence.usa_driving_licence('New Mexico')   #=> "68178637"
+      #
+      # @faker.version next
+      def usa_driving_licence(state = 'California')
+        bothify(fetch("driving_licence.usa.#{state.to_s.strip.downcase.gsub(' ', '_')}"))
+      rescue I18n::MissingTranslationData => _e
+        raise InvalidStatePassed, "Invalid state code passed for USA, '#{state}'"
+      end
+
       private
 
       def random_gender
@@ -104,4 +121,10 @@ module Faker
       end
     end
   end
+
+  class InvalidStatePassed < StandardError
+    def initialize(msg = 'Invalid state code passed')
+      super
+    end
+  end
 end