faker 3.5.1 → 3.5.3

data/lib/faker/default/internet.rb

@@ -267,7 +267,7 @@ module Faker
       #   Faker::Internet.mac_address(prefix: 'aa:44')  #=> "aa:44:30:88:6e:95"
       def mac_address(prefix: '')
         prefix_digits = prefix.split(':').map { |d| d.to_i(16) }
-        address_digits = Array.new((6 - prefix_digits.size)) { rand(256) }
+        address_digits = Array.new(6 - prefix_digits.size) { rand(256) }
         (prefix_digits + address_digits).map { |d| format('%02x', d) }.join(':')
       end
 

data/lib/faker/default/invoice.rb

@@ -13,8 +13,8 @@ module Faker
       # @return [Integer]
       #
       # @example
-      #   Faker::Finance.amount_between #=> 0
-      #   Faker::Finance.amount_between(0, 10) #=> 4.33
+      #   Faker::Invoice.amount_between #=> 0
+      #   Faker::Invoice.amount_between(from: 0, to: 10) #=> 4.33
       #
       # @faker.version 1.9.0
       def amount_between(from: 0, to: 0)

data/lib/faker/default/json.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Faker
   class Json < Base
     require 'json'
@@ -104,17 +106,20 @@ module Faker
       end
 
       def add_hash(key_array, hash, width, options)
-        string_to_eval = 'hash'
+        string_to_eval = 'hash'.dup
+
         key_array.length.times do |index|
           string_to_eval << "['#{key_array[index]}']"
         end
         string_to_eval << " = #{build_shallow_hash(width, options)}"
         eval(string_to_eval)
+
         hash
       end
 
       def build_keys_from_array(key_array)
-        key_string = ''
+        key_string = ''.dup
+
         key_array.each do |value|
           key_string << "['#{value}']"
         end

data/lib/faker/default/lorem.rb

@@ -194,7 +194,7 @@ module Faker
 
         paragraph += " #{paragraph(sentence_count: 3, supplemental: supplemental)}" while paragraph.length < number
 
-        "#{paragraph[0...number - 1]}."
+        "#{paragraph[0...(number - 1)]}."
       end
 
       ##

data/lib/faker/default/markdown.rb

@@ -28,7 +28,7 @@ module Faker
       def emphasis
         paragraph = Faker::Lorem.paragraph(sentence_count: 3)
         words = paragraph.split
-        position = rand(0..words.length - 1)
+        position = rand(0..(words.length - 1))
         formatting = fetch('markdown.emphasis')
         words[position] = "#{formatting}#{words[position]}#{formatting}"
         words.join(' ')
@@ -133,7 +133,7 @@ module Faker
       def random(*args)
         method_list = available_methods
         args&.each { |ex| method_list.delete_if { |meth| meth == ex.to_sym } }
-        send(method_list[Faker::Config.random.rand(0..method_list.length - 1)])
+        send(method_list[Faker::Config.random.rand(0..(method_list.length - 1))])
       end
 
       ##

data/lib/faker/default/national_health_service.rb

@@ -20,8 +20,7 @@ module Faker
         # If the check digit is equivalent to 10, the number is invalid.
         # See https://en.wikipedia.org/wiki/NHS_number
         base_number -= 1 if check_digit(number: base_number) == 10
-        "#{base_number}#{check_digit(number: base_number)}".to_s
-                                                           .chars
+        "#{base_number}#{check_digit(number: base_number)}".chars
                                                            .insert(3, ' ')
                                                            .insert(7, ' ')
                                                            .join

data/lib/faker/default/placeholdit.rb

@@ -45,7 +45,7 @@ module Faker
       private
 
       def generate_color
-        format('%06x', (rand * 0xffffff))
+        format('%06x', rand * 0xffffff)
       end
     end
   end

data/lib/faker/default/twitter.rb

@@ -17,6 +17,9 @@ module Faker
       #
       # @faker.version 1.7.3
       def user(include_status: true, include_email: false)
+        warn('DEPRECATION WARNING: Faker::Twitter is deprecated. Use Faker::X instead. Some return attributes \
+          will be removed, check the docs for more details.')
+
         user_id = id
         background_image_url = Faker::LoremFlickr.image(size: '600x400')
         profile_image_url = Faker::Avatar.image(slug: user_id, size: '48x48')
@@ -81,6 +84,9 @@ module Faker
       #
       # @faker.version 1.7.3
       def status(include_user: true, include_photo: false)
+        warn('DEPRECATION WARNING: Faker::Twitter is deprecated. Use Faker::X instead. Some return attributes \
+          will be removed, check the docs for more details.')
+
         status_id = id
         status = {
           id: status_id,
@@ -123,6 +129,8 @@ module Faker
       #
       # @faker.version 1.7.3
       def screen_name
+        warn('DEPRECATION WARNING: Faker::Twitter is deprecated. Use Faker::X instead.')
+
         Faker::Internet.username(specifier: nil, separators: ['_'])[0...20]
       end
 
@@ -204,4 +212,190 @@ module Faker
       end
     end
   end
+
+  class X < Base
+    class << self
+      ##
+      # Produces a random X user based on X's v2 API.
+      #
+      # @return [Hash]
+      #
+      # @example
+      #   Faker::X.user #=>  { data: [{:id=>"8821452687517076614", :name=>"Lincoln Paucek", :screen_name=>"cody"...
+      #
+      # @faker.version 1.7.3
+      def user
+        author_id = Faker::Number.between(from: 1, to: 9_223_372_036_854_775_807)
+
+        {
+          data: [
+            {
+              author_id: author_id.to_s,
+              id: id.to_s,
+              text: Faker::Lorem.sentence
+            }
+          ],
+          includes: {
+            users: [
+              {
+                public_metrics: {
+                  followers_count: Faker::Number.between(to: 1, from: 1_000),
+                  following_count: Faker::Number.between(to: 1, from: 200),
+                  tweet_count: Faker::Number.between(to: 1, from: 10_000),
+                  listed_count: Faker::Number.between(to: 1, from: 1_000)
+                },
+                username: screen_name,
+                pinned_tweet_id: Faker::Number.between(from: 1, to: 9_223_372_036_854_775_807).to_s,
+                entities: user_entities,
+                description: Faker::Lorem.sentence,
+                name: Faker::Name.name,
+                verified: Faker::Boolean.boolean(true_ratio: 0.1),
+                location: Faker::Internet.public_ip_v4_address,
+                id: author_id.to_s,
+                protected: Faker::Boolean.boolean(true_ratio: 0.1),
+                url: url,
+                profile_image_url: Faker::Avatar.image(slug: id, size: '48x48'),
+                created_at: created_at
+              }
+            ]
+          }
+        }
+      end
+
+      ##
+      # Produces a random X tweet with default attributes.
+      #
+      # @param include_user [Boolean] Include user details
+      # @param include_media [Boolean] Include user media (photo) details
+      # @return [Hash]
+      #
+      # @example
+      #   Faker::X.tweet #=> { data: [{:id=>"8821452687517076614", :text=>"Ea et laboriosam vel non."...
+      #   Faker::X.tweet(include_media: true) # Get a tweet object with a photo media attachment
+      #   Faker::X.tweet(include_user: true) # Get a tweet object with an user details
+      #
+      # @faker.version 1.7.3
+      def tweet(include_media: false, include_user: false)
+        tweet = {}
+        tweet_object = tweet_item
+        includes = {}
+
+        if include_media
+          media_key = Faker::Number.between(from: 1, to: 9_223_372_036_854_775_807).to_s
+
+          includes[:media] = media(media_key)
+          tweet_object[:attachments] = { media_keys: [media_key] }
+        end
+
+        includes[:users] = user[:includes][:users] if include_user
+
+        tweet[:data] = [
+          tweet_object
+        ]
+
+        unless includes.empty?
+          tweet[:includes] = includes
+        end
+
+        tweet
+      end
+
+      ##
+      # Produces a random screen_name.
+      #
+      # @return [String]
+      #
+      # @example
+      #   Faker::X.screen_name #=> "audreanne_hackett"
+      #
+      # @faker.version 1.7.3
+      def screen_name
+        Faker::Internet.username(specifier: nil, separators: ['_'])[0...20]
+      end
+
+      private
+
+      def id
+        Faker::Number.between(from: 1, to: 9_223_372_036_854_775_807)
+      end
+
+      def created_at
+        Faker::Date.between(from: '2006-03-21', to: ::Date.today).to_time.utc.iso8601(3)
+      end
+
+      def url
+        "https://t.co/#{Faker::Lorem.characters(number: 10)}"
+      end
+
+      def user_entities
+        entities = tweet_entities
+
+        {
+          url: {
+            urls: entities[:urls]
+          },
+          description: {
+            hashtags: entities[:hashtags]
+          }
+        }
+      end
+
+      def tweet_entities
+        display_url = Faker::Internet.url(host: 'example.com')
+
+        {
+          urls: [
+            {
+              start: 0,
+              end: 5,
+              url: url,
+              expanded_url: display_url,
+              display_url: display_url.sub('http://', '')
+            }
+          ],
+          hashtags: [
+            {
+              start: 0,
+              end: 5,
+              tag: Faker::Lorem.word.capitalize
+            }
+          ]
+        }
+      end
+
+      def media(media_key)
+        expanded_url = Faker::LoremFlickr.image(size: '1064x600')
+
+        [{
+          height: Faker::Number.between(to: 1, from: 1000),
+          media_key: media_key,
+          type: 'photo',
+          preview_image_url: expanded_url,
+          width: Faker::Number.between(to: 1, from: 2000),
+          alt_text: Faker::Lorem.sentence
+        }]
+      end
+
+      def tweet_item
+        conversation_id = id.to_s
+
+        {
+          id: conversation_id,
+          text: Faker::Lorem.sentence,
+          lang: sample(%w[en fr es pt it ja]),
+          conversation_id: conversation_id,
+          created_at: created_at,
+          author_id: Faker::Number.between(from: 1, to: 9_223_372_036_854_775_807).to_s,
+          public_metrics: {
+            retweet_count: Faker::Number.between(to: 1, from: 100),
+            reply_count: Faker::Number.between(to: 1, from: 20),
+            like_count: Faker::Number.between(to: 1, from: 25),
+            quote_count: Faker::Number.between(to: 1, from: 10)
+          },
+          possibly_sensitive: Faker::Boolean.boolean(true_ratio: 0.1),
+          entities: tweet_entities
+        }
+      end
+    end
+  end
 end

data/lib/faker/default/types.rb

@@ -116,7 +116,7 @@ module Faker
       #
       # @faker.version 1.8.6
       def random_type
-        type_to_use = SIMPLE_TYPES[rand(0..SIMPLE_TYPES.length - 1)]
+        type_to_use = SIMPLE_TYPES[rand(0..(SIMPLE_TYPES.length - 1))]
         case type_to_use
         when :string
           rb_string
@@ -136,7 +136,7 @@ module Faker
       # @faker.version 1.8.6
       def random_complex_type
         types = SIMPLE_TYPES + COMPLEX_TYPES
-        type_to_use = types[rand(0..types.length - 1)]
+        type_to_use = types[rand(0..(types.length - 1))]
         case type_to_use
         when :string
           rb_string

data/lib/faker/music/bossa_nova.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative 'music'
+
+module Faker
+  class Music
+    class BossaNova < Base
+      class << self
+        ##
+        # Produces the name of a bossa nova artist.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::BossaNova.artist #=> "Tom Jobin"
+        #
+        # @faker.version 1.8.3
+        def artist
+          fetch('bossa_nova.artists')
+        end
+
+        ##
+        # Produces a bossa nova song.
+        #
+        # @return [String]
+        #
+        # @example
+        #   Faker::Music::BossaNova.song #=> "Chega de Saudade"
+        #
+        # @faker.version 1.8.3
+        def song
+          fetch('bossa_nova.songs')
+        end
+      end
+    end
+  end
+
+  include Faker::Deprecator
+
+  deprecate_generator('BossaNova', Music::BossaNova)
+end

data/lib/faker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Faker # :nodoc:
-  VERSION = '3.5.1'
+  VERSION = '3.5.3'
 end

data/lib/helpers/deprecator.rb

@@ -103,7 +103,7 @@ module Faker
     end
 
     def self.skip_warning?
-      skip == true
+      @skip == true
     end
 
     def self.skip