para

head

Reusable conformance ("contract") tests for L<Qwiratry> format plugins.


A format plugin provides C<Qwiratry::Format::<NAME>::Parse> and/or
C<Qwiratry::Format::<NAME>::Render> classes that inherit the contracts in
L<Qwiratry::Format::Base>. This module asserts, from the outside, that such a
plugin satisfies the shared contract: it is discoverable through the factory,
its operation classes inherit the correct base, C<parse>/C<render> behave, the
format round-trips when it claims to be lossless, and it works through the
C<↱> / C<↴> pipeline operators.


code

=begin code
use Test;
use Qwiratry::Test::Format;

conforms-to-format-contract(
    format        => 'JSON',
    parse-samples => [ '{"a":1}', '[1,2,3]' ],
    render-values => [ { :a(1) }, [1, 2, 3] ],
    :lossless,
);

done-testing;
=end code


The one required argument is C<:format>. Everything else is capability-driven:
supply only the samples/flags that apply to the format under test.


C<RAKUDO_RAKUAST=1> (inherited from Qwiratry's slang).



unit module Qwiratry::Test::Format;

use Test;
use Qwiratry::Format;
use Qwiratry::Format::Base;
use Qwiratry::Query::Slang;
use X::Qwiratry;

#| Assert that the named format plugin satisfies the Qwiratry format contract.
#|
#| Capability flags/arguments (all optional except C<:format>):
#|   :parse / :render        which operations the format supports (default: both)
#|   :parse-samples          text inputs that must parse without error
#|   :render-values          data values that must render to a Str
#|   :lossless               parse∘render∘parse must equal parse (per sample)
#|   :invalid-samples        text inputs that must throw on parse
#|   :pipeline               also exercise the ↱ / ↴ operators (default: True)
sub conforms-to-format-contract(
    Str  :$format!,
    Bool :$parse = True,
    Bool :$render = True,
         :@parse-samples,
         :@render-values,
         :@invalid-samples,
    Bool :$lossless = False,
    Bool :$pipeline = True,
    Str  :$desc = "Qwiratry::Format '$format' contract",
    --> Bool
) is export {
    subtest $desc => {
        if $parse {
            subtest 'parse: discovery, factory, base contract' => {
                ok $format.lc (elem) Qwiratry::Format.formats(:type<Parse>)».lc,
                    "'$format' is discoverable as a Parse format";
                my $impl = Qwiratry::Format.make(:type<Parse>, :format($format));
                isa-ok $impl, Qwiratry::Format::Base::Parse,
                    "Parse impl inherits Qwiratry::Format::Base::Parse";
                can-ok $impl, 'parse', 'Parse impl provides a parse method';
            }
        }

        if $render {
            subtest 'render: discovery, factory, base contract' => {
                ok $format.lc (elem) Qwiratry::Format.formats(:type<Render>)».lc,
                    "'$format' is discoverable as a Render format";
                my $impl = Qwiratry::Format.make(:type<Render>, :format($format));
                isa-ok $impl, Qwiratry::Format::Base::Render,
                    "Render impl inherits Qwiratry::Format::Base::Render";
                can-ok $impl, 'render', 'Render impl provides a render method';
            }
        }

        if $parse && @parse-samples {
            subtest 'parse: samples produce defined data' => {
                my $impl = Qwiratry::Format.make(:type<Parse>, :format($format));
                for @parse-samples -> $sample {
                    my $data;
                    lives-ok { $data = $impl.parse($sample) },
                        "parses sample: {$sample.raku}";
                    ok $data.defined, "parsed data is defined: {$sample.raku}";
                }
            }
        }

        if $render && @render-values {
            subtest 'render: values produce Str output' => {
                my $impl = Qwiratry::Format.make(:type<Render>, :format($format));
                for @render-values -> $value {
                    my $text;
                    lives-ok { $text = $impl.render($value) },
                        "renders value: {$value.raku}";
                    isa-ok $text, Str, "render returns Str for {$value.raku}";
                }
            }
        }

        if $lossless && $parse && $render && @parse-samples {
            subtest 'lossless: parse∘render∘parse == parse' => {
                my $parser = Qwiratry::Format.make(:type<Parse>, :format($format));
                my $renderer = Qwiratry::Format.make(:type<Render>, :format($format));
                for @parse-samples -> $sample {
                    my $once = $parser.parse($sample);
                    my $twice = $parser.parse($renderer.render($once));
                    is-deeply $twice, $once,
                        "round-trips without loss: {$sample.raku}";
                }
            }
        }

        if $pipeline && $parse && @parse-samples {
            subtest 'pipeline: ↱ parse operator matches direct parse' => {
                my $parser = Qwiratry::Format.make(:type<Parse>, :format($format));
                for @parse-samples -> $sample {
                    is-deeply ($sample ↱ $format), $parser.parse($sample),
                        "↱ matches parse for {$sample.raku}";
                }
            }
        }

        if $pipeline && $render && @render-values {
            subtest 'pipeline: ↴ render operator matches direct render' => {
                my $renderer = Qwiratry::Format.make(:type<Render>, :format($format));
                for @render-values -> $value {
                    is ($value ↴ $format), $renderer.render($value),
                        "↴ matches render for {$value.raku}";
                }
            }
        }

        if $parse && @invalid-samples {
            subtest 'parse: invalid input is rejected' => {
                my $parser = Qwiratry::Format.make(:type<Parse>, :format($format));
                for @invalid-samples -> $sample {
                    dies-ok { $parser.parse($sample) },
                        "rejects invalid input: {$sample.raku}";
                }
            }
        }
    }
}


root

Location

User-visible changes by release


Changelog


React

=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<AI|file:../mcp/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>
    =item2 L<Hand these documents to an AI assistant|file:../mcp/index.podlite>

=end nested
=begin nested :!nested
=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>

=end nested
=end React


Built with L<Podlite|https://podlite.org> — the markup and publishing tools behind this site.


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


Format

Qwiratry::Test::Format

Synopsis

Requires

Qwiratry::Test v0.0.1

Authors

License

Dependencies

Test Dependencies

Provides

Documentation