HtmlEditorFieldTest::testImageInsertion() - Code Metrics - Inspection of "Tinymce image shortcodes" - silverstripe/silverstripe-framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#5174)

by Damian

created 2016-03-20 20:23 UTC

HtmlEditorFieldTest::testImageInsertion() A

↳ Parent: HtmlEditorFieldTest::testResizedImageInsertion()

Complexity

Conditions	1
Paths	1

Size

Total Lines	21
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	21
rs	9.3142
cc	1
eloc	16
nc	1
nop	0

<?php

use Filesystem as SS_Filesystem;

/**
 * @package framework
 * @subpackage tests
 */
class HtmlEditorFieldTest extends FunctionalTest {

	protected static $fixture_file = 'HtmlEditorFieldTest.yml';

	protected static $use_draft_site = true;

	protected $requiredExtensions = array(
		'HtmlEditorField_Toolbar' => array('HtmlEditorFieldTest_DummyMediaFormFieldExtension')
	);

	protected $extraDataObjects = array('HtmlEditorFieldTest_Object');

	public function setUp() {
		parent::setUp();

		// Set backend root to /HtmlEditorFieldTest
		AssetStoreTest_SpyStore::activate('HtmlEditorFieldTest');

		// Create a test files for each of the fixture references
		$files = File::get()->exclude('ClassName', 'Folder');
		foreach($files as $file) {
			$fromPath = BASE_PATH . '/framework/tests/forms/images/' . $file->Name;
			$destPath = AssetStoreTest_SpyStore::getLocalPath($file); // Only correct for test asset store
			SS_Filesystem::makeFolder(dirname($destPath));
			copy($fromPath, $destPath);
		}
	}

	public function tearDown() {
		AssetStoreTest_SpyStore::reset();
		parent::tearDown();
	}

	public function testBasicSaving() {
		$obj = new HtmlEditorFieldTest_Object();
		$editor   = new HtmlEditorField('Content');

		$editor->setValue('<p class="foo">Simple Content</p>');
		$editor->saveInto($obj);
		$this->assertEquals('<p class="foo">Simple Content</p>', $obj->Content, 'Attributes are preserved.');

		$editor->setValue('<p>Unclosed Tag');
		$editor->saveInto($obj);
		$this->assertEquals('<p>Unclosed Tag</p>', $obj->Content, 'Unclosed tags are closed.');
	}

	public function testNullSaving() {
		$obj = new HtmlEditorFieldTest_Object();
		$editor = new HtmlEditorField('Content');

		$editor->setValue(null);
		$editor->saveInto($obj);
		$this->assertEquals('', $obj->Content, "Doesn't choke on empty/null values.");
	}

	public function testResizedImageInsertion() {
		$obj = new HtmlEditorFieldTest_Object();
		$editor = new HtmlEditorField('Content');

		$fileID = $this->idFromFixture('Image', 'example_image');
		$editor->setValue(sprintf(
			'[image src="assets/HTMLEditorFieldTest_example.jpg" width="10" height="20" id="%d"]',
			$fileID
		));
		$editor->saveInto($obj);

		$parser = new CSSContentParser($obj->dbObject('Content')->forTemplate());
		$xml = $parser->getByXpath('//img');
		$this->assertEquals(
			'HTMLEditorFieldTest example',
			(string)$xml[0]['alt'],
			'Alt tags are added by default based on filename'
		);
		$this->assertEquals('', (string)$xml[0]['title'], 'Title tags are added by default.');
		$this->assertEquals(10, (int)$xml[0]['width'], 'Width tag of resized image is set.');
		$this->assertEquals(20, (int)$xml[0]['height'], 'Height tag of resized image is set.');

		$neededFilename
			= '/assets/HtmlEditorFieldTest/f5c7c2f814/HTMLEditorFieldTest-example__ResizedImageWyIxMCIsIjIwIl0.jpg';
		
		$this->assertEquals($neededFilename, (string)$xml[0]['src'], 'Correct URL of resized image is set.');
		$this->assertTrue(file_exists(BASE_PATH.DIRECTORY_SEPARATOR.$neededFilename), 'File for resized image exists');
		$this->assertEquals(false, $obj->HasBrokenFile, 'Referenced image file exists.');
	}

	public function testMultiLineSaving() {
		$obj = $this->objFromFixture('HtmlEditorFieldTest_Object', 'home');
		$editor   = new HtmlEditorField('Content');
		$editor->setValue('<p>First Paragraph</p><p>Second Paragraph</p>');
		$editor->saveInto($obj);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
		$this->assertEquals('<p>First Paragraph</p><p>Second Paragraph</p>', $obj->Content);
	}

	public function testSavingLinksWithoutHref() {
		$obj = $this->objFromFixture('HtmlEditorFieldTest_Object', 'home');
		$editor   = new HtmlEditorField('Content');

		$editor->setValue('<p><a name="example-anchor"></a></p>');
		$editor->saveInto($obj);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

		$this->assertEquals (
			'<p><a name="example-anchor"></a></p>', $obj->Content, 'Saving a link without a href attribute works'
		);
	}

	public function testGetAnchors() {
		if (!class_exists('Page')) {
			$this->markTestSkipped();
		}
		$html = '<div name="foo"></div>
<div name=\'bar\'></div>
<div id="baz"></div>
<div id=\'bam\'></div>
<div id = "baz"></div>
<div id = ""></div>
<div id="some\'id"></div>
<div id=bar></div>';
		$expected = array(
			'foo',
			'bar',
			'baz',
			'bam',
			"some&#039;id",
		);
		$page = new Page();
		$page->Title = 'Test';
		$page->Content = $html;
		$page->write();
		$this->useDraftSite(true);

		$request = new SS_HTTPRequest('GET', '/', array(
			'PageID' => $page->ID,
		));

		$toolBar = new HtmlEditorField_Toolbar(new Controller(), 'test');
		$toolBar->setRequest($request);

		$results = json_decode($toolBar->getanchors(), true);
		$this->assertEquals($expected, $results);
	}

	public function testHtmlEditorFieldFileLocal() {
		$file = new HtmlEditorField_Image('http://domain.com/folder/my_image.jpg?foo=bar');
		$this->assertEquals('http://domain.com/folder/my_image.jpg?foo=bar', $file->URL);
		$this->assertEquals('my_image.jpg', $file->Name);
		$this->assertEquals('jpg', $file->Extension);

		// TODO Can't easily test remote file dimensions
	}

	public function testHtmlEditorFieldFileRemote() {
		$fileFixture = new File(array('Name' => 'my_local_image.jpg', 'Filename' => 'folder/my_local_image.jpg'));
		$file = new HtmlEditorField_Image('http://localdomain.com/folder/my_local_image.jpg', $fileFixture);
		$this->assertEquals('http://localdomain.com/folder/my_local_image.jpg', $file->URL);
		$this->assertEquals('my_local_image.jpg', $file->Name);
		$this->assertEquals('jpg', $file->Extension);

	}
}

/**
 * @package framework
 * @subpackage tests
 */
class HtmlEditorFieldTest_DummyMediaFormFieldExtension extends Extension implements TestOnly {
	public static $fields = null;
	public static $update_called = false;

	public function updateImageForm($form) {
		self::$update_called = true;
		self::$fields = $form->Fields();
	}
}

class HtmlEditorFieldTest_Object extends DataObject implements TestOnly {
	private static $db = array(
		'Title' => 'Varchar',
		'Content' => 'HTMLText',
		'HasBrokenFile' => 'Boolean'
	);
}


1			<?php
2
3			use Filesystem as SS_Filesystem;
4
5			/**
6			* @package framework
7			* @subpackage tests
8			*/
9			class HtmlEditorFieldTest extends FunctionalTest {
10
11			protected static $fixture_file = 'HtmlEditorFieldTest.yml';
12
13			protected static $use_draft_site = true;
14
15			protected $requiredExtensions = array(
16			'HtmlEditorField_Toolbar' => array('HtmlEditorFieldTest_DummyMediaFormFieldExtension')
17			);
18
19			protected $extraDataObjects = array('HtmlEditorFieldTest_Object');
20
21			public function setUp() {
22			parent::setUp();
23
24			// Set backend root to /HtmlEditorFieldTest
25			AssetStoreTest_SpyStore::activate('HtmlEditorFieldTest');
26
27			// Create a test files for each of the fixture references
28			$files = File::get()->exclude('ClassName', 'Folder');
29			foreach($files as $file) {
30			$fromPath = BASE_PATH . '/framework/tests/forms/images/' . $file->Name;
31			$destPath = AssetStoreTest_SpyStore::getLocalPath($file); // Only correct for test asset store
32			SS_Filesystem::makeFolder(dirname($destPath));
33			copy($fromPath, $destPath);
34			}
35			}
36
37			public function tearDown() {
38			AssetStoreTest_SpyStore::reset();
39			parent::tearDown();
40			}
41
42			public function testBasicSaving() {
43			$obj = new HtmlEditorFieldTest_Object();
44			$editor = new HtmlEditorField('Content');
45
46			$editor->setValue('<p class="foo">Simple Content</p>');
47			$editor->saveInto($obj);
48			$this->assertEquals('<p class="foo">Simple Content</p>', $obj->Content, 'Attributes are preserved.');
49
50			$editor->setValue('<p>Unclosed Tag');
51			$editor->saveInto($obj);
52			$this->assertEquals('<p>Unclosed Tag</p>', $obj->Content, 'Unclosed tags are closed.');
53			}
54
55			public function testNullSaving() {
56			$obj = new HtmlEditorFieldTest_Object();
57			$editor = new HtmlEditorField('Content');
58
59			$editor->setValue(null);
60			$editor->saveInto($obj);
61			$this->assertEquals('', $obj->Content, "Doesn't choke on empty/null values.");
62			}
63
64			public function testResizedImageInsertion() {
65			$obj = new HtmlEditorFieldTest_Object();
66			$editor = new HtmlEditorField('Content');
67
68			$fileID = $this->idFromFixture('Image', 'example_image');
69			$editor->setValue(sprintf(
70			'[image src="assets/HTMLEditorFieldTest_example.jpg" width="10" height="20" id="%d"]',
71			$fileID
72			));
73			$editor->saveInto($obj);
74
75			$parser = new CSSContentParser($obj->dbObject('Content')->forTemplate());
76			$xml = $parser->getByXpath('//img');
77			$this->assertEquals(
78			'HTMLEditorFieldTest example',
79			(string)$xml[0]['alt'],
80			'Alt tags are added by default based on filename'
81			);
82			$this->assertEquals('', (string)$xml[0]['title'], 'Title tags are added by default.');
83			$this->assertEquals(10, (int)$xml[0]['width'], 'Width tag of resized image is set.');
84			$this->assertEquals(20, (int)$xml[0]['height'], 'Height tag of resized image is set.');
85
86			$neededFilename
87			= '/assets/HtmlEditorFieldTest/f5c7c2f814/HTMLEditorFieldTest-example__ResizedImageWyIxMCIsIjIwIl0.jpg';
88
89			$this->assertEquals($neededFilename, (string)$xml[0]['src'], 'Correct URL of resized image is set.');
90			$this->assertTrue(file_exists(BASE_PATH.DIRECTORY_SEPARATOR.$neededFilename), 'File for resized image exists');
91			$this->assertEquals(false, $obj->HasBrokenFile, 'Referenced image file exists.');
92			}
93
94			public function testMultiLineSaving() {
95			$obj = $this->objFromFixture('HtmlEditorFieldTest_Object', 'home');
96			$editor = new HtmlEditorField('Content');
97			$editor->setValue('<p>First Paragraph</p><p>Second Paragraph</p>');
98			$editor->saveInto($obj);
			0 ignored issues – show Bug introduced 2016-03-13 20:30 UTC by Report Bug Copy Issue Report It seems like `$obj` defined by `$this->objFromFixture('H...ldTest_Object', 'home')` on line `95` can be `null`; however, `HtmlEditorField::saveInto()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
99			$this->assertEquals('<p>First Paragraph</p><p>Second Paragraph</p>', $obj->Content);
100			}
101
102			public function testSavingLinksWithoutHref() {
103			$obj = $this->objFromFixture('HtmlEditorFieldTest_Object', 'home');
104			$editor = new HtmlEditorField('Content');
105
106			$editor->setValue('<p><a name="example-anchor"></a></p>');
107			$editor->saveInto($obj);
			0 ignored issues – show Bug introduced 2016-03-13 20:30 UTC by Report Bug Copy Issue Report It seems like `$obj` defined by `$this->objFromFixture('H...ldTest_Object', 'home')` on line `103` can be `null`; however, `HtmlEditorField::saveInto()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
108
109			$this->assertEquals (
110			'<p><a name="example-anchor"></a></p>', $obj->Content, 'Saving a link without a href attribute works'
111			);
112			}
113
114			public function testGetAnchors() {
115			if (!class_exists('Page')) {
116			$this->markTestSkipped();
117			}
118			$html = '<div name="foo"></div>
119			<div name=\'bar\'></div>
120			<div id="baz"></div>
121			<div id=\'bam\'></div>
122			<div id = "baz"></div>
123			<div id = ""></div>
124			<div id="some\'id"></div>
125			<div id=bar></div>';
126			$expected = array(
127			'foo',
128			'bar',
129			'baz',
130			'bam',
131			"some'id",
132			);
133			$page = new Page();
134			$page->Title = 'Test';
135			$page->Content = $html;
136			$page->write();
137			$this->useDraftSite(true);
138
139			$request = new SS_HTTPRequest('GET', '/', array(
140			'PageID' => $page->ID,
141			));
142
143			$toolBar = new HtmlEditorField_Toolbar(new Controller(), 'test');
144			$toolBar->setRequest($request);
145
146			$results = json_decode($toolBar->getanchors(), true);
147			$this->assertEquals($expected, $results);
148			}
149
150			public function testHtmlEditorFieldFileLocal() {
151			$file = new HtmlEditorField_Image('http://domain.com/folder/my_image.jpg?foo=bar');
152			$this->assertEquals('http://domain.com/folder/my_image.jpg?foo=bar', $file->URL);
153			$this->assertEquals('my_image.jpg', $file->Name);
154			$this->assertEquals('jpg', $file->Extension);
			0 ignored issues – show Bug introduced 2015-11-26 12:19 UTC by Report Bug Copy Issue Report The property `Extension` does not seem to exist. Did you mean `extensions`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
155			// TODO Can't easily test remote file dimensions
156			}
157
158			public function testHtmlEditorFieldFileRemote() {
159			$fileFixture = new File(array('Name' => 'my_local_image.jpg', 'Filename' => 'folder/my_local_image.jpg'));
160			$file = new HtmlEditorField_Image('http://localdomain.com/folder/my_local_image.jpg', $fileFixture);
161			$this->assertEquals('http://localdomain.com/folder/my_local_image.jpg', $file->URL);
162			$this->assertEquals('my_local_image.jpg', $file->Name);
163			$this->assertEquals('jpg', $file->Extension);
			0 ignored issues – show Bug introduced 2015-11-26 12:19 UTC by Report Bug Copy Issue Report The property `Extension` does not seem to exist. Did you mean `extensions`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
164			}
165			}
166
167			/**
168			* @package framework
169			* @subpackage tests
170			*/
171			class HtmlEditorFieldTest_DummyMediaFormFieldExtension extends Extension implements TestOnly {
172			public static $fields = null;
173			public static $update_called = false;
174
175			public function updateImageForm($form) {
176			self::$update_called = true;
177			self::$fields = $form->Fields();
178			}
179			}
180
181			class HtmlEditorFieldTest_Object extends DataObject implements TestOnly {
182			private static $db = array(
183			'Title' => 'Varchar',
184			'Content' => 'HTMLText',
185			'HasBrokenFile' => 'Boolean'
186			);
187			}
188

silverstripe / silverstripe-framework

Pull Request — master (#5174)

HtmlEditorFieldTest::testImageInsertion() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like