Module: SmartCore::Initializer::DSL::ClassMethods Private

Defined in:
lib/smart_core/initializer/dsl.rb

Overview

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

Since:

  • 0.1.0

Instance Method Summary collapse

Instance Method Details

#__definer__ ⇒ SmartCore::Initializer::Constructor::Definer

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:

Since:

  • 0.1.0



84
85
86
 
# File 'lib/smart_core/initializer/dsl.rb', line 84

def __definer__
  @__definer__
end

#__init_extensions__ ⇒ SmartCore::Initializer::Extentions::List

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:

  • (SmartCore::Initializer::Extentions::List)

Since:

  • 0.1.0



76
77
78
 
# File 'lib/smart_core/initializer/dsl.rb', line 76

def __init_extensions__
  @__init_extensions__
end

#__initializer_settings__ ⇒ SmartCore::Initializer::Settings

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:

Since:

  • 0.1.0



92
93
94
 
# File 'lib/smart_core/initializer/dsl.rb', line 92

def __initializer_settings__
  @__initializer_settings__
end

#__options__ ⇒ SmartCore::Initializer::Attribute::List

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:

Since:

  • 0.1.0



68
69
70
 
# File 'lib/smart_core/initializer/dsl.rb', line 68

def __options__
  @__options__
end

#__params__ ⇒ SmartCore::Initializer::Attribute::List

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:

Since:

  • 0.1.0



60
61
62
 
# File 'lib/smart_core/initializer/dsl.rb', line 60

def __params__
  @__params__
end

#ext_init(&block) ⇒ void Also known as: extend_initialization_flow

This method returns an undefined value.

Parameters:

  • block (Block)

Since:

  • 0.1.0



202
203
204
 
# File 'lib/smart_core/initializer/dsl.rb', line 202

def ext_init(&block)
  __definer__.define_init_extension(block)
end

#new(*arguments, &block) ⇒ Any

Parameters:

  • arguments (Array)
  • block (Block)

Returns:

  • (Any)

Since:

  • 0.1.0



102
103
104
 
# File 'lib/smart_core/initializer/dsl.rb', line 102

def new(*arguments, &block)
  SmartCore::Initializer::Constructor.new(self, arguments, block).construct
end

#option(name, type = __initializer_settings__.generic_type_object, privacy: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_PRIVACY_MODE, finalize: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_FINALIZER, cast: __initializer_settings__.auto_cast, type_system: __initializer_settings__.type_system, mutable: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_MUTABLE, as: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_AS, default: SmartCore::Initializer::Attribute::Value::Option::UNDEFINED_DEFAULT, optional: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_OPTIONAL) ⇒ void

This method returns an undefined value.

Parameters:

  • name (String, Symbol)
  • type (String, Symbol, Any) (defaults to: __initializer_settings__.generic_type_object)
  • cast (Hash) (defaults to: __initializer_settings__.auto_cast) —

    a customizable set of options

  • privacy (Hash) (defaults to: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_PRIVACY_MODE) —

    a customizable set of options

  • finalize (Hash) (defaults to: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_FINALIZER) —

    a customizable set of options

  • type_system (Hash) (defaults to: __initializer_settings__.type_system) —

    a customizable set of options

  • mutable (Hash) (defaults to: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_MUTABLE) —

    a customizable set of options

  • as (Hash) (defaults to: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_AS) —

    a customizable set of options

  • default (Hash) (defaults to: SmartCore::Initializer::Attribute::Value::Option::UNDEFINED_DEFAULT) —

    a customizable set of options

  • optional (Hash) (defaults to: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_OPTIONAL) —

    a customizable set of options

Options Hash (privacy:):

  • (String, Symbol)

Options Hash (finalize:):

  • (String, Symbol, Proc)

Options Hash (cast:):

  • (Boolean)

Options Hash (type_system:):

  • (String, Symbol)

Options Hash (mutable:):

  • (Boolean)

Options Hash (as:):

  • (NilClass, String, Symbol)

Options Hash (default:):

  • (Proc, Any)

Options Hash (optional:):

  • (Boolean)

Since:

  • 0.1.0

Version:

  • 0.8.0



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/smart_core/initializer/dsl.rb', line 164

def option(
  name,
  type = __initializer_settings__.generic_type_object,
  privacy: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_PRIVACY_MODE,
  finalize: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_FINALIZER,
  cast: __initializer_settings__.auto_cast,
  type_system: __initializer_settings__.type_system,
  mutable: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_MUTABLE,
  as: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_AS,
  default: SmartCore::Initializer::Attribute::Value::Option::UNDEFINED_DEFAULT,
  optional: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_OPTIONAL
)
  __definer__.define_option(
    name, type, type_system, privacy, finalize, cast, mutable, as, default, optional
  )
end

#options(*names, mutable: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_MUTABLE, privacy: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_PRIVACY_MODE) ⇒ void

This method returns an undefined value.

Parameters:

  • names (Array<String, Symbol>)
  • mutable (Hash) (defaults to: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_MUTABLE) —

    a customizable set of options

  • privacy (Hash) (defaults to: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_PRIVACY_MODE) —

    a customizable set of options

Options Hash (mutable:):

  • (Boolean)

Options Hash (privacy:):

  • (String, Symbol)

Since:

  • 0.1.0

Version:

  • 0.8.0



189
190
191
192
193
194
195
 
# File 'lib/smart_core/initializer/dsl.rb', line 189

def options(
  *names,
  mutable: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_MUTABLE,
  privacy: SmartCore::Initializer::Attribute::Value::Option::DEFAULT_PRIVACY_MODE
)
  __definer__.define_options(*names, mutable: mutable, privacy: privacy)
end

#param(name, type = __initializer_settings__.generic_type_object, privacy: SmartCore::Initializer::Attribute::Value::Param::DEFAULT_PRIVACY_MODE, finalize: SmartCore::Initializer::Attribute::Value::Param::DEFAULT_FINALIZER, cast: __initializer_settings__.auto_cast, type_system: __initializer_settings__.type_system, mutable: SmartCore::Initializer::Attribute::Value::Param::DEFAULT_MUTABLE, as: SmartCore::Initializer::Attribute::Value::Param::DEFAULT_AS) ⇒ void

This method returns an undefined value.

Parameters:

  • name (String, Symbol)
  • type (String, Symbol, Any) (defaults to: __initializer_settings__.generic_type_object)
  • cast (Hash) (defaults to: __initializer_settings__.auto_cast) —

    a customizable set of options

  • privacy (Hash) (defaults to: SmartCore::Initializer::Attribute::Value::Param::DEFAULT_PRIVACY_MODE) —

    a customizable set of options

  • finalize (Hash) (defaults to: SmartCore::Initializer::Attribute::Value::Param::DEFAULT_FINALIZER) —

    a customizable set of options

  • mutable (Hash) (defaults to: SmartCore::Initializer::Attribute::Value::Param::DEFAULT_MUTABLE) —

    a customizable set of options

  • as (Hash) (defaults to: SmartCore::Initializer::Attribute::Value::Param::DEFAULT_AS) —

    a customizable set of options

Options Hash (privacy:):

  • (String, Symbol)

Options Hash (finalize:):

  • (String, Symbol, Proc)

Options Hash (cast:):

  • (Boolean)

Options Hash (mutable:):

  • (Boolean)

Options Hash (as:):

  • (NilClass, String, Symbol)

Since:

  • 0.1.0

Version:

  • 0.8.0



118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/smart_core/initializer/dsl.rb', line 118

def param(
  name,
  type = __initializer_settings__.generic_type_object,
  privacy: SmartCore::Initializer::Attribute::Value::Param::DEFAULT_PRIVACY_MODE,
  finalize: SmartCore::Initializer::Attribute::Value::Param::DEFAULT_FINALIZER,
  cast: __initializer_settings__.auto_cast,
  type_system: __initializer_settings__.type_system,
  mutable: SmartCore::Initializer::Attribute::Value::Param::DEFAULT_MUTABLE,
  as: SmartCore::Initializer::Attribute::Value::Param::DEFAULT_AS
)
  __definer__.define_parameter(
    name, type, type_system, privacy, finalize, cast, mutable, as
  )
end

#params(*names, mutable: SmartCore::Initializer::Attribute::Value::Param::DEFAULT_MUTABLE, privacy: SmartCore::Initializer::Attribute::Value::Param::DEFAULT_PRIVACY_MODE) ⇒ void

This method returns an undefined value.

Parameters:

  • names (Array<String, Symbol>)
  • mutable (Hash) (defaults to: SmartCore::Initializer::Attribute::Value::Param::DEFAULT_MUTABLE) —

    a customizable set of options

  • privacy (Hash) (defaults to: SmartCore::Initializer::Attribute::Value::Param::DEFAULT_PRIVACY_MODE) —

    a customizable set of options

Options Hash (mutable:):

  • (Boolean)

Options Hash (privacy:):

  • (String, Symbol)

Since:

  • 0.1.0



141
142
143
144
145
146
147
 
# File 'lib/smart_core/initializer/dsl.rb', line 141

def params(
  *names,
  mutable: SmartCore::Initializer::Attribute::Value::Param::DEFAULT_MUTABLE,
  privacy: SmartCore::Initializer::Attribute::Value::Param::DEFAULT_PRIVACY_MODE
)
  __definer__.define_parameters(*names, mutable: mutable, privacy: privacy)
end