faker 2.5.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f753c6745324477819be7fa8671395eaf8d64269de47b0aaa366ab3cb0b28655
-  data.tar.gz: ccbb9fe077964f47444c76843548ff3c9272b321ec6e4c246ce66a2fe772bc7e
+  metadata.gz: fb9de0d85e1b327fa6244f79aebac217e98ebc8fa2e1c96b272052f4dae9d782
+  data.tar.gz: 5c7b79154bf09afb0219c2ba318a94ef3d4190945dff8dc2416f4f5f2a9eb6f6
 SHA512:
-  metadata.gz: a74a4e4fe1fdcafd4a09f379d3fd9955bb09c1a3bcc1ed8d996aec2d7fd7ec8cdbeb898ce536f9778dfdc55779c0b715bff3a8edd11545c5690e2a1f1e79e3b7
-  data.tar.gz: f6ede2e9b87b99c453b79dad0d2ee57b0b542a72ab8efb166a8a4aeb3c5d6308285c6d6984787542660cfb8a0d99cf5f9419a7cfc6768f74a933ea9c7d63725f
+  metadata.gz: 718fd8fc9fce389081c35e218be9cbff7525deb6b63dcfda5900ab29f594ee4e7e547207be787c2db54db9898f85af860800135ed8598fb249c29157ba4e4ce7
+  data.tar.gz: af919beb8a106738dfb753d79e689c12f0eea79c5942774f737e0a0d0f345f37c85d25e65a5071b803a2b11ecdb57e74854f3737dd2be50ca2ca3bcd0a7a03d0

data/CHANGELOG.md

@@ -1,6 +1,159 @@
 # Change Log
 
-## [v2.5.0](https://github.com/faker-ruby/faker/tree/v2.5.0) (2019-30-09)
+## [v2.9.0](https://github.com/faker-ruby/faker/tree/v2.9.0) (2019-12-16)
+
+This version:
+- adds `Faker::Gender.short_binary_type`
+- adds a few YARD docs
+- fix Faker::Educator issues
+- update locales
+
+## Bug/Fixes
+
+- [PR #1860](https://github.com/faker-ruby/faker/pull/1860) Fix Educator methods returning bad data. [@connorshea](https://github.com/connorshea)
+
+## Documentation
+
+- [PR #1859](https://github.com/faker-ruby/faker/pull/1859) YYYY-MM-DD in CHANGELOG [@jas14](https://github.com/jas14)
+- [PR #1797](https://github.com/faker-ruby/faker/pull/1797) add YARD doc for Faker::Job [@ashishra0](https://github.com/ashishra0)
+- [PR #1790](https://github.com/faker-ruby/faker/pull/1790) add Faker::Beer YARD docs [@ashishra0](https://github.com/ashishra0)
+
+## Feature Request
+
+- [PR #1863](https://github.com/faker-ruby/faker/pull/1863) Add Faker::Gender.short_binary_type [@bruno-b-martins](https://github.com/bruno-b-martins)
+
+## Update locales
+
+- [PR #1864](https://github.com/faker-ruby/faker/pull/1864) adding `male` & `female` first names for persian [@alphamarket](https://github.com/alphamarket)
+
+------------------------------------------------------------------------------
+
+## [v2.8.1](https://github.com/faker-ruby/faker/tree/v2.8.1) (2019-12-06)
+
+## Bug/Fixes
+
+- [PR #1846](https://github.com/faker-ruby/faker/pull/1846) Fix internet custom domain with suffix [@ngouy](https://github.com/ngouy)
+
+## Documentation
+
+- [PR #1852](https://github.com/faker-ruby/faker/pull/1852) Add YARD docs for Faker::Business. [@connorshea](https://github.com/connorshea)
+- [PR #1851](https://github.com/faker-ruby/faker/pull/1851) Add YARD docs for Faker::Crypto. [@connorshea](https://github.com/connorshea)
+- [PR #1850](https://github.com/faker-ruby/faker/pull/1850) Add YARD docs for Faker::Kpop. [@connorshea](https://github.com/connorshea)
+- [PR #1849](https://github.com/faker-ruby/faker/pull/1849) Add YARD docs for Faker::BossaNova. [@connorshea](https://github.com/connorshea)
+- [PR #1848](https://github.com/faker-ruby/faker/pull/1848) Add YARD Docs for Faker::Demographic. [@connorshea](https://github.com/connorshea)
+- [PR #1844](https://github.com/faker-ruby/faker/pull/1844) Fix yard doc in contribution [@vikas95prasad](https://github.com/vikas95prasad)
+- [PR #1802](https://github.com/faker-ruby/faker/pull/1802) Add YARD doc for Faker::Food [@sap1enza](https://github.com/sap1enza)
+- [PR #1766](https://github.com/faker-ruby/faker/pull/1766) Add YARD docs for Faker::Address [@connorshea](https://github.com/connorshea)
+
+## Refactoring
+
+- [PR #1847](https://github.com/faker-ruby/faker/pull/1847) Makes minor refactors on Internet.domain_name method [@tiagofsilva](https://github.com/tiagofsilva)
+- [PR #1772](https://github.com/faker-ruby/faker/pull/1848) Refactor Faker::Educator and add docs [@connorshea](https://github.com/connorshea)
+
+## Update local dependencies
+
+- Update rubocop requirement from = 0.76.0 to = 0.77.0 (#1843)
+
+------------------------------------------------------------------------------
+
+## [v2.8.0](https://github.com/faker-ruby/faker/tree/v2.8.0) (2019-12-01)
+
+## Bug/Fixes
+
+- [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-09-30)
 
 This version introduces:
 - locales for Thai language - the mother language in Thailand
@@ -34,7 +187,7 @@ The following development dependencies were updated:
 
 ------------------------------------------------------------------------------
 
-## [v2.4.0](https://github.com/faker-ruby/faker/tree/v2.4.0) (2019-19-09)
+## [v2.4.0](https://github.com/faker-ruby/faker/tree/v2.4.0) (2019-09-19)
 
 ## Documentation
 
@@ -59,7 +212,7 @@ The following development dependencies were updated:
 
 ------------------------------------------------------------------------------
 
-## [v2.3.0](https://github.com/faker-ruby/faker/tree/v2.3.0) (2019-12-09)
+## [v2.3.0](https://github.com/faker-ruby/faker/tree/v2.3.0) (2019-09-12)
 
 ## Documentation
 
@@ -78,7 +231,7 @@ The following development dependencies were updated:
 
 ------------------------------------------------------------------------------
 
-## [v2.2.2](https://github.com/faker-ruby/faker/tree/v2.2.2) (2019-05-09)
+## [v2.2.2](https://github.com/faker-ruby/faker/tree/v2.2.2) (2019-09-05)
 
 ## Bug/Fixes
 
@@ -102,7 +255,7 @@ The following development dependencies were updated:
 
 ------------------------------------------------------------------------------
 
-## [v2.2.1](https://github.com/faker-ruby/faker/tree/v2.2.1) (2019-30-08)
+## [v2.2.1](https://github.com/faker-ruby/faker/tree/v2.2.1) (2019-08-30)
 
 ## Bug/Fixes
 
@@ -112,7 +265,7 @@ The following development dependencies were updated:
 
 Fixing number with one digit caused the test_insignificant_zero to fail. As it seemed that the behavior tested by test_insignificant_zero was already covered by test_number and test_decimal, we removed it to prevent duplication.
 
-## [v2.2.0](https://github.com/faker-ruby/faker/tree/v2.2.0) (2019-25-08)
+## [v2.2.0](https://github.com/faker-ruby/faker/tree/v2.2.0) (2019-08-25)
 
 ## Deprecate
 
@@ -136,7 +289,7 @@ Add deprecation warning for positional arguments to notify users that are coming
 
 ------------------------------------------------------------------------------
 
-## [v2.1.2](https://github.com/faker-ruby/faker/tree/v2.1.2) (2019-10-08)
+## [v2.1.2](https://github.com/faker-ruby/faker/tree/v2.1.2) (2019-08-10)
 
 ## Enhancements
 
@@ -146,7 +299,7 @@ Add deprecation warning for positional arguments to notify users that are coming
 
 We had to use `bundled with 1.7.3` to avoid some issues.
 
-## [v2.1.1](https://github.com/faker-ruby/faker/tree/2.1.1) (2019-10-08)
+## [v2.1.1](https://github.com/faker-ruby/faker/tree/2.1.1) (2019-08-10)
 
 ## Bug/Fixes
 
@@ -164,7 +317,7 @@ Rollback Faker::Time changes because we should expect the date format from activ
 
 ------------------------------------------------------------------------------
 
-## [v2.1.0](https://github.com/faker-ruby/faker/tree/v2.1.0) (2019-31-07)
+## [v2.1.0](https://github.com/faker-ruby/faker/tree/v2.1.0) (2019-07-31)
 
 ## Bug/Fixes
 - [PR #1675](https://github.com/faker-ruby/faker/pull/1675) Fix off-by-one error when formatting month names [@jutonz](https://github.com/jutonz)
@@ -173,7 +326,7 @@ This change required a quick release because it's a breaking issue. Every place
 
 ------------------------------------------------------------------------------
 
-## [v2.0](https://github.com/faker-ruby/faker/tree/v2.0) (2019-31-07)
+## [v2.0](https://github.com/faker-ruby/faker/tree/v2.0) (2019-07-31)
 
 ## Important Note:
 

data/README.md

@@ -7,6 +7,7 @@
 [![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.
 
@@ -360,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/default/address.rb

@@ -5,6 +5,19 @@ module Faker
     flexible :address
 
     class << self
+      ##
+      # Produces the name of a city.
+      #
+      # @param options [Hash]
+      # @option with_state [Boolean] Whether to include the state name in the output.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Address.city #=> "Imogeneborough"
+      #   Faker::Address.city(options: { with_state: true })
+      #     #=> "Northfort, California"
+      #
+      # @faker.version 0.3.0
       def city(legacy_options = NOT_GIVEN, options: {})
         warn_for_deprecated_arguments do |keywords|
           keywords << :options if legacy_options != NOT_GIVEN
@@ -13,10 +26,29 @@ module Faker
         parse(options[:with_state] ? 'address.city_with_state' : 'address.city')
       end
 
+      ##
+      # Produces a street name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Address.street_name #=> "Larkin Fork"
+      #
+      # @faker.version 0.3.0
       def street_name
         parse('address.street_name')
       end
 
+      ##
+      # Produces a street address.
+      #
+      # @param include_secondary [Boolean] Whether or not to include the secondary address.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Address.street_address #=> "282 Kevin Brook"
+      #
+      # @faker.version 0.3.0
       def street_address(legacy_include_secondary = NOT_GIVEN, include_secondary: false)
         warn_for_deprecated_arguments do |keywords|
           keywords << :include_secondary if legacy_include_secondary != NOT_GIVEN
@@ -25,18 +57,57 @@ module Faker
         numerify(parse('address.street_address') + (include_secondary ? ' ' + secondary_address : ''))
       end
 
+      ##
+      # Produces a secondary address.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Address.secondary_address #=> "Apt. 672"
+      #
+      # @faker.version 0.3.0
       def secondary_address
         bothify(fetch('address.secondary_address'))
       end
 
+      ##
+      # Produces a building number.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Address.building_number #=> "7304"
+      #
+      # @faker.version 0.3.0
       def building_number
         bothify(fetch('address.building_number'))
       end
 
+      ##
+      # Produces the name of a community.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Address.community #=> "University Crossing"
+      #
+      # @faker.version 1.8.0
       def community
         parse('address.community')
       end
 
+      ##
+      # Produces a Zip Code.
+      #
+      # @param state_abbreviation [String] an abbreviation for a state where the zip code should be located.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Address.zip_code #=> "58517"
+      #   Faker::Address.zip_code #=> "23285-4905"
+      #   Faker::Address.zip_code(state_abbreviation: 'CO') #=> "80011"
+      #
+      # @faker.version 0.3.0
       def zip_code(legacy_state_abbreviation = NOT_GIVEN, state_abbreviation: '')
         warn_for_deprecated_arguments do |keywords|
           keywords << :state_abbreviation if legacy_state_abbreviation != NOT_GIVEN
@@ -52,6 +123,15 @@ module Faker
         bothify(fetch('address.postcode_by_state.' + state_abbreviation))
       end
 
+      ##
+      # Produces the name of a time zone.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Address.time_zone #=> "Asia/Yakutsk"
+      #
+      # @faker.version 1.2.0
       def time_zone
         fetch('address.time_zone')
       end
@@ -59,30 +139,96 @@ module Faker
       alias zip zip_code
       alias postcode zip_code
 
+      ##
+      # Produces a street suffix.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Address.street_suffix #=> "Street"
+      #
+      # @faker.version 0.3.0
       def street_suffix
         fetch('address.street_suffix')
       end
 
+      ##
+      # Produces a city suffix.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Address.city_suffix #=> "fort"
+      #
+      # @faker.version 0.3.0
       def city_suffix
         fetch('address.city_suffix')
       end
 
+      ##
+      # Produces a city prefix.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Address.city_prefix #=> "Lake"
+      #
+      # @faker.version 0.3.0
       def city_prefix
         fetch('address.city_prefix')
       end
 
+      ##
+      # Produces a state abbreviation.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Address.state_abbr #=> "AP"
+      #
+      # @faker.version 0.3.0
       def state_abbr
         fetch('address.state_abbr')
       end
 
+      ##
+      # Produces the name of a state.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Address.state #=> "California"
+      #
+      # @faker.version 0.3.0
       def state
         fetch('address.state')
       end
 
+      ##
+      # Produces the name of a country.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Address.country #=> "French Guiana"
+      #
+      # @faker.version 0.3.0
       def country
         fetch('address.country')
       end
 
+      ##
+      # Produces a country by ISO country code. See the
+      # [List of ISO 3166 country codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)
+      # on Wikipedia for a full list.
+      #
+      # @param code [String] An ISO country code.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Address.country_by_code(code: 'NL') #=> "Netherlands"
+      #
+      # @faker.version 1.9.2
       def country_by_code(legacy_code = NOT_GIVEN, code: 'US')
         warn_for_deprecated_arguments do |keywords|
           keywords << :code if legacy_code != NOT_GIVEN
@@ -91,6 +237,16 @@ module Faker
         fetch('address.country_by_code.' + code)
       end
 
+      ##
+      # Produces an ISO 3166 country code when given a country name.
+      #
+      # @param name [String] Country name in snake_case format.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Address.country_name_to_code(name: 'united_states') #=> "US"
+      #
+      # @faker.version 1.9.2
       def country_name_to_code(legacy_name = NOT_GIVEN, name: 'united_states')
         warn_for_deprecated_arguments do |keywords|
           keywords << :name if legacy_name != NOT_GIVEN
@@ -99,22 +255,68 @@ module Faker
         fetch('address.country_by_name.' + name)
       end
 
+      ##
+      # Produces an ISO 3166 country code.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Address.country_code #=> "IT"
+      #
+      # @faker.version 1.4.0
       def country_code
         fetch('address.country_code')
       end
 
+      ##
+      # Produces a long (alpha-3) ISO 3166 country code.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Address.country_code_long #=> "ITA"
+      #
+      # @faker.version 0.3.0
       def country_code_long
         fetch('address.country_code_long')
       end
 
+      ##
+      # Produces a latitude.
+      #
+      # @return [Float]
+      #
+      # @example
+      #   Faker::Address.latitude #=> -58.17256227443719
+      #
+      # @faker.version 1.0.0
       def latitude
         ((rand * 180) - 90).to_f
       end
 
+      ##
+      # Produces a longitude.
+      #
+      # @return [Float]
+      #
+      # @example
+      #   Faker::Address.longitude #=> -156.65548382095133
+      #
+      # @faker.version 1.0.0
       def longitude
         ((rand * 360) - 180).to_f
       end
 
+      ##
+      # Produces a full address.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Address.full_address
+      #     #=> "282 Kevin Brook, Imogeneborough, CA 58517"
+      #
+      # @faker.version 0.3.0
       def full_address
         parse('address.full_address')
       end