faker 2.8.0 → 2.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29798f78b1587b989eb395b41be5d0851b1e8ce2ee6488d1a4291dcaca7e8713
-  data.tar.gz: 67694fb9ec2495bd11a85278962b5941326e24891fce2f9f9fb5a9baa4efa424
+  metadata.gz: 76e19dcb7a0fa3703ab5ad3864a973a9bb4ce8d18ca75947ebc8300a3f29fbcb
+  data.tar.gz: 7a171e80faa3db8686d8e0f9e2d4e21f77322268161aebfbae5b58b14139a795
 SHA512:
-  metadata.gz: 2e968a3d663d459014b85287e0e2867cbcd8198acf82efe1e342af18990aadf090ba60c3771af8d79587a2ee95e16638922993f061f1f8437e45464f5bfd7a60
-  data.tar.gz: 2a66801d474d23dfae78a6fb4c0b74b3a59f2af066b679d31ef6ad9862037151c85a429beda138d771d76d5ae3e7aa111b27ccd85e0a0fb4984c7b304fe8fe22
+  metadata.gz: 8f161b394abfccf7ca9122d8bc6d8957f63f8c0f9c5d3772c31ed898dfc50fb50b13b0da01289a67ff89904ec3cf4a16e514b568a9ef69a07f48e27e4e1e7da5
+  data.tar.gz: 00f2bcd1ae3821b113e1b375a1ceb0baa5657aad695f9f7fb7569f4bc74a65cacec2096535664a73f6a0840554613e7e11111dcce6d50fcc126e6c46199b930b

data/CHANGELOG.md

@@ -1,8 +1,36 @@
 # 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)
 
-## Bugfixes
+## Bug/Fixes
 
 - [PR #1563](https://github.com/faker-ruby/faker/pull/1563) 
 Fix generating routing number [@psienko](https://github.com/psienko)

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

data/lib/faker/default/ancient.rb

@@ -3,18 +3,54 @@
 module Faker
   class Ancient < Base
     class << self
+      ##
+      # Produces a god from ancient mythology.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Ancient.god #=> "Zeus"
+      #
+      # @faker.version 1.7.0
       def god
         fetch('ancient.god')
       end
 
+      ##
+      # Produces a primordial from ancient mythology.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Ancient.primordial #=> "Gaia"
+      #
+      # @faker.version 1.7.0
       def primordial
         fetch('ancient.primordial')
       end
 
+      ##
+      # Produces a titan from ancient mythology.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Ancient.titan #=> "Atlas"
+      #
+      # @faker.version 1.7.0
       def titan
         fetch('ancient.titan')
       end
 
+      ##
+      # Produces a hero from ancient mythology.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Ancient.hero #=> "Achilles"
+      #
+      # @faker.version 1.7.0
       def hero
         fetch('ancient.hero')
       end

data/lib/faker/default/bossa_nova.rb

@@ -3,10 +3,28 @@
 module Faker
   class BossaNova < Base
     class << self
+      ##
+      # Produces the name of a bossa nova artist.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::BossaNova.artist #=> "Tom Jobin"
+      #
+      # @faker.version 1.8.3
       def artist
         fetch('bossa_nova.artists')
       end
 
+      ##
+      # Produces a bossa nova song.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::BossaNova.song #=> "Chega de Saudade"
+      #
+      # @faker.version 1.8.3
       def song
         fetch('bossa_nova.songs')
       end

data/lib/faker/default/business.rb

@@ -7,14 +7,41 @@ module Faker
     flexible :business
 
     class << self
+      ##
+      # Produces a credit card number.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Business.credit_card_number #=> "1228-1221-1221-1431"
+      #
+      # @faker.version 1.2.0
       def credit_card_number
         fetch('business.credit_card_numbers')
       end
 
+      ##
+      # Produces a credit card expiration date.
+      #
+      # @return [Date]
+      #
+      # @example
+      #   Faker::Business.credit_card_number #=> <Date: 2015-11-11 ((2457338j,0s,0n),+0s,2299161j)>
+      #
+      # @faker.version 1.2.0
       def credit_card_expiry_date
         ::Date.today + (365 * rand(1..4))
       end
 
+      ##
+      # Produces a type of credit card.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Business.credit_card_type #=> "visa"
+      #
+      # @faker.version 1.2.0
       def credit_card_type
         fetch('business.credit_card_types')
       end