faker 2.11.0 → 2.18.0

data/lib/faker/books/lovecraft.rb

@@ -68,6 +68,7 @@ module Faker
         #
         # @param word_count [Integer] The number of words to have in the sentence
         # @param random_words_to_add [Integer]
+        # @param open_compounds_allowed [Boolean] If true, generated sentence can contain words having additional spaces
         #
         # @return [String]
         #
@@ -80,15 +81,18 @@ module Faker
         # @example
         #   Faker::Books::Lovecraft.sentence(word_count: 3, random_words_to_add: 1)
         #     #=> "Amorphous indescribable tenebrous."
+        # @example
+        #   Faker::Books::Lovecraft.sentence(word_count: 3, random_words_to_add: 0, open_compounds_allowed: true)
+        #     #=> "Effulgence unmentionable gambrel."
         #
         # @faker.version 1.9.3
-        def sentence(legacy_word_count = NOT_GIVEN, legacy_random_words_to_add = NOT_GIVEN, word_count: 4, random_words_to_add: 6)
+        def sentence(legacy_word_count = NOT_GIVEN, legacy_random_words_to_add = NOT_GIVEN, word_count: 4, random_words_to_add: 6, open_compounds_allowed: true)
           warn_for_deprecated_arguments do |keywords|
             keywords << :word_count if legacy_word_count != NOT_GIVEN
             keywords << :random_words_to_add if legacy_random_words_to_add != NOT_GIVEN
           end
 
-          words(number: word_count + rand(random_words_to_add.to_i).to_i, spaces_allowed: true).join(' ').capitalize + '.'
+          "#{words(number: word_count + rand(random_words_to_add.to_i).to_i, spaces_allowed: open_compounds_allowed).join(' ').capitalize}."
         end
 
         ##
@@ -266,9 +270,9 @@ module Faker
 
           paragraph = paragraph(sentence_count: 3)
 
-          paragraph += ' ' + paragraph(sentence_count: 3) while paragraph.length < characters
+          paragraph += " #{paragraph(sentence_count: 3)}" while paragraph.length < characters
 
-          paragraph[0...characters - 1] + '.'
+          "#{paragraph[0...characters - 1]}."
         end
       end
     end

data/lib/faker/creature/bird.rb

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+module Faker
+  class Creature
+    class Bird < Base
+      flexible :bird
+
+      class << self
+        ##
+        # Produces a random common family name of a bird.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.common_family_name #=> "Owls"
+        #
+        # @faker.version next
+        def common_family_name
+          fetch('creature.bird.common_family_name')
+        end
+
+        ##
+        # Produces a random common taxonomic order from the class Aves
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.order #=> "Passeriformes"
+        #
+        # @faker.version next
+        def order
+          orders = I18n.translate('faker.creature.bird.order_common_map').keys
+          sample(orders).to_s
+        end
+
+        ##
+        # Produces a random bird anatomy word
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.anatomy #=> "rump"
+        #
+        # @faker.version next
+        def anatomy
+          fetch('creature.bird.anatomy')
+        end
+
+        ##
+        # Produces a random, past tensed bird anatomy word
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.anatomy #=> "breasted"
+        #
+        # @faker.version next
+        def anatomy_past_tense
+          fetch('creature.bird.anatomy_past_tense')
+        end
+
+        ##
+        # Produces a random geographical word used in describing birds
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.geo #=> "Eurasian"
+        #
+        # @faker.version next
+        def geo
+          fetch('creature.bird.geo')
+        end
+
+        ##
+        # Produces a random color word used in describing birds
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.color #=> "ferruginous"
+        #
+        # @faker.version next
+        def color
+          fetch('creature.bird.colors')
+        end
+
+        ##
+        # Produces a random adjective used to described birds
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.adjective #=> 'common'
+        #
+        # @faker.version next
+        def adjective
+          fetch('creature.bird.adjectives')
+        end
+
+        ##
+        # Produces a random emotional adjective NOT used to described birds
+        # ...but could be
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.emotional_adjective #=> 'cantankerous'
+        #
+        # @faker.version next
+        def emotional_adjective
+          fetch('creature.bird.emotional_adjectives')
+        end
+
+        ##
+        # Produces a random adjective NOT used to described birds
+        # ...but probably shouldn't
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.silly_adjective #=> 'drunk'
+        #
+        # @faker.version next
+        def silly_adjective
+          fetch('creature.bird.silly_adjectives')
+        end
+
+        ##
+        # Produces a random common name for a bird
+        #
+        # @param [String | Symbol | nil] tax_order Tax
+        # @return [String]
+        # @raises TypeError If `tax_order` cannot be converted into a Symbol
+        # @raises ArgumentError If `tax_order` is not a valid taxonomic order
+        #
+        # @example
+        #   Faker::Creature::Bird.common_name #=> 'wren'
+        #
+        # @faker.version next
+        def common_name(tax_order = nil)
+          map = translate('faker.creature.bird.order_common_map')
+          if tax_order.nil?
+            sample(map.values.flatten).downcase
+          else
+            raise TypeError, 'tax_order parameter must be symbolizable' \
+              unless tax_order.respond_to?(:to_sym)
+            raise ArgumentError, "#{tax_order} is not a valid taxonomic order" \
+                                 unless map.keys.include?(tax_order.to_sym)
+
+            the_order = translate('faker.creature.bird.order_common_map')[tax_order.to_sym]
+            sample(the_order).downcase
+          end
+        end
+
+        ##
+        # Produces a random and plausible common name for a bird
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.plausible_common_name #=> 'Hellinger's Wren'
+        #
+        # @faker.version next
+        def plausible_common_name
+          parse('creature.bird.plausible_common_names').capitalize
+        end
+
+        ##
+        # Produces a random and IMplausible common name for a bird
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Bird.implausible_common_name #=> 'Hellinger's Cantankerous Chickadee'
+        #
+        # @faker.version next
+        def implausible_common_name
+          parse('creature.bird.implausible_common_names').capitalize
+        end
+
+        ##
+        # Produces a hash entry with a random order and a random common name
+        # that is of that order
+        #
+        # @return [Hash<order,common_name>]
+        #
+        # @example
+        #  Faker::Creature::Bird.order_with_common_name #=> {
+        #    order: ''Accipitriformes',
+        #    common_name: 'Osprey'
+        # }
+        #
+        # @faker.version next
+        def order_with_common_name(tax_order = nil)
+          map = I18n.translate('faker.creature.bird.order_common_map')
+          o = tax_order.nil? ? order : tax_order
+          { order: o, common_name: sample(map[o.to_sym]) }
+        end
+      end
+    end
+  end
+end

data/lib/faker/default/address.rb

@@ -54,7 +54,7 @@ module Faker
           keywords << :include_secondary if legacy_include_secondary != NOT_GIVEN
         end
 
-        numerify(parse('address.street_address') + (include_secondary ? ' ' + secondary_address : ''))
+        numerify(parse('address.street_address') + (include_secondary ? " #{secondary_address}" : ''))
       end
 
       ##
@@ -102,7 +102,7 @@ module Faker
       # @return [String]
       #
       # @example
-      # Faker::Address.mail_box #=> "PO Box 123"
+      #   Faker::Address.mail_box #=> "PO Box 123"
       #
       # @faker.version 2.9.1
       def mail_box
@@ -133,7 +133,7 @@ module Faker
 
         # provide a zip code that is valid for the state provided
         # see http://www.fincen.gov/forms/files/us_state_territory_zip_codes.pdf
-        bothify(fetch('address.postcode_by_state.' + state_abbreviation))
+        bothify(fetch("address.postcode_by_state.#{state_abbreviation}"))
       end
 
       ##
@@ -247,7 +247,7 @@ module Faker
           keywords << :code if legacy_code != NOT_GIVEN
         end
 
-        fetch('address.country_by_code.' + code)
+        fetch("address.country_by_code.#{code}")
       end
 
       ##
@@ -265,7 +265,7 @@ module Faker
           keywords << :name if legacy_name != NOT_GIVEN
         end
 
-        fetch('address.country_by_name.' + name)
+        fetch("address.country_by_name.#{name}")
       end
 
       ##
@@ -333,6 +333,36 @@ module Faker
       def full_address
         parse('address.full_address')
       end
+
+      ##
+      # Produces Address hash of required fields
+      #
+      # @return [Hash]
+      #
+      # @example
+      #   Faker::Address.full_address_as_hash(:longitude,
+      #                                       :latitude,
+      #                                       :country_name_to_code,
+      #                                       country_name_to_code: {name: 'united_states'})
+      #     #=> {:longitude=>-101.74428917174603, :latitude=>-37.40056749089944, :country_name_to_code=>"US"}
+      #
+      #  Faker::Address.full_address_as_hash(:full_address)
+      #     #=> {:full_address=>"87635 Rice Street, Lake Brentonton, OR 61896-5968"}
+      #
+      #  Faker::Address.full_address_as_hash(:city, :time_zone)
+      #     #=> {:city=>"East Faustina", :time_zone=>"America/Mexico_City"}
+      #
+      #  Faker::Address.full_address_as_hash(:street_address, street_address: {include_secondary: true})
+      #     #=> {:street_address=>"29423 Kenneth Causeway Suite 563"}
+      #
+      # @faker.version 2.13.0
+      def full_address_as_hash(*attrs, **attrs_params)
+        attrs.map!(&:to_sym)
+        attrs_params.transform_keys!(&:to_sym)
+        attrs.map do |attr|
+          { "#{attr}": attrs_params[attr] ? send(attr, **attrs_params[attr]) : send(attr) }
+        end.reduce({}, :merge)
+      end
     end
   end
 end

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/bank.rb

@@ -5,6 +5,17 @@ module Faker
     flexible :bank
 
     class << self
+      ##
+      # Produces a bank account number.
+      #
+      # @param digits [Integer] Number of digits that the generated account number should have.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Bank.account_number #=> 6738582379
+      #   Faker::Bank.account_number(digits: 13) #=> 673858237902
+      #
+      # @faker.version 1.9.1
       def account_number(legacy_digits = NOT_GIVEN, digits: 10)
         warn_for_deprecated_arguments do |keywords|
           keywords << :digits if legacy_digits != NOT_GIVEN
@@ -17,6 +28,18 @@ module Faker
         output[0...digits]
       end
 
+      ##
+      # Produces a bank iban number.
+      #
+      # @param country_code [String, nil] Specifies what country prefix is used to generate the iban code. Providing `nil` will use a random country.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Bank.iban #=> "GB76DZJM33188515981979"
+      #   Faker::Bank.iban(country_code: "be") #=> "BE6375388567752043"
+      #   Faker::Bank.iban(country_code: nil) #=> "DE45186738071857270067"
+      #
+      # @faker.version 1.7.0
       def iban(legacy_country_code = NOT_GIVEN, country_code: 'GB')
         # Each country has its own format for bank accounts
         # Many of them use letters in certain parts of the account
@@ -25,6 +48,8 @@ module Faker
           keywords << :country_code if legacy_country_code != NOT_GIVEN
         end
 
+        country_code ||= iban_country_code
+
         begin
           pattern = fetch("bank.iban_details.#{country_code.downcase}.bban_pattern")
         rescue I18n::MissingTranslationData
@@ -38,22 +63,85 @@ module Faker
         country_code.upcase + iban_checksum(country_code, account) + account
       end
 
+      ##
+      # Produces the ISO 3166 code of a country that uses the IBAN system.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Bank.iban_country_code #=> "CH"
+      #
+      # @faker.version next
+      def iban_country_code
+        sample(translate('faker.bank.iban_details').keys).to_s.upcase
+      end
+
+      ##
+      # Produces a bank name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Bank.name #=> "ABN AMRO CORPORATE FINANCE LIMITED"
+      #
+      # @faker.version 1.7.0
       def name
         fetch('bank.name')
       end
 
+      ##
+      # Produces a routing number.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Bank.routing_number #=> "729343831"
+      #
+      # @faker.version 1.9.1
       def routing_number
         valid_routing_number
       end
 
+      ##
+      # Produces a valid routing number.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Bank.routing_number #=> "729343831"
+      #
+      # @faker.version 1.9.1
       def routing_number_with_format
         compile_fraction(valid_routing_number)
       end
 
+      ##
+      # Produces a swift / bic number.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Bank.swift_bic #=> "AAFMGB21"
+      #
+      # @faker.version 1.7.0
       def swift_bic
         fetch('bank.swift_bic')
       end
 
+      ##
+      # Produces an Australian BSB (Bank-State-Branch) number
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Bank.bsb_number
+      #     #=> "036616"
+      #
+      # @faker.version 2.13.0
+      def bsb_number
+        compile_bsb_number
+      end
+
       private
 
       def checksum(num_string)
@@ -68,8 +156,13 @@ module Faker
       def compile_routing_number
         digit_one_two = %w[00 01 02 03 04 05 06 07 08 09 10 11 12]
         ((21..32).to_a + (61..72).to_a + [80]).each { |x| digit_one_two << x.to_s }
-        routing_num = digit_one_two.sample + rand_numstring + rand_numstring + rand_numstring + rand_numstring + rand_numstring + rand_numstring + rand_numstring
-        routing_num
+        digit_one_two.sample + rand_numstring + rand_numstring + rand_numstring + rand_numstring + rand_numstring + rand_numstring + rand_numstring
+      end
+
+      def compile_bsb_number
+        digit_one_two = %w[01 03 06 08 11 12 73 76 78 30]
+        state = (2..7).to_a.map(&:to_s).sample
+        digit_one_two.sample + state + rand_numstring + rand_numstring + rand_numstring
       end
 
       # Calculates the mandatory checksum in 3rd and 4th characters in IBAN format
@@ -103,7 +196,7 @@ module Faker
         prefix = (1..50).to_a.map(&:to_s).sample
         numerator = routing_num.split('')[5..8].join.to_i.to_s
         denominator = routing_num.split('')[0..4].join.to_i.to_s
-        prefix + '-' + numerator + '/' + denominator
+        "#{prefix}-#{numerator}/#{denominator}"
       end
 
       def rand_numstring