faker 2.15.1 → 3.4.2

data/lib/faker/default/science.rb

@@ -3,6 +3,47 @@
 module Faker
   class Science < Base
     class << self
+      BRANCHES = {
+        empirical: %i[empirical_natural_basic empirical_natural_applied empirical_social_basic empirical_social_applied],
+        formal: %i[formal_basic formal_applied],
+        natural: %i[empirical_natural_basic empirical_natural_applied],
+        social: %i[empirical_social_basic empirical_social_applied],
+        basic: %i[empirical_natural_basic empirical_social_basic formal_basic],
+        applied: %i[empirical_natural_applied empirical_social_applied formal_applied]
+      }.freeze
+
+      ##
+      # Produces a name of a science
+      # You can optionally filter by specifying one or more of the following:
+      # `:empirical, :formal, :natural, :social, :basic, :applied`
+      # @see https://en.wikipedia.org/wiki/Science#Branches_of_science
+      # @see Faker::Educator.subject
+      #
+      # @param branches [Array<Symbol>]
+      # @return [String]
+      #
+      # @example
+      #   Faker::Science.science #=> "Space science"
+      #   Faker::Science.science(:natural, :applied) #=> "Engineering"
+      #   Faker::Science.science(:formal, :applied) #=> "Computer Science"
+      #
+      # @faker.version next
+      def science(*branches)
+        selected = BRANCHES.values.flatten.uniq
+        branches.each do |branch|
+          selected &= BRANCHES[branch] if BRANCHES.key? branch
+        end
+
+        raise ArgumentError, 'Filters do not match any sciences' if selected.empty?
+
+        sciences = []
+        selected.each do |branch|
+          sciences += translate("faker.science.branch.#{branch}")
+        end
+
+        sample(sciences)
+      end
+
       ##
       # Produces the name of a element.
       #
@@ -29,6 +70,32 @@ module Faker
         fetch('science.element_symbol')
       end
 
+      ##
+      # Produces the state of an element.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Science.element_state #=> "Liquid"
+      #
+      # @faker.version next
+      def element_state
+        fetch('science.element_state')
+      end
+
+      ##
+      # Produces the subcategory of an element.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Science.element_subcategory #=> "Reactive nonmetal"
+      #
+      # @faker.version next
+      def element_subcategory
+        fetch('science.element_subcategory')
+      end
+
       ##
       # Produces the name of a scientist.
       #
@@ -41,6 +108,47 @@ module Faker
       def scientist
         fetch('science.scientist')
       end
+
+      ##
+      # Produces a scientifically sounding word
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::Science.modifier #=> "Quantum"
+      #   Faker::Science.modifier #=> "Superconductive"
+      #
+      # @faker.version next
+      def modifier
+        fetch('science.modifier')
+      end
+
+      ##
+      # Produces the name of a scientific tool.
+      # By default it uses a science word modifier to generate more diverse data, which can be disabled.
+      #
+      # @param simple [Boolean] Whether to generate simple realistic tool names, (no Q-word).
+      # @return [String]
+      #
+      # @example
+      #   Faker::Science.tool #=> "Superconductive Microcentrifuge"
+      #   Faker::Science.tool #=> "Portable Cryostat"
+      #   Faker::Science.tool #=> "Quantum Spectrophotometer"
+      #   Faker::Science.tool(simple: true) #=> "Microcentrifuge"
+      #
+      # @faker.version next
+      def tool(simple: false)
+        tool = fetch('science.tool')
+        return tool if simple
+
+        # Makes sure the modifier are different
+        loop do
+          modifier = self.modifier
+          break unless tool.start_with?(modifier)
+        end
+
+        "#{modifier} #{tool}"
+      end
     end
   end
 end

data/lib/faker/default/source.rb

@@ -17,11 +17,7 @@ module Faker
       #     #=> "alert('Hello World!');"
       #
       # @faker.version 1.9.0
-      def hello_world(legacy_lang = NOT_GIVEN, lang: :ruby)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :lang if legacy_lang != NOT_GIVEN
-        end
-
+      def hello_world(lang: :ruby)
         fetch("source.hello_world.#{lang}")
       end
 
@@ -39,13 +35,7 @@ module Faker
       #     #=> "console.log('foo bar');"
       #
       # @faker.version 1.9.0
-      def print(legacy_str = NOT_GIVEN, legacy_lang = NOT_GIVEN, str: 'some string', lang: :ruby)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :str if legacy_str != NOT_GIVEN
-        end
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :lang if legacy_lang != NOT_GIVEN
-        end
+      def print(str: 'some string', lang: :ruby)
         code = fetch("source.print.#{lang}")
         code.gsub('faker_string_to_print', str)
       end
@@ -65,10 +55,7 @@ module Faker
       #   #    }"
       #
       # @faker.version 1.9.0
-      def print_1_to_10(legacy_lang = NOT_GIVEN, lang: :ruby)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :lang if legacy_lang != NOT_GIVEN
-        end
+      def print_1_to_10(lang: :ruby)
         fetch("source.print_1_to_10.#{lang}")
       end
     end

data/lib/faker/default/south_africa.rb

@@ -13,7 +13,7 @@ module Faker
       #
       # @faker.version 1.9.2
       def id_number
-        Faker::IDNumber.south_african_id_number
+        Faker::IdNumber.south_african_id_number
       end
 
       ##
@@ -26,7 +26,7 @@ module Faker
       #
       # @faker.version 1.9.2
       def valid_id_number
-        Faker::IDNumber.valid_south_african_id_number
+        Faker::IdNumber.valid_south_african_id_number
       end
 
       ##
@@ -39,7 +39,7 @@ module Faker
       #
       # @faker.version 1.9.2
       def invalid_id_number
-        Faker::IDNumber.invalid_south_african_id_number
+        Faker::IdNumber.invalid_south_african_id_number
       end
 
       ##

data/lib/faker/default/string.rb

@@ -10,20 +10,14 @@ module Faker
       # @return [String]
       #
       # @example
-      #   rubocop:disable Style/AsciiComments
       #   Faker::String.random #=> "3 뇦\u0017&y\u{3A109}$8^4* 녹豿4좘툢ꔾ쉙6ɉ\uA6 8TN畀챵|\"3쇤Ŵ"
       #   Faker::String.random(length: 4) #=> "⼨%0*"
       #   Faker::String.random(length: 3..12) #=> "\u{69FDC};秨툫"
       #   Faker::String.random(length: [0, 6]) #=> "I轤𣴒P溟L"
       #   Faker::String.random(length: [1, (2..5), [3, 6], nil]) #=> "葓L#ћ"
-      #   rubocop:enable Style/AsciiComments
       #
       # @faker.version 1.9.0
-      def random(legacy_length = NOT_GIVEN, length: 32)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :length if legacy_length != NOT_GIVEN
-        end
-
+      def random(length: 32)
         utf8string select_a length
       end
 

data/lib/faker/default/stripe.rb

@@ -14,11 +14,7 @@ module Faker
       #   Faker::Stripe.valid_card(card_type: "visa_debit") #=> "4000056655665556"
       #
       # @faker.version 1.9.0
-      def valid_card(legacy_card_type = NOT_GIVEN, card_type: nil)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :card_type if legacy_card_type != NOT_GIVEN
-        end
-
+      def valid_card(card_type: nil)
         valid_cards = translate('faker.stripe.valid_cards').keys
 
         if card_type.nil?
@@ -44,11 +40,7 @@ module Faker
       #   Faker::Stripe.valid_token(card_type: "mc_debit") #=> "tok_mastercard_debit"
       #
       # @faker.version 1.9.0
-      def valid_token(legacy_card_type = NOT_GIVEN, card_type: nil)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :card_type if legacy_card_type != NOT_GIVEN
-        end
-
+      def valid_token(card_type: nil)
         valid_tokens = translate('faker.stripe.valid_tokens').keys
 
         if card_type.nil?
@@ -73,11 +65,7 @@ module Faker
       #   Faker::Stripe.invalid_card(card_error: "addressZipFail") #=> "4000000000000010"
       #
       # @faker.version 1.9.0
-      def invalid_card(legacy_card_error = NOT_GIVEN, card_error: nil)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :card_error if legacy_card_error != NOT_GIVEN
-        end
-
+      def invalid_card(card_error: nil)
         invalid_cards = translate('faker.stripe.invalid_cards').keys
 
         if card_error.nil?
@@ -130,11 +118,7 @@ module Faker
       #   Faker::Stripe.ccv(card_type: "amex") #=> "1234"
       #
       # @faker.version 1.9.0
-      def ccv(legacy_card_type = NOT_GIVEN, card_type: nil)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :card_type if legacy_card_type != NOT_GIVEN
-        end
-
+      def ccv(card_type: nil)
         (card_type.to_s == 'amex' ? rand_in_range(1000, 9999) : rand_in_range(100, 999)).to_s
       end
     end

data/lib/faker/default/tea.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Faker
+  class Tea < Base
+    flexible :tea
+
+    class << self
+      ##
+      # Produces a random variety or blend of tea.
+      #
+      # @param type [String, nil] the type of tea to query for (valid types: 'Black', 'Green', 'Oolong', 'White', and 'Herbal')
+      # @return [String] a variety of tea
+      #
+      # @example
+      #   Faker::Tea.variety
+      #     #=> "Earl Grey"
+      #
+      # @example
+      #   Faker::Tea.variety(type: 'Green')
+      #     #=> "Jasmine"
+      # @faker.version next
+      def variety(type: nil)
+        type ||= fetch('tea.type')
+        fetch "tea.variety.#{type.downcase}"
+      end
+
+      ##
+      # Produces a random type of tea.
+      #
+      # @return [String] a type of tea
+      #
+      # @example
+      #   Faker::Tea.type
+      #     #=> "Green"
+      # @faker.version next
+      def type
+        fetch 'tea.type'
+      end
+    end
+  end
+end

data/lib/faker/{music/show.rb → default/theater.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Faker
-  class Show < Base
+  class Theater < Base
     class << self
       ##
       # Produces the name of a musical for an older audience
@@ -9,12 +9,12 @@ module Faker
       # @return [String]
       #
       # @example
-      #   Faker::Alphanumeric.alpha
-      #     #=> "West Side Story"
+      #   Faker::Theater.adult_musical
+      #     #=> "Mamma Mia!"
       #
       # @faker.version 2.13.0
       def adult_musical
-        fetch('show.adult_musical')
+        fetch('theater.adult_musical')
       end
 
       ##
@@ -23,12 +23,12 @@ module Faker
       # @return [String]
       #
       # @example
-      #   Faker::Alphanumeric.alpha
+      #   Faker::Theater.kids_musical
       #     #=> "Into the Woods JR."
       #
       # @faker.version 2.13.0
       def kids_musical
-        fetch('show.kids_musical')
+        fetch('theater.kids_musical')
       end
 
       ##
@@ -37,13 +37,16 @@ module Faker
       # @return [String]
       #
       # @example
-      #   Faker::Alphanumeric.alpha
+      #   Faker::Theater.play
       #     #=> "Death of a Salesman"
       #
       # @faker.version 2.13.0
       def play
-        fetch('show.play')
+        fetch('theater.play')
       end
     end
   end
+
+  include Faker::Deprecator
+  deprecate_generator('Show', Theater)
 end

data/lib/faker/default/time.rb

@@ -13,9 +13,6 @@ module Faker
     }.freeze
 
     class << self
-      # rubocop:disable Metrics/ParameterLists
-      # rubocop:disable Style/AsciiComments
-
       ##
       # Produce a random time between two times.
       #
@@ -38,20 +35,13 @@ module Faker
       #   Faker::Time.between(from: DateTime.now - 1, to: DateTime.now, format: :long) #=> "2018年10月16日(火) 10時48分27秒 -0500"
       #
       # @faker.version 1.5.0
-      def between(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, legacy_format = NOT_GIVEN, from:, to:, format: nil)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :from if legacy_from != NOT_GIVEN
-          keywords << :to if legacy_to != NOT_GIVEN
-          keywords << :format if legacy_format != NOT_GIVEN
-        end
-
+      def between(from:, to:, format: nil)
         from = get_time_object(from)
         to = get_time_object(to)
 
         time = Faker::Base.rand_in_range(from, to)
         time_with_format(time, format)
       end
-      # rubocop:enable Style/AsciiComments
 
       ##
       # Produce a random time between two dates.
@@ -81,14 +71,7 @@ module Faker
       #     #=> "Fri, 19 Oct 2018 15:17:46 -0500"
       #
       # @faker.version 1.0.0
-      def between_dates(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, legacy_period = NOT_GIVEN, legacy_format = NOT_GIVEN, from:, to:, period: :all, format: nil)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :from if legacy_from != NOT_GIVEN
-          keywords << :to if legacy_to != NOT_GIVEN
-          keywords << :period if legacy_period != NOT_GIVEN
-          keywords << :format if legacy_format != NOT_GIVEN
-        end
-
+      def between_dates(from:, to:, period: :all, format: nil)
         date = Faker::Date.between(from: from, to: to)
         time = date_with_random_time(date, period)
         time_with_format(time, format)
@@ -109,13 +92,7 @@ module Faker
       #     #=> "October 21, 2018 20:47"
       #
       # @faker.version 1.5.0
-      def forward(legacy_days = NOT_GIVEN, legacy_period = NOT_GIVEN, legacy_format = NOT_GIVEN, days: 365, period: :all, format: nil)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :days if legacy_days != NOT_GIVEN
-          keywords << :period if legacy_period != NOT_GIVEN
-          keywords << :format if legacy_format != NOT_GIVEN
-        end
-
+      def forward(days: 365, period: :all, format: nil)
         time_with_format(date_with_random_time(Faker::Date.forward(days: days), period), format)
       end
 
@@ -134,16 +111,9 @@ module Faker
       #     #=> "14 Oct 07:44"
       #
       # @faker.version 1.5.0
-      def backward(legacy_days = NOT_GIVEN, legacy_period = NOT_GIVEN, legacy_format = NOT_GIVEN, days: 365, period: :all, format: nil)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :days if legacy_days != NOT_GIVEN
-          keywords << :period if legacy_period != NOT_GIVEN
-          keywords << :format if legacy_format != NOT_GIVEN
-        end
-
+      def backward(days: 365, period: :all, format: nil)
         time_with_format(date_with_random_time(Faker::Date.backward(days: days), period), format)
       end
-      # rubocop:enable Metrics/ParameterLists
 
       private
 

data/lib/faker/default/twitter.rb

@@ -16,14 +16,9 @@ module Faker
       #   Faker::Twitter.user(include_email: true) # Simulate an authenticated user with the email permission
       #
       # @faker.version 1.7.3
-      def user(legacy_include_status = NOT_GIVEN, legacy_include_email = NOT_GIVEN, include_status: true, include_email: false)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :include_status if legacy_include_status != NOT_GIVEN
-          keywords << :include_email if legacy_include_email != NOT_GIVEN
-        end
-
+      def user(include_status: true, include_email: false)
         user_id = id
-        background_image_url = Faker::LoremPixel.image(size: '600x400') # TODO: Make the dimensions change
+        background_image_url = Faker::LoremFlickr.image(size: '600x400')
         profile_image_url = Faker::Avatar.image(slug: user_id, size: '48x48')
         user = {
           id: user_id,
@@ -51,7 +46,7 @@ module Faker
           profile_background_image_url_https: background_image_url,
           profile_background_image_url: background_image_url.sub('https://', 'http://'),
           profile_background_tile: Faker::Boolean.boolean(true_ratio: 0.1),
-          profile_banner_url: Faker::LoremPixel.image(size: '1500x500'),
+          profile_banner_url: Faker::LoremFlickr.image(size: '1500x500'),
           profile_image_url_https: profile_image_url,
           profile_image_url: profile_image_url.sub('https://', 'http://'),
           profile_link_color: Faker::Color.hex_color,
@@ -68,7 +63,7 @@ module Faker
           verified: Faker::Boolean.boolean(true_ratio: 0.1)
         }
         user[:status] = Faker::Twitter.status(include_user: false) if include_status
-        user[:email] = Faker::Internet.safe_email if include_email
+        user[:email] = Faker::Internet.email if include_email
         user
       end
 
@@ -85,12 +80,7 @@ module Faker
       #   Faker::Twitter.status(include_photo: true) # Includes entities for an attached image
       #
       # @faker.version 1.7.3
-      def status(legacy_include_user = NOT_GIVEN, legacy_include_photo = NOT_GIVEN, include_user: true, include_photo: false)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :include_user if legacy_include_user != NOT_GIVEN
-          keywords << :include_photo if legacy_include_photo != NOT_GIVEN
-        end
-
+      def status(include_user: true, include_photo: false)
         status_id = id
         status = {
           id: status_id,
@@ -161,11 +151,7 @@ module Faker
         }
       end
 
-      def status_entities(legacy_include_photo = NOT_GIVEN, include_photo: false)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :include_photo if legacy_include_photo != NOT_GIVEN
-        end
-
+      def status_entities(include_photo: false)
         entities = {
           hashtags: [],
           symbols: [],
@@ -177,9 +163,7 @@ module Faker
       end
 
       def photo_entity
-        # TODO: Dynamic image sizes
-        # TODO: Return accurate indices
-        media_url = Faker::LoremPixel.image(size: '1064x600')
+        media_url = Faker::LoremFlickr.image(size: '1064x600')
         media_id = id
         {
           id: media_id,

data/lib/faker/default/types.rb

@@ -16,17 +16,11 @@ module Faker
       #   Faker::Types.rb_string #=> "foobar"
       #
       # @faker.version 1.8.6
-      def rb_string(legacy_words = NOT_GIVEN, words: 1)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :words if legacy_words != NOT_GIVEN
-        end
-
+      def rb_string(words: 1)
         resolved_num = resolve(words)
-        word_list =
-          translate('faker.lorem.words')
-
+        word_list = translate('faker.lorem.words')
         word_list *= ((resolved_num / word_list.length) + 1)
-        shuffle(word_list)[0, resolved_num].join(' ')
+        sample(word_list, resolved_num).join(' ')
       end
 
       ##
@@ -51,12 +45,7 @@ module Faker
       #   Faker::Types.rb_integer #=> 1
       #
       # @faker.version 1.8.6
-      def rb_integer(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, from: 0, to: 100)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :from if legacy_from != NOT_GIVEN
-          keywords << :to if legacy_to != NOT_GIVEN
-        end
-
+      def rb_integer(from: 0, to: 100)
         rand(from..to).to_i
       end
 
@@ -72,15 +61,11 @@ module Faker
       #   Faker::Types.rb_hash(number: 2) #=> {name: "bob", last: "marley"}
       #
       # @faker.version 1.8.6
-      def rb_hash(legacy_number = NOT_GIVEN, legacy_type = NOT_GIVEN, number: 1, type: random_type)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :number if legacy_number != NOT_GIVEN
-          keywords << :type if legacy_type != NOT_GIVEN
-        end
-
+      def rb_hash(number: 1, type: -> { random_type })
         {}.tap do |hsh|
           Lorem.words(number: number * 2).uniq.first(number).each do |s|
-            hsh.merge!(s.to_sym => type)
+            value = type.is_a?(Proc) ? type.call : type
+            hsh.merge!(s.to_sym => value)
           end
         end
       end
@@ -97,12 +82,8 @@ module Faker
       #   Faker::Types.complex_rb_hash(number: 2) #=> {user: {first: "bob", last: "marley"}, son: ["damien", "marley"]}
       #
       # @faker.version 1.8.6
-      def complex_rb_hash(legacy_number = NOT_GIVEN, number: 1)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :number if legacy_number != NOT_GIVEN
-        end
-
-        rb_hash(number: number, type: random_complex_type)
+      def complex_rb_hash(number: 1)
+        rb_hash(number: number, type: -> { random_complex_type })
       end
 
       ##
@@ -114,16 +95,13 @@ module Faker
       # @example
       #   Faker::Types.rb_array #=> ["a"]
       #   Faker::Types.rb_array(len: 4) #=> ["a", 1, 2, "bob"]
+      #   Faker::Types.rb_array(len: 2, type: -> { Faker::Types.rb_string }) #=> ["cat", "foo"]
       #
       # @faker.version 1.8.6
-      def rb_array(legacy_len = NOT_GIVEN, len: 1)
-        warn_for_deprecated_arguments do |keywords|
-          keywords << :len if legacy_len != NOT_GIVEN
-        end
-
+      def rb_array(len: 1, type: -> { random_type })
         [].tap do |ar|
           len.times do
-            ar.push random_type
+            ar.push type.is_a?(Proc) ? type.call : type
           end
         end
       end