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

See Also:

• Sinclair::Options

Author:

• Darthjee

Constant Summary

DEFAULT_OPTIONS =

Default options

See Also:

• Resourceable::ClassMethods#resource_for

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

Instance Method Summary

• #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.

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>)

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

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 95

#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 84

#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 106

#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:

• (Decorator, TrueClass, FalseClass)

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

#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

Returns:

• (Jace::Dispatcher)

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

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

Returns:

• (Array<String,Symbol>)

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

#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 58

#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 113

#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

Returns:

• (Integer)

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