Class: Dictionary

Inherits:
Object show all
Includes:
Enumerable
Defined in:
lib/knj/autoload/backups/facets_dictionary.rb

Overview

Dictionary

The Dictionary class is a Hash that preserves order. So it has some array-like extensions also. By defualt a Dictionary object preserves insertion order, but any order can be specified including alphabetical key order.

Usage

Just require this file and use Dictionary instead of Hash.

# You can do simply
hsh = Dictionary.new
hsh['z'] = 1
hsh['a'] = 2
hsh['c'] = 3
p hsh.keys     #=> ['z','a','c']

# or using Dictionary[] method
hsh = Dictionary['z', 1, 'a', 2, 'c', 3]
p hsh.keys     #=> ['z','a','c']

# but this don't preserve order
hsh = Dictionary['z'=>1, 'a'=>2, 'c'=>3]
p hsh.keys     #=> ['a','c','z']

# Dictionary has useful extensions: push, pop and unshift
p hsh.push('to_end', 15)       #=> true, key added
p hsh.push('to_end', 30)       #=> false, already - nothing happen
p hsh.unshift('to_begin', 50)  #=> true, key added
p hsh.unshift('to_begin', 60)  #=> false, already - nothing happen
p hsh.keys                     #=> ["to_begin", "a", "c", "z", "to_end"]
p hsh.pop                      #=> ["to_end", 15], if nothing remains, return nil
p hsh.keys                     #=> ["to_begin", "a", "c", "z"]
p hsh.shift                    #=> ["to_begin", 30], if nothing remains, return nil

Usage Notes

  • You can use #order_by to set internal sort order.

  • #<< takes a two element [k,v] array and inserts.

  • Use ::auto which creates Dictionay sub-entries as needed.

  • And ::alpha which creates a new Dictionary sorted by key.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args, &blk) ⇒ Dictionary

New Dictiionary.



124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 124

def initialize(*args, &blk)
  @order = []
  @order_by = nil
  if blk
    dict = self                                  # This ensure autmatic key entry effect the
    oblk = lambda{ |hsh, key| blk[dict,key] }    # dictionary rather then just the interal hash.
    @hash = Hash.new(*args, &oblk)
  else
    @hash = Hash.new(*args)
  end
end

Class Method Details

.[](*args) ⇒ Object

– TODO is this needed? Doesn’t the super class do this? ++



74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 74

def [](*args)
  hsh = new
  if Hash === args[0]
    hsh.replace(args[0])
  elsif (args.size % 2) != 0
    raise ArgumentError, "odd number of elements for Hash"
  else
    while !args.empty?
      hsh[args.shift] = args.shift
    end
  end
  hsh
end

.alpha(*args, &block) ⇒ Object

Alternate to #new which creates a dictionary sorted by key.

d = Dictionary.alpha
d["z"] = 1
d["y"] = 2
d["x"] = 3
d  #=> {"x"=>3,"y"=>2,"z"=>2}

This is equivalent to:

Dictionary.new.order_by { |key,value| key }



106
107
108
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 106

def alpha(*args, &block)
  new(*args, &block).order_by_key
end

.auto(*args) ⇒ Object

Alternate to #new which auto-creates sub-dictionaries as needed.

d = Dictionary.auto
d["a"]["b"]["c"] = "abc"  #=> { "a"=>{"b"=>{"c"=>"abc"}}}



115
116
117
118
119
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 115

def auto(*args)
  #AutoDictionary.new(*args)
  leet = lambda { |hsh, key| hsh[key] = new(&leet) }
  new(*args, &leet)
end

.new_by(*args, &blk) ⇒ Object

Like #new but the block sets the order.



90
91
92
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 90

def new_by(*args, &blk)
  new(*args).order_by(&blk)
end

Instance Method Details

#<<(kv) ⇒ Object 



327
328
329
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 327

def <<(kv)
  push(*kv)
end

#==(hsh2) ⇒ Object

def ==( hsh2 )

return false if @order != hsh2.order
super hsh2

end



201
202
203
204
205
206
207
208
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 201

def ==(hsh2)
  if hsh2.is_a?( Dictionary )
    @order == hsh2.order &&
    @hash  == hsh2.instance_variable_get("@hash")
  else
    false
  end
end

#[](k) ⇒ Object 



210
211
212
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 210

def [] k
  @hash[ k ]
end

#[]=(k, i = nil, v = nil) ⇒ Object

Store operator.

h[key] = value

Or with additional index.

h[key,index] = value



226
227
228
229
230
231
232
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 226

def []=(k, i=nil, v=nil)
  if v
    insert(i,k,v)
  else
    store(k,i)
  end
end

#clear ⇒ Object 



244
245
246
247
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 244

def clear
  @order = []
  @hash.clear
end

#delete(key) ⇒ Object 



249
250
251
252
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 249

def delete( key )
  @order.delete( key )
  @hash.delete( key )
end

#delete_if ⇒ Object 



270
271
272
273
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 270

def delete_if
  order.clone.each { |k| delete k if yield(k,@hash[k]) }
  self
end

#dup ⇒ Object 



352
353
354
355
356
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 352

def dup
  a = []
  each{ |k,v| a << k; a << v }
  self.class[*a]
end

#each ⇒ Object Also known as: each_pair 



264
265
266
267
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 264

def each
  order.each { |k| yield( k,@hash[k] ) }
  self
end

#each_key ⇒ Object 



254
255
256
257
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 254

def each_key
  order.each { |k| yield( k ) }
  self
end

#each_value ⇒ Object 



259
260
261
262
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 259

def each_value
  order.each { |k| yield( @hash[k] ) }
  self
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


401
402
403
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 401

def empty?
  @hash.empty?
end

#fetch(k, *a, &b) ⇒ Object 



214
215
216
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 214

def fetch(k, *a, &b)
  @hash.fetch(k, *a, &b)
end

#first(x = nil) ⇒ Object 



385
386
387
388
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 385

def first(x=nil)
  return @hash[order.first] unless x
  order.first(x).collect { |k| @hash[k] }
end

#has_key?(key) ⇒ Boolean

Returns:

  • (Boolean) 


405
406
407
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 405

def has_key?(key)
  @hash.key?(key)
end

#insert(i, k, v) ⇒ Object 



234
235
236
237
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 234

def insert( i,k,v )
  @order.insert( i,k )
  @hash.store( k,v )
end

#inspect ⇒ Object 



346
347
348
349
350
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 346

def inspect
  ary = []
  each {|k,v| ary << k.inspect + "=>" + v.inspect}
  '{' + ary.join(", ") + '}'
end

#invert ⇒ Object 



285
286
287
288
289
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 285

def invert
  hsh2 = self.class.new
  order.each { |k| hsh2[@hash[k]] = k }
  hsh2
end

#key?(key) ⇒ Boolean

Returns:

  • (Boolean) 


409
410
411
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 409

def key?(key)
  @hash.key?(key)
end

#keys ⇒ Object 



281
282
283
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 281

def keys
  order
end

#last(x = nil) ⇒ Object 



391
392
393
394
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 391

def last(x=nil)
  return @hash[order.last] unless x
  order.last(x).collect { |k| @hash[k] }
end

#length ⇒ Object Also known as: size 



396
397
398
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 396

def length
  @order.length
end

#merge(hsh2) ⇒ Object 



365
366
367
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 365

def merge( hsh2 )
  self.dup.update(hsh2)
end

#order ⇒ Object 



136
137
138
139
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 136

def order
  reorder if @order_by
  @order
end

#order_by(&block) ⇒ Object

Keep dictionary sorted by a specific sort order.



143
144
145
146
147
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 143

def order_by( &block )
  @order_by = block
  order
  self
end

#order_by_key ⇒ Object

Keep dictionary sorted by key.

d = Dictionary.new.order_by_key
d["z"] = 1
d["y"] = 2
d["x"] = 3
d  #=> {"x"=>3,"y"=>2,"z"=>2}

This is equivalent to:

Dictionary.new.order_by { |key,value| key }

The initializer Dictionary#alpha also provides this.



163
164
165
166
167
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 163

def order_by_key
  @order_by = lambda { |k,v| k }
  order
  self
end

#order_by_value ⇒ Object

Keep dictionary sorted by value.

d = Dictionary.new.order_by_value
d["z"] = 1
d["y"] = 2
d["x"] = 3
d  #=> {"x"=>3,"y"=>2,"z"=>2}

This is equivalent to:

Dictionary.new.order_by { |key,value| value }



181
182
183
184
185
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 181

def order_by_value
  @order_by = lambda { |k,v| v }
  order
  self
end

#pop ⇒ Object 



341
342
343
344
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 341

def pop
  key = order.last
  key ? [key,delete(key)] : nil
end

#push(k, v) ⇒ Object 



331
332
333
334
335
336
337
338
339
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 331

def push( k,v )
  unless @hash.include?( k )
    @order.push( k )
    @hash.store( k,v )
    true
  else
    false
  end
end

#reject(&block) ⇒ Object 



291
292
293
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 291

def reject(&block)
  self.dup.delete_if(&block)
end

#reject!(&block) ⇒ Object 



295
296
297
298
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 295

def reject!( &block )
  hsh2 = reject(&block)
  self == hsh2 ? nil : hsh2
end

#reorder ⇒ Object 



188
189
190
191
192
193
194
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 188

def reorder
  if @order_by
    assoc = @order.collect{ |k| [k,@hash[k]] }.sort_by(&@order_by)
    @order = assoc.collect{ |k,v| k }
  end
  @order
end

#replace(hsh2) ⇒ Object 



300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 300

def replace(hsh2)
  case hsh2
  when Hash
    @order = hsh2.keys
    @hash  = hsh2
  else
    @order = hsh2.order
    @hash  = hsh2.hash
  end
  reorder
end

#reverse ⇒ Object 



380
381
382
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 380

def reverse
  dup.reverse!
end

#reverse! ⇒ Object 



375
376
377
378
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 375

def reverse!
  @order.reverse!
  self
end

#select ⇒ Object 



369
370
371
372
373
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 369

def select
  ary = []
  each { |k,v| ary << [k,v] if yield k,v }
  ary
end

#shift ⇒ Object 



312
313
314
315
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 312

def shift
  key = order.first
  key ? [key,delete(key)] : super
end

#store(a, b) ⇒ Object 



239
240
241
242
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 239

def store( a,b )
  @order.push( a ) unless @hash.key?( a )
  @hash.store( a,b )
end

#to_a ⇒ Object 



413
414
415
416
417
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 413

def to_a
  ary = []
  each { |k,v| ary << [k,v] }
  ary
end

#to_h ⇒ Object 



427
428
429
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 427

def to_h
  @hash.dup
end

#to_hash ⇒ Object 



423
424
425
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 423

def to_hash
  @hash.dup
end

#to_s ⇒ Object 



419
420
421
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 419

def to_s
  self.to_a.to_s
end

#unshift(k, v) ⇒ Object 



317
318
319
320
321
322
323
324
325
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 317

def unshift( k,v )
  unless @hash.include?( k )
    @order.unshift( k )
    @hash.store( k,v )
    true
  else
    false
  end
end

#update(hsh2) ⇒ Object Also known as: merge! 



358
359
360
361
362
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 358

def update( hsh2 )
  hsh2.each { |k,v| self[k] = v }
  reorder
  self
end

#values ⇒ Object 



275
276
277
278
279
 
# File 'lib/knj/autoload/backups/facets_dictionary.rb', line 275

def values
  ary = []
  order.each { |k| ary.push @hash[k] }
  ary
end