NAME DOM::Tiny - Minimalistic HTML/XML DOM parser with CSS selectors SYNOPSIS use DOM::Tiny; # Parse my $dom = DOM::Tiny->new('
Test
123
456
'); $dom->find(':not(p)')->map('strip'); # Render say "$dom"; DESCRIPTION DOM::Tiny is a minimalistic and relaxed pure-perl HTML/XML DOM parser based on Mojo::DOM. It supports the HTML Living StandardHi!
'); say $dom->at('p[id]')->text; If an XML declaration is found, the parser will automatically switch into XML mode and everything becomes case-sensitive. # XML semantics my $dom = DOM::Tiny->new('Hi!
'); say $dom->at('P[ID]')->text; XML detection can also be disabled with the "xml" method. # Force XML semantics my $dom = DOM::Tiny->new->xml(1)->parse('Hi!
'); say $dom->at('P[ID]')->text; # Force HTML semantics my $dom = DOM::Tiny->new->xml(0)->parse('Hi!
'); say $dom->at('p[id]')->text; SELECTORS DOM::Tiny uses a CSS selector engine based on Mojo::DOM::CSS. All CSS selectors that make sense for a standalone parser are supported. * Any element. my $all = $dom->find('*'); E An element of type E. my $title = $dom->at('title'); E[foo] An E element with a foo attribute. my $links = $dom->find('a[href]'); E[foo="bar"] An E element whose foo attribute value is exactly equal to bar. my $case_sensitive = $dom->find('input[type="hidden"]'); my $case_sensitive = $dom->find('input[type=hidden]'); E[foo="bar" i] An E element whose foo attribute value is exactly equal to any (ASCII-range) case-permutation of bar. Note that this selector is EXPERIMENTAL and might change without warning! my $case_insensitive = $dom->find('input[type="hidden" i]'); my $case_insensitive = $dom->find('input[type=hidden i]'); my $case_insensitive = $dom->find('input[class~="foo" i]'); This selector is part of Selectors Level 4bar
baz\nbar
baz\nI ♥ DOM::Tiny!
'); Append HTML/XML fragment to this node (for all node types other than root). # "Test 123
" $dom->parse('Test
')->at('p') ->child_nodes->first->append(' 123')->root; append_content $dom = $dom->append_content('I ♥ DOM::Tiny!
'); Append HTML/XML fragment (for root and tag nodes) or raw content to this node's content. # "Test123
" $dom->parse('Test
')->at('p')->append_content('123')->root; at my $result = $dom->at('div ~ p'); Find first descendant element of this element matching the CSS selector and return it as a DOM::Tiny object, or undef if none could be found. All selectors listed in "SELECTORS" are supported. # Find first element with "svg" namespace definition my $namespace = $dom->at('[xmlns\:svg]')->{'xmlns:svg'}; attr my $hash = $dom->attr; my $foo = $dom->attr('foo'); $dom = $dom->attr({foo => 'bar'}); $dom = $dom->attr(foo => 'bar'); This element's attributes. # Remove an attribute delete $dom->attr->{id}; # Attribute without value $dom->attr(selected => undef); # List id attributes say $dom->find('*')->map(attr => 'id')->compact->join("\n"); child_nodes my $collection = $dom->child_nodes; Return a collection containing all child nodes of this element as DOM::Tiny objects. # "123
" $dom->parse('Test123
')->at('p')->child_nodes->first->remove; # "" $dom->parse('123')->child_nodes->first; # " Test " $dom->parse('123')->child_nodes->last->content; children my $collection = $dom->children; my $collection = $dom->children('div ~ p'); Find all child elements of this element matching the CSS selector and return a collection containing these elements as DOM::Tiny objects. All selectors listed in "SELECTORS" are supported. # Show tag name of random child element say $dom->children->shuffle->first->tag; content my $str = $dom->content; $dom = $dom->content('I ♥ DOM::Tiny!
'); Return this node's content or replace it with HTML/XML fragment (for root and tag nodes) or raw content. # "Test" $dom->parse('123
" $dom->parse('Test
')->at('p')->content('123')->root; # "123
" $dom->parse('123
') ->descendant_nodes->grep(sub { $_->type eq 'comment' }) ->map('remove')->first; # "testtest
" $dom->parse('123456
') ->at('p')->descendant_nodes->grep(sub { $_->type eq 'text' }) ->map(content => 'test')->first->root; find my $collection = $dom->find('div ~ p'); Find all descendant elements of this element matching the CSS selector and return a collection containing these elements as DOM::Tiny objects. All selectors listed in "SELECTORS" are supported. # Find a specific element and extract information my $id = $dom->find('div')->[23]{id}; # Extract information from multiple elements my @headers = $dom->find('h1, h2, h3')->map('text')->each; # Count all the different tags my $hash = $dom->find('*')->reduce(sub { $a->{$b->tag}++; $a }, {}); # Find elements with a class that contains dots my @divs = $dom->find('div.foo\.bar')->each; following my $collection = $dom->following; my $collection = $dom->following('div ~ p'); Find all sibling elements after this node matching the CSS selector and return a collection containing these elements as DOM::Tiny objects. All selectors listen in "SELECTORS" are supported. # List tags of sibling elements after this node say $dom->following->map('tag')->join("\n"); following_nodes my $collection = $dom->following_nodes; Return a collection containing all sibling nodes after this node as DOM::Tiny objects. # "C" $dom->parse('A
C')->at('p')->following_nodes->last->content; matches my $bool = $dom->matches('div ~ p'); Check if this element matches the CSS selector. All selectors listed in "SELECTORS" are supported. # True $dom->parse('A
')->at('p')->matches('.a'); $dom->parse('A
')->at('p')->matches('p[class]'); # False $dom->parse('A
')->at('p')->matches('.b'); $dom->parse('A
')->at('p')->matches('p[id]'); namespace my $namespace = $dom->namespace; Find this element's namespace, or return undef if none could be found. # Find namespace for an element with namespace prefix my $namespace = $dom->at('svg > svg\:circle')->namespace; # Find namespace for an element that may or may not have a namespace prefix my $namespace = $dom->at('svg > circle')->namespace; next my $sibling = $dom->next; Return DOM::Tiny object for next sibling element, or undef if there are no more siblings. # "123456
') ->at('b')->next_node->next_node; # " Test " $dom->parse('123456
') ->at('b')->next_node->content; parent my $parent = $dom->parent; Return DOM::Tiny object for parent of this node, or undef if this node has no parent. # "Test" $dom->parse('Test
')->at('i')->parent; parse $dom = $dom->parse('C
')->at('p')->preceding_nodes->first->content; prepend $dom = $dom->prepend('I ♥ DOM::Tiny!
'); Prepend HTML/XML fragment to this node (for all node types other than root). # "Test 123
" $dom->parse('123
') ->at('p')->child_nodes->first->prepend('Test ')->root; prepend_content $dom = $dom->prepend_content('I ♥ DOM::Tiny!
'); Prepend HTML/XML fragment (for root and tag nodes) or raw content to this node's content. # "123Test
" $dom->parse('Test
')->at('p')->prepend_content('123')->root; previous my $sibling = $dom->previous; Return DOM::Tiny object for previous sibling element, or undef if there are no more siblings. # "123456
') ->at('b')->previous_node->previous_node; # " Test " $dom->parse('123456
') ->at('b')->previous_node->content; remove my $parent = $dom->remove; Remove this node and return "root" (for root nodes) or "parent". # "" $dom->parse('456
" $dom->parse('123456
') ->at('p')->child_nodes->first->remove->root; replace my $parent = $dom->replace('123
" $dom->parse('Test
') ->at('p')->child_nodes->[0]->replace('123')->root; root my $root = $dom->root; Return DOM::Tiny object for root node. strip my $parent = $dom->strip; Remove this element while preserving its content and return "parent". # "bar
baz\nbar
baz\nTest
')->type; # "tag" $dom->parse('Test
')->at('p')->type; # "text" $dom->parse('Test
')->at('p')->child_nodes->first->type; val my $value = $dom->val; Extract value from form element (such as button, input, option, select and textarea), or return undef if this element has no value. In the case of select with multiple attribute, find option elements with selected attribute and return an array reference with all values, or undef if none could be found. # "a" $dom->parse('')->at('input')->val; # "b" $dom->parse('')->at('textarea')->val; # "c" $dom->parse('')->at('option')->val; # "d" $dom->parse('') ->at('select')->val; # "e" $dom->parse('') ->at('select')->val->[0]; # "on" $dom->parse('')->at('input')->val; wrap $dom = $dom->wrap(''); Wrap HTML/XML fragment around this node (for all node types other than root), placing it as the last child of the first innermost element. # "123Test
" $dom->parse('Test')->at('b')->wrap('123
')->root; # "Test
123Test
123
" $dom->parse('Test')->at('b')->wrap('123
')->root; # "Test
" $dom->parse('Test
')->at('p')->child_nodes->first->wrap('')->root; wrap_content $dom = $dom->wrap_content(''); Wrap HTML/XML fragment around this node's content (for root and tag nodes), placing it as the last children of the first innermost element. # "123Test
" $dom->parse('Test
')->at('p')->wrap_content('123')->root; # "
Test
123
" $dom->parse('Test')->wrap_content('123
'); xml my $bool = $dom->xml; $dom = $dom->xml($bool); Disable HTML semantics in parser and activate case-sensitivity, defaults to auto detection based on XML declarations. COLLECTION METHODS Some DOM::Tiny methods return an array-based collection object based on Mojo::Collection, which can either be accessed directly as an array reference, or with the following methods. # Chain methods $collection->map(sub { ucfirst })->shuffle->each(sub { my ($word, $num) = @_; say "$num: $word"; }); # Access array directly to manipulate collection $collection->[23] += 100; say for @$collection; compact my $new = $collection->compact; Create a new collection with all elements that are defined and not an empty string. # $collection contains (0, 1, undef, 2, '', 3) $collection->compact->join(', '); # "0, 1, 2, 3" each my @elements = $collection->each; $collection = $collection->each(sub {...}); Evaluate callback for each element in collection or return all elements as a list if none has been provided. The element will be the first argument passed to the callback and is also available as $_. # Make a numbered list $collection->each(sub { my ($e, $num) = @_; say "$num: $e"; }); first my $first = $collection->first; my $first = $collection->first(qr/foo/); my $first = $collection->first(sub {...}); my $first = $collection->first($method); my $first = $collection->first($method, @args); Evaluate regular expression/callback for, or call method on, each element in collection and return the first one that matched the regular expression, or for which the callback/method returned true. The element will be the first argument passed to the callback and is also available as $_. # Longer version my $first = $collection->first(sub { $_->$method(@args) }); # Find first value that contains the word "tiny" my $interesting = $collection->first(qr/tiny/i); # Find first value that is greater than 5 my $greater = $collection->first(sub { $_ > 5 }); flatten my $new = $collection->flatten; Flatten nested collections/arrays recursively and create a new collection with all elements. # $collection contains (1, [2, [3, 4], 5, [6]], 7) $collection->flatten->join(', '); # "1, 2, 3, 4, 5, 6, 7" grep my $new = $collection->grep(qr/foo/); my $new = $collection->grep(sub {...}); my $new = $collection->grep($method); my $new = $collection->grep($method, @args); Evaluate regular expression/callback for, or call method on, each element in collection and create a new collection with all elements that matched the regular expression, or for which the callback/method returned true. The element will be the first argument passed to the callback and is also available as $_. # Longer version my $new = $collection->grep(sub { $_->$method(@args) }); # Find all values that contain the word "tiny" my $interesting = $collection->grep(qr/tiny/i); # Find all values that are greater than 5 my $greater = $collection->grep(sub { $_ > 5 }); join my $stream = $collection->join; my $stream = $collection->join("\n"); Turn collection into string. # Join all values with commas $collection->join(', '); last my $last = $collection->last; Return the last element in collection. map my $new = $collection->map(sub {...}); my $new = $collection->map($method); my $new = $collection->map($method, @args); Evaluate callback for, or call method on, each element in collection and create a new collection from the results. The element will be the first argument passed to the callback and is also available as $_. # Longer version my $new = $collection->map(sub { $_->$method(@args) }); # Append the word "tiny" to all values my $domified = $collection->map(sub { $_ . 'tiny' }); reduce my $result = $collection->reduce(sub {...}); my $result = $collection->reduce(sub {...}, $initial); Reduce elements in collection with callback, the first element will be used as initial value if none has been provided. # Calculate the sum of all values my $sum = $collection->reduce(sub { $a + $b }); # Count how often each value occurs in collection my $hash = $collection->reduce(sub { $a->{$b}++; $a }, {}); reverse my $new = $collection->reverse; Create a new collection with all elements in reverse order. slice my $new = $collection->slice(4 .. 7); Create a new collection with all selected elements. # $collection contains ('A', 'B', 'C', 'D', 'E') $collection->slice(1, 2, 4)->join(' '); # "B C E" shuffle my $new = $collection->shuffle; Create a new collection with all elements in random order. size my $size = $collection->size; Number of elements in collection. sort my $new = $collection->sort; my $new = $collection->sort(sub {...}); Sort elements based on return value of callback and create a new collection from the results. # Sort values case-insensitive my $case_insensitive = $collection->sort(sub { uc($a) cmp uc($b) }); tap $collection = $collection->tap(sub {...}); Equivalent to "tap" in Mojo::Base. to_array my $array = $collection->to_array; Turn collection into array reference. uniq my $new = $collection->uniq; my $new = $collection->uniq(sub {...}); my $new = $collection->uniq($method); my $new = $collection->uniq($method, @args); Create a new collection without duplicate elements, using the string representation of either the elements or the return value of the callback/method. # Longer version my $new = $collection->uniq(sub { $_->$method(@args) }); # $collection contains ('foo', 'bar', 'bar', 'baz') $collection->uniq->join(' '); # "foo bar baz" # $collection contains ([1, 2], [2, 1], [3, 2]) $collection->uniq(sub{ $_->[1] })->to_array; # "[[1, 2], [2, 1]]" BUGS Report any issues on the public bugtracker. AUTHOR Dan Book