faker 2.15.1 → 2.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c64eb124941da11f6f02bdf234dcf3fe2b83568e1b951e97d198b458495a4956
-  data.tar.gz: 2d589426b8f0d7f7845f3e7f0f104ee0258a37a312e7400cf8a0fd3fabd2475b
+  metadata.gz: 18002d6c86949152fab3522919844331fc549e8593f46616c165a346cb210abd
+  data.tar.gz: db62f2c9507addb919ee639d6f204ca15b604d30d87beeb86cc18a6299bce381
 SHA512:
-  metadata.gz: fd8f47c75906cc93e8d45db108478fea154409e86aef1b7d33c4b25c3266c540d91b174ae4cb4e17359fc6ab148cd9751d03db574d94e8726ed0d52f611c9031
-  data.tar.gz: 4dccd79f0c6b1ed2b9fcd1c765b0276500b03f951b096d81e563cf5dddd0a28f0910c902e3de69233d17042011f41b2372957ccb80a89bf347d7567575129f63
+  metadata.gz: 8c9fd6bc54ace68f40dfd9b30618077086389a9447de27fb0ffb062715c9a531da95875ea0c50a9b5d02a7dd4105e80b58bd633aeb98da5cdeec132aba5ccc96
+  data.tar.gz: 54016385c84f11b1bb7075d60c9063ca7f02659c7ea13c5cb31b315ece710c9761317a1208b100954426f41ff1d9c133427b52e6728c44ea517e5f6f2a624b40

data/CHANGELOG.md

@@ -1,5 +1,36 @@
 # Change Log
 
+## [v2.16.0](https://github.com/faker-ruby/faker/tree/v2.16.0) (2020-02-09)
+
+## Chores
+
+- [PR #2262](https://github.com/faker-ruby/faker/pull/2262) Workaround build error for ruby-head [@koic](https://github.com/koic)
+- [PR #2257](https://github.com/faker-ruby/faker/pull/2257) Trim trailing white space throughout the project [@koic](https://github.com/koic)
+- [PR #2229](https://github.com/faker-ruby/faker/pull/2229) Use Random.new instead of `Random::DEFAULT` [@connorshea](https://github.com/connorshea)
+- [PR #2226](https://github.com/faker-ruby/faker/pull/2226) Add Ruby 3.0 to CI matrix [@connorshea](https://github.com/connorshea)
+
+## Documentation
+
+- [PR #2247](https://github.com/faker-ruby/faker/pull/2247) 2243 yard doc [@sudeeptarlekar](https://github.com/sudeeptarlekar)
+- [PR #2240](https://github.com/faker-ruby/faker/pull/2240) Updated `rock_band.md` to include example for using song generator [@jsca-kwok](https://github.com/jsca-kwok)
+- [PR #2205](https://github.com/faker-ruby/faker/pull/2205) `Faker::Mountain` doc [@bipashant](https://github.com/bipashant)
+
+## Feature Request
+
+- [PR #2221](https://github.com/faker-ruby/faker/pull/2221) Added rock band song generator [@jsca-kwok](https://github.com/jsca-kwok)
+- [PR #2208](https://github.com/faker-ruby/faker/pull/2208) Feat/add blockchain Tezos keys [@akettal](https://github.com/akettal) [@Pierre-Michard](https://github.com/Pierre-Michard)
+- [PR #2197](https://github.com/faker-ruby/faker/pull/2197) Add `Faker::Games::Touhou` [@dysnomian](https://github.com/dysnomian)
+
+## Update locales
+
+- [PR #2238](https://github.com/faker-ruby/faker/pull/2238) added some data in `fr.yml` and `football.yml` [@MathGL92](https://github.com/MathGL92)
+- [PR #2222](https://github.com/faker-ruby/faker/pull/2222) Add Japanese for `Faker::Book` [@zoshigayan](https://github.com/zoshigayan)
+- [PR #2217](https://github.com/faker-ruby/faker/pull/2217) Add Sephiroth and Northern Cave to `Faker::Games::SuperSmashBros` [@boardfish](https://github.com/boardfish)
+- [PR #2201](https://github.com/faker-ruby/faker/pull/2201) Typo in Lebowski Quote [@rgraff](https://github.com/rgraff)
+- [PR #2197](https://github.com/faker-ruby/faker/pull/2197) Add `Faker::Games::Touhou` [@dysnomian](https://github.com/dysnomian)
+
+------------------------------------------------------------------------------
+
 ## [v2.15.1](https://github.com/faker-ruby/faker/tree/v2.15.1) (2020-11-24)
 
 - Rollback PR #2169 and bump 2.15.1 [#2203](https://github.com/faker-ruby/faker/pull/2203) @vbrazo

data/History.md

@@ -33,7 +33,7 @@
 ## v1.6.0 (2015-11-23)
 * Lots of bug fixes -- most notably, a fix for email addresses and domains in non-en locales
 * Updated locales: de, en-AU, en-NZ, en-SG, en-US, en-au-ocker, en, es, fr, he, it, ja, nb-NO, pl, pt-BR, sk, and zh-CN
-* Updated classes: Address, Avatar, Book, Code, Commerce, Company, Hipster, IDNumber, Internet, Number, Placeholdit, Shakespeare, and Time 
+* Updated classes: Address, Avatar, Book, Code, Commerce, Company, Hipster, IDNumber, Internet, Number, Placeholdit, Shakespeare, and Time
 
 ## v1.5.0 (2015-08-17)
 * Added logos
@@ -83,7 +83,7 @@
 * 1 major change:
     * Removed deprecated methods from Address: earth_country, us_state, us_state_abbr, uk_postcode, uk_county
 * Many minor changes (please see github pull requests for credits)
-    * Added many localizations 
+    * Added many localizations
     * Added range and array support for Lorem
 
 ## v1.0.1 (2011-09-27)
@@ -117,7 +117,7 @@
     * Added Canadian translation [igbanam]
     * Added Norwegian translation [kytrinyx]
     * Lots of translation-related cleanup [kytrinyx]
-  
+
 
 ## v0.9.5 (2011-01-27)
 * 1 minor bug fix:
@@ -159,7 +159,7 @@
 * 3 major enhancements:
     * Added Lorem to generate fake Latin
     * Added secondary_address to Address, and made inclusion of
-    secondary address in street_address optional (false by 
+    secondary address in street_address optional (false by
     default).
     * Added UK address methods [Caius Durling]
 

data/README.md

@@ -1,4 +1,3 @@
-
 ![logotype a happy-07](https://user-images.githubusercontent.com/36028424/40263395-4318481e-5b44-11e8-92e5-3dcc1ce169b3.png)
 
 # Faker
@@ -186,6 +185,7 @@ gem 'faker', :git => 'https://github.com/faker-ruby/faker.git', :branch => 'mast
   - [Faker::Marketing](doc/default/marketing.md)
   - [Faker::Measurement](doc/default/measurement.md)
   - [Faker::Military](doc/default/military.md)
+  - [Faker::Mountain](doc/default/mountain.md)
   - [Faker::Name](doc/default/name.md)
   - [Faker::Nation](doc/default/nation.md)
   - [Faker::NatoPhoneticAlphabet](doc/default/nato_phonetic_alphabet.md)
@@ -252,6 +252,7 @@ gem 'faker', :git => 'https://github.com/faker-ruby/faker.git', :branch => 'mast
   - [Faker::Games::StreetFighter](doc/games/street_fighter.md)
   - [Faker::Games::SuperMario](doc/games/super_mario.md)
   - [Faker::Games::SuperSmashBros](doc/games/super_smash_bros.md)
+  - [Faker::Games::Touhou](doc/games/touhou.md)
   - [Faker::Games::WarhammerFantasy](doc/games/warhammer_fantasy.md)
   - [Faker::Games::Witcher](doc/games/witcher.md)
   - [Faker::Games::WorldOfWarcraft](doc/games/world_of_warcraft.md)

data/lib/faker.rb

@@ -29,7 +29,7 @@ module Faker
       end
 
       def random
-        @random || Random::DEFAULT
+        @random || Random.new
       end
     end
   end

data/lib/faker/blockchain/tezos.rb

@@ -88,6 +88,34 @@ module Faker
           encode_tz(:edsig, 64)
         end
 
+        ##
+        # Produces a random Tezos public key
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Blockchain::Tezos.public_key
+        #     #=> "edpkuib9x8QXRc5nWwHUg7U1dXsVmaUrUNU5sX9pVEEvwbMVdfMCeq"
+        #
+        # @faker.version 2.15.2
+        def public_key
+          encode_tz(:edpk, 32)
+        end
+
+        ##
+        # Produces a random Tezos public key
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Blockchain::Tezos.secret_key
+        #     #=> "edsk3HZCAGEGpzQPnQUwQeFY4ESanFhQCgLpKriQw8GHyhKCrjHawv"
+        #
+        # @faker.version 2.15.2
+        def secret_key
+          encode_tz(:edsk, 32)
+        end
+
         protected
 
         ##

data/lib/faker/default/app.rb

@@ -63,7 +63,6 @@ module Faker
       #
       # @faker.version 1.4.3
       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|
           keywords << :major if legacy_major != NOT_GIVEN
           keywords << :minor if legacy_minor != NOT_GIVEN
@@ -72,6 +71,7 @@ module Faker
 
         [major, minor, patch].map { |chunk| sample(Array(chunk)) }.join('.')
       end
+      # rubocop:enable Metrics/ParameterLists
     end
   end
 end

data/lib/faker/default/avatar.rb

@@ -39,7 +39,6 @@ module Faker
       #
       # @faker.version 1.4.3
       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|
           keywords << :slug if legacy_slug != NOT_GIVEN
           keywords << :size if legacy_size != NOT_GIVEN
@@ -55,6 +54,7 @@ module Faker
         bgset_query = "&bgset=#{bgset}" if bgset
         "https://robohash.org/#{slug}.#{format}?size=#{size}&set=#{set}#{bgset_query}"
       end
+      # rubocop:enable Metrics/ParameterLists
     end
   end
 end

data/lib/faker/default/barcode.rb

@@ -3,8 +3,9 @@
 module Faker
   class Barcode < Base
     class << self
-      ## Returns a EAN 8 or 13 digit format barcode number with check digit
-      #  @returns [String]
+      ##
+      # Returns a EAN 8 or 13 digit format barcode number with check digit
+      #  @return [String]
       #
       #  @example
       #     Faker::Barcode.ean      => "85657526"
@@ -16,8 +17,9 @@ module Faker
         generate_barcode("barcode.ean_#{Integer(length)}")
       end
 
-      ## Returns a EAN 8 or 13 digit format barcode number with composite string attached with check digit
-      #  @returns [String]
+      ##
+      # Returns a EAN 8 or 13 digit format barcode number with composite string attached with check digit
+      #  @return [String]
       #
       #  @example
       #     Faker::Barcode.ean_with_composite_sumbology      => "41007624|JHOC6649"
@@ -29,8 +31,9 @@ module Faker
         "#{ean(length)}|#{bothify(parse('barcode.composite_symbol'))}"
       end
 
-      ## Returns a UPC_A format barcode number with check digit
-      #  @returns [String]
+      ##
+      # Returns a UPC_A format barcode number with check digit
+      #  @return [String]
       #
       #  @example
       #     Faker::Barcode.upc_a      => "766807541831"
@@ -40,8 +43,9 @@ module Faker
         generate_barcode('barcode.upc_a')
       end
 
-      ## Returns a UPC_E format barcode number with check digit
-      #  @returns [String]
+      ##
+      # Returns a UPC_E format barcode number with check digit
+      #  @return [String]
       #
       #  @example
       #     Faker::Barcode.upc_e      => "03746820"
@@ -51,8 +55,9 @@ module Faker
         generate_barcode('barcode.upc_e')
       end
 
-      ## Returns a UPC_A format barcode number with composite string attached with check digit
-      #  @returns [String]
+      ##
+      # Returns a UPC_A format barcode number with composite string attached with check digit
+      #  @return [String]
       #
       #  @example
       #     Faker::Barcode.upc_a_with_composite_symbology      => "790670155765|JOVG6208"
@@ -62,8 +67,9 @@ module Faker
         "#{upc_a}|#{bothify(parse('barcode.composite_symbol'))}"
       end
 
-      ## Returns a UPC_E format barcode number with composite string attached with check digit
-      #  @returns [String]
+      ##
+      # Returns a UPC_E format barcode number with composite string attached with check digit
+      #  @return [String]
       #
       #  @example
       #     Faker::Barcode.upc_e_with_composite_symbology      => "05149247|BKZX9722"
@@ -73,8 +79,9 @@ module Faker
         "#{upc_e}|#{bothify(parse('barcode.composite_symbol'))}"
       end
 
-      ## Returns a ISBN format barcode number with check digit
-      #  @returns [String]
+      ##
+      # Returns a ISBN format barcode number with check digit
+      #  @return [String]
       #
       #  @example
       #     Faker::Barcode.isbn      => "9798363807732"
@@ -84,8 +91,9 @@ module Faker
         generate_barcode('barcode.isbn')
       end
 
-      ## Returns a ISMN format barcode number with check digit
-      #  @returns [String]
+      ##
+      # Returns a ISMN format barcode number with check digit
+      #  @return [String]
       #
       #  @example
       #     Faker::Barcode.ismn      => "9790527672897"
@@ -95,8 +103,9 @@ module Faker
         generate_barcode('barcode.ismn')
       end
 
-      ## Returns a ISSN format barcode number with check digit
-      #  @returns [String]
+      ##
+      # Returns a ISSN format barcode number with check digit
+      #  @return [String]
       #
       #  @example
       #     Faker::Barcode.issn      => "9775541703338"
@@ -114,9 +123,10 @@ module Faker
         "#{barcode}#{check_digit}"
       end
 
-      ## Returns the sum of even and odd numbers from value passed
+      ##
+      # Returns the sum of even and odd numbers from value passed
       #
-      # @returns [Array]
+      # @return [Array]
       #
       # @example
       #   Faker::Barcode.send(:sum_even_odd, 12345)   => [9, 5]
@@ -137,9 +147,10 @@ module Faker
         [sum_odd, sum_even]
       end
 
-      ## Generates the check digits from sum passed
+      ##
+      # Generates the check digits from sum passed
       #
-      # @returns [Integer]
+      # @return [Integer]
       #
       # @example
       #   Faker::Barcode.send(:generate_check_digit, 12, 4)   => 0

data/lib/faker/default/cannabis.rb

@@ -2,6 +2,7 @@
 
 module Faker
   class Cannabis < Base
+    ##
     # Produces a random strain.
     #
     # @return [String]
@@ -14,6 +15,7 @@ module Faker
       fetch('cannabis.strains')
     end
 
+    ##
     # Produces a random abbreviation.
     #
     # @return [String]
@@ -26,6 +28,7 @@ module Faker
       fetch('cannabis.cannabinoid_abbreviations')
     end
 
+    ##
     # Produces a random cannabinoid type.
     #
     # @return [String]
@@ -38,6 +41,7 @@ module Faker
       fetch('cannabis.cannabinoids')
     end
 
+    ##
     # Produces a random terpene type.
     #
     # @return [String]
@@ -50,6 +54,7 @@ module Faker
       fetch('cannabis.terpenes')
     end
 
+    ##
     # Produces a random kind of medical use.
     #
     # @return [String]
@@ -62,6 +67,7 @@ module Faker
       fetch('cannabis.medical_uses')
     end
 
+    ##
     # Produces a random health benefit.
     #
     # @return [String]
@@ -74,6 +80,7 @@ module Faker
       fetch('cannabis.health_benefits')
     end
 
+    ##
     # Produces a random category.
     #
     # @return [String]
@@ -86,6 +93,7 @@ module Faker
       fetch('cannabis.categories')
     end
 
+    ##
     # Produces a random type.
     #
     # @return [String]
@@ -98,6 +106,7 @@ module Faker
       fetch('cannabis.types')
     end
 
+    ##
     # Produces a random buzzword.
     #
     # @return [String]
@@ -110,6 +119,7 @@ module Faker
       fetch('cannabis.buzzwords')
     end
 
+    ##
     # Produces a random brand.
     #
     # @return [String]

data/lib/faker/default/chuck_norris.rb

@@ -5,6 +5,7 @@ module Faker
     flexible :chuck_norris
 
     class << self
+      ##
       # Produces a Chuck Norris Fact.
       # Original list of facts:
       # https://github.com/jenkinsci/chucknorris-plugin/blob/master/src/main/java/hudson/plugins/chucknorris/FactGenerator.java

data/lib/faker/default/code.rb

@@ -80,11 +80,11 @@ module Faker
         value << "-#{vd}"
       end
 
+      ##
+      # Produces a random NRIC (National Registry Identity Card) code.
       # By default generates a Singaporean NRIC ID for someone
       # who is born between the age of 18 and 65.
       #
-      # Produces a random NRIC (National Registry Identity Card) code.
-      #
       # @param min_age [Integer] the min age of the person in years
       # @param max_age [Integer] the max age of the person in years
       # @return [String]

data/lib/faker/default/company.rb

@@ -404,7 +404,18 @@ module Faker
         formatted ? format('%s.%s.%s/%s-%s', *number.scan(/(\d{2})(\d{3})(\d{3})(\d{4})(\d{2})/).flatten) : number
       end
 
+      ##
       # Get a random Russian tax number.
+      # @param region [String] Any region string
+      # @param type [Symbol] Legeal or not, defaults to :legal
+      #
+      # @return [String]
+      # @example
+      #   Faker::Company.russian_tax_number                             #=> "0415584064"
+      #   Faker::Company.russian_tax_number(region: 'AZ')               #=> "AZ50124562"
+      #   Faker::Company.russian_tax_number(region: 'AZ', type: false)  #=> "AZ8802315465"
+      #
+      # @faker.version 1.9.4
       def russian_tax_number(region: nil, type: :legal)
         inn_number(region, type)
       end
@@ -507,7 +518,14 @@ module Faker
       #
       # Range of regions:
       # https://ru.wikipedia.org/wiki/Коды_субъектов_Российской_Федерации
+      # region [String] Any region string
+      # @param type [Symbol] Legeal or not, defaults to :legal
       #
+      # @return [String]
+      # @example
+      #   Faker::Comnpany.russian_tax_number
+      #   Faker::Comnpany.russian_tax_number(region: 'AZ')
+      #   Faker::Comnpany.russian_tax_number(region: 'AZ', type: false)
       # rubocop:enable Style/AsciiComments
       def inn_number(region, type)
         n10 = [2, 4, 10, 3, 5, 9, 4, 6, 8]