faker 2.6.0

data/lib/faker/creature/animal.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Faker
+  class Creature
+    class Animal < Base
+      class << self
+        ##
+        # Produces a random animal name
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Animal.name #=> "fly"
+        #
+        # @faker.version 1.9.2
+        def name
+          fetch('creature.animal.name')
+        end
+      end
+    end
+  end
+end

data/lib/faker/creature/cat.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Faker
+  class Creature
+    class Cat < Base
+      flexible :cat
+
+      class << self
+        ##
+        # Produces a random name for a cat
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Cat.name #=> "Felix"
+        #
+        # @faker.version 1.9.2
+        def name
+          fetch('creature.cat.name')
+        end
+
+        ##
+        # Produces a random cat breed
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Cat.breed #=> "Scottish Fold"
+        #
+        # @faker.version 1.9.2
+        def breed
+          fetch('creature.cat.breed')
+        end
+
+        ##
+        # Produces a random cat breed registry
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Cat.registry #=> "Fancy Southern Africa Cat Council"
+        #
+        # @faker.version 1.9.2
+        def registry
+          fetch('creature.cat.registry')
+        end
+      end
+    end
+  end
+end

data/lib/faker/creature/dog.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Faker
+  class Creature
+    class Dog < Base
+      flexible :dog
+
+      class << self
+        ##
+        # Produces a random name for a dog
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Dog.name #=> "Spike"
+        #
+        # @faker.version 1.9.2
+        def name
+          fetch('creature.dog.name')
+        end
+
+        ##
+        # Produces a random dog breed
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Dog.breed #=> "Yorkshire Terrier"
+        #
+        # @faker.version 1.9.2
+        def breed
+          fetch('creature.dog.breed')
+        end
+
+        ##
+        # Produces a random sound made by a dog
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Dog.sound #=> "woof woof"
+        #
+        # @faker.version 1.9.2
+        def sound
+          fetch('creature.dog.sound')
+        end
+
+        ##
+        # Produces a random dog meme phrase
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Dog.meme_phrase #=> "smol pupperino"
+        #
+        # @faker.version 1.9.2
+        def meme_phrase
+          fetch('creature.dog.meme_phrase')
+        end
+
+        ##
+        # Produces a random dog age
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Dog.age #=> "puppy"
+        #
+        # @faker.version 1.9.2
+        def age
+          fetch('creature.dog.age')
+        end
+
+        ##
+        # Produces a random gender
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Dog.gender #=> "Female"
+        #
+        # @faker.version 1.9.2
+        def gender
+          Faker::Gender.binary_type
+        end
+
+        ##
+        # Produces a random coat length
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Dog.coat_length #=> "short"
+        #
+        # @faker.version 1.9.2
+        def coat_length
+          fetch('creature.dog.coat_length')
+        end
+
+        ##
+        # Produces a random size of a dog
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Dog.size #=> "small"
+        #
+        # @faker.version 1.9.2
+        def size
+          fetch('creature.dog.size')
+        end
+      end
+    end
+  end
+end

data/lib/faker/creature/horse.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Faker
+  class Creature
+    class Horse < Base
+      flexible :horse
+
+      class << self
+        ##
+        # Produces a random name for a horse
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Horse.name #=> "Noir"
+        #
+        # @faker.version 1.9.2
+        def name
+          fetch('creature.horse.name')
+        end
+
+        ##
+        # Produces a random horse breed
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Creature::Horse.breed #=> "Spanish Barb see Barb Horse"
+        #
+        # @faker.version 1.9.2
+        def breed
+          fetch('creature.horse.breed')
+        end
+      end
+    end
+  end
+end

data/lib/faker/default/address.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module Faker
+  class Address < Base
+    flexible :address
+
+    class << self
+      def city(legacy_options = NOT_GIVEN, options: {})
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :options if legacy_options != NOT_GIVEN
+        end
+
+        parse(options[:with_state] ? 'address.city_with_state' : 'address.city')
+      end
+
+      def street_name
+        parse('address.street_name')
+      end
+
+      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
+        end
+
+        numerify(parse('address.street_address') + (include_secondary ? ' ' + secondary_address : ''))
+      end
+
+      def secondary_address
+        bothify(fetch('address.secondary_address'))
+      end
+
+      def building_number
+        bothify(fetch('address.building_number'))
+      end
+
+      def community
+        parse('address.community')
+      end
+
+      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
+        end
+
+        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
+
+      def time_zone
+        fetch('address.time_zone')
+      end
+
+      alias zip zip_code
+      alias postcode zip_code
+
+      def street_suffix
+        fetch('address.street_suffix')
+      end
+
+      def city_suffix
+        fetch('address.city_suffix')
+      end
+
+      def city_prefix
+        fetch('address.city_prefix')
+      end
+
+      def state_abbr
+        fetch('address.state_abbr')
+      end
+
+      def state
+        fetch('address.state')
+      end
+
+      def country
+        fetch('address.country')
+      end
+
+      def country_by_code(legacy_code = NOT_GIVEN, code: 'US')
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :code if legacy_code != NOT_GIVEN
+        end
+
+        fetch('address.country_by_code.' + code)
+      end
+
+      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
+        end
+
+        fetch('address.country_by_name.' + name)
+      end
+
+      def country_code
+        fetch('address.country_code')
+      end
+
+      def country_code_long
+        fetch('address.country_code_long')
+      end
+
+      def latitude
+        ((rand * 180) - 90).to_f
+      end
+
+      def longitude
+        ((rand * 360) - 180).to_f
+      end
+
+      def full_address
+        parse('address.full_address')
+      end
+    end
+  end
+end

data/lib/faker/default/alphanumeric.rb

@@ -0,0 +1,73 @@
+# 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(legacy_number = NOT_GIVEN, number: 32)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :number if legacy_number != NOT_GIVEN
+        end
+        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(legacy_number = NOT_GIVEN, number: 32, min_alpha: 0, min_numeric: 0)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :number if legacy_number != NOT_GIVEN
+        end
+        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,23 @@
+# frozen_string_literal: true
+
+module Faker
+  class Ancient < Base
+    class << self
+      def god
+        fetch('ancient.god')
+      end
+
+      def primordial
+        fetch('ancient.primordial')
+      end
+
+      def titan
+        fetch('ancient.titan')
+      end
+
+      def hero
+        fetch('ancient.hero')
+      end
+    end
+  end
+end