NAME

Data::Transfigure::Node - the root role which all Data::Transfigure transfigurators must implement

DESCRIPTION

Data::Transfigure::Node must be implemented by all transfigurators used by Data::Transfigure

FIELDS

handler (required param)

The handler param accepts a CODEREF/anonymous subroutine which itself receives a single parameter, the data element to transfigure, and is expected to return the transfigured value.

METHODS

applies_to( %params )

applies_to is required to be supplied by classes implementing this role.

This method recieves a param hash with keys value and position and returns a constant from Data::Transfigure::Constants reflecting what degree of match, if any, the transfigurator has to that node. Higher values are better matches.

transfigure( @args )

Executes the handler on the data element. Typically this shouldn't be called manually or need to be overridden by subclasses.

AUTHOR

Mark Tyrrell <mark@tyrrminal.dev>

LICENSE

Copyright (c) 2023 Mark Tyrrell

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.