traipse 0.5.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in traipse.gemspec
+gemspec
+gem 'rspec'

data/README.rdoc

@@ -0,0 +1,33 @@
+= Traipse
+
+Traipse allows you to address a data structure with a dot notated string. This is useful for extracting certain nodes
+in a data structure (expecially JSON-parsed) and storing the 'path' to those nodes in a database.
+
+== Installation
+
+Traipse is available as a RubyGem:
+
+    gem install traipse
+    
+=== Example
+
+    data = {
+      "name" => "Percival",
+      "board" => {
+        "name" => "cats"
+      },
+      "categories" => [
+        { "name" => "animals" },
+        { "name" => "kitties" },
+        { "name" => "robots" },    
+      ]
+    }
+    
+    Traipse.find( data, 'name' ) # [ "Percival" ]
+    Traipse.find( data, 'board.name' ) # [ "cats" ]
+    Traipse.find( data, 'categories.name' ) # [ "animals", "kitties", "robots" ]
+    Traipse.find( data, '*.name' ) # [ "cats", "animals", "kitties", "robots" ]
+    
+== Authors
+
+* Pawel Szymczykowski

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/traipse.rb

@@ -0,0 +1,46 @@
+require "traipse/version"
+
+module Traipse
+  
+  SEPARATOR = '.'
+  
+  # Find a needle in a haystack using something akin to JSON dot syntax
+  # ex: Traipse.find( data, 'cat.name' ) # similar to data['cat']['name']
+  def self.find( object, path )
+    return _find( object, path.split( SEPARATOR ) )
+  end
+  
+  def self._find( object, path, results=[] ) # :nodoc:
+    key, *rest = path
+    
+    # Oops.. no key? Hands a path of '*'
+    return [ object ] unless key
+
+    # What happens if we miss a key?
+    return [] unless object.is_a?( Hash )
+
+    # Handle wildcard hash keys
+    if key == '*'
+      object.keys.each do |subkey|
+        results += _find( object, [ subkey, *rest ] )
+      end
+      return results
+    end
+
+    # This is the end of the line, megatron.
+    return [ object[ key ] ].compact if rest.empty?
+
+    # Traverse hashes and arrays
+    case object[ key ]
+    when Hash
+      return _find( object[ key ], rest )
+    when Array
+      object[ key ].each do |obj|
+        results += _find( obj, rest )
+      end
+    end
+    
+    return results
+  end
+  
+end

data/lib/traipse/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'traipse'
+
+RSpec.configure do |config|
+end

data/spec/traipse_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+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' }
+      ]
+    }
+  ]
+};
+
+describe Traipse do
+
+  it "can find top level values" do
+    Traipse.find( data, 'name' ).should == [ 'Percival' ]
+  end
+  
+  it "can get to nested values" do
+    Traipse.find( data, 'board.name' ).should == [ 'cats' ]
+  end
+  
+  it "can traverse arrays" do
+    Traipse.find( data, 'categories.name' ).should == [ "animals", "kitties", "robots" ]
+  end
+  
+  it "can traverse arrays to get to nested values" do
+    Traipse.find( data, 'products.shoes.brands.name' ).should == 
+      [ "converse", "adidas", "nike" ]
+  end
+  
+  it "can handle key wildcards" do
+    Traipse.find( data, 'products.*.brands.name' ).should ==
+      [ "converse", "adidas", "nike", "Calvin Klein", 
+        "Diesel", "Betsey Johnson", [ "Marc", "Ecko" ] ]
+        
+    Traipse.find( data, '*.name' ).should == [ "cats", "animals", "kitties", "robots" ]
+  end
+  
+  it "can do multiple wildcards" do
+      Traipse.find( data, "products.*.brands.*" ).should == 
+        [ "converse", "adidas", "nike", "Calvin Klein", 
+          "Diesel", "Betsey Johnson", [ "Marc", "Ecko" ], 'Yes Please' ]
+    end
+  
+end

data/traipse.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "traipse/version"
+
+Gem::Specification.new do |s|
+  s.name        = "traipse"
+  s.version     = Traipse::VERSION
+  s.authors     = ["Pawel Szymczykowski"]
+  s.email       = ["makenai@gmail.com"]
+  s.homepage    = "https://github.com/makenai/traipse"
+  s.summary     = %q{Traverse data structures with a dot notated string.}
+  s.description = %q{Traipse is a library that allows you to address a data structure of Hashes & Arrays using a dot notated string & wildcards. ex: 'categories.*.name'. Like X-Path but dumber.}
+
+  s.rubyforge_project = "traipse"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: traipse
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- Pawel Szymczykowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-25 00:00:00.000000000Z
+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''.
+  Like X-Path but dumber.'
+email:
+- makenai@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/traipse.rb
+- lib/traipse/version.rb
+- spec/spec_helper.rb
+- spec/traipse_spec.rb
+- traipse.gemspec
+homepage: https://github.com/makenai/traipse
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: traipse
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Traverse data structures with a dot notated string.
+test_files:
+- spec/spec_helper.rb
+- spec/traipse_spec.rb