faker 2.3.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bec55e97c49aba2834c60f979ddfbbba32d561b6300640059e10b74f4f64a11
-  data.tar.gz: 60197e5cfab12ef29607bfb817a86fb14db6757d3868afbc5dd2a2751412e070
+  metadata.gz: 29798f78b1587b989eb395b41be5d0851b1e8ce2ee6488d1a4291dcaca7e8713
+  data.tar.gz: 67694fb9ec2495bd11a85278962b5941326e24891fce2f9f9fb5a9baa4efa424
 SHA512:
-  metadata.gz: 6163f75344392f843e01d14ff8ddb484c40ad7b8b055a1e7a3be1cfebb972b5e5244ac4f61b424862d997bee39c4d3b61d1b605aebad6f6534e771acb32ca380
-  data.tar.gz: 93310c967dc3daa9a664d456978a636b7bc01122fbbe4a1c565206db401bfcdadee214d01c0e4b2b22be4c001cdf255de5f46762df2cb16d9f4e5fcb2c006418
+  metadata.gz: 2e968a3d663d459014b85287e0e2867cbcd8198acf82efe1e342af18990aadf090ba60c3771af8d79587a2ee95e16638922993f061f1f8437e45464f5bfd7a60
+  data.tar.gz: 2a66801d474d23dfae78a6fb4c0b74b3a59f2af066b679d31ef6ad9862037151c85a429beda138d771d76d5ae3e7aa111b27ccd85e0a0fb4984c7b304fe8fe22

data/CHANGELOG.md

@@ -1,5 +1,161 @@
 # Change Log
 
+## [v2.8.0](https://github.com/faker-ruby/faker/tree/v2.8.0) (2019-12-01)
+
+## Bugfixes
+
+- [PR #1563](https://github.com/faker-ruby/faker/pull/1563) 
+Fix generating routing number [@psienko](https://github.com/psienko)
+
+## Chores
+
+- [PR #1835](https://github.com/faker-ruby/faker/pull/1835) 
+Remove duplicate method description [@pacso](https://github.com/pacso)
+
+## Documentation
+
+- [PR #1837](https://github.com/faker-ruby/faker/pull/1837) 
+docs: Internet #email, #domain do not control TLD [@olleolleolle](https://github.com/olleolleolle)
+- [PR #1833](https://github.com/faker-ruby/faker/pull/1833) Explain safe_email method [@swrobel](https://github.com/swrobel)
+- [PR #1810](https://github.com/faker-ruby/faker/pull/1810) Add yard docs for Faker::Coffee methods [@LuanGB](https://github.com/LuanGB)
+- [PR #1803](https://github.com/faker-ruby/faker/pull/1803) 
+add YARD doc for Faker::Coin [@sap1enza](https://github.com/sap1enza) [@connorshea](https://github.com/connorshea)
+- [PR #1799](https://github.com/faker-ruby/faker/pull/1799) Remove 'See below examples' for consistency [@DevUsmanGhani](https://github.com/DevUsmanGhani)
+- [PR #1793](https://github.com/faker-ruby/faker/pull/1793) add Faker::Relationship YARD docs [@DevUsmanGhani](https://github.com/DevUsmanGhani)
+
+## Feature Request
+
+- [PR #1808](https://github.com/faker-ruby/faker/pull/1808) Adds domain option for Internet email and domain_name methods [@tiagofsilva](https://github.com/tiagofsilva)
+
+## Update locales
+
+- [PR #1841](https://github.com/faker-ruby/faker/pull/1841) 
+Fix strange result from `Lorem.word` in ja locale [@yujideveloper](https://github.com/yujideveloper)
+- [PR #1839](https://github.com/faker-ruby/faker/pull/1839) 
+added new heroes, new maps and almost all of the quotes [@TCsTheMechanic](https://github.com/TCsTheMechanic)
+
+## Update local dependencies
+
+- [PR #1831](https://github.com/faker-ruby/faker/pull/1831) Update rake requirement from = 13.0.0 to = 13.0.1 [@DevUsmanGhani](https://github.com/DevUsmanGhani) 
+
+------------------------------------------------------------------------------
+
+## [v2.7.0](https://github.com/faker-ruby/faker/tree/v2.7.0) (2019-11-01)
+
+This version:
+- adds `Faker::IDNumber.chilean_id`
+- updates some translations/locales
+- updates local dependencies
+- adds SemVer badge
+
+## Documentation
+
+- [PR #1814](https://github.com/faker-ruby/faker/pull/1814) Add Discord link [@vbrazo](https://github.com/vbrazo)
+- [PR #1289](https://github.com/faker-ruby/faker/pull/1289) Add SemVer compatibility badge to README [@greysteil](https://github.com/greysteil)
+
+## Feature Request
+
+- [PR #1819](https://github.com/faker-ruby/faker/pull/1819) Adding chilean_id in Faker::IDNumber [@cristofer](https://github.com/cristofer)
+
+## Update locales
+
+- [PR #1824](https://github.com/faker-ruby/faker/pull/1824) Added Canadian Country Code [@clinch](https://github.com/clinch)
+- [PR #1817](https://github.com/faker-ruby/faker/pull/1817) Add Japanese animal names [@shouichi](https://github.com/shouichi)
+- [PR #1816](https://github.com/faker-ruby/faker/pull/1816) Add Japanese bank names [@shouichi](https://github.com/shouichi)
+- [PR #1813](https://github.com/faker-ruby/faker/pull/1813) Translate Canadian provinces for fr-CA [@Bhacaz](https://github.com/Bhacaz)
+- [PR #1806](https://github.com/faker-ruby/faker/pull/1806) Add Terry Bogard to Super Smash Bros. options [@clinch](https://github.com/clinch)
+
+## Update local dependencies
+
+- Update rubocop requirement from = 0.75.0 to = 0.75.1 (#1811)
+- Update rubocop requirement from = 0.75.1 to = 0.76.0 (#1822)
+- Update minitest requirement from = 5.12.2 to = 5.13.0 (#1823)
+
+------------------------------------------------------------------------------
+
+## [v2.6.0](https://github.com/faker-ruby/faker/tree/v2.6.0) (2019-10-10)
+
+This version:
+- adds `Faker::Date.in_date_period`
+- adds `Faker::WorldCup` YARD docs
+- updates local dependencies
+
+## Documentation
+
+- [PR #1789](https://github.com/faker-ruby/faker/pull/1789) Faker::WorldCup YARD docs [@ashishra0](https://github.com/ashishra0)
+
+## Feature Request
+
+- [PR #1755](https://github.com/faker-ruby/faker/pull/1755) Add Faker::Date.in_date_period [@AmrAdelKhalil](https://github.com/AmrAdelKhalil)
+
+## Update local dependencies
+
+The following development dependencies were updated:
+- Update rake requirement from = 12.3.3 to = 13.0.0 (#1776)
+- Update minitest requirement from = 5.12.0 to = 5.12.2 (#1775)
+- Update test-unit requirement from = 3.3.3 to = 3.3.4 (#1774)
+
+------------------------------------------------------------------------------
+
+## [v2.5.0](https://github.com/faker-ruby/faker/tree/v2.5.0) (2019-30-09)
+
+This version introduces:
+- locales for Thai language - the mother language in Thailand
+- YARD documentation for faker interfaces
+- locales updates or fixes
+
+## Feature Request
+
+- [PR #1773](https://github.com/faker-ruby/faker/pull/1773) Two new locales added: th and en-th [@kodram](https://github.com/kodram)
+
+## Documentation
+
+- [PR #1771](https://github.com/faker-ruby/faker/pull/1771) Fix some rubocop comments that were showing up in YARD docs. [@connorshea](https://github.com/connorshea)
+- [PR #1767](https://github.com/faker-ruby/faker/pull/1767) Fix two incorrect flexible method calls. [@connorshea](https://github.com/connorshea)
+- [PR #1761](https://github.com/faker-ruby/faker/pull/1761) Add YARD docs for the Basketball and Football fakers. [@connorshea](https://github.com/connorshea)
+- [PR #1768](https://github.com/faker-ruby/faker/pull/1768) Add YARD docs for Faker::Restaurant. [@connorshea](https://github.com/connorshea)
+- [PR #1759](https://github.com/faker-ruby/faker/pull/1759) Add YARD docs for all remaining TV Shows [@connorshea](https://github.com/connorshea)
+- [PR #1758](https://github.com/faker-ruby/faker/pull/1758) Add YARD docs for Doctor Who and fix a method name. [@connorshea](https://github.com/connorshea)
+- [PR #1756](https://github.com/faker-ruby/faker/pull/1756) Add more miscellaneous YARD docs [@connorshea](https://github.com/connorshea)
+- [PR #1753](https://github.com/faker-ruby/faker/pull/1753) Add YARD docs for Date, Time, and Number [@connorshea](https://github.com/connorshea)
+
+## Update locales
+
+- [PR #1764](https://github.com/faker-ruby/faker/pull/1764) Remove "mint green" from color [@ro-savage](https://github.com/ro-savage)
+- [PR #1751](https://github.com/faker-ruby/faker/pull/1751) fix from Color.name to Color.color_name [@4geru](https://github.com/4geru)
+
+## Update local dependencies
+
+The following development dependencies were updated:
+- Update minitest requirement from = 5.11.3 to = 5.12.0 (#1763)
+
+------------------------------------------------------------------------------
+
+## [v2.4.0](https://github.com/faker-ruby/faker/tree/v2.4.0) (2019-19-09)
+
+## Documentation
+
+- [PR #1750](https://github.com/faker-ruby/faker/pull/1750) add only japanese word spec [@4geru](https://github.com/4geru)
+- [PR #1740](https://github.com/faker-ruby/faker/pull/1740) Add more YARD docs [@connorshea](https://github.com/connorshea)
+- [PR #1747](https://github.com/faker-ruby/faker/pull/1747) Fix PR links [@geniou](https://github.com/geniou)
+
+## Feature Request
+
+- [PR #1742](https://github.com/faker-ruby/faker/pull/1742) Add Faker::Blockchain::Aeternity [@2pd](https://github.com/2pd)
+
+## Update locales
+
+- [PR #1743](https://github.com/faker-ruby/faker/pull/1743) Fix another ambiguity in element_symbol field [@psibi](https://github.com/psibi)
+- [PR #1748](https://github.com/faker-ruby/faker/pull/1748) fix typo from bread to breed [@4geru](https://github.com/4geru)
+- [PR #1752](https://github.com/faker-ruby/faker/pull/1752) fix creature i18n path in japanese [@4geru](https://github.com/4geru)
+
+## Update local dependencies
+
+The following development dependencies were updated:
+- Update simplecov requirement from = 0.17.0 to = 0.17.1 (#1749)
+
+------------------------------------------------------------------------------
+
 ## [v2.3.0](https://github.com/faker-ruby/faker/tree/v2.3.0) (2019-12-09)
 
 ## Documentation
@@ -14,8 +170,8 @@
 
 ## Update locales
 
-- [PR #1732](https://github.com/faker-ruby/faker/pull/1732) Add pokemon name in Johto area [@mathieujobin](https://github.com/mathieujobin)
-- [PR #1723](https://github.com/faker-ruby/faker/pull/1723) Quebec province postal codes starts by [GHJ], adding missing two [@Ryutooooo](https://github.com/Ryutooooo)
+- [PR #1723](https://github.com/faker-ruby/faker/pull/1723) Add pokemon name in Johto area [@mathieujobin](https://github.com/mathieujobin)
+- [PR #1732](https://github.com/faker-ruby/faker/pull/1732) Quebec province postal codes starts by [GHJ], adding missing two [@Ryutooooo](https://github.com/Ryutooooo)
 
 ------------------------------------------------------------------------------
 

data/README.md

@@ -4,9 +4,10 @@
 # Faker
 [![Build Status](https://travis-ci.org/faker-ruby/faker.svg?branch=master)](https://travis-ci.org/faker-ruby/faker)
 [![Gem Version](https://badge.fury.io/rb/faker.svg)](https://badge.fury.io/rb/faker)
-[![Inline docs](http://inch-ci.org/github/stympy/faker.svg?branch=master)](http://inch-ci.org/github/stympy/faker)
+[![Inline docs](https://inch-ci.org/github/faker-ruby/faker.svg?branch=master)](https://inch-ci.org/github/faker-ruby/faker)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/ef54c7f9df86e965d64b/test_coverage)](https://codeclimate.com/github/stympy/faker/test_coverage)
 [![Maintainability](https://api.codeclimate.com/v1/badges/ef54c7f9df86e965d64b/maintainability)](https://codeclimate.com/github/stympy/faker/maintainability)
+[![SemVer compatibility](https://api.dependabot.com/badges/compatibility_score?dependency-name=faker&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=faker&package-manager=bundler&version-scheme=semver)
 
 This gem is a port of [Perl's Data::Faker library](https://metacpan.org/pod/Data::Faker) that generates fake data.
 
@@ -211,6 +212,7 @@ gem 'faker', :git => 'https://github.com/faker-ruby/faker.git', :branch => 'mast
   - [Faker::WorldCup](doc/default/world_cup.md)
 
 ### Blockchain
+  - [Faker::Blockchain::Aeternity](doc/blockchain/aeternity.md)
   - [Faker::Blockchain::Bitcoin](doc/blockchain/bitcoin.md)
   - [Faker::Blockchain::Ethereum](doc/blockchain/ethereum.md)
   - [Faker::Blockchain::Tezos](doc/blockchain/tezos.md)
@@ -359,5 +361,7 @@ See [CONTRIBUTING.md](https://github.com/stympy/faker/blob/master/CONTRIBUTING.m
 ## Contact
 Comments and feedback are welcome. Send an email to Benjamin Curtis via the [google group](http://groups.google.com/group/ruby-faker).
 
+You can also join our [discord channel](https://discord.gg/RMumTwB) to discuss anything regarding improvements or feature requests.
+
 ## License
 This code is free to use under the terms of the MIT license.

data/lib/faker/blockchain/aeternity.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Faker
+  class Blockchain
+    class Aeternity < Base
+      class << self
+        ##
+        # Produces a random Aeternity wallet address
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Blockchain::Aeternity.address
+        #     #=> "ak_zvU8YQLagjcfng7Tg8yCdiZ1rpiWNp1PBn3vtUs44utSvbJVR"
+        #
+        def address
+          'ak_' + rand_strings
+        end
+
+        ##
+        # Produces a random Aeternity transaction
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Blockchain::Aeternity.transaction
+        #     #=> "th_147nDP22h3pHrLt2qykTH4txUwQh1ccaXp"
+        #
+        def transaction
+          'th_' + rand_strings(51)
+        end
+
+        ##
+        # Produces a random Aeternity contract
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Blockchain::Aeternity.contract
+        #     #=> "ct_Hk2JsNeWGEYQEHHQCfcBeGrwbhtYSwFTPdDhW2SvjFYVojyhW"
+        #
+        def contract
+          'ct_' + rand_strings
+        end
+
+        ##
+        # Produces a random Aeternity oracle
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Blockchain::Aeternity.oracle
+        #     #=> "ok_28QDg7fkF5qiKueSdUvUBtCYPJdmMEoS73CztzXCRAwMGKHKZh"
+        #
+        def oracle
+          'ok_' + rand_strings(51)
+        end
+
+        protected
+
+        def rand_strings(length = 50)
+          hex_alphabet = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
+          var = +''
+          length.times { var << sample(shuffle(hex_alphabet.split(''))) }
+          var
+        end
+      end
+    end
+  end
+end

data/lib/faker/default/app.rb

@@ -42,6 +42,8 @@ module Faker
         parse('app.author')
       end
 
+      # rubocop:disable Metrics/ParameterLists
+
       ##
       # Produces a String representing a semantic version identifier.
       #
@@ -60,7 +62,6 @@ module Faker
       #   Faker::App.semantic_version(patch: 5..6) #=> "7.2.6"
       #
       # @faker.version 1.4.3
-      # rubocop:disable Metrics/ParameterLists
       def semantic_version(legacy_major = NOT_GIVEN, legacy_minor = NOT_GIVEN, legacy_patch = NOT_GIVEN, major: 0..9, minor: 0..9, patch: 1..9)
         # rubocop:enable Metrics/ParameterLists
         warn_for_deprecated_arguments do |keywords|

data/lib/faker/default/appliance.rb

@@ -3,10 +3,28 @@
 module Faker
   class Appliance < Base
     class << self
+      ##
+      # Produces the name of an appliance brand.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Appliance.brand #=> "Bosch"
+      #
+      # @faker.version 1.9.0
       def brand
         fetch('appliance.brand')
       end
 
+      ##
+      # Produces the name of a type of appliance equipment.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Appliance.equipment #=> "Appliance plug"
+      #
+      # @faker.version 1.9.0
       def equipment
         fetch('appliance.equipment')
       end

data/lib/faker/default/avatar.rb

@@ -6,6 +6,8 @@ module Faker
       # @private
       SUPPORTED_FORMATS = %w[png jpg bmp].freeze
 
+      # rubocop:disable Metrics/ParameterLists
+
       ##
       # Produces a URL for an avatar from robohash.org
       #
@@ -36,7 +38,6 @@ module Faker
       #     #=> "https://robohash.org/my-own-slug.bmp?size=50x50&set=set1&bgset=bg1"
       #
       # @faker.version 1.4.3
-      # rubocop:disable Metrics/ParameterLists
       def image(legacy_slug = NOT_GIVEN, legacy_size = NOT_GIVEN, legacy_format = NOT_GIVEN, legacy_set = NOT_GIVEN, legacy_bgset = NOT_GIVEN, slug: nil, size: '300x300', format: 'png', set: 'set1', bgset: nil)
         # rubocop:enable Metrics/ParameterLists
         warn_for_deprecated_arguments do |keywords|

data/lib/faker/default/bank.rb

@@ -58,8 +58,11 @@ module Faker
 
       def checksum(num_string)
         num_array = num_string.split('').map(&:to_i)
-        digit = (7 * (num_array[0] + num_array[3] + num_array[6]) + 3 * (num_array[1] + num_array[4] + num_array[7]) + 9 * (num_array[2] + num_array[5])) % 10
-        digit == num_array[8]
+        (
+          7 * (num_array[0] + num_array[3] + num_array[6]) +
+            3 * (num_array[1] + num_array[4] + num_array[7]) +
+            9 * (num_array[2] + num_array[5])
+        ) % 10
       end
 
       def compile_routing_number
@@ -85,12 +88,15 @@ module Faker
       end
 
       def valid_routing_number
-        for _ in 0..50
-          micr = compile_routing_number
+        routing_number = compile_routing_number
+        checksum = checksum(routing_number)
+        return routing_number if valid_checksum?(routing_number, checksum)
 
-          break if checksum(micr)
-        end
-        micr
+        routing_number[0..7] + checksum.to_s
+      end
+
+      def valid_checksum?(routing_number, checksum)
+        routing_number[8].to_i == checksum
       end
 
       def compile_fraction(routing_num)

data/lib/faker/default/chuck_norris.rb

@@ -2,7 +2,7 @@
 
 module Faker
   class ChuckNorris < Base
-    flexible :name
+    flexible :chuck_norris
 
     class << self
       # from: https://github.com/jenkinsci/chucknorris-plugin/blob/master/src/main/java/hudson/plugins/chucknorris/FactGenerator.java

data/lib/faker/default/coffee.rb

@@ -5,24 +5,69 @@ module Faker
     flexible :coffee
 
     class << self
+      ##
+      # Produces a random blend name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Coffee.blend_name #=> "Major Java"
+      #
+      # @faker.version 1.9.0
       def blend_name
         parse('coffee.blend_name')
       end
 
+      ##
+      # Produces a random coffee origin place.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Coffee.origin #=> "Oaxaca, Mexico"
+      #
+      # @faker.version 1.9.0
       def origin
         country = fetch('coffee.country')
         region = fetch("coffee.regions.#{search_format(country)}")
         "#{region}, #{country}"
       end
 
+      ##
+      # Produces a random coffee variety.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Coffee.variety #=> "Red Bourbon"
+      #
+      # @faker.version 1.9.0
       def variety
         fetch('coffee.variety')
       end
 
+      ##
+      # Produces a string containing a random description of a coffee's taste.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Coffee.notes #=> "dull, tea-like, cantaloupe, soy sauce, marshmallow"
+      #
+      # @faker.version 1.9.0
       def notes
         parse('coffee.notes')
       end
 
+      ##
+      # Produces a random coffee taste intensity.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Coffee.intensifier #=> "mild"
+      #
+      # @faker.version 1.9.0
       def intensifier
         fetch('coffee.intensifier')
       end