queryable_hash 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eae6be91fce7bc5ee219a1b1fc1af4ed19e21ae8
+  data.tar.gz: 53b42bdfd7e52c98a95925420e5e580bd57b6a3e
+SHA512:
+  metadata.gz: 4fa48f8de809bbdb9250bafdb1ec7af868ffba82985daf4983aaa575ee789b3bce9126f12e6cd10c3af08e7b28423c220eb648f173955e59138d5eaaab0f7564
+  data.tar.gz: 1456438f377219c2f59996ec8e1867dba6c060d085c9a07184c8fb633a6bf3c4045889e91a753d69bc520091ffd406ea46b5f3f10667a42f5d5ffd549c12afa4

data/lib/queryable_hash/version.rb

@@ -0,0 +1,3 @@
+module QueryableHash
+  VERSION = "0.0.1"
+end

data/lib/queryable_hash/wrapper.rb

@@ -0,0 +1,34 @@
+require "delegate"
+
+module QueryableHash
+  class Wrapper < SimpleDelegator
+
+    def initialize(hash)
+      @original_hash = hash
+      super hash
+    end
+
+    def find_all(*queries, nil_value: nil)
+      queries.reduce([]) do |memo, query|
+        context = self
+        query.split(".").each do |name|
+          break if context.nil?
+          context = context[name.to_sym] || context[name]
+        end
+        memo << (context || nil_value)
+      end
+    end
+
+    def find_first(*queries, nil_value: nil)
+      first = find_all(*queries, nil_value: nil_value).find do |result|
+        result != nil_value
+      end
+      first || nil_value
+    end
+
+    def to_hash
+      @original_hash
+    end
+
+  end
+end

data/lib/queryable_hash.rb

@@ -0,0 +1,8 @@
+require_relative "queryable_hash/version"
+require_relative "queryable_hash/wrapper"
+
+module QueryableHash
+  def self.wrap(hash)
+    Wrapper.new hash
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require "simplecov"
+
+if ENV["CI"]
+  require "coveralls"
+  SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+end
+
+SimpleCov.command_name "pry-test"
+SimpleCov.start do
+  add_filter "/test/"
+end
+
+Coveralls.wear! if ENV["CI"]
+
+require_relative "../lib/queryable_hash"

data/test/wrapper_test.rb

@@ -0,0 +1,77 @@
+require_relative "test_helper"
+
+module QueryableHash
+  class QueryableHashTest < PryTest::Test
+    before do
+      @data = {
+        glossary: {
+          title: "example glossary",
+          gloss_div: {
+            title: "S",
+            gloss_list: {
+              gloss_entry: {
+                id: "SGML",
+                sort_as: "SGML",
+                gloss_term: "Standard Generalized Markup Language",
+                acronym: "SGML",
+                abbrev: "ISO 8879:1986",
+                gloss_def: {
+                  para: "A meta-markup language, used to create markup languages such as DocBook.",
+                  gloss_see_also: ["GML", "XML"]
+                },
+                gloss_see: "markup"
+              }
+            }
+          }
+        }
+      }
+      @queryable = QueryableHash.wrap(@data)
+    end
+
+    test "find_all" do
+      query = "glossary.gloss_div.gloss_list.gloss_entry.id"
+      assert @queryable.find_all(query) == ["SGML"]
+    end
+
+    test "find_all with multiple queries" do
+      title, term, para = @queryable.find_all(
+        "glossary.title",
+        "glossary.gloss_div.gloss_list.gloss_entry.gloss_term",
+        "glossary.gloss_div.gloss_list.gloss_entry.gloss_def.para"
+      )
+      assert title == "example glossary"
+      assert term == "Standard Generalized Markup Language"
+      assert para == "A meta-markup language, used to create markup languages such as DocBook."
+    end
+
+    test "find_first" do
+      query = "glossary.gloss_div.gloss_list.gloss_entry.id"
+      assert @queryable.find_first(query) == "SGML"
+    end
+
+    test "find_first with missing key" do
+      query = "this.key.does.not.exist"
+      assert @queryable.find_first(query).nil?
+    end
+
+    test "find_first with missing key and nil value" do
+      query = "nate.this.key.does.not.exist"
+      assert @queryable.find_first(query, nil_value: "missing") == "missing"
+    end
+
+    test "find_first with multiple queries" do
+      term = @queryable.find_first(
+        "glossary.div.list.entry.term",
+        "glossary.gloss_div.list.entry.term",
+        "glossary.gloss_div.gloss_list.entry.term",
+        "glossary.gloss_div.gloss_list.gloss_entry.term",
+        "glossary.gloss_div.gloss_list.gloss_entry.gloss_term"
+      )
+      assert term == "Standard Generalized Markup Language"
+    end
+
+    test "to_hash" do
+      assert @queryable.to_hash == @data
+    end
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: queryable_hash
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nathan Hopkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Safely & easily find data in Hashes using dot notation queries.
+email:
+- natehop@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/queryable_hash.rb
+- lib/queryable_hash/version.rb
+- lib/queryable_hash/wrapper.rb
+- test/test_helper.rb
+- test/wrapper_test.rb
+homepage: https://github.com/hopsoft/queryable_hash
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Safely & easily find data in Hashes using dot notation queries.
+test_files:
+- test/test_helper.rb
+- test/wrapper_test.rb
+has_rdoc: