faker 1.8.7 → 2.17.0

data/lib/faker/default/markdown.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+module Faker
+  class Markdown < Base
+    class << self
+      ##
+      # Produces a random header format.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Markdown.headers #=> "##### Autem"
+      #
+      # @faker.version 1.8.0
+      def headers
+        "#{fetch('markdown.headers')} #{Lorem.word.capitalize}"
+      end
+
+      ##
+      # Produces a random emphasis formatting on a random word in two sentences.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Markdown.emphasis #=> "_Incidunt atque quis repellat id impedit.  Quas numquam quod incidunt dicta non. Blanditiis delectus laudantium atque reiciendis qui._"
+      #
+      # @faker.version 1.8.0
+      def emphasis
+        paragraph = Faker::Lorem.paragraph(sentence_count: 3)
+        words = paragraph.split(' ')
+        position = rand(0..words.length - 1)
+        formatting = fetch('markdown.emphasis')
+        words[position] = "#{formatting}#{words[position]}#{formatting}"
+        words.join(' ')
+      end
+
+      ##
+      # Produces a random ordered list of items between 1 and 10 randomly.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Markdown.ordered_list #=> "1. Qui reiciendis non consequatur atque.\n2. Quo doloremque veritatis tempora aut.\n3. Aspernatur.\n4. Ea ab.\n5. Qui.\n6. Sit pariatur nemo eveniet.\n7. Molestiae aut.\n8. Nihil molestias iure placeat.\n9. Dolore autem quisquam."
+      #
+      # @faker.version 1.8.0
+      def ordered_list
+        number = rand(1..10)
+
+        result = []
+        number.times do |i|
+          result << "#{i}. #{Faker::Lorem.sentence(word_count: 1)} \n"
+        end
+        result.join('')
+      end
+
+      ##
+      # Produces a random unordered list of items between 1 and 10 randomly.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Markdown.unordered_list #=> "* Voluptatum aliquid tempora molestiae facilis non sed.\n* Nostrum omnis iste impedit voluptatum dolor.\n* Esse quidem et facere."
+      #
+      # @faker.version 1.8.0
+      def unordered_list
+        number = rand(1..10)
+
+        result = []
+        number.times do |_i|
+          result << "* #{Faker::Lorem.sentence(word_count: 1)} \n"
+        end
+        result.join('')
+      end
+
+      ##
+      # Produces a random inline code snippet between two sentences.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Markdown.inline_code #=> "Aut eos quis suscipit. `Dignissimos voluptatem expedita qui.` Quo doloremque veritatis tempora aut."
+      #
+      # @faker.version 1.8.0
+      def inline_code
+        "`#{Faker::Lorem.sentence(word_count: 1)}`"
+      end
+
+      ##
+      # Produces a random code block formatted in Ruby.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Markdown.block_code #=> "```ruby\nEos quasi qui.\n```"
+      #
+      # @faker.version 1.8.0
+      def block_code
+        "```ruby\n#{Lorem.sentence(word_count: 1)}\n```"
+      end
+
+      ##
+      # Produces a random 3x4 table with a row of headings, a row of hyphens and two rows of data
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Markdown.table #=> "ad | similique | voluptatem\n---- | ---- | ----\ncorrupti | est | rerum\nmolestiae | quidem | et"
+      #
+      # @faker.version 1.8.0
+      def table
+        table = []
+        3.times do
+          table << "#{Lorem.word} | #{Lorem.word} | #{Lorem.word}"
+        end
+        table.insert(1, '---- | ---- | ----')
+        table.join("\n")
+      end
+
+      ##
+      # Produces a random method from the methods above, excluding the methods listed in the arguments.
+      #
+      # @overload random(methods)
+      #   @param methods [Symbol] Specify which methods to exclude.
+      #
+      # @return [String, Array<String>]
+      #
+      # @example
+      #   Faker::Markdown.random #=> returns output from a single method outlined above
+      #   Faker::Markdown.random("table") #=> returns output from any single method outlined above except for "table"
+      #   Faker::Markdown.random("ordered_list", "unordered_list") #=> returns output from any single method outlined above except for either ordered_list and unordered_list
+      #
+      # @faker.version 1.8.0
+      def random(*args)
+        method_list = available_methods
+        args&.each { |ex| method_list.delete_if { |meth| meth == ex.to_sym } }
+        send(method_list[rand(0..method_list.length - 1)])
+      end
+
+      ##
+      # Produces a simulated blog-esque text-heavy block in markdown
+      #
+      # Keyword arguments: sentences, repeat
+      # @param sentences [Integer] Specifies how many sentences make a text block.
+      # @param repeat [Integer] Specifies how many times the text block repeats.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Markdown.sandwich #=> returns newline separated content of 1 header, 1 default lorem paragraph, and 1 random markdown element
+      #   Faker::Markdown.sandwich(sentences: 5) #=> returns newline separated content of 1 header, 1 5-sentence lorem paragraph, and 1 random markdown element
+      #   Faker::Markdown.sandwich(sentences: 6, repeat: 3) #=> returns newline separated content of 1 header, and then 3 sections consisting of, here, 1 6-sentence lorem paragraph and 1 random markdown element. The random markdown element is chosen at random in each iteration of the paragraph-markdown pairing.
+      #
+      # @faker.version 1.8.0
+      def sandwich(legacy_sentences = NOT_GIVEN, legacy_repeat = NOT_GIVEN, sentences: 3, repeat: 1)
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :sentences if legacy_sentences != NOT_GIVEN
+          keywords << :repeat if legacy_repeat != NOT_GIVEN
+        end
+
+        text_block = []
+        text_block << headers
+        repeat.times do
+          text_block << Faker::Lorem.paragraph(sentence_count: sentences)
+          text_block << random
+        end
+        text_block.join("\n")
+      end
+
+      private
+
+      def available_methods
+        Markdown.public_methods(false) - Base.methods
+      end
+    end
+  end
+end

data/lib/faker/default/marketing.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Faker
+  class Marketing < Base
+    flexible :marketing
+
+    class << self
+      ##
+      # Produces the name of a video game console or platform.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Marketing.buzzwords #=> "rubber meets the road"
+      #
+      # @faker.version 1.9.4
+      def buzzwords
+        fetch('marketing.buzzwords')
+      end
+    end
+  end
+end

data/lib/faker/default/measurement.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+module Faker
+  class Measurement < Base
+    class << self
+      ALL = 'all'
+      NONE = 'none'
+
+      ##
+      # Produces a random height measurement.
+      #
+      # @param amount [Integer] Speficies the random height value.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Measurement.height #=> "6 inches"
+      #   Faker::Measurement.height(amount: 1.4) #=> "1.4 inches"
+      #   Faker::Measurement.height(amount: "none") #=> "inch"
+      #   Faker::Measurement.height(amount: "all") #=> "inches"
+      #
+      # @faker.version 1.7.3
+      def height(legacy_amount = NOT_GIVEN, amount: rand(10))
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :amount if legacy_amount != NOT_GIVEN
+        end
+
+        define_measurement_locale(amount, 'height')
+      end
+
+      ##
+      # Produces a random length measurement.
+      #
+      # @param amount [Integer] Speficies the random length value.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Measurement.length #=> "1 yard"
+      #   Faker::Measurement.length(amount: 1.4) #=> "1.4 yards"
+      #
+      # @faker.version 1.7.3
+      def length(legacy_amount = NOT_GIVEN, amount: rand(10))
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :amount if legacy_amount != NOT_GIVEN
+        end
+
+        define_measurement_locale(amount, 'length')
+      end
+
+      ##
+      # Produces a random volume measurement.
+      #
+      # @param amount [Integer] Speficies the random volume value.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Measurement.volume #=> "10 cups"
+      #   Faker::Measurement.volume(amount: 1.4) #=> "1.4 cups"
+      #
+      # @faker.version 1.7.3
+      def volume(legacy_amount = NOT_GIVEN, amount: rand(10))
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :amount if legacy_amount != NOT_GIVEN
+        end
+
+        define_measurement_locale(amount, 'volume')
+      end
+
+      ##
+      # Produces a random weight measurement.
+      #
+      # @param amount [Integer] Speficies the random weight value.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Measurement.weight #=> "3 pounds"
+      #   Faker::Measurement.weight(amount: 1.4) #=> "1.4 pounds"
+      #
+      # @faker.version 1.7.3
+      def weight(legacy_amount = NOT_GIVEN, amount: rand(10))
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :amount if legacy_amount != NOT_GIVEN
+        end
+
+        define_measurement_locale(amount, 'weight')
+      end
+
+      ##
+      # Produces a random metric height measurement.
+      #
+      # @param amount [Integer] Speficies the random height value.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Measurement.metric_height #=> "2 meters"
+      #   Faker::Measurement.metric_height(amount: 1.4) #=> "1.4 meters"
+      #
+      # @faker.version 1.7.3
+      def metric_height(legacy_amount = NOT_GIVEN, amount: rand(10))
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :amount if legacy_amount != NOT_GIVEN
+        end
+
+        define_measurement_locale(amount, 'metric_height')
+      end
+
+      ##
+      # Produces a random metric length measurement.
+      #
+      # @param amount [Integer] Speficies the random length value.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Measurement.metric_length #=> "0 decimeters"
+      #   Faker::Measurement.metric_length(amount: 1.4) #=> "1.4 decimeters"
+      #
+      # @faker.version 1.7.3
+      def metric_length(legacy_amount = NOT_GIVEN, amount: rand(10))
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :amount if legacy_amount != NOT_GIVEN
+        end
+
+        define_measurement_locale(amount, 'metric_length')
+      end
+
+      ##
+      # Produces a random metric volume measurement.
+      #
+      # @param amount [Integer] Speficies the random volume value.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Measurement.metric_volume #=> "1 liter"
+      #   Faker::Measurement.metric_volume(amount: 1.4) #=> "1.4 liters"
+      #
+      # @faker.version 1.7.3
+      def metric_volume(legacy_amount = NOT_GIVEN, amount: rand(10))
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :amount if legacy_amount != NOT_GIVEN
+        end
+
+        define_measurement_locale(amount, 'metric_volume')
+      end
+
+      ##
+      # Produces a random metric weight measurement.
+      #
+      # @param amount [Integer] Speficies the random weight value.
+      # @return [String]
+      #
+      # @example
+      #   Faker::Measurement.metric_weight #=> "8 grams"
+      #   Faker::Measurement.metric_weight(amount: 1.4) #=> "1.4 grams"
+      #
+      # @faker.version 1.7.3
+      def metric_weight(legacy_amount = NOT_GIVEN, amount: rand(10))
+        warn_for_deprecated_arguments do |keywords|
+          keywords << :amount if legacy_amount != NOT_GIVEN
+        end
+
+        define_measurement_locale(amount, 'metric_weight')
+      end
+
+      private
+
+      def check_for_plural(text, number)
+        if number && number != 1
+          make_plural(text)
+        else
+          text
+        end
+      end
+
+      def define_measurement_locale(amount, locale)
+        ensure_valid_amount(amount)
+        case amount
+        when ALL
+          make_plural(fetch("measurement.#{locale}"))
+        when NONE
+          fetch("measurement.#{locale}")
+        else
+          locale = check_for_plural(fetch("measurement.#{locale}"), amount)
+
+          "#{amount} #{locale}"
+        end
+      end
+
+      def ensure_valid_amount(amount)
+        raise ArgumentError, 'invalid amount' unless amount == NONE || amount == ALL || amount.is_a?(Integer) || amount.is_a?(Float)
+      end
+
+      def make_plural(text)
+        case text
+        when 'foot'
+          'feet'
+        when 'inch'
+          'inches'
+        when 'fluid ounce'
+          'fluid ounces'
+        when 'metric ton'
+          'metric tons'
+        else
+          "#{text}s"
+        end
+      end
+    end
+  end
+end

data/lib/faker/default/military.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Faker
+  class Military < Base
+    class << self
+      ##
+      # Produces a rank in the U.S. Army.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Military.army_rank #=> "Staff Sergeant"
+      #
+      # @faker.version 1.9.0
+      def army_rank
+        fetch('military.army_rank')
+      end
+
+      ##
+      # Produces a rank in the U.S. Marines.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Military.marines_rank #=> "Gunnery Sergeant"
+      #
+      # @faker.version 1.9.0
+      def marines_rank
+        fetch('military.marines_rank')
+      end
+
+      ##
+      # Produces a rank in the U.S. Navy.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Military.navy_rank #=> "Seaman"
+      #
+      # @faker.version 1.9.0
+      def navy_rank
+        fetch('military.navy_rank')
+      end
+
+      ##
+      # Produces a rank in the U.S. Air Force.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Military.air_force_rank #=> "Captain"
+      #
+      # @faker.version 1.9.0
+      def air_force_rank
+        fetch('military.air_force_rank')
+      end
+
+      ##
+      # Produces a rank in the U.S. Space Force.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Military.space_force_rank #=> "Senior Enlisted Advisor of the Space Force"
+      #
+      # @faker.version next
+      def space_force_rank
+        fetch('military.space_force_rank')
+      end
+
+      ##
+      # Produces a rank in the U.S. Coast Guard
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Military.coast_guard_rank #=> "Master Chief Petty Officer of the Coast Guard"
+      #
+      # @faker.version next
+      def coast_guard_rank
+        fetch('military.coast_guard_rank')
+      end
+
+      ##
+      # Produces a U.S. Department of Defense Paygrade.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Military.dod_paygrade #=> "E-6"
+      #
+      # @faker.version 1.9.0
+      def dod_paygrade
+        fetch('military.dod_paygrade')
+      end
+    end
+  end
+end