Module: Serega::SeregaConfig::SeregaConfigInstanceMethods

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

Overview

SeregaConfig Instance methods

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#opts ⇒ Hash (readonly)

Shows current config as Hash

Returns:

  • (Hash) —

    config options



36
37
38
 
# File 'lib/serega/config.rb', line 36

def opts
  @opts
end

Instance Method Details

#attribute_keys ⇒ Array<Symbol>

Returns options names allowed in ‘Serega.attribute` method

Returns:

  • (Array<Symbol>) —

    Allowed options keys for attribute initialization



65
66
67
 
# File 'lib/serega/config.rb', line 65

def attribute_keys
  opts.fetch(:attribute_keys)
end

#check_attribute_name ⇒ Object

Returns whether attributes names check is disabled



124
125
126
 
# File 'lib/serega/config.rb', line 124

def check_attribute_name
  opts.fetch(:check_attribute_name)
end

#check_attribute_name=(value) ⇒ Boolean

Sets :check_attribute_name config option

Parameters:

  • value (Boolean) —

    Set :check_attribute_name config option

Returns:

  • (Boolean) —

    New :check_attribute_name config option

Raises:



133
134
135
136
 
# File 'lib/serega/config.rb', line 133

def check_attribute_name=(value)
  raise SeregaError, "Must have boolean value, #{value.inspect} provided" if (value != true) && (value != false)
  opts[:check_attribute_name] = value
end

#check_initiate_params ⇒ Boolean

Returns :check_initiate_params config option

Returns:

  • (Boolean) —

    Current :check_initiate_params config option



77
78
79
 
# File 'lib/serega/config.rb', line 77

def check_initiate_params
  opts.fetch(:check_initiate_params)
end

#check_initiate_params=(value) ⇒ Boolean

Sets :check_initiate_params config option

Parameters:

  • value (Boolean) —

    Set :check_initiate_params config option

Returns:

  • (Boolean) —

    :check_initiate_params config option

Raises:



86
87
88
89
 
# File 'lib/serega/config.rb', line 86

def check_initiate_params=(value)
  raise SeregaError, "Must have boolean value, #{value.inspect} provided" if (value != true) && (value != false)
  opts[:check_initiate_params] = value
end

#delegate_default_allow_nil ⇒ Boolean

Returns :delegate_default_allow_nil config option

Returns:

  • (Boolean) —

    Current :delegate_default_allow_nil config option



93
94
95
 
# File 'lib/serega/config.rb', line 93

def delegate_default_allow_nil
  opts.fetch(:delegate_default_allow_nil)
end

#delegate_default_allow_nil=(value) ⇒ Boolean

Sets :delegate_default_allow_nil config option

Parameters:

  • value (Boolean) —

    Set :delegate_default_allow_nil config option

Returns:

  • (Boolean) —

    :delegate_default_allow_nil config option

Raises:



102
103
104
105
 
# File 'lib/serega/config.rb', line 102

def delegate_default_allow_nil=(value)
  raise SeregaError, "Must have boolean value, #{value.inspect} provided" if (value != true) && (value != false)
  opts[:delegate_default_allow_nil] = value
end

#from_json ⇒ #call

Returns current ‘from_json` adapter

Returns:

  • (#call) —

    Callable that used to parse JSON



153
154
155
 
# File 'lib/serega/config.rb', line 153

def from_json
  opts.fetch(:from_json)
end

#from_json=(value) ⇒ #call

Sets current ‘from_json` adapter

Parameters:

  • value (#call) —

    Callable that used to parse JSON

Returns:

  • (#call) —

    Provided callable object



160
161
162
 
# File 'lib/serega/config.rb', line 160

def from_json=(value)
  opts[:from_json] = value
end

#initialize(opts = nil) ⇒ Object

Initializes new config instance.

Parameters:

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

    Initial config options



43
44
45
46
 
# File 'lib/serega/config.rb', line 43

def initialize(opts = nil)
  opts ||= DEFAULTS
  @opts = SeregaUtils::EnumDeepDup.call(opts)
end

#initiate_keys ⇒ Array<Symbol>

Returns options names allowed in ‘Serega#new` method

Returns:

  • (Array<Symbol>) —

    allowed options keys



59
60
61
 
# File 'lib/serega/config.rb', line 59

def initiate_keys
  opts.fetch(:initiate_keys)
end

#max_cached_plans_per_serializer_count ⇒ Boolean

Returns :max_cached_plans_per_serializer_count config option

Returns:

  • (Boolean) —

    Current :max_cached_plans_per_serializer_count config option



109
110
111
 
# File 'lib/serega/config.rb', line 109

def max_cached_plans_per_serializer_count
  opts.fetch(:max_cached_plans_per_serializer_count)
end

#max_cached_plans_per_serializer_count=(value) ⇒ Boolean

Sets :max_cached_plans_per_serializer_count config option

Parameters:

  • value (Boolean) —

    Set :check_initiate_params config option

Returns:

  • (Boolean) —

    New :max_cached_plans_per_serializer_count config option

Raises:



118
119
120
121
 
# File 'lib/serega/config.rb', line 118

def max_cached_plans_per_serializer_count=(value)
  raise SeregaError, "Must have Integer value, #{value.inspect} provided" unless value.is_a?(Integer)
  opts[:max_cached_plans_per_serializer_count] = value
end

#plugins ⇒ Array

Shows used plugins

Returns:

  • (Array) —

    Used plugins



53
54
55
 
# File 'lib/serega/config.rb', line 53

def plugins
  opts.fetch(:plugins)
end

#serialize_keys ⇒ Array<Symbol>

Returns options names allowed in ‘to_h, to_json, as_json` methods

Returns:

  • (Array<Symbol>) —

    Allowed options keys for serialization



71
72
73
 
# File 'lib/serega/config.rb', line 71

def serialize_keys
  opts.fetch(:serialize_keys)
end

#to_json ⇒ #call

Returns current ‘to_json` adapter

Returns:

  • (#call) —

    Callable that used to construct JSON



140
141
142
 
# File 'lib/serega/config.rb', line 140

def to_json
  opts.fetch(:to_json)
end

#to_json=(value) ⇒ #call

Sets current ‘to_json` adapter

Parameters:

  • value (#call) —

    Callable that used to construct JSON

Returns:

  • (#call) —

    Provided callable object



147
148
149
 
# File 'lib/serega/config.rb', line 147

def to_json=(value)
  opts[:to_json] = value
end