faker 3.3.0 → 3.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be60c8141d31082df945cc901a037a7cb113f778e55ad162ac94437591d8077e
-  data.tar.gz: 9daf53dae40a7ff80301d2b6ee34add1362ece01847d575fe60b8486d36956ad
+  metadata.gz: 8af27d99c348c9ae7dc6d06e29566ba78ca5b7f38639697d17dcb4a8403e0497
+  data.tar.gz: bd07375b615d5440b35e6c903a2ca68afcaecb8d0caed7eddac5e2a7d0c34946
 SHA512:
-  metadata.gz: ef12b97fb9cfc95debc587e978c0d88d7a8fb46a3fe9f88069f2bd5e1472a747c5ff8b2fc970b71a36cee26323c5efe3252cf2bd20e936e0dc5e7f7aeaa3778d
-  data.tar.gz: 547705e2465dc97198c5b1da5a9bfa5e859f46f035fef05f6b4a5b5fe9b4302a3daef2ed8964d765b29781eeca81d41dca9100540f71808f2d4cbcf9be6f332f
+  metadata.gz: 6b54896707a3b7cd26bed81a5ee99af3e0d7cba59814f977c27d308ade1d56ba7670b83e4404982f1e51d1e42b9e8c229619e0737cd27c44a6922c6798084e04
+  data.tar.gz: 13c40edb228c8bdbbc5ac704775762dc19794c006a6ccd8d75dc7c3528ae19245a7163be4ffe213d11ae99529ad297a1b2ba356dd5ade3c500fa72312db04308

data/CHANGELOG.md

@@ -1,5 +1,64 @@
 # Changelog
 
+## [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
+
+* Fix bug on phone number generator for `en-US` locale caused by incorrect `.yml` file structure by @aprescott in https://github.com/faker-ruby/faker/pull/2924
+
+### What's Changed
+
+* Added docs for Deprecator in CONTRIBUTING.md by @keshavbiswa in https://github.com/faker-ruby/faker/pull/2919
+* Rename Faker::show to Faker::Theater by @keshavbiswa in https://github.com/faker-ruby/faker/pull/2921
+* renamed nhs to national_health_service by @keshavbiswa in https://github.com/faker-ruby/faker/pull/2923
+
+### New Contributors
+* @aprescott made their first contribution in https://github.com/faker-ruby/faker/pull/2924
+
+**Full Changelog**: https://github.com/faker-ruby/faker/compare/v3.3.0...v3.3.1
+
+-------------------------
+
 ## [v3.3.0](https://github.com/faker-ruby/faker/tree/v3.3.0) (2024-03-25)
 
 ### 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)
@@ -284,6 +292,7 @@ gem 'faker', :git => 'https://github.com/faker-ruby/faker.git', :branch => 'main
   - [Faker::Superhero](doc/default/superhero.md)
   - [Faker::Tea](doc/default/tea.md)
   - [Faker::Team](doc/default/team.md)
+  - [Faker::Theater](doc/default/theater.md)
   - [Faker::Time](doc/default/time.md)
   - [Faker::Twitter](doc/default/twitter.md)
   - [Faker::Types](doc/default/types.md)
@@ -485,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/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("'", '')&.split
+            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/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/{music/show.rb → default/theater.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Faker
-  class Show < Base
+  class Theater < Base
     class << self
       ##
       # Produces the name of a musical for an older audience
@@ -9,12 +9,12 @@ module Faker
       # @return [String]
       #
       # @example
-      #   Faker::Alphanumeric.alpha
-      #     #=> "West Side Story"
+      #   Faker::Theater.adult_musical
+      #     #=> "Mamma Mia!"
       #
       # @faker.version 2.13.0
       def adult_musical
-        fetch('show.adult_musical')
+        fetch('theater.adult_musical')
       end
 
       ##
@@ -23,12 +23,12 @@ module Faker
       # @return [String]
       #
       # @example
-      #   Faker::Alphanumeric.alpha
+      #   Faker::Theater.kids_musical
       #     #=> "Into the Woods JR."
       #
       # @faker.version 2.13.0
       def kids_musical
-        fetch('show.kids_musical')
+        fetch('theater.kids_musical')
       end
 
       ##
@@ -37,13 +37,16 @@ module Faker
       # @return [String]
       #
       # @example
-      #   Faker::Alphanumeric.alpha
+      #   Faker::Theater.play
       #     #=> "Death of a Salesman"
       #
       # @faker.version 2.13.0
       def play
-        fetch('show.play')
+        fetch('theater.play')
       end
     end
   end
+
+  include Faker::Deprecator
+  deprecate_generator('Show', Theater)
 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/version.rb

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

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

data/lib/locales/en/food.yml

@@ -455,7 +455,8 @@ en:
         - Pumpkin Seed
         - Purple Carrot
         - Purple Rice
-        - Quark Quinc
+        - Quark 
+        - Quince
         - Quinoa
         - Radicchio
         - Radish

data/lib/locales/en/{show.yml → theater.yml}

@@ -1,6 +1,6 @@
 en:
   faker:
-    show:
+    theater:
       adult_musical: 
         - "Elton John and Tim Rice's Aida"
         - "Ain't Misbehavin'"

data/lib/locales/en-US.yml

@@ -6949,16 +6949,16 @@ en-US:
         - "(#{PhoneNumber.area_code}) #{PhoneNumber.exchange_code}-#{PhoneNumber.subscriber_number} x#{PhoneNumber.extension}"
         - "#{PhoneNumber.area_code}-#{PhoneNumber.exchange_code}-#{PhoneNumber.subscriber_number} x#{PhoneNumber.extension}"
         - "#{PhoneNumber.area_code}.#{PhoneNumber.exchange_code}.#{PhoneNumber.subscriber_number} x#{PhoneNumber.extension}"
-      cell_phone:
-        formats:
-          - "#{PhoneNumber.area_code}-#{PhoneNumber.exchange_code}-#{PhoneNumber.subscriber_number}"
-          - "(#{PhoneNumber.area_code}) #{PhoneNumber.exchange_code}-#{PhoneNumber.subscriber_number}"
-          - "#{PhoneNumber.area_code}-#{PhoneNumber.exchange_code}-#{PhoneNumber.subscriber_number}"
-          - "#{PhoneNumber.area_code}.#{PhoneNumber.exchange_code}.#{PhoneNumber.subscriber_number}"
-          - "#{PhoneNumber.area_code}-#{PhoneNumber.exchange_code}-#{PhoneNumber.subscriber_number}"
-          - "(#{PhoneNumber.area_code}) #{PhoneNumber.exchange_code}-#{PhoneNumber.subscriber_number}"
-          - "#{PhoneNumber.area_code}-#{PhoneNumber.exchange_code}-#{PhoneNumber.subscriber_number}"
-          - "#{PhoneNumber.area_code}.#{PhoneNumber.exchange_code}.#{PhoneNumber.subscriber_number}"
+    cell_phone:
+      formats:
+        - "#{PhoneNumber.area_code}-#{PhoneNumber.exchange_code}-#{PhoneNumber.subscriber_number}"
+        - "(#{PhoneNumber.area_code}) #{PhoneNumber.exchange_code}-#{PhoneNumber.subscriber_number}"
+        - "#{PhoneNumber.area_code}-#{PhoneNumber.exchange_code}-#{PhoneNumber.subscriber_number}"
+        - "#{PhoneNumber.area_code}.#{PhoneNumber.exchange_code}.#{PhoneNumber.subscriber_number}"
+        - "#{PhoneNumber.area_code}-#{PhoneNumber.exchange_code}-#{PhoneNumber.subscriber_number}"
+        - "(#{PhoneNumber.area_code}) #{PhoneNumber.exchange_code}-#{PhoneNumber.subscriber_number}"
+        - "#{PhoneNumber.area_code}-#{PhoneNumber.exchange_code}-#{PhoneNumber.subscriber_number}"
+        - "#{PhoneNumber.area_code}.#{PhoneNumber.exchange_code}.#{PhoneNumber.subscriber_number}"
     id_number:
       valid: "#{IdNumber.ssn_valid}"
       invalid:

data/lib/locales/ja/football.yml

@@ -0,0 +1,115 @@
+ja:
+  faker:
+    football:
+      teams:
+        - レアル・マドリード
+        - FCバルセロナ
+        - バレンシアCF
+        - アトレティコ・マドリード
+        - マンチェスター・ユナイテッド
+        - チェルシー
+        - リヴァプール
+        - アーセナル
+        - トッテナム・ホットスパー
+        - ACミラン
+        - インテル・ミラノ
+        - ASローマ
+        - ユヴェントス
+        - バイエルン・ミュンヘン
+        - ボルシア・ドルトムント
+        - シャルケ04
+        - ベンフィカ
+        - ガラタサライ
+        - PSVアイントホーフェン
+        - LAギャラクシー
+        - パリ・サンジェルマン
+      players:
+        - リオネル・メッシ
+        - ジェラール・ピケ
+        - セルヒオ・ラモス
+        - クリスティアーノ・ロナウド
+        - ダビド・デ・ヘア
+        - ポール・ポグバ
+        - アントワーヌ・グリーズマン
+        - アルバロ・モラタ
+        - アンドレス・イニエスタ
+        - ロベルト・フィルミーノ
+        - モハメド・サラー
+        - ハリー・ケイン
+        - デレ・アリ
+        - アリエン・ロッベン
+        - フランク・リベリー
+        - マルコ・ロイス
+        - ロベルト・レヴァンドフスキ
+        - ズラタン・イブラヒモビッチ
+        - エディンソン・カバーニ
+        - セルヒオ・アグエロ
+        - ネイマール
+        - メスト・エジル
+        - ジャンルイジ・ブッフォン
+        - ウィリアン
+        - マヌエル・ノイアー
+        - ファン・マタ
+        - マヌエル・ノイアー
+        - セスク・ファブレガス
+        - ガレス・ベイル
+        - エデン・アザール
+        - マリオ・マンジュキッチ
+        - キリアン・ムバッペ
+      coaches:
+        - エルネスト・バルベルデ
+        - ジネディーヌ・ジダン
+        - ジョゼ・モウリーニョ
+        - アントニオ・コンテ
+        - ユルゲン・クロップ
+        - マウリシオ・ポチェッティーノ
+        - ディエゴ・シメオネ
+        - マッシミリアーノ・アッレグリ
+        - ユップ・ハインケス
+        - アーセン・ベンゲル
+        - ホルヘ・サンパオリ
+        - フェルナンド・サントス
+        - ディディエ・デシャン
+        - ヨアヒム・レーヴ
+        - フレン・ロペテギ
+        - マウリシオ・ポチェッティーノ
+        - ウナイ・エメリ
+        - マッシミリアーノ・アッレグリ
+        - トーマス・トゥヘル
+      competitions:
+        - UEFAヨーロッパ選手権
+        - アジアカップ
+        - アフリカネイションズカップ
+        - コパ・アメリカ
+        - UEFAチャンピオンズリーグ
+        - FIFAワールドカップ
+        - UEFAヨーロッパリーグ
+        - セリエA
+        - バークレイズ・プレミアリーグ
+        - ブンデスリーガ
+        - リーガ・サンタンデール
+        - FAカップ
+        - リーグ・アン
+        - プリメイラ・リーガ
+        - エールディヴィジ
+        - スーパーリーグ
+        - メジャーリーグサッカー
+        - コッパ・イタリア
+        - DFBポカール
+        - CONCACAFゴールドカップ
+        - ネーションズカップ
+        - コパ・デル・レイ
+      positions:
+        - ゴールキーパー
+        - フルバック
+        - ライトバック
+        - レフトバック
+        - ディフェンシブミッドフィールダー
+        - ミッドフィールダー
+        - アタッキングミッドフィールダー
+        - ライトミッドフィールダー
+        - レフトミッドフィールダー
+        - ライトウィング
+        - レフトウィング
+        - セカンドストライカー
+        - センターフォワード