ffaker 2.20.0 → 2.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62563970b5647d9b9d17709d369aa243a480f6f8f297fe8c04841ddba48a3e86
-  data.tar.gz: 1efe8abdde29b64dc68ed806fd834f7d2414fe80c13933c69e28085874faae22
+  metadata.gz: a3f9654a58ede677b3fb5953188b4c4c3dbddae88d2efb645afce0ddf9e6f548
+  data.tar.gz: 666b18e3d964b7caa9b7db582b1fb4c4965eda1e9542aaf34bb5d15583bc8d71
 SHA512:
-  metadata.gz: 2390c4b547a5811c6c4cea17576f96ef7353cef2e533b990c7af4ec3972b786bfedddb400b880bc810507c6404a6ea55d37bf54ffc16b9fbcc154ecb8dd8fd15
-  data.tar.gz: dfd2614ffefc6e61f16bd660214e25eac2158d8879648fe0c2de0b1a3f49c330bc1244926495a3ee1879d3618050d43052ea09a7c1388495061ac30275e7f156
+  metadata.gz: 1a94ca7b3c77c52cd80423729d743c501379d2257fa6e191a2a8f9af5291f48a0deebcc9fc2589a2bbc6cabaebf8a9a9406b3dad69f64dafb219bffee263614a
+  data.tar.gz: a26f1111b465b8d35d87985457b03ef38d2a76282c8962f5b6a4e749ba33465a945f6dcbd040397dc2aadc43807f7ec70bfc21985465ecad28c770210be0f814

data/Changelog.md

@@ -2,6 +2,54 @@
 
   - Add your change HERE
 
+## 2.25.0
+  - Generator for Finnish identity numbers [@zHarrowed]
+  - Fix typos and add Codespell GitHub action [@kianmeng]
+  - Add FFaker::Boolean.boolean with true ratio [@nedzib]
+  - Add LoremTW and JobTW [@cookiepingyen]
+  - Add loan tools to bank [@hulous]
+
+## 2.24.0
+  - *BREAKING CHANGE*: Drop support under ruby 3.0 [@marocchino]
+  - Add ruby 3.4 to CI [@marocchino]
+  - Add ruby 3.3 to CI [@boimw]
+  - Fix Luhn algorithm used in french companie's SIRET and sweden SSN [@Krap]
+  - Add `FFaker::UUID` `.uuidv4`, `.uuidv6`, `.uuidv7`, and `.uuidv8` [@stilist]
+  - Deprecate `FFaker::Guid.guid` in favor of `FFaker::UUID` methods [@stilist]
+  - Limit FFaker::BankUS.routing_number first two digits [@professor]
+
+## 2.23.0
+  - Add FFaker::BankUS.accounting_number [@professor]
+  - Add FFaker::BankUS.routing_number [@professor]
+  - Resolve a lot of RuboCop offenses [@AlexWayfer]
+  - Change `Image.url`, `Image.file`, `Book.cover` and `Avatar.image` arguments to keywords [@AlexWayfer]
+  - Adds FFaker::Date.birthday [@professor]
+  - Adds FFaker::Crypto.sha256 [@professor]
+  - Update README [@professor]
+  - Adds FFaker::Number.between [@professor]
+  - Fixed `FFaker::Number.unique.number(digits: 1)` under Ruby 3 [@simonhildebrandt]
+
+## 2.22.0
+  - *BREAKING CHANGE*: Drop support under ruby 2.7 [@marocchino]
+  - Correct Vehicle::VIN result [@philippevezina]
+  - Improve performance unique [@iiwo]
+  - Drop gemspec generation in rake [@technicalpickles]
+  - Add identification EC [@josieljunior]
+  - Update data for AddressDE [@slowjack2k]
+  - Add ruby 3.2 to CI [@petergoldstein]
+  - Add JoJo module [@ar2em1s]
+  - Fix crash in FFaker::Time#datetime when defining FFaker::Date module [@brupla6126]
+
+## 2.21.0
+  - Generate valid VINs [@xunker]
+  - Add neighborhood and address complement to AddressBR [@az3vedo]
+  - Ensure FFaker::HTMLIpsum.fancy_string return includes at least one tag [@gabrielcosta42]
+  - Fix IdentificationTW area code [@timfanda35]
+  - Add Ruby 3.1 to CI matrix [@petergoldstein]
+  - Add AnimalBr [@thiago-henrique-leite]
+  - Fix rubocop warnings [@mmrshk]
+  - Consistently generate REFERENCE.md [@technicalpickles] and [@Volosh1n]
+
 ## 2.20.0
   - Remove date from gem specification [@AlexWayfer]
   - Add Number module [@Volosh1n]
@@ -23,7 +71,7 @@
   - Test with Github actions & Ruby 3 [@marocchino]
   - Generate reference by CI [@marocchino]
   - Change the regex to cover all scenarios in lorem_fr [@abnersajr]
-  - Add "Freedom Ipsum" text generator option [@hmaack and @lynnd335]
+  - Add "Freedom Ipsum" text generator option [@hmaack] and [@lynnd335]
   - Fix issues with `FFaker::Image` module [@hmaack]
   - Fix typo in animal.rb module [@renius]
 
@@ -186,21 +234,6 @@
   - many internal library and test suite refactorings
 
 
-[#181]: https://github.com/ffaker/ffaker/issues/181
-[#191]: https://github.com/ffaker/ffaker/issues/191
-[#193]: https://github.com/ffaker/ffaker/issues/193
-[#195]: https://github.com/ffaker/ffaker/issues/195
-[#196]: https://github.com/ffaker/ffaker/issues/196
-[#199]: https://github.com/ffaker/ffaker/issues/199
-[#200]: https://github.com/ffaker/ffaker/issues/200
-[#203]: https://github.com/ffaker/ffaker/issues/203
-[#211]: https://github.com/ffaker/ffaker/pull/211
-[#212]: https://github.com/ffaker/ffaker/pull/212
-[#213]: https://github.com/ffaker/ffaker/pull/213
-[@marocchino]: https://github.com/marocchino
-[@rstacruz]: https://github.com/rstacruz
-[@anderscarling]: https://github.com/anderscarling
-
 
 ## 2.0.0
   - switched faker to ffaker namespace, you should now be able to use
@@ -380,7 +413,7 @@ Api additions by Rafael Souza
 
 ## 0.3.2 2010-01-14
 
-* Several Optimizations, renamed gem packege to ffaker.
+* Several Optimizations, renamed gem package to ffaker.
 
 ## 0.3.1 2008-04-03
 
@@ -410,3 +443,116 @@ Api additions by Rafael Souza
 ## 0.1.0 2007-11-22
 
 * Initial release
+
+[#181]: https://github.com/ffaker/ffaker/issues/181
+[#191]: https://github.com/ffaker/ffaker/issues/191
+[#193]: https://github.com/ffaker/ffaker/issues/193
+[#195]: https://github.com/ffaker/ffaker/issues/195
+[#196]: https://github.com/ffaker/ffaker/issues/196
+[#199]: https://github.com/ffaker/ffaker/issues/199
+[#200]: https://github.com/ffaker/ffaker/issues/200
+[#203]: https://github.com/ffaker/ffaker/issues/203
+[#211]: https://github.com/ffaker/ffaker/pull/211
+[#212]: https://github.com/ffaker/ffaker/pull/212
+[#213]: https://github.com/ffaker/ffaker/pull/213
+[@44uk]: https://github.com/44uk
+[@AlexAvlonitis]: https://github.com/AlexAvlonitis
+[@AlexWayfer]: https://github.com/AlexWayfer
+[@CarlosMouraJR]: https://github.com/CarlosMouraJR
+[@GuillaumeOcculy]: https://github.com/GuillaumeOcculy
+[@IgorMarques]: https://github.com/IgorMarques
+[@Krap]: https://github.com/Krap
+[@Kutomore]: https://github.com/Kutomore
+[@MQuy]: https://github.com/MQuy
+[@Moafak]: https://github.com/Moafak
+[@Phanithism]: https://github.com/Phanithism
+[@Sephyros]: https://github.com/Sephyros
+[@SteveRedka]: https://github.com/SteveRedka
+[@Volosh1n]: https://github.com/Volosh1n
+[@YutaGoto]: https://github.com/YutaGoto
+[@aaronsama]: https://github.com/aaronsama
+[@abnersajr]: https://github.com/abnersajr
+[@adimircolen]: https://github.com/adimircolen
+[@alagu]: https://github.com/alagu
+[@alibby]: https://github.com/alibby
+[@anderscarling]: https://github.com/anderscarling
+[@andyklimczak]: https://github.com/andyklimczak
+[@ar2em1s]: https://github.com/ar2em1s
+[@artplan1]: https://github.com/artplan1
+[@az3vedo]: https://github.com/az3vedo
+[@boimw]: https://github.com/boimw
+[@brain64bit]: https://github.com/brain64bit
+[@brnrdog]: https://github.com/brnrdog
+[@brupla6126]: https://github.com/brupla6126
+[@ckyOL]: https://github.com/ckyOL
+[@cookiepingyen]: https://github.com/cookiepingyen
+[@danderozier]: https://github.com/danderozier
+[@dankimio]: https://github.com/dankimio
+[@delucas]: https://github.com/delucas
+[@dimroc]: https://github.com/dimroc
+[@dphurley]: https://github.com/dphurley
+[@eikes]: https://github.com/eikes
+[@falegk]: https://github.com/falegk
+[@firedev]: https://github.com/firedev
+[@gabrielcosta42]: https://github.com/gabrielcosta42
+[@gerard76]: https://github.com/gerard76
+[@gruz0]: https://github.com/gruz0
+[@hmaack]: https://github.com/hmaack
+[@hulous]: https://github.com/hulous
+[@iamarmanjon]: https://github.com/iamarmanjon
+[@iiwo]: https://github.com/iiwo
+[@j0al]: https://github.com/j0al
+[@jakubm]: https://github.com/jakubm
+[@jasonleonhard]: https://github.com/jasonleonhard
+[@joshdvir]: https://github.com/joshdvir
+[@josieljunior]: https://github.com/josieljunior
+[@jvanbaarsen]: https://github.com/jvanbaarsen
+[@kianmeng]: https://github.com/kianmeng
+[@kmayer]: https://github.com/kmayer
+[@kojino]: https://github.com/kojino
+[@ktroutner]: https://github.com/ktroutner
+[@lilsweetcaligula]: https://github.com/lilsweetcaligula
+[@lynnd335]: https://github.com/lynnd335
+[@makketagg]: https://github.com/makketagg
+[@marocchino]: https://github.com/marocchino
+[@max-si-m]: https://github.com/max-si-m
+[@mechos3d]: https://github.com/mechos3d
+[@metalelf0]: https://github.com/metalelf0
+[@miscelatore]: https://github.com/miscelatore
+[@mklemme]: https://github.com/mklemme
+[@mmrshk]: https://github.com/mmrshk
+[@nav16]: https://github.com/nav16
+[@ni3t]: https://github.com/ni3t
+[@nicholaskillin]: https://github.com/nicholaskillin
+[@nicolas-brousse]: https://github.com/nicolas-brousse
+[@nigelgomesot]: https://github.com/nigelgomesot
+[@pawelma]: https://github.com/pawelma
+[@petergoldstein]: https://github.com/petergoldstein
+[@philippevezina]: https://github.com/philippevezina
+[@pominx]: https://github.com/pominx
+[@professor]: https://github.com/professor
+[@renius]: https://github.com/renius
+[@rgcamus]: https://github.com/rgcamus
+[@robin]: https://github.com/robin
+[@rocknruby]: https://github.com/rocknruby
+[@rstacruz]: https://github.com/rstacruz
+[@rvisuvasam]: https://github.com/rvisuvasam
+[@simonhildebrandt]: https://github.com/simonhildebrandt
+[@slowjack2k]: https://github.com/slowjack2k
+[@spheric]: https://github.com/spheric
+[@steverovsky]: https://github.com/steverovsky
+[@stilist]: https://github.com/stilist
+[@tatey]: https://github.com/tatey
+[@technicalpickles]: https://github.com/technicalpickles
+[@thiago-henrique-leite]: https://github.com/thiago-henrique-leite
+[@thilonel]: https://github.com/thilonel
+[@thutterer]: https://github.com/thutterer
+[@timfanda35]: https://github.com/timfanda35
+[@tvarley]: https://github.com/tvarley
+[@ulzr]: https://github.com/ulzr
+[@vinhnglx]: https://github.com/vinhnglx
+[@waldyr]: https://github.com/waldyr
+[@walerian777]: https://github.com/walerian777
+[@xunker]: https://github.com/xunker
+[@zHarrowed]: https://github.com/zHarrowed
+

data/Gemfile

@@ -1,4 +1,19 @@
 # frozen_string_literal: true
 
 source 'https://rubygems.org'
+
 gemspec
+
+group :development do
+  gem 'rake', '~> 13.0'
+end
+
+group :development, :lint do
+  gem 'rubocop'
+  gem 'rubocop-performance'
+  gem 'rubocop-rake'
+end
+
+group :development, :test do
+  gem 'test-unit'
+end

data/README.md

@@ -65,7 +65,7 @@ If you want to add new modules or localization data, use one of the
 (or create a new one!).
 
 **const_missing** is
-[overriden](https://github.com/ffaker/ffaker/blob/main/lib/ffaker/utils/module_utils.rb#L9)
+[overridden](https://github.com/ffaker/ffaker/blob/main/lib/ffaker/utils/module_utils.rb#L9)
 for Faker modules, so if you try to use a constant that is not defined
 in the module, the
 [override](https://github.com/ffaker/ffaker/blob/main/lib/ffaker/utils/module_utils.rb#L9)
@@ -77,12 +77,23 @@ name will be set with data from `ffaker/data/name/first_names`.
 
 To get repeatable results in Minitest or Rspec, follow [these instructions](RANDOM.md#using-the-same-random-seed-as-your-tests).
 
-## Unique results
+## Unique values
 
-You can get unique value from any methods in FFaker like this:
+You can ensure unique values are generated using the `unique` method. `ffaker` will retry the generation
+until an unique value if found.
 
-```rb
-FFaker::Name.unique.name
+Example:
+```ruby
+FFaker::Name.unique.name # ensures an unique value is returned for FFaker::Name
+```
+
+If an unique value cannot be generated within a maximum limit of retries for a generator
+a `FFaker::UniqueUtils::RetryLimitExceeded` error will be raised.
+
+You can prevent exceeding the limit by clearing the record of used values (e.g. between tests):
+```ruby
+FFaker::Name.unique.clear # clears the used values for FFaker::Name
+FFaker::UniqueUtils.clear # clears the used values for all generators
 ```
 
 ## TODO
@@ -94,8 +105,9 @@ FFaker::Name.unique.name
 
 * Fork the project.
 * Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+   * To run all the tests: `rake test`
+   * To run a single test: `rake test TEST=test/test_lorem_br.rb`
 * Commit, do not mess with rakefile, version, or history.
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.