Exception: CodeError::Base

Inherits:
StandardError
  • Object
show all
Defined in:
lib/code_error.rb

Constant Summary collapse

@@global_config = 
{
  :success => {
    :code =>   SUCCESS_CODE,
    :status => SUCCESS_STATUS,
    :msg =>    SUCCESS_MSG,
    :pos =>    DEFAULT_POS,
    :masked => DEFAULT_MASKED
  },
  :internal => {
    :code =>   INTERNAL_CODE,
    :status => INTERNAL_STATUS,
    :msg =>    INTERNAL_MSG,
    :pos =>    DEFAULT_POS,
    :masked => DEFAULT_MASKED
  },
  :masked_msg => DEFAULT_MASKED_MSG,
  :pos =>        DEFAULT_POS,
  :masked =>     DEFAULT_MASKED
}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(code = nil, options = {}, code_map = {}, klass_config = {}) ⇒ Base

Returns a new instance of Base.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/code_error.rb', line 108

def initialize(code = nil, options = {}, code_map = {}, klass_config = {})
  @code =       code
  @info =       options[:info]
  @masked_msg = options[:masked_msg] || klass_config[:masked_msg] || @@global_config[:masked_msg]
  @success_code =    klass_config[:success][:code]    || @@global_config[:success][:code]
  @internal_code =   klass_config[:internal][:code]   || @@global_config[:internal][:code]
  @internal_status = klass_config[:internal][:status] || @@global_config[:internal][:status]
  if code_map.keys.include?(code)
    @status = code_map[code][:status]
    @msg =    options[:msg] || code_map[code][:msg] || klass_config[:internal][:msg]  || @@global_config[:internal][:msg]
    @pos =    nil_next(options[:pos],    nil_next(code_map[code][:pos],    nil_next(klass_config[:pos],    @@global_config[:pos])))
    @masked = nil_next(options[:masked], nil_next(code_map[code][:masked], nil_next(klass_config[:masked], @@global_config[:masked])))
  elsif code == @success_code
    @code = @success_code
    @status = options[:status] || klass_config[:success][:status] || @@global_config[:success][:status]
    @msg =    options[:msg]    || klass_config[:success][:msg]    || @@global_config[:success][:msg]
    @pos =    options[:pos]    || klass_config[:success][:pos]    || @@global_config[:success][:pos]
    @masked = nil_next(options[:masked], nil_next(klass_config[:success][:masked], @@global_config[:success][:masked]))
  else
    # :internal or unknown code
    if code.is_a?(String)
      @code = @internal_code
      @msg = code
    else
      @code = code
      @msg =  options[:msg]    || klass_config[:internal][:msg]    || @@global_config[:internal][:msg]
    end
    @status = options[:status] || @internal_status
    @pos =    options[:pos]    || klass_config[:internal][:pos]    || @@global_config[:internal][:pos]
    @masked = nil_next(options[:masked], nil_next(klass_config[:internal][:masked], @@global_config[:internal][:masked]))
  end
end

Instance Attribute Details

#code ⇒ Object (readonly)

Returns the value of attribute code.



18
19
20
 
# File 'lib/code_error.rb', line 18

def code
  @code
end

#info ⇒ Object (readonly)

Returns the value of attribute info.



18
19
20
 
# File 'lib/code_error.rb', line 18

def info
  @info
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



18
19
20
 
# File 'lib/code_error.rb', line 18

def status
  @status
end

Class Method Details

.error_codes(data = {}) ⇒ Object 



46
47
48
 
# File 'lib/code_error.rb', line 46

def self.error_codes(data = {})
  @error_codes = data
end

.gen(code = nil, options = {}) ⇒ Object 



40
41
42
43
44
 
# File 'lib/code_error.rb', line 40

def self.gen(code = nil, options = {})
  merge_klass_config
  @error_codes = {} unless @error_codes
  new(code, options, @error_codes, @klass_config)
end

.internal(data = {}) ⇒ Object 



54
55
56
 
# File 'lib/code_error.rb', line 54

def self.internal(data = {})
  merge_klass_config( :internal => data )
end

.masked(masked = false) ⇒ Object 



62
63
64
 
# File 'lib/code_error.rb', line 62

def self.masked(masked = false)
  merge_klass_config( :masked => masked )
end

.masked_msg(msg = nil) ⇒ Object 



58
59
60
 
# File 'lib/code_error.rb', line 58

def self.masked_msg(msg = nil)
  merge_klass_config( :masked_msg => msg )
end

.pos(pos = nil) ⇒ Object 



66
67
68
 
# File 'lib/code_error.rb', line 66

def self.pos(pos = nil)
  merge_klass_config( :pos => pos )
end

.success(data = {}) ⇒ Object 



50
51
52
 
# File 'lib/code_error.rb', line 50

def self.success(data = {})
  merge_klass_config( :success => data )
end

Instance Method Details

#data(options = {}) ⇒ Object 



74
75
76
77
78
79
80
81
 
# File 'lib/code_error.rb', line 74

def data(options = {})
  {
    :status => @status,
    :code => @code,
    :msg => show_message(@code, @msg, options),
    :info => @info
  }
end

#internal? ⇒ Boolean

Returns:



87
88
89
 
# File 'lib/code_error.rb', line 87

def internal?
  @status == @internal_status
end

#message ⇒ Object 



70
71
72
 
# File 'lib/code_error.rb', line 70

def message
  self.data.inspect
end

#msg(options = {}) ⇒ Object 



83
84
85
 
# File 'lib/code_error.rb', line 83

def msg(options = {})
  show_message(@code, @msg, options)
end