faker 2.14.0 → 2.18.0

data/lib/faker/default/number.rb

@@ -40,7 +40,7 @@ module Faker
           keywords << :digits if legacy_digits != NOT_GIVEN
         end
 
-        '0' + (2..digits).collect { digit }.join
+        "0#{(2..digits).collect { digit }.join}"
       end
 
       ##
@@ -139,11 +139,26 @@ module Faker
         hex
       end
 
+      # Produces a number in binary format.
+      #
+      # @param digits [Integer] Number of digits to generate the binary as string
+      # @return [String]
+      #
+      # @example
+      #   Faker::Number.binary(digits: 4) #=> "1001"
+      #
+      # @faker.version next
+      def binary(digits: 4)
+        bin = ''
+        digits.times { bin += rand(2).to_s(2) }
+        bin
+      end
+
       ##
       # Produces a float given a mean and standard deviation.
       #
       # @param mean [Integer]
-      # @param standard_deviation [Integer, Float]
+      # @param standard_deviation [Numeric]
       # @return [Float]
       #
       # @example
@@ -165,12 +180,13 @@ module Faker
       ##
       # Produces a number between two provided values. Boundaries are inclusive.
       #
-      # @param from [Integer] The lowest number to include.
-      # @param to [Integer] The highest number to include.
-      # @return [Integer]
+      # @param from [Numeric] The lowest number to include.
+      # @param to [Numeric] The highest number to include.
+      # @return [Numeric]
       #
       # @example
       #   Faker::Number.between(from: 1, to: 10) #=> 7
+      #   Faker::Number.between(from: 0.0, to: 1.0) #=> 0.7844640543957383
       #
       # @faker.version 1.0.0
       def between(legacy_from = NOT_GIVEN, legacy_to = NOT_GIVEN, from: 1.00, to: 5000.00)
@@ -186,10 +202,11 @@ module Faker
       # Produces a number within two provided values. Boundaries are inclusive or exclusive depending on the range passed.
       #
       # @param range [Range] The range from which to generate a number.
-      # @return [Integer]
+      # @return [Numeric]
       #
       # @example
       #   Faker::Number.within(range: 1..10) #=> 7
+      #   Faker::Number.within(range: 0.0..1.0) #=> 0.7844640543957383
       #
       # @faker.version 1.0.0
       def within(legacy_range = NOT_GIVEN, range: 1.00..5000.00)

data/lib/faker/default/omniauth.rb

@@ -9,12 +9,16 @@ module Faker
                 :email
 
     def initialize(name: nil, email: nil)
+      super()
+
       @name = name || "#{Name.first_name} #{Name.last_name}"
       @email = email || Internet.safe_email(name: self.name)
       @first_name, @last_name = self.name.split
     end
 
     class << self
+      # rubocop:disable Metrics/ParameterLists
+
       ##
       # Generate a mock Omniauth response from Google.
       #
@@ -25,9 +29,7 @@ module Faker
       # @return [Hash] An auth hash in the format provided by omniauth-google.
       #
       # @faker.version 1.8.0
-      # rubocop:disable Metrics/ParameterLists
       def google(legacy_name = NOT_GIVEN, legacy_email = NOT_GIVEN, legacy_uid = NOT_GIVEN, name: nil, email: nil, uid: Number.number(digits: 9).to_s)
-        # rubocop:enable Metrics/ParameterLists
         warn_for_deprecated_arguments do |keywords|
           keywords << :name if legacy_name != NOT_GIVEN
           keywords << :email if legacy_email != NOT_GIVEN
@@ -93,9 +95,7 @@ module Faker
       # @return [Hash] An auth hash in the format provided by omniauth-facebook.
       #
       # @faker.version 1.8.0
-      # rubocop:disable Metrics/ParameterLists
       def facebook(legacy_name = NOT_GIVEN, legacy_email = NOT_GIVEN, legacy_username = NOT_GIVEN, legacy_uid = NOT_GIVEN, name: nil, email: nil, username: nil, uid: Number.number(digits: 7).to_s)
-        # rubocop:enable Metrics/ParameterLists
         warn_for_deprecated_arguments do |keywords|
           keywords << :name if legacy_name != NOT_GIVEN
           keywords << :email if legacy_email != NOT_GIVEN
@@ -154,9 +154,7 @@ module Faker
       # @return [Hash] An auth hash in the format provided by omniauth-twitter.
       #
       # @faker.version 1.8.0
-      # rubocop:disable Metrics/ParameterLists
       def twitter(legacy_name = NOT_GIVEN, legacy_nickname = NOT_GIVEN, legacy_uid = NOT_GIVEN, name: nil, nickname: nil, uid: Number.number(digits: 6).to_s)
-        # rubocop:enable Metrics/ParameterLists
         warn_for_deprecated_arguments do |keywords|
           keywords << :name if legacy_name != NOT_GIVEN
           keywords << :nickname if legacy_nickname != NOT_GIVEN
@@ -245,9 +243,7 @@ module Faker
       # @return [Hash] An auth hash in the format provided by omniauth-linkedin.
       #
       # @faker.version 1.8.0
-      # rubocop:disable Metrics/ParameterLists
       def linkedin(legacy_name = NOT_GIVEN, legacy_email = NOT_GIVEN, legacy_uid = NOT_GIVEN, name: nil, email: nil, uid: Number.number(digits: 6).to_s)
-        # rubocop:enable Metrics/ParameterLists
         warn_for_deprecated_arguments do |keywords|
           keywords << :name if legacy_name != NOT_GIVEN
           keywords << :email if legacy_email != NOT_GIVEN
@@ -326,9 +322,7 @@ module Faker
       # @return [Hash] An auth hash in the format provided by omniauth-github.
       #
       # @faker.version 1.8.0
-      # rubocop:disable Metrics/ParameterLists
       def github(legacy_name = NOT_GIVEN, legacy_email = NOT_GIVEN, legacy_uid = NOT_GIVEN, name: nil, email: nil, uid: Number.number(digits: 8).to_s)
-        # rubocop:enable Metrics/ParameterLists
         warn_for_deprecated_arguments do |keywords|
           keywords << :name if legacy_name != NOT_GIVEN
           keywords << :email if legacy_email != NOT_GIVEN
@@ -391,6 +385,7 @@ module Faker
           }
         }
       end
+      # rubocop:enable Metrics/ParameterLists
 
       ##
       # Generate a mock Omniauth response from Apple.

data/lib/faker/default/placeholdit.rb

@@ -5,6 +5,8 @@ module Faker
     class << self
       SUPPORTED_FORMATS = %w[png jpg gif jpeg].freeze
 
+      # rubocop:disable Metrics/ParameterLists
+
       ##
       # Produces a random placeholder image from https://placehold.it.
       #
@@ -26,9 +28,7 @@ module Faker
       #   Faker::Placeholdit.image(size: '50x50', format: 'jpg', background_color: 'ffffff', text_color: '000', text: 'Some Custom Text') #=> "https://placehold.it/50x50.jpg/ffffff/000?text=Some Custom Text"
       #
       # @faker.version 1.6.0
-      # rubocop:disable Metrics/ParameterLists
       def image(legacy_size = NOT_GIVEN, legacy_format = NOT_GIVEN, legacy_background_color = NOT_GIVEN, legacy_text_color = NOT_GIVEN, legacy_text = NOT_GIVEN, size: '300x300', format: 'png', background_color: nil, text_color: nil, text: nil)
-        # rubocop:enable Metrics/ParameterLists
         warn_for_deprecated_arguments do |keywords|
           keywords << :size if legacy_size != NOT_GIVEN
           keywords << :format if legacy_format != NOT_GIVEN
@@ -51,6 +51,7 @@ module Faker
         image_url += "?text=#{text}" if text
         image_url
       end
+      # rubocop:enable Metrics/ParameterLists
 
       private
 

data/lib/faker/default/relationship.rb

@@ -32,7 +32,7 @@ module Faker
           end
         end
 
-        fetch('relationship.familial.' + connection)
+        fetch("relationship.familial.#{connection}")
       end
 
       ##

data/lib/faker/default/science.rb

@@ -29,6 +29,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.
       #

data/lib/faker/default/space.rb

@@ -158,7 +158,7 @@ module Faker
       #
       # @faker.version 1.6.4
       def distance_measurement
-        rand(10..100).to_s + ' ' + fetch('space.distance_measurement')
+        "#{rand(10..100)} #{fetch('space.distance_measurement')}"
       end
 
       ##

data/lib/faker/default/string.rb

@@ -3,6 +3,8 @@
 module Faker
   class String < Base
     class << self
+      # rubocop:disable Style/AsciiComments
+
       ##
       # Produces a random UTF-8 string with optional nested length selectors.
       #
@@ -10,13 +12,11 @@ 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)
@@ -26,6 +26,7 @@ module Faker
 
         utf8string select_a length
       end
+      # rubocop:enable Style/AsciiComments
 
       private
 

data/lib/faker/default/stripe.rb

@@ -30,7 +30,7 @@ module Faker
           end
         end
 
-        fetch('stripe.valid_cards.' + card_type)
+        fetch("stripe.valid_cards.#{card_type}")
       end
 
       ##
@@ -60,7 +60,7 @@ module Faker
           end
         end
 
-        fetch('stripe.valid_tokens.' + card_type)
+        fetch("stripe.valid_tokens.#{card_type}")
       end
 
       ##
@@ -89,7 +89,7 @@ module Faker
           end
         end
 
-        fetch('stripe.invalid_cards.' + card_error)
+        fetch("stripe.invalid_cards.#{card_error}")
       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/default/types.rb

@@ -72,7 +72,7 @@ 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)
+      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
@@ -80,7 +80,8 @@ module Faker
 
         {}.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
@@ -102,7 +103,7 @@ module Faker
           keywords << :number if legacy_number != NOT_GIVEN
         end
 
-        rb_hash(number: number, type: random_complex_type)
+        rb_hash(number: number, type: -> { random_complex_type })
       end
 
       ##

data/lib/faker/default/vehicle.rb

@@ -278,7 +278,7 @@ module Faker
 
         return regexify(bothify(fetch('vehicle.license_plate'))) if state_abbreviation.empty?
 
-        key = 'vehicle.license_plate_by_state.' + state_abbreviation
+        key = "vehicle.license_plate_by_state.#{state_abbreviation}"
         regexify(bothify(fetch(key)))
       end
 

data/lib/faker/fantasy/tolkien.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Faker
+  class Fantasy
+    class Tolkien < Base
+      flexible :tolkien
+
+      class << self
+        ##
+        # Produces a character from Tolkien's legendarium
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Fantasy::Tolkien.character
+        #    #=> "Goldberry"
+        #
+        # @faker.version next
+        def character
+          fetch('tolkien.characters')
+        end
+
+        ##
+        # Produces a location from Tolkien's legendarium
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Fantasy::Tolkien.location
+        #    #=> "Helm's Deep"
+        #
+        # @faker.version next
+        def location
+          fetch('tolkien.locations')
+        end
+
+        ##
+        # Produces a race from Tolkien's legendarium
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Fantasy::Tolkien.race
+        #     #=> "Uruk-hai"
+        #
+        # @faker.version next
+        def race
+          fetch('tolkien.races')
+        end
+
+        ##
+        # Produces the name of a poem from Tolkien's legendarium
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Fantasy::Tolkien.poem
+        #     #=> "Chip the glasses and crack the plates"
+        #
+        # @faker.version next
+        def poem
+          fetch('tolkien.poems')
+        end
+      end
+    end
+  end
+end

data/lib/faker/games/clash_of_clans.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Faker
+  class Games
+    class ClashOfClans < Base
+      class << self
+        ##
+        # Produces the name of a troop from Clash of Clans.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ClashOfClans.troop #=> "Barbarian"
+        #
+        # @faker.version next
+        def troop
+          fetch('games.clash_of_clans.troops')
+        end
+
+        ##
+        # Produces the name of a rank from Clash Of Clans.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ClashOfClans.rank #=> "Legend"
+        #
+        # @faker.version next
+        def rank
+          fetch('games.clash_of_clans.ranks')
+        end
+
+        ##
+        # Produces the name of a defensive buiding from Clash Of Clans.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Games::ClashOfClans.defensive_building #=> "Cannon"
+        #
+        # @faker.version next
+        def defensive_building
+          fetch('games.clash_of_clans.defensive_buildings')
+        end
+      end
+    end
+  end
+end