Module: Serega::ClassMethods

Included in:
Serega
Defined in:
lib/serega.rb

Overview

Serializers class methods

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#config ⇒ SeregaConfig (readonly)

Returns current serializer config.

Returns:



68
69
70
 
# File 'lib/serega.rb', line 68

def config
  @config
end

Instance Method Details

#as_json(object, opts = FROZEN_EMPTY_HASH) ⇒ Hash

Serializes provided object as JSON

Parameters:

  • object (Object) —

    Serialized object

  • opts (Hash) (defaults to: FROZEN_EMPTY_HASH) —

    Serializer modifiers and other instantiating options

Options Hash (opts):

  • :only (Array, Hash, String, Symbol) —

    The only attributes to serialize

  • :except (Array, Hash, String, Symbol) —

    Attributes to hide

  • :with (Array, Hash, String, Symbol) —

    Attributes (usually hidden) to serialize additionally

  • :validate (Boolean) —

    Validates provided modifiers (Default is true)

  • :context (Hash) —

    Serialization context

  • :many (Boolean) —

    Set true if provided multiple objects (Default `object.is_a?(Enumerable)`)

Returns:

  • (Hash) —

    Serialization result



237
238
239
 
# File 'lib/serega.rb', line 237

def as_json(object, opts = FROZEN_EMPTY_HASH)
  config.from_json.call(to_json(object, opts))
end

#attribute(name, **opts, &block) ⇒ Serega::SeregaAttribute

Adds attribute

Parameters:

  • name (Symbol) —

    Attribute name. Attribute value will be found by executing `object.<name>`

  • opts (Hash) —

    Options to serialize attribute

  • block (Proc) —

    Custom block to find attribute value. Accepts object and context.

Returns:



175
176
177
178
 
# File 'lib/serega.rb', line 175

def attribute(name, **opts, &block)
  attribute = self::SeregaAttribute.new(name: name, opts: opts, block: block)
  attributes[attribute.name] = attribute
end

#attributes ⇒ Hash

Lists attributes

Returns:

  • (Hash) —

    attributes list



162
163
164
 
# File 'lib/serega.rb', line 162

def attributes
  @attributes ||= {}
end

#call(object, opts = FROZEN_EMPTY_HASH) ⇒ Hash

Serializes provided object to Hash

Parameters:

  • object (Object) —

    Serialized object

  • opts (Hash) (defaults to: FROZEN_EMPTY_HASH) —

    Serializer modifiers and other instantiating options

Options Hash (opts):

  • :only (Array, Hash, String, Symbol) —

    The only attributes to serialize

  • :except (Array, Hash, String, Symbol) —

    Attributes to hide

  • :with (Array, Hash, String, Symbol) —

    Attributes (usually hidden) to serialize additionally

  • :validate (Boolean) —

    Validates provided modifiers (Default is true)

  • :context (Hash) —

    Serialization context

  • :many (Boolean) —

    Set true if provided multiple objects (Default `object.is_a?(Enumerable)`)

Returns:

  • (Hash) —

    Serialization result



194
195
196
197
 
# File 'lib/serega.rb', line 194

def call(object, opts = FROZEN_EMPTY_HASH)
  initiate_keys = config.initiate_keys
  new(opts.slice(*initiate_keys)).to_h(object, opts.except(*initiate_keys))
end

#plugin(name, **opts) ⇒ class<Module>

Enables plugin for current serializer

Parameters:

  • name (Symbol, Class<Module>) —

    Plugin name or plugin module itself

  • opts (Hash) —

    ] Plugin options

Returns:

  • (class<Module>) —

    Loaded plugin module

Raises:



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/serega.rb', line 120

def plugin(name, **opts)
  raise SeregaError, "This plugin is already loaded" if plugin_used?(name)

  plugin = SeregaPlugins.find_plugin(name)

  # We split loading of plugin to three parts - before_load, load, after_load:
  #
  # - **before_load_plugin** usually used to check requirements and to load additional plugins
  # - **load_plugin** usually used to include plugin modules
  # - **after_load_plugin** usually used to add config options
  plugin.before_load_plugin(self, **opts) if plugin.respond_to?(:before_load_plugin)
  plugin.load_plugin(self, **opts) if plugin.respond_to?(:load_plugin)
  plugin.after_load_plugin(self, **opts) if plugin.respond_to?(:after_load_plugin)

  # Store attached plugins, so we can check it is loaded later
  config.plugins << (plugin.respond_to?(:plugin_name) ? plugin.plugin_name : plugin)

  plugin
end

#plugin_used?(name) ⇒ Boolean

Checks plugin is used

Parameters:

  • name (Symbol, Class<Module>) —

    Plugin name or plugin module itself

Returns:

  • (Boolean) —

    Is plugin used



147
148
149
150
151
152
153
154
155
 
# File 'lib/serega.rb', line 147

def plugin_used?(name)
  plugin_name =
    case name
    when Module then name.respond_to?(:plugin_name) ? name.plugin_name : name
    else name
    end

  config.plugins.include?(plugin_name)
end

#to_h(object, opts = FROZEN_EMPTY_HASH) ⇒ Object

See Also:



200
201
202
 
# File 'lib/serega.rb', line 200

def to_h(object, opts = FROZEN_EMPTY_HASH)
  call(object, opts)
end

#to_json(object, opts = FROZEN_EMPTY_HASH) ⇒ String

Serializes provided object to JSON string

Parameters:

  • object (Object) —

    Serialized object

  • opts (Hash) (defaults to: FROZEN_EMPTY_HASH) —

    Serializer modifiers and other instantiating options

Options Hash (opts):

  • :only (Array, Hash, String, Symbol) —

    The only attributes to serialize

  • :except (Array, Hash, String, Symbol) —

    Attributes to hide

  • :with (Array, Hash, String, Symbol) —

    Attributes (usually hidden) to serialize additionally

  • :validate (Boolean) —

    Validates provided modifiers (Default is true)

  • :context (Hash) —

    Serialization context

  • :many (Boolean) —

    Set true if provided multiple objects (Default `object.is_a?(Enumerable)`)

Returns:

  • (String) —

    Serialization result



218
219
220
221
 
# File 'lib/serega.rb', line 218

def to_json(object, opts = FROZEN_EMPTY_HASH)
  initiate_keys = config.initiate_keys
  new(opts.slice(*initiate_keys)).to_json(object, opts.except(*initiate_keys))
end