Add gray matter

data/unroll-example.json

@@ -0,0 +1,38 @@
+{
+  "results": [
+    {
+      "id": 306,
+      "name": "First Company",
+      "branches": [
+        {
+          "id": 4191,
+          "city": "Seattle",
+          "customers": [
+            {
+              "id": 446,
+              "name": "Big Tech 1"
+            },
+            {
+              "id": 447,
+              "name": "Big Tech 2"
+            }
+          ]
+        },
+        {
+          "id": 4192,
+          "city": "Oakland",
+          "customers": [
+            {
+              "id": 448,
+              "name": "Health Tech 1"
+            },
+            {
+              "id": 449,
+              "name": "Health Tech 2"
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

functions/barcharts.md

@@ -1,4 +1,6 @@
-# barcharts
+---
+title: barcharts
+---
 
 ```jq
 def barchart($key):

functions/conversion.md

@@ -1,4 +1,6 @@
-# conversion
+---
+title: conversion
+---
 
 Pretty print numbers
 

functions/describe.md

@@ -1,4 +1,7 @@
-# describe
+---
+title: describe
+data: data/sample-github-events.json
+---
 
 Get object outline
 

functions/flatten.md

@@ -1,4 +1,8 @@
-# Flatten
+---
+title: Flatten
+data: data/sample-github-events.json
+---
+
 
 ## Flat JSON
 

functions/github-api.md

@@ -1,4 +1,6 @@
-# github api
+---
+title: github api
+---
 
 ```jq
 def github_raw_url:

functions/json2csv.md

@@ -1,4 +1,6 @@
-# json2csv
+---
+title: json2csv
+---
 
 ```jq
 # ~/.jq/convert.jq

functions/pick.md

@@ -1,4 +1,6 @@
-# pick
+---
+title: pick
+---
 
 [[Source]](https://github.com/jqlang/jq/issues/2578#issuecomment-1532632453)
 

functions/read-history.md

@@ -1,4 +1,6 @@
-# Read history
+---
+title: Read history
+---
 
 Compile timestamps in `.bash_history` for all users
 

functions/summary.md

@@ -1,4 +1,6 @@
-# summary
+---
+title: summary
+---
 
 ```jq
 def grouped_summary($item):

functions/unroll.md

@@ -0,0 +1,94 @@
+---
+title: Unroll
+source: 
+  - https://stackoverflow.com/a/33290267
+---
+
+
+```jq
+[leaf_paths as $path | {
+    "key": $path | map(tostring) | join("_"),
+    "value": getpath($path)
+}] | from_entries
+```
+
+```console
+$ cat data/nested.json|jq '[leaf_paths as $path | {  
+    "key": $path | map(tostring) | join("_"),
+    "value": getpath($path)
+}] | from_entries
+'
+{
+  "server_atx_user": "annie",
+  "server_atx_port": 22,
+  "storage_nyc_user": "nntrn",
+  "storage_nyc_port": 22
+}
+```
+
+
+
+```jq
+def categorize:
+    # Returns "object", "array" or "scalar" to indicate the category
+    # of the piped element.
+    if type == "object" then "object" 
+    elif type == "array" then "array" 
+    else "scalar" 
+    end;
+
+def pluck($category):
+    # Plucks the children of a particular category from piped element.    
+    if categorize != "object"
+    then empty
+    else to_entries[] 
+         | select(.value | categorize == $category) 
+         | .value
+    end;
+    
+def split:
+    # Splits the piped element's children into arrays, scalars, and objects 
+    # and returns a meta object containing the children seperated by these
+    # keys. If the piped element is a scalar or array, this does not look 
+    # at the children, but just returns that element in the meta object.
+    if categorize == "scalar" then { objects: [], arrays: [], scalars: [.] }
+    elif categorize == "array" then { objects: [], arrays: [.], scalars: [] } 
+    else { objects: [pluck("object")], arrays : [pluck("array")], scalars: [pluck("scalar")] }
+    end;
+
+def unwrap:
+  # Unwraps an array recursively, until the elements of the returned array 
+  # are either scalars or objects but not arrays. If piped element is not
+  # an array, returns the element as is.
+
+  if type != "array" then .
+  elif length == 0  then empty
+  else .[] | unwrap
+  end;
+
+def extract($category):
+  # Extracts the elements of a particular category from the piped in array. 
+  # If the piped in element is not an array, this fn acts as filter to 
+  # only return the element if it is of the desired category.
+  unwrap | select(.| categorize == $category);
+
+def unroll: 
+  # Unrolls the passed in object recursively until only scalars are left.
+  # Returns a row for each leaf node of tree structure of the object and
+  # elements of the row would be all the scalars encountered at all the
+  # ancestor levels of this left node.
+
+  . | .result += .state.scalars
+    | .state.objects += [.state.arrays | extract("object")]
+    | .state.objects += [.state.arrays | extract("scalar")]
+    | if (.state.objects | length == 0 )
+      then .result
+      else ({ data : .state.objects,
+              state: .state.objects[] | split,
+              result: .result
+            } | unroll)
+      end;
+
+def unrolls($data): { data: $data, state: $data| split, result: [] } | unroll ;
+def unrolls: unrolls(.);
+```

general/codepoints.md

@@ -1,4 +1,6 @@
-# Codepoints
+---
+title: Codepoints
+---
 
 Work with explode/implode
 

general/data-cleaning.md

@@ -1,4 +1,6 @@
-# Data cleaning
+---
+title: Data cleaning
+---
 
 ## Delete keys
 

data-transform.md → general/data-transform.md

@@ -1,10 +1,13 @@
-# Data transformation
+---
+title: Data transformation
+data: data/nested.json
+---
 
 ## json2ini
 
 Adapted from <a>https://stackoverflow.com/a/76665197</a>
 
-Data used: [nested.json](data/nested.json)
+Data used: [nested.json](../data/nested.json)
 
 ```
 {

general/examples.md

@@ -1,4 +1,6 @@
-# Examples
+---
+title: Examples
+---
 
 ## Reduce
 

general/inputs.md

@@ -1,4 +1,7 @@
-# Working with `inputs`
+---
+title: Inputs
+data: data/tmp.tsv
+---
 
 **DATA**: [tmp.tsv](../data/tmp.tsv)
 

general/kv.md

@@ -1,4 +1,6 @@
-# kv
+---
+title: kv
+---
 
 ```jq
 split("\n")

general/oneliners.md

@@ -1,4 +1,6 @@
-# Oneliners
+---
+title: Oneliners
+---
 
 ## Recursively convert appropriate data types from string
 

general/reduce.md

@@ -1,4 +1,6 @@
-# Reduce
+---
+title: Reduce
+---
 
 ```jq
 def tocsv:

general/scalars.md

@@ -1,4 +1,6 @@
-# Scalars
+---
+title: Scalars
+---
 
 Scalars are variables that hold an *individual* value (strings, integers, and booleans). If it's not an object or array — it's most likely a scalar
 

general/streams.md

@@ -1,4 +1,6 @@
-# Working with streams
+---
+title: Working with streams
+---
 
 Data used: [nested.json](../data/outer.json)
 

general/wrangle.md

@@ -1,4 +1,6 @@
-# Wrangle
+---
+title: Wrangle
+---
 
 ## Zip Column Headers
 

readme.md

@@ -6,4 +6,14 @@ git clone -b staging https://github.com/nntrn/jq-recipes.git
 git clone https://github.com/nntrn/jq-recipes.wiki.git
 ```
 
+## Setup
+
+```sh
+curl --create-dirs -o ~/.jq/recipes.jq https://nntrn.github.io/jq-recipes/recipes.jq
+
+git clone -b staging https://github.com/nntrn/jq-recipes.git
+
+
+```
+
 [Github Page](http://nntrn.github.io/jq-recipes) | [Wiki](https://github.com/nntrn/jq-recipes/wiki)

unroll.jq

@@ -0,0 +1,62 @@
+def categorize:
+    # Returns "object", "array" or "scalar" to indicate the category
+    # of the piped element.
+    if type == "object" then "object" 
+    elif type == "array" then "array" 
+    else "scalar" 
+    end;
+
+def pluck($category):
+    # Plucks the children of a particular category from piped element.    
+    if categorize != "object"
+    then empty
+    else to_entries[] 
+         | select(.value | categorize == $category) 
+         | .value
+    end;
+
+def split:
+    # Splits the piped element's children into arrays, scalars, and objects 
+    # and returns a meta object containing the children seperated by these
+    # keys. If the piped element is a scalar or array, this does not look 
+    # at the children, but just returns that element in the meta object.
+    if categorize == "scalar" then { objects: [], arrays: [], scalars: [.] }
+    elif categorize == "array" then { objects: [], arrays: [.], scalars: [] } 
+    else { objects: [pluck("object")], arrays : [pluck("array")], scalars: [pluck("scalar")] }
+    end;
+
+def unwrap:
+  # Unwraps an array recursively, until the elements of the returned array 
+  # are either scalars or objects but not arrays. If piped element is not
+  # an array, returns the element as is.
+
+  if type != "array" then .
+  elif length == 0  then empty
+  else .[] | unwrap
+  end;
+
+def extract($category):
+  # Extracts the elements of a particular category from the piped in array. 
+  # If the piped in element is not an array, this fn acts as filter to 
+  # only return the element if it is of the desired category.
+  unwrap | select(.| categorize == $category);
+
+def unroll: 
+  # Unrolls the passed in object recursively until only scalars are left.
+  # Returns a row for each leaf node of tree structure of the object and
+  # elements of the row would be all the scalars encountered at all the
+  # ancestor levels of this left node.
+
+  . | .result += .state.scalars
+    | .state.objects += [.state.arrays | extract("object")]
+    | .state.objects += [.state.arrays | extract("scalar")]
+    | if (.state.objects | length == 0 )
+      then .result
+      else ({ data : .state.objects,
+              state: .state.objects[] | split,
+              result: .result
+            } | unroll)
+      end;
+
+def unrolls($data): { data: $data, state: $data| split, result: [] } | unroll ;
+def unrolls: unrolls(.);