faker 3.3.1 → 3.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cb066b564608902aac8699487a9d11cb48bac922915f51b2ca7d5e9ed2c3d5f
-  data.tar.gz: edfabcbea53ec9ed1c7acd2dcf6c8fe6475efa56bae692758aaf6103de771993
+  metadata.gz: cf806bbcecec3b286e05fe7c79f0b4274708a3a7f55add0b3488a3ba8bf574f6
+  data.tar.gz: 688f47f7f92a4b58281ef2e3beb0df72e134e916929d7aa1ff4e6db07af9151d
 SHA512:
-  metadata.gz: f76bde79e5d96a73b34d487a7bb2a8d1cc5f05631d9ba48952edbb2a3f6470409586a974676c329b7a61112f338c33ad631e6362a4c54242e4d61efe52f1f29c
-  data.tar.gz: dcb683004a0cc255d076059a3b199870a921473355358d25afd73f904255db7f30297779ec75364ddebb2f806a6a874ef0e328e3dcce0549a3b6dfea8ee96e0a
+  metadata.gz: 4cd84609a1b8b0d846f5185cd544141e22d8296a2bcbe4a613daabcdadde8afa1039a9087dafbf7b7ccba7668ff5c506b1ca25cbebd3520455760a16dea45cd6
+  data.tar.gz: ab939601c6ceeb1f051d708687a61e2a89c3e9da77881159866a73cb5039c9292101cb48d3b19c36607b1cbf25192e8895e7e49b0dde1e88c0e07c0e24e75f01

data/CHANGELOG.md

@@ -1,5 +1,94 @@
 # Changelog
 
+## [v3.4.2](https://github.com/faker-ruby/faker/tree/v3.4.2) (2024-07-16)
+
+Happy July with a new faker-ruby release.
+
+This version:
+
+- introduces a breaking change for `Faker::NationalHealthService.british_number` (more details below)
+- adds translation for some generators
+- fixes bugs
+
+### Breaking changes
+
+The NHS sets aside a range of numbers from 999 000 0000 to 999 999 9999 for test purposes. The old range could
+produce NHS numbers that were in use by real patients in the UK/England and Wales. In this version, `Faker::NationalHealthService.british_number` uses the test range for creating NHS numbers rather than the previous 400 000 0010 to 499 999 9999 range.
+
+Breaking change was introduced in "Add test range param to NHS numbers" by @neanias in https://github.com/faker-ruby/faker/pull/2947
+
+### Improvements & Bug fixes
+
+* Add Bank and Sport to Swedish locale by @twk-mn in https://github.com/faker-ruby/faker/pull/2961
+* docs: update with notes about validity for zips by @garrettgregor in https://github.com/faker-ruby/faker/pull/2963
+* `Faker::Games::Dota` missing quotes and new heroes by @arthurka-o in https://github.com/faker-ruby/faker/pull/2907
+* Add phone_number.country_code and address.full_address in locale sv by @larkro in https://github.com/faker-ruby/faker/pull/2965
+* Fix typo by @fynsta in https://github.com/faker-ruby/faker/pull/2968
+* fix: `Faker::Internet.username` should not generate duplicated punctuation by @thdaraujo in https://github.com/faker-ruby/faker/pull/2970
+* Update dog breed names for `en-US` locale by @mononoken in https://github.com/faker-ruby/faker/pull/2972
+* Add `Deprecator.skip_warning?` ability to silence deprecators on tests by @keshavbiswa in https://github.com/faker-ruby/faker/pull/2956
+
+### Update local dependencies
+
+* Bump timecop from 0.9.9 to 0.9.10 by @dependabot in https://github.com/faker-ruby/faker/pull/2969
+* Bump minitest from 5.23.1 to 5.24.1 by @dependabot in https://github.com/faker-ruby/faker/pull/2975
+* Bump bundler version to `2.4.22` by @thdaraujo in https://github.com/faker-ruby/faker/pull/2978
+* Bump rubocop from 1.64.1 to 1.65.0 by @dependabot in https://github.com/faker-ruby/faker/pull/2979
+* Bump rubocop-minitest from 0.35.0 to 0.35.1 by @dependabot in https://github.com/faker-ruby/faker/pull/2980
+
+## New Contributors
+* @twk-mn made their first contribution in https://github.com/faker-ruby/faker/pull/2961
+* @neanias made their first contribution in https://github.com/faker-ruby/faker/pull/2947
+* @garrettgregor made their first contribution in https://github.com/faker-ruby/faker/pull/2963
+* @arthurka-o made their first contribution in https://github.com/faker-ruby/faker/pull/2907
+* @larkro made their first contribution in https://github.com/faker-ruby/faker/pull/2965
+* @fynsta made their first contribution in https://github.com/faker-ruby/faker/pull/2968
+* @mononoken made their first contribution in https://github.com/faker-ruby/faker/pull/2972
+
+**Full Changelog**: https://github.com/faker-ruby/faker/compare/v.3.4.1...v3.4.2
+
+---------------------------------
+
+## [v3.4.1](https://github.com/faker-ruby/faker/tree/v3.4.1) (2024-05-28)
+
+### What's changed
+
+* Performance: Sample arrays instead of performing shuffle and slice by @alextaujenis in https://github.com/faker-ruby/faker/pull/2940
+* Performance: Reduce the time complexity of `Faker::Crypto` generators by @alextaujenis in https://github.com/faker-ruby/faker/pull/2938
+* Remove tzinfo dependency by @stefannibrasil in https://github.com/faker-ruby/faker/pull/2952
+
+### Bug fixes
+
+* Fix invalid IANA time zone identifier for `Atlantic/Cape_Verde` by @andrelaszlo in https://github.com/faker-ruby/faker/pull/2927
+* Fix entry in faker.food.ingredients by @matthewmayer in https://github.com/faker-ruby/faker/pull/2933
+* Docs: add absolute links to CONTRIBUTING from README by @matthewmayer in https://github.com/faker-ruby/faker/pull/2934
+* Fix: `Faker::Number.hexadecimal` should include characters within the range of `[0-9a-f]` by @alextaujenis in https://github.com/faker-ruby/faker/pull/2942
+* Username splits names by space and doesn't regex match them by @keshavbiswa in https://github.com/faker-ruby/faker/pull/2950
+
+### Features
+
+* Add animals, desserts, foods, hobbies, house, and k-pop translations to the Korean locale file by @connie-feng in https://github.com/faker-ruby/faker/pull/2935
+* Add adjectives to Korean locale file by @connie-feng in https://github.com/faker-ruby/faker/pull/2930
+* Add emotions, movies, Pokemon, and Studio Ghibli to the Korean locale by @connie-feng in https://github.com/faker-ruby/faker/pull/2941
+* Add Japanese translations for `Faker::Sports::Football`. by @yamat47 in https://github.com/faker-ruby/faker/pull/2903
+
+### Update local dependencies
+
+* Bump rake from 13.1.0 to 13.2.1 by @dependabot in https://github.com/faker-ruby/faker/pull/2929
+* Bump i18n from 1.14.4 to 1.14.5 by @dependabot in https://github.com/faker-ruby/faker/pull/2949
+* Bump minitest from 5.22.3 to 5.23.1 by @dependabot in https://github.com/faker-ruby/faker/pull/2957
+* Bump rubocop from 1.63.4 to 1.64.0 by @dependabot in https://github.com/faker-ruby/faker/pull/2958
+
+## New Contributors
+
+* @connie-feng made their first contribution in https://github.com/faker-ruby/faker/pull/2930
+* @andrelaszlo made their first contribution in https://github.com/faker-ruby/faker/pull/2927
+* @matthewmayer made their first contribution in https://github.com/faker-ruby/faker/pull/2933
+
+**Full Changelog**: https://github.com/faker-ruby/faker/compare/v3.3.1...v.3.4.1
+
+---------------------------------
+
 ## [v3.3.1](https://github.com/faker-ruby/faker/tree/v3.3.1) (2024-04-02)
 
 ### Bug fixes

data/README.md

@@ -14,7 +14,7 @@ Faker helps you generate realistic test data, and populate your
 database with more than a couple of records while you're doing development.
 
 It comes in very handy for taking screenshots (taking screenshots for a personal project)
-and it was the original impetus for the creation of this gem).
+and it was the original impetus for the creation of this gem.
 
 ## Quick links
 
@@ -24,6 +24,14 @@ and it was the original impetus for the creation of this gem).
 [rubydocs]: https://www.rubydoc.info/gems/faker/
 [changelog]: CHANGELOG.md
 
+## In the media
+
+- 📰 [With Great Humor Comes Great Developer Engagement] - KTH Royal Institute of Technology research
+- 🎧 [Computer und Kommunikation 4.5.2024, komplette Sendung] - Deutschland Funk Radio Interview
+
+[With Great Humor Comes Great Developer Engagement]: https://arxiv.org/pdf/2312.01680
+[Computer und Kommunikation 4.5.2024, komplette Sendung]: https://www.deutschlandfunk.de/computer-und-kommunikation-4-5-2024-komplette-sendung-dlf-16492b03-100.html
+
 ## Table of Contents
 
 - [Faker](#faker)
@@ -486,9 +494,9 @@ gem 'faker', :git => 'https://github.com/faker-ruby/faker.git', :branch => 'main
 
 ## Contributing
 
-**Note**: We are not accepting proposals for new generators and locales. The [Contributing](CONTRIBUTING.md) guide has a few notes about this decision.
+**Note**: We are not accepting proposals for new generators and locales. The [Contributing](https://github.com/faker-ruby/faker/blob/main/CONTRIBUTING.md) guide has a few notes about this decision.
 
-Take a look at the [Contributing](CONTRIBUTING.md) document for
+Take a look at the [Contributing](https://github.com/faker-ruby/faker/blob/main/CONTRIBUTING.md) document for
 instructions on setting up the repo on your machine, opening bug reports, understanding the codebase,
 and creating a good pull request.
 

data/lib/faker/books/lovecraft.rb

@@ -133,10 +133,9 @@ module Faker
           resolved_num = resolve(number)
           word_list = translate('faker.lovecraft.words')
           word_list *= ((resolved_num / word_list.length) + 1)
+          words = sample(word_list, resolved_num)
+          return words if spaces_allowed
 
-          return shuffle(word_list)[0, resolved_num] if spaces_allowed
-
-          words = shuffle(word_list)[0, resolved_num]
           words.each_with_index { |w, i| words[i] = word if w =~ /\s/ }
         end
 

data/lib/faker/default/address.rb

@@ -119,8 +119,8 @@ module Faker
           return numerify(letterified_string, leading_zero: true)
         end
 
-        # provide a zip code that is valid for the state provided
-        # see http://www.fincen.gov/forms/files/us_state_territory_zip_codes.pdf
+        # provide a zip code that may be valid for the state provided
+        # note: zip code may appear in the correct format for the state provided but may not be an actual state zip.
         bothify(fetch("address.postcode_by_state.#{state_abbreviation}"))
       end
 

data/lib/faker/default/crypto.rb

@@ -5,6 +5,15 @@ require 'openssl'
 module Faker
   class Crypto < Base
     class << self
+      # Setting the lorem character number lower than the default of
+      # 255 reduces the time complexity of each hash algorithm while
+      # still returning deterministically unique values. See
+      # https://github.com/faker-ruby/faker/pull/2938 for more info.
+      MD5_MIN_NUMBER_OF_CHARACTERS = 25
+      SHA1_MIN_NUMBER_OF_CHARACTERS = 31
+      SHA256_MIN_NUMBER_OF_CHARACTERS = 50
+      SHA512_MIN_NUMBER_OF_CHARACTERS = 100
+
       ##
       # Produces an MD5 hash.
       #
@@ -15,7 +24,7 @@ module Faker
       #
       # @faker.version 1.6.4
       def md5
-        OpenSSL::Digest::MD5.hexdigest(Lorem.characters)
+        OpenSSL::Digest::MD5.hexdigest(Lorem.characters(number: MD5_MIN_NUMBER_OF_CHARACTERS))
       end
 
       ##
@@ -28,7 +37,7 @@ module Faker
       #
       # @faker.version 1.6.4
       def sha1
-        OpenSSL::Digest::SHA1.hexdigest(Lorem.characters)
+        OpenSSL::Digest::SHA1.hexdigest(Lorem.characters(number: SHA1_MIN_NUMBER_OF_CHARACTERS))
       end
 
       ##
@@ -41,7 +50,7 @@ module Faker
       #
       # @faker.version 1.6.4
       def sha256
-        OpenSSL::Digest::SHA256.hexdigest(Lorem.characters)
+        OpenSSL::Digest::SHA256.hexdigest(Lorem.characters(number: SHA256_MIN_NUMBER_OF_CHARACTERS))
       end
 
       ##
@@ -54,7 +63,7 @@ module Faker
       #
       # @faker.version next
       def sha512
-        OpenSSL::Digest::SHA512.hexdigest(Lorem.characters)
+        OpenSSL::Digest::SHA512.hexdigest(Lorem.characters(number: SHA512_MIN_NUMBER_OF_CHARACTERS))
       end
     end
   end

data/lib/faker/default/hipster.rb

@@ -39,10 +39,9 @@ module Faker
           (supplemental ? translate('faker.lorem.words') : [])
         )
         word_list *= ((resolved_num / word_list.length) + 1)
+        words = sample(word_list, resolved_num)
+        return words if spaces_allowed
 
-        return shuffle(word_list)[0, resolved_num] if spaces_allowed
-
-        words = shuffle(word_list)[0, resolved_num]
         words.each_with_index { |w, i| words[i] = word if w =~ /\s/ }
       end
 

data/lib/faker/default/internet.rb

@@ -63,9 +63,12 @@ module Faker
       #   Faker::Internet.username(specifier: 20, separators: ['_'])  #=> "nikki_sawaynnikki_saway"
       def username(specifier: nil, separators: %w[. _])
         with_locale(:en) do
-          return shuffle(specifier.scan(/[[:word:]]+/)).join(sample(separators)).downcase if specifier.respond_to?(:scan)
-
           case specifier
+          when ::String
+            names = specifier.gsub("'", '').scan(/[[:word:]]+/)
+            shuffled_names = shuffle(names)
+
+            return shuffled_names.join(sample(separators)).downcase
           when Integer
             # If specifier is Integer and has large value, Argument error exception is raised to overcome memory full error
             raise ArgumentError, 'Given argument is too large' if specifier > 10**6

data/lib/faker/default/lorem.rb

@@ -45,7 +45,7 @@ module Faker
           word_list -= exclude_words
         end
         word_list *= ((resolved_num / word_list.length) + 1)
-        shuffle(word_list)[0, resolved_num]
+        sample(word_list, resolved_num)
       end
 
       ##

data/lib/faker/default/national_health_service.rb

@@ -6,14 +6,17 @@ module Faker
       ##
       # Produces a random British NHS number.
       #
+      # The NHS sets aside a range of numbers from 999 000 0000 to 999 999 9999
+      # for test purposes.
+      #
       # @return [String]
       #
       # @example
-      #   Faker::NationalHealthService.british_number #=> "403 958 5577"
+      #   Faker::NationalHealthService.british_number #=> "999 464 0232"
       #
       # @faker.version 1.9.2
       def british_number
-        base_number = rand(400_000_001...499_999_999)
+        base_number = rand(999_000_001...999_999_999)
         # If the check digit is equivalent to 10, the number is invalid.
         # See https://en.wikipedia.org/wiki/NHS_number
         base_number -= 1 if check_digit(number: base_number) == 10
@@ -24,6 +27,8 @@ module Faker
                                                            .join
       end
 
+      private
+
       ##
       # Produces a random British NHS number's check digit.
       #

data/lib/faker/default/number.rb

@@ -114,7 +114,7 @@ module Faker
       # @faker.version 1.0.0
       def hexadecimal(digits: 6)
         hex = ''
-        digits.times { hex += rand(15).to_s(16) }
+        digits.times { hex += rand(16).to_s(16) }
         hex
       end
 

data/lib/faker/default/omniauth.rb

@@ -444,11 +444,11 @@ module Faker
       private
 
       def gender
-        shuffle(%w[male female]).pop
+        sample(%w[male female])
       end
 
       def timezone
-        shuffle((-12..12).to_a).pop
+        sample((-12..12).to_a)
       end
 
       def image
@@ -460,11 +460,11 @@ module Faker
       end
 
       def random_number_from_range(range)
-        shuffle(range.to_a).pop
+        sample(range.to_a)
       end
 
       def random_boolean
-        shuffle([true, false]).pop
+        sample([true, false])
       end
     end
   end

data/lib/faker/default/types.rb

@@ -18,11 +18,9 @@ module Faker
       # @faker.version 1.8.6
       def rb_string(words: 1)
         resolved_num = resolve(words)
-        word_list =
-          translate('faker.lorem.words')
-
+        word_list = translate('faker.lorem.words')
         word_list *= ((resolved_num / word_list.length) + 1)
-        shuffle(word_list)[0, resolved_num].join(' ')
+        sample(word_list, resolved_num).join(' ')
       end
 
       ##

data/lib/faker/default/vehicle.rb

@@ -48,12 +48,13 @@ module Faker
       # @return [String]
       #
       # @example
-      #   Faker::Vehicle.manufacture #=> "Lamborghini"
+      #   Faker::Vehicle.manufacturer #=> "Lamborghini"
       #
       # @faker.version 1.6.4
-      def manufacture
-        fetch('vehicle.manufacture')
+      def manufacturer
+        fetch('vehicle.manufacturer')
       end
+      alias manufacture manufacturer
 
       ##
       # Produces a random vehicle make.

data/lib/faker/locations/australia.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 module Faker
-  extend Deprecator
-
   class Locations
     class Australia < Base
       class << self
@@ -48,5 +46,7 @@ module Faker
       end
     end
   end
+
+  include Deprecator
   deprecate_generator('Australia', Locations::Australia)
 end

data/lib/faker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Faker # :nodoc:
-  VERSION = '3.3.1'
+  VERSION = '3.4.2'
 end

data/lib/helpers/deprecator.rb

@@ -10,7 +10,10 @@ module Faker
       extension = Module.new do
         def const_missing(missing_const_name)
           if class_variable_defined?(:@@_deprecated_constants) && (replacement = class_variable_get(:@@_deprecated_constants)[missing_const_name.to_s])
-            $stdout.puts("DEPRECATION WARNING: #{name}::#{replacement[:old_generator]} is deprecated. Use #{replacement[:new_constant]} instead.")
+            unless Faker::Deprecator.skip_warning?
+              $stdout.puts("DEPRECATION WARNING: #{name}::#{replacement[:old_generator]} is deprecated. Use #{replacement[:new_constant]} instead.")
+            end
+
             return replacement[:new_constant]
           end
 
@@ -25,6 +28,26 @@ module Faker
 
       base.singleton_class.prepend extension
     end
+
+    def self.skip_warning
+      original = Faker::Deprecator.skip
+      Faker::Deprecator.skip = true
+      yield
+    ensure
+      Faker::Deprecator.skip = original
+    end
+
+    def self.skip_warning?
+      skip == true
+    end
+
+    def self.skip
+      @skip ||= false
+    end
+
+    def self.skip=(value)
+      @skip = value
+    end
   end
 end
 # rubocop:enable Style/ClassVars

data/lib/locales/en/address.yml

@@ -1717,7 +1717,7 @@ en:
         - America/Godthab
         - Atlantic/South_Georgia
         - Atlantic/Azores
-        - Atlantic/Cabo_Verde
+        - Atlantic/Cape_Verde
         - Europe/Dublin
         - Europe/London
         - Europe/Lisbon