Class: OrderedHash

Inherits:
Hash
  • Object
show all
Defined in:
lib/orderedhash.rb

Overview

AUTHOR

jan molic /mig/at/1984/dot/cz/

DESCRIPTION

Hash with preserved order and some array-like extensions
Public domain.

THANKS

Andrew Johnson for his suggestions and fixes of Hash[],
merge, to_a, inspect and shift

Direct Known Subclasses

AutoOrderedHash

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*a, &b) ⇒ OrderedHash

–}}}



35
36
37
38
39
40
 
# File 'lib/orderedhash.rb', line 35

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

Instance Attribute Details

#order ⇒ Object

–{{{



13
14
15
 
# File 'lib/orderedhash.rb', line 13

def order
  @order
end

#to_yaml_style ⇒ Object

Returns the value of attribute to_yaml_style.



218
219
220
 
# File 'lib/orderedhash.rb', line 218

def to_yaml_style
  @to_yaml_style
end

Class Method Details

.[](*args) ⇒ Object

–{{{



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/orderedhash.rb', line 17

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
    0.step(args.size - 1, 2) do |a|
      b = a + 1
      hsh[args[a]] = args[b]
    end
  end
  hsh
#--}}}
end

Instance Method Details

#==(hsh2) ⇒ Object 



54
55
56
57
58
59
 
# File 'lib/orderedhash.rb', line 54

def == hsh2
#--{{{
    return false if @order != hsh2.order
    super hsh2
#--}}}
end

#__class__ ⇒ Object

–}}}



212
213
214
215
216
 
# File 'lib/orderedhash.rb', line 212

def __class__
#--{{{
  OrderedHash
#--}}}
end

#class ⇒ Object

–}}}



207
208
209
210
211
 
# File 'lib/orderedhash.rb', line 207

def class
#--{{{
  Hash
#--}}}
end

#clear ⇒ Object

–}}}



60
61
62
63
64
65
 
# File 'lib/orderedhash.rb', line 60

def clear
#--{{{
    @order = []
    super
#--}}}
end

#delete(key) ⇒ Object

–}}}



66
67
68
69
70
71
 
# File 'lib/orderedhash.rb', line 66

def delete key
#--{{{
    @order.delete key
    super
#--}}}
end

#delete_if ⇒ Object 



91
92
93
94
95
96
97
98
 
# File 'lib/orderedhash.rb', line 91

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

#each ⇒ Object Also known as: each_pair

–}}}



84
85
86
87
88
89
 
# File 'lib/orderedhash.rb', line 84

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

#each_key ⇒ Object

–}}}



72
73
74
75
76
77
 
# File 'lib/orderedhash.rb', line 72

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

#each_value ⇒ Object

–}}}



78
79
80
81
82
83
 
# File 'lib/orderedhash.rb', line 78

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

#inspect ⇒ Object

–}}}



181
182
183
184
185
186
187
 
# File 'lib/orderedhash.rb', line 181

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

#invert ⇒ Object

–}}}



111
112
113
114
115
116
117
 
# File 'lib/orderedhash.rb', line 111

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

#keys ⇒ Object

–}}}



106
107
108
109
110
 
# File 'lib/orderedhash.rb', line 106

def keys
#--{{{
    @order
#--}}}
end

#merge(hsh2) ⇒ Object 



195
196
197
198
199
 
# File 'lib/orderedhash.rb', line 195

def merge hsh2
#--{{{
    self.dup update(hsh2)
#--}}}
end

#orig_store ⇒ Object

–}}}



46
 
# File 'lib/orderedhash.rb', line 46

alias orig_store store

#pop ⇒ Object

–}}}



163
164
165
166
167
168
 
# File 'lib/orderedhash.rb', line 163

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

#push(k, v) ⇒ Object

–}}}



152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/orderedhash.rb', line 152

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

#reject(&block) ⇒ Object

–}}}



118
119
120
121
122
 
# File 'lib/orderedhash.rb', line 118

def reject &block
#--{{{
    self.dup.delete_if &block
#--}}}
end

#reject!(&block) ⇒ Object

–}}}



123
124
125
126
127
128
 
# File 'lib/orderedhash.rb', line 123

def reject! &block
#--{{{
    hsh2 = reject &block
    self == hsh2 ? nil : hsh2
#--}}}
end

#replace(hsh2) ⇒ Object

–}}}



129
130
131
132
133
134
 
# File 'lib/orderedhash.rb', line 129

def replace hsh2
#--{{{
    @order = hsh2.keys 
    super hsh2
#--}}}
end

#select ⇒ Object

–}}}



200
201
202
203
204
205
206
 
# File 'lib/orderedhash.rb', line 200

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

#shift ⇒ Object

–}}}



135
136
137
138
139
140
 
# File 'lib/orderedhash.rb', line 135

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

#store(a, b) ⇒ Object Also known as: []= 



47
48
49
50
51
52
 
# File 'lib/orderedhash.rb', line 47

def store a,b
#--{{{
    @order.push a unless has_key? a
    super a,b
#--}}}
end

#store_only(a, b) ⇒ Object

–}}}



41
42
43
44
45
 
# File 'lib/orderedhash.rb', line 41

def store_only a,b
#--{{{
    store a,b
#--}}}
end

#to_a ⇒ Object

–}}}



169
170
171
172
173
174
175
 
# File 'lib/orderedhash.rb', line 169

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

#to_s ⇒ Object

–}}}



176
177
178
179
180
 
# File 'lib/orderedhash.rb', line 176

def to_s
#--{{{
    self.to_a.to_s
#--}}}
end

#unshift(k, v) ⇒ Object

–}}}



141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/orderedhash.rb', line 141

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

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

–}}}



188
189
190
191
192
193
 
# File 'lib/orderedhash.rb', line 188

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

#values ⇒ Object

–}}}



99
100
101
102
103
104
105
 
# File 'lib/orderedhash.rb', line 99

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

#yaml_inline! ⇒ Object 



244
 
# File 'lib/orderedhash.rb', line 244

def yaml_inline!() self.yaml_inline = true end

#yaml_inline=(bool) ⇒ Object 



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
 
# File 'lib/orderedhash.rb', line 219

def yaml_inline= bool
  if respond_to?("to_yaml_style")
    self.to_yaml_style = :inline
  else
    unless defined? @__yaml_inline_meth
      @__yaml_inline_meth =
        lambda {|opts|
          YAML::quick_emit(object_id, opts) {|emitter|
            emitter << '{ ' << map{|kv| kv.join ': '}.join(', ') << ' }'
          }
        }
      class << self
        def to_yaml opts = {}
          begin
            @__yaml_inline ? @__yaml_inline_meth[ opts ] : super
          rescue
            @to_yaml_style = :inline
            super
          end
        end
      end
    end
  end
  @__yaml_inline = bool
end