Hello brothers and sisters of the monastary,

I need a function which will filter a nested hash, removing any fields I'm not interested in.

For example, lets say my application uses the following data structure. The hash values in any given instance of this structure are variable, but the hash keys will always be the same.

my $source = {
    f1 => 'garbage',
    f2 => 'more garbage',
    f3 => 'important data',
    f4 => {
        this => 'sub hash',
        is   => 'garbage'
    },
    f5 => {
        f6 => 'more important data',
        f7 => {
            more => 'garbage',
            f8   => 'important data',
        },
        f9 => 'garbage',
    },
    f10 => [ 'important', 'data' ],
    f11 => [ 'more', 'garbage' ]
};

[download]

I only am interested in the important data, and I want to remove all the garbage.

I came up with a data structure I could use to express the parts of the structure I'm interested in.

my $filter = {
    f3 => 1,
    f5 => {
        f6 => 1,
        f7 => {
            f8 => 1
        }
    },
    f10 => 1
};

[download]

Given this filter, I want the output of the function to be the following hash:

my $output = {
    f3 => 'important data',
    f5 => {
        f6 => 'more important data',
        f7 => {
            f8   => 'important data',
        }
    },
    f10 => [ 'important', 'data' ],
};

[download]

A key feature of this function is that it must accept any variable type of filter; data which is garbage in one case is important in another case.

I came up with the following function which seems to work well:

sub hash_filter {
  my $source = shift;
  my $filter = shift;

  my %output;

  foreach ( keys %$filter ) {
    if ( exists $source->{$_} ) {

      if ( ref $filter->{$_} eq 'HASH' ) {
        croak "bad filter: on '$_', expected HASH\n"
          unless ( ref $source->{$_} eq 'HASH' );

        $output{$_} = hash_filter( $source->{$_}, $filter->{$_} );
      }
      else {
        $output{$_} = $source->{$_};
      }

    }
  }

  return \%output;
}

[download]

I'm very happy with how it works, but since I mean for this function to be reusable I wanted to hear how you all would do it.

Is there a simpler way to do this with higher order functions like map and grep?

Thank you for your help,

Jim

πάντων χρημάτων μέτρον έστιν άνθρωπος.

In reply to A more elegant way to filter a nested hash? by jimpudar

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.