faker 1.1.2 → 3.1.1

data/lib/faker/default/address.rb

@@ -0,0 +1,348 @@
+# frozen_string_literal: true
+
+module Faker
+  class Address < Base
+    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(options: {})
+        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(include_secondary: false)
+        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 mail box number.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Address.mail_box #=> "PO Box 123"
+      #
+      # @faker.version 2.9.1
+      def mail_box
+        bothify(fetch('address.mail_box'))
+      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(state_abbreviation: '')
+        if state_abbreviation.empty?
+          letterified_string = letterify(fetch('address.postcode'))
+          return numerify(letterified_string, leading_zero: true)
+        end
+
+        # 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}"))
+      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
+
+      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(code: 'US')
+        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(name: 'united_states')
+        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
+
+      ##
+      # 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/adjective.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Faker
+  class Adjective < Base
+    flexible :adjective
+
+    class << self
+      ##
+      # Produces a positive adjective.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Adjective.positive #=> "Kind"
+      #
+      # @faker.version next
+      def positive
+        fetch('adjective.positive')
+      end
+
+      ##
+      # Produces a negative adjective.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Adjective.negative #=> "Creepy"
+      #
+      # @faker.version next
+      def negative
+        fetch('adjective.negative')
+      end
+    end
+  end
+end

data/lib/faker/default/alphanumeric.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Faker
+  class Alphanumeric < Base
+    ##
+    # List of characters allowed for alphanumeric strings
+    # @private
+    ALPHANUMS = LLetters + Numbers
+
+    class << self
+      ##
+      # Produces a random string of alphabetic characters (no digits)
+      #
+      # @param number [Integer] The length of the string to generate
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Alphanumeric.alpha(number: 10) #=> "zlvubkrwga"
+      #
+      # @faker.version 1.9.2
+      def alpha(number: 32)
+        char_count = resolve(number)
+        return '' if char_count.to_i < 1
+
+        Array.new(char_count) { sample(self::LLetters) }.join
+      end
+
+      ##
+      # Produces a random string of alphanumeric characters
+      #
+      # @param number [Integer] The number of characters to generate
+      # @param min_alpha [Integer] The minimum number of alphabetic to add to the string
+      # @param min_numeric [Integer] The minimum number of numbers to add to the string
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Alphanumeric.alphanumeric(number: 10) #=> "3yfq2phxtb"
+      # @example
+      #   Faker::Alphanumeric.alphanumeric(number: 10, min_alpha: 3) #=> "3yfq2phxtb"
+      # @example
+      #   Faker::Alphanumeric.alphanumeric(number: 10, min_alpha: 3, min_numeric: 3) #=> "3yfq2phx8b"
+      #
+      # @faker.version 2.1.3
+      def alphanumeric(number: 32, min_alpha: 0, min_numeric: 0)
+        char_count = resolve(number)
+        return '' if char_count.to_i < 1
+        raise ArgumentError, 'min_alpha must be greater than or equal to 0' if min_alpha&.negative?
+        raise ArgumentError, 'min_numeric must be greater than or equal to 0' if min_numeric&.negative?
+
+        return Array.new(char_count) { sample(ALPHANUMS) }.join if min_alpha.zero? && min_numeric.zero?
+
+        raise ArgumentError, 'min_alpha + min_numeric must be <= number' if min_alpha + min_numeric > char_count
+
+        random_count = char_count - min_alpha - min_numeric
+
+        alphas = Array.new(min_alpha) { sample(self::LLetters) }
+        numbers = Array.new(min_numeric) { sample(self::Numbers) }
+        randoms = Array.new(random_count) { sample(ALPHANUMS) }
+
+        combined = alphas + numbers + randoms
+        combined.shuffle.join
+      end
+    end
+  end
+end

data/lib/faker/default/ancient.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+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
+    end
+  end
+end

data/lib/faker/default/app.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Faker
+  class App < Base
+    class << self
+      ##
+      # Produces an app name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::App.name #=> "Treeflex"
+      #
+      # @faker.version 1.4.3
+      def name
+        fetch('app.name')
+      end
+
+      ##
+      # Produces a version string.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::App.version #=> "1.85"
+      #
+      # @faker.version 1.4.3
+      def version
+        parse('app.version')
+      end
+
+      ##
+      # Produces the name of an app's author.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::App.author #=> "Daphne Swift"
+      #
+      # @faker.version 1.4.3
+      def author
+        parse('app.author')
+      end
+
+      ##
+      # Produces a String representing a semantic version identifier.
+      #
+      # @param major [Integer, Range] An integer to use or a range to pick the integer from.
+      # @param minor [Integer, Range] An integer to use or a range to pick the integer from.
+      # @param patch [Integer, Range] An integer to use or a range to pick the integer from.
+      # @return [String]
+      #
+      # @example
+      #   Faker::App.semantic_version #=> "3.2.5"
+      # @example
+      #   Faker::App.semantic_version(major: 42) #=> "42.5.2"
+      # @example
+      #   Faker::App.semantic_version(minor: 100..101) #=> "42.100.4"
+      # @example
+      #   Faker::App.semantic_version(patch: 5..6) #=> "7.2.6"
+      #
+      # @faker.version 1.4.3
+      def semantic_version(major: 0..9, minor: 0..9, patch: 1..9)
+        [major, minor, patch].map { |chunk| sample(Array(chunk)) }.join('.')
+      end
+    end
+  end
+end

data/lib/faker/default/appliance.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Faker
+  class Appliance < Base
+    class << self
+      ##
+      # Produces the name of an appliance brand.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Appliance.brand #=> "Bosch"
+      #
+      # @faker.version 1.9.0
+      def brand
+        fetch('appliance.brand')
+      end
+
+      ##
+      # Produces the name of a type of appliance equipment.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Appliance.equipment #=> "Appliance plug"
+      #
+      # @faker.version 1.9.0
+      def equipment
+        fetch('appliance.equipment')
+      end
+    end
+  end
+end

data/lib/faker/default/artist.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Faker
+  class Artist < Base
+    class << self
+      ##
+      # Produces the name of an artist.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Artist.name #=> "Michelangelo"
+      #
+      # @faker.version 1.8.8
+      def name
+        fetch('artist.names')
+      end
+    end
+  end
+end

data/lib/faker/default/avatar.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Faker
+  class Avatar < Base
+    class << self
+      # @private
+      SUPPORTED_FORMATS = %w[png jpg bmp].freeze
+
+      ##
+      # Produces a URL for an avatar from robohash.org
+      #
+      # @param slug [String, nil]
+      # @param size [String] image size in pixels, in the format of 'AxB'
+      # @param format [String] The image file format
+      # @param set [String] The avatar set to use
+      # @param bgset [String, nil] The background set to use
+      # @return [String] A robohash.org URL
+      #
+      # @example
+      #   Faker::Avatar.image
+      #     #=> "https://robohash.org/sitsequiquia.png?size=300x300&set=set1"
+      # @example
+      #   Faker::Avatar.image(slug: "my-own-slug")
+      #     #=> "https://robohash.org/my-own-slug.png?size=300x300&set=set1"
+      # @example
+      #   Faker::Avatar.image(slug: "my-own-slug", size: "50x50")
+      #     #=> "https://robohash.org/my-own-slug.png?size=50x50&set=set1"
+      # @example
+      #   Faker::Avatar.image(slug: "my-own-slug", size: "50x50", format: "jpg")
+      #     #=> "https://robohash.org/my-own-slug.jpg?size=50x50&set=set1"
+      # @example
+      #   Faker::Avatar.image(slug: "my-own-slug", size: "50x50", format: "bmp")
+      #     #=> "https://robohash.org/my-own-slug.bmp?size=50x50&set=set1"
+      # @example
+      #   Faker::Avatar.image(slug: "my-own-slug", size: "50x50", format: "bmp", set: "set1", bgset: "bg1")
+      #     #=> "https://robohash.org/my-own-slug.bmp?size=50x50&set=set1&bgset=bg1"
+      #
+      # @faker.version 1.4.3
+      def image(slug: nil, size: '300x300', format: 'png', set: 'set1', bgset: nil)
+        raise ArgumentError, 'Size should be specified in format 300x300' unless size =~ /^[0-9]+x[0-9]+$/
+        raise ArgumentError, "Supported formats are #{SUPPORTED_FORMATS.join(', ')}" unless SUPPORTED_FORMATS.include?(format)
+
+        slug ||= Faker::Lorem.words.join
+        bgset_query = "&bgset=#{bgset}" if bgset
+        "https://robohash.org/#{slug}.#{format}?size=#{size}&set=#{set}#{bgset_query}"
+      end
+    end
+  end
+end