aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/ruby-msg/lib/orderedhash.rb
blob: 16a4f58605331fe3f1b14fd1d8933ffb163c46ab (plain)
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
# = OrderedHash
#
# == Version
#  1.2006.07.13 (change of the first number means Big Change)
#
# == Description
#  Hash which preserves order of added items (like PHP array).
#
# == Usage
#
# (see examples directory under the ruby gems root directory)
#
#  require 'rubygems'
#  require 'ordered_hash'
#
#  hsh = OrderedHash.new
#  hsh['z'] = 1
#  hsh['a'] = 2
#  hsh['c'] = 3
#  p hsh.keys     # ['z','a','c']
#
# == Source
# http://simplypowerful.1984.cz/goodlibs/1.2006.07.13
#
# == Author
#  jan molic (/mig/at_sign/1984/dot/cz/)
#
# == Thanks to
#  Andrew Johnson for his suggestions and fixes of Hash[], merge, to_a, inspect and shift
#  Desmond Dsouza for == fixes
#
# == Licence
#  You can redistribute it and/or modify it under the same terms of Ruby's license;
#  either the dual license version in 2003, or any later version.
#

class OrderedHash < Hash

	attr_accessor :order

	class << self

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

	end

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

	def store_only a,b
		store a,b
	end

	alias orig_store store

	def store a,b
		@order.push a unless has_key? a
		super a,b
	end

	alias []= store

	def == hsh2
		return hsh2==self if !hsh2.is_a?(OrderedHash)
		return false if @order != hsh2.order
		super hsh2
	end

	def clear
		@order = []
		super
	end

	def delete key
		@order.delete key
		super
	end

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

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

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

	alias each_pair each

	def delete_if
		@order.clone.each { |k|
			delete k if yield
		}
		self
	end

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

	def keys
		@order
	end

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

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

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

	def replace hsh2
		@order = hsh2.keys
		super hsh2
	end

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

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

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

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

	def first
		self[@order.first]
	end

	def last
		self[@order.last]
	end

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

	def to_s
		self.to_a.to_s
	end

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

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

	alias :merge! update

	def merge hsh2
		self.dup update(hsh2)
	end

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

end

#=end