Class: Hash

Inherits:
Object show all
Extended by:
Nuggets::Hash::IDMapMixin, Nuggets::Hash::NestMixin, Nuggets::Hash::SeenMixin, Nuggets::Hash::ZipMixin
Includes:
Nuggets::Hash::BlankMixin, Nuggets::Hash::DeepMergeMixin, Nuggets::Hash::UnrollMixin
Defined in:
lib/nuggets/hash/insert.rb,
lib/nuggets/hash/at.rb,
lib/nuggets/hash/zip.rb,
lib/nuggets/hash/nest.rb,
lib/nuggets/hash/only.rb,
lib/nuggets/hash/seen.rb,
lib/nuggets/hash/idmap.rb,
lib/nuggets/hash/unroll.rb,
lib/nuggets/object/blank.rb,
lib/nuggets/hash/in_order.rb,
lib/nuggets/hash/deep_merge.rb

Overview

–

#

A component of ruby-nuggets, some extensions to the Ruby programming # language. #

#

Copyright © 2007-2011 Jens Wille #

#

Authors: #

Jens Wille <[email protected]>                                       #
                                                                        #

ruby-nuggets is free software; you can redistribute it and/or modify it # under the terms of the GNU Affero General Public License as published by # the Free Software Foundation; either version 3 of the License, or (at your # option) any later version. #

#

ruby-nuggets is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or # FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License # for more details. #

#

You should have received a copy of the GNU Affero General Public License # along with ruby-nuggets. If not, see <www.gnu.org/licenses/>. #

#

++

Direct Known Subclasses

Nuggets::Hash::ZipMixin::ZipHash

Instance Method Summary collapse

Methods included from Nuggets::Hash::ZipMixin

zip, zipkey, zipval

Methods included from Nuggets::Hash::NestMixin

nest

Methods included from Nuggets::Hash::SeenMixin

seen

Methods included from Nuggets::Hash::IDMapMixin

idmap

Methods included from Nuggets::Hash::DeepMergeMixin

#deep_merge, #deep_merge!

Methods included from Nuggets::Hash::BlankMixin

#vain?

Methods included from Nuggets::Hash::UnrollMixin

#unroll

Instance Method Details

#at(what) ⇒ Object

call-seq:

hash.at(what) => aHash

Returns the key/value pair of hash at key position what. Remember that hashes might not have the intended (or expected) order in pre-1.9 Ruby.



37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/nuggets/hash/at.rb', line 37

def at(what)
  return {} if empty?

  key = case what
    when ::Integer
      keys[what]
    else
      block_given? ? keys.send(*what) { |*a| yield(*a) } : keys.send(*what)
  end

  { key => self[key] }
end

#first ⇒ Object

call-seq:

hash.first => aHash

Returns the “first” key/value pair of hash.



54
55
56
 
# File 'lib/nuggets/hash/at.rb', line 54

def first
  at(:first)
end

#in_order(*ordered) ⇒ Object

call-seq:

hash.in_order(*ordered) => anArray

Returns hash#to_a, in forced order (cf. Array#in_order).

Examples:

{ :a => 1, :b => 2, :c => 3 }.in_order(:b, :c)  #=> [[:b, 2], [:c, 3], [:a, 1]]
{ :a => 1, :b => 2, :c => 3 }.in_order(:b, :d)  #=> [[:b, 2], [:a, 1], [:c, 3]]



40
41
42
 
# File 'lib/nuggets/hash/in_order.rb', line 40

def in_order(*ordered)
  keys.in_order(*ordered).map { |key| [key, self[key]] }
end

#insert(other, &block) ⇒ Object

call-seq:

hash.insert(other) => new_hash
hash.insert(other) { |key, old_value, new_value| ... } => new_hash

Inserts other into hash, while merging existing values instead of just overwriting. Uses default Hash#merge or block for merging.



36
37
38
39
40
41
42
43
 
# File 'lib/nuggets/hash/insert.rb', line 36

def insert(other, &block)
  block ||= lambda { |key, old_val, new_val|
    old_val.is_a?(::Hash) && new_val.is_a?(::Hash) ?
      old_val.merge(new_val, &block) : new_val
  }

  merge(other, &block)
end

#insert!(other) ⇒ Object

call-seq:

hash.insert!(other) => hash
hash.insert!(other) { |key, old_value, new_value| ... } => hash

Destructive version of #insert.



50
51
52
 
# File 'lib/nuggets/hash/insert.rb', line 50

def insert!(other)
  replace block_given? ? insert(other) { |*a| yield(*a) } : insert(other)
end

#last ⇒ Object

call-seq:

hash.last => aHash

Returns the “last” key/value pair of hash.



62
63
64
 
# File 'lib/nuggets/hash/at.rb', line 62

def last
  at(:last)
end

#only(relax = size == 1, split = false) ⇒ Object

call-seq:

hash.only => aHash
hash.only(+true+) => aHash

Returns the only key/value pair of hash. Raises an IndexError if hash’s size is not 1, unless parameter true is passed.

Raises:

  • (::IndexError) 


38
39
40
41
42
 
# File 'lib/nuggets/hash/only.rb', line 38

def only(relax = size == 1, split = false)
  raise ::IndexError, 'not a single-element hash' unless relax

  split ? Array(*first) : first
end

#only_pair(relax = size == 1) ⇒ Object

call-seq:

hash.only_pair => anArray
hash.only_pair(+true+) => anArray

Returns the only key/value pair of hash as an array. Raises an IndexError if hash’s size is not 1, unless parameter true is passed.



50
51
52
 
# File 'lib/nuggets/hash/only.rb', line 50

def only_pair(relax = size == 1)
  only(relax, true)
end

#rand ⇒ Object

call-seq:

hash.rand => aHash

Returns a random key/value pair of hash.



70
71
72
 
# File 'lib/nuggets/hash/at.rb', line 70

def rand
  at(:rand)
end