RSS_File_ItemTest.php

<?php declare(strict_types=1);

use PHPUnit\Framework\TestCase;

class RSS_File_ItemTest extends RSS_ItemTest
{
    public static function setUpBeforeClass(): void
    {
        RSS_File_Item::$FILES_URL = 'http://www.example.com/mp3/';
        RSS_File_Item::$FILES_DIR = getcwd();
    }


    public function getDefaultType()
    {
        return 'application/octet-stream';
    }

    protected $filename;
    protected $filename_base;
    protected $default_title_from_file;

    public function newRSSItem()
    {
        return new RSS_File_Item($this->filename);
    }

    public function getDefaultTitle()
    {
        return $this->default_title_from_file;
    }

    public function getDefaultSubtitle()
    {
        return '';
    }

    public function setUp(): void
    {
        // most common case for tests in this file.
        $this->filename = 'example.mp3';
        $this->filename_base = 'example';
        $this->default_title_from_file = 'example.mp3';
        parent::setUp();
    }

    public function test_constructor_sets_default_properties_from_filename()
    {
        $item = $this->newRSSItem();
        $this->assertEquals('example.mp3', $item->getFilename());
        $this->assertEquals($this->getDefaultTitle(), $item->getTitle());
        $this->assertEquals('http://www.example.com/mp3/example.mp3', $item->getLink());
        $this->assertEquals($this->getDefaultType(), $item->getType());
    }

    public function test_filename_with_full_path()
    {
        $this->filename = getcwd() . '/example.mp3';
        $item = $this->newRSSItem();
        $this->assertEquals(getcwd() . '/example.mp3', $item->getFilename());
        $this->assertEquals('http://www.example.com/mp3/example.mp3', $item->getLink());
    }

    public function test_filename_without_extension()
    {
        $this->filename = 'example';
        $this->default_title_from_file = 'example';
        $item = $this->newRSSItem();
        $this->assertEquals('example', $item->getFilename());
        $this->assertEquals('http://www.example.com/mp3/example', $item->getLink());
    }

    public function test_filename_with_full_path_without_extension()
    {
        $this->filename = getcwd() . '/example';
        $this->default_title_from_file = 'example';
        $item = $this->newRSSItem();
        $this->assertEquals(getcwd() . '/example', $item->getFilename());
        $this->assertEquals('http://www.example.com/mp3/example', $item->getLink());
    }

    // test image png
    public function test_png_image_from_filesystem() {
        touch('example.png');
        $item = $this->newRSSItem();
        $this->assertEquals('http://www.example.com/mp3/example.png', $item->getImage());
        unlink('example.png');
    }

    // test image png no extension
    public function test_png_image_from_filesystem_no_extension() {
        $this->filename = 'example';
        $this->default_title_from_file = 'example';
        touch('example.png');
        $item = $this->newRSSItem();
        $this->assertEquals('http://www.example.com/mp3/example.png', $item->getImage());
        unlink('example.png');
    }

    // test image png dot only
    public function test_png_image_from_filesystem_dot_only() {
        $this->filename = 'example.';
        $this->default_title_from_file = 'example.';
        touch('example.png');
        $item = $this->newRSSItem();
        $this->assertEquals('http://www.example.com/mp3/example.png', $item->getImage());
        unlink('example.png');
    }

    // test image jpg
    public function test_jpg_image_from_filesystem() {
        touch('example.jpg');
        $item = $this->newRSSItem();
        $this->assertEquals('http://www.example.com/mp3/example.jpg', $item->getImage());
        unlink('example.jpg');
    }

    // test image jpg no extension
    public function test_jpg_image_from_filesystem_no_extension() {
        $this->filename = 'example';
        $this->default_title_from_file = 'example';
        touch('example.jpg');
        $item = $this->newRSSItem();
        $this->assertEquals('http://www.example.com/mp3/example.jpg', $item->getImage());
        unlink('example.jpg');
    }

    // test image jpg dot only
    public function test_jpg_image_from_filesystem_dot_only() {
        $this->filename = 'example.';
        $this->default_title_from_file = 'example.';
        touch('example.jpg');
        $item = $this->newRSSItem();
        $this->assertEquals('http://www.example.com/mp3/example.jpg', $item->getImage());
        unlink('example.jpg');
    }

    // test summary default
    public function test_summary_default() {
        $item = $this->newRSSItem();
        $this->assertEquals('', $item->getSummary());
    }

    // test summary override
    public function test_summary_override() {
        file_put_contents('example.txt', 'WRONG');
        $item = $this->newRSSItem();
        $item->setSummary('RIGHT');
        $this->assertEquals('RIGHT', $item->getSummary());
        unlink('example.txt');
    }

    // test summary
    public function test_summary_from_filesystem() {
        file_put_contents('example.txt', 'special summary!');
        $item = $this->newRSSItem();
        $this->assertEquals('special summary!', $item->getSummary());
        unlink('example.txt');
    }

    // test summary no extension
    public function test_summary_from_filesystem_no_extension() {
        $this->filename = 'example';
        $this->default_title_from_file = 'example';
        file_put_contents('example.txt', 'special summary 2!');
        $item = $this->newRSSItem();
        $this->assertEquals('special summary 2!', $item->getSummary());
        unlink('example.txt');
    }

    // test summary dot only
    public function test_summary_from_filesystem_dot_only() {
        $this->filename = 'example.';
        $this->default_title_from_file = 'example.';
        file_put_contents('example.txt', 'special summary 3!');
        $item = $this->newRSSItem();
        $this->assertEquals('special summary 3!', $item->getSummary());
        unlink('example.txt');
    }

    // test subtitle default
    public function test_subtitle_default() {
        $item = $this->newRSSItem();
        $this->assertEquals($this->getDefaultSubtitle(), $item->getSubtitle());
    }

    // test subtitle override
    public function test_subtitle_override() {
        file_put_contents('example_subtitle.txt', 'WRONG');
        $item = $this->newRSSItem();
        $item->setSubtitle('RIGHT');
        $this->assertEquals('RIGHT', $item->getSubtitle());
        unlink('example_subtitle.txt');
    }

    // test subtitle
    public function test_subtitle_from_filesystem() {
        file_put_contents('example_subtitle.txt', 'special subtitle!');
        $item = $this->newRSSItem();
        $this->assertEquals('special subtitle!', $item->getSubtitle());
        unlink('example_subtitle.txt');
    }

    // test subtitle no extension
    public function test_subtitle_from_filesystem_no_extension() {
        $this->filename = 'example';
        $this->default_title_from_file = 'example';
        file_put_contents('example_subtitle.txt', 'special subtitle 2!');
        $item = $this->newRSSItem();
        $this->assertEquals('special subtitle 2!', $item->getSubtitle());
        unlink('example_subtitle.txt');
    }

    // test subtitle dot only
    public function test_subtitle_from_filesystem_dot_only() {
        $this->filename = 'example.';
        $this->default_title_from_file = 'example.';
        file_put_contents('example_subtitle.txt', 'special subtitle 3!');
        $item = $this->newRSSItem();
        $this->assertEquals('special subtitle 3!', $item->getSubtitle());
        unlink('example_subtitle.txt');
    }

    public function test_saveImage_jpg()
    {
        $item = $this->newRSSItem();
        $expected_image_filename = $this->filename_base . '.jpg';
        $this->assertFalse(file_exists($expected_image_filename));
        $item->saveImage('image/jpeg', 'JFIF content');
        $this->assertTrue(file_exists($expected_image_filename));
        $this->assertEquals('JFIF content', file_get_contents($expected_image_filename));
    }

    public function test_saveImage_png()
    {
        $item = $this->newRSSItem();
        $expected_image_filename = $this->filename_base . '.png';
        $this->assertFalse(file_exists($expected_image_filename));
        $item->saveImage('image/png', 'PNG content');
        $this->assertTrue(file_exists($expected_image_filename));
        $this->assertEquals('PNG content', file_get_contents($expected_image_filename));
    }

    public function test_saveImage_doesnt_replace_manual_image()
    {
        $expected_image_filename = $this->filename_base . '.jpg';
        file_put_contents($expected_image_filename, 'bla');

        $item = $this->newRSSItem();
        $item->saveImage('image/jpeg', 'JFIF content');
        $this->assertEquals('bla', file_get_contents($expected_image_filename));
    }

    public function test_saveImage_doesnt_replace_manual_image_of_alternate_type_jpg_png()
    {
        $expected_image_filename = $this->filename_base . '.jpg';
        $unexpected_image_filename = $this->filename_base . '.png';
        file_put_contents($expected_image_filename, 'bla');

        $item = $this->newRSSItem();
        $item->saveImage('image/png', 'PNG content');
        $this->assertEquals('bla', file_get_contents($expected_image_filename));
        $this->assertFalse(file_exists($unexpected_image_filename));
    }

    public function test_saveImage_doesnt_replace_manual_image_of_alternate_type_png_jpg()
    {
        $expected_image_filename = $this->filename_base . '.png';
        $unexpected_image_filename = $this->filename_base . '.jpg';
        file_put_contents($expected_image_filename, 'bla');

        $item = $this->newRSSItem();
        $item->saveImage('image/jpeg', 'JFIF content');
        $this->assertEquals('bla', file_get_contents($expected_image_filename));
        $this->assertFalse(file_exists($unexpected_image_filename));
    }

    public function test_saveImage_anything_else()
    {
        $item = $this->newRSSItem();
        $file_count_before = count(glob($this->filename_base . '*'));
        $item->saveImage('application/octet-stream', 'random data');
        $file_count_after = count(glob($this->filename_base . '*'));
        $this->assertEquals($file_count_before, $file_count_after);
    }

    public function test_getModificationTime_returns_most_recent_including_metadata_files()
    {
        $item = $this->newRSSItem();
        $now = time();

        clearstatcache();

        touch($this->filename, $now - 60);
        $this->assertEquals($now - 60, $item->getModificationTime());

        touch('example.txt', $now - 50);
        $this->assertEquals($now - 50, $item->getModificationTime());

        touch('example_subtitle.txt', $now - 40);
        $this->assertEquals($now - 40, $item->getModificationTime());

        touch('example.png', $now - 30);
        $this->assertEquals($now - 30, $item->getModificationTime());

        touch('example.jpg', $now - 20);
        $this->assertEquals($now - 20, $item->getModificationTime());
    }

    public function tearDown(): void
    {
        file_exists($this->filename) && unlink($this->filename);
        file_exists('example.jpg') && unlink('example.jpg');
        file_exists('example.png') && unlink('example.png');
        file_exists('example.txt') && unlink('example.txt');
        file_exists('example_subtitle.txt') && unlink('example_subtitle.txt');
    }
}