Class: AttributeStruct

Inherits:
BasicObject
Defined in:
lib/attribute_struct/version.rb,
lib/attribute_struct/attribute_hash.rb,
lib/attribute_struct/attribute_struct.rb

Defined Under Namespace

Classes: CollapseArray, Mash

Constant Summary collapse

VERSION =

Current library version

::Gem::Version.new('0.2.16')
AttributeHash = 
Mash

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(init_hash = nil) { ... } ⇒ AttributeStruct

Create new instance

Parameters:

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

    hash to initialize struct

Yields:

  • block to execute within struct context



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/attribute_struct/attribute_struct.rb', line 61

def initialize(init_hash=nil, &block)
  @_camel_keys = _klass.camel_keys
  @_arg_state = __hashish.new
  @table = __hashish.new
  if(init_hash)
    _load(init_hash)
  end
  if(block)
    self.instance_exec(&block)
  end
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(sym, *args) { ... } ⇒ Object

Note:

Dragons and unicorns all over in here

Provides struct DSL behavior

Parameters:

  • sym (Symbol, String) —

    method name

  • args (Object) —

    argument list

Yields:

  • provided block

Returns:

  • (Object) —

    existing value or newly set value



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/attribute_struct/attribute_struct.rb', line 147

def method_missing(sym, *args, &block)
  if((s = sym.to_s).end_with?('='))
    s.slice!(-1, s.length)
    sym = s
  end
  sym = _process_key(sym)
  if(!args.empty? || block)
    if(args.empty? && block)
      base = @table.fetch(sym, :__unset__)
      if(_state(:value_collapse) && !base.is_a?(self.class!))
        orig = base
        base = _klass_new
      else
        unless(base.is_a?(self.class!))
          base = _klass_new
        end
      end
      if(block.arity == 0)
        base.instance_exec(&block)
      else
        base.instance_exec(base, &block)
      end
      if(orig.is_a?(::NilClass))
        @table[sym] = base
      else
        if(orig == :__unset__)
          @table[sym] = base
        else
          unless(orig.is_a?(CollapseArray))
            orig = CollapseArray.new.push(orig)
          end
          orig << base
          @table[sym] = orig
        end
      end
    elsif(!args.empty? && block)
      result = leaf = base = @table.fetch(sym, _klass_new)
      args.flatten.each do |arg|
        leaf = base[arg]
        unless(leaf.is_a?(_klass))
          leaf = _klass_new
          base._set(arg, leaf)
          base = leaf
        end
      end
      if(!leaf.nil? && _state(:value_collapse))
        orig = leaf
        leaf = orig.parent._klass_new
      end
      block.arity == 0 ? leaf._build(&block) : leaf._build(leaf, &block)
      if(orig)
        unless(orig.is_a?(CollapseArray))
          orig = CollapseArray.new.push(orig)
        end
        orig << leaf
      else
        orig = leaf
      end
      @table[sym] = result
    else
      if(args.size > 1 && args.all?{|i| i.is_a?(::String) || i.is_a?(::Symbol)} && !_state(:value_collapse))
        @table[sym] = _klass_new unless @table[sym].is_a?(_klass)
        endpoint = args.inject(@table[sym]) do |memo, k|
          unless(memo[k].is_a?(_klass))
            memo._set(k, _klass_new)
          end
          memo[k]
        end
        return endpoint # custom break out
      else
        if(_state(:value_collapse) && !(leaf = @table[sym]).nil?)
          unless(leaf.is_a?(CollapseArray))
            leaf = CollapseArray.new.push(leaf)
          end
          leaf << (args.size > 1 ? args : args.first)
          @table[sym] = leaf
        else
          @table[sym] = (args.size > 1 ? args : args.first)
        end
      end
    end
  end
  @table[sym] = _klass_new if @table[sym].nil? && !@table[sym].is_a?(_klass)
  @table[sym]
end

Class Attribute Details

.camel_keys ⇒ Truthy, Falsey

Returns global flag for camel keys.

Returns:

  • (Truthy, Falsey) —

    global flag for camel keys



8
9
10
 
# File 'lib/attribute_struct/attribute_struct.rb', line 8

def camel_keys
  @camel_keys
end

Instance Attribute Details

#_arg_state ⇒ AtributeStruct::AttributeHash, Mash (readonly)

Returns holding space for state.

Returns:

  • (AtributeStruct::AttributeHash, Mash) —

    holding space for state



55
56
57
 
# File 'lib/attribute_struct/attribute_struct.rb', line 55

def _arg_state
  @_arg_state
end

#_camel_keys ⇒ Truthy, Falsey

Returns current camelizing setting.

Returns:

  • (Truthy, Falsey) —

    current camelizing setting



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

def _camel_keys
  @_camel_keys
end

Class Method Details

.build(&block) ⇒ Object

Create AttributeStruct instance and dump the resulting hash



33
34
35
36
 
# File 'lib/attribute_struct/attribute_struct.rb', line 33

def build(&block)
  raise ArgumentError.new 'Block required for build!' unless block
  new(&block)._dump
end

.hashish ⇒ AttributeStruct::AttributeHash

Returns:



28
29
30
 
# File 'lib/attribute_struct/attribute_struct.rb', line 28

def hashish
  ::AttributeStruct::AttributeHash
end

.irb_compat! ⇒ TrueClass

Note:

this will add methods required for working within IRB

Enable IRB compatibility mode

Returns:

  • (TrueClass) 


42
43
44
45
 
# File 'lib/attribute_struct/attribute_struct.rb', line 42

def irb_compat!
  self.send(:include, IrbCompat)
  true
end

.load_the_camels ⇒ Object

Loads helpers for camel casing



20
21
22
23
24
25
 
# File 'lib/attribute_struct/attribute_struct.rb', line 20

def load_the_camels
  unless(@camels_loaded)
    require 'attribute_struct/monkey_camels'
    @camels_loaded = true
  end
end

Instance Method Details

#[](key) ⇒ Object

Direct data access

Parameters:

  • key (String, Symbol)

Returns:

  • (Object) 


120
121
122
 
# File 'lib/attribute_struct/attribute_struct.rb', line 120

def [](key)
  _data[_process_key(key)]
end

#__hashish ⇒ Class

Returns hashish type available.

Returns:

  • (Class) —

    hashish type available



341
342
343
 
# File 'lib/attribute_struct/attribute_struct.rb', line 341

def __hashish
  ::AttributeStruct::AttributeHash
end

#_array(*args) ⇒ Array Also known as: array!

Create an Array and evaluate discovered AttributeStructs

Parameters:

  • args (Object) —

    array contents

Returns:

  • (Array) 


458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/attribute_struct/attribute_struct.rb', line 458

def _array(*args)
  args.map do |maybe_block|
    if(maybe_block.is_a?(::Proc))
      klass = _klass_new
      if(maybe_block.arity > 0)
        klass.instance_exec(klass, &maybe_block)
      else
        klass.instance_exec(&maybe_block)
      end
      klass
    else
      maybe_block
    end
  end
end

#_build { ... } ⇒ Object Also known as: build!

Execute block within current context

Yields:

  • block to execute

Returns:

  • (Object) 


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

def _build(&block)
  self.instance_exec(&block)
end

#_camel_keys_action ⇒ Symbol, NilClass

Returns :auto_disable or :auto_enable.

Returns:

  • (Symbol, NilClass) —

    :auto_disable or :auto_enable



433
434
435
 
# File 'lib/attribute_struct/attribute_struct.rb', line 433

def _camel_keys_action
  @_camel_keys_set
end

#_camel_keys_set(v) ⇒ Symbol

Set custom rule for processed keys at this context level

Parameters:

  • v (Symbol) —

    :auto_disable or :auto_enable

Returns:

  • (Symbol) 


428
429
430
 
# File 'lib/attribute_struct/attribute_struct.rb', line 428

def _camel_keys_set(v)
  @_camel_keys_set = v
end

#_data ⇒ AttributeStruct::AttributeHash, Mash Also known as: data!

Returns underlying struct data.

Returns:



254
255
256
 
# File 'lib/attribute_struct/attribute_struct.rb', line 254

def _data
  @table
end

#_deep_copy(thing = nil) ⇒ Object

Create a “deep” copy

Parameters:

  • thing (Object) (defaults to: nil) —

    struct to copy. defaults to self

Returns:

  • (Object) —

    new instance



362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/attribute_struct/attribute_struct.rb', line 362

def _deep_copy(thing=nil)
  thing ||= _dump
  if(thing.is_a?(::Enumerable))
    val = thing.map{|v| v.is_a?(::Enumerable) ? _deep_copy(v) : _do_dup(v) }
  else
    val = _do_dup(thing)
  end
  if(thing.is_a?(::Hash))
    val = __hashish[*val.flatten(1)]
  end
  val
end

#_delete(key) ⇒ Object Also known as: delete!

Delete entry from struct

Parameters:

  • key (String, Symbol)

Returns:

  • (Object) —

    value of entry



263
264
265
 
# File 'lib/attribute_struct/attribute_struct.rb', line 263

def _delete(key)
  _data.delete(_process_key(key))
end

#_do_dup(v) ⇒ Object

Note:

if Symbol provided, String is returned

Provide dup of instance

Parameters:

  • v (Object)

Returns:

  • (Object) —

    duped instance



350
351
352
353
354
355
356
 
# File 'lib/attribute_struct/attribute_struct.rb', line 350

def _do_dup(v)
  begin
    v.dup
  rescue
    v.is_a?(::Symbol) ? v.to_s : v
  end
end

#_dump ⇒ AttributeStruct::AttributeHash, Mash Also known as: dump!

Returns dump struct to hashish.

Returns:



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/attribute_struct/attribute_struct.rb', line 269

def _dump
  processed = @table.map do |key, value|
    if(value.is_a?(::Enumerable))
      flat = value.map do |v|
        v.is_a?(_klass) ? v._dump : v
      end
      val = value.is_a?(::Hash) ? __hashish[*flat.flatten(1)] : flat
    elsif(value.is_a?(_klass))
      val = value._dump
    else
      val = value
    end
    [key, val]
  end
  __hashish[*processed.flatten(1)]
end

#_keys ⇒ Array<String,Symbol> Also known as: keys!

Returns keys within struct.

Returns:

  • (Array<String,Symbol>) —

    keys within struct



248
249
250
 
# File 'lib/attribute_struct/attribute_struct.rb', line 248

def _keys
  _data.keys
end

#_klass ⇒ Class Also known as: klass!, class!, class

Returns this class.

Returns:

  • (Class) —

    this class



405
406
407
 
# File 'lib/attribute_struct/attribute_struct.rb', line 405

def _klass
  ::AttributeStruct
end

#_klass_new ⇒ AttributeStruct

Note:

will set self as parent and propogate camelizing status

Returns new struct instance.

Returns:



414
415
416
417
418
419
420
421
422
 
# File 'lib/attribute_struct/attribute_struct.rb', line 414

def _klass_new
  n = _klass.new
  unless(_camel_keys_action == :auto_discovery)
    n._camel_keys_set(_camel_keys_action)
  end
  n._camel_keys = _camel_keys
  n._parent(self)
  n
end

#_load(hashish) ⇒ self Also known as: load!

Clear current struct data and replace

Parameters:

  • hashish (Hash) —

    hashish type instance

Returns:

  • (self) 


291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/attribute_struct/attribute_struct.rb', line 291

def _load(hashish)
  @table.clear
  if(_root._camel_keys_action == :auto_discovery)
    starts = hashish.keys.map{|k|k[0,1]}
    unless(starts.detect{|k| k =~ /[A-Z]/})
      _camel_keys_set(:auto_disable)
    else
      _camel_keys_set(:auto_enable) unless _parent.nil?
    end
  end
  hashish.each do |key, value|
    key = key.dup
    if(value.is_a?(::Enumerable))
      flat = value.map do |v|
        v.is_a?(::Hash) ? _klass.new(v) : v
      end
      value = value.is_a?(::Hash) ? __hashish[*flat.flatten(1)] : flat
    end
    if(value.is_a?(::Hash))
      self._set(key)._load(value)
    else
      self._set(key, value)
    end
  end
  self
end

#_merge(overlay) ⇒ AttributeStruct

Perform deep merge

Parameters:

Returns:



323
324
325
326
327
328
 
# File 'lib/attribute_struct/attribute_struct.rb', line 323

def _merge(overlay)
  source = _deep_copy
  dest = overlay._deep_copy
  result = source.deep_merge(dest)
  _klass.new(result)
end

#_merge!(overlay) ⇒ self

Perform deep merge in place

Parameters:

Returns:

  • (self) 


334
335
336
337
338
 
# File 'lib/attribute_struct/attribute_struct.rb', line 334

def _merge!(overlay)
  result = _merge(overlay)._dump
  _load(result)
  self
end

#_parent(obj = nil) ⇒ AttributeStruct, NilClass Also known as: parent!

Returns parent of this struct.

Returns:



438
439
440
441
 
# File 'lib/attribute_struct/attribute_struct.rb', line 438

def _parent(obj=nil)
  @_parent = obj if obj
  @_parent
end

#_process_key(key, *args) ⇒ String, Symbol Also known as: process_key!

Provide expected key format based on context

Parameters:

  • key (String, Symbol)
  • args (Object) —

    argument list (:force will force processing)

Returns:

  • (String, Symbol) 


380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/attribute_struct/attribute_struct.rb', line 380

def _process_key(key, *args)
  key = key.to_s
  if(_camel_keys && _camel_keys_action)
    case _camel_keys_action
    when :auto_disable
      key._no_hump
    when :auto_enable
      key._hump
    end
  end
  if((_camel_keys && key._camel?) || args.include?(:force))
    key.to_s.split('_').map do |part|
      "#{part[0,1].upcase}#{part[1,part.size]}"
    end.join.to_sym
  else
    if(_camel_keys)
      # Convert so Hash doesn't make a new one and lose the meta
      key = ::CamelString.new(key) unless key.is_a?(::CamelString)
    end
    key
  end
end

#_root ⇒ AttributeStruct, NilClass Also known as: root!

Returns root of the struct or nil if self is root.

Returns:

  • (AttributeStruct, NilClass) —

    root of the struct or nil if self is root



445
446
447
448
449
450
451
 
# File 'lib/attribute_struct/attribute_struct.rb', line 445

def _root
  r = self
  until(r._parent.nil?)
    r = r._parent
  end
  r
end

#_set(key, val = nil) { ... } ⇒ Object Also known as: set!

Directly set value into struct. Useful when the key is not valid ruby syntax for a method

Parameters:

  • key (String, Symbol)
  • val (Object) (defaults to: nil)

Yields:

  • block to execute within context

Returns:

  • (Object) 


131
132
133
134
135
136
137
 
# File 'lib/attribute_struct/attribute_struct.rb', line 131

def _set(key, val=nil, &block)
  if(val)
    self.method_missing(key, val, &block)
  else
    self.method_missing(key, &block)
  end
end

#_set_state(args = {}) ⇒ Hashish Also known as: set_state!

Set state into current context

Parameters:

  • args (Hashish) (defaults to: {}) —

    hashish type holding data for context

Returns:

  • (Hashish) 


86
87
88
 
# File 'lib/attribute_struct/attribute_struct.rb', line 86

def _set_state(args={})
  _arg_state.merge!(args)
end

#_state(key, traverse = true) ⇒ Object, NilClass Also known as: state!

Value of requested state

Parameters:

  • key (Symbol, String)
  • traverse (TrueClass, FalseClass) (defaults to: true) —

    traverse towards root for matching key

Returns:

  • (Object, NilClass) 


96
97
98
99
100
101
102
103
104
 
# File 'lib/attribute_struct/attribute_struct.rb', line 96

def _state(key, traverse=true)
  if(_arg_state.has_key?(key))
    _arg_state[key]
  else
    if(traverse && _parent)
      _parent._state(key)
    end
  end
end

#is_a?(klass) ⇒ TrueClass, FalseClass Also known as: kind_of?

Determine if self is a class

Parameters:

  • klass (Class)

Returns:

  • (TrueClass, FalseClass) 


242
243
244
 
# File 'lib/attribute_struct/attribute_struct.rb', line 242

def is_a?(klass)
  (_klass.ancestors + [::AttributeStruct]).include?(klass)
end

#nil? ⇒ TrueClass, FalseClass

Returns struct is nil (empty data).

Returns:

  • (TrueClass, FalseClass) —

    struct is nil (empty data)



234
235
236
 
# File 'lib/attribute_struct/attribute_struct.rb', line 234

def nil?
  _data.empty?
end

#respond_to?(name) ⇒ TrueClass, FalseClass

Instance responds to method name

Parameters:

  • name (Symbol, String)

Returns:

  • (TrueClass, FalseClass) 


479
480
481
 
# File 'lib/attribute_struct/attribute_struct.rb', line 479

def respond_to?(name)
  _klass.instance_methods.map(&:to_sym).include?(name.to_sym)
end