hash-query 1.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hquery.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mike Evans
+
+MIT License
+
+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 copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Hquery
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hquery'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hquery
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/hash_query.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/hash_query/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Mike Evans']
+  gem.email         = ['mike@urlgonomics.com']
+  gem.description   = %q{Provides a css-like selector system for querying values out of deeply nested hashes}
+  gem.summary       = %q{See above}
+  gem.homepage      = 'https://github.com/mje113/hash-query'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'hash-query'
+  gem.require_paths = ['lib']
+  gem.version       = HashQuery::VERSION
+end

data/lib/hash_query.rb

@@ -0,0 +1,132 @@
+require 'hash_query/version'
+require 'pry'
+
+module HashQuery
+
+  module Extension
+
+    # Public: Scans the hash data strucure looking for keys that match the 
+    # psuedo css selector.
+    #
+    # selectors - String of pseudo css selectors to navigate hash structure
+    #
+    # Examples
+    #
+    #     entity = { 
+    #       :a => 1, 
+    #       :b => { 
+    #         :c => {
+    #           :d => { 
+    #             :e => 2, 
+    #             :f => 3 
+    #           }
+    #         },
+    #         :cc => [
+    #           3,
+    #           {
+    #             :g => 6,
+    #             :h => 7,
+    #             :i => [ 8, 9, 10, 11 ]
+    #           },
+    #           4,
+    #           5
+    #         ]
+    #       }
+    #     }.to_entity
+    #     entity.query('a')         # => 1
+    #     entity.query('a b c d e') # => 2
+    #     entity.query('c d e')     # => 2
+    #     entity.query('a>string')
+    #     entity.query('a:string')
+    #
+    # Returns a value or collection of values that are found.
+    def query(selectors)
+      @_query ||= HashQuery::Query.new(self)
+      @_query.query(selectors)
+    end
+
+  end
+
+  class Query
+
+    def initialize(hash)
+      @hash = hash
+    end
+
+    def query(selectors)
+      selectors = Selector.parse(selectors)
+      found = descend(selectors, @hash, [])
+  
+      if found.empty?
+        nil
+      elsif found.size == 1
+        found.first
+      else
+        found
+      end
+    end
+
+    def hash_y?(node)
+      node.class.ancestors.include?(Hash)
+    end
+  
+    def array_y?(node)
+      node.class.ancestors.include?(Array)
+    end
+  
+    def descend(selectors, node, found)
+      return if node.nil? || (!hash_y?(node) && !array_y?(node))
+      descend_array(selectors, node, found) if array_y?(node)
+      descend_hash(selectors, node, found)  if hash_y?(node)
+      return found
+    end
+  
+    def descend_array(selectors, node, found)
+      node.each do |a|
+        descend(selectors, a, found)
+      end
+    end
+  
+    def descend_hash(selectors, node, found)
+      selectors = selectors.dup
+
+      if selectors.first.match?(node)
+        selector = selectors.shift
+        if selectors.size == 0
+          found << selector.match!(node)
+        else
+          descend(selectors, selector.match!(node), found)
+        end
+      else
+        node.select { |k, node| hash_y?(node) || array_y?(node) }.each do |k, node| 
+          descend(selectors, node, found)
+        end
+      end
+    end
+  end
+
+  class Selector
+
+    def self.parse(selectors)
+      selectors.split(/ /).map { |matcher| new(matcher) }
+    end
+
+    def initialize(matcher)
+      @key, @type = matcher.split(':')
+      @type = Object.module_eval("::#{@type.capitalize}", __FILE__, __LINE__) if @type
+    end
+
+    def match?(node)
+      node.has_key?(@key) && (!@type || node[@key].is_a?(@type))
+    end
+
+    def match!(node)
+      node[@key]
+    end
+  end
+
+end
+
+class Hash
+  include HashQuery::Extension
+end

data/lib/hash_query/version.rb

@@ -0,0 +1,3 @@
+module HashQuery
+  VERSION = '1.0.1'
+end

data/test/helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+require 'hash_query'
+
+

data/test/test_hash_query.rb

@@ -0,0 +1,126 @@
+require 'helper'
+
+class TestHquery < MiniTest::Unit::TestCase
+
+   def setup
+    @movie = {
+      'title'  => 'Goodfellas',
+      'rating' => 'R',
+      'encodings' => ['a', 'b', 'c'],
+      'media'  => [
+        {
+          'type' => 'hd',
+          'encoding' => 'h264'
+        },
+        {
+          'type' => 'sd',
+          'encoding' => 'mpeg2'
+        }
+      ],
+      'actors' => [
+        {
+          'name' => 'Robert De Niro',
+          'role' => 'James Conway',
+          'awards' => {
+            'academy' => 2,
+            'emmies'  => 5
+          }
+        },
+        {
+          'name' => 'Ray Liotta',
+          'role' => 'Henry Hill'
+        }
+      ],
+      'director' => {
+        'name' => 'Martin Scorsese',
+        'award_count' => 23
+      }
+    }
+
+    @hquery = { 
+          'a' => 1, 
+          'b' => { 
+            'c' => {
+              'd' => { 
+                'e' => 2, 
+                'f' => 3 
+              }
+            },
+            'cc' => [
+              3,
+              {
+                'g' => 6,
+                'h' => 7,
+                'i' => [ 8, 9, 10, 11 ]
+              },
+              4,
+              5
+            ]
+          }
+        }
+  end
+
+  def test_included_in_hash
+    h = {}
+    assert h.respond_to?(:query)
+    assert h.respond_to?(:query)
+  end
+
+  def test_finds_nothing
+    assert_nil @hquery.query('z')
+  end
+
+  def test_finding_deep_array_value
+    assert_equal [8,9,10,11], @hquery.query('i')
+  end
+
+  def test_can_be_querried_shallow
+    assert_equal 'Goodfellas', @movie.query('title')
+    assert_equal 'R',          @movie.query('rating')
+  end
+
+  def test_can_be_querried_one_level_deep
+    assert_equal 'Martin Scorsese', @movie.query('director name')
+  end
+
+  def test_can_be_querried_shallow_for_a_deep_value
+    assert_equal 23, @movie.query('award_count')
+  end
+
+  def test_can_be_querried_two_levels_deep
+    assert_equal 2, @movie.query('actors awards academy')
+    assert_equal 5, @movie.query('actors awards emmies')
+  end
+
+  def test_can_be_querried_to_find_an_array
+    assert_equal ['a', 'b', 'c'], @movie.query('encodings')
+  end
+   
+  def test_can_be_querried_for_multiple_values
+    assert_equal ['Robert De Niro', 'Ray Liotta'], @movie.query('actors name')
+  end
+
+  def test_can_query_for_type
+    assert_equal 'Goodfellas', @movie.query('title:string')
+  end
+
+  def test_can_deep_query_for_type
+    assert_equal 2, @movie.query('academy:fixnum')
+    assert_equal 2, @movie.query('actors awards academy:fixnum')
+  end
+
+  def test_will_return_nil_if_type_is_not_matched
+    assert_equal nil, @movie.query('title:fixnum')
+  end
+
+  def test_can_query_for_complex_type
+    assert_equal ['a', 'b', 'c'], @movie.query('encodings:array')
+  end
+
+  def test_raises_exception_if_type_not_found
+    assert_raises NameError do
+      @movie.query('title:bogus')
+    end
+  end
+
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: hash-query
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mike Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-30 00:00:00.000000000 Z
+dependencies: []
+description: Provides a css-like selector system for querying values out of deeply
+  nested hashes
+email:
+- mike@urlgonomics.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- hash_query.gemspec
+- lib/hash_query.rb
+- lib/hash_query/version.rb
+- test/helper.rb
+- test/test_hash_query.rb
+homepage: https://github.com/mje113/hash-query
+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: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: See above
+test_files:
+- test/helper.rb
+- test/test_hash_query.rb