.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Data::MethodProxy 3pm" .TH Data::MethodProxy 3pm "2019-09-06" "perl v5.28.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Data::MethodProxy \- Inject dynamic data into static data. .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Data::MethodProxy; \& \& my $mproxy = Data::MethodProxy\->new(); \& \& my $output = $mproxy\->render({ \& half_six => [\*(Aq$proxy\*(Aq, \*(Aqmain\*(Aq, \*(Aqhalf\*(Aq, 6], \& }); \& # { half_six => 3 } \& \& sub half { \& my ($class, $number) = @_; \& return $number / 2; \& } .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" A method proxy is an array ref describing a class method to call and the arguments to pass to it. The first value of the array ref is the scalar \&\f(CW$proxy\fR, followed by a package name, then a subroutine name which must callable in the package, and a list of any subroutine arguments. .PP .Vb 1 \& [ \*(Aq$proxy\*(Aq, \*(AqFoo::Bar\*(Aq, \*(Aqbaz\*(Aq, 123, 4 ] .Ve .PP The above is saying, do this: .PP .Vb 1 \& Foo::Bar\->baz( 123, 4 ); .Ve .PP The \*(L"render\*(R" method is the main entry point for replacing all found method proxies in an arbitrary data structure with the return value of calling the methods. .SS "Example" .IX Subsection "Example" Consider this static \s-1YAML\s0 configuration: .PP .Vb 5 \& \-\-\- \& db: \& dsn: DBI:mysql:database=foo \& username: bar \& password: abc123 .Ve .PP Putting your database password inside of a configuration file is usually considered a bad practice. You can use a method proxy to get around this without jumping through a bunch of hoops: .PP .Vb 9 \& \-\-\- \& db: \& dsn: DBI:mysql:database=foo \& username: bar \& password: \& \- $proxy \& \- MyApp::Config \& \- get_db_password \& \- foo\-bar .Ve .PP When \*(L"render\*(R" is called on the above data structure it will see the method proxy and will replace the array ref with the return value of calling the method. .PP A method proxy, in Perl syntax, looks like this: .PP .Vb 1 \& [\*(Aq$proxy\*(Aq, $package, $method, @args] .Ve .PP The \f(CW$proxy\fR string can also be written as \f(CW&proxy\fR. The above is then converted to a method call and replaced by the return value of the method call: .PP .Vb 1 \& $package\->$method( @args ); .Ve .PP In the above database password example the method call would be this: .PP .Vb 1 \& MyApp::Config\->get_db_password( \*(Aqfoo\-bar\*(Aq ); .Ve .PP You'd still need to create a \f(CW\*(C`MyApp::Config\*(C'\fR package, and add a \&\f(CW\*(C`get_db_password\*(C'\fR method to it. .SH "METHODS" .IX Header "METHODS" .SS "render" .IX Subsection "render" .Vb 1 \& my $output = $mproxy\->render( $input ); .Ve .PP Traverses the supplied data looking for method proxies, calling them, and replacing them with the return value of the method call. Any value may be passed, such as a hash ref, an array ref, a method proxy, an object, a scalar, etc. Array and hash refs will be recursively searched for method proxies. .PP If a circular reference is detected an error will be thrown. .SS "call" .IX Subsection "call" .Vb 1 \& my $return = $mproxy\->call( [\*(Aq$proxy\*(Aq, $package, $method, @args] ); .Ve .PP Calls the method proxy and returns its return. .SS "is_valid" .IX Subsection "is_valid" .Vb 1 \& die unless $mproxy\->is_valid( ... ); .Ve .PP Returns true if the passed value looks like a method proxy. .SS "is_callable" .IX Subsection "is_callable" .Vb 1 \& die unless $mproxy\->is_callable( ... ); .Ve .PP Returns true if the passed value looks like a method proxy, and has a package and method which exist. .SH "SUPPORT" .IX Header "SUPPORT" Please submit bugs and feature requests to the Data-MethodProxy GitHub issue tracker: .PP .SH "AUTHORS" .IX Header "AUTHORS" .Vb 1 \& Aran Clary Deltac .Ve .SH "ACKNOWLEDGEMENTS" .IX Header "ACKNOWLEDGEMENTS" Thanks to ZipRecruiter for encouraging their employees to contribute back to the open source ecosystem. Without their dedication to quality software development this distribution would not exist. .SH "LICENSE" .IX Header "LICENSE" This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.