Project

queryable_hash

0.0
No commit activity in last 3 years
No release in over 3 years
queryable_hashhopsoft/queryable_hashHomepageDocumentationSource CodeBug TrackerWiki
Find data in Hashes using dot notation queries
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
11,833
Stars
0
Forks
0
Watchers
3
 Releases
Current version
1.0.0
Total releases
5
First release
2015-02-23
Latest release
2016-06-16
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
0
Merged Pull Requests
1
Pull Request Acceptance Rate
100%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2015-03-22
Reverse Dependencies
0

 Dependencies

Development

bundler
>= 0
coveralls
>= 0
pry-test
>= 0
rake
>= 0
simplecov
>= 0
 Project Readme

Lines of Code Code Status Dependency Status Build Status Coverage Status

QueryableHash

Find data in Hashes using dot notation queries.

We use QueryableHash to parse Ruby Hashes built from JSON API data. It works especially well when the target data is erratic.

Examples

Data to query

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"
        }
      }
    }
  }
}

Find first match

queryable = QueryableHash.wrap(data)
queryable.get("glossary.gloss_div.gloss_list.gloss_entry.id") #=> "SGML"

Find first match using multiple queries

queryable = QueryableHash.wrap(data)
queryable.get("this.key.does.not.exist", "glossary.gloss_div.gloss_list.gloss_entry.id") #=> "SGML"

Find all matches

queryable = QueryableHash.wrap(data)
queryable.get_all(
  "glossary.title",
  "glossary.gloss_div.gloss_list.gloss_entry.gloss_term",
  "glossary.gloss_div.gloss_list.gloss_entry.gloss_def.para"
)
#=> [ "example glossary",
#     "Standard Generalized Markup Language",
#     "A meta-markup language, used to create markup languages such as DocBook." ]

# or assign the results

title, term, para = queryable.get_all(
  "glossary.title",
  "glossary.gloss_div.gloss_list.gloss_entry.gloss_term",
  "glossary.gloss_div.gloss_list.gloss_entry.gloss_def.para"
)
title #=> "example glossary",
term  #=> "Standard Generalized Markup Language"
param #=> "A meta-markup language, used to create markup languages such as DocBook."

Find deeply nested missing key

queryable = QueryableHash.wrap(data)
queryable.get("this.key.does.not.exist") #=> nil

Assign a custom value to represent nil

queryable = QueryableHash.wrap(data)
queryable.get("this.key.does.not.exist", nil_value: "missing") #=> "missing"

Raise an error when not found

queryable = QueryableHash.wrap(data)
queryable.get("this.key.does.not.exist", raise_when_nil: true) #=> raises QueryableHash::NotFoundError

Set query options on the instance

queryable = QueryableHash.wrap(data, nil_value: "missing")
queryable.get("this.key.does.not.exist")      #=> "missing"
queryable.get("neither.does.this.one")        #=> "missing"
queryable.get("nor.this.one", nil_value: nil) #=> nil
queryable = QueryableHash.wrap(data, raise_when_nil: true)
queryable.get("this.key.does.not.exist")             #=> raises QueryableHash::NotFoundError
queryable.get("neither.does.this.one")               #=> raises QueryableHash::NotFoundError
queryable.get("nor.this.one", raise_when_nil: false) #=> nil

Also check out: https://github.com/joshbuddy/jsonpath