Class: TypeStruct

Inherits:
Object show all
Defined in:
lib/type_struct.rb,
lib/type_struct/ext.rb,
lib/type_struct/union.rb,
lib/type_struct/hash_of.rb,
lib/type_struct/version.rb,
lib/type_struct/array_of.rb,
lib/type_struct/generator.rb,
lib/type_struct/interface.rb,
lib/type_struct/exceptions.rb

Defined Under Namespace

Modules: ClassMethods, Unionable Classes: ArrayOf, Generator, HashOf, Interface, MultiTypeError, Union

Constant Summary collapse

VERSION = 
"0.7.1"
UnionNotFoundError = 
Class.new(StandardError)

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arg = {}) ⇒ TypeStruct

Returns a new instance of TypeStruct.

Raises:



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/type_struct.rb', line 11

def initialize(arg = {})
  unless h = Hash.try_convert(arg)
    raise TypeError, "no implicit conversion from #{arg} to Hash"
  end
  sym_h = {}
  h.each do |k, v|
    sym_h[k.to_sym] = v
  end
  errors = []
  klass = self.class
  klass.members.each do |k|
    unless klass.valid?(k, sym_h[k])
      begin
        raise TypeError, "#{klass}##{k} expect #{klass.type(k)} got #{sym_h[k].inspect}"
      rescue TypeError => e
        errors << e
      end
    end
    instance_variable_set("@#{k}", sym_h[k])
    sym_h[k].freeze if self.class.frozen?
  end
  raise MultiTypeError, errors unless errors.empty?
end

Class Method Details

.new(**args, &block) ⇒ Object 



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/type_struct.rb', line 172

def new(**args, &block)
  c = Class.new(TypeStruct) do
    extend ClassMethods
    const_set :DEFINITION, args.freeze

    class << self
      alias_method :new, :original_new
    end

    args.each_key do |k|
      define_method(k) do
        instance_variable_get("@#{k}")
      end

      define_method("#{k}=") do |v|
        unless self.class.valid?(k, v)
          raise TypeError, "#{self.class}##{k} expect #{self.class.type(k)} got #{v.inspect}"
        end
        instance_variable_set("@#{k}", v)
      end
    end
  end

  if block_given?
    c.module_eval(&block)
  end
  c
end

.original_new ⇒ Object 



171
 
# File 'lib/type_struct.rb', line 171

alias original_new new

.try_convert(klass, key, value, errors) ⇒ Object 



107
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/type_struct.rb', line 107

def try_convert(klass, key, value, errors)
  case klass
  when Union
    union_errors = []
    klass.each do |k|
      begin
        return try_convert(k, key, value, nil)
      rescue TypeError, MultiTypeError => e
        union_errors << e
      end
    end

    raise UnionNotFoundError, "#{klass} is not found with value `#{value}'\nerrors:\n#{union_errors.join("\n")}"
  when ArrayOf
    unless Array === value
      begin
        raise TypeError, "#{self}##{key} expect #{klass.inspect} got #{value.inspect}"
      rescue TypeError => e
        raise unless errors
        errors << e
      end
      return value
    end
    value.map { |v| try_convert(klass.type, key, v, errors) }
  when HashOf
    unless Hash === value
      begin
        raise TypeError, "#{self}##{key} expect #{klass.inspect} got #{value.inspect}"
      rescue TypeError => e
        raise unless errors
        errors << e
      end
      return value
    end
    new_hash = {}
    value.each do |hk, hv|
      new_hash[hk] = try_convert(klass.value_type, key, hv, errors)
    end
    new_hash
  else
    if klass.respond_to?(:ancestors)
      if klass.ancestors.include?(TypeStruct)
        klass.from_hash(value)
      elsif klass.ancestors.include?(Struct)
        struct = klass.new
        value.each { |k, v| struct[k] = v }
        struct
      elsif klass === value
        value
      else
        begin
          raise TypeError, "#{self}##{key} expect #{klass} got #{value.inspect}"
        rescue => e
          raise unless errors
          errors << e
        end
        value
      end
    else
      value
    end
  end
end

Instance Method Details

#==(other) ⇒ Object 



35
36
37
38
 
# File 'lib/type_struct.rb', line 35

def ==(other)
  return false unless TypeStruct === other
  to_h == other.to_h
end

#[](k) ⇒ Object 



44
45
46
 
# File 'lib/type_struct.rb', line 44

def [](k)
  __send__ k
end

#[]=(k, v) ⇒ Object 



40
41
42
 
# File 'lib/type_struct.rb', line 40

def []=(k, v)
  __send__ "#{k}=", v
end

#inspect ⇒ Object Also known as: to_s 



48
49
50
51
52
53
 
# File 'lib/type_struct.rb', line 48

def inspect
  m = to_h.map do |k, v|
    "#{k}=#{v.inspect}"
  end
  "#<#{self.class} #{m.join(', ')}>"
end

#to_h ⇒ Object 



56
57
58
59
60
61
62
 
# File 'lib/type_struct.rb', line 56

def to_h
  m = {}
  self.class.members.each do |k|
    m[k] = self[k]
  end
  m
end