Class: BSON::OrderedHash

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*a, &b) ⇒ OrderedHash

Returns a new instance of OrderedHash.



63
64
65
66
# File 'lib/bson/ordered_hash.rb', line 63

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

Instance Attribute Details

#ordered_keysObject

Returns the value of attribute ordered_keys.



46
47
48
# File 'lib/bson/ordered_hash.rb', line 46

def ordered_keys
  @ordered_keys
end

Class Method Details

.[](*args) ⇒ Object



48
49
50
51
52
53
54
55
56
57
58
59
60
61
# File 'lib/bson/ordered_hash.rb', line 48

def self.[] *args
  oh = BSON::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
32
33
34
# File 'lib/bson/ordered_hash.rb', line 23

def ==(other)
  begin
    case other
    when BSON::OrderedHash
       keys == other.keys && values == other.values
    else
      super
    end
  rescue
    false
  end
end

#[]=(key, value) ⇒ Object



77
78
79
80
81
82
# File 'lib/bson/ordered_hash.rb', line 77

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

#clearObject



162
163
164
165
# File 'lib/bson/ordered_hash.rb', line 162

def clear
  super
  @ordered_keys = []
end

#delete(key, &block) ⇒ Object



131
132
133
134
# File 'lib/bson/ordered_hash.rb', line 131

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

#delete_if(&block) ⇒ Object



136
137
138
139
140
141
142
143
# File 'lib/bson/ordered_hash.rb', line 136

def delete_if(&block)
  keys.each do |key|
    if yield key, self[key]
      delete(key)
    end
  end
  self
end

#dupObject



117
118
119
120
121
122
123
# File 'lib/bson/ordered_hash.rb', line 117

def dup
  result = OrderedHash.new
  @ordered_keys.each do |key|
    result[key] = self[key]
  end
  result
end

#eachObject Also known as: each_pair



84
85
86
87
# File 'lib/bson/ordered_hash.rb', line 84

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

#eql?(o) ⇒ Boolean

Returns:

  • (Boolean)


182
183
184
185
186
187
188
# File 'lib/bson/ordered_hash.rb', line 182

def eql?(o)
  if o.instance_of? BSON::OrderedHash
    self.hash == o.hash
  else
    false
  end
end

#extractable_options?true, false

Allows activesupport Array#extract_options! to extract options when they are instance of BSON::OrderedHash

Returns:

  • (true, false)

    true if options can be extracted



40
41
42
# File 'lib/bson/ordered_hash.rb', line 40

def extractable_options?
  instance_of?(BSON::OrderedHash)
end

#hashObject



173
174
175
176
177
178
179
180
# File 'lib/bson/ordered_hash.rb', line 173

def hash
  code = 17
  each_pair do |key, value|
    code = 37 * code + key.hash
    code = 37 * code + value.hash
  end
  code & 0x7fffffff
end

#initialize_copy(original) ⇒ Object



167
168
169
170
# File 'lib/bson/ordered_hash.rb', line 167

def initialize_copy(original)
  super
  @ordered_keys = original.ordered_keys.dup
end

#inspectObject



125
126
127
128
129
# File 'lib/bson/ordered_hash.rb', line 125

def inspect
  str = "#<BSON::OrderedHash:0x#{self.object_id.to_s(16)} {"
  str << (@ordered_keys || []).collect { |k| "\"#{k}\"=>#{self.[](k).inspect}" }.join(", ")
  str << '}>'
end

#keysObject



73
74
75
# File 'lib/bson/ordered_hash.rb', line 73

def keys
  @ordered_keys.dup
end

#merge(other) ⇒ Object



103
104
105
106
107
# File 'lib/bson/ordered_hash.rb', line 103

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

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



109
110
111
112
113
# File 'lib/bson/ordered_hash.rb', line 109

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

#reject(&block) ⇒ Object



145
146
147
148
149
# File 'lib/bson/ordered_hash.rb', line 145

def reject(&block)
  clone = self.clone
  return clone unless block_given?
  clone.delete_if(&block)
end

#reject!(&block) ⇒ Object



151
152
153
154
155
156
157
158
159
160
# File 'lib/bson/ordered_hash.rb', line 151

def reject!(&block)
  changed = false
  self.each do |k,v|
    if yield k, v
      changed = true
      delete(k)
    end
  end
  changed ? self : nil
end

#replace(other) ⇒ Object



98
99
100
101
# File 'lib/bson/ordered_hash.rb', line 98

def replace(other)
  @ordered_keys.replace(other.keys)
  super
end

#to_aObject



90
91
92
# File 'lib/bson/ordered_hash.rb', line 90

def to_a
  @ordered_keys.map { |k| [k, self[k]] }
end

#valuesObject



94
95
96
# File 'lib/bson/ordered_hash.rb', line 94

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

#yaml_initialize(tag, val) ⇒ Object



68
69
70
71
# File 'lib/bson/ordered_hash.rb', line 68

def yaml_initialize(tag, val)
  @ordered_keys = []
  super
end