traipse 0.5.0 → 0.6.0

data/lib/traipse.rb

@@ -10,6 +10,10 @@ module Traipse
     return _find( object, path.split( SEPARATOR ) )
   end
   
+  def self.find_with_keys( object, path )
+    _find_with_keys( object, path.split( SEPARATOR ) )
+  end
+  
   def self._find( object, path, results=[] ) # :nodoc:
     key, *rest = path
     
@@ -43,4 +47,37 @@ module Traipse
     return results
   end
   
+  def self._find_with_keys( object, path, full_path=[], results={} ) # :nodoc:
+    key, *rest = path
+    full_path << key unless key == "*"
+    
+    # Handle wildcard hash keys
+    if key == '*'
+      object.keys.each do |subkey|
+        results.merge! _find_with_keys( object, [ subkey, *rest ], full_path.dup )
+      end
+      return results.reject { |k,v| v.nil? }
+    end
+
+    # This is the end of the line, megatron.
+    return { full_path.join(".") => object[key] } if rest.empty?
+    
+    # Traverse hashes and arrays
+    case object[ key ]
+    when Hash
+      return _find_with_keys( object[ key ], rest, full_path )
+    when Array
+      if rest.first =~ /^\d+$/
+        index = rest.shift.to_i
+        results.merge! _find_with_keys( object[key][index], rest, full_path + [index] )
+      else
+        object[ key ].each_with_index do |obj, index|
+          results.merge! _find_with_keys( obj, rest, full_path + [index] )
+        end
+      end
+    end
+    
+    return results
+  end
+  
 end

data/lib/traipse/version.rb

@@ -1,3 +1,3 @@
 module Traipse
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/test/traipse_test.rb

@@ -0,0 +1,89 @@
+require "../lib/traipse"
+require "test/unit"
+
+
+
+class TraipseTest < Test::Unit::TestCase
+  
+  DATA = {
+    "name" => "Percival",
+    "board" => {
+      "name" => "cats"
+    },
+    "categories" => [
+      { "name" => "animals" },
+      { "name" => "kitties" },
+      { "name" => "robots" },    
+    ],
+    "products" => {
+      "shoes" => {
+        "brands" => [
+          { "name" => "converse" },
+          { "name" => "adidas" },
+          { "name" => "nike" }
+        ]
+      },
+      "apparel" => {
+        "brands" => [
+          { "name" => "Calvin Klein" },
+          { "name" => "Diesel" },
+          { "name" => "Betsey Johnson" },
+          { "name" => [ "Marc", "Ecko" ] },
+          { "caltrops" => 'Yes Please' }
+        ]
+      }
+    }
+  }
+  
+  def test_can_find_top_level_values
+    assert_equal ['Percival'], Traipse.find( DATA, 'name' )
+  end
+  
+  def test_can_return_key_names_too
+    matches = Traipse.find_with_keys( DATA, 'name' )
+    assert_equal matches.keys, ["name"]
+    assert_equal matches.values, ["Percival"]
+  end
+  
+  def test_can_get_to_nested_values
+    matches = Traipse.find_with_keys( DATA, 'board.name' )
+    assert_equal matches.keys, ["board.name"]
+    assert_equal matches.values, ["cats"]
+  end
+  
+  def test_can_traverse_arrays
+    matches = Traipse.find_with_keys( DATA, 'categories.name' )
+    assert_equal ["categories.0.name", "categories.1.name", "categories.2.name"], matches.keys
+    assert_equal ["animals", "kitties", "robots"], matches.values
+  end
+  
+  def test_can_traverse_arrays_to_get_to_nested_values
+    matches = Traipse.find_with_keys( DATA, 'products.shoes.brands.name' )
+    assert_equal ["products.shoes.brands.0.name", "products.shoes.brands.1.name", "products.shoes.brands.2.name"], matches.keys
+    assert_equal [ "converse", "adidas", "nike" ], matches.values
+  end
+  
+  def test_can_handle_key_wildcards
+    matches = Traipse.find_with_keys( DATA, 'products.*.brands.name' )
+    assert_equal [ "converse", "adidas", "nike", "Calvin Klein", "Diesel", "Betsey Johnson", [ "Marc", "Ecko" ] ], matches.values
+    assert_equal "products.shoes.brands.0.name", matches.keys.first
+    assert_equal "products.apparel.brands.3.name", matches.keys.last
+    
+    matches = Traipse.find_with_keys( DATA, '*.name' )
+    assert_equal [ "cats", "animals", "kitties", "robots" ], matches.values
+    assert_equal "board.name", matches.keys.first
+    assert_equal "categories.2.name", matches.keys.last
+  end
+  
+  def test_can_do_multiple_wildcards
+    matches = Traipse.find_with_keys( DATA, "products.*.brands.*" )
+    assert_equal [ "converse", "adidas", "nike", "Calvin Klein", "Diesel", "Betsey Johnson", [ "Marc", "Ecko" ], 'Yes Please' ], matches.values
+    assert_equal "products.shoes.brands.0.name", matches.keys.first
+    assert_equal "products.apparel.brands.4.caltrops", matches.keys.last
+  end
+  
+  def test_can_match_array_indexed_paths
+    assert_equal [ "Marc", "Ecko" ], Traipse.find_with_keys( DATA, "products.apparel.brands.3.name").values.first
+    assert_equal 'Yes Please', Traipse.find_with_keys( DATA, "products.apparel.brands.4.caltrops").values.first
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: traipse
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-25 00:00:00.000000000Z
+date: 2012-08-15 00:00:00.000000000 Z
 dependencies: []
 description: ! 'Traipse is a library that allows you to address a data structure of
   Hashes & Arrays using a dot notated string & wildcards. ex: ''categories.*.name''.
@@ -28,6 +28,7 @@ files:
 - lib/traipse/version.rb
 - spec/spec_helper.rb
 - spec/traipse_spec.rb
+- test/traipse_test.rb
 - traipse.gemspec
 homepage: https://github.com/makenai/traipse
 licenses: []
@@ -49,10 +50,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: traipse
-rubygems_version: 1.8.17
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Traverse data structures with a dot notated string.
 test_files:
 - spec/spec_helper.rb
 - spec/traipse_spec.rb
+- test/traipse_test.rb