From f5fdb7373ccf15d57475eb89f729a39d53f3094f Mon Sep 17 00:00:00 2001 From: Olivier Bellone Date: Mon, 15 Jul 2024 09:59:42 -0700 Subject: [PATCH] Entity name setter method --- Gemfile | 2 + Gemfile.lock | 5 + lib/grape_sorbet.rb | 1 + lib/grape_sorbet/grape_entity_name.rb | 89 ++ sorbet/rbi/dsl/grape/dsl/api.rbi | 17 + sorbet/rbi/dsl/grape/dsl/callbacks.rbi | 10 + sorbet/rbi/dsl/grape/dsl/helpers.rbi | 10 + sorbet/rbi/dsl/grape/dsl/middleware.rbi | 10 + sorbet/rbi/dsl/grape/dsl/request_response.rbi | 10 + sorbet/rbi/dsl/grape/dsl/routing.rbi | 10 + sorbet/rbi/dsl/grape/dsl/validations.rbi | 10 + sorbet/rbi/gems/grape-entity@1.0.1.rbi | 1151 +++++++++++++++++ sorbet/rbi/gems/multi_json@1.15.0.rbi | 268 ++++ spec/grape_entity/entity_spec.rb | 53 + spec/spec_helper.rb | 2 + 15 files changed, 1648 insertions(+) create mode 100644 lib/grape_sorbet/grape_entity_name.rb create mode 100644 sorbet/rbi/dsl/grape/dsl/api.rbi create mode 100644 sorbet/rbi/dsl/grape/dsl/callbacks.rbi create mode 100644 sorbet/rbi/dsl/grape/dsl/helpers.rbi create mode 100644 sorbet/rbi/dsl/grape/dsl/middleware.rbi create mode 100644 sorbet/rbi/dsl/grape/dsl/request_response.rbi create mode 100644 sorbet/rbi/dsl/grape/dsl/routing.rbi create mode 100644 sorbet/rbi/dsl/grape/dsl/validations.rbi create mode 100644 sorbet/rbi/gems/grape-entity@1.0.1.rbi create mode 100644 sorbet/rbi/gems/multi_json@1.15.0.rbi create mode 100644 spec/grape_entity/entity_spec.rb diff --git a/Gemfile b/Gemfile index 7dce20e..c08c581 100644 --- a/Gemfile +++ b/Gemfile @@ -32,4 +32,6 @@ group :test do gem "minitest-reporters", "~> 1.4" gem "simplecov", require: false + + gem "grape-entity", require: false end diff --git a/Gemfile.lock b/Gemfile.lock index 8128ecc..51224e9 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -53,6 +53,9 @@ GEM mustermann-grape (~> 1.1.0) rack (>= 2) zeitwerk + grape-entity (1.0.1) + activesupport (>= 3.0.0) + multi_json (>= 1.3.2) i18n (1.14.5) concurrent-ruby (~> 1.0) io-console (0.7.2) @@ -67,6 +70,7 @@ GEM builder minitest (>= 5.0) ruby-progressbar + multi_json (1.15.0) mustermann (3.0.0) ruby2_keywords (~> 0.0.1) mustermann-grape (1.1.0) @@ -169,6 +173,7 @@ PLATFORMS DEPENDENCIES bundler-audit + grape-entity grape_sorbet! irb minitest (~> 5.0) diff --git a/lib/grape_sorbet.rb b/lib/grape_sorbet.rb index 0a98c66..09f6d89 100644 --- a/lib/grape_sorbet.rb +++ b/lib/grape_sorbet.rb @@ -5,3 +5,4 @@ module GrapeSorbet end require_relative "grape_sorbet/version" +require_relative "grape_sorbet/grape_entity_name" diff --git a/lib/grape_sorbet/grape_entity_name.rb b/lib/grape_sorbet/grape_entity_name.rb new file mode 100644 index 0000000..b7fced5 --- /dev/null +++ b/lib/grape_sorbet/grape_entity_name.rb @@ -0,0 +1,89 @@ +# typed: strict +# frozen_string_literal: true + +require "sorbet-runtime" + +module GrapeSorbet + # This is a patch for Grape::Entity to make it easier to define custom entity names when using Sorbet. + # + # This patch defines a class setter `entity_name=` that can be used to define a custom entity name in a single line, + # while still working as expected with grape-swagger: + # ``` + # class Link < Grape::Entity + # self.entity_name = "LinkedStatus" + # end + # ``` + # + # Without this patch, you would have to define a custom entity name like this: + # ``` + # class Link < Grape::Entity + # extend T::Sig + # + # sig { returns(String) } + # def self.entity_name + # "LinkedStatus" + # end + # end + # ``` + # + # or even more verbose, if you're using the `Style/ClassMethodsDefinitions` Rubocop rule with + # `EnforcedStyle: self_class`: + # ``` + # class Link < Grape::Entity + # class << self + # extend T::Sig + # + # sig { returns(String) } + # def entity_name + # "LinkedStatus" + # end + # end + # end + # ``` + module GrapeEntityName + extend T::Sig + + include Kernel + + # Sets the entity name. + # + # Used by grape-swagger to define a custom name to use in the OpenAPI schema instead of generating it from the + # fully qualified class name. + # + # @param entity_name [String] The custom entity name. + sig { params(entity_name: String).returns(String) } + attr_writer :entity_name + + # Returns the custom entity name if one has been set (using `entity_name=`), otherwise raises an error. + # + # @return [String] The custom entity name. + # @raise [StandardError] If no custom entity name has been set. + sig { returns(String) } + def entity_name + @entity_name = T.let(@entity_name, T.nilable(String)) + + return @entity_name unless @entity_name.nil? + + raise "entity_name has not been set for #{self}, call `#{self}.entity_name = \"...\"` to set it" + end + + sig { params(method_name: T.any(String, Symbol), include_all: T.untyped).returns(T::Boolean) } + def respond_to?(method_name, include_all = false) + # grape-swagger checks if the model class responds to `:entity_name`, so we need to return false if + # `@entity_name` is nil (meaning `entity_name=` was never called). + if method_name.to_sym == :entity_name + return !!(defined?(@entity_name) && !@entity_name.nil?) + end + + super + end + end +end + +begin + require "grape-entity" +rescue LoadError + return +else + Grape::Entity.extend(GrapeSorbet::GrapeEntityName) +end diff --git a/sorbet/rbi/dsl/grape/dsl/api.rbi b/sorbet/rbi/dsl/grape/dsl/api.rbi new file mode 100644 index 0000000..0cd80b5 --- /dev/null +++ b/sorbet/rbi/dsl/grape/dsl/api.rbi @@ -0,0 +1,17 @@ +# typed: true + +# DO NOT EDIT MANUALLY +# This is an autogenerated file for dynamic methods in `Grape::DSL::API`. +# Please instead update this file by running `bin/tapioca dsl Grape::DSL::API`. + + +module Grape::DSL::API + mixes_in_class_methods ::Grape::Middleware::Auth::DSL::ClassMethods + mixes_in_class_methods ::Grape::DSL::Configuration::ClassMethods + mixes_in_class_methods ::Grape::DSL::Validations::ClassMethods + mixes_in_class_methods ::Grape::DSL::Callbacks::ClassMethods + mixes_in_class_methods ::Grape::DSL::Helpers::ClassMethods + mixes_in_class_methods ::Grape::DSL::Middleware::ClassMethods + mixes_in_class_methods ::Grape::DSL::RequestResponse::ClassMethods + mixes_in_class_methods ::Grape::DSL::Routing::ClassMethods +end diff --git a/sorbet/rbi/dsl/grape/dsl/callbacks.rbi b/sorbet/rbi/dsl/grape/dsl/callbacks.rbi new file mode 100644 index 0000000..8f6a80c --- /dev/null +++ b/sorbet/rbi/dsl/grape/dsl/callbacks.rbi @@ -0,0 +1,10 @@ +# typed: true + +# DO NOT EDIT MANUALLY +# This is an autogenerated file for dynamic methods in `Grape::DSL::Callbacks`. +# Please instead update this file by running `bin/tapioca dsl Grape::DSL::Callbacks`. + + +module Grape::DSL::Callbacks + mixes_in_class_methods ::Grape::DSL::Configuration::ClassMethods +end diff --git a/sorbet/rbi/dsl/grape/dsl/helpers.rbi b/sorbet/rbi/dsl/grape/dsl/helpers.rbi new file mode 100644 index 0000000..355b144 --- /dev/null +++ b/sorbet/rbi/dsl/grape/dsl/helpers.rbi @@ -0,0 +1,10 @@ +# typed: true + +# DO NOT EDIT MANUALLY +# This is an autogenerated file for dynamic methods in `Grape::DSL::Helpers`. +# Please instead update this file by running `bin/tapioca dsl Grape::DSL::Helpers`. + + +module Grape::DSL::Helpers + mixes_in_class_methods ::Grape::DSL::Configuration::ClassMethods +end diff --git a/sorbet/rbi/dsl/grape/dsl/middleware.rbi b/sorbet/rbi/dsl/grape/dsl/middleware.rbi new file mode 100644 index 0000000..dbbd333 --- /dev/null +++ b/sorbet/rbi/dsl/grape/dsl/middleware.rbi @@ -0,0 +1,10 @@ +# typed: true + +# DO NOT EDIT MANUALLY +# This is an autogenerated file for dynamic methods in `Grape::DSL::Middleware`. +# Please instead update this file by running `bin/tapioca dsl Grape::DSL::Middleware`. + + +module Grape::DSL::Middleware + mixes_in_class_methods ::Grape::DSL::Configuration::ClassMethods +end diff --git a/sorbet/rbi/dsl/grape/dsl/request_response.rbi b/sorbet/rbi/dsl/grape/dsl/request_response.rbi new file mode 100644 index 0000000..25aadf7 --- /dev/null +++ b/sorbet/rbi/dsl/grape/dsl/request_response.rbi @@ -0,0 +1,10 @@ +# typed: true + +# DO NOT EDIT MANUALLY +# This is an autogenerated file for dynamic methods in `Grape::DSL::RequestResponse`. +# Please instead update this file by running `bin/tapioca dsl Grape::DSL::RequestResponse`. + + +module Grape::DSL::RequestResponse + mixes_in_class_methods ::Grape::DSL::Configuration::ClassMethods +end diff --git a/sorbet/rbi/dsl/grape/dsl/routing.rbi b/sorbet/rbi/dsl/grape/dsl/routing.rbi new file mode 100644 index 0000000..73e4ad7 --- /dev/null +++ b/sorbet/rbi/dsl/grape/dsl/routing.rbi @@ -0,0 +1,10 @@ +# typed: true + +# DO NOT EDIT MANUALLY +# This is an autogenerated file for dynamic methods in `Grape::DSL::Routing`. +# Please instead update this file by running `bin/tapioca dsl Grape::DSL::Routing`. + + +module Grape::DSL::Routing + mixes_in_class_methods ::Grape::DSL::Configuration::ClassMethods +end diff --git a/sorbet/rbi/dsl/grape/dsl/validations.rbi b/sorbet/rbi/dsl/grape/dsl/validations.rbi new file mode 100644 index 0000000..0c69dd5 --- /dev/null +++ b/sorbet/rbi/dsl/grape/dsl/validations.rbi @@ -0,0 +1,10 @@ +# typed: true + +# DO NOT EDIT MANUALLY +# This is an autogenerated file for dynamic methods in `Grape::DSL::Validations`. +# Please instead update this file by running `bin/tapioca dsl Grape::DSL::Validations`. + + +module Grape::DSL::Validations + mixes_in_class_methods ::Grape::DSL::Configuration::ClassMethods +end diff --git a/sorbet/rbi/gems/grape-entity@1.0.1.rbi b/sorbet/rbi/gems/grape-entity@1.0.1.rbi new file mode 100644 index 0000000..d71f2a3 --- /dev/null +++ b/sorbet/rbi/gems/grape-entity@1.0.1.rbi @@ -0,0 +1,1151 @@ +# typed: true + +# DO NOT EDIT MANUALLY +# This is an autogenerated file for types exported from the `grape-entity` gem. +# Please instead update this file by running `bin/tapioca gem grape-entity`. + + +# source://grape-entity//lib/grape_entity/entity.rb#5 +module Grape + class << self + # source://grape/2.1.2/lib/grape.rb#61 + def deprecator; end + end +end + +# An Entity is a lightweight structure that allows you to easily +# represent data from your application in a consistent and abstracted +# way in your API. Entities can also provide documentation for the +# fields exposed. +# +# Entities are not independent structures, rather, they create +# **representations** of other Ruby objects using a number of methods +# that are convenient for use in an API. Once you've defined an Entity, +# you can use it in your API like this: +# +# @example Entity Definition +# +# module API +# module Entities +# class User < Grape::Entity +# expose :first_name, :last_name, :screen_name, :location +# expose :field, documentation: { type: "string", desc: "describe the field" } +# expose :latest_status, using: API::Status, as: :status, unless: { collection: true } +# expose :email, if: { type: :full } +# expose :new_attribute, if: { version: 'v2' } +# expose(:name) { |model, options| [model.first_name, model.last_name].join(' ') } +# end +# end +# end +# @example Usage in the API Layer +# +# module API +# class Users < Grape::API +# version 'v2' +# +# desc 'User index', { params: API::Entities::User.documentation } +# get '/users' do +# @users = User.all +# type = current_user.admin? ? :full : :default +# present @users, with: API::Entities::User, type: type +# end +# end +# end +# +# source://grape-entity//lib/grape_entity/entity.rb#45 +class Grape::Entity + # @return [Entity] a new instance of Entity + # + # source://grape-entity//lib/grape_entity/entity.rb#479 + def initialize(object, options = T.unsafe(nil)); end + + # The serializable hash is the Entity's primary output. It is the transformed + # hash for the given data model and is used as the basis for serialization to + # JSON and other formats. + # + # @param runtime_options [Hash] Any options you pass in here will be known to the entity + # representation, this is where you can trigger things from conditional options + # etc. + # + # source://grape-entity//lib/grape_entity/entity.rb#508 + def as_json(runtime_options = T.unsafe(nil)); end + + # source://grape-entity//lib/grape_entity/entity.rb#540 + def delegate_attribute(attribute); end + + # Returns the value of attribute delegator. + # + # source://grape-entity//lib/grape_entity/entity.rb#46 + def delegator; end + + # source://grape-entity//lib/grape_entity/entity.rb#493 + def documentation; end + + # source://grape-entity//lib/grape_entity/entity.rb#532 + def exec_with_attribute(attribute, &block); end + + # source://grape-entity//lib/grape_entity/entity.rb#516 + def exec_with_object(options, &block); end + + # source://grape-entity//lib/grape_entity/entity.rb#497 + def formatters; end + + # Prevent default serialization of :options or :delegator. + def inspect; end + + # @return [Boolean] + # + # source://grape-entity//lib/grape_entity/entity.rb#550 + def is_defined_in_entity?(attribute); end + + # Returns the value of attribute object. + # + # source://grape-entity//lib/grape_entity/entity.rb#46 + def object; end + + # Returns the value of attribute options. + # + # source://grape-entity//lib/grape_entity/entity.rb#46 + def options; end + + # source://grape-entity//lib/grape_entity/entity.rb#465 + def presented; end + + # source://grape-entity//lib/grape_entity/entity.rb#489 + def root_exposure; end + + # source://grape-entity//lib/grape_entity/entity.rb#485 + def root_exposures; end + + # The serializable hash is the Entity's primary output. It is the transformed + # hash for the given data model and is used as the basis for serialization to + # JSON and other formats. + # + # @param runtime_options [Hash] Any options you pass in here will be known to the entity + # representation, this is where you can trigger things from conditional options + # etc. + # + # source://grape-entity//lib/grape_entity/entity.rb#508 + def serializable_hash(runtime_options = T.unsafe(nil)); end + + # source://grape-entity//lib/grape_entity/entity.rb#559 + def to_json(options = T.unsafe(nil)); end + + # source://grape-entity//lib/grape_entity/entity.rb#564 + def to_xml(options = T.unsafe(nil)); end + + # source://grape-entity//lib/grape_entity/entity.rb#536 + def value_for(key, options = T.unsafe(nil)); end + + class << self + # source://grape-entity//lib/grape_entity/entity.rb#218 + def build_exposure_for_attribute(attribute, nesting_stack, options, block); end + + # @return [Boolean] + # + # source://grape-entity//lib/grape_entity/entity.rb#257 + def can_unexpose?; end + + # source://grape-entity//lib/grape_entity/entity.rb#261 + def cannot_unexpose!; end + + # source://grape-entity//lib/grape_entity/entity.rb#129 + def delegation_opts; end + + # Returns a hash, the keys are symbolized references to fields in the entity, + # the values are document keys in the entity's documentation key. When calling + # #docmentation, any exposure without a documentation key will be ignored. + # + # source://grape-entity//lib/grape_entity/entity.rb#283 + def documentation; end + + # This method is the primary means by which you will declare what attributes + # should be exposed by the entity. + # + # Note the parameters passed in via the lambda syntax. + # + # + # @example as: a proc or lambda + # + # object = OpenStruct(awesomeness: 'awesome_key', awesome: 'not-my-key', other: 'other-key' ) + # + # class MyEntity < Grape::Entity + # expose :awesome, as: proc { object.awesomeness } + # expose :awesomeness, as: ->(object, opts) { object.other } + # end + # + # => { 'awesome_key': 'not-my-key', 'other-key': 'awesome_key' } + # @option options + # @option options + # @option options + # @option options + # @option options + # @option options + # @option options + # @option options + # @param options [Hash] a customizable set of options + # + # source://grape-entity//lib/grape_entity/entity.rb#190 + def expose(*args, &block); end + + # source://grape-entity//lib/grape_entity/entity.rb#241 + def find_exposure(attribute); end + + # This allows you to declare a Proc in which exposures can be formatted with. + # It take a block with an arity of 1 which is passed as the value of the exposed attribute. + # + # @example Formatter declaration + # + # module API + # module Entities + # class User < Grape::Entity + # format_with :timestamp do |date| + # date.strftime('%m/%d/%Y') + # end + # + # expose :birthday, :last_signed_in, format_with: :timestamp + # end + # end + # end + # @example Formatters are available to all decendants + # + # Grape::Entity.format_with :timestamp do |date| + # date.strftime('%m/%d/%Y') + # end + # @param name [Symbol] the name of the formatter + # @param block [Proc] the block that will interpret the exposed attribute + # @raise [ArgumentError] + # + # source://grape-entity//lib/grape_entity/entity.rb#315 + def format_with(name, &block); end + + # Returns all formatters that are registered for this and it's ancestors + # + # @return [Hash] of formatters + # + # source://grape-entity//lib/grape_entity/entity.rb#111 + def formatters; end + + # Sets the attribute formatters + # + # @param value the value to set the attribute formatters to. + # + # source://grape-entity//lib/grape_entity/entity.rb#107 + def formatters=(_arg0); end + + # source://grape-entity//lib/grape_entity/entity.rb#115 + def hash_access; end + + # source://grape-entity//lib/grape_entity/entity.rb#119 + def hash_access=(value); end + + # @private + # + # source://grape-entity//lib/grape_entity/entity.rb#136 + def inherited(subclass); end + + # Merges the given options with current block options. + # + # @param options [Hash] Exposure options. + # + # source://grape-entity//lib/grape_entity/entity.rb#593 + def merge_options(options); end + + # This allows you to present a collection of objects. + # + # When false (default) every object in a collection to present will be wrapped separately + # into an instance of your presenter. + # + # @example Entity Definition + # + # module API + # module Entities + # class User < Grape::Entity + # expose :id + # end + # + # class Users < Grape::Entity + # present_collection true + # expose :items, as: 'users', using: API::Entities::User + # expose :version, documentation: { type: 'string', + # desc: 'actual api version', + # required: true } + # + # def version + # options[:version] + # end + # end + # end + # end + # @example Usage in the API Layer + # + # module API + # class Users < Grape::API + # version 'v2' + # + # # this will render { "users" : [ { "id" : "1" }, { "id" : "2" } ], "version" : "v2" } + # get '/users' do + # @users = User.all + # present @users, with: API::Entities::Users + # end + # + # # this will render { "user" : { "id" : "1" } } + # get '/users/:id' do + # @user = User.find(params[:id]) + # present @user, with: API::Entities::User + # end + # end + # end + # @param present_collection [true or false] when true all objects will be available as + # items in your presenter instead of wrapping each object in an instance of your presenter. + # @param collection_name [Symbol] the name of the collection accessor in your entity object. + # Default :items + # + # source://grape-entity//lib/grape_entity/entity.rb#416 + def present_collection(present_collection = T.unsafe(nil), collection_name = T.unsafe(nil)); end + + # This convenience method allows you to instantiate one or more entities by + # passing either a singular or collection of objects. Each object will be + # initialized with the same options. If an array of objects is passed in, + # an array of entities will be returned. If a single object is passed in, + # a single entity will be returned. + # + # @option options + # @option options + # @option options + # @option options + # @param objects [Object or Array] One or more objects to be represented. + # @param options [Hash] Options that will be passed through to each entity + # representation. + # + # source://grape-entity//lib/grape_entity/entity.rb#438 + def represent(objects, options = T.unsafe(nil)); end + + # This allows you to set a root element name for your representation. + # + # @example Entity Definition + # + # module API + # module Entities + # class User < Grape::Entity + # root 'users', 'user' + # expose :id + # end + # end + # end + # @example Usage in the API Layer + # + # module API + # class Users < Grape::API + # version 'v2' + # + # # this will render { "users" : [ { "id" : "1" }, { "id" : "2" } ] } + # get '/users' do + # @users = User.all + # present @users, with: API::Entities::User + # end + # + # # this will render { "user" : { "id" : "1" } } + # get '/users/:id' do + # @user = User.find(params[:id]) + # present @user, with: API::Entities::User + # end + # end + # end + # @param plural [String] the root key to use when representing + # a collection of objects. If missing or nil, no root key will be used + # when representing collections of objects. + # @param singular [String] the root key to use when representing + # a single object. If missing or nil, no root key will be used when + # representing an individual object. + # + # source://grape-entity//lib/grape_entity/entity.rb#360 + def root(plural, singular = T.unsafe(nil)); end + + # This method returns the entity's root or collection root node, or its parent's + # + # @param root_type: either :collection_root or just :root + # + # source://grape-entity//lib/grape_entity/entity.rb#456 + def root_element(root_type); end + + # source://grape-entity//lib/grape_entity/entity.rb#103 + def root_exposure; end + + # Sets the attribute root_exposure + # + # @param value the value to set the attribute root_exposure to. + # + # source://grape-entity//lib/grape_entity/entity.rb#107 + def root_exposure=(_arg0); end + + # Returns exposures that have been declared for this Entity on the top level. + # + # @return [Array] of exposures + # + # source://grape-entity//lib/grape_entity/entity.rb#237 + def root_exposures; end + + # source://grape-entity//lib/grape_entity/entity.rb#245 + def unexpose(*attributes); end + + # source://grape-entity//lib/grape_entity/entity.rb#251 + def unexpose_all; end + + # Raises an error if the given options include unknown keys. + # Renames aliased options. + # + # @param options [Hash] Exposure options. + # + # source://grape-entity//lib/grape_entity/entity.rb#622 + def valid_options(options); end + + # Set options that will be applied to any exposures declared inside the block. + # + # @example Multi-exposure if + # + # class MyEntity < Grape::Entity + # with_options if: { awesome: true } do + # expose :awesome, :sweet + # end + # end + # + # source://grape-entity//lib/grape_entity/entity.rb#274 + def with_options(options); end + end +end + +# source://grape-entity//lib/grape_entity/condition/base.rb#5 +module Grape::Entity::Condition + class << self + # source://grape-entity//lib/grape_entity/condition.rb#12 + def new_if(arg); end + + # source://grape-entity//lib/grape_entity/condition.rb#16 + def new_unless(arg); end + + private + + # source://grape-entity//lib/grape_entity/condition.rb#22 + def condition(inverse, arg); end + end +end + +# source://grape-entity//lib/grape_entity/condition/base.rb#6 +class Grape::Entity::Condition::Base + # @return [Base] a new instance of Base + # + # source://grape-entity//lib/grape_entity/condition/base.rb#11 + def initialize(inverse = T.unsafe(nil)); end + + # source://grape-entity//lib/grape_entity/condition/base.rb#15 + def ==(other); end + + # @raise [NotImplementedError] + # + # source://grape-entity//lib/grape_entity/condition/base.rb#27 + def if_value(_entity, _options); end + + # @return [Boolean] + # + # source://grape-entity//lib/grape_entity/condition/base.rb#19 + def inversed?; end + + # @return [Boolean] + # + # source://grape-entity//lib/grape_entity/condition/base.rb#23 + def met?(entity, options); end + + # source://grape-entity//lib/grape_entity/condition/base.rb#31 + def unless_value(entity, options); end + + class << self + # source://grape-entity//lib/grape_entity/condition/base.rb#7 + def new(inverse, *_arg1, **_arg2, &_arg3); end + end +end + +# source://grape-entity//lib/grape_entity/condition/block_condition.rb#6 +class Grape::Entity::Condition::BlockCondition < ::Grape::Entity::Condition::Base + # source://grape-entity//lib/grape_entity/condition/block_condition.rb#13 + def ==(other); end + + # Returns the value of attribute block. + # + # source://grape-entity//lib/grape_entity/condition/block_condition.rb#7 + def block; end + + # source://grape-entity//lib/grape_entity/condition/block_condition.rb#17 + def if_value(entity, options); end + + # source://grape-entity//lib/grape_entity/condition/block_condition.rb#9 + def setup(block); end +end + +# source://grape-entity//lib/grape_entity/condition/hash_condition.rb#6 +class Grape::Entity::Condition::HashCondition < ::Grape::Entity::Condition::Base + # source://grape-entity//lib/grape_entity/condition/hash_condition.rb#13 + def ==(other); end + + # Returns the value of attribute cond_hash. + # + # source://grape-entity//lib/grape_entity/condition/hash_condition.rb#7 + def cond_hash; end + + # source://grape-entity//lib/grape_entity/condition/hash_condition.rb#17 + def if_value(_entity, options); end + + # source://grape-entity//lib/grape_entity/condition/hash_condition.rb#9 + def setup(cond_hash); end + + # source://grape-entity//lib/grape_entity/condition/hash_condition.rb#21 + def unless_value(_entity, options); end +end + +# source://grape-entity//lib/grape_entity/condition/symbol_condition.rb#6 +class Grape::Entity::Condition::SymbolCondition < ::Grape::Entity::Condition::Base + # source://grape-entity//lib/grape_entity/condition/symbol_condition.rb#13 + def ==(other); end + + # source://grape-entity//lib/grape_entity/condition/symbol_condition.rb#17 + def if_value(_entity, options); end + + # source://grape-entity//lib/grape_entity/condition/symbol_condition.rb#9 + def setup(symbol); end + + # Returns the value of attribute symbol. + # + # source://grape-entity//lib/grape_entity/condition/symbol_condition.rb#7 + def symbol; end +end + +# The Entity DSL allows you to mix entity functionality into +# your existing classes. +# +# source://grape-entity//lib/grape_entity/entity.rb#50 +module Grape::Entity::DSL + mixes_in_class_methods ::Grape::Entity::DSL::ClassMethods + + # Instantiates an entity version of this object. + # + # source://grape-entity//lib/grape_entity/entity.rb#97 + def entity(options = T.unsafe(nil)); end + + class << self + # @private + # + # source://grape-entity//lib/grape_entity/entity.rb#51 + def included(base); end + end +end + +# source://grape-entity//lib/grape_entity/entity.rb#57 +module Grape::Entity::DSL::ClassMethods + # Call this to make exposures to the entity for this Class. + # Can be called with symbols for the attributes to expose, + # a block that yields the full Entity DSL (See Grape::Entity), + # or both. + # + # @example Symbols only. + # + # class User + # include Grape::Entity::DSL + # + # entity :name, :email + # end + # @example Mixed. + # + # class User + # include Grape::Entity::DSL + # + # entity :name, :email do + # expose :latest_status, using: Status::Entity, if: :include_status + # expose :new_attribute, if: { version: 'v2' } + # end + # end + # + # source://grape-entity//lib/grape_entity/entity.rb#89 + def entity(*exposures, &block); end + + # Returns the automatically-created entity class for this + # Class. + # + # source://grape-entity//lib/grape_entity/entity.rb#60 + def entity_class(search_ancestors = T.unsafe(nil)); end +end + +# source://grape-entity//lib/grape_entity/delegator/base.rb#5 +module Grape::Entity::Delegator + class << self + # source://grape-entity//lib/grape_entity/delegator.rb#11 + def new(object); end + end +end + +# source://grape-entity//lib/grape_entity/delegator/base.rb#6 +class Grape::Entity::Delegator::Base + # @return [Base] a new instance of Base + # + # source://grape-entity//lib/grape_entity/delegator/base.rb#9 + def initialize(object); end + + # @return [Boolean] + # + # source://grape-entity//lib/grape_entity/delegator/base.rb#17 + def accepts_options?; end + + # @return [Boolean] + # + # source://grape-entity//lib/grape_entity/delegator/base.rb#13 + def delegatable?(_attribute); end + + # Returns the value of attribute object. + # + # source://grape-entity//lib/grape_entity/delegator/base.rb#7 + def object; end +end + +# source://grape-entity//lib/grape_entity/delegator/hash_object.rb#6 +class Grape::Entity::Delegator::HashObject < ::Grape::Entity::Delegator::Base + # source://grape-entity//lib/grape_entity/delegator/hash_object.rb#7 + def delegate(attribute, hash_access: T.unsafe(nil)); end +end + +# source://grape-entity//lib/grape_entity/delegator/openstruct_object.rb#6 +class Grape::Entity::Delegator::OpenStructObject < ::Grape::Entity::Delegator::Base + # source://grape-entity//lib/grape_entity/delegator/openstruct_object.rb#7 + def delegate(attribute); end +end + +# source://grape-entity//lib/grape_entity/delegator/plain_object.rb#6 +class Grape::Entity::Delegator::PlainObject < ::Grape::Entity::Delegator::Base + # @return [Boolean] + # + # source://grape-entity//lib/grape_entity/delegator/plain_object.rb#11 + def delegatable?(attribute); end + + # source://grape-entity//lib/grape_entity/delegator/plain_object.rb#7 + def delegate(attribute); end +end + +# source://grape-entity//lib/grape_entity/deprecated.rb#5 +class Grape::Entity::Deprecated < ::StandardError + # @return [Deprecated] a new instance of Deprecated + # + # source://grape-entity//lib/grape_entity/deprecated.rb#6 + def initialize(msg, spec); end +end + +# source://grape-entity//lib/grape_entity/exposure/base.rb#8 +module Grape::Entity::Exposure + class << self + # source://grape-entity//lib/grape_entity/exposure.rb#16 + def new(attribute, options); end + + private + + # source://grape-entity//lib/grape_entity/exposure.rb#95 + def build_block_exposure(base_args, passed_proc); end + + # source://grape-entity//lib/grape_entity/exposure.rb#72 + def build_class_exposure(base_args, using_class, passed_proc); end + + # source://grape-entity//lib/grape_entity/exposure.rb#99 + def build_delegator_exposure(base_args); end + + # source://grape-entity//lib/grape_entity/exposure.rb#83 + def build_formatter_exposure(base_args, format_with); end + + # source://grape-entity//lib/grape_entity/exposure.rb#91 + def build_nesting_exposure(base_args); end + + # source://grape-entity//lib/grape_entity/exposure.rb#39 + def compile_conditions(attribute, options); end + + # source://grape-entity//lib/grape_entity/exposure.rb#55 + def expose_nil_condition(attribute, options); end + end +end + +# source://grape-entity//lib/grape_entity/exposure/base.rb#9 +class Grape::Entity::Exposure::Base + # @return [Base] a new instance of Base + # + # source://grape-entity//lib/grape_entity/exposure/base.rb#16 + def initialize(attribute, options, conditions); end + + # source://grape-entity//lib/grape_entity/exposure/base.rb#38 + def ==(other); end + + # source://grape-entity//lib/grape_entity/exposure/base.rb#111 + def attr_path(entity, options); end + + # Returns the value of attribute attribute. + # + # source://grape-entity//lib/grape_entity/exposure/base.rb#10 + def attribute; end + + # @return [Boolean] + # + # source://grape-entity//lib/grape_entity/exposure/base.rb#99 + def conditional?; end + + # Returns the value of attribute conditions. + # + # source://grape-entity//lib/grape_entity/exposure/base.rb#10 + def conditions; end + + # @return [Boolean] + # + # source://grape-entity//lib/grape_entity/exposure/base.rb#103 + def conditions_met?(entity, options); end + + # if we have any nesting exposures with the same name. + # + # @return [Boolean] + # + # source://grape-entity//lib/grape_entity/exposure/base.rb#52 + def deep_complex_nesting?(entity); end + + # Returns the value of attribute documentation. + # + # source://grape-entity//lib/grape_entity/exposure/base.rb#10 + def documentation; end + + # source://grape-entity//lib/grape_entity/exposure/base.rb#30 + def dup(&block); end + + # source://grape-entity//lib/grape_entity/exposure/base.rb#34 + def dup_args; end + + # Returns the value of attribute for_merge. + # + # source://grape-entity//lib/grape_entity/exposure/base.rb#10 + def for_merge; end + + # Returns the value of attribute is_safe. + # + # source://grape-entity//lib/grape_entity/exposure/base.rb#10 + def is_safe; end + + # source://grape-entity//lib/grape_entity/exposure/base.rb#119 + def key(entity = T.unsafe(nil)); end + + # @return [Boolean] + # + # source://grape-entity//lib/grape_entity/exposure/base.rb#47 + def nesting?; end + + # Returns the value of attribute override. + # + # source://grape-entity//lib/grape_entity/exposure/base.rb#10 + def override; end + + # @return [Boolean] + # + # source://grape-entity//lib/grape_entity/exposure/base.rb#128 + def override?; end + + # source://grape-entity//lib/grape_entity/exposure/base.rb#72 + def serializable_value(entity, options); end + + # source://grape-entity//lib/grape_entity/exposure/base.rb#45 + def setup; end + + # @return [Boolean] + # + # source://grape-entity//lib/grape_entity/exposure/base.rb#107 + def should_expose?(entity, options); end + + # @return [Boolean] + # + # source://grape-entity//lib/grape_entity/exposure/base.rb#95 + def should_return_key?(options); end + + # @return [Boolean] + # + # source://grape-entity//lib/grape_entity/exposure/base.rb#56 + def valid?(entity); end + + # source://grape-entity//lib/grape_entity/exposure/base.rb#88 + def valid_value(entity, options); end + + # @raise [NotImplementedError] + # + # source://grape-entity//lib/grape_entity/exposure/base.rb#68 + def value(_entity, _options); end + + # source://grape-entity//lib/grape_entity/exposure/base.rb#123 + def with_attr_path(entity, options, &block); end + + protected + + # Returns the value of attribute options. + # + # source://grape-entity//lib/grape_entity/exposure/base.rb#134 + def options; end + + class << self + # source://grape-entity//lib/grape_entity/exposure/base.rb#12 + def new(attribute, options, conditions, *_arg3, **_arg4, &_arg5); end + end +end + +# source://grape-entity//lib/grape_entity/exposure/block_exposure.rb#6 +class Grape::Entity::Exposure::BlockExposure < ::Grape::Entity::Exposure::Base + # source://grape-entity//lib/grape_entity/exposure/block_exposure.rb#17 + def ==(other); end + + # Returns the value of attribute block. + # + # source://grape-entity//lib/grape_entity/exposure/block_exposure.rb#7 + def block; end + + # source://grape-entity//lib/grape_entity/exposure/block_exposure.rb#13 + def dup; end + + # source://grape-entity//lib/grape_entity/exposure/block_exposure.rb#25 + def setup(&block); end + + # @return [Boolean] + # + # source://grape-entity//lib/grape_entity/exposure/block_exposure.rb#21 + def valid?(_entity); end + + # source://grape-entity//lib/grape_entity/exposure/block_exposure.rb#9 + def value(entity, options); end +end + +# source://grape-entity//lib/grape_entity/exposure/delegator_exposure.rb#6 +class Grape::Entity::Exposure::DelegatorExposure < ::Grape::Entity::Exposure::Base + # source://grape-entity//lib/grape_entity/exposure/delegator_exposure.rb#7 + def value(entity, _options); end +end + +# source://grape-entity//lib/grape_entity/exposure/formatter_block_exposure.rb#6 +class Grape::Entity::Exposure::FormatterBlockExposure < ::Grape::Entity::Exposure::Base + # source://grape-entity//lib/grape_entity/exposure/formatter_block_exposure.rb#17 + def ==(other); end + + # source://grape-entity//lib/grape_entity/exposure/formatter_block_exposure.rb#13 + def dup; end + + # Returns the value of attribute format_with. + # + # source://grape-entity//lib/grape_entity/exposure/formatter_block_exposure.rb#7 + def format_with; end + + # source://grape-entity//lib/grape_entity/exposure/formatter_block_exposure.rb#9 + def setup(&format_with); end + + # source://grape-entity//lib/grape_entity/exposure/formatter_block_exposure.rb#21 + def value(entity, _options); end +end + +# source://grape-entity//lib/grape_entity/exposure/formatter_exposure.rb#6 +class Grape::Entity::Exposure::FormatterExposure < ::Grape::Entity::Exposure::Base + # source://grape-entity//lib/grape_entity/exposure/formatter_exposure.rb#17 + def ==(other); end + + # source://grape-entity//lib/grape_entity/exposure/formatter_exposure.rb#13 + def dup_args; end + + # Returns the value of attribute format_with. + # + # source://grape-entity//lib/grape_entity/exposure/formatter_exposure.rb#7 + def format_with; end + + # source://grape-entity//lib/grape_entity/exposure/formatter_exposure.rb#9 + def setup(format_with); end + + # source://grape-entity//lib/grape_entity/exposure/formatter_exposure.rb#21 + def value(entity, _options); end +end + +# source://grape-entity//lib/grape_entity/exposure/nesting_exposure.rb#6 +class Grape::Entity::Exposure::NestingExposure < ::Grape::Entity::Exposure::Base + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure.rb#17 + def ==(other); end + + # if we have any nesting exposures with the same name. + # delegate :deep_complex_nesting?(entity), to: :nested_exposures + # + # @return [Boolean] + # + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure.rb#59 + def deep_complex_nesting?(entity); end + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure.rb#13 + def dup_args; end + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure.rb#25 + def find_nested_exposure(attribute); end + + # Returns the value of attribute nested_exposures. + # + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure.rb#7 + def nested_exposures; end + + # @return [Boolean] + # + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure.rb#21 + def nesting?; end + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure.rb#39 + def serializable_value(entity, options); end + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure.rb#9 + def setup(nested_exposures = T.unsafe(nil)); end + + # @return [Boolean] + # + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure.rb#29 + def valid?(entity); end + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure.rb#45 + def valid_value_for(key, entity, options); end + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure.rb#33 + def value(entity, options); end + + private + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure.rb#73 + def easy_normalized_exposures(entity, options); end + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure.rb#116 + def map_entity_exposures(entity, options); end + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure.rb#65 + def nesting_options_for(options); end + + # This method 'merges' subsequent nesting exposures with the same name if it's needed + # + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure.rb#82 + def normalized_exposures(entity, options); end +end + +# source://grape-entity//lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb#7 +class Grape::Entity::Exposure::NestingExposure::NestedExposures + include ::Enumerable + + # @return [NestedExposures] a new instance of NestedExposures + # + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb#10 + def initialize(exposures); end + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb#23 + def <<(exposure); end + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb#54 + def ==(*args, &block); end + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb#54 + def [](*args, &block); end + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb#54 + def all?(*args, &block); end + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb#34 + def clear; end + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb#54 + def count(*args, &block); end + + # Determine if we have any nesting exposures with the same name. + # + # @return [Boolean] + # + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb#62 + def deep_complex_nesting?(entity); end + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb#28 + def delete_by(*attributes); end + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb#54 + def each(*args, &block); end + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb#54 + def each_with_object(*args, &block); end + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb#54 + def empty?(*args, &block); end + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb#15 + def find_by(attribute); end + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb#54 + def length(*args, &block); end + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb#54 + def select(*args, &block); end + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb#19 + def select_by(attribute); end + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb#54 + def size(*args, &block); end + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb#54 + def to_a(*args, &block); end + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb#54 + def to_ary(*args, &block); end + + private + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure/nested_exposures.rb#76 + def reset_memoization!; end +end + +# source://grape-entity//lib/grape_entity/exposure/nesting_exposure/output_builder.rb#7 +class Grape::Entity::Exposure::NestingExposure::OutputBuilder < ::SimpleDelegator + # @return [OutputBuilder] a new instance of OutputBuilder + # + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure/output_builder.rb#8 + def initialize(entity); end + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure/output_builder.rb#36 + def __getobj__; end + + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure/output_builder.rb#16 + def add(exposure, result); end + + # @return [Boolean] + # + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure/output_builder.rb#31 + def is_a?(klass); end + + # @return [Boolean] + # + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure/output_builder.rb#31 + def kind_of?(klass); end + + private + + # In case if we want to solve collisions providing lambda to :merge option + # + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure/output_builder.rb#55 + def merge_strategy(for_merge); end + + # If output_collection contains at least one element we have to represent the output as a collection + # + # source://grape-entity//lib/grape_entity/exposure/nesting_exposure/output_builder.rb#43 + def output; end +end + +# source://grape-entity//lib/grape_entity/exposure/represent_exposure.rb#6 +class Grape::Entity::Exposure::RepresentExposure < ::Grape::Entity::Exposure::Base + # source://grape-entity//lib/grape_entity/exposure/represent_exposure.rb#19 + def ==(other); end + + # source://grape-entity//lib/grape_entity/exposure/represent_exposure.rb#15 + def dup_args; end + + # source://grape-entity//lib/grape_entity/exposure/represent_exposure.rb#9 + def setup(using_class_name, subexposure); end + + # Returns the value of attribute subexposure. + # + # source://grape-entity//lib/grape_entity/exposure/represent_exposure.rb#7 + def subexposure; end + + # source://grape-entity//lib/grape_entity/exposure/represent_exposure.rb#34 + def using_class; end + + # Returns the value of attribute using_class_name. + # + # source://grape-entity//lib/grape_entity/exposure/represent_exposure.rb#7 + def using_class_name; end + + # @return [Boolean] + # + # source://grape-entity//lib/grape_entity/exposure/represent_exposure.rb#30 + def valid?(entity); end + + # source://grape-entity//lib/grape_entity/exposure/represent_exposure.rb#25 + def value(entity, options); end + + private + + # source://grape-entity//lib/grape_entity/exposure/represent_exposure.rb#44 + def using_options_for(options); end +end + +# All supported options. +# +# source://grape-entity//lib/grape_entity/entity.rb#570 +Grape::Entity::OPTIONS = T.let(T.unsafe(nil), Set) + +# source://grape-entity//lib/grape_entity/options.rb#7 +class Grape::Entity::Options + extend ::Forwardable + + # @return [Options] a new instance of Options + # + # source://grape-entity//lib/grape_entity/options.rb#14 + def initialize(opts_hash = T.unsafe(nil)); end + + # source://grape-entity//lib/grape_entity/options.rb#46 + def ==(other); end + + # source://forwardable/1.3.3/forwardable.rb#231 + def [](*args, **_arg1, &block); end + + # source://forwardable/1.3.3/forwardable.rb#231 + def dig(*args, **_arg1, &block); end + + # source://forwardable/1.3.3/forwardable.rb#231 + def empty?(*args, **_arg1, &block); end + + # source://grape-entity//lib/grape_entity/options.rb#75 + def except_fields(for_key = T.unsafe(nil)); end + + # source://forwardable/1.3.3/forwardable.rb#231 + def fetch(*args, **_arg1, &block); end + + # source://grape-entity//lib/grape_entity/options.rb#61 + def for_nesting(key); end + + # source://forwardable/1.3.3/forwardable.rb#231 + def key?(*args, **_arg1, &block); end + + # source://grape-entity//lib/grape_entity/options.rb#22 + def merge(new_opts); end + + # source://grape-entity//lib/grape_entity/options.rb#65 + def only_fields(for_key = T.unsafe(nil)); end + + # Returns the value of attribute opts_hash. + # + # source://grape-entity//lib/grape_entity/options.rb#10 + def opts_hash; end + + # source://grape-entity//lib/grape_entity/options.rb#34 + def reverse_merge(new_opts); end + + # @return [Boolean] + # + # source://grape-entity//lib/grape_entity/options.rb#51 + def should_return_key?(key); end + + # source://grape-entity//lib/grape_entity/options.rb#85 + def with_attr_path(part); end + + private + + # source://grape-entity//lib/grape_entity/options.rb#97 + def build_for_nesting(key); end + + # source://grape-entity//lib/grape_entity/options.rb#108 + def build_symbolized_hash(attribute, hash); end + + # source://grape-entity//lib/grape_entity/options.rb#123 + def only_for_given(key, fields); end +end + +# source://grape-entity//lib/grape_entity/version.rb#3 +module GrapeEntity; end + +# source://grape-entity//lib/grape_entity/version.rb#4 +GrapeEntity::VERSION = T.let(T.unsafe(nil), String) diff --git a/sorbet/rbi/gems/multi_json@1.15.0.rbi b/sorbet/rbi/gems/multi_json@1.15.0.rbi new file mode 100644 index 0000000..64c3c0c --- /dev/null +++ b/sorbet/rbi/gems/multi_json@1.15.0.rbi @@ -0,0 +1,268 @@ +# typed: true + +# DO NOT EDIT MANUALLY +# This is an autogenerated file for types exported from the `multi_json` gem. +# Please instead update this file by running `bin/tapioca gem multi_json`. + + +# source://multi_json//lib/multi_json/options.rb#1 +module MultiJson + include ::MultiJson::Options + extend ::MultiJson::Options + extend ::MultiJson + + # Get the current adapter class. + # + # source://multi_json//lib/multi_json.rb#70 + def adapter; end + + # Set the JSON parser utilizing a symbol, string, or class. + # Supported by default are: + # + # * :oj + # * :json_gem + # * :json_pure + # * :ok_json + # * :yajl + # * :nsjsonserialization (MacRuby only) + # * :gson (JRuby only) + # * :jr_jackson (JRuby only) + # + # source://multi_json//lib/multi_json.rb#90 + def adapter=(new_adapter); end + + # source://multi_json//lib/multi_json.rb#26 + def cached_options(*_arg0); end + + # source://multi_json//lib/multi_json.rb#129 + def current_adapter(options = T.unsafe(nil)); end + + # Decode a JSON string into Ruby. + # + # Options + # + # :symbolize_keys :: If true, will use symbols instead of strings for the keys. + # :adapter :: If set, the selected adapter will be used for this call. + # + # source://multi_json//lib/multi_json.rb#119 + def decode(string, options = T.unsafe(nil)); end + + # The default adapter based on what you currently + # have loaded and installed. First checks to see + # if any adapters are already loaded, then checks + # to see which are installed if none are loaded. + # + # source://multi_json//lib/multi_json.rb#46 + def default_adapter; end + + # The default adapter based on what you currently + # have loaded and installed. First checks to see + # if any adapters are already loaded, then checks + # to see which are installed if none are loaded. + # + # source://multi_json//lib/multi_json.rb#46 + def default_engine; end + + # source://multi_json//lib/multi_json.rb#18 + def default_options; end + + # source://multi_json//lib/multi_json.rb#11 + def default_options=(value); end + + # Encodes a Ruby object as JSON. + # + # source://multi_json//lib/multi_json.rb#138 + def dump(object, options = T.unsafe(nil)); end + + # Encodes a Ruby object as JSON. + # + # source://multi_json//lib/multi_json.rb#138 + def encode(object, options = T.unsafe(nil)); end + + # Get the current adapter class. + # + # source://multi_json//lib/multi_json.rb#70 + def engine; end + + # Set the JSON parser utilizing a symbol, string, or class. + # Supported by default are: + # + # * :oj + # * :json_gem + # * :json_pure + # * :ok_json + # * :yajl + # * :nsjsonserialization (MacRuby only) + # * :gson (JRuby only) + # * :jr_jackson (JRuby only) + # + # source://multi_json//lib/multi_json.rb#90 + def engine=(new_adapter); end + + # Decode a JSON string into Ruby. + # + # Options + # + # :symbolize_keys :: If true, will use symbols instead of strings for the keys. + # :adapter :: If set, the selected adapter will be used for this call. + # + # source://multi_json//lib/multi_json.rb#119 + def load(string, options = T.unsafe(nil)); end + + # source://multi_json//lib/multi_json.rb#98 + def load_adapter(new_adapter); end + + # source://multi_json//lib/multi_json.rb#26 + def reset_cached_options!(*_arg0); end + + # Set the JSON parser utilizing a symbol, string, or class. + # Supported by default are: + # + # * :oj + # * :json_gem + # * :json_pure + # * :ok_json + # * :yajl + # * :nsjsonserialization (MacRuby only) + # * :gson (JRuby only) + # * :jr_jackson (JRuby only) + # + # source://multi_json//lib/multi_json.rb#90 + def use(new_adapter); end + + # Executes passed block using specified adapter. + # + # source://multi_json//lib/multi_json.rb#144 + def with_adapter(new_adapter); end + + # Executes passed block using specified adapter. + # + # source://multi_json//lib/multi_json.rb#144 + def with_engine(new_adapter); end + + private + + # source://multi_json//lib/multi_json.rb#155 + def load_adapter_from_string_name(name); end +end + +# source://multi_json//lib/multi_json.rb#31 +MultiJson::ALIASES = T.let(T.unsafe(nil), Hash) + +# source://multi_json//lib/multi_json/adapter_error.rb#2 +class MultiJson::AdapterError < ::ArgumentError + # Returns the value of attribute cause. + # + # source://multi_json//lib/multi_json/adapter_error.rb#3 + def cause; end + + class << self + # source://multi_json//lib/multi_json/adapter_error.rb#5 + def build(original_exception); end + end +end + +# Legacy support +# +# source://multi_json//lib/multi_json/parse_error.rb#16 +MultiJson::DecodeError = MultiJson::ParseError + +# source://multi_json//lib/multi_json/parse_error.rb#16 +MultiJson::LoadError = MultiJson::ParseError + +# source://multi_json//lib/multi_json/options.rb#2 +module MultiJson::Options + # source://multi_json//lib/multi_json/options.rb#25 + def default_dump_options; end + + # source://multi_json//lib/multi_json/options.rb#21 + def default_load_options; end + + # source://multi_json//lib/multi_json/options.rb#17 + def dump_options(*args); end + + # source://multi_json//lib/multi_json/options.rb#8 + def dump_options=(options); end + + # source://multi_json//lib/multi_json/options.rb#13 + def load_options(*args); end + + # source://multi_json//lib/multi_json/options.rb#3 + def load_options=(options); end + + private + + # source://multi_json//lib/multi_json/options.rb#31 + def get_options(options, *args); end +end + +# source://multi_json//lib/multi_json/options_cache.rb#2 +module MultiJson::OptionsCache + extend ::MultiJson::OptionsCache + + # source://multi_json//lib/multi_json/options_cache.rb#10 + def fetch(type, key, &block); end + + # source://multi_json//lib/multi_json/options_cache.rb#5 + def reset; end + + private + + # source://multi_json//lib/multi_json/options_cache.rb#24 + def write(cache, key); end +end + +# Normally MultiJson is used with a few option sets for both dump/load +# methods. When options are generated dynamically though, every call would +# cause a cache miss and the cache would grow indefinitely. To prevent +# this, we just reset the cache every time the number of keys outgrows +# 1000. +# +# source://multi_json//lib/multi_json/options_cache.rb#22 +MultiJson::OptionsCache::MAX_CACHE_SIZE = T.let(T.unsafe(nil), Integer) + +# source://multi_json//lib/multi_json/parse_error.rb#2 +class MultiJson::ParseError < ::StandardError + # Returns the value of attribute cause. + # + # source://multi_json//lib/multi_json/parse_error.rb#3 + def cause; end + + # Returns the value of attribute data. + # + # source://multi_json//lib/multi_json/parse_error.rb#3 + def data; end + + class << self + # source://multi_json//lib/multi_json/parse_error.rb#5 + def build(original_exception, data); end + end +end + +# source://multi_json//lib/multi_json.rb#33 +MultiJson::REQUIREMENT_MAP = T.let(T.unsafe(nil), Array) + +# source://multi_json//lib/multi_json/version.rb#16 +MultiJson::VERSION = T.let(T.unsafe(nil), String) + +# source://multi_json//lib/multi_json/version.rb#2 +class MultiJson::Version + class << self + # @return [String] + # + # source://multi_json//lib/multi_json/version.rb#10 + def to_s; end + end +end + +# source://multi_json//lib/multi_json/version.rb#3 +MultiJson::Version::MAJOR = T.let(T.unsafe(nil), Integer) + +# source://multi_json//lib/multi_json/version.rb#4 +MultiJson::Version::MINOR = T.let(T.unsafe(nil), Integer) + +# source://multi_json//lib/multi_json/version.rb#5 +MultiJson::Version::PATCH = T.let(T.unsafe(nil), Integer) + +# source://multi_json//lib/multi_json/version.rb#6 +MultiJson::Version::PRE = T.let(T.unsafe(nil), T.untyped) diff --git a/spec/grape_entity/entity_spec.rb b/spec/grape_entity/entity_spec.rb new file mode 100644 index 0000000..3e56788 --- /dev/null +++ b/spec/grape_entity/entity_spec.rb @@ -0,0 +1,53 @@ +# typed: strict +# frozen_string_literal: true + +require "spec_helper" + +module Grape + class EntitySpec < Minitest::Spec + describe "Grape::Entity" do + before do + @fresh_class = T.let( + T.unsafe(Class).new(Grape::Entity), + T.all(T.class_of(Grape::Entity), GrapeSorbet::GrapeEntityName), + ) + end + + describe "class methods" do + describe ".entity_name" do + it "returns the custom entity name if one has been set" do + @fresh_class.entity_name = "CustomEntityName" + assert_equal("CustomEntityName", @fresh_class.entity_name) + end + + it "raises an error if no custom entity name has been set" do + e = assert_raises(StandardError) { @fresh_class.entity_name } + assert_match(/entity_name has not been set/, e.message) + end + end + + describe ".entity_name=" do + it "sets the entity name" do + refute(@fresh_class.instance_variable_defined?(:@entity_name)) + + @fresh_class.entity_name = "CustomEntityName" + + assert(@fresh_class.instance_variable_defined?(:@entity_name)) + assert_equal("CustomEntityName", @fresh_class.instance_variable_get(:@entity_name)) + end + end + + describe ".respond_to?" do + it "returns true for entity_name if a custom entity name has been set" do + @fresh_class.entity_name = "CustomEntityName" + assert(@fresh_class.respond_to?(:entity_name)) + end + + it "returns false for entity_name if no custom entity name has been set" do + refute(@fresh_class.respond_to?(:entity_name)) + end + end + end + end + end +end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 7c04cdd..7e1fc23 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -1,6 +1,8 @@ # typed: strict # frozen_string_literal: true +require "grape_sorbet" + require "tapioca/internal" require "minitest/autorun" require "minitest/spec"