DEV Community

Omar Bahareth
Omar Bahareth

Posted on

Are there functions similar to Ruby's `dig` in other languages?

I really like using Ruby's Array#dig and Hash#dig operator (introduced in Ruby 2.3) to quickly and safely access deeply nested structures

I would love to see different versions of it in other languages so I can use them more too!

Here's how dig works:

Assuming we have an orders array that looks like this.

orders = [
  {
    id: 1,
    customer: {
      name: "Customer 1",
      phone: "1234"
    }
  },

  {
    id: 2
  },

# ...
]
Enter fullscreen mode Exit fullscreen mode

We can easily navigate through this structure with dig like so

orders.dig(0, :customer, :phone) #=> "1234"
Enter fullscreen mode Exit fullscreen mode

We can also not worry about any of the "in-between" objects not existing, as it will return nil as soon it finds something that doesn't exist.

orders.dig(1, :customer, :phone) #=> nil
Enter fullscreen mode Exit fullscreen mode

It returns nil the moment it finds that customer doesn't exist, and it makes me avoid checking if keys exist every time I want to access a nested object.

What are some cool ways to access nested data like this in other languages? I ask because I want to learn and because I probably do it in overly-convoluted ways at the moment.

Thanks for reading!

Discussion (15)

Collapse
daksamit profile image
Dominik Aksamit • Edited

It's known as optional chaining / null propagation.
In Javascript it's described as ECMAScript proposal

instead of writing:

const phone = orders && orders[0] && orders[0].customer && orders[0].customer.phone
Enter fullscreen mode Exit fullscreen mode

it could be like:

const phone = orders?[0]?.customer?.phone
Enter fullscreen mode Exit fullscreen mode

For now, there are libraries like lodash/get, where we can use function:

import { get } from 'lodash'
const phone = get(orders[0], 'customer.phone', 'optional default value')
Enter fullscreen mode Exit fullscreen mode
Collapse
patrickcarlohickman profile image
Patrick Carlo-Hickman

PHP7 introduced the null coalesce operator (??) which will suppress errors for the missing intermediate keys. So, this will work without errors/warnings:

$phone = $orders[0]['customer']['phone'] ?? null;

The Laravel framework in PHP also has array helpers which allow you to access values using "dot" notation:

$phone = array_get($orders, '0.customer.phone');

You can pass a third value to use as the default if it doesn't exist, but the default is null without it.

This helper function is a shortcut to access the Arr::get() method mentioned by Suhayb Alghutaymil.

Collapse
brightone profile image
Oleksii Filonenko • Edited

I'm currently doing Rust, and I have a little trouble answering this question.

A couple points:

  • Rust does not have anything like dig built-in.
  • It wouldn't make sense, as there is no nil/null/whatever in Rust - if it's a String, it's there, no strings attached (pun intended).
  • To represent a value that might not be there, there is a concept of an Option enum, which can be either Some(value) or None (the concept is not new - Haskell has Maybe, and languages like Swift or Kotlin have nullable types)
  • A macro can probably do something like that for nested Options.

I came up with this:

macro_rules! dig {
   ( $root:ident, $($step:ident),+ $(,)? ) => {
      {
         let leaf = $root;
         $(
            let leaf = leaf.and_then(|inner| inner.$step);
         )+
         leaf
      }
   }
}

Looks a bit funky, but does the job:

let c = Some(C {                                   
    b: Some(B {                                    
        a: Some(A { data: 5 }),                    
    }),                                            
});                                                
assert_eq!(Some(5), dig!(c, b, a).map(|a| a.data));

let c = Some(C { b: None });                    
assert_eq!(None, dig!(c, b, a).map(|a| a.data));

EDIT: I completely forgot about a cool language feature in Rust - ? operator.

Synopsis:

Result<T, E> is very similar to Option<T>, but it instead can be either Ok(T) (all good, T is the value) or Err(E) (something went wrong, E is the error type - String for a message, etc.)

result? basically means .if it's Ok, get the inner value and continue execution. If it's an Err, return it".

It allows for code like this:

fn etl(data: ...) -> Result<..., Error> {
    data.extract()?.transform()?.load()
}
Collapse
lazerfx profile image
Peter Street • Edited

C# 6.0 and onwards gives you the Null Propagating Operator MSDN Guide β€” like many of the other languages here, you would use it something like:

var customerName = orders[0]?.customer?.name;

This can be combined with the null coalescing operator, to give a default value:

var customerName = orders[0]?.customer?.name ?? "No value found.";
Collapse
ajkerrigan profile image
AJ Kerrigan • Edited

For Python, glom is a great package for this sort of nested data access. The happy path from the intro docs looks like this:

from glom import glom

target = {'a': {'b': {'c': 'd'}}}
glom(target, 'a.b.c')  # returns 'd'

That 'a.b.c' bit is a simple glom specifier, but it can get much wilder! Glom provides more advanced specifiers for features like:

  • Null coalescing behavior
  • Validation
  • Debugging/inspection

And you can always plug in your own code or extend glom even further. Simple to get started, but a long fun road to travel from there!

Collapse
star_yznaga profile image
Star Yznaga

I'm not sure that ECMAScript 10/ES10/Javascript 2019 has a function like that, per se, but one new feature that will likely be in ES11 that would help you get the safe-access bit of these dig functions in JS would be using the new proposed nullish-coalescing syntax.

The current version of Swift does already have null-coalescing, though.

Collapse
suhayb profile image
Suhayb Alghutaymil

In Laravel you could use this with Arr::get helper method.

use Illuminate\Support\Arr;

$array = ['products' => ['desk' => ['price' => 100]]];

$price = Arr::get($array, 'products.desk.price');

// 100
Collapse
tiguchi profile image
Thomas Iguchi

In Java (version 8 and onward) this can be done using Optional

String phoneNumber = Optional.ofNullable(list.get(0))
                             .map(Order::getCustomer)
                             .map(Customer::getPhone)
                             .orElse(null);
Collapse
baweaver profile image
Brandon Weaver

Haskell and other functional languages have Lenses, which are roughly equivalent to focusing on a value or path and either getting or setting it. Imagine dig with a related bury function and you get close.

I'd mentioned it in this particular Storybook post in Part Four, though it may make more sense to start at Part One for continuity

Collapse
oshanwisumperuma profile image
Oshan Wisumperuma

In Elixir use Kernel.get_in/2 for maps

iex(1)> m = %{foo: %{bar: %{baz: 1}}}
%{foo: %{bar: %{baz: 1}}}
iex(2)> get_in m, [:foo, :bar, :baz]
1
iex(3)> get_in m, [:foo, :zot]
nil
Collapse
jmfayard profile image
Jean-Michel Fayard πŸ‡«πŸ‡·πŸ‡©πŸ‡ͺπŸ‡¬πŸ‡§πŸ‡ͺπŸ‡ΈπŸ‡¨πŸ‡΄ • Edited

Kotlin

orders.firstOrNull()?.customer?.phone
Collapse
jmfayard profile image
Jean-Michel Fayard πŸ‡«πŸ‡·πŸ‡©πŸ‡ͺπŸ‡¬πŸ‡§πŸ‡ͺπŸ‡ΈπŸ‡¨πŸ‡΄

See this runnable snippet pl.kotl.in/1aOqY8rQu

Collapse
t3h2mas profile image
Thomas Noe

I'm a heavy user of Ramda's #path method in JavaScript / Node

Collapse
obahareth profile image
Omar Bahareth Author

Thank you for sharing everyone! I learned a lot!

Collapse
devchris profile image
Christoph Drechsler

Now available for Javascript:

npmjs.com/package/jsdig