TITLE

SUBTITLE

data

=begin data
{"type":"page","file":"work_mods/zef/TinyFloats/README.md","sources":[],"node":{"type":"block","id":"bROjYE5SS9lUgRtnJJcXo","margin":"","name":"root","content":[{"type":"para","id":"U5iH_Hqz-xG-xZR58Wyd0","margin":"","location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":1,"column":127,"offset":126}},"text":"text","content":[{"meta":"https://github.com/japhb/TinyFloats/actions","type":"fcode","name":"L","content":[{"type":"block","id":"53n5xJNP4D4MtOqDFDw6o","margin":"","name":"Image","config":[],"location":{"start":{"line":1,"column":2,"offset":1},"end":{"line":1,"column":81,"offset":80}},"content":[{"type":"image","src":"https://github.com/japhb/TinyFloats/workflows/test/badge.svg","alt":"Actions Status"}]}]}]},{"type":"block","id":"qijaLXl768WqlUySJ6IMy","margin":"","level":1,"name":"head","location":{"start":{"line":3,"column":1,"offset":128},"end":{"line":4,"column":5,"offset":137}},"content":["NAME"]},{"type":"para","id":"PJEHOZ273e7rwLXvKEDFm","margin":"","location":{"start":{"line":6,"column":1,"offset":139},"end":{"line":6,"column":48,"offset":186}},"text":"text","content":["TinyFloats - Convert to/from tiny float formats"]},{"type":"block","id":"ObTIqv6mwymNQ1tIMappw","margin":"","level":1,"name":"head","location":{"start":{"line":8,"column":1,"offset":188},"end":{"line":9,"column":9,"offset":205}},"content":["SYNOPSIS"]},{"type":"block","id":"xDyw7R6pTDM4TK1BPI88F","margin":"","name":"code","config":[{"name":"lang","value":"raku","type":"string"}],"location":{"start":{"line":11,"column":1,"offset":207},"end":{"line":16,"column":4,"offset":329}},"content":[{"type":"verbatim","value":"use TinyFloats;\n\nmy $bin16 = bin16-from-num(1e0);     # 0x3C00\nmy $num   = num-from-bin16(0xFBFF);  # -65504e0"}]},{"type":"block","id":"FdSoA03OyF3sxGP0PDPZl","margin":"","level":1,"name":"head","location":{"start":{"line":18,"column":1,"offset":331},"end":{"line":19,"column":12,"offset":354}},"content":["DESCRIPTION"]},{"type":"para","id":"k_h_T7W39UzjkQcOZigZq","margin":"","location":{"start":{"line":21,"column":1,"offset":356},"end":{"line":21,"column":121,"offset":476}},"text":"text","content":["TinyFloats is a collection of simple conversion routines to help with storing floating point data in tiny float formats."]},{"type":"para","id":"ijW8rSJcs2jlGRre0zZEF","margin":"","location":{"start":{"line":23,"column":1,"offset":478},"end":{"line":23,"column":163,"offset":640}},"text":"text","content":["This very first version supports only conversion between native nums and the IEEE 754 binary16 format, AKA ",{"type":"fcode","name":"C","content":["_Float16"]}," in C, ",{"type":"fcode","name":"C","content":["float16"]}," in CDDL, and ",{"type":"fcode","name":"C","content":["7.25"]}," in CBOR."]},{"type":"block","id":"02I8-pkZrDM7829n_sGOV","margin":"","level":1,"name":"head","location":{"start":{"line":25,"column":1,"offset":642},"end":{"line":26,"column":7,"offset":655}},"content":["AUTHOR"]},{"type":"para","id":"O4_Wdpwpc3KPbrQMiCkBH","margin":"","location":{"start":{"line":28,"column":1,"offset":657},"end":{"line":28,"column":35,"offset":691}},"text":"text","content":["Geoffrey Broadwell ",{"meta":"mailto:gjb@sonic.net","type":"fcode","name":"L","content":["gjb@sonic.net"]}]},{"type":"block","id":"BnxFLvA7D9ZNHo4Ze6dsd","margin":"","level":1,"name":"head","location":{"start":{"line":30,"column":1,"offset":693},"end":{"line":31,"column":22,"offset":736}},"content":["COPYRIGHT AND LICENSE"]},{"type":"para","id":"LV6hWDyepayzSUkthTDhI","margin":"","location":{"start":{"line":33,"column":1,"offset":738},"end":{"line":33,"column":34,"offset":771}},"text":"text","content":["Copyright 2021 Geoffrey Broadwell"]},{"type":"para","id":"i8vgchsuNxtd8iNh2_2Xy","margin":"","location":{"start":{"line":35,"column":1,"offset":773},"end":{"line":35,"column":104,"offset":876}},"text":"text","content":["This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0."]}]},"publishUrl":"/mods/zef/TinyFloats/README.md","pluginsData":{"moduleInfo":{"meta":{"api":"","auth":"zef:japhb","authors":["Geoffrey Broadwell"],"build-depends":[],"depends":[],"description":"Convert to/from tiny float formats","dist":"TinyFloats:ver<0.0.1>:auth<zef:japhb>","license":"Artistic-2.0","name":"TinyFloats","path":"T/IN/TINYFLOATS/f7ebbc8a3f8858f343380a20a09bd65859cecac9.tar.gz","perl":"6.d","provides":{"TinyFloats":"lib/TinyFloats.rakumod"},"resources":[],"source-url":"https://github.com/japhb/TinyFloats.git","tags":[],"test-depends":[],"version":"0.0.1"},"files":[{"file":"work_mods/zef/TinyFloats/README.md","publishUrl":"/mods/zef/TinyFloats/README.md"},{"file":"work_mods/zef/TinyFloats/lib/TinyFloats.rakumod","publishUrl":"/mods/zef/TinyFloats/lib/TinyFloats.rakumod"}],"src":"zef","url":"/mods/zef/TinyFloats"}}}
=end data


React

    =begin React :component<RenderItem>
    =begin data
    {"type":"page","file":"work_mods/zef/TinyFloats/README.md","sources":[],"node":{"type":"block","id":"bROjYE5SS9lUgRtnJJcXo","margin":"","name":"root","content":[{"type":"para","id":"U5iH_Hqz-xG-xZR58Wyd0","margin":"","location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":1,"column":127,"offset":126}},"text":"text","content":[{"meta":"https://github.com/japhb/TinyFloats/actions","type":"fcode","name":"L","content":[{"type":"block","id":"53n5xJNP4D4MtOqDFDw6o","margin":"","name":"Image","config":[],"location":{"start":{"line":1,"column":2,"offset":1},"end":{"line":1,"column":81,"offset":80}},"content":[{"type":"image","src":"https://github.com/japhb/TinyFloats/workflows/test/badge.svg","alt":"Actions Status"}]}]}]},{"type":"block","id":"qijaLXl768WqlUySJ6IMy","margin":"","level":1,"name":"head","location":{"start":{"line":3,"column":1,"offset":128},"end":{"line":4,"column":5,"offset":137}},"content":["NAME"]},{"type":"para","id":"PJEHOZ273e7rwLXvKEDFm","margin":"","location":{"start":{"line":6,"column":1,"offset":139},"end":{"line":6,"column":48,"offset":186}},"text":"text","content":["TinyFloats - Convert to/from tiny float formats"]},{"type":"block","id":"ObTIqv6mwymNQ1tIMappw","margin":"","level":1,"name":"head","location":{"start":{"line":8,"column":1,"offset":188},"end":{"line":9,"column":9,"offset":205}},"content":["SYNOPSIS"]},{"type":"block","id":"xDyw7R6pTDM4TK1BPI88F","margin":"","name":"code","config":[{"name":"lang","value":"raku","type":"string"}],"location":{"start":{"line":11,"column":1,"offset":207},"end":{"line":16,"column":4,"offset":329}},"content":[{"type":"verbatim","value":"use TinyFloats;\n\nmy $bin16 = bin16-from-num(1e0);     # 0x3C00\nmy $num   = num-from-bin16(0xFBFF);  # -65504e0"}]},{"type":"block","id":"FdSoA03OyF3sxGP0PDPZl","margin":"","level":1,"name":"head","location":{"start":{"line":18,"column":1,"offset":331},"end":{"line":19,"column":12,"offset":354}},"content":["DESCRIPTION"]},{"type":"para","id":"k_h_T7W39UzjkQcOZigZq","margin":"","location":{"start":{"line":21,"column":1,"offset":356},"end":{"line":21,"column":121,"offset":476}},"text":"text","content":["TinyFloats is a collection of simple conversion routines to help with storing floating point data in tiny float formats."]},{"type":"para","id":"ijW8rSJcs2jlGRre0zZEF","margin":"","location":{"start":{"line":23,"column":1,"offset":478},"end":{"line":23,"column":163,"offset":640}},"text":"text","content":["This very first version supports only conversion between native nums and the IEEE 754 binary16 format, AKA ",{"type":"fcode","name":"C","content":["_Float16"]}," in C, ",{"type":"fcode","name":"C","content":["float16"]}," in CDDL, and ",{"type":"fcode","name":"C","content":["7.25"]}," in CBOR."]},{"type":"block","id":"02I8-pkZrDM7829n_sGOV","margin":"","level":1,"name":"head","location":{"start":{"line":25,"column":1,"offset":642},"end":{"line":26,"column":7,"offset":655}},"content":["AUTHOR"]},{"type":"para","id":"O4_Wdpwpc3KPbrQMiCkBH","margin":"","location":{"start":{"line":28,"column":1,"offset":657},"end":{"line":28,"column":35,"offset":691}},"text":"text","content":["Geoffrey Broadwell ",{"meta":"mailto:gjb@sonic.net","type":"fcode","name":"L","content":["gjb@sonic.net"]}]},{"type":"block","id":"BnxFLvA7D9ZNHo4Ze6dsd","margin":"","level":1,"name":"head","location":{"start":{"line":30,"column":1,"offset":693},"end":{"line":31,"column":22,"offset":736}},"content":["COPYRIGHT AND LICENSE"]},{"type":"para","id":"LV6hWDyepayzSUkthTDhI","margin":"","location":{"start":{"line":33,"column":1,"offset":738},"end":{"line":33,"column":34,"offset":771}},"text":"text","content":["Copyright 2021 Geoffrey Broadwell"]},{"type":"para","id":"i8vgchsuNxtd8iNh2_2Xy","margin":"","location":{"start":{"line":35,"column":1,"offset":773},"end":{"line":35,"column":104,"offset":876}},"text":"text","content":["This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0."]}]},"publishUrl":"/mods/zef/TinyFloats/README.md","pluginsData":{"moduleInfo":{"meta":{"api":"","auth":"zef:japhb","authors":["Geoffrey Broadwell"],"build-depends":[],"depends":[],"description":"Convert to/from tiny float formats","dist":"TinyFloats:ver<0.0.1>:auth<zef:japhb>","license":"Artistic-2.0","name":"TinyFloats","path":"T/IN/TINYFLOATS/f7ebbc8a3f8858f343380a20a09bd65859cecac9.tar.gz","perl":"6.d","provides":{"TinyFloats":"lib/TinyFloats.rakumod"},"resources":[],"source-url":"https://github.com/japhb/TinyFloats.git","tags":[],"test-depends":[],"version":"0.0.1"},"files":[{"file":"work_mods/zef/TinyFloats/README.md","publishUrl":"/mods/zef/TinyFloats/README.md"},{"file":"work_mods/zef/TinyFloats/lib/TinyFloats.rakumod","publishUrl":"/mods/zef/TinyFloats/lib/TinyFloats.rakumod"}],"src":"zef","url":"/mods/zef/TinyFloats"}}}
    =end data
    =end React


root

Convert to/from tiny float formats


para

L<Examples| file:../examples/index.podlite>


L<Download |file:../download/index.podlite>


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


HEADER

FOOTER

TinyFloats


=begin data
{"type":"page","file":"work_mods/zef/TinyID/TinyID/README.md","sources":[],"node":{"type":"block","id":"WyIyLwoDCnGt8xnj3902O","margin":"","name":"root","content":[{"type":"block","id":"OIj_wUwkA4ich0fqcm9tH","margin":"","level":1,"name":"head","location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":1,"column":69,"offset":68}},"content":["Shorten and obfuscate IDs in ",{"meta":"https://www.raku.org","type":"fcode","name":"L","content":["Raku"]}," language"]},{"type":"para","id":"f4y9ocQsWQLSBuCcspa_D","margin":"","location":{"start":{"line":3,"column":1,"offset":70},"end":{"line":3,"column":65,"offset":134}},"text":"text","content":[{"type":"block","id":"cA6LjBmctcqlbcPFTuMBz","margin":"","name":"Image","config":[],"location":{"start":{"line":3,"column":1,"offset":70},"end":{"line":3,"column":65,"offset":134}},"content":[{"type":"image","src":"https://github.com/bbkr/TinyID/workflows/test/badge.svg","alt":"test"}]}]},{"type":"block","id":"iIN4FcboABJ7Y5D_AOF3P","margin":"","level":2,"name":"head","location":{"start":{"line":5,"column":1,"offset":136},"end":{"line":5,"column":12,"offset":147}},"content":["SYNOPSIS"]},{"type":"block","id":"Ng9iGWqZkBSEDyjW9Wzje","margin":"","name":"code","config":[{"name":"lang","value":"raku","type":"string"}],"location":{"start":{"line":7,"column":1,"offset":149},"end":{"line":17,"column":4,"offset":512}},"content":[{"type":"verbatim","value":"    use TinyID;\n    \n    my $key = ( 'a'..'z', 'A'..'Z', 0..9 ).flat.pick( * ).join;\n    # example key is '2BjLhRduC6Tb8Q5cEk9oxnFaWUDpOlGAgwYzNre7tI4yqPvXm0KSV1fJs3ZiHM'\n    \n    my $tinyid = TinyID.new( key => $key );\n    \n    say $tinyid.encode( 48888851145 );  # will print '1FN7Ab'\n    say $tinyid.decode( '1FN7Ab' );     # will print 48888851145"}]},{"type":"block","id":"SQn6tSFUk-3vVw6HvGLRq","margin":"","level":2,"name":"head","location":{"start":{"line":19,"column":1,"offset":514},"end":{"line":19,"column":15,"offset":528}},"content":["DESCRIPTION"]},{"type":"para","id":"neJwfYm5c0PFcKJJ80gPA","margin":"","location":{"start":{"line":21,"column":1,"offset":530},"end":{"line":21,"column":95,"offset":624}},"text":"text","content":["Using real IDs in various places - such as GET links or API payload - is generally a bad idea:"]},{"type":"list","id":"7bvdYGwQXqRYAtYI1-Ile","margin":"","level":1,"list":"itemized","content":[{"type":"block","id":"kwFag4ccqAzu31E4w92Sk","margin":"","name":"item","level":1,"location":{"start":{"line":23,"column":1,"offset":626},"end":{"line":23,"column":109,"offset":734}},"content":[{"type":"para","id":"STze5V9tvdnAKAsVPZZ7C","margin":"","location":{"start":{"line":23,"column":3,"offset":628},"end":{"line":23,"column":109,"offset":734}},"text":"text","content":["It may reveal some sensitive informations about your business, such as growth rate or amount of customers."]}]},{"type":"block","id":"d-aM-T-eLwo4Hy5mxorIF","margin":"","name":"item","level":1,"location":{"start":{"line":24,"column":1,"offset":735},"end":{"line":24,"column":226,"offset":960}},"content":[{"type":"para","id":"hv0Vkld-UCD4ChK4nUVQn","margin":"","location":{"start":{"line":24,"column":3,"offset":737},"end":{"line":24,"column":226,"offset":960}},"text":"text","content":["If someone finds unprotected resource link, where you forgot to check if passed resource ID really belongs to currently logged-in user, he will be able to steal all of your data really fast just by incrementing ID in links."]}]},{"type":"block","id":"dSZDIqWx-OPIhRSHBdZT8","margin":"","name":"item","level":1,"location":{"start":{"line":25,"column":1,"offset":961},"end":{"line":25,"column":91,"offset":1051}},"content":[{"type":"para","id":"0fe--2g8JQ-sUQEbeCtdo","margin":"","location":{"start":{"line":25,"column":3,"offset":963},"end":{"line":25,"column":91,"offset":1051}},"text":"text","content":["Big numbers may cause overflows in places where length is limited, such as SMS messages."]}]}]},{"type":"para","id":"MmuOUtn4thH-jGEpGC1LM","margin":"","location":{"start":{"line":27,"column":1,"offset":1053},"end":{"line":27,"column":86,"offset":1138}},"text":"text","content":["With the help of this module you can shorten and obfuscate your IDs at the same time."]},{"type":"block","id":"bv71lDHRjSt6QKEWCdbfN","margin":"","level":2,"name":"head","location":{"start":{"line":29,"column":1,"offset":1140},"end":{"line":29,"column":11,"offset":1150}},"content":["METHODS"]},{"type":"block","id":"uk-s_vQcc0H3NREsUU4NP","margin":"","level":3,"name":"head","location":{"start":{"line":31,"column":1,"offset":1152},"end":{"line":31,"column":27,"offset":1178}},"content":["new( key => 'qwerty' )"]},{"type":"para","id":"RqOIP1n2JyW9hf1vbURK2","margin":"","location":{"start":{"line":33,"column":1,"offset":1180},"end":{"line":33,"column":66,"offset":1245}},"text":"text","content":["Key must consist of at least two ",{"type":"fcode","name":"I","content":[{"type":"fcode","name":"B","content":["unique"]}]}," unicode characters."]},{"type":"para","id":"pHZKkqI6NYMFYOO5YfpKn","margin":"","location":{"start":{"line":35,"column":1,"offset":1247},"end":{"line":35,"column":45,"offset":1291}},"text":"text","content":["The longer the key - the shorter encoded ID."]},{"type":"para","id":"X3rd4X_UDxK2Ap2e8EYdr","margin":"","location":{"start":{"line":37,"column":1,"offset":1293},"end":{"line":40,"column":139,"offset":1715}},"text":"text","content":["Encoded ID will be made exclusively out of characters from the key.\nThis very useful property allows to adapt your encoding to the environment.\nFor example in SMS messages you may restrict key to US ASCII to avoid available length reduction caused by conversion to GSM 03.38 charset.\nOr if you want to use such ID as file/directory name in case insensitive filesystem you may want to use only lowercase letters in the key."]},{"type":"block","id":"2HhUMNFLDVkf8zqz60dmK","margin":"","level":3,"name":"head","location":{"start":{"line":42,"column":1,"offset":1717},"end":{"line":42,"column":18,"offset":1734}},"content":["encode( 123 )"]},{"type":"para","id":"k09aaWRfNmuaurLgSdcD2","margin":"","location":{"start":{"line":44,"column":1,"offset":1736},"end":{"line":44,"column":39,"offset":1774}},"text":"text","content":["Encode positive integer into a string."]},{"type":"para","id":"mbbk6xPkFZVfdChBmaFM4","margin":"","location":{"start":{"line":46,"column":1,"offset":1776},"end":{"line":46,"column":92,"offset":1867}},"text":"text","content":["Note that leading ",{"type":"fcode","name":"C","content":["0"]},"s are not preserved, ",{"type":"fcode","name":"C","content":["encode( 123 )"]}," is the same as ",{"type":"fcode","name":"C","content":["encode( 00123 )"]},"."]},{"type":"para","id":"aX0So5jThWgtkBsibAID4","margin":"","location":{"start":{"line":48,"column":1,"offset":1869},"end":{"line":49,"column":147,"offset":2125}},"text":"text","content":["Used algorithm is a base to the length of the key conversion that maps to distinct permutation of characters.\nDo not consider it a strong encryption, but if you have secret and long and well shuffled key it is almost impossible to reverse-engineer real ID."]},{"type":"block","id":"1ElOjeY99RrfwDNckfebO","margin":"","level":3,"name":"head","location":{"start":{"line":51,"column":1,"offset":2127},"end":{"line":51,"column":20,"offset":2146}},"content":["decode( 'rer' )"]},{"type":"para","id":"14OWuEb6WNLxT95OoVPhc","margin":"","location":{"start":{"line":53,"column":1,"offset":2148},"end":{"line":53,"column":44,"offset":2191}},"text":"text","content":["Decode string back into a positive integer."]},{"type":"block","id":"sKGmE0VvlcCHKCTMAFW8P","margin":"","level":2,"name":"head","location":{"start":{"line":55,"column":1,"offset":2193},"end":{"line":55,"column":10,"offset":2202}},"content":["TRICKS"]},{"type":"para","id":"SJVkwDZGBBWgUUztFi6h1","margin":"","location":{"start":{"line":57,"column":1,"offset":2204},"end":{"line":57,"column":124,"offset":2327}},"text":"text","content":["If you provide sequential characters in key you can convert your numbers to some weird numeric systems, for example base18:"]},{"type":"block","id":"5AA5ikKPcGE8DV8HdSaeo","margin":"","name":"code","config":[{"name":"lang","value":"raku","type":"string"}],"location":{"start":{"line":59,"column":1,"offset":2329},"end":{"line":61,"column":4,"offset":2430}},"content":[{"type":"verbatim","value":"    TinyID.new( key => '0123456789ABCDEFGH' ).encode( 48888851145 ).say;    # '47F709HFF'"}]},{"type":"para","id":"MKrrhByh3ZjgLVR5tlqjs","margin":"","location":{"start":{"line":63,"column":1,"offset":2432},"end":{"line":63,"column":43,"offset":2474}},"text":"text","content":["Or you can go wild just for the fun of it."]},{"type":"block","id":"0xDe17ScS4K9cMSP84o_1","margin":"","name":"code","config":[{"name":"lang","value":"raku","type":"string"}],"location":{"start":{"line":65,"column":1,"offset":2476},"end":{"line":68,"column":4,"offset":2619}},"content":[{"type":"verbatim","value":"    my $key = ( '😀'..'😿' ).flat.join; # emoji subset\n    TinyID.new( key => $key ).encode( 48888851145 ).say;    # '😭😢😀😊😫😉'"}]},{"type":"block","id":"YlPV_Hny3EMlFvLkTF31F","margin":"","level":2,"name":"head","location":{"start":{"line":70,"column":1,"offset":2621},"end":{"line":70,"column":25,"offset":2645}},"content":["OTHER IMPLEMENTATIONS"]},{"type":"list","id":"ACHN7oY_U8anCUVQD5xMd","margin":"","level":1,"list":"itemized","content":[{"type":"block","id":"Cs89SjqfC0injWhFdinyY","margin":"","name":"item","level":1,"location":{"start":{"line":72,"column":1,"offset":2647},"end":{"line":72,"column":76,"offset":2722}},"content":[{"type":"para","id":"rq07lUmCMrmktnHmcG9bj","margin":"","location":{"start":{"line":72,"column":3,"offset":2649},"end":{"line":72,"column":76,"offset":2722}},"text":"text","content":[{"meta":"http://search.cpan.org/~bbkr/Integer-Tiny-0.3/lib/Integer/Tiny.pm","type":"fcode","name":"L","content":["Perl"]}]}]},{"type":"block","id":"4ieFDHm8mYFMZnFd0cHlZ","margin":"","name":"item","level":1,"location":{"start":{"line":73,"column":1,"offset":2723},"end":{"line":73,"column":45,"offset":2767}},"content":[{"type":"para","id":"wpKRWq-mjhg_n28tu8hx7","margin":"","location":{"start":{"line":73,"column":3,"offset":2725},"end":{"line":73,"column":45,"offset":2767}},"text":"text","content":[{"meta":"https://github.com/krowinski/tinyID","type":"fcode","name":"L","content":["PHP"]}]}]}]}]},"publishUrl":"/mods/zef/TinyID/TinyID/README.md","pluginsData":{"moduleInfo":{"meta":{"api":"","auth":"zef:bbkr","authors":["Paweł bbkr Pabian"],"description":"Shorten and obfuscate IDs.","dist":"TinyID:ver<1.0.3>:auth<zef:bbkr>","license":"Artistic-2.0","name":"TinyID","path":"T/IN/TINYID/da9fc88456f7c9fe9ca1dcb525b51bba0c14c783.tar.gz","provides":{"TinyID":"lib/TinyID.rakumod"},"source-url":"git://github.com/bbkr/TinyID.git","version":"1.0.3"},"files":[{"file":"work_mods/zef/TinyID/TinyID/README.md","publishUrl":"/mods/zef/TinyID/TinyID/README.md"}],"src":"zef","url":"/mods/zef/TinyID"}}}
=end data


    =begin React :component<RenderItem>
    =begin data
    {"type":"page","file":"work_mods/zef/TinyID/TinyID/README.md","sources":[],"node":{"type":"block","id":"WyIyLwoDCnGt8xnj3902O","margin":"","name":"root","content":[{"type":"block","id":"OIj_wUwkA4ich0fqcm9tH","margin":"","level":1,"name":"head","location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":1,"column":69,"offset":68}},"content":["Shorten and obfuscate IDs in ",{"meta":"https://www.raku.org","type":"fcode","name":"L","content":["Raku"]}," language"]},{"type":"para","id":"f4y9ocQsWQLSBuCcspa_D","margin":"","location":{"start":{"line":3,"column":1,"offset":70},"end":{"line":3,"column":65,"offset":134}},"text":"text","content":[{"type":"block","id":"cA6LjBmctcqlbcPFTuMBz","margin":"","name":"Image","config":[],"location":{"start":{"line":3,"column":1,"offset":70},"end":{"line":3,"column":65,"offset":134}},"content":[{"type":"image","src":"https://github.com/bbkr/TinyID/workflows/test/badge.svg","alt":"test"}]}]},{"type":"block","id":"iIN4FcboABJ7Y5D_AOF3P","margin":"","level":2,"name":"head","location":{"start":{"line":5,"column":1,"offset":136},"end":{"line":5,"column":12,"offset":147}},"content":["SYNOPSIS"]},{"type":"block","id":"Ng9iGWqZkBSEDyjW9Wzje","margin":"","name":"code","config":[{"name":"lang","value":"raku","type":"string"}],"location":{"start":{"line":7,"column":1,"offset":149},"end":{"line":17,"column":4,"offset":512}},"content":[{"type":"verbatim","value":"    use TinyID;\n    \n    my $key = ( 'a'..'z', 'A'..'Z', 0..9 ).flat.pick( * ).join;\n    # example key is '2BjLhRduC6Tb8Q5cEk9oxnFaWUDpOlGAgwYzNre7tI4yqPvXm0KSV1fJs3ZiHM'\n    \n    my $tinyid = TinyID.new( key => $key );\n    \n    say $tinyid.encode( 48888851145 );  # will print '1FN7Ab'\n    say $tinyid.decode( '1FN7Ab' );     # will print 48888851145"}]},{"type":"block","id":"SQn6tSFUk-3vVw6HvGLRq","margin":"","level":2,"name":"head","location":{"start":{"line":19,"column":1,"offset":514},"end":{"line":19,"column":15,"offset":528}},"content":["DESCRIPTION"]},{"type":"para","id":"neJwfYm5c0PFcKJJ80gPA","margin":"","location":{"start":{"line":21,"column":1,"offset":530},"end":{"line":21,"column":95,"offset":624}},"text":"text","content":["Using real IDs in various places - such as GET links or API payload - is generally a bad idea:"]},{"type":"list","id":"7bvdYGwQXqRYAtYI1-Ile","margin":"","level":1,"list":"itemized","content":[{"type":"block","id":"kwFag4ccqAzu31E4w92Sk","margin":"","name":"item","level":1,"location":{"start":{"line":23,"column":1,"offset":626},"end":{"line":23,"column":109,"offset":734}},"content":[{"type":"para","id":"STze5V9tvdnAKAsVPZZ7C","margin":"","location":{"start":{"line":23,"column":3,"offset":628},"end":{"line":23,"column":109,"offset":734}},"text":"text","content":["It may reveal some sensitive informations about your business, such as growth rate or amount of customers."]}]},{"type":"block","id":"d-aM-T-eLwo4Hy5mxorIF","margin":"","name":"item","level":1,"location":{"start":{"line":24,"column":1,"offset":735},"end":{"line":24,"column":226,"offset":960}},"content":[{"type":"para","id":"hv0Vkld-UCD4ChK4nUVQn","margin":"","location":{"start":{"line":24,"column":3,"offset":737},"end":{"line":24,"column":226,"offset":960}},"text":"text","content":["If someone finds unprotected resource link, where you forgot to check if passed resource ID really belongs to currently logged-in user, he will be able to steal all of your data really fast just by incrementing ID in links."]}]},{"type":"block","id":"dSZDIqWx-OPIhRSHBdZT8","margin":"","name":"item","level":1,"location":{"start":{"line":25,"column":1,"offset":961},"end":{"line":25,"column":91,"offset":1051}},"content":[{"type":"para","id":"0fe--2g8JQ-sUQEbeCtdo","margin":"","location":{"start":{"line":25,"column":3,"offset":963},"end":{"line":25,"column":91,"offset":1051}},"text":"text","content":["Big numbers may cause overflows in places where length is limited, such as SMS messages."]}]}]},{"type":"para","id":"MmuOUtn4thH-jGEpGC1LM","margin":"","location":{"start":{"line":27,"column":1,"offset":1053},"end":{"line":27,"column":86,"offset":1138}},"text":"text","content":["With the help of this module you can shorten and obfuscate your IDs at the same time."]},{"type":"block","id":"bv71lDHRjSt6QKEWCdbfN","margin":"","level":2,"name":"head","location":{"start":{"line":29,"column":1,"offset":1140},"end":{"line":29,"column":11,"offset":1150}},"content":["METHODS"]},{"type":"block","id":"uk-s_vQcc0H3NREsUU4NP","margin":"","level":3,"name":"head","location":{"start":{"line":31,"column":1,"offset":1152},"end":{"line":31,"column":27,"offset":1178}},"content":["new( key => 'qwerty' )"]},{"type":"para","id":"RqOIP1n2JyW9hf1vbURK2","margin":"","location":{"start":{"line":33,"column":1,"offset":1180},"end":{"line":33,"column":66,"offset":1245}},"text":"text","content":["Key must consist of at least two ",{"type":"fcode","name":"I","content":[{"type":"fcode","name":"B","content":["unique"]}]}," unicode characters."]},{"type":"para","id":"pHZKkqI6NYMFYOO5YfpKn","margin":"","location":{"start":{"line":35,"column":1,"offset":1247},"end":{"line":35,"column":45,"offset":1291}},"text":"text","content":["The longer the key - the shorter encoded ID."]},{"type":"para","id":"X3rd4X_UDxK2Ap2e8EYdr","margin":"","location":{"start":{"line":37,"column":1,"offset":1293},"end":{"line":40,"column":139,"offset":1715}},"text":"text","content":["Encoded ID will be made exclusively out of characters from the key.\nThis very useful property allows to adapt your encoding to the environment.\nFor example in SMS messages you may restrict key to US ASCII to avoid available length reduction caused by conversion to GSM 03.38 charset.\nOr if you want to use such ID as file/directory name in case insensitive filesystem you may want to use only lowercase letters in the key."]},{"type":"block","id":"2HhUMNFLDVkf8zqz60dmK","margin":"","level":3,"name":"head","location":{"start":{"line":42,"column":1,"offset":1717},"end":{"line":42,"column":18,"offset":1734}},"content":["encode( 123 )"]},{"type":"para","id":"k09aaWRfNmuaurLgSdcD2","margin":"","location":{"start":{"line":44,"column":1,"offset":1736},"end":{"line":44,"column":39,"offset":1774}},"text":"text","content":["Encode positive integer into a string."]},{"type":"para","id":"mbbk6xPkFZVfdChBmaFM4","margin":"","location":{"start":{"line":46,"column":1,"offset":1776},"end":{"line":46,"column":92,"offset":1867}},"text":"text","content":["Note that leading ",{"type":"fcode","name":"C","content":["0"]},"s are not preserved, ",{"type":"fcode","name":"C","content":["encode( 123 )"]}," is the same as ",{"type":"fcode","name":"C","content":["encode( 00123 )"]},"."]},{"type":"para","id":"aX0So5jThWgtkBsibAID4","margin":"","location":{"start":{"line":48,"column":1,"offset":1869},"end":{"line":49,"column":147,"offset":2125}},"text":"text","content":["Used algorithm is a base to the length of the key conversion that maps to distinct permutation of characters.\nDo not consider it a strong encryption, but if you have secret and long and well shuffled key it is almost impossible to reverse-engineer real ID."]},{"type":"block","id":"1ElOjeY99RrfwDNckfebO","margin":"","level":3,"name":"head","location":{"start":{"line":51,"column":1,"offset":2127},"end":{"line":51,"column":20,"offset":2146}},"content":["decode( 'rer' )"]},{"type":"para","id":"14OWuEb6WNLxT95OoVPhc","margin":"","location":{"start":{"line":53,"column":1,"offset":2148},"end":{"line":53,"column":44,"offset":2191}},"text":"text","content":["Decode string back into a positive integer."]},{"type":"block","id":"sKGmE0VvlcCHKCTMAFW8P","margin":"","level":2,"name":"head","location":{"start":{"line":55,"column":1,"offset":2193},"end":{"line":55,"column":10,"offset":2202}},"content":["TRICKS"]},{"type":"para","id":"SJVkwDZGBBWgUUztFi6h1","margin":"","location":{"start":{"line":57,"column":1,"offset":2204},"end":{"line":57,"column":124,"offset":2327}},"text":"text","content":["If you provide sequential characters in key you can convert your numbers to some weird numeric systems, for example base18:"]},{"type":"block","id":"5AA5ikKPcGE8DV8HdSaeo","margin":"","name":"code","config":[{"name":"lang","value":"raku","type":"string"}],"location":{"start":{"line":59,"column":1,"offset":2329},"end":{"line":61,"column":4,"offset":2430}},"content":[{"type":"verbatim","value":"    TinyID.new( key => '0123456789ABCDEFGH' ).encode( 48888851145 ).say;    # '47F709HFF'"}]},{"type":"para","id":"MKrrhByh3ZjgLVR5tlqjs","margin":"","location":{"start":{"line":63,"column":1,"offset":2432},"end":{"line":63,"column":43,"offset":2474}},"text":"text","content":["Or you can go wild just for the fun of it."]},{"type":"block","id":"0xDe17ScS4K9cMSP84o_1","margin":"","name":"code","config":[{"name":"lang","value":"raku","type":"string"}],"location":{"start":{"line":65,"column":1,"offset":2476},"end":{"line":68,"column":4,"offset":2619}},"content":[{"type":"verbatim","value":"    my $key = ( '😀'..'😿' ).flat.join; # emoji subset\n    TinyID.new( key => $key ).encode( 48888851145 ).say;    # '😭😢😀😊😫😉'"}]},{"type":"block","id":"YlPV_Hny3EMlFvLkTF31F","margin":"","level":2,"name":"head","location":{"start":{"line":70,"column":1,"offset":2621},"end":{"line":70,"column":25,"offset":2645}},"content":["OTHER IMPLEMENTATIONS"]},{"type":"list","id":"ACHN7oY_U8anCUVQD5xMd","margin":"","level":1,"list":"itemized","content":[{"type":"block","id":"Cs89SjqfC0injWhFdinyY","margin":"","name":"item","level":1,"location":{"start":{"line":72,"column":1,"offset":2647},"end":{"line":72,"column":76,"offset":2722}},"content":[{"type":"para","id":"rq07lUmCMrmktnHmcG9bj","margin":"","location":{"start":{"line":72,"column":3,"offset":2649},"end":{"line":72,"column":76,"offset":2722}},"text":"text","content":[{"meta":"http://search.cpan.org/~bbkr/Integer-Tiny-0.3/lib/Integer/Tiny.pm","type":"fcode","name":"L","content":["Perl"]}]}]},{"type":"block","id":"4ieFDHm8mYFMZnFd0cHlZ","margin":"","name":"item","level":1,"location":{"start":{"line":73,"column":1,"offset":2723},"end":{"line":73,"column":45,"offset":2767}},"content":[{"type":"para","id":"wpKRWq-mjhg_n28tu8hx7","margin":"","location":{"start":{"line":73,"column":3,"offset":2725},"end":{"line":73,"column":45,"offset":2767}},"text":"text","content":[{"meta":"https://github.com/krowinski/tinyID","type":"fcode","name":"L","content":["PHP"]}]}]}]}]},"publishUrl":"/mods/zef/TinyID/TinyID/README.md","pluginsData":{"moduleInfo":{"meta":{"api":"","auth":"zef:bbkr","authors":["Paweł bbkr Pabian"],"description":"Shorten and obfuscate IDs.","dist":"TinyID:ver<1.0.3>:auth<zef:bbkr>","license":"Artistic-2.0","name":"TinyID","path":"T/IN/TINYID/da9fc88456f7c9fe9ca1dcb525b51bba0c14c783.tar.gz","provides":{"TinyID":"lib/TinyID.rakumod"},"source-url":"git://github.com/bbkr/TinyID.git","version":"1.0.3"},"files":[{"file":"work_mods/zef/TinyID/TinyID/README.md","publishUrl":"/mods/zef/TinyID/TinyID/README.md"}],"src":"zef","url":"/mods/zef/TinyID"}}}
    =end data
    =end React


Shorten and obfuscate IDs.


TinyID


An Experimental Workflow / State Management toolkit


=begin data
{"type":"page","file":"work_mods/zef/Tinky/Tinky-0.1.4/README.md","sources":[],"node":{"type":"block","id":"KxGcFbofFs3FyV7RA5345","margin":"","name":"root","content":[{"type":"block","id":"mItB_6OwhQuAuc4Zfp6F4","margin":"","level":1,"name":"head","location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":1,"column":8,"offset":7}},"content":["Tinky"]},{"type":"para","id":"zJRepH6X1Q8tCOr_7arJY","margin":"","location":{"start":{"line":3,"column":1,"offset":9},"end":{"line":3,"column":41,"offset":49}},"text":"text","content":["An experimental workflow module for Raku"]},{"type":"para","id":"XD_Ptfj971Yp1wQFBFcbC","margin":"","location":{"start":{"line":5,"column":1,"offset":51},"end":{"line":5,"column":79,"offset":129}},"text":"text","content":[{"type":"block","id":"_wRSaCftXkmrRjVb-EKm9","margin":"","name":"Image","config":[],"location":{"start":{"line":5,"column":1,"offset":51},"end":{"line":5,"column":79,"offset":129}},"content":[{"type":"image","src":"https://github.com/jonathanstowe/Tinky/workflows/CI/badge.svg","alt":"Build Status"}]}]},{"type":"block","id":"CzS57EbdLBTmj__JZtkoV","margin":"","level":2,"name":"head","location":{"start":{"line":7,"column":1,"offset":131},"end":{"line":7,"column":12,"offset":142}},"content":["Synopsis"]},{"type":"para","id":"wY3xUglIdOOBVIc90xcGQ","margin":"","location":{"start":{"line":9,"column":1,"offset":144},"end":{"line":9,"column":81,"offset":224}},"text":"text","content":["This is quite long ",{"meta":"#description","type":"fcode","name":"L","content":["skip to the Description"]}," if you are impatient."]},{"type":"block","id":"UfeGZLQG5yeeTeVn_Jdf6","margin":"","name":"code","config":[{"name":"lang","value":"raku","type":"string"}],"location":{"start":{"line":11,"column":1,"offset":226},"end":{"line":113,"column":4,"offset":4963}},"content":[{"type":"verbatim","value":"\nuse Tinky;\n\n\n# A class that will use the workflow\n# it can have any attributes or methods\n# required by your application\n\nclass Ticket does Tinky::Object {\n    has Str $.ticket-number = (^100000).pick.fmt(\"%08d\");\n    has Str $.owner;\n}\n\n# Set up some states as required by the application\nmy $state-new         = Tinky::State.new(name => 'new');\nmy $state-open        = Tinky::State.new(name => 'open');\nmy $state-rejected    = Tinky::State.new(name => 'rejected');\nmy $state-in-progress = Tinky::State.new(name => 'in-progress');\nmy $state-stalled     = Tinky::State.new(name => 'stalled');\nmy $state-complete    = Tinky::State.new(name => 'complete');\n\n# Each state has an 'enter-supply' and a 'leave-supply' which get the\n# object which the state was applied to.\n\n$state-rejected.enter-supply.act( -> $object { say \"** sending rejected e-mail for Ticket '{ $object.ticket-number }' **\"});\n\n# Create some transitions to describe pre-determined change of state\n# A method will be created on the Tinky::Object for each transition name\n\nmy $open              = Tinky::Transition.new(name => 'open', from => $state-new, to => $state-open);\n\n# Where  more than one transition has the same name, the transition which matches the object's \n# current state will be use.\nmy $reject-new        = Tinky::Transition.new(name => 'reject', from => $state-new, to => $state-rejected);\nmy $reject-open       = Tinky::Transition.new(name => 'reject', from => $state-open, to => $state-rejected);\nmy $reject-stalled    = Tinky::Transition.new(name => 'reject', from => $state-stalled, to => $state-rejected);\n\nmy $stall-open        = Tinky::Transition.new(name => 'stall', from => $state-open, to => $state-stalled);\nmy $stall-progress    = Tinky::Transition.new(name => 'stall', from => $state-in-progress, to => $state-stalled);\n\n# The transition supply allows specific logic for the transition to be performed\n\n$stall-progress.supply.act( -> $object { say \"** rescheduling tickets for '{ $object.owner }' on ticket stall **\"});\n\nmy $unstall           = Tinky::Transition.new(name => 'unstall', from => $state-stalled, to => $state-in-progress);\n\nmy $take              = Tinky::Transition.new(name => 'take', from => $state-open, to => $state-in-progress);\n\nmy $complete-open     = Tinky::Transition.new(name => 'complete', from => $state-open, to => $state-complete);\nmy $complete-progress = Tinky::Transition.new(name => 'complete', from => $state-in-progress, to => $state-complete);\n\nmy @transitions = $open, $reject-new, $reject-open, $reject-stalled, $stall-open, $stall-progress, $unstall, $take, $complete-open, $complete-progress;\n\n# The Workflow object allows the relation between states and transitions to be calculate\n# and generates the methods that will be applied to the ticket object.  The initial-state\n# will be applied to the object if there is no existing state on the state.\nmy $workflow = Tinky::Workflow.new(:@transitions, name => 'ticket-workflow', initial-state => $state-new );\n\n# The workflow aggregates the Supplies of the transitions and the states.\n# This could be to a logging subsystem for instance. \n\n$workflow.transition-supply.act(-> ($trans, $object) { say \"Ticket '{ $object.ticket-number }' went from { $trans.from.name }' to '{ $trans.to.name }'\" });\n\n# The final-supply emits the state and the object when a state is reached where there are no\n# further transitions available\n\n$workflow.final-supply.act(-> ( $state, $object) { say \"** updating performance stats with Ticket '{ $object.ticket-number }' entered State '{ $state.name }'\" });\n\n# Create an instance of the Tinky::Object.\n# A 'state' can be supplied to initialise if, for example, the data was retrieved from a database.\nmy $ticket-a = Ticket.new(owner => \"Operator A\");\n\n# Applying the workflow will set the initial state if one is configured and will\n# apply a role that provides the transition methods.\n# The workflow object can be configured to check whether the object to which it\n# is being applied is suitable and throw an exception if not.\n\n$ticket-a.apply-workflow($workflow);\n\n# Exercise the transition methods.\n# Other mechanisms are available for performing the transitions whuch may be more\n# suitable if the next state is to be calculated.\n\n# State new -> open\n$ticket-a.open;\n\n# State open -> in-progress\n$ticket-a.take;\n\n# Get the names of the states which are now available for the object\n# [stalled complete]\n$ticket-a.next-states>>.name.say;\n\n# Directly assigning the state will be validated, an exception will\n# be thrown if this is not a valid transition at the time\n$ticket-a.state = $state-stalled;\n\n# State stalled -> rejected\n# This is a final state and no further transitions are available.\n$ticket-a.reject;\n"}]},{"type":"block","id":"TIAeLsr6IDyO3HSqc1vwp","margin":"","level":2,"name":"head","location":{"start":{"line":115,"column":1,"offset":4965},"end":{"line":115,"column":15,"offset":4979}},"content":["Description"]},{"type":"para","id":"j3TY261EI579l4SftXsz5","margin":"","location":{"start":{"line":117,"column":1,"offset":4981},"end":{"line":119,"column":32,"offset":5154}},"text":"text","content":["Tinky is a deterministic state manager that can be used to implement a\nworkflow system, it provides a role ",{"type":"fcode","name":"C","content":["Tinky::Object"]}," that allows an\nobject to have a managed state."]},{"type":"para","id":"_ymLnmEQ0nzYJprGehpWd","margin":"","location":{"start":{"line":121,"column":1,"offset":5156},"end":{"line":126,"column":51,"offset":5564}},"text":"text","content":["A ",{"type":"fcode","name":"C","content":["Workflow"]}," is simply a set of ",{"type":"fcode","name":"C","content":["State"]},"s and allowable transitions\nbetween them. Validators can be defined to check whether an object should\nbe allowed to enter or leave a specific state or have a transition\nperformed, asynchronous notification of state change (enter, leave or\ntransition application,) is provided by Supplies which are available at\n",{"type":"fcode","name":"C","content":["State"]},"/",{"type":"fcode","name":"C","content":["Transition"]}," level or aggregrated."]},{"type":"para","id":"Mxvjq0Y8HJEynsCGs6UXn","margin":"","location":{"start":{"line":128,"column":1,"offset":5566},"end":{"line":133,"column":73,"offset":5992}},"text":"text","content":["I have taken somewhat of a \"kitchen-sink\" toolkit approach with this to\nprovide a somewhat rich interface that can be more easily used to create\nhigher level applications which interact nicely with Raku's reactive\nand composable nature. I've taken some ideas from similar software in\nother languages that I have used and added features that I would have\nliked for the problems that I was solving and ended up providing myself."]},{"type":"para","id":"IM9o_8r0jThRee5xjTXJE","margin":"","location":{"start":{"line":135,"column":1,"offset":5994},"end":{"line":142,"column":51,"offset":6539}},"text":"text","content":["By the way I've deliberately chosen a \"non-enterprisey\" name for this\nfor a couple of reasons, largely however because I'm not convinced that\nthis will remain the gold standard within the problem domain I don't\nwant to block out a more sensible name for someone who may want to make\nsomething later, also the possible candidates involving some variant\nof \"Workflow\" or \"state machine\" don't properly fit what I see this as\nwhich is something that has some of the features of the latter in order\nto provide a toolkit to help implement the former."]},{"type":"para","id":"TGMdQxzxLWV_nrk4pdSWT","margin":"","location":{"start":{"line":144,"column":1,"offset":6541},"end":{"line":144,"column":62,"offset":6602}},"text":"text","content":["The full documentation is available ",{"meta":"Documentation.md","type":"fcode","name":"L","content":["here"]},"."]},{"type":"block","id":"sFm5EuYkG5P_Qs5SoANat","margin":"","level":2,"name":"head","location":{"start":{"line":146,"column":1,"offset":6604},"end":{"line":146,"column":16,"offset":6619}},"content":["Installation"]},{"type":"para","id":"N4raJK7_5ZOPJsX8lrcU_","margin":"","location":{"start":{"line":148,"column":1,"offset":6621},"end":{"line":148,"column":96,"offset":6716}},"text":"text","content":["Assuming you have a working Rakudo installation you should be able to install this with ",{"type":"fcode","name":"I","content":["zef"]}," :"]},{"type":"block","id":"NPGSbOzDxQJGe8qzIAoZ9","margin":"","name":"code","config":[],"location":{"start":{"line":150,"column":1,"offset":6718},"end":{"line":156,"column":22,"offset":6821}},"content":[{"type":"verbatim","value":"# From the source directory\n\nzef install .\n\n# Remote installation\n\nzef install Tinky"}]},{"type":"block","id":"7_fVTzvVn92LIIQBgarGF","margin":"","level":2,"name":"head","location":{"start":{"line":158,"column":1,"offset":6823},"end":{"line":158,"column":11,"offset":6833}},"content":["Support"]},{"type":"para","id":"jtYW5IN9-8zOpZKiiYrmr","margin":"","location":{"start":{"line":160,"column":1,"offset":6835},"end":{"line":161,"column":68,"offset":6968}},"text":"text","content":["This is an experimental software but suggestions and patches that\nmay make it more useful in your software are welcomed via github at"]},{"type":"para","id":"qSQaiewuYRzjBPGkVN-HO","margin":"","location":{"start":{"line":163,"column":1,"offset":6970},"end":{"line":163,"column":46,"offset":7015}},"text":"text","content":[{"meta":"https://github.com/jonathanstowe/Tinky/issues","type":"fcode","name":"L","content":["https://github.com/jonathanstowe/Tinky/issues"]}]},{"type":"block","id":"BLBLjn4JkFIXcYLWHtJ3m","margin":"","level":2,"name":"head","location":{"start":{"line":166,"column":1,"offset":7018},"end":{"line":166,"column":11,"offset":7028}},"content":["Licence"]},{"type":"para","id":"Sx9cs2a9vYZ3O_EnD1D7O","margin":"","location":{"start":{"line":168,"column":1,"offset":7030},"end":{"line":168,"column":23,"offset":7052}},"text":"text","content":["This is free software."]},{"type":"para","id":"KMC5QSziNsJsG7MpmsvD5","margin":"","location":{"start":{"line":170,"column":1,"offset":7054},"end":{"line":170,"column":60,"offset":7113}},"text":"text","content":["Please see the ",{"meta":"LICENCE","type":"fcode","name":"L","content":["LICENCE"]}," file in the distribution."]},{"type":"para","id":"CopOnqwXObUCpQ06Cok2e","margin":"","location":{"start":{"line":172,"column":1,"offset":7115},"end":{"line":172,"column":29,"offset":7143}},"text":"text","content":["© Jonathan Stowe 2016 - 2021"]}]},"publishUrl":"/mods/zef/Tinky/Tinky-0.1.4/README.md","pluginsData":{"moduleInfo":{"meta":{"api":"1.0","auth":"zef:jonathanstowe","authors":["Jonathan Stowe <jns+git@gellyfish.co.uk>"],"build-depends":[],"depends":[],"description":"An Experimental Workflow / State Management toolkit","dist":"Tinky:ver<0.1.4>:auth<zef:jonathanstowe>","license":"Artistic-2.0","meta-version":"1","name":"Tinky","path":"T/IN/TINKY/0c9e517500ea9ce2745240e6ee9ca72bc33586a7.tar.gz","provides":{"Tinky":"lib/Tinky.pm"},"raku":"6.*","resources":[],"source-url":"https://github.com/jonathanstowe/Tinky.git","support":{"bugtracker":"https://github.com/jonathanstowe/Tinky/issues","email":"jns+git@gellyfish.co.uk","source":"https://github.com/jonathanstowe/Tinky.git"},"tags":["Workflow","toolkit","state machine"],"test-depends":["Test"],"version":"0.1.4"},"files":[{"file":"work_mods/zef/Tinky/Tinky-0.1.4/README.md","publishUrl":"/mods/zef/Tinky/Tinky-0.1.4/README.md"},{"file":"work_mods/zef/Tinky/Tinky-0.1.4/Documentation.md","publishUrl":"/mods/zef/Tinky/Tinky-0.1.4/Documentation.md"},{"file":"work_mods/zef/Tinky/Tinky-0.1.4/lib/Tinky.pm","publishUrl":"/mods/zef/Tinky/Tinky-0.1.4/lib/Tinky.pm"}],"src":"zef","url":"/mods/zef/Tinky"}}}
=end data


    =begin React :component<RenderItem>
    =begin data
    {"type":"page","file":"work_mods/zef/Tinky/Tinky-0.1.4/README.md","sources":[],"node":{"type":"block","id":"KxGcFbofFs3FyV7RA5345","margin":"","name":"root","content":[{"type":"block","id":"mItB_6OwhQuAuc4Zfp6F4","margin":"","level":1,"name":"head","location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":1,"column":8,"offset":7}},"content":["Tinky"]},{"type":"para","id":"zJRepH6X1Q8tCOr_7arJY","margin":"","location":{"start":{"line":3,"column":1,"offset":9},"end":{"line":3,"column":41,"offset":49}},"text":"text","content":["An experimental workflow module for Raku"]},{"type":"para","id":"XD_Ptfj971Yp1wQFBFcbC","margin":"","location":{"start":{"line":5,"column":1,"offset":51},"end":{"line":5,"column":79,"offset":129}},"text":"text","content":[{"type":"block","id":"_wRSaCftXkmrRjVb-EKm9","margin":"","name":"Image","config":[],"location":{"start":{"line":5,"column":1,"offset":51},"end":{"line":5,"column":79,"offset":129}},"content":[{"type":"image","src":"https://github.com/jonathanstowe/Tinky/workflows/CI/badge.svg","alt":"Build Status"}]}]},{"type":"block","id":"CzS57EbdLBTmj__JZtkoV","margin":"","level":2,"name":"head","location":{"start":{"line":7,"column":1,"offset":131},"end":{"line":7,"column":12,"offset":142}},"content":["Synopsis"]},{"type":"para","id":"wY3xUglIdOOBVIc90xcGQ","margin":"","location":{"start":{"line":9,"column":1,"offset":144},"end":{"line":9,"column":81,"offset":224}},"text":"text","content":["This is quite long ",{"meta":"#description","type":"fcode","name":"L","content":["skip to the Description"]}," if you are impatient."]},{"type":"block","id":"UfeGZLQG5yeeTeVn_Jdf6","margin":"","name":"code","config":[{"name":"lang","value":"raku","type":"string"}],"location":{"start":{"line":11,"column":1,"offset":226},"end":{"line":113,"column":4,"offset":4963}},"content":[{"type":"verbatim","value":"\nuse Tinky;\n\n\n# A class that will use the workflow\n# it can have any attributes or methods\n# required by your application\n\nclass Ticket does Tinky::Object {\n    has Str $.ticket-number = (^100000).pick.fmt(\"%08d\");\n    has Str $.owner;\n}\n\n# Set up some states as required by the application\nmy $state-new         = Tinky::State.new(name => 'new');\nmy $state-open        = Tinky::State.new(name => 'open');\nmy $state-rejected    = Tinky::State.new(name => 'rejected');\nmy $state-in-progress = Tinky::State.new(name => 'in-progress');\nmy $state-stalled     = Tinky::State.new(name => 'stalled');\nmy $state-complete    = Tinky::State.new(name => 'complete');\n\n# Each state has an 'enter-supply' and a 'leave-supply' which get the\n# object which the state was applied to.\n\n$state-rejected.enter-supply.act( -> $object { say \"** sending rejected e-mail for Ticket '{ $object.ticket-number }' **\"});\n\n# Create some transitions to describe pre-determined change of state\n# A method will be created on the Tinky::Object for each transition name\n\nmy $open              = Tinky::Transition.new(name => 'open', from => $state-new, to => $state-open);\n\n# Where  more than one transition has the same name, the transition which matches the object's \n# current state will be use.\nmy $reject-new        = Tinky::Transition.new(name => 'reject', from => $state-new, to => $state-rejected);\nmy $reject-open       = Tinky::Transition.new(name => 'reject', from => $state-open, to => $state-rejected);\nmy $reject-stalled    = Tinky::Transition.new(name => 'reject', from => $state-stalled, to => $state-rejected);\n\nmy $stall-open        = Tinky::Transition.new(name => 'stall', from => $state-open, to => $state-stalled);\nmy $stall-progress    = Tinky::Transition.new(name => 'stall', from => $state-in-progress, to => $state-stalled);\n\n# The transition supply allows specific logic for the transition to be performed\n\n$stall-progress.supply.act( -> $object { say \"** rescheduling tickets for '{ $object.owner }' on ticket stall **\"});\n\nmy $unstall           = Tinky::Transition.new(name => 'unstall', from => $state-stalled, to => $state-in-progress);\n\nmy $take              = Tinky::Transition.new(name => 'take', from => $state-open, to => $state-in-progress);\n\nmy $complete-open     = Tinky::Transition.new(name => 'complete', from => $state-open, to => $state-complete);\nmy $complete-progress = Tinky::Transition.new(name => 'complete', from => $state-in-progress, to => $state-complete);\n\nmy @transitions = $open, $reject-new, $reject-open, $reject-stalled, $stall-open, $stall-progress, $unstall, $take, $complete-open, $complete-progress;\n\n# The Workflow object allows the relation between states and transitions to be calculate\n# and generates the methods that will be applied to the ticket object.  The initial-state\n# will be applied to the object if there is no existing state on the state.\nmy $workflow = Tinky::Workflow.new(:@transitions, name => 'ticket-workflow', initial-state => $state-new );\n\n# The workflow aggregates the Supplies of the transitions and the states.\n# This could be to a logging subsystem for instance. \n\n$workflow.transition-supply.act(-> ($trans, $object) { say \"Ticket '{ $object.ticket-number }' went from { $trans.from.name }' to '{ $trans.to.name }'\" });\n\n# The final-supply emits the state and the object when a state is reached where there are no\n# further transitions available\n\n$workflow.final-supply.act(-> ( $state, $object) { say \"** updating performance stats with Ticket '{ $object.ticket-number }' entered State '{ $state.name }'\" });\n\n# Create an instance of the Tinky::Object.\n# A 'state' can be supplied to initialise if, for example, the data was retrieved from a database.\nmy $ticket-a = Ticket.new(owner => \"Operator A\");\n\n# Applying the workflow will set the initial state if one is configured and will\n# apply a role that provides the transition methods.\n# The workflow object can be configured to check whether the object to which it\n# is being applied is suitable and throw an exception if not.\n\n$ticket-a.apply-workflow($workflow);\n\n# Exercise the transition methods.\n# Other mechanisms are available for performing the transitions whuch may be more\n# suitable if the next state is to be calculated.\n\n# State new -> open\n$ticket-a.open;\n\n# State open -> in-progress\n$ticket-a.take;\n\n# Get the names of the states which are now available for the object\n# [stalled complete]\n$ticket-a.next-states>>.name.say;\n\n# Directly assigning the state will be validated, an exception will\n# be thrown if this is not a valid transition at the time\n$ticket-a.state = $state-stalled;\n\n# State stalled -> rejected\n# This is a final state and no further transitions are available.\n$ticket-a.reject;\n"}]},{"type":"block","id":"TIAeLsr6IDyO3HSqc1vwp","margin":"","level":2,"name":"head","location":{"start":{"line":115,"column":1,"offset":4965},"end":{"line":115,"column":15,"offset":4979}},"content":["Description"]},{"type":"para","id":"j3TY261EI579l4SftXsz5","margin":"","location":{"start":{"line":117,"column":1,"offset":4981},"end":{"line":119,"column":32,"offset":5154}},"text":"text","content":["Tinky is a deterministic state manager that can be used to implement a\nworkflow system, it provides a role ",{"type":"fcode","name":"C","content":["Tinky::Object"]}," that allows an\nobject to have a managed state."]},{"type":"para","id":"_ymLnmEQ0nzYJprGehpWd","margin":"","location":{"start":{"line":121,"column":1,"offset":5156},"end":{"line":126,"column":51,"offset":5564}},"text":"text","content":["A ",{"type":"fcode","name":"C","content":["Workflow"]}," is simply a set of ",{"type":"fcode","name":"C","content":["State"]},"s and allowable transitions\nbetween them. Validators can be defined to check whether an object should\nbe allowed to enter or leave a specific state or have a transition\nperformed, asynchronous notification of state change (enter, leave or\ntransition application,) is provided by Supplies which are available at\n",{"type":"fcode","name":"C","content":["State"]},"/",{"type":"fcode","name":"C","content":["Transition"]}," level or aggregrated."]},{"type":"para","id":"Mxvjq0Y8HJEynsCGs6UXn","margin":"","location":{"start":{"line":128,"column":1,"offset":5566},"end":{"line":133,"column":73,"offset":5992}},"text":"text","content":["I have taken somewhat of a \"kitchen-sink\" toolkit approach with this to\nprovide a somewhat rich interface that can be more easily used to create\nhigher level applications which interact nicely with Raku's reactive\nand composable nature. I've taken some ideas from similar software in\nother languages that I have used and added features that I would have\nliked for the problems that I was solving and ended up providing myself."]},{"type":"para","id":"IM9o_8r0jThRee5xjTXJE","margin":"","location":{"start":{"line":135,"column":1,"offset":5994},"end":{"line":142,"column":51,"offset":6539}},"text":"text","content":["By the way I've deliberately chosen a \"non-enterprisey\" name for this\nfor a couple of reasons, largely however because I'm not convinced that\nthis will remain the gold standard within the problem domain I don't\nwant to block out a more sensible name for someone who may want to make\nsomething later, also the possible candidates involving some variant\nof \"Workflow\" or \"state machine\" don't properly fit what I see this as\nwhich is something that has some of the features of the latter in order\nto provide a toolkit to help implement the former."]},{"type":"para","id":"TGMdQxzxLWV_nrk4pdSWT","margin":"","location":{"start":{"line":144,"column":1,"offset":6541},"end":{"line":144,"column":62,"offset":6602}},"text":"text","content":["The full documentation is available ",{"meta":"Documentation.md","type":"fcode","name":"L","content":["here"]},"."]},{"type":"block","id":"sFm5EuYkG5P_Qs5SoANat","margin":"","level":2,"name":"head","location":{"start":{"line":146,"column":1,"offset":6604},"end":{"line":146,"column":16,"offset":6619}},"content":["Installation"]},{"type":"para","id":"N4raJK7_5ZOPJsX8lrcU_","margin":"","location":{"start":{"line":148,"column":1,"offset":6621},"end":{"line":148,"column":96,"offset":6716}},"text":"text","content":["Assuming you have a working Rakudo installation you should be able to install this with ",{"type":"fcode","name":"I","content":["zef"]}," :"]},{"type":"block","id":"NPGSbOzDxQJGe8qzIAoZ9","margin":"","name":"code","config":[],"location":{"start":{"line":150,"column":1,"offset":6718},"end":{"line":156,"column":22,"offset":6821}},"content":[{"type":"verbatim","value":"# From the source directory\n\nzef install .\n\n# Remote installation\n\nzef install Tinky"}]},{"type":"block","id":"7_fVTzvVn92LIIQBgarGF","margin":"","level":2,"name":"head","location":{"start":{"line":158,"column":1,"offset":6823},"end":{"line":158,"column":11,"offset":6833}},"content":["Support"]},{"type":"para","id":"jtYW5IN9-8zOpZKiiYrmr","margin":"","location":{"start":{"line":160,"column":1,"offset":6835},"end":{"line":161,"column":68,"offset":6968}},"text":"text","content":["This is an experimental software but suggestions and patches that\nmay make it more useful in your software are welcomed via github at"]},{"type":"para","id":"qSQaiewuYRzjBPGkVN-HO","margin":"","location":{"start":{"line":163,"column":1,"offset":6970},"end":{"line":163,"column":46,"offset":7015}},"text":"text","content":[{"meta":"https://github.com/jonathanstowe/Tinky/issues","type":"fcode","name":"L","content":["https://github.com/jonathanstowe/Tinky/issues"]}]},{"type":"block","id":"BLBLjn4JkFIXcYLWHtJ3m","margin":"","level":2,"name":"head","location":{"start":{"line":166,"column":1,"offset":7018},"end":{"line":166,"column":11,"offset":7028}},"content":["Licence"]},{"type":"para","id":"Sx9cs2a9vYZ3O_EnD1D7O","margin":"","location":{"start":{"line":168,"column":1,"offset":7030},"end":{"line":168,"column":23,"offset":7052}},"text":"text","content":["This is free software."]},{"type":"para","id":"KMC5QSziNsJsG7MpmsvD5","margin":"","location":{"start":{"line":170,"column":1,"offset":7054},"end":{"line":170,"column":60,"offset":7113}},"text":"text","content":["Please see the ",{"meta":"LICENCE","type":"fcode","name":"L","content":["LICENCE"]}," file in the distribution."]},{"type":"para","id":"CopOnqwXObUCpQ06Cok2e","margin":"","location":{"start":{"line":172,"column":1,"offset":7115},"end":{"line":172,"column":29,"offset":7143}},"text":"text","content":["© Jonathan Stowe 2016 - 2021"]}]},"publishUrl":"/mods/zef/Tinky/Tinky-0.1.4/README.md","pluginsData":{"moduleInfo":{"meta":{"api":"1.0","auth":"zef:jonathanstowe","authors":["Jonathan Stowe <jns+git@gellyfish.co.uk>"],"build-depends":[],"depends":[],"description":"An Experimental Workflow / State Management toolkit","dist":"Tinky:ver<0.1.4>:auth<zef:jonathanstowe>","license":"Artistic-2.0","meta-version":"1","name":"Tinky","path":"T/IN/TINKY/0c9e517500ea9ce2745240e6ee9ca72bc33586a7.tar.gz","provides":{"Tinky":"lib/Tinky.pm"},"raku":"6.*","resources":[],"source-url":"https://github.com/jonathanstowe/Tinky.git","support":{"bugtracker":"https://github.com/jonathanstowe/Tinky/issues","email":"jns+git@gellyfish.co.uk","source":"https://github.com/jonathanstowe/Tinky.git"},"tags":["Workflow","toolkit","state machine"],"test-depends":["Test"],"version":"0.1.4"},"files":[{"file":"work_mods/zef/Tinky/Tinky-0.1.4/README.md","publishUrl":"/mods/zef/Tinky/Tinky-0.1.4/README.md"},{"file":"work_mods/zef/Tinky/Tinky-0.1.4/Documentation.md","publishUrl":"/mods/zef/Tinky/Tinky-0.1.4/Documentation.md"},{"file":"work_mods/zef/Tinky/Tinky-0.1.4/lib/Tinky.pm","publishUrl":"/mods/zef/Tinky/Tinky-0.1.4/lib/Tinky.pm"}],"src":"zef","url":"/mods/zef/Tinky"}}}
    =end data
    =end React


Tinky


The Raku Knowledge Base


=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<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=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>

=item1 B<Resources>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>

=end nested
=begin nested :!nested

=item1 B<Resoures>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=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/>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=end React


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


TinyFloats

NAME

SYNOPSIS

DESCRIPTION

AUTHOR

COPYRIGHT AND LICENSE

TinyFloats v0.0.1

Authors

License

Dependencies

Test Dependencies

Provides

Documentation