ffaker 2.7.0 → 2.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ddd9b72c20d0dc426b47fc5308d76c2316b7d205
-  data.tar.gz: 12ea70c65727acd2fe8b85820e34cb817df4e2d9
+SHA256:
+  metadata.gz: c192ca9da2eae4b0b7cde440c26750a269de60ff3b07dcd5c73ef3fcc11afb1b
+  data.tar.gz: a8ff030a5c7141b36fdc15c1842a13b1fca40b07f5c2883e7f53bdd83a471dd0
 SHA512:
-  metadata.gz: 62ccce417b7a2850135e4a3ca09e41d6c2e85cf1c17bbc92b0ae4ac64d209e90b02729ef79d0f41da6ca72387c140f176ff05fb719674b9b87ab323d9962405c
-  data.tar.gz: b18b3d1833a69c1b967ecea20a5e0802c37fabcbdb21b365bf58b737e4b57cd4fe4754fde36431bca1cc288d7f04ca1e45352c6f2c4c234d04d763ccfc982894
+  metadata.gz: 8a32d059e758d8bdd370cefb0e445e03db4f46bb2a0faf19b2754d3dc0faf7cbb3dabab69c3e89253fc3e09600b453c1f56ed87efd730515de53768524603372
+  data.tar.gz: 795d9c1c1c3bf9f3f38007a771463c6a46290f11445755c30ce0b712c903a729d4bf2b3048a70f5118abe12075dfbc3a1a65a3b6443056768d8bad0b95655aa4

data/Changelog.md

@@ -1,3 +1,118 @@
+## development
+
+  - Add your change HERE
+
+## 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]
+  - Add NameES (Spainsh) [@rgcamus]
+  - Fix DateTime range [@AlexWayfer]
+  - Now SSN returns valid SSN [@lilsweetcaligula]
+  - Now FFaker::Time.(date, datetime) returns Date, DateTime objects [@AlexWayfer]
+  - Now Gender.random returns non-binary genders [@kmayer]
+    - If you need binary gender use Gender.binary
+
+## 2.9.0
+  - Add orly book cover generator [@artplan1]
+  - Add LoremIE (Irish) [@mklemme]
+  - Improve FFaker::Time.between docs and implementation [@eikes]
+  - Fix patronymics for Никита [@ulzr]
+  - Add EAN generator [@jvanbaarsen]
+
+## 2.8.1
+  - Updated password generation [@makketagg]
+
+## 2.8.0
+  - Fixes `Uncaught exception: invalid byte sequence in US-ASCII` [@thilonel]
+  - Add international numbers on PhoneNumberFR and test it [@nicolas-brousse]
+  - Clean code based on PhoneNumberBR structure [@nicolas-brousse]
+  - Drop support for ruby 1.9 [@thilonel]
+  - Replace mass require with autoload [@thilonel]
+
 ## 2.7.0
   - Add unique method [@AlexAvlonitis]
   - Add Time.day_of_week [@tvarley]

data/Gemfile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 gemspec

data/RANDOM.md

@@ -0,0 +1,153 @@
+## Setting/Resetting the random seed
+
+ffaker maintains its own random number generator which allows the responses to
+be deterministic and repeatable given the correct seed.
+
+You can get the current seed with `FFaker::Random.seed`, set it with
+`FFaker::Random.seed=<seed>`, and reset it back to its initial state with
+`FFaker::Random.reset!`. You can also use `FFaker::Random.rand` to get a random
+number from the RNG.
+
+```ruby
+require 'ffaker'
+
+> FFaker::Random.seed
+# => 296167445578296242020083756344880134311
+
+> FFaker::Random.seed=12345
+# => 12345
+
+> FFaker::Random.seed
+# => 12345
+
+> 5.times.map{ FFaker::Random.rand(0..9) }
+# => [2, 5, 1, 7, 4]
+> FFaker::Random.reset!
+> 5.times.map{ FFaker::Random.rand(0..9) }
+# => [2, 5, 1, 7, 4]
+```
+
+Calling `seed=` implicitly calls `reset!` so there is no need to call it
+separately after setting the seed.
+
+### Using the same random seed as your tests
+
+If you are using Minitest or Rspec and run your tests in random order, ffaker
+can use their random seed to return the same data given the same seed.
+
+Note: ffaker can not use the random seed from Test::Unit because it [does not
+allow the random seed to be set by the user](https://github.com/test-unit/test-unit/blob/master/lib/test/unit/test-suite-creator.rb#L67-L69).
+
+#### Minitest
+
+Assuming you're already using ffaker in your tests, you will need add a "plugin"
+to make it use the same seed as Minitest. In your tests directory (usually named
+"test") make another directory named "minitest" and create a file in that
+directory named "ffaker_random_seed_plugin.rb" that contains:
+
+```ruby
+# test/minitest/ffaker_random_seed_plugin.rb
+module Minitest
+  def self.plugin_ffaker_random_seed_init(options)
+    FFaker::Random.seed = options[:seed]
+  end
+end
+```
+
+Next, you will need to add a `before_setup` method in every test file that uses
+ffaker and call `FFaker::Random.reset!` within it. Ideally this will be in your
+test case superclass.
+
+```ruby
+# test_helper.rb or similar.
+class TestBase < Minitest::Test
+  def before_setup
+    FFaker::Random.reset!
+  end
+end
+
+class TestSomethingUsingFFaker < TestBase
+  def test_something_using_ffaker
+    # use FFaker as normal
+  end
+end
+```
+
+ffaker will now use the same random seed as Minitest, including seeds passed in
+using `--seed nnn` on the command line, and will return the same data every
+time that seed is used.
+
+#### Rspec
+
+Assuming you're already using ffaker in your specs, add the following to your
+`spec_helper.rb` or equivalent file:
+
+```ruby
+# spec_helper.rb
+RSpec.configure do |config|
+  config.before(:all)  { FFaker::Random.seed=config.seed }
+  config.before(:each) { FFaker::Random.reset! }
+end
+```
+
+If your helper already has an `RSpec.configure` block, simply put the two
+"config.before" lines in that block.
+
+ffaker will now use the same random seed as Rspec, including seeds passed in
+using `--seed nnn` on the command line, and will return the same data every
+time that seed is used.
+
+### Generating random data in ffaker modules
+
+ffaker modules should use the included deterministic methods to get random data
+so that the same data can be returned with the correct random seed.  All ffaker
+modules extend the ModuleUtils module which provides the necessary methods. They
+are:
+
+  * Use `fetch_sample(array)` instead of `Array#sample` to get a random item from an array.
+  * Use `fetch_sample(array, count: n)` instead of `Array#sample(n)` to get multiple random items from an array.
+  * Use `shuffle(array)` instead of `Array#shuffle` to randomly reorder an array.
+  * Calls to `rand` will automatically use the correct random-number generator, no change is required.
+
+For other uses, you can access the random number generator directly via
+`FFaker::Random`. Example:
+
+```ruby
+array.shuffle!(random: FFaker::Random)
+```
+
+### Testing repeatability of ffaker modules
+
+There are helper methods available to use in tests to ensure your module output
+is repeatable and deterministic. All existing module tests use them, and we
+would like all future modules to also use them.
+
+First, include the DeterministicHelper in your test class:
+
+```ruby
+include DeterministicHelper
+```
+
+If your want to test methods that do not require arguments, the
+`assert_methods_are_deterministic` method will help you test many methods with
+one line of test.
+
+```ruby
+# Example: This will test the methods :method_name, :other_method_name, and
+# :another_method_name on class FFaker::NewFFakerModule.
+assert_methods_are_deterministic(
+  FFaker::NewFFakerModule,
+  :method_name, :other_method_name, :another_method_name
+)
+```
+
+For testing methods that require an argument, or to test more complicated
+behavior, you can use the `assert_deterministic` method within a test method.
+
+```ruby
+def test_some_method
+  assert_deterministic { FFaker::NewFFakerModule.some_method(:required_argument) }
+end
+```
+
+For more examples, please see the test cases for existing modules.

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`.
@@ -86,6 +100,13 @@ FFaker::Name.unique.name
   (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.