faker 2.4.0 → 2.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f048f99db924a824430ec4b564d6526df4912994e5837146e309adfa35d8a8b5
-  data.tar.gz: a6d6c98bd04fb29faaa2549e51053d882cf930dd4fae38b478e8e35230e496ab
+  metadata.gz: 76e19dcb7a0fa3703ab5ad3864a973a9bb4ce8d18ca75947ebc8300a3f29fbcb
+  data.tar.gz: 7a171e80faa3db8686d8e0f9e2d4e21f77322268161aebfbae5b58b14139a795
 SHA512:
-  metadata.gz: 6e389da23548bfd30277a61c39051a874fb1da29b4af4258b11c8327eef7a2707c5862983eecd93658331d2c89643a18a588a3f978a3de3276511a501ff2f659
-  data.tar.gz: 9028bfe72719c6f4da2653bfc17f50fac5559a1238175045b9aaad4dd86fd404b12048e5e9ba6dbe7d3ab388300b5ff8763e0c0f9984fa51d57b2c760e5c02cb
+  metadata.gz: 8f161b394abfccf7ca9122d8bc6d8957f63f8c0f9c5d3772c31ed898dfc50fb50b13b0da01289a67ff89904ec3cf4a16e514b568a9ef69a07f48e27e4e1e7da5
+  data.tar.gz: 00f2bcd1ae3821b113e1b375a1ceb0baa5657aad695f9f7fb7569f4bc74a65cacec2096535664a73f6a0840554613e7e11111dcce6d50fcc126e6c46199b930b

data/CHANGELOG.md

@@ -1,5 +1,164 @@
 # Change Log
 
+## [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-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

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