PHP 8-only Support, New Features (v4) (spatie#153)

* add 'content-type' config option to allow customization of the content-type for the feed response

* add jsonfeed.org support

* add test for jsonfeed.org support, update test snapshots

* sync config/misc files with spatie/package-skeleton-laravel where possible

* drop php 7 support; add support for parallel testing; bump phpunit version to 9.5

* update php-cs-fixer config

* update readme

* escape quotes for content/summary fields

* add support for feed images

* add configuration option for specifying the feed type (atom, rss. or json)

* add owner feed object prop, timestamp() method for generating correct timestamps based on the feed format

* ensure that generated rss, atom and json feeds can pass w3c validation

* add helper class for determining content types for feeds; use helper class to determine response content type

* add `image` attribute to FeedItem (json feeds only); remove `Feed::author` attribute and add `Feed::authorName` and `Feed::authorEmail` attributes; add test for response content type; update tests/snapshots

* update readme, wip

* use hasViewComposer() instead of separate methods for registering the view composer; code cleanup

* remove unused import

* add configuration file validation

* wip

* add config validator tests; update test snapshots

* support tuple syntax for items configuration key

* wip

* update readme, description of items key in config

* make config validation and tests more robust

* wip

* rename `jsonfeed` view to `json`

* use PHP 8 syntax where possible

* remove feed::feed view

* default to feed::atom view instead of feed::feed

* add support for caching feed items

* rename kebab-case config keys to camelCase

* wip

* use php 8 syntax, code cleanup

* add version upgrade guide

* validate cacheTtl config option

* revert item cache commits

* fix feed item resolver and tests

* update docs on how to correctly pass arguments to the `items` method

* use PHPUnit 9.5.4; bump laravel-package-tools version to v1.9

* update changelog

* remove parallel testing, use PHPUnit 9.4 to avoid issues with v9.5

Author: patinthehat

.editorconfig

@@ -1,6 +1,3 @@
-; This file is for unifying the coding style for different editors and IDEs.
-; More information at http://editorconfig.org
-
 root = true
 
 [*]
@@ -13,3 +10,6 @@ trim_trailing_whitespace = true
 
 [*.md]
 trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_size = 2

.gitattributes

@@ -2,9 +2,13 @@
 # https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
 
 # Ignore all test and documentation with "export-ignore".
+/.github            export-ignore
 /.gitattributes     export-ignore
 /.gitignore         export-ignore
-/.travis.yml        export-ignore
 /phpunit.xml.dist   export-ignore
-/.scrutinizer.yml   export-ignore
 /tests              export-ignore
+/.editorconfig      export-ignore
+/.php_cs.dist       export-ignore
+/psalm.xml          export-ignore
+/psalm.xml.dist     export-ignore
+/testbench.yaml     export-ignore

.github/CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**.
+
+Please read and understand the contribution guide before creating an issue or pull request.
+
+## Etiquette
+
+This project is open source, and as such, the maintainers give their free time to build and maintain the source code
+held within. They make the code freely available in the hope that it will be of use to other developers. It would be
+extremely unfair for them to suffer abuse or anger for their hard work.
+
+Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
+world that developers are civilized and selfless people.
+
+It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
+quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
+
+## Viability
+
+When requesting or submitting new features, first consider whether it might be useful to others. Open
+source projects are used by many developers, who may have entirely different needs to your own. Think about
+whether or not your feature is likely to be used by other users of the project.
+
+## Procedure
+
+Before filing an issue:
+
+- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
+- Check to make sure your feature suggestion isn't already present within the project.
+- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
+- Check the pull requests tab to ensure that the feature isn't already in progress.
+
+Before submitting a pull request:
+
+- Check the codebase to ensure that your feature doesn't already exist.
+- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
+
+## Requirements
+
+If the project maintainer has any additional requirements, you will find them listed here.
+
+- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://pear.php.net/package/PHP_CodeSniffer).
+
+- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+
+**Happy coding**!

.github/FUNDING.yml

@@ -1 +1,2 @@
 github: spatie
+custom: https://spatie.be/open-source/support-us

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+    - name: Ask a question
+      url: https://github.com/spatie/laravel-feed/discussions/new?category=q-a
+      about: Ask the community for help
+    - name: Request a feature
+      url: https://github.com/spatie/laravel-feed/discussions/new?category=ideas
+      about: Share ideas for new features
+    - name: Report a bug
+      url: https://github.com/spatie/laravel-feed/issues/new
+      about: Report a reproducable bug

.github/SECURITY.md

@@ -0,0 +1,3 @@
+# Security Policy
+
+If you discover any security related issues, please email [email protected] instead of using the issue tracker.

.github/workflows/php-cs-fixer.yml

@@ -13,7 +13,7 @@ jobs:
             -   name: Fix style
                 uses: docker://oskarstark/php-cs-fixer-ga
                 with:
-                    args: --config=.php_cs --allow-risky=yes
+                    args: --config=.php_cs.dist --allow-risky=yes
 
             -   name: Extract branch name
                 shell: bash

.github/workflows/run-tests.yml

@@ -9,7 +9,7 @@ jobs:
             fail-fast: false
             matrix:
                 os: [ubuntu-latest]
-                php: [7.4, 8.0]
+                php: [8.0]
                 laravel: [7.*, 8.*]
                 dependency-version: [prefer-lowest, prefer-stable]
                 include:

.gitignore

@@ -1,5 +1,12 @@
+.idea
+.php_cs
+.php_cs.cache
+.phpunit.result.cache
 build
 composer.lock
+coverage
 docs
+phpunit.xml
+psalm.xml
+testbench.yaml
 vendor
-.php_cs.cache

.php_cs renamed to .php_cs.dist

@@ -3,7 +3,6 @@
 $finder = Symfony\Component\Finder\Finder::create()
     ->notPath('bootstrap/*')
     ->notPath('storage/*')
-    ->notPath('storage/*')
     ->notPath('resources/view/mail/*')
     ->in([
         __DIR__ . '/src',
@@ -30,9 +29,15 @@ return PhpCsFixer\Config::create()
         ],
         'phpdoc_single_line_var_spacing' => true,
         'phpdoc_var_without_name' => true,
+        'class_attributes_separation' => [
+            'elements' => [
+                'method',
+            ],
+        ],
         'method_argument_space' => [
             'on_multiline' => 'ensure_fully_multiline',
             'keep_multiple_spaces_after_comma' => true,
-        ]
+        ],
+        'single_trait_insert_per_statement' => true,
     ])
     ->setFinder($finder);

CHANGELOG.md

@@ -2,6 +2,34 @@
 
 All notable changes to `laravel-feed` will be documented in this file
 
+## 4.0.0 - unreleased
+
+- adds support for PHP 8 only.
+- drops PHP 7 support.
+- uses PHP 8 syntax where possible.
+- bumps `PHPUnit` to v9.5.
+- adds support for running tests in parallel.
+- updates the readme to include the new API & configuration settings.
+- adds an `UPGRADING.md` guide to help users manually upgrade package versions.
+- adds support for json feeds _(`jsonfeed.org` support)_.
+- removes `FeedItem::author`.  _Use `FeedItem::authorName` and `FeedItem::authorEmail` instead._
+- removes the `feed::feed` view.  _Use `feed::atom`, `feed::json`, `feed:rss` or a custom view instead._
+- adds support for `FeedItem::image` _(json feeds only)_.
+- adds validation of the configuration file.
+- adds support for tuple notation in the `items` configuration key.
+- adds feed config option `format` to specify the type of feed that is generated _(`rss`, `atom`, or `json`)_.
+- adds feed config option `contentType` to force the content type of the feed response.
+- adds feed config option `image` which associates an image with the overall feed.
+- changes feed config option `type` default value to an empty string _(value is now auto detected by default)_.
+- changes feed config option `view` so that it is now required to be an existing view.
+- config option `view` no longer defaults to `feed::feed` when it contains an empty value _(now defaults to `feed::atom`)._
+- generated rss and atom feeds now pass w3c validation (#152).
+
+This release contains Breaking Changes:
+- `FeedItem::author` has been replaced with `authorName` and `authorEmail` _(optional)_.
+- Several new configuration options are required (see above).
+- The value of the configuration option `view` must be an existing view _(empty values/non-existent views now throw an Exception)_.
+
 ## 3.2.1 - 2021-05-27
 
 - fix breaking change introduced in 3.1.4

CONTRIBUTING.md

@@ -5,7 +5,7 @@
 ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/spatie/laravel-feed/run-tests?label=tests)
 [![Total Downloads](https://img.shields.io/packagist/dt/spatie/laravel-feed.svg?style=flat-square)](https://packagist.org/packages/spatie/laravel-feed)
 
-This package provides an easy way to generate [RSS feeds](http://www.whatisrss.com/). There's almost no coding required on your part. Just follow the installation instructions update your config file and you're good to go.
+This package provides an easy way to generate a feed for your Laravel application.  Supported formats are [RSS](http://www.whatisrss.com/), [Atom](https://en.wikipedia.org/wiki/Atom_(standard)), and [JSON](https://jsonfeed.org). There's almost no coding required on your part. Just follow the installation instructions, update your config file, and you're good to go.
 
 Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects [on our website](https://spatie.be/opensource).
 
@@ -50,9 +50,13 @@ return [
              * Here you can specify which class and method will return
              * the items that should appear in the feed. For example:
              * 'App\Model@getAllFeedItems'
+             * or
+             * ['App\Model', 'getAllFeedItems']
              *
-             * You can also pass an argument to that method:
-             * ['App\Model@getAllFeedItems', 'argument']
+             * You can also pass an argument to that method.  Note that their key must be the name of the parameter:             * 
+             * ['App\Model@getAllFeedItems', 'parameterName' => 'argument']
+             * or
+             * ['App\Model', 'getAllFeedItems', 'parameterName' => 'argument']
              */
             'items' => '',
 
@@ -65,10 +69,34 @@ return [
             'description' => 'The description of the feed.',
             'language' => 'en-US',
 
+            /*
+             * The image to display for the feed.  For Atom feeds, this is displayed as
+             * a banner/logo; for RSS and JSON feeds, it's displayed as an icon.
+             * An empty value omits the image attribute from the feed.
+             */
+            'image' => '',
+
+            /*
+             * The format of the feed.  Acceptable values are 'rss', 'atom', or 'json'.
+             */
+            'format' => 'atom',
+
             /*
              * The view that will render the feed.
              */
-            'view' => 'feed::feed',
+            'view' => 'feed::atom',
+
+            /*
+             * The type to be used in the <link> tag.  Set to an empty string to automatically
+             * determine the correct value.
+             */
+            'type' => '',
+
+            /*
+             * The content type for the feed response.  Set to an empty string to automatically
+             * determine the correct value.
+             */
+            'contentType' => '',
         ],
     ],
 ];
@@ -103,7 +131,8 @@ class NewsItem extends Model implements Feedable
             ->summary($this->summary)
             ->updated($this->updated_at)
             ->link($this->link)
-            ->author($this->author);
+            ->authorName($this->author)
+            ->authorEmail($this->authorEmail);
     }
 }
 ```
@@ -127,7 +156,7 @@ class NewsItem extends Model implements Feedable
             'summary' => $this->summary,
             'updated' => $this->updated_at,
             'link' => $this->link,
-            'author' => $this->author,
+            'authorName' => $this->authorName,
         ]);
     }
 }
@@ -158,7 +187,14 @@ return [
             /*
              * Here you can specify which class and method will return
              * the items that should appear in the feed. For example:
-             * '\App\Model@getAllFeedItems'
+             * 'App\Model@getAllFeedItems'
+             * or
+             * ['App\Model', 'getAllFeedItems']
+             *
+             * You can also pass an argument to that method.  Note that their key must be the name of the parameter:             * 
+             * ['App\Model@getAllFeedItems', 'parameterName' => 'argument']
+             * or
+             * ['App\Model', 'getAllFeedItems', 'parameterName' => 'argument']
              */
             'items' => 'App\NewsItem@getFeedItems',
 
@@ -169,6 +205,11 @@ return [
 
             'title' => 'All newsitems on mysite.com',
 
+            /*
+             * The format of the feed.  Acceptable values are 'rss', 'atom', or 'json'.
+             */
+            'format' => 'atom',
+
             /*
              * Custom view for the items.
              *
@@ -202,12 +243,17 @@ return [
 
     'feeds' => [
         'news' => [
-            'items' => 'App\NewsItem@getFeedItems',
+            'items' => ['App\NewsItem', 'getFeedItems'],
 
             'url' => '/feed',
 
             'title' => 'All newsitems on mysite.com',
 
+            /*
+             * The format of the feed.  Acceptable values are 'rss', 'atom', or 'json'.
+             */
+            'format' => 'atom',
+            
             /*
              * Custom view for the items.
              *
@@ -240,23 +286,23 @@ As an alternative you can use this blade component:
 <x-feed-links />
 ```
 
-## Changelog
-
-Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
-
 ## Testing
 
-``` bash
+```bash
 composer test
 ```
 
+## Changelog
+
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+
 ## Contributing
 
-Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
 
-## Security
+## Security Vulnerabilities
 
-If you discover any security related issues, please email [email protected] instead of using the issue tracker.
+Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
 
 ## Credits