ffakerTW 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b0c7607607951dfd8d441b5e8ee98ed55cb69311130c8cc5e890e0fc20c87180
+  data.tar.gz: 8154e32ce1c8357b9c93a9392837c7dc5c571a1f67038d2167ffe4c3ab018305
+SHA512:
+  metadata.gz: 175e6101e737a63d96f1790615c59c66240b29b824719e55cacaa15af3dc656c769ba1af56bf69f2ebe9c62f9cd589c2eac69baef1986d7f0d2a3bbcd10d114b
+  data.tar.gz: 1699f221976cdda5b12c159815c37c21d33bea415ebf5fbe5ee0d5c1a815459a4690a19bec3fcef74cb548100fbcfdb00384f9b694f421e3c70ead60f76942d4

data/Changelog.md

@@ -0,0 +1,7 @@
+## development
+
+  - Add your change HERE
+
+## 1.0.0
+  - Clone from FFaker 2.21.0
+  - Add Traditional-Chinese like 'NameTW'

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ffakerTW.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/LICENSE

@@ -0,0 +1,17 @@
+Copyright (c) 2023 Patrick Su
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---
+
+版權所有 (c) 2023 Patrick Su
+
+特此免費授予獲得本軟件和相關文檔文件（“軟件”）副本的任何人不受限制地處理本軟件的權限，包括但不限於使用、複製、修改、合併的權利 、發布、分發、再許可和/或出售軟件的副本，並允許獲得軟件的人這樣做，但須滿足以下條件：
+
+上述版權聲明和本許可聲明應包含在本軟件的所有副本或重要部分中。
+
+本軟件“按原樣”提供，不提供任何明示或暗示的保證，包括但不限於對適銷性、特定用途的適用性和非侵權的保證。 在任何情況下，作者或版權持有人均不對任何索賠、損害或其他責任負責，無論是在合同訴訟、侵權行為還是其他方面，由軟件或軟件的使用或其他交易引起、由軟件引起或與之相關 軟件。

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

@@ -0,0 +1,31 @@
+# FfakerTW
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ffakerTW`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ffakerTW.