redux-scraper/sorbet/rbi/gems/jbuilder@2.13.0.rbi

# typed: true

# DO NOT EDIT MANUALLY
# This is an autogenerated file for types exported from the `jbuilder` gem.
# Please instead update this file by running `bin/tapioca gem jbuilder`.


# source://jbuilder//lib/jbuilder/jbuilder.rb#1
class Jbuilder < ::BasicObject
  # @return [Jbuilder] a new instance of Jbuilder
  # @yield [_self]
  # @yieldparam _self [Jbuilder] the object that the method was called on
  #
  # source://jbuilder//lib/jbuilder.rb#15
  def initialize(options = T.unsafe(nil)); end

  # Turns the current element into an array and iterates over the passed collection, adding each iteration as
  # an element of the resulting array.
  #
  # Example:
  #
  #   json.array!(@people) do |person|
  #     json.name person.name
  #     json.age calculate_age(person.birthday)
  #   end
  #
  #   [ { "name": David", "age": 32 }, { "name": Jamie", "age": 31 } ]
  #
  # You can use the call syntax instead of an explicit extract! call:
  #
  #   json.(@people) { |person| ... }
  #
  # It's generally only needed to use this method for top-level arrays. If you have named arrays, you can do:
  #
  #   json.people(@people) do |person|
  #     json.name person.name
  #     json.age calculate_age(person.birthday)
  #   end
  #
  #   { "people": [ { "name": David", "age": 32 }, { "name": Jamie", "age": 31 } ] }
  #
  # If you omit the block then you can set the top level array directly:
  #
  #   json.array! [1, 2, 3]
  #
  #   [1,2,3]
  #
  # source://jbuilder//lib/jbuilder.rb#212
  def array!(collection = T.unsafe(nil), *attributes, &block); end

  # Returns the attributes of the current builder.
  #
  # source://jbuilder//lib/jbuilder.rb#267
  def attributes!; end

  # source://jbuilder//lib/jbuilder.rb#251
  def call(object, *attributes, &block); end

  # Turns the current element into an array and yields a builder to add a hash.
  #
  # Example:
  #
  #   json.comments do
  #     json.child! { json.content "hello" }
  #     json.child! { json.content "world" }
  #   end
  #
  #   { "comments": [ { "content": "hello" }, { "content": "world" } ]}
  #
  # More commonly, you'd use the combined iterator, though:
  #
  #   json.comments(@post.comments) do |comment|
  #     json.content comment.formatted_content
  #   end
  #
  # source://jbuilder//lib/jbuilder.rb#177
  def child!; end

  # Deeply apply key format to nested hashes and arrays passed to
  # methods like set!, merge! or array!.
  #
  # Example:
  #
  #   json.key_format! camelize: :lower
  #   json.settings({some_value: "abc"})
  #
  #   { "settings": { "some_value": "abc" }}
  #
  #   json.key_format! camelize: :lower
  #   json.deep_format_keys!
  #   json.settings({some_value: "abc"})
  #
  #   { "settings": { "someValue": "abc" }}
  #
  # source://jbuilder//lib/jbuilder.rb#152
  def deep_format_keys!(value = T.unsafe(nil)); end

  # Extracts the mentioned attributes or hash elements from the passed object and turns them into attributes of the JSON.
  #
  # Example:
  #
  #   @person = Struct.new(:name, :age).new('David', 32)
  #
  #   or you can utilize a Hash
  #
  #   @person = { name: 'David', age: 32 }
  #
  #   json.extract! @person, :name, :age
  #
  #   { "name": David", "age": 32 }, { "name": Jamie", "age": 31 }
  #
  # You can also use the call syntax instead of an explicit extract! call:
  #
  #   json.(@person, :name, :age)
  #
  # source://jbuilder//lib/jbuilder.rb#243
  def extract!(object, *attributes); end

  # If you want to skip adding nil values to your JSON hash. This is useful
  # for JSON clients that don't deal well with nil values, and would prefer
  # not to receive keys which have null values.
  #
  # Example:
  #   json.ignore_nil! false
  #   json.id User.new.id
  #
  #   { "id": null }
  #
  #   json.ignore_nil!
  #   json.id User.new.id
  #
  #   {}
  #
  # source://jbuilder//lib/jbuilder.rb#127
  def ignore_nil!(value = T.unsafe(nil)); end

  # Specifies formatting to be applied to the key. Passing in a name of a function
  # will cause that function to be called on the key.  So :upcase will upper case
  # the key.  You can also pass in lambdas for more complex transformations.
  #
  # Example:
  #
  #   json.key_format! :upcase
  #   json.author do
  #     json.name "David"
  #     json.age 32
  #   end
  #
  #   { "AUTHOR": { "NAME": "David", "AGE": 32 } }
  #
  # You can pass parameters to the method using a hash pair.
  #
  #   json.key_format! camelize: :lower
  #   json.first_name "David"
  #
  #   { "firstName": "David" }
  #
  # Lambdas can also be used.
  #
  #   json.key_format! ->(key){ "_" + key }
  #   json.first_name "David"
  #
  #   { "_first_name": "David" }
  #
  # source://jbuilder//lib/jbuilder.rb#103
  def key_format!(*args); end

  # Merges hash, array, or Jbuilder instance into current builder.
  #
  # source://jbuilder//lib/jbuilder.rb#272
  def merge!(object); end

  # source://jbuilder//lib/jbuilder.rb#67
  def method_missing(*args, &block); end

  # Returns the nil JSON.
  #
  # source://jbuilder//lib/jbuilder.rb#260
  def nil!; end

  # Returns the nil JSON.
  #
  # source://jbuilder//lib/jbuilder.rb#260
  def null!; end

  # source://jbuilder//lib/jbuilder.rb#32
  def set!(key, value = T.unsafe(nil), *args, &block); end

  # Encodes the current builder as JSON.
  #
  # source://jbuilder//lib/jbuilder.rb#278
  def target!; end

  private

  # @return [Boolean]
  #
  # source://jbuilder//lib/jbuilder.rb#356
  def _blank?(value = T.unsafe(nil)); end

  # source://jbuilder//lib/jbuilder.rb#284
  def _extract_hash_values(object, attributes); end

  # source://jbuilder//lib/jbuilder.rb#288
  def _extract_method_values(object, attributes); end

  # source://jbuilder//lib/jbuilder.rb#317
  def _format_keys(hash_or_array); end

  # @return [Boolean]
  #
  # source://jbuilder//lib/jbuilder.rb#352
  def _is_collection?(object); end

  # source://jbuilder//lib/jbuilder.rb#313
  def _key(key); end

  # source://jbuilder//lib/jbuilder.rb#337
  def _map_collection(collection); end

  # source://jbuilder//lib/jbuilder.rb#292
  def _merge_block(key); end

  # source://jbuilder//lib/jbuilder.rb#299
  def _merge_values(current_value, updates); end

  # @return [Boolean]
  #
  # source://jbuilder//lib/jbuilder.rb#360
  def _object_respond_to?(object, *methods); end

  # source://jbuilder//lib/jbuilder.rb#343
  def _scope; end

  # source://jbuilder//lib/jbuilder.rb#329
  def _set_value(key, value); end

  class << self
    # Same as instance method deep_format_keys! except sets the default.
    #
    # source://jbuilder//lib/jbuilder.rb#157
    def deep_format_keys(value = T.unsafe(nil)); end

    # Yields a builder and automatically turns the result into a JSON string
    #
    # source://jbuilder//lib/jbuilder.rb#26
    def encode(*args, &block); end

    # Same as instance method ignore_nil! except sets the default.
    #
    # source://jbuilder//lib/jbuilder.rb#132
    def ignore_nil(value = T.unsafe(nil)); end

    # Same as the instance method key_format! except sets the default.
    #
    # source://jbuilder//lib/jbuilder.rb#108
    def key_format(*args); end
  end
end

# source://jbuilder//lib/jbuilder/errors.rb#11
class Jbuilder::ArrayError < ::StandardError
  class << self
    # source://jbuilder//lib/jbuilder/errors.rb#12
    def build(key); end
  end
end

# source://jbuilder//lib/jbuilder.rb#30
Jbuilder::BLANK = T.let(T.unsafe(nil), Jbuilder::Blank)

# source://jbuilder//lib/jbuilder/blank.rb#2
class Jbuilder::Blank
  # source://jbuilder//lib/jbuilder/blank.rb#3
  def ==(other); end

  # @return [Boolean]
  #
  # source://jbuilder//lib/jbuilder/blank.rb#7
  def empty?; end
end

# source://jbuilder//lib/jbuilder/collection_renderer.rb#12
module Jbuilder::CollectionRenderable
  extend ::ActiveSupport::Concern

  mixes_in_class_methods ::Jbuilder::CollectionRenderable::ClassMethods

  private

  # source://jbuilder//lib/jbuilder/collection_renderer.rb#27
  def build_rendered_collection(templates, _spacer); end

  # source://jbuilder//lib/jbuilder/collection_renderer.rb#23
  def build_rendered_template(content, template, layout = T.unsafe(nil)); end

  # source://jbuilder//lib/jbuilder/collection_renderer.rb#31
  def json; end
end

# source://jbuilder//lib/jbuilder/collection_renderer.rb#0
module Jbuilder::CollectionRenderable::ClassMethods
  # source://jbuilder//lib/jbuilder/collection_renderer.rb#16
  def supported?; end
end

# source://jbuilder//lib/jbuilder/collection_renderer.rb#35
class Jbuilder::CollectionRenderable::ScopedIterator < ::SimpleDelegator
  include ::ActiveSupport::ToJsonWithActiveSupportEncoder
  include ::Enumerable

  # @return [ScopedIterator] a new instance of ScopedIterator
  #
  # source://jbuilder//lib/jbuilder/collection_renderer.rb#38
  def initialize(obj, scope); end

  # Rails 6.0 support:
  #
  # source://jbuilder//lib/jbuilder/collection_renderer.rb#44
  def each; end

  # Rails 6.1 support:
  #
  # source://jbuilder//lib/jbuilder/collection_renderer.rb#53
  def each_with_info; end
end

# Rails 6.0 support:
#
# source://jbuilder//lib/jbuilder/collection_renderer.rb#67
class Jbuilder::CollectionRenderer < ::ActionView::CollectionRenderer
  include ::Jbuilder::CollectionRenderable
  extend ::Jbuilder::CollectionRenderable::ClassMethods

  # @return [CollectionRenderer] a new instance of CollectionRenderer
  #
  # source://jbuilder//lib/jbuilder/collection_renderer.rb#70
  def initialize(lookup_context, options, &scope); end

  private

  # source://jbuilder//lib/jbuilder/collection_renderer.rb#76
  def collection_with_template(view, template, layout, collection); end
end

# source://jbuilder//lib/jbuilder/collection_renderer.rb#110
class Jbuilder::EnumerableCompat < ::SimpleDelegator
  # Rails 6.1 requires this.
  #
  # source://jbuilder//lib/jbuilder/collection_renderer.rb#112
  def size(*args, &block); end
end

# source://jbuilder//lib/jbuilder/key_formatter.rb#5
class Jbuilder::KeyFormatter
  # @return [KeyFormatter] a new instance of KeyFormatter
  #
  # source://jbuilder//lib/jbuilder/key_formatter.rb#6
  def initialize(*args); end

  # source://jbuilder//lib/jbuilder/key_formatter.rb#23
  def format(key); end

  private

  # source://jbuilder//lib/jbuilder/key_formatter.rb#19
  def initialize_copy(original); end
end

# source://jbuilder//lib/jbuilder/errors.rb#18
class Jbuilder::MergeError < ::StandardError
  class << self
    # source://jbuilder//lib/jbuilder/errors.rb#19
    def build(current_value, updates); end
  end
end

# source://jbuilder//lib/jbuilder/errors.rb#4
class Jbuilder::NullError < ::NoMethodError
  class << self
    # source://jbuilder//lib/jbuilder/errors.rb#5
    def build(key); end
  end
end

# source://jbuilder//lib/jbuilder/railtie.rb#5
class Jbuilder::Railtie < ::Rails::Railtie; end

# source://jbuilder//lib/jbuilder/version.rb#2
Jbuilder::VERSION = T.let(T.unsafe(nil), String)

# source://jbuilder//lib/jbuilder/jbuilder_template.rb#280
class JbuilderHandler
  # source://jbuilder//lib/jbuilder/jbuilder_template.rb#281
  def default_format; end

  # source://jbuilder//lib/jbuilder/jbuilder_template.rb#281
  def default_format=(val); end

  class << self
    # source://jbuilder//lib/jbuilder/jbuilder_template.rb#284
    def call(template, source = T.unsafe(nil)); end

    # source://jbuilder//lib/jbuilder/jbuilder_template.rb#281
    def default_format; end

    # source://jbuilder//lib/jbuilder/jbuilder_template.rb#281
    def default_format=(val); end
  end
end

# source://jbuilder//lib/jbuilder/jbuilder_template.rb#6
class JbuilderTemplate < ::Jbuilder
  # @return [JbuilderTemplate] a new instance of JbuilderTemplate
  #
  # source://jbuilder//lib/jbuilder/jbuilder_template.rb#13
  def initialize(context, *args); end

  # source://jbuilder//lib/jbuilder/jbuilder_template.rb#117
  def array!(collection = T.unsafe(nil), *args); end

  # Caches the json constructed within the block passed. Has the same signature as the `cache` helper
  # method in `ActionView::Helpers::CacheHelper` and so can be used in the same way.
  #
  # Example:
  #
  #   json.cache! ['v1', @person], expires_in: 10.minutes do
  #     json.extract! @person, :name, :age
  #   end
  #
  # source://jbuilder//lib/jbuilder/jbuilder_template.rb#67
  def cache!(key = T.unsafe(nil), options = T.unsafe(nil)); end

  # Conditionally caches the json depending in the condition given as first parameter. Has the same
  # signature as the `cache` helper method in `ActionView::Helpers::CacheHelper` and so can be used in
  # the same way.
  #
  # Example:
  #
  #   json.cache_if! !admin?, @person, expires_in: 10.minutes do
  #     json.extract! @person, :name, :age
  #   end
  #
  # source://jbuilder//lib/jbuilder/jbuilder_template.rb#109
  def cache_if!(condition, *args, &block); end

  # Caches the json structure at the root using a string rather than the hash structure. This is considerably
  # faster, but the drawback is that it only works, as the name hints, at the root. So you cannot
  # use this approach to cache deeper inside the hierarchy, like in partials or such. Continue to use #cache! there.
  #
  # Example:
  #
  #   json.cache_root! @person do
  #     json.extract! @person, :name, :age
  #   end
  #
  #   # json.extra 'This will not work either, the root must be exclusive'
  #
  # source://jbuilder//lib/jbuilder/jbuilder_template.rb#90
  def cache_root!(key = T.unsafe(nil), options = T.unsafe(nil)); end

  # Generates JSON using the template specified with the `:partial` option. For example, the code below will render
  # the file `views/comments/_comments.json.jbuilder`, and set a local variable comments with all this message's
  # comments, which can be used inside the partial.
  #
  # Example:
  #
  #   json.partial! 'comments/comments', comments: @message.comments
  #
  # There are multiple ways to generate a collection of elements as JSON, as ilustrated below:
  #
  # Example:
  #
  #   json.array! @posts, partial: 'posts/post', as: :post
  #
  #   # or:
  #   json.partial! 'posts/post', collection: @posts, as: :post
  #
  #   # or:
  #   json.partial! partial: 'posts/post', collection: @posts, as: :post
  #
  #   # or:
  #   json.comments @post.comments, partial: 'comments/comment', as: :comment
  #
  # Aside from that, the `:cached` options is available on Rails >= 6.0. This will cache the rendered results
  # effectively using the multi fetch feature.
  #
  # Example:
  #
  #   json.array! @posts, partial: "posts/post", as: :post, cached: true
  #
  #   json.comments @post.comments, partial: "comments/comment", as: :comment, cached: true
  #
  # source://jbuilder//lib/jbuilder/jbuilder_template.rb#51
  def partial!(*args); end

  # source://jbuilder//lib/jbuilder/jbuilder_template.rb#127
  def set!(name, object = T.unsafe(nil), *args); end

  # source://jbuilder//lib/jbuilder/jbuilder_template.rb#113
  def target!; end

  private

  # source://jbuilder//lib/jbuilder/jbuilder_template.rb#193
  def _cache_fragment_for(key, options, &block); end

  # source://jbuilder//lib/jbuilder/jbuilder_template.rb#212
  def _cache_key(key, options); end

  # source://jbuilder//lib/jbuilder/jbuilder_template.rb#225
  def _fragment_name_with_digest(key, options); end

  # @return [Boolean]
  #
  # source://jbuilder//lib/jbuilder/jbuilder_template.rb#237
  def _is_active_model?(object); end

  # @return [Boolean]
  #
  # source://jbuilder//lib/jbuilder/jbuilder_template.rb#233
  def _partial_options?(options); end

  # source://jbuilder//lib/jbuilder/jbuilder_template.rb#198
  def _read_fragment_cache(key, options = T.unsafe(nil)); end

  # source://jbuilder//lib/jbuilder/jbuilder_template.rb#275
  def _render_active_model_partial(object); end

  # source://jbuilder//lib/jbuilder/jbuilder_template.rb#254
  def _render_explicit_partial(name_or_options, locals = T.unsafe(nil)); end

  # source://jbuilder//lib/jbuilder/jbuilder_template.rb#188
  def _render_partial(options); end

  # source://jbuilder//lib/jbuilder/jbuilder_template.rb#139
  def _render_partial_with_options(options); end

  # source://jbuilder//lib/jbuilder/jbuilder_template.rb#241
  def _set_inline_partial(name, object, options); end

  # source://jbuilder//lib/jbuilder/jbuilder_template.rb#204
  def _write_fragment_cache(key, options = T.unsafe(nil)); end

  class << self
    # Returns the value of attribute template_lookup_options.
    #
    # source://jbuilder//lib/jbuilder/jbuilder_template.rb#8
    def template_lookup_options; end

    # Sets the attribute template_lookup_options
    #
    # @param value the value to set the attribute template_lookup_options to.
    #
    # source://jbuilder//lib/jbuilder/jbuilder_template.rb#8
    def template_lookup_options=(_arg0); end
  end
end