Class: Serega

Inherits:
Object
  • Object
show all
Extended by:
ClassMethods
Includes:
InstanceMethods
Defined in:
lib/serega.rb,
lib/serega.rb,
lib/serega/plan.rb,
lib/serega/config.rb,
lib/serega/errors.rb,
lib/serega/json/oj.rb,
lib/serega/plugins.rb,
lib/serega/version.rb,
lib/serega/attribute.rb,
lib/serega/json/json.rb,
lib/serega/plan_point.rb,
lib/serega/json/adapter.rb,
lib/serega/plugins/if/if.rb,
lib/serega/utils/to_hash.rb,
lib/serega/object_serializer.rb,
lib/serega/plugins/root/root.rb,
lib/serega/utils/symbol_name.rb,
lib/serega/plugins/batch/batch.rb,
lib/serega/utils/enum_deep_dup.rb,
lib/serega/attribute_normalizer.rb,
lib/serega/utils/enum_deep_freeze.rb,
lib/serega/plugins/openapi/openapi.rb,
lib/serega/plugins/batch/lib/loader.rb,
lib/serega/plugins/batch/lib/loaders.rb,
lib/serega/plugins/metadata/metadata.rb,
lib/serega/plugins/preloads/preloads.rb,
lib/serega/plugins/presenter/presenter.rb,
lib/serega/plugins/formatters/formatters.rb,
lib/serega/plugins/batch/lib/batch_config.rb,
lib/serega/helpers/serializer_class_helper.rb,
lib/serega/plugins/metadata/meta_attribute.rb,
lib/serega/plugins/batch/lib/modules/config.rb,
lib/serega/validations/attribute/check_name.rb,
lib/serega/validations/attribute/check_block.rb,
lib/serega/validations/check_initiate_params.rb,
lib/serega/plugins/openapi/lib/modules/config.rb,
lib/serega/plugins/openapi/lib/openapi_config.rb,
lib/serega/plugins/preloads/lib/preload_paths.rb,
lib/serega/validations/check_attribute_params.rb,
lib/serega/validations/check_serialize_params.rb,
lib/serega/plugins/batch/lib/modules/attribute.rb,
lib/serega/plugins/if/validations/check_opt_if.rb,
lib/serega/plugins/preloads/lib/modules/config.rb,
lib/serega/validations/attribute/check_opt_key.rb,
lib/serega/validations/utils/check_opt_is_bool.rb,
lib/serega/validations/utils/check_opt_is_hash.rb,
lib/serega/plugins/batch/lib/modules/plan_point.rb,
lib/serega/plugins/preloads/lib/preloads_config.rb,
lib/serega/validations/attribute/check_opt_hide.rb,
lib/serega/validations/attribute/check_opt_many.rb,
lib/serega/validations/initiate/check_modifiers.rb,
lib/serega/validations/utils/check_allowed_keys.rb,
lib/serega/validations/attribute/check_opt_const.rb,
lib/serega/validations/attribute/check_opt_value.rb,
lib/serega/plugins/preloads/lib/modules/attribute.rb,
lib/serega/plugins/if/validations/check_opt_unless.rb,
lib/serega/plugins/metadata/validations/check_opts.rb,
lib/serega/plugins/metadata/validations/check_path.rb,
lib/serega/plugins/preloads/lib/modules/plan_point.rb,
lib/serega/plugins/metadata/validations/check_block.rb,
lib/serega/validations/attribute/check_opt_delegate.rb,
lib/serega/plugins/context_metadata/context_metadata.rb,
lib/serega/plugins/if/validations/check_opt_if_value.rb,
lib/serega/plugins/preloads/lib/format_user_preloads.rb,
lib/serega/plugins/preloads/lib/preloads_constructor.rb,
lib/serega/plugins/string_modifiers/string_modifiers.rb,
lib/serega/validations/attribute/check_opt_serializer.rb,
lib/serega/plugins/activerecord_preloads/lib/preloader.rb,
lib/serega/plugins/batch/lib/modules/object_serializer.rb,
lib/serega/plugins/batch/lib/plugins_extensions/preloads.rb,
lib/serega/plugins/batch/lib/validations/check_opt_batch.rb,
lib/serega/plugins/if/validations/check_opt_unless_value.rb,
lib/serega/plugins/batch/lib/modules/attribute_normalizer.rb,
lib/serega/plugins/preloads/validations/check_opt_preload.rb,
lib/serega/plugins/batch/lib/plugins_extensions/formatters.rb,
lib/serega/plugins/metadata/validations/check_opt_hide_nil.rb,
lib/serega/plugins/string_modifiers/parse_string_modifiers.rb,
lib/serega/validations/utils/check_opt_is_string_or_symbol.rb,
lib/serega/plugins/batch/lib/modules/check_attribute_params.rb,
lib/serega/plugins/batch/lib/validations/check_batch_opt_key.rb,
lib/serega/plugins/explicit_many_option/explicit_many_option.rb,
lib/serega/plugins/metadata/validations/check_opt_hide_empty.rb,
lib/serega/plugins/preloads/lib/modules/attribute_normalizer.rb,
lib/serega/plugins/activerecord_preloads/activerecord_preloads.rb,
lib/serega/plugins/preloads/lib/modules/check_attribute_params.rb,
lib/serega/plugins/preloads/validations/check_opt_preload_path.rb,
lib/serega/plugins/batch/lib/validations/check_batch_opt_loader.rb,
lib/serega/plugins/explicit_many_option/validations/check_opt_many.rb,
lib/serega/plugins/batch/lib/plugins_extensions/activerecord_preloads.rb

Overview

Parent class for your serializers

Defined Under Namespace

Modules: ClassMethods, InstanceMethods, SeregaHelpers, SeregaJSON, SeregaPlugins, SeregaUtils, SeregaValidations Classes: AttributeNotExist, OpenAPI, SeregaAttribute, SeregaAttributeNormalizer, SeregaConfig, SeregaError, SeregaObjectSerializer, SeregaPlan, SeregaPlanPoint

Constant Summary collapse

FROZEN_EMPTY_HASH =

Frozen hash

Returns:

  • (Hash) —

    frozen hash

{}.freeze
FROZEN_EMPTY_ARRAY =

Frozen array

Returns:

  • (Array) —

    frozen array

[].freeze
VERSION =

Serega gem version

Returns:

  • (String) —

    SemVer gem version

File.read(File.join(File.dirname(__FILE__), "../../VERSION")).strip

Instance Attribute Summary

Attributes included from ClassMethods

#config

Method Summary

Methods included from ClassMethods

as_json, attribute, attributes, call, plugin, plugin_used?, to_h, to_json

Methods included from InstanceMethods

#as_json, #call, #initialize, #plan, #to_h, #to_json