x-twitter-scraper 0.10.5 → 0.10.6

data/lib/x_twitter_scraper/internal/type/array_of.rb

@@ -7,34 +7,12 @@
 module XTwitterScraper
   module Internal
     module Type
-      # @api private
-      #
-      # @abstract
-      #
-      # @generic Elem
-      #
-      # Array of items of a given type.
       class ArrayOf
         include XTwitterScraper::Internal::Type::Converter
         include XTwitterScraper::Internal::Util::SorbetRuntimeSupport
 
         private_class_method :new
 
-        # @overload [](type_info, spec = {})
-        #
-        # @param type_info [Hash{Symbol=>Object}, Proc, XTwitterScraper::Internal::Type::Converter, Class]
-        #
-        # @param spec [Hash{Symbol=>Object}] .
-        #
-        #   @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
-        #
-        #   @option spec [Proc] :enum
-        #
-        #   @option spec [Proc] :union
-        #
-        #   @option spec [Boolean] :"nil?"
-        #
-        # @return [self]
         def self.[](...) = new(...)
 
         # @api public
@@ -50,9 +28,8 @@ module XTwitterScraper
         #
         # @return [Boolean]
         def ==(other)
-          # rubocop:disable Layout/LineLength
+          # rubocop:disable-next Layout/LineLength
           other.is_a?(XTwitterScraper::Internal::Type::ArrayOf) && other.nilable? == nilable? && other.item_type == item_type
-          # rubocop:enable Layout/LineLength
         end
 
         # @api public
@@ -60,23 +37,6 @@ module XTwitterScraper
         # @return [Integer]
         def hash = [self.class, item_type].hash
 
-        # @api private
-        #
-        # @param value [Array<Object>, Object]
-        #
-        # @param state [Hash{Symbol=>Object}] .
-        #
-        #   @option state [Boolean] :translate_names
-        #
-        #   @option state [Boolean] :strictness
-        #
-        #   @option state [Hash{Symbol=>Object}] :exactness
-        #
-        #   @option state [Class<StandardError>] :error
-        #
-        #   @option state [Integer] :branched
-        #
-        # @return [Array<Object>, Object]
         def coerce(value, state:)
           exactness = state.fetch(:exactness)
 
@@ -100,15 +60,6 @@ module XTwitterScraper
             end
         end
 
-        # @api private
-        #
-        # @param value [Array<Object>, Object]
-        #
-        # @param state [Hash{Symbol=>Object}] .
-        #
-        #   @option state [Boolean] :can_retry
-        #
-        # @return [Array<Object>, Object]
         def dump(value, state:)
           target = item_type
           if value.is_a?(Array)
@@ -120,47 +71,20 @@ module XTwitterScraper
           end
         end
 
-        # @api private
-        #
-        # @return [Object]
         def to_sorbet_type
           T::Array[XTwitterScraper::Internal::Util::SorbetRuntimeSupport.to_sorbet_type(item_type)]
         end
 
-        # @api private
-        #
-        # @return [generic<Elem>]
         protected def item_type = @item_type_fn.call
 
-        # @api private
-        #
-        # @return [Boolean]
         protected def nilable? = @nilable
 
-        # @api private
-        #
-        # @param type_info [Hash{Symbol=>Object}, Proc, XTwitterScraper::Internal::Type::Converter, Class]
-        #
-        # @param spec [Hash{Symbol=>Object}] .
-        #
-        #   @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
-        #
-        #   @option spec [Proc] :enum
-        #
-        #   @option spec [Proc] :union
-        #
-        #   @option spec [Boolean] :"nil?"
         def initialize(type_info, spec = {})
           @item_type_fn = XTwitterScraper::Internal::Type::Converter.type_info(type_info || spec)
           @meta = XTwitterScraper::Internal::Type::Converter.meta_info(type_info, spec)
           @nilable = spec.fetch(:nil?, false)
         end
 
-        # @api private
-        #
-        # @param depth [Integer]
-        #
-        # @return [String]
         def inspect(depth: 0)
           items = XTwitterScraper::Internal::Type::Converter.inspect(item_type, depth: depth.succ)
 

data/lib/x_twitter_scraper/internal/type/base_model.rb

@@ -7,54 +7,24 @@
 module XTwitterScraper
   module Internal
     module Type
-      # @abstract
       class BaseModel
         extend XTwitterScraper::Internal::Type::Converter
         extend XTwitterScraper::Internal::Util::SorbetRuntimeSupport
 
         class << self
-          # @api private
-          #
-          # Assumes superclass fields are totally defined before fields are accessed /
-          # defined on subclasses.
-          #
-          # @param child [Class<XTwitterScraper::Internal::Type::BaseModel>]
           def inherited(child)
             super
             child.known_fields.replace(known_fields.dup)
           end
 
-          # @api private
-          #
-          # @return [Hash{Symbol=>Hash{Symbol=>Object}}]
           def known_fields = @known_fields ||= {}
 
-          # @api private
-          #
-          # @return [Hash{Symbol=>Hash{Symbol=>Object}}]
           def fields
             known_fields.transform_values do |field|
               {**field.except(:type_fn), type: field.fetch(:type_fn).call}
             end
           end
 
-          # @api private
-          #
-          # @param name_sym [Symbol]
-          #
-          # @param required [Boolean]
-          #
-          # @param type_info [Hash{Symbol=>Object}, Proc, XTwitterScraper::Internal::Type::Converter, Class]
-          #
-          # @param spec [Hash{Symbol=>Object}] .
-          #
-          #   @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
-          #
-          #   @option spec [Proc] :enum
-          #
-          #   @option spec [Proc] :union
-          #
-          #   @option spec [Boolean] :"nil?"
           private def add_field(name_sym, required:, type_info:, spec:)
             meta = XTwitterScraper::Internal::Type::Converter.meta_info(type_info, spec)
             type_fn, info =
@@ -99,7 +69,7 @@ module XTwitterScraper
             end
 
             # rubocop:disable Style/CaseEquality
-            # rubocop:disable Metrics/BlockLength
+            # rubocop:disable-next Metrics/BlockLength
             define_method(name_sym) do
               target = type_fn.call
 
@@ -136,54 +106,17 @@ module XTwitterScraper
                 end
               end
             end
-            # rubocop:enable Metrics/BlockLength
             # rubocop:enable Style/CaseEquality
           end
 
-          # @api private
-          #
-          # @param name_sym [Symbol]
-          #
-          # @param type_info [Hash{Symbol=>Object}, Proc, XTwitterScraper::Internal::Type::Converter, Class]
-          #
-          # @param spec [Hash{Symbol=>Object}] .
-          #
-          #   @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
-          #
-          #   @option spec [Proc] :enum
-          #
-          #   @option spec [Proc] :union
-          #
-          #   @option spec [Boolean] :"nil?"
           def required(name_sym, type_info, spec = {})
             add_field(name_sym, required: true, type_info: type_info, spec: spec)
           end
 
-          # @api private
-          #
-          # @param name_sym [Symbol]
-          #
-          # @param type_info [Hash{Symbol=>Object}, Proc, XTwitterScraper::Internal::Type::Converter, Class]
-          #
-          # @param spec [Hash{Symbol=>Object}] .
-          #
-          #   @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
-          #
-          #   @option spec [Proc] :enum
-          #
-          #   @option spec [Proc] :union
-          #
-          #   @option spec [Boolean] :"nil?"
           def optional(name_sym, type_info, spec = {})
             add_field(name_sym, required: false, type_info: type_info, spec: spec)
           end
 
-          # @api private
-          #
-          # `request_only` attributes not excluded from `.#coerce` when receiving responses
-          # even if well behaved servers should not send them
-          #
-          # @param blk [Proc]
           private def request_only(&blk)
             @mode = :dump
             blk.call
@@ -191,11 +124,6 @@ module XTwitterScraper
             @mode = nil
           end
 
-          # @api private
-          #
-          # `response_only` attributes are omitted from `.#dump` when making requests
-          #
-          # @param blk [Proc]
           private def response_only(&blk)
             @mode = :coerce
             blk.call
@@ -209,9 +137,8 @@ module XTwitterScraper
           #
           # @return [Boolean]
           def ==(other)
-            # rubocop:disable Layout/LineLength
+            # rubocop:disable-next Layout/LineLength
             other.is_a?(Class) && other <= XTwitterScraper::Internal::Type::BaseModel && other.fields == fields
-            # rubocop:enable Layout/LineLength
           end
 
           # @api public
@@ -233,23 +160,6 @@ module XTwitterScraper
         def hash = [self.class, @data].hash
 
         class << self
-          # @api private
-          #
-          # @param value [XTwitterScraper::Internal::Type::BaseModel, Hash{Object=>Object}, Object]
-          #
-          # @param state [Hash{Symbol=>Object}] .
-          #
-          #   @option state [Boolean] :translate_names
-          #
-          #   @option state [Boolean] :strictness
-          #
-          #   @option state [Hash{Symbol=>Object}] :exactness
-          #
-          #   @option state [Class<StandardError>] :error
-          #
-          #   @option state [Integer] :branched
-          #
-          # @return [self, Object]
           def coerce(value, state:)
             exactness = state.fetch(:exactness)
 
@@ -270,7 +180,7 @@ module XTwitterScraper
             data = instance.to_h
             status = instance.instance_variable_get(:@coerced)
 
-            # rubocop:disable Metrics/BlockLength
+            # rubocop:disable-next Metrics/BlockLength
             fields.each do |name, field|
               mode, required, target = field.fetch_values(:mode, :required, :type)
               api_name, nilable, const = field.fetch_values(:api_name, :nilable, :const)
@@ -306,21 +216,11 @@ module XTwitterScraper
               status.store(name, state.fetch(:error) || true)
               data.store(name, converted)
             end
-            # rubocop:enable Metrics/BlockLength
 
             keys.each { data.store(_1, val.fetch(_1)) }
             instance
           end
 
-          # @api private
-          #
-          # @param value [self, Object]
-          #
-          # @param state [Hash{Symbol=>Object}] .
-          #
-          #   @option state [Boolean] :can_retry
-          #
-          # @return [Hash{Object=>Object}, Object]
           def dump(value, state:)
             unless (coerced = XTwitterScraper::Internal::Util.coerce_hash(value)).is_a?(Hash)
               return super
@@ -357,21 +257,12 @@ module XTwitterScraper
             acc
           end
 
-          # @api private
-          #
-          # @return [Object]
           def to_sorbet_type
             self
           end
         end
 
         class << self
-          # @api private
-          #
-          # @param model [XTwitterScraper::Internal::Type::BaseModel]
-          # @param convert [Boolean]
-          #
-          # @return [Hash{Symbol=>Object}]
           def recursively_to_h(model, convert:)
             rec = ->(x) do
               case x
@@ -442,16 +333,6 @@ module XTwitterScraper
         # @return [Hash{Symbol=>Object}]
         def deep_to_h = self.class.recursively_to_h(@data, convert: false)
 
-        # @param keys [Array<Symbol>, nil]
-        #
-        # @return [Hash{Symbol=>Object}]
-        #
-        # @example
-        #   # `content_disclosure` is a `XTwitterScraper::ContentDisclosure`
-        #   content_disclosure => {
-        #     advertising: advertising,
-        #     ai_generated: ai_generated
-        #   }
         def deconstruct_keys(keys)
           (keys || self.class.known_fields.keys)
             .filter_map do |k|
@@ -478,9 +359,6 @@ module XTwitterScraper
         # @return [String]
         def to_yaml(*a) = XTwitterScraper::Internal::Type::Converter.dump(self.class, self).to_yaml(*a)
 
-        # Create a new instance of a model.
-        #
-        # @param data [Hash{Symbol=>Object}, self]
         def initialize(data = {})
           @data = {}
           @coerced = {}
@@ -495,11 +373,6 @@ module XTwitterScraper
         end
 
         class << self
-          # @api private
-          #
-          # @param depth [Integer]
-          #
-          # @return [String]
           def inspect(depth: 0)
             return super() if depth.positive?
 
@@ -522,9 +395,6 @@ module XTwitterScraper
         # @return [String]
         def to_s = deep_to_h.to_s
 
-        # @api private
-        #
-        # @return [String]
         def inspect
           converted = self.class.recursively_to_h(self, convert: true)
           "#<#{self.class}:0x#{object_id.to_s(16)} #{converted}>"

data/lib/x_twitter_scraper/internal/type/base_page.rb

@@ -7,11 +7,6 @@
 module XTwitterScraper
   module Internal
     module Type
-      # @api private
-      #
-      # @generic Elem
-      #
-      # This module provides a base implementation for paginated responses in the SDK.
       module BasePage
         # rubocop:disable Lint/UnusedMethodArgument
 
@@ -34,24 +29,16 @@ module XTwitterScraper
         # @return [void]
         def auto_paging_each(&blk) = (raise NotImplementedError)
 
-        # @return [Enumerable<generic<Elem>>]
         def to_enum = super(:auto_paging_each)
 
         alias_method :enum_for, :to_enum
 
-        # @api private
-        #
-        # @param client [XTwitterScraper::Internal::Transport::BaseClient]
-        # @param req [Hash{Symbol=>Object}]
-        # @param headers [Hash{String=>String}]
-        # @param page_data [Object]
         def initialize(client:, req:, headers:, page_data:)
           @client = client
           @req = req
           @model = req.fetch(:model)
           super()
         end
-
         # rubocop:enable Lint/UnusedMethodArgument
       end
     end

data/lib/x_twitter_scraper/internal/type/boolean.rb

@@ -7,11 +7,6 @@
 module XTwitterScraper
   module Internal
     module Type
-      # @api private
-      #
-      # @abstract
-      #
-      # Ruby has no Boolean class; this is something for models to refer to.
       class Boolean
         extend XTwitterScraper::Internal::Type::Converter
         extend XTwitterScraper::Internal::Util::SorbetRuntimeSupport
@@ -33,44 +28,11 @@ module XTwitterScraper
         def self.==(other) = other.is_a?(Class) && other <= XTwitterScraper::Internal::Type::Boolean
 
         class << self
-          # @api private
-          #
-          # Coerce value to Boolean if possible, otherwise return the original value.
-          #
-          # @param value [Boolean, Object]
-          #
-          # @param state [Hash{Symbol=>Object}] .
-          #
-          #   @option state [Boolean] :translate_names
-          #
-          #   @option state [Boolean] :strictness
-          #
-          #   @option state [Hash{Symbol=>Object}] :exactness
-          #
-          #   @option state [Class<StandardError>] :error
-          #
-          #   @option state [Integer] :branched
-          #
-          # @return [Boolean, Object]
           def coerce(value, state:)
             state.fetch(:exactness)[value == true || value == false ? :yes : :no] += 1
             value
           end
 
-          # @!method dump(value, state:)
-          #   @api private
-          #
-          #   @param value [Boolean, Object]
-          #
-          #   @param state [Hash{Symbol=>Object}] .
-          #
-          #     @option state [Boolean] :can_retry
-          #
-          #   @return [Boolean, Object]
-
-          # @api private
-          #
-          # @return [Object]
           def to_sorbet_type
             T::Boolean
           end

data/lib/x_twitter_scraper/internal/type/converter.rb

@@ -7,40 +7,12 @@
 module XTwitterScraper
   module Internal
     module Type
-      # @api private
       module Converter
         extend XTwitterScraper::Internal::Util::SorbetRuntimeSupport
 
         # rubocop:disable Lint/UnusedMethodArgument
-
-        # @api private
-        #
-        # @param value [Object]
-        #
-        # @param state [Hash{Symbol=>Object}] .
-        #
-        #   @option state [Boolean] :translate_names
-        #
-        #   @option state [Boolean] :strictness
-        #
-        #   @option state [Hash{Symbol=>Object}] :exactness
-        #
-        #   @option state [Class<StandardError>] :error
-        #
-        #   @option state [Integer] :branched
-        #
-        # @return [Object]
         def coerce(value, state:) = (raise NotImplementedError)
 
-        # @api private
-        #
-        # @param value [Object]
-        #
-        # @param state [Hash{Symbol=>Object}] .
-        #
-        #   @option state [Boolean] :can_retry
-        #
-        # @return [Object]
         def dump(value, state:)
           case value
           in Array
@@ -62,31 +34,12 @@ module XTwitterScraper
           end
         end
 
-        # @api private
-        #
-        # @param depth [Integer]
-        #
-        # @return [String]
         def inspect(depth: 0)
           super()
         end
 
         # rubocop:enable Lint/UnusedMethodArgument
-
         class << self
-          # @api private
-          #
-          # @param spec [Hash{Symbol=>Object}, Proc, XTwitterScraper::Internal::Type::Converter, Class] .
-          #
-          #   @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
-          #
-          #   @option spec [Proc] :enum
-          #
-          #   @option spec [Proc] :union
-          #
-          #   @option spec [Boolean] :"nil?"
-          #
-          # @return [Proc]
           def type_info(spec)
             case spec
             in Proc
@@ -102,38 +55,10 @@ module XTwitterScraper
             end
           end
 
-          # @api private
-          #
-          # @param type_info [Hash{Symbol=>Object}, Proc, XTwitterScraper::Internal::Type::Converter, Class] .
-          #
-          #   @option type_info [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
-          #
-          #   @option type_info [Proc] :enum
-          #
-          #   @option type_info [Proc] :union
-          #
-          #   @option type_info [Boolean] :"nil?"
-          #
-          # @param spec [Hash{Symbol=>Object}, Proc, XTwitterScraper::Internal::Type::Converter, Class] .
-          #
-          #   @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
-          #
-          #   @option spec [Proc] :enum
-          #
-          #   @option spec [Proc] :union
-          #
-          #   @option spec [Boolean] :"nil?"
-          #
-          # @return [Hash{Symbol=>Object}]
           def meta_info(type_info, spec)
             [spec, type_info].grep(Hash).first.to_h.except(:const, :enum, :union, :nil?)
           end
 
-          # @api private
-          #
-          # @param translate_names [Boolean]
-          #
-          # @return [Hash{Symbol=>Object}]
           def new_coerce_state(translate_names: true)
             {
               translate_names: translate_names,
@@ -144,50 +69,6 @@ module XTwitterScraper
             }
           end
 
-          # @api private
-          #
-          # Based on `target`, transform `value` into `target`, to the extent possible:
-          #
-          # 1. if the given `value` conforms to `target` already, return the given `value`
-          # 2. if it's possible and safe to convert the given `value` to `target`, then the
-          #    converted value
-          # 3. otherwise, the given `value` unaltered
-          #
-          # The coercion process is subject to improvement between minor release versions.
-          # See https://docs.pydantic.dev/latest/concepts/unions/#smart-mode
-          #
-          # @param target [XTwitterScraper::Internal::Type::Converter, Class]
-          #
-          # @param value [Object]
-          #
-          # @param state [Hash{Symbol=>Object}] The `strictness` is one of `true`, `false`. This informs the coercion strategy
-          # when we have to decide between multiple possible conversion targets:
-          #
-          # - `true`: the conversion must be exact, with minimum coercion.
-          # - `false`: the conversion can be approximate, with some coercion.
-          #
-          # The `exactness` is `Hash` with keys being one of `yes`, `no`, or `maybe`. For
-          # any given conversion attempt, the exactness will be updated based on how closely
-          # the value recursively matches the target type:
-          #
-          # - `yes`: the value can be converted to the target type with minimum coercion.
-          # - `maybe`: the value can be converted to the target type with some reasonable
-          #   coercion.
-          # - `no`: the value cannot be converted to the target type.
-          #
-          # See implementation below for more details.
-          #
-          #   @option state [Boolean] :translate_names
-          #
-          #   @option state [Boolean] :strictness
-          #
-          #   @option state [Hash{Symbol=>Object}] :exactness
-          #
-          #   @option state [Class<StandardError>] :error
-          #
-          #   @option state [Integer] :branched
-          #
-          # @return [Object]
           def coerce(target, value, state: XTwitterScraper::Internal::Type::Converter.new_coerce_state)
             # rubocop:disable Metrics/BlockNesting
             exactness = state.fetch(:exactness)
@@ -272,17 +153,6 @@ module XTwitterScraper
             # rubocop:enable Metrics/BlockNesting
           end
 
-          # @api private
-          #
-          # @param target [XTwitterScraper::Internal::Type::Converter, Class]
-          #
-          # @param value [Object]
-          #
-          # @param state [Hash{Symbol=>Object}] .
-          #
-          #   @option state [Boolean] :can_retry
-          #
-          # @return [Object]
           def dump(target, value, state: {can_retry: true})
             case target
             in XTwitterScraper::Internal::Type::Converter
@@ -292,12 +162,6 @@ module XTwitterScraper
             end
           end
 
-          # @api private
-          #
-          # @param target [Object]
-          # @param depth [Integer]
-          #
-          # @return [String]
           def inspect(target, depth:)
             case target
             in XTwitterScraper::Internal::Type::Converter