Class: Spider::OrderedHash

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

Overview

:nodoc:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args, &block) ⇒ OrderedHash

Returns a new instance of OrderedHash.



11
12
13
14
 
# File 'lib/spiderfw/utils/ordered_hash.rb', line 11

def initialize(*args, &block)
  super
  @keys = []
end

Class Method Details

.[](*args) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/spiderfw/utils/ordered_hash.rb', line 16

def self.[](*args)
  ordered_hash = new

  if args.length == 1 && (args.first.is_a?(Array)  || args.first.is_a?(Hash))
    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 



46
47
48
49
 
# File 'lib/spiderfw/utils/ordered_hash.rb', line 46

def []=(key, value)
  @keys << key if !has_key?(key)
  super
end

#clear ⇒ Object 



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

def clear
  super
  @keys.clear
  self
end

#delete(key) ⇒ Object 



51
52
53
54
55
56
57
 
# File 'lib/spiderfw/utils/ordered_hash.rb', line 51

def delete(key)
  if has_key? key
    index = @keys.index(key)
    @keys.delete_at index
  end
  super
end

#delete_if ⇒ Object 



59
60
61
62
63
 
# File 'lib/spiderfw/utils/ordered_hash.rb', line 59

def delete_if
  super
  sync_keys!
  self
end

#each ⇒ Object Also known as: each_pair 



103
104
105
 
# File 'lib/spiderfw/utils/ordered_hash.rb', line 103

def each
  @keys.each {|key| yield [key, self[key]]}
end

#each_key ⇒ Object 



95
96
97
 
# File 'lib/spiderfw/utils/ordered_hash.rb', line 95

def each_key
  @keys.each { |key| yield key }
end

#each_value ⇒ Object 



99
100
101
 
# File 'lib/spiderfw/utils/ordered_hash.rb', line 99

def each_value
  @keys.each { |key| yield self[key]}
end

#initialize_copy(other) ⇒ Object 



40
41
42
43
44
 
# File 'lib/spiderfw/utils/ordered_hash.rb', line 40

def initialize_copy(other)
  super
  # make a deep copy of keys
  @keys = other.keys
end

#inspect ⇒ Object 



137
138
139
 
# File 'lib/spiderfw/utils/ordered_hash.rb', line 137

def inspect
  "#<OrderedHash #{super}>"
end

#keys ⇒ Object 



75
76
77
 
# File 'lib/spiderfw/utils/ordered_hash.rb', line 75

def keys
  @keys.dup
end

#merge(other_hash) ⇒ Object 



126
127
128
 
# File 'lib/spiderfw/utils/ordered_hash.rb', line 126

def merge(other_hash)
  dup.merge!(other_hash)
end

#merge!(other_hash) ⇒ Object 



121
122
123
124
 
# File 'lib/spiderfw/utils/ordered_hash.rb', line 121

def merge!(other_hash)
  other_hash.each {|k,v| self[k] = v }
  self
end

#reject(&block) ⇒ Object 



71
72
73
 
# File 'lib/spiderfw/utils/ordered_hash.rb', line 71

def reject(&block)
  dup.reject!(&block)
end

#reject! ⇒ Object 



65
66
67
68
69
 
# File 'lib/spiderfw/utils/ordered_hash.rb', line 65

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.



131
132
133
134
135
 
# File 'lib/spiderfw/utils/ordered_hash.rb', line 131

def replace(other)
  super
  @keys = other.keys
  self
end

#shift ⇒ Object 



115
116
117
118
119
 
# File 'lib/spiderfw/utils/ordered_hash.rb', line 115

def shift
  k = @keys.first
  v = delete(k)
  [k, v]
end

#to_a ⇒ Object 



87
88
89
 
# File 'lib/spiderfw/utils/ordered_hash.rb', line 87

def to_a
  @keys.map { |key| [ key, self[key] ] }
end

#to_hash ⇒ Object 



83
84
85
 
# File 'lib/spiderfw/utils/ordered_hash.rb', line 83

def to_hash
  self
end

#to_json ⇒ Object 



91
92
93
 
# File 'lib/spiderfw/utils/ordered_hash.rb', line 91

def to_json
    '{'+ @keys.map{ |key| ({key => self[key]}).to_json[1..-2] }.join(', ') +'}'
end

#values ⇒ Object 



79
80
81
 
# File 'lib/spiderfw/utils/ordered_hash.rb', line 79

def values
  @keys.collect { |key| self[key] }
end