Class: Azeroth::Options Private

Inherits:
Sinclair::Options
  • Object
show all
Defined in:
lib/azeroth/options.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Resource buiilding options

See Also:

Author:

  • Darthjee

Constant Summary collapse

DEFAULT_OPTIONS =

Default options

See Also:

{
  only: %i[create destroy edit index new show update],
  except: [],
  decorator: true,
  before_save: nil,
  after_save: nil,
  build_with: nil,
  update_with: nil,
  paginated: false,
  per_page: 20
}.freeze

Instance Method Summary collapse

Instance Method Details

#actions ⇒ Array<Symbol>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Actions to be built

Returns:

  • (Array<Symbol>) 


34
35
36
 
# File 'lib/azeroth/options.rb', line 34

def actions
  [only].flatten.map(&:to_sym) - [except].flatten.map(&:to_sym)
end

#after_save ⇒ Symbol, Proc

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Block or method name to be run after save

The given method or block will be ran after committing changes in models to database

Returns:

  • (Symbol, Proc) 



# File 'lib/azeroth/options.rb', line 91

#before_save ⇒ Symbol, Proc

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Block or method name to be run before save

The given method or block will be ran before committing changes in models to database

Returns:

  • (Symbol, Proc) 



# File 'lib/azeroth/options.rb', line 80

#build_with ⇒ Symbol, Proc

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Block or method name to be ran when building the resource

Returns:

  • (Symbol, Proc) 



# File 'lib/azeroth/options.rb', line 102

#decorator ⇒ Decorator, ...

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

decorator class to be used

when set as true/false, it either infer the class (model_class::Decorator) or do not use a decorator at all calling model.as_json

Returns:




# File 'lib/azeroth/options.rb', line 68

#event_registry ⇒ Jace::Registry

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns the event registry

Event registry is used to handle events within the request

Returns:

  • (Jace::Registry) 


43
44
45
 
# File 'lib/azeroth/options.rb', line 43

def event_registry
  @event_registry ||= build_event_registry
end

#except ⇒ Array<String,Symbol>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

actions to be ignored

Returns:

  • (Array<String,Symbol>) 



# File 'lib/azeroth/options.rb', line 61

#only ⇒ Array<String,Symbol>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

filter of only actions to be built

Returns:

  • (Array<String,Symbol>) 



# File 'lib/azeroth/options.rb', line 54

#paginated ⇒ TrueClass, FalseClass Also known as: paginated?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Boolean indicating if pagination should or not be used

Returns:

  • (TrueClass, FalseClass) 



# File 'lib/azeroth/options.rb', line 116

#update_with ⇒ Symbol, Proc

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Block or method name to be ran when updating the resource

Returns:

  • (Symbol, Proc) 



# File 'lib/azeroth/options.rb', line 109