lib/ruote/util/lookup.rb in ruote-2.2.0 vs lib/ruote/util/lookup.rb in ruote-2.3.0

@@ -1,7 +1,7 @@
 #--
-# Copyright (c) 2005-2011, John Mettraux, [e-mail]
+# Copyright (c) 2005-2012, John Mettraux, [e-mail]
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
 # in the Software without restriction, including without limitation the rights
 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
@@ -23,36 +23,62 @@
 #++
 
 
 module Ruote
 
+  #--
+  # methods that accept a small "dot notation" for looking up
+  # into nested hashes and arrays
+  #++
+
   #   h = { 'a' => { 'b' => [ 1, 3, 4 ] } }
   #
   #   p Ruote.lookup(h, 'a.b.1') # => 3
   #
-  def Ruote.lookup(collection, key, container_lookup=false)
+  def self.lookup(collection, key, container_lookup=false)
 
     return collection if key == '.'
 
     key, rest = pop_key(key)
-    value = flookup(collection, key)
+    value = fetch(collection, key)
 
     return [ key, collection ] if container_lookup && rest.size == 0
     return [ rest.first, value ] if container_lookup && rest.size == 1
     return value if rest.size == 0
     return nil if value == nil
 
-    lookup(value, rest)
+    lookup(value, rest, container_lookup)
   end
 
+  #   h = { 'a' => { 'b' => [ 1, 3, 4 ] } }
+  #
+  #   p Ruote.lookup(h, 'a.b.1') # => true
+  #
+  def self.has_key?(collection, key)
+
+    return collection if key == '.'
+
+    key, rest = pop_key(key)
+
+    return has_key?(fetch(collection, key), rest) if rest.any?
+
+    if collection.respond_to?(:has_key?)
+      collection.has_key?(key)
+    elsif collection.respond_to?(:[])
+      key.to_i < collection.size
+    else
+      false
+    end
+  end
+
   #   h = { 'customer' => { 'name' => 'alpha' } }
   #
   #   Ruote.set(h, 'customer.name', 'bravo')
   #
   #   h #=> { 'customer' => { 'name' => 'bravo' } }
   #
-  def Ruote.set(collection, key, value)
+  def self.set(collection, key, value)
 
     k, c = lookup(collection, key, true)
 
     if c
       k = k.to_i if c.is_a?(Array)
@@ -66,49 +92,61 @@
   #   r = Ruote.unset(h, 'customer.rank')
   #
   #   h # => { 'customer' => { 'name' => 'alpha' } }
   #   r # => '1st'
   #
-  def Ruote.unset(collection, key)
+  def self.unset(collection, key)
 
     k, c = lookup(collection, key, true)
 
-    return collection.delete(key) unless c
-
-    if c.is_a?(Array)
+    if c.nil?
+      collection.delete(key)
+    elsif c.is_a?(Array)
       c.delete_at(Integer(k)) rescue nil
-    else
+    elsif c.is_a?(Hash)
       c.delete(k)
+    else
+      nil
     end
   end
 
   protected # well...
 
-  def Ruote.pop_key(key)
+  # Pops the first key in a path key.
+  #
+  #   Ruote.pop_key('a.b.c') # => 'a'
+  #   Ruote.pop_key('1.2.3') # => 1
+  #
+  # (note the narrowing to an int that happens)
+  #
+  def self.pop_key(key)
 
     ks = key.is_a?(String) ? key.split('.') : key
 
     [ narrow_key(ks.first), ks[1..-1] ]
   end
 
-  def Ruote.narrow_key(key)
+  # If the key holds an integer returns it, else return the key as is.
+  #
+  def self.narrow_key(key)
 
-    return 0 if key == '0'
-
-    i = key.to_i
-    return i if i != 0
-
-    key
+    key.match(/^-?\d+$/) ? key.to_i : key
   end
 
-  def Ruote.flookup(collection, key)
+  # Given a collection and a key returns the corresponding value
+  #
+  #   Ruote.fetch([ 12, 13, 24 ], 1) # => 13
+  #   Ruote.fetch({ '1' => 13 }, 1) # => 13
+  #   Ruote.fetch({ 1 => 13 }, 1) # => 13
+  #
+  def self.fetch(collection, key)
 
     value = (collection[key] rescue nil)
 
     if value == nil and key.is_a?(Fixnum)
-      value = (collection[key.to_s] rescue nil)
+      (collection[key.to_s] rescue nil)
+    else
+      value
     end
-
-    value
   end
 end