/usr/lib/ruby/vendor_ruby/hashery/dictionary.rb is in ruby-hashery 2.1.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 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 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 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 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 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 | module Hashery
# 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.
#
# Using a Dictionary is almost the same as using a 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
#
# == 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.
#
# == Acknowledgments
#
# Dictionary is a port of OrderHash 2.0 Copyright (c) 2005 Jan Molic.
#
# People who have contributed to this class since then include:
#
# * Andrew Johnson (merge, to_a, inspect, shift and Hash[])
# * Jeff Sharpe (reverse and reverse!)
# * Thomas Leitner (has_key? and key?)
#
# OrderedHash is public domain.
#
class Dictionary
include Enumerable
class << self
#
# Create a new Dictionary storing argument pairs as an initial mapping.
#
# TODO: Is this needed? Doesn't the super class do this?
#
# Returns Dictionary instance.
#
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
#
# Like #new but the block sets the order instead of the default.
#
# Dictionary.new_by{ |k,v| k }
#
def new_by(*args, &blk)
new(*args).order_by(&blk)
end
#
# Alternate to #new which creates a dictionary sorted by the key as a string.
#
# d = Dictionary.alphabetic
# 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.to_s }
#
def alphabetic(*args, &block)
new(*args, &block).order_by { |key,value| key.to_s }
end
# DEPRECATED: Use #alphabetic instead.
alias :alpha :alphabetic
#
# Alternate to #new which auto-creates sub-dictionaries as needed.
#
# Examples
#
# d = Dictionary.auto
# d["a"]["b"]["c"] = "abc" #=> { "a"=>{"b"=>{"c"=>"abc"}}}
#
def auto(*args)
#AutoDictionary.new(*args)
leet = lambda { |hsh, key| hsh[key] = new(&leet) }
new(*args, &leet)
end
end
#
# New Dictiionary.
#
def initialize(*args, &blk)
@order = []
@order_by = nil
if blk
dict = self # This ensures automatic 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
#
# Order of keys.
#
# Returns [Array].
#
def order
reorder if @order_by
@order
end
#
# Keep dictionary sorted by a specific sort order.
#
# block - Ordering procedure.
#
# Returns +self+.
#
def order_by( &block )
@order_by = block
order
self
end
#
# 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.
#
# Returns +self+.
#
def order_by_key
if block_given?
@order_by = Proc.new{ |k,v| yield(k) }
else
@order_by = Proc.new{ |k,v| k }
end
order
self
end
#
# 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 }
#
def order_by_value
if block_given?
@order_by = Proc.new{ |k,v| yield(v) }
else
@order_by = Proc.new{ |k,v| v }
end
order
self
end
#
# Re-apply the sorting procedure.
#
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
#def ==( hsh2 )
# return false if @order != hsh2.order
# super hsh2
#end
#
# Is the dictionary instance equivalent to another?
#
def ==(hsh2)
if hsh2.is_a?( Dictionary )
@order == hsh2.order &&
@hash == hsh2.instance_variable_get("@hash")
else
false
end
end
#
# Lookup entry with key.
#
def [] key
@hash[ key ]
end
#
# Featch entry given +key+.
#
def fetch(key, *a, &b)
@hash.fetch(key, *a, &b)
end
#
# Store operator.
#
# h[key] = value
#
# Or with additional index.
#
# h[key,index] = value
#
def []=(k, i=nil, v=nil)
if v
insert(i,k,v)
else
store(k,i)
end
end
#
# Insert entry into dictionary at specific index position.
#
# index - [Integer] Position of order placement.
# key - [Object] Key to associate with value.
# value - [Object] Value to associate with key.
#
# Returns `value` stored.
#
def insert(index, key, value)
@order.insert(index, key)
@hash.store(key, value)
end
#
# Add entry into dictionary.
#
# Returns `value`.
#
def store(key, value)
@order.push(key) unless @hash.has_key?(key)
@hash.store(key, value)
end
#
# Clear dictionary of all entries.
#
def clear
@order = []
@hash.clear
end
#
# Delete the entry with given +key+.
#
def delete(key)
@order.delete(key)
@hash.delete(key)
end
#
# Iterate over each key.
#
def each_key
order.each { |k| yield( k ) }
self
end
#
# Iterate over each value.
#
def each_value
order.each { |k| yield( @hash[k] ) }
self
end
#
# Iterate over each key-value pair.
#
def each
order.each { |k| yield( k,@hash[k] ) }
self
end
alias each_pair each
#
# Delete entry if it fits conditional block.
#
def delete_if
order.clone.each { |k| delete k if yield(k,@hash[k]) }
self
end
#
# List of all dictionary values.
#
# Returns [Array].
#
def values
ary = []
order.each { |k| ary.push @hash[k] }
ary
end
#
# List of all dictionary keys.
#
# Returns [Array].
#
def keys
order
end
#
# Invert the dictionary.
#
# Returns [Dictionary] New dictionary that is inverse of the original.
#
def invert
hsh2 = self.class.new
order.each { |k| hsh2[@hash[k]] = k }
hsh2
end
#
# Reject entries based on give condition block and return
# new dictionary.
#
# Returns [Dictionary].
#
def reject(&block)
self.dup.delete_if(&block)
end
#
# Reject entries based on give condition block.
#
# Returns [Hash] of rejected entries.
#
# FIXME: This looks like it is implemented wrong!!!
#
def reject!( &block )
hsh2 = reject(&block)
self == hsh2 ? nil : hsh2
end
#
# Replace dictionary entries with new table.
#
def replace(hsh2)
case hsh2
when Dictionary
@order = hsh2.order
@hash = hsh2.to_h
when Hash
@hash = hsh2
@order = @hash.keys
else
@hash = hsh2.to_h
@order = @hash.keys
end
reorder
end
#
# Remove entry from the to top of dictionary.
#
def shift
key = order.first
key ? [key,delete(key)] : super
end
#
# Push entry on to the top of dictionary.
#
def unshift( k,v )
unless @hash.include?( k )
@order.unshift( k )
@hash.store( k,v )
true
else
false
end
end
#
# Same as #push.
#
def <<(kv)
push(*kv)
end
#
# Push entry on to bottom of the dictionary.
#
def push(k,v)
unless @hash.include?( k )
@order.push( k )
@hash.store( k,v )
true
else
false
end
end
#
# Pop entry off the bottom of dictionary.
#
def pop
key = order.last
key ? [key,delete(key)] : nil
end
#
# Inspection string for Dictionary.
#
# Returns [String].
#
def inspect
ary = []
each {|k,v| ary << k.inspect + "=>" + v.inspect}
'{' + ary.join(", ") + '}'
end
#
# Duplicate dictionary.
#
# Returns [Dictionary].
#
def dup
a = []
each{ |k,v| a << k; a << v }
self.class[*a]
end
#
# Update dictionary with other hash.
#
# Returns self.
#
def update( hsh2 )
hsh2.each { |k,v| self[k] = v }
reorder
self
end
alias :merge! update
#
# Merge other hash creating new dictionary.
#
# Returns [Dictionary].
#
def merge(hsh2)
self.dup.update(hsh2)
end
#
# Select items from dictiornary.
#
# Returns [Array] of two-element arrays.
#
def select
ary = []
each { |k,v| ary << [k,v] if yield k,v }
ary
end
#
# Reverse the order of the dictionary.
#
# Returns self.
#
def reverse!
@order.reverse!
self
end
#
# Reverse the order of duplicte dictionary.
#
# Returns [Dictionary].
#
def reverse
dup.reverse!
end
#
# Get/set initial entry value.
#
def first(x=nil)
return @hash[order.first] unless x
order.first(x).collect { |k| @hash[k] }
end
#
# Get/set last entry value.
#
def last(x=nil)
return @hash[order.last] unless x
order.last(x).collect { |k| @hash[k] }
end
#
# Number of items in the dictionary.
#
def length
@order.length
end
alias :size :length
#
# Is the dictionary empty?
#
# Returns `true` or `false`.
#
def empty?
@hash.empty?
end
#
# Does the dictionary have a given +key+.
#
# Returns `true` or `false`.
#
def has_key?(key)
@hash.has_key?(key)
end
#
# Does the dictionary have a given +key+.
#
# Returns `true` or `false`.
#
def key?(key)
@hash.key?(key)
end
#
# Convert to array.
#
# Returns [Array] of two-element arrays.
#
def to_a
ary = []
each { |k,v| ary << [k,v] }
ary
end
#
# Convert to array then to string.
#
# Returns [String].
#
def to_s
self.to_a.to_s
end
#
# Get a duplicate of the underlying hash table.
#
# Returns [Hash].
#
def to_hash
@hash.dup
end
#
# Get a duplicate of the underlying hash table.
#
# Returns [Hash].
#
def to_h
@hash.dup
end
protected
#
# Underlying hash table.
#
def hash_table
@hash
end
end
end
|