ffaker 2.10.0 → 2.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f532bea3a00e53fb51d207c8ab6475d8bf07491288e6dc0e49019584b2a1d925
-  data.tar.gz: 86d4914bdfaceb6216c585b84e716e6483c2d98f0252c09666fdbc81ddef331d
+  metadata.gz: f45921dd1eae37420883610af8fa98376812b220f8bb19d15ad418eeeaf3926b
+  data.tar.gz: 3a05c27b2457b4920993430a334534a0b41f2b92d4b5b5f99de8ab8ba4b69ca2
 SHA512:
-  metadata.gz: 92ddfa13cfff6caee03ab7c8b0209f83cb4062cfa851afcf7db8b44b2bdab88548e65b374098c35c443d7e1d91629113e6e5724284ea28e0686255d636c90557
-  data.tar.gz: 781d78136e6a5acb0de5f6c201c25e092f14a52116db2dd1bf73aaae84b04904d9cc68240483f284e45b37d22fc8e89a83517dfe41940f2cd272394fa53de9ee
+  metadata.gz: ba901db425ebad3cf7755b83ff07f81da266d63ae3370448ed473653fcdbad7b12585c5e6c2675be8f14db49e00b68fad19ceb30ea7af0147b817c02184ce1d6
+  data.tar.gz: de56b8153970b889b4a56ebec2662ef8a7eff9378a69fe4164c3cd2393f02e71b7ddcc0c396bcdd94978d6a4d2e67ce3bf65c7fcce3c6626e5733c493b24ba0a

data/Changelog.md

@@ -1,3 +1,113 @@
+## development
+
+  - Add your change HERE
+
+# 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]
+  - Make Italian Phone number deterministic [@Volosh1n]
+
+## 2.19.0
+  - Added Lorem BR [@abnersajr]
+  - Added french company siret and siren generator [@hulous]
+  - Added Games generator [@nicholaskillin]
+  - Added EditorConfig file [@AlexWayfer]
+  - Fixed loadError on scripts/reference.rb [@marocchino]
+  - Removed trailing comma from NameGA first_names_male [@stilist]
+  - Localized Gender and Sport to Russian [@SteveRedka]
+  - Added more italian data [@miscelatore]
+
+## 2.18.0
+  - Remove unneeded 'require' statements [@Volosh1n]
+  - Add PhoneNumberJA [@YutaGoto]
+  - 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]
+  - Fix issues with `FFaker::Image` module [@hmaack]
+  - Fix typo in animal.rb module [@renius]
+
+## 2.17.0
+  - Apply Rubocop's autocorrect [@marocchino]
+  - Remove Ruby-2.4 support [@marocchino]
+  - Remove OpenStruct [@Volosh1n]
+  - Fix PhoneNumberBR Area Codes [@CarlosMouraJR]
+  - More minor fixes [@marocchino]
+
+## 2.16.0
+  - Add IdentificationIN [@nigelgomesot]
+  - Improved NL zipcode generation [@gerard76]
+
+## 2.15.0
+  - Add `IdentificationTW` [@pominx]
+  - Add `CompanyJA` [@ktroutner]
+  - Add `AddressFR.region` [@GuillaumeOcculy]
+  - Add `AnimalES` [@delucas]
+  - Fix `AddressNL.postal_code` [@gerard76]
+
+## 2.14.0
+  - Add `Code.npi` [@alibby]
+
+## 2.13.0
+  - Add `Bank.card_number`, `.card_expiry_date` and `.card_type` [@AlexWayfer]
+  - Add `Bank.iban` [@Volosh1n]
+  - Add optional argument to `AddressUS.state_abbr` to determine state's abbreviation [@Volosh1n]
+  - Add `Name.pronouns` [@danderozier]
+  - Add `FFaker::ColorPL`, `FFaker::IdentificationPL`, `FFaker::SportPL` [@walerian777]
+
+## 2.12.0
+  - Add Russian Phone Numbers [@steverovsky]
+  - Remove invalid example from NameRU.first_name_male [@steverovsky]
+  - *BREAKING CHANGE*: Drop support of under 2.3  [@marocchino]
+  - Add PhoneNumberUA [@Volosh1n]
+  - Add SemVer [@marocchino]
+  - Remove some obselated prefix from PhoneNumberBR.mobile_phone_prefix
+    [@Kutomore]
+  - Add Book.iban [@Volosh1n]
+  - Add Name.pronouns [@danderozier]
+  - Add PhoneNumberRU [@steverovsky]
+
+## 2.11.0
+  - Add HealthcareRU [@gruz0]
+  - Removing potentially offensive name [@rvisuvasam]
+  - Add NameTW, PhoneNumberTW [@pominx]
+  - Add AnimalCN, EducationCN [@ckyOL]
+  - Add NameIN [@alagu]
+  - Add AnimalPL, GenderPL, GenderJP, PhoneNumberPL [@walerian777]
+  - Now PhoneNumberBR returns only valid area_code
+
 ## 2.10.0
   - Add Image [@nicolas-brousse]
   - Add LoremPL (Polish) [@walerian777]
@@ -108,21 +218,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
@@ -332,3 +427,110 @@ 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
+[@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
+[@brain64bit]: https://github.com/brain64bit
+[@brnrdog]: https://github.com/brnrdog
+[@brupla6126]: https://github.com/brupla6126
+[@ckyOL]: https://github.com/ckyOL
+[@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
+[@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

data/Gemfile

@@ -1,2 +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

@@ -1,4 +1,6 @@
-[![Build Status](https://travis-ci.org/ffaker/ffaker.svg?branch=master)](https://travis-ci.org/ffaker/ffaker) [![Code Climate](https://codeclimate.com/github/EmmanuelOga/ffaker/badges/gpa.svg)](https://codeclimate.com/github/EmmanuelOga/ffaker)
+[![Build Status](https://github.com/ffaker/ffaker/workflows/Test/badge.svg)](https://github.com/ffaker/ffaker/actions?query=workflow%3ATest)
+[![Code Climate](https://codeclimate.com/github/EmmanuelOga/ffaker/badges/gpa.svg)](https://codeclimate.com/github/EmmanuelOga/ffaker)
+[![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)
 # ffaker
 
 [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ffaker/ffaker?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
@@ -28,6 +30,18 @@ and then
 
     require 'ffaker'
 
+### Rails
+
+1. If using rails then add the gem to your development and test environments:
+
+```ruby
+group :development, :test do
+  gem 'ffaker'
+end
+```
+
+2. and then run `bundle install` in your terminal/BASH/command line.
+
 ## Why ffaker?
 
 ffaker is a fork of faker, and was initially written in an effort to speed up
@@ -47,14 +61,14 @@ Hopefully some day faker and ffaker will join forces!
 A lot of people have contributed to ffaker. Check [this list](https://github.com/ffaker/ffaker/graphs/contributors).
 
 If you want to add new modules or localization data, use one of the
-[directories for data files](https://github.com/ffaker/ffaker/tree/master/lib/ffaker/data)
+[directories for data files](https://github.com/ffaker/ffaker/tree/main/lib/ffaker/data)
 (or create a new one!).
 
 **const_missing** is
-[overriden](https://github.com/ffaker/ffaker/blob/master/lib/ffaker/utils/module_utils.rb#L9)
+[overriden](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/master/lib/ffaker/utils/module_utils.rb#L9)
+[override](https://github.com/ffaker/ffaker/blob/main/lib/ffaker/utils/module_utils.rb#L9)
 will look for a data file matching the name of the constant. E.G.: the
 first time someone accesses `FFaker::Name::FIRST_NAMES`, a const of that
 name will be set with data from `ffaker/data/name/first_names`.
@@ -63,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
@@ -80,12 +105,20 @@ 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.
 
+## Release
+
+* Bump version in `lib/version.rb`.
+* Update `Changelog.md`.
+* Tag with `v<major>.<minor>.<patch>`.
+* Push it.
+
 ## Copyright
 
 Copyright (c) 2013 Emmanuel Oga. See LICENSE for details.