Class: Hashery::OrderedHash
- Inherits:
-
Hash
show all
- Defined in:
- lib/hashery/ordered_hash.rb
Overview
Note:
As of Ruby 1.9+ this class is not needed, since Ruby 1.9’s standard Hash tracks inseration order.
This implementation derives from the same class in ActiveSupport library.
OrderedHash is a simple ordered hash implmentation, for users of Ruby 1.8.7 or less.
Class Method Summary
collapse
Instance Method Summary
collapse
Methods inherited from Hash
create, #rekey, #rekey!, #retrieve, #to_stash
Constructor Details
#initialize(*args, &block) ⇒ OrderedHash
Returns a new instance of OrderedHash.
31
32
33
34
|
# File 'lib/hashery/ordered_hash.rb', line 31
def initialize(*args, &block)
super
@keys = []
end
|
Class Method Details
.[](*args) ⇒ Object
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
# File 'lib/hashery/ordered_hash.rb', line 36
def self.[](*args)
ordered_hash = new
if (args.length == 1 && args.first.is_a?(Array))
args.first.each do |key_value_pair|
next unless (key_value_pair.is_a?(Array))
ordered_hash[key_value_pair[0]] = key_value_pair[1]
end
return ordered_hash
end
unless (args.size % 2 == 0)
raise ArgumentError.new("odd number of arguments for Hash")
end
args.each_with_index do |val, ind|
next if (ind % 2 != 0)
ordered_hash[val] = args[ind + 1]
end
ordered_hash
end
|
Instance Method Details
#[]=(key, value) ⇒ Object
65
66
67
68
|
# File 'lib/hashery/ordered_hash.rb', line 65
def []=(key, value)
@keys << key unless key?(key)
super(key, value)
end
|
124
125
126
127
128
|
# File 'lib/hashery/ordered_hash.rb', line 124
def clear
super
@keys.clear
self
end
|
#delete(key) ⇒ Object
70
71
72
73
74
75
76
|
# File 'lib/hashery/ordered_hash.rb', line 70
def delete(key)
if has_key? key
index = @keys.index(key)
@keys.delete_at(index)
end
super(key)
end
|
#delete_if ⇒ Object
78
79
80
81
82
|
# File 'lib/hashery/ordered_hash.rb', line 78
def delete_if
super
sync_keys!
self
end
|
#each ⇒ Object
Also known as:
each_pair
118
119
120
|
# File 'lib/hashery/ordered_hash.rb', line 118
def each
@keys.each{ |key| yield(key, self[key]) }
end
|
110
111
112
|
# File 'lib/hashery/ordered_hash.rb', line 110
def each_key
@keys.each{ |key| yield(key) }
end
|
#each_value ⇒ Object
114
115
116
|
# File 'lib/hashery/ordered_hash.rb', line 114
def each_value
@keys.each{ |key| yield(self[key]) }
end
|
#initialize_copy(other) ⇒ Object
60
61
62
63
|
# File 'lib/hashery/ordered_hash.rb', line 60
def initialize_copy(other)
super(other)
@keys = other.keys
end
|
153
154
155
|
# File 'lib/hashery/ordered_hash.rb', line 153
def inspect
"#<OrderedHash #{super}>"
end
|
94
95
96
|
# File 'lib/hashery/ordered_hash.rb', line 94
def keys
@keys.dup
end
|
#merge(other_hash) ⇒ Object
141
142
143
|
# File 'lib/hashery/ordered_hash.rb', line 141
def merge(other_hash)
dup.merge!(other_hash)
end
|
#merge!(other_hash) ⇒ Object
136
137
138
139
|
# File 'lib/hashery/ordered_hash.rb', line 136
def merge!(other_hash)
other_hash.each{ |k,v| self[k] = v }
self
end
|
#reject(&block) ⇒ Object
90
91
92
|
# File 'lib/hashery/ordered_hash.rb', line 90
def reject(&block)
dup.reject!(&block)
end
|
84
85
86
87
88
|
# File 'lib/hashery/ordered_hash.rb', line 84
def reject!
super
sync_keys!
self
end
|
#replace(other) ⇒ Object
When replacing with another hash, the initial order of our keys must come from the other hash, ordered or not.
147
148
149
150
151
|
# File 'lib/hashery/ordered_hash.rb', line 147
def replace(other)
super
@keys = other.keys
self
end
|
130
131
132
133
134
|
# File 'lib/hashery/ordered_hash.rb', line 130
def shift
k = @keys.first
v = delete(k)
[k, v]
end
|
#sync_keys! ⇒ Object
159
160
161
|
# File 'lib/hashery/ordered_hash.rb', line 159
def sync_keys!
@keys.delete_if{ |k| !key?(k) }
end
|
106
107
108
|
# File 'lib/hashery/ordered_hash.rb', line 106
def to_a
@keys.map{ |key| [ key, self[key] ] }
end
|
102
103
104
|
# File 'lib/hashery/ordered_hash.rb', line 102
def to_hash
self
end
|
#to_yaml(opts = {}) ⇒ Object
18
19
20
21
22
23
24
25
26
|
# File 'lib/hashery/ordered_hash.rb', line 18
def to_yaml(opts = {})
YAML.quick_emit(self, opts) do |out|
out.seq(taguri, to_yaml_style) do |seq|
each do |k, v|
seq.add(k => v)
end
end
end
end
|
#to_yaml_type ⇒ Object
14
15
16
|
# File 'lib/hashery/ordered_hash.rb', line 14
def to_yaml_type
"!tag:yaml.org,2002:omap"
end
|
98
99
100
|
# File 'lib/hashery/ordered_hash.rb', line 98
def values
@keys.collect{ |key| self[key] }
end
|