Class: PayPal::SDK::Core::Util::OrderedHash
- Inherits:
-
Hash
- Object
- Hash
- PayPal::SDK::Core::Util::OrderedHash
- Defined in:
- lib/paypal-sdk/core/util/ordered_hash.rb
Overview
:nodoc:
Direct Known Subclasses
Class Method Summary collapse
Instance Method Summary collapse
- #[]=(key, value) ⇒ Object
- #clear ⇒ Object
- #delete(key) ⇒ Object
- #delete_if ⇒ Object
- #each ⇒ Object (also: #each_pair)
- #each_key ⇒ Object
- #each_value ⇒ Object
-
#initialize(*args, &block) ⇒ OrderedHash
constructor
In MRI the Hash class is core and written in C.
- #initialize_copy(other) ⇒ Object
- #inspect ⇒ Object
- #invert ⇒ Object
- #keys ⇒ Object
- #merge(other_hash, &block) ⇒ Object
- #merge!(other_hash) ⇒ Object (also: #update)
- #reject(&block) ⇒ Object
- #reject! ⇒ Object
-
#replace(other) ⇒ Object
When replacing with another hash, the initial order of our keys must come from the other hash -ordered or not.
- #shift ⇒ Object
- #to_a ⇒ Object
- #to_hash ⇒ Object
- #to_yaml_type ⇒ Object
- #values ⇒ Object
Constructor Details
#initialize(*args, &block) ⇒ OrderedHash
In MRI the Hash class is core and written in C. In particular, methods are programmed with explicit C function calls and polymorphism is not honored.
For example, []= is crucial in this implementation to maintain the @keys array but hash.c invokes rb_hash_aset() originally. This prevents method reuse through inheritance and forces us to reimplement stuff.
For instance, we cannot use the inherited #merge! because albeit the algorithm itself would work, our []= is not being called at all by the C code.
22 23 24 25 |
# File 'lib/paypal-sdk/core/util/ordered_hash.rb', line 22 def initialize(*args, &block) super @keys = [] end |
Class Method Details
.[](*args) ⇒ Object
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
# File 'lib/paypal-sdk/core/util/ordered_hash.rb', line 27 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
57 58 59 60 |
# File 'lib/paypal-sdk/core/util/ordered_hash.rb', line 57 def []=(key, value) @keys << key if !has_key?(key) super end |
#clear ⇒ Object
116 117 118 119 120 |
# File 'lib/paypal-sdk/core/util/ordered_hash.rb', line 116 def clear super @keys.clear self end |
#delete(key) ⇒ Object
62 63 64 65 66 67 68 |
# File 'lib/paypal-sdk/core/util/ordered_hash.rb', line 62 def delete(key) if has_key? key index = @keys.index(key) @keys.delete_at index end super end |
#delete_if ⇒ Object
70 71 72 73 74 |
# File 'lib/paypal-sdk/core/util/ordered_hash.rb', line 70 def delete_if super sync_keys! self end |
#each ⇒ Object Also known as: each_pair
110 111 112 |
# File 'lib/paypal-sdk/core/util/ordered_hash.rb', line 110 def each @keys.each {|key| yield [key, self[key]]} end |
#each_key ⇒ Object
102 103 104 |
# File 'lib/paypal-sdk/core/util/ordered_hash.rb', line 102 def each_key @keys.each { |key| yield key } end |
#each_value ⇒ Object
106 107 108 |
# File 'lib/paypal-sdk/core/util/ordered_hash.rb', line 106 def each_value @keys.each { |key| yield self[key]} end |
#initialize_copy(other) ⇒ Object
51 52 53 54 55 |
# File 'lib/paypal-sdk/core/util/ordered_hash.rb', line 51 def initialize_copy(other) super # make a deep copy of keys @keys = other.keys end |
#inspect ⇒ Object
154 155 156 |
# File 'lib/paypal-sdk/core/util/ordered_hash.rb', line 154 def inspect "#<OrderedHash #{super}>" end |
#invert ⇒ Object
150 151 152 |
# File 'lib/paypal-sdk/core/util/ordered_hash.rb', line 150 def invert OrderedHash[self.to_a.map!{|key_value_pair| key_value_pair.reverse}] end |
#keys ⇒ Object
86 87 88 |
# File 'lib/paypal-sdk/core/util/ordered_hash.rb', line 86 def keys @keys.dup end |
#merge(other_hash, &block) ⇒ Object
139 140 141 |
# File 'lib/paypal-sdk/core/util/ordered_hash.rb', line 139 def merge(other_hash, &block) dup.merge!(other_hash, &block) end |
#merge!(other_hash) ⇒ Object Also known as: update
128 129 130 131 132 133 134 135 |
# File 'lib/paypal-sdk/core/util/ordered_hash.rb', line 128 def merge!(other_hash) if block_given? other_hash.each { |k, v| self[k] = key?(k) ? yield(k, self[k], v) : v } else other_hash.each { |k, v| self[k] = v } end self end |
#reject(&block) ⇒ Object
82 83 84 |
# File 'lib/paypal-sdk/core/util/ordered_hash.rb', line 82 def reject(&block) dup.reject!(&block) end |
#reject! ⇒ Object
76 77 78 79 80 |
# File 'lib/paypal-sdk/core/util/ordered_hash.rb', line 76 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.
144 145 146 147 148 |
# File 'lib/paypal-sdk/core/util/ordered_hash.rb', line 144 def replace(other) super @keys = other.keys self end |
#shift ⇒ Object
122 123 124 125 126 |
# File 'lib/paypal-sdk/core/util/ordered_hash.rb', line 122 def shift k = @keys.first v = delete(k) [k, v] end |
#to_a ⇒ Object
98 99 100 |
# File 'lib/paypal-sdk/core/util/ordered_hash.rb', line 98 def to_a @keys.map { |key| [ key, self[key] ] } end |
#to_hash ⇒ Object
94 95 96 |
# File 'lib/paypal-sdk/core/util/ordered_hash.rb', line 94 def to_hash self end |
#to_yaml_type ⇒ Object
5 6 7 |
# File 'lib/paypal-sdk/core/util/ordered_hash.rb', line 5 def to_yaml_type "!tag:yaml.org,2002:map" end |
#values ⇒ Object
90 91 92 |
# File 'lib/paypal-sdk/core/util/ordered_hash.rb', line 90 def values @keys.collect { |key| self[key] } end |