para

use v6.d;
use JSON::Fast;
use Syndicate::Feed;
use Syndicate::JSONFeed::Item;
use Syndicate::Utils;
use Syndicate::Stats;

my constant JSONFEED-VERSION       is export = 'https://jsonfeed.org/version/1.1';
our constant JSONFEED-VERSION-PREFIX is export = 'https://jsonfeed.org/version/';

sub str-field(%h, Str $name --> Str) {
    my $v = %h{$name}:exists ?? %h{$name} // Str !! Str;
    die "JSON Feed '$name' must be a string, got {$v.^name}" unless $v ~~ Str;
    $v
}

unit class Syndicate::JSONFeed:ver<0.0.6>:auth<zef:sasha> does Syndicate::Feed;

has Str $.version = JSONFEED-VERSION;
has Str $.feed_url;
has Str $.user_comment;
has Str $.next_url;
has Str $.icon;
has Str $.favicon;
has %.author of Str;
has Bool $.expired;
has Hash $!cached-hash;
has $!cached-items;
has Lock $!hash-lock = Lock.new;
has Str $!cached-json;
has Lock $!json-lock = Lock.new;

multi method new(Str $json) {
    my %h;
    my $ok = try { %h = from-json($json); True };
    unless $ok {
        Syndicate::Stats.record-error;
        die "Invalid JSON: $!";
    }
    self.new-from-hash(%h)
}

multi method new-from-hash(%h) {
    with-error-recording {
        my $version = %h<version> // JSONFEED-VERSION;
        die "JSON Feed 'version' must be a string, got {$version.^name}"
            unless $version ~~ Str;
        die "Invalid JSON Feed version: $version"
            unless $version.starts-with(JSONFEED-VERSION-PREFIX) && $version.chars > JSONFEED-VERSION-PREFIX.chars;
        my $title       = str-field(%h, 'title');
        die "JSON Feed requires title" unless $title.defined && $title.chars;
        my $link        = str-field(%h, 'home_page_url');
        my $desc        = str-field(%h, 'description');
        my $gen         = str-field(%h, 'generator');

        my %author;
        if %h<author> ~~ Hash {
            with %h<author> {
                %author<name>   = .<name> // Str;
                %author<url>    = .<url> // Str;
                %author<avatar> = .<avatar> // Str;
            }
        } elsif %h<author>.defined {
            die "JSON Feed 'author' must be a Hash, got {%h<author>.^name}";
        }

        my @items;
        die "JSON Feed requires 'items' key" unless %h<items>:exists;
        die "JSON Feed 'items' must be an array" unless %h<items> ~~ Array;
        for @(%h<items>) -> $item-data {
            die "JSON Feed 'items' must contain objects, got: {$item-data.^name}" unless $item-data ~~ Hash;
            @items.push: Syndicate::JSONFeed::Item.new-from-hash(%$item-data);
        }

        my $locale = str-field(%h, 'locale');
        my $lang   = $locale.defined ?? $locale !! str-field(%h, 'language');
        my %bless = :$version, :$title, :$link, :description($desc),
            :generator($gen),
            :feed_url(str-field(%h, 'feed_url')),
            :user_comment(str-field(%h, 'user_comment')),
            :next_url(str-field(%h, 'next_url')),
            :icon(str-field(%h, 'icon')),
            :favicon(str-field(%h, 'favicon')),
            :author(%author),
            :language($lang);
        if %h<expired>:exists {
            die "JSON Feed 'expired' must be a Bool, got {%h<expired>.^name}"
                unless %h<expired> ~~ Bool;
            %bless<expired> = %h<expired>;
        }
        self.bless(|%bless, :@items)
    }
}

method to-hash(:$clone = True) {
    $!hash-lock.protect: {
        # Feed-level metadata is cached; the result returned to callers is a
        # shallow copy with the author hash rebuilt. Items are regenerated per
        # call (see below), so callers cannot mutate cache state.
        $!cached-hash //= do {
            my %h;
            %h<version>       = $.version;
            %h<title>         = $.title         if $.title.defined;
            %h<home_page_url> = $.link          if $.link.defined;
            %h<feed_url>      = $.feed_url      if $.feed_url.defined;
            %h<description>   = $.description   if $.description.defined;
            %h<user_comment>  = $.user_comment  if $.user_comment.defined;
            %h<next_url>      = $.next_url      if $.next_url.defined;
            %h<icon>          = $.icon          if $.icon.defined;
            %h<favicon>       = $.favicon       if $.favicon.defined;
            %h<locale>        = $.language      if $.language.defined;
            %h<generator>     = $.generator     if $.generator.defined;
            %h<expired>       = $.expired       if $.expired.defined;

            if %.author<name>.defined || %.author<url>.defined || %.author<avatar>.defined {
                my %a;
                %a<name>   = %.author<name>   if %.author<name>.defined;
                %a<url>    = %.author<url>    if %.author<url>.defined;
                %a<avatar> = %.author<avatar> if %.author<avatar>.defined;
                %h<author> = %a;
            }

            %h
        }
        my %h = %($!cached-hash);
        if %h<author>:exists {
            my %a;
            %a{$_} = %h<author>{$_} for %h<author>.keys;
            %h<author> = %a;
        }
        # Item hashes are cached once and cloned on every call: JSONFeed::Item
        # hashes contain nested containers (authors, tags), and cloning cached
        # hashes is cheaper than rebuilding them and guarantees callers cannot
        # mutate cache state. :!clone opts out of the O(items) copy for hot paths.
        $!cached-items //= @.items.map(*.to-hash).Array;
        %h<items> = $clone
            ?? $!cached-items.map({ self!clone-item-hash($_) }).Array
            !! $!cached-items;
        %h
    }
}

method !clone-item-hash(%h --> Hash) {
    my %c;
    for %h.kv -> $k, $v {
        given $v {
            when Array {
                %c{$k} = $v.map({ $_ ~~ Hash ?? $_.clone !! $_ }).Array;
            }
            when Hash { %c{$k} = $v.clone }
            default   { %c{$k} = $v }
        }
    }
    %c
}

method to-json {
    $!json-lock.protect: { $!cached-json //= to-json $.to-hash }
}

method Str { $.to-json }



head

code

=begin code :lang<raku>
my $feed = Syndicate::JSONFeed.new($json-string);
my $feed = Syndicate::JSONFeed.new(:title("My Feed"), :feed_url("..."), ...);
say $feed.to-json;
my %h = $feed.to-hash;
=end code


Parses and generates JSON Feed 1.1. Does L<C<Syndicate::Feed>|rakudoc:Syndicate::Feed>.


B<Note:> When constructed from a hash, a missing C<version> is defaulted to
C<https://jsonfeed.org/version/1.1>. Auto-detection in L<C<Syndicate::Parse>|rakudoc:Syndicate::Parse>
is deliberately stricter — it only treats input as a JSON Feed when a C<version>
starting with C<https://jsonfeed.org/version/> is present, so that arbitrary JSON
documents are not mistaken for feeds.


item

root

Parse

Item

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


JSONFeed

NAME

SYNOPSIS

DESCRIPTION

ATTRIBUTES

Syndicate v0.0.6

Authors

License

Dependencies

Test Dependencies

Provides

Documentation