Class: OrderedHash

Inherits:
Hash
  • Object
show all
Defined in:
lib/mongo/util/ordered_hash.rb

Overview

A hash in which the order of keys are preserved.

Under Ruby 1.9 and greater, this class has no added methods because Ruby’s Hash already keeps its keys ordered by order of insertion.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*a, &b) ⇒ OrderedHash

Returns a new instance of OrderedHash.



52
53
54
55
 
# File 'lib/mongo/util/ordered_hash.rb', line 52

def initialize(*a, &b)
  super
  @ordered_keys = []
end

Instance Attribute Details

#ordered_keys ⇒ Object

Returns the value of attribute ordered_keys.



35
36
37
 
# File 'lib/mongo/util/ordered_hash.rb', line 35

def ordered_keys
  @ordered_keys
end

Class Method Details

.[](*args) ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/mongo/util/ordered_hash.rb', line 37

def self.[] *args
  oh = OrderedHash.new
  if Hash === args[0]
    oh.merge! args[0]
  elsif (args.size % 2) != 0
    raise ArgumentError, "odd number of elements for Hash"
  else
    0.step(args.size - 1, 2) do |key|
      value = key + 1
      oh[args[key]] = args[value]
    end
  end
  oh
end

Instance Method Details

#==(other) ⇒ Object 



23
24
25
26
27
28
29
30
31
 
# File 'lib/mongo/util/ordered_hash.rb', line 23

def ==(other)
  begin
    !other.nil? &&
      keys == other.keys &&
      values == other.values
  rescue
    false
  end
end

#[]=(key, value) ⇒ Object 



61
62
63
64
65
 
# File 'lib/mongo/util/ordered_hash.rb', line 61

def []=(key, value)
  @ordered_keys ||= []
  @ordered_keys << key unless @ordered_keys.include?(key)
  super(key, value)
end

#clear ⇒ Object 



108
109
110
111
 
# File 'lib/mongo/util/ordered_hash.rb', line 108

def clear
  super
  @ordered_keys = []
end

#delete(key, &block) ⇒ Object 



95
96
97
98
 
# File 'lib/mongo/util/ordered_hash.rb', line 95

def delete(key, &block)
  @ordered_keys.delete(key) if @ordered_keys
  super
end

#delete_if(&block) ⇒ Object 



100
101
102
103
104
105
106
 
# File 'lib/mongo/util/ordered_hash.rb', line 100

def delete_if(&block)
  self.each { |k,v|
    if yield k, v
      delete(k)
    end
  }
end

#each ⇒ Object 



67
68
69
70
 
# File 'lib/mongo/util/ordered_hash.rb', line 67

def each
  @ordered_keys ||= []
  @ordered_keys.each { |k| yield k, self[k] }
end

#inspect ⇒ Object 



89
90
91
92
93
 
# File 'lib/mongo/util/ordered_hash.rb', line 89

def inspect
  str = '{'
  str << (@ordered_keys || []).collect { |k| "\"#{k}\"=>#{self.[](k).inspect}" }.join(", ")
  str << '}'
end

#keys ⇒ Object 



57
58
59
 
# File 'lib/mongo/util/ordered_hash.rb', line 57

def keys
  @ordered_keys || []
end

#merge(other) ⇒ Object 



76
77
78
79
80
 
# File 'lib/mongo/util/ordered_hash.rb', line 76

def merge(other)
  oh = self.dup
  oh.merge!(other)
  oh
end

#merge!(other) ⇒ Object 



82
83
84
85
86
87
 
# File 'lib/mongo/util/ordered_hash.rb', line 82

def merge!(other)
  @ordered_keys ||= []
  @ordered_keys += other.keys # unordered if not an OrderedHash
  @ordered_keys.uniq!
  super(other)
end

#values ⇒ Object 



72
73
74
 
# File 'lib/mongo/util/ordered_hash.rb', line 72

def values
  collect { |k, v| v }
end