Class: Azeroth::Options Private
- Inherits:
-
Sinclair::Options
- Object
- Sinclair::Options
- Azeroth::Options
- 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
Constant Summary collapse
- DEFAULT_OPTIONS =
Default options
{ 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
-
#actions ⇒ Array<Symbol>
private
Actions to be built.
-
#after_save ⇒ Symbol, Proc
private
Block or method name to be run after save.
-
#before_save ⇒ Symbol, Proc
private
Block or method name to be run before save.
-
#build_with ⇒ Symbol, Proc
private
Block or method name to be ran when building the resource.
-
#decorator ⇒ Decorator, ...
private
decorator class to be used.
-
#event_dispatcher(event) ⇒ Jace::Dispatcher
private
Returns event dispatcher.
-
#except ⇒ Array<String,Symbol>
private
actions to be ignored.
-
#only ⇒ Array<String,Symbol>
private
filter of only actions to be built.
-
#paginated ⇒ TrueClass, FalseClass
(also: #paginated?)
private
Boolean indicating if pagination should or not be used.
-
#per_page ⇒ Integer
private
Number of elements when pagination is active.
-
#update_with ⇒ Symbol, Proc
private
Block or method name to be ran when updating the resource.
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
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
|
# File 'lib/azeroth/options.rb', line 96
|
#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
|
# File 'lib/azeroth/options.rb', line 85
|
#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
|
# File 'lib/azeroth/options.rb', line 107
|
#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
|
# File 'lib/azeroth/options.rb', line 73
|
#event_dispatcher(event) ⇒ Jace::Dispatcher
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 event dispatcher
Event dispatcher is responsible for sending events such as before_save
to it’s correct calling point
45 46 47 48 49 50 |
# File 'lib/azeroth/options.rb', line 45 def event_dispatcher(event) Jace::Dispatcher.new( before: try("before_#{event}"), after: try("after_#{event}") ) 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
|
# File 'lib/azeroth/options.rb', line 66
|
#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
|
# File 'lib/azeroth/options.rb', line 59
|
#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
|
# File 'lib/azeroth/options.rb', line 121
|
#per_page ⇒ Integer
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.
Number of elements when pagination is active
|
# File 'lib/azeroth/options.rb', line 128
|
#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
|
# File 'lib/azeroth/options.rb', line 114
|