Attachment #154767 for bug #129877

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Lines 28-33 Link Here

(-)src/org/eclipse/wst/html/ui/internal/edit/ui/CleanupDialogHTML.java (+9 lines)
28	import org.eclipse.wst.html.ui.internal.HTMLUIMessages;	28	import org.eclipse.wst.html.ui.internal.HTMLUIMessages;
29	import org.eclipse.wst.html.ui.internal.editor.IHelpContextIds;	29	import org.eclipse.wst.html.ui.internal.editor.IHelpContextIds;
30	import org.eclipse.wst.sse.core.internal.encoding.CommonEncodingPreferenceNames;	30	import org.eclipse.wst.sse.core.internal.encoding.CommonEncodingPreferenceNames;
		31	import org.eclipse.wst.xml.ui.internal.XMLUIMessages;
31		32
32	public class CleanupDialogHTML extends Dialog implements SelectionListener {	33	public class CleanupDialogHTML extends Dialog implements SelectionListener {
33		34
Lines 37-42 Link Here
37	protected Button fRadioButtonAttrNameCaseAsis;	38	protected Button fRadioButtonAttrNameCaseAsis;
38	protected Button fRadioButtonAttrNameCaseLower;	39	protected Button fRadioButtonAttrNameCaseLower;
39	protected Button fRadioButtonAttrNameCaseUpper;	40	protected Button fRadioButtonAttrNameCaseUpper;
		41	protected Button fCheckBoxCompressEmptyElementTags;
40	protected Button fCheckBoxInsertRequiredAttrs;	42	protected Button fCheckBoxInsertRequiredAttrs;
41	protected Button fCheckBoxInsertMissingTags;	43	protected Button fCheckBoxInsertMissingTags;
42	protected Button fCheckBoxQuoteAttrValues;	44	protected Button fCheckBoxQuoteAttrValues;
Lines 118-123 Link Here
118	layout.makeColumnsEqualWidth = true;	120	layout.makeColumnsEqualWidth = true;
119	composite.setLayout(layout);	121	composite.setLayout(layout);
120		122
		123	// Compress empty element tags
		124	fCheckBoxCompressEmptyElementTags = new Button(composite, SWT.CHECK);
		125	fCheckBoxCompressEmptyElementTags.setText(XMLUIMessages.Compress_empty_element_tags_UI_);
		126	fCheckBoxCompressEmptyElementTags.addSelectionListener(this);
		127
121	// Insert missing required attrs	128	// Insert missing required attrs
122	fCheckBoxInsertRequiredAttrs = new Button(composite, SWT.CHECK);	129	fCheckBoxInsertRequiredAttrs = new Button(composite, SWT.CHECK);
123	fCheckBoxInsertRequiredAttrs.setText(HTMLUIMessages.Insert_required_attributes_UI_);	130	fCheckBoxInsertRequiredAttrs.setText(HTMLUIMessages.Insert_required_attributes_UI_);
Lines 196-201 Link Here
196	protected void initializeOptions() {	203	protected void initializeOptions() {
197	initializeOptionsForHTML();	204	initializeOptionsForHTML();
198		205
		206	fCheckBoxCompressEmptyElementTags.setSelection(getModelPreferences().getBoolean(HTMLCorePreferenceNames.COMPRESS_EMPTY_ELEMENT_TAGS));
199	fCheckBoxInsertRequiredAttrs.setSelection(getModelPreferences().getBoolean(HTMLCorePreferenceNames.INSERT_REQUIRED_ATTRS));	207	fCheckBoxInsertRequiredAttrs.setSelection(getModelPreferences().getBoolean(HTMLCorePreferenceNames.INSERT_REQUIRED_ATTRS));
200	fCheckBoxInsertMissingTags.setSelection(getModelPreferences().getBoolean(HTMLCorePreferenceNames.INSERT_MISSING_TAGS));	208	fCheckBoxInsertMissingTags.setSelection(getModelPreferences().getBoolean(HTMLCorePreferenceNames.INSERT_MISSING_TAGS));
201	fCheckBoxQuoteAttrValues.setSelection(getModelPreferences().getBoolean(HTMLCorePreferenceNames.QUOTE_ATTR_VALUES));	209	fCheckBoxQuoteAttrValues.setSelection(getModelPreferences().getBoolean(HTMLCorePreferenceNames.QUOTE_ATTR_VALUES));
Lines 235-240 Link Here
235	protected void storeOptions() {	243	protected void storeOptions() {
236	storeOptionsForHTML();	244	storeOptionsForHTML();
237		245
		246	getModelPreferences().setValue(HTMLCorePreferenceNames.COMPRESS_EMPTY_ELEMENT_TAGS, fCheckBoxCompressEmptyElementTags.getSelection());
238	getModelPreferences().setValue(HTMLCorePreferenceNames.INSERT_REQUIRED_ATTRS, fCheckBoxInsertRequiredAttrs.getSelection());	247	getModelPreferences().setValue(HTMLCorePreferenceNames.INSERT_REQUIRED_ATTRS, fCheckBoxInsertRequiredAttrs.getSelection());
239	getModelPreferences().setValue(HTMLCorePreferenceNames.INSERT_MISSING_TAGS, fCheckBoxInsertMissingTags.getSelection());	248	getModelPreferences().setValue(HTMLCorePreferenceNames.INSERT_MISSING_TAGS, fCheckBoxInsertMissingTags.getSelection());
240	getModelPreferences().setValue(HTMLCorePreferenceNames.QUOTE_ATTR_VALUES, fCheckBoxQuoteAttrValues.getSelection());	249	getModelPreferences().setValue(HTMLCorePreferenceNames.QUOTE_ATTR_VALUES, fCheckBoxQuoteAttrValues.getSelection());




import org.w3c.dom.Element;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

// nakamori_TODO: check and remove CSS formatting


		// there are any
		// insertMissingTags() will return the new missing start tag if one is
		// missing
		// then compress any empty element tags
		// applyTagNameCase() will return the renamed node.
		// The renamed/new node will be saved and returned to caller when all
		// cleanup is done.
		renamedNode = insertMissingTags(renamedNode);
		renamedNode = compressEmptyElementTag(renamedNode);
		renamedNode = insertRequiredAttrs(renamedNode);
		renamedNode = applyTagNameCase(renamedNode);
		applyAttrNameCase(renamedNode);


		return result;
	}
	
	/**
	 * <p>Compress empty element tags if the prefence is set to do so</p>
	 * 
	 * @copyof org.eclipse.wst.xml.core.internal.cleanup.ElementNodeCleanupHandler#compressEmptyElementTag
	 * 
	 * @param node the {@link IDOMNode} to possible compress
	 * @return the compressed node if the given node should be compressed, else the node as it was given
	 */
	private IDOMNode compressEmptyElementTag(IDOMNode node) {
		boolean compressEmptyElementTags = getCleanupPreferences().getCompressEmptyElementTags();
		IDOMNode newNode = node;

		IStructuredDocumentRegion startTagStructuredDocumentRegion = newNode.getFirstStructuredDocumentRegion();
		IStructuredDocumentRegion endTagStructuredDocumentRegion = newNode.getLastStructuredDocumentRegion();

		if (compressEmptyElementTags && startTagStructuredDocumentRegion != endTagStructuredDocumentRegion && startTagStructuredDocumentRegion != null) {
			ITextRegionList regions = startTagStructuredDocumentRegion.getRegions();
			ITextRegion lastRegion = regions.get(regions.size() - 1);
			// format children and end tag if not empty element tag
			if (lastRegion.getType() != DOMRegionContext.XML_EMPTY_TAG_CLOSE) {
				NodeList childNodes = newNode.getChildNodes();
				if (childNodes == null || childNodes.getLength() == 0 || (childNodes.getLength() == 1 && (childNodes.item(0)).getNodeType() == Node.TEXT_NODE && ((childNodes.item(0)).getNodeValue().trim().length() == 0))) {
					IDOMModel structuredModel = newNode.getModel();
					IStructuredDocument structuredDocument = structuredModel.getStructuredDocument();

					int startTagStartOffset = newNode.getStartOffset();
					int offset = endTagStructuredDocumentRegion.getStart();
					int length = endTagStructuredDocumentRegion.getLength();
					structuredDocument.replaceText(structuredDocument, offset, length, ""); //$NON-NLS-1$
					newNode = (IDOMNode) structuredModel.getIndexedRegion(startTagStartOffset); // save

					offset = startTagStructuredDocumentRegion.getStart() + lastRegion.getStart();
					structuredDocument.replaceText(structuredDocument, offset, 0, "/"); //$NON-NLS-1$
					newNode = (IDOMNode) structuredModel.getIndexedRegion(startTagStartOffset); // save
				}
			}
		}

		return newNode;
	}
}

Lines 13-18 Link Here

(-)src/org/eclipse/wst/html/core/tests/HTMLCoreTestSuite.java (+2 lines)
13	import junit.framework.Test;	13	import junit.framework.Test;
14	import junit.framework.TestSuite;	14	import junit.framework.TestSuite;
15		15
		16	import org.eclipse.wst.html.core.tests.cleanup.TestHTMLCleanupProcessor;
16	import org.eclipse.wst.html.core.tests.format.TestFormatProcessorHTML;	17	import org.eclipse.wst.html.core.tests.format.TestFormatProcessorHTML;
17	import org.eclipse.wst.html.core.tests.misc.HTMLCorePreferencesTest;	18	import org.eclipse.wst.html.core.tests.misc.HTMLCorePreferencesTest;
18	import org.eclipse.wst.html.core.tests.misc.HTMLTagInfoTest;	19	import org.eclipse.wst.html.core.tests.misc.HTMLTagInfoTest;
Lines 47-51 Link Here
47	addTest(new TestSuite(BUG124835SetStyleAttributeValueTest.class));	48	addTest(new TestSuite(BUG124835SetStyleAttributeValueTest.class));
48	addTest(new TestSuite(TestFormatProcessorHTML.class));	49	addTest(new TestSuite(TestFormatProcessorHTML.class));
49	addTest(new TestSuite(TestCatalogContentModels.class));	50	addTest(new TestSuite(TestCatalogContentModels.class));
		51	addTest(TestHTMLCleanupProcessor.suite());
50	}	52	}
51	}	53	}




<?xml version="1.0" encoding="ISO-8859-1" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<title>Insert title here</title>
</head>
<body>

<br>

<br></br>

</body>
</html>




<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Insert title here</title>
</head>
<body>

<br>

<br/>

</body>
</html>




/*******************************************************************************
 * Copyright (c) 2009 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.wst.html.core.tests.cleanup;

import java.io.IOException;

import junit.extensions.TestSetup;
import junit.framework.Test;
import junit.framework.TestCase;
import junit.framework.TestSuite;

import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.jface.text.IDocument;
import org.eclipse.wst.html.core.internal.cleanup.HTMLCleanupProcessorImpl;
import org.eclipse.wst.html.core.tests.ProjectUtil;
import org.eclipse.wst.sse.core.StructuredModelManager;
import org.eclipse.wst.sse.core.internal.cleanup.AbstractStructuredCleanupProcessor;
import org.eclipse.wst.sse.core.internal.provisional.IStructuredModel;
import org.eclipse.wst.sse.core.utils.StringUtils;

public class TestHTMLCleanupProcessor extends TestCase {
	/**
	 * The name of the project that all of these tests will use
	 */
	private static final String PROJECT_NAME = "TestHTMLCleanupProcessor";
	
	/**
	 * The location of the testing files
	 */
	private static final String PROJECT_FILES = "/testresources/HTMLCleanupProcessor";
	
	/**
	 * The project that all of the tests use
	 */
	private static IProject fProject;
	
	/**
	 * Default constructor
	 */
	public TestHTMLCleanupProcessor() {
		super("Test HTML Cleanup Processor");
	}
	
	/**
	 * Constructor that takes a test name.
	 * 
	 * @param name The name this test run should have.
	 */
	public TestHTMLCleanupProcessor(String name) {
		super(name);
	}
	
	/**
	 * <p>Use this method to add these tests to a larger test suite so set up
	 * and tear down can be performed</p>
	 * 
	 * @return a {@link TestSetup} that will run all of the tests in this class
	 * with set up and tear down.
	 */
	public static Test suite() {
		TestSuite ts = new TestSuite(TestHTMLCleanupProcessor.class);
		return new TestHTMLCleanupProcessorSetup(ts);

	}
	
	/**
	 * <p><b>TEST:</b> collapsing empty tags in an html document</p>
	 */
	public void testCollapseEmptyTagsHTML()throws Exception  {
		HTMLCleanupProcessorImpl cleanupProcessor = getProcessorForForEmptyTagsTest();
		runTest("test1.html", "test1-expected.html", cleanupProcessor);
	}
	
	/**
	 * <p><b>TEST:</b> collapsing empty tags in an xhtml document</p>
	 */
	public void testCollapseEmptyTagsXHTML()throws Exception  {
		HTMLCleanupProcessorImpl cleanupProcessor = getProcessorForForEmptyTagsTest();
		runTest("test2.html", "test2-expected.html", cleanupProcessor);
	}
	
	/**
	 * @return a configured {@link HTMLCleanupProcessorImpl} for testing compressing empty tags
	 */
	private static HTMLCleanupProcessorImpl getProcessorForForEmptyTagsTest() {
		HTMLCleanupProcessorImpl cleanupProcessor = new HTMLCleanupProcessorImpl();
		cleanupProcessor.getCleanupPreferences().setCompressEmptyElementTags(true);
		cleanupProcessor.getCleanupPreferences().setInsertRequiredAttrs(false);
		cleanupProcessor.getCleanupPreferences().setInsertMissingTags(true);
		cleanupProcessor.getCleanupPreferences().setQuoteAttrValues(false);
		cleanupProcessor.getCleanupPreferences().setFormatSource(false);
		cleanupProcessor.getCleanupPreferences().setConvertEOLCodes(false);
		
		return cleanupProcessor;
	}
	
	/**
	 * <p>Runs an {@link AbstractStructuredCleanupProcessor} test</p>
	 * 
	 * @param originalFile file to clean up
	 * @param expectedResultsFile expected results of cleaning up the original file
	 * @param configuredCleanupProcessor the processor to use to do the cleaning
	 * 
	 * @throws Exception tests can throw exceptions now and then
	 */
	private void runTest(String originalFile, String expectedResultsFile,
			AbstractStructuredCleanupProcessor configuredCleanupProcessor) throws Exception {
		
		IStructuredModel model = null;
		IStructuredModel expectedModel = null;
		try {
			model = getModelForEdit(originalFile);
			expectedModel = getModelForEdit(expectedResultsFile);
			
			configuredCleanupProcessor.refreshCleanupPreferences = false;
			configuredCleanupProcessor.cleanupModel(model);
			configuredCleanupProcessor.refreshCleanupPreferences = true;
			
			model.save();
			
			standardizeLineEndings(model.getStructuredDocument());
			standardizeLineEndings(expectedModel.getStructuredDocument());
			
			assertEquals("Clean up results did not match expected results",
					expectedModel.getStructuredDocument().get(),
					model.getStructuredDocument().get());
		} finally {
			if(model != null) {
				model.releaseFromEdit();
			}
			
			if(expectedModel != null) {
				expectedModel.releaseFromEdit();
			}
		}
	}
	
	/**
	 * <p>Given a file name in <code>fProject</code> attempts to get a model
	 * for it, if the file doesn't exist or it can't get the model the test fails.</p>
	 * 
	 * @param filename
	 * @return
	 * @throws CoreException 
	 * @throws IOException 
	 */
	private IStructuredModel getModelForEdit(final String filename) throws IOException, CoreException {
		IFile file = fProject.getFile(filename);
		assertTrue("Test file " + file + " can not be found", file.exists());
		
		IStructuredModel model = StructuredModelManager.getModelManager().getModelForEdit(file);
		assertNotNull("Could not get model for " + file, model);
		
		return model;
	}
	
	
	/**
	 * <p>Line endings can be an issue when running tests on different OSs.
	 * This function standardizes the line endings to use <code>\n</code></p>
	 * 
	 * <p>It will get the text from the given editor, change the line endings,
	 * and then save the editor</p>
	 * 
	 * @param editor standardize the line endings of the text presented in this
	 * editor.
	 */
	private void standardizeLineEndings(IDocument doc) {
		String contents = doc.get();
		contents = StringUtils.replace(contents, "\r\n", "\n");
		contents = StringUtils.replace(contents, "\r", "\n");
		doc.set(contents);
	}
	
	/**
	 * <p>This inner class is used to do set up and tear down before and
	 * after (respectively) all tests in the inclosing class have run.</p>
	 */
	private static class TestHTMLCleanupProcessorSetup extends TestSetup {
		private static final String WTP_AUTOTEST_NONINTERACTIVE = "wtp.autotest.noninteractive";
		private static String previousWTPAutoTestNonInteractivePropValue = null;
		
		/**
		 * Default constructor
		 * 
		 * @param test do setup for the given test
		 */
		public TestHTMLCleanupProcessorSetup(Test test) {
			super(test);
		}

		/**
		 * <p>This is run once before all of the tests</p>
		 * 
		 * @see junit.extensions.TestSetup#setUp()
		 */
		public void setUp() throws Exception {
			fProject = ProjectUtil.createProject(PROJECT_NAME, null, null);
			ProjectUtil.copyBundleEntriesIntoWorkspace(PROJECT_FILES, PROJECT_NAME);
			
			String noninteractive = System.getProperty(WTP_AUTOTEST_NONINTERACTIVE);
			if (noninteractive != null) {
				previousWTPAutoTestNonInteractivePropValue = noninteractive;
			} else {
				previousWTPAutoTestNonInteractivePropValue = "false";
			}
			System.setProperty(WTP_AUTOTEST_NONINTERACTIVE, "true");
		}

		/**
		 * <p>This is run once after all of the tests have been run</p>
		 * 
		 * @see junit.extensions.TestSetup#tearDown()
		 */
		public void tearDown() throws Exception {
			fProject.delete(true, new NullProgressMonitor());
			
			if (previousWTPAutoTestNonInteractivePropValue != null) {
				System.setProperty(WTP_AUTOTEST_NONINTERACTIVE, previousWTPAutoTestNonInteractivePropValue);
			}
		}
	}
}




<?xml version="1.0" encoding="ISO-8859-1" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<title>Insert title here</title>
</head>
<body>

<br />

<br/>

</body>
</html>




<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Insert title here</title>
</head>
<body>

<br>

<br></br>

</body>
</html>




/*******************************************************************************
 * Copyright (c) 2009 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     
 *******************************************************************************/
package org.eclipse.wst.html.core.tests;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.Enumeration;

import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IFolder;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IProjectDescription;
import org.eclipse.core.resources.IWorkspaceRunnable;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.Path;

/**
 * 
 * @see org.eclipse.wst.xml.ui.tests.ProjectUtil Similar Project Utils
 * @see org.eclipse.wst.css.ui.tests.ProjectUtil Similar Project Utils
 * @see org.eclipse.wst.dtd.ui.tests.ProjectUtil Similar Project Utils
 */
public class ProjectUtil {
	public static IProject createProject(String name, IPath location, String[] natureIds) {
		IProjectDescription description = ResourcesPlugin.getWorkspace().newProjectDescription(name);
		if (location != null) {
			description.setLocation(location);
		}
		if (natureIds != null) {
			description.setNatureIds(natureIds);
		}
		IProject project = ResourcesPlugin.getWorkspace().getRoot().getProject(name);
		try {
			project.create(description, new NullProgressMonitor());
			project.open(new NullProgressMonitor());
		}
		catch (CoreException e) {
			e.printStackTrace();
		}
		return project;
	}
	
	/**
	 * @param rootEntry - avoid trailing separators
	 * @param fullTargetPath
	 */
	public static void copyBundleEntriesIntoWorkspace(final String rootEntry, final String fullTargetPath) {
		IWorkspaceRunnable runnable = new IWorkspaceRunnable() {
			public void run(IProgressMonitor monitor) throws CoreException {
				_copyBundleEntriesIntoWorkspace(rootEntry, fullTargetPath);
				ResourcesPlugin.getWorkspace().checkpoint(true);
			}
		};
		try {
			ResourcesPlugin.getWorkspace().run(runnable, new NullProgressMonitor());
		}
		catch (CoreException e) {
			e.printStackTrace();
		}
	}
	
	static void _copyBundleEntriesIntoWorkspace(final String rootEntry, final String fullTargetPath) throws CoreException {
		Enumeration entries = HTMLCoreTestsPlugin.getDefault().getBundle().getEntryPaths(rootEntry);
		while (entries != null && entries.hasMoreElements()) {
			String entryPath = entries.nextElement().toString();
			String targetPath = new Path(fullTargetPath + "/" + entryPath.substring(rootEntry.length())).toString();
			if (entryPath.endsWith("/")) {
				IFolder folder = ResourcesPlugin.getWorkspace().getRoot().getFolder(new Path(targetPath));
				if (!folder.exists()) {
					folder.create(true, true, new NullProgressMonitor());
				}
				_copyBundleEntriesIntoWorkspace(entryPath, targetPath);
			}
			else {
				_copyBundleEntryIntoWorkspace(entryPath, targetPath);
			}
		}
	}
	
	static IFile _copyBundleEntryIntoWorkspace(String entryname, String fullPath) throws CoreException {
		IFile file = null;
		URL entry = HTMLCoreTestsPlugin.getDefault().getBundle().getEntry(entryname);
		if (entry != null) {
			try {
				byte[] b = new byte[2048];
				InputStream input = entry.openStream();
				ByteArrayOutputStream output = new ByteArrayOutputStream();
				int i = -1;
				while ((i = input.read(b)) > -1) {
					output.write(b, 0, i);
				}
				file = ResourcesPlugin.getWorkspace().getRoot().getFile(new Path(fullPath));
				if (file != null) {
					if (!file.exists()) {
						file.create(new ByteArrayInputStream(output.toByteArray()), true, new NullProgressMonitor());
					}
					else {
						file.setContents(new ByteArrayInputStream(output.toByteArray()), true, false, new NullProgressMonitor());
					}
				}
			}
			catch (IOException e) {
				e.printStackTrace();
			}
			catch (CoreException e) {
				e.printStackTrace();
			}
		}
		return file;
	}
}

Return to bug 129877

Lines 52-57 Link Here

(-)src/org/eclipse/wst/html/core/internal/cleanup/ElementNodeCleanupHandler.java (+44 lines)
52	import org.w3c.dom.Element;	52	import org.w3c.dom.Element;
53	import org.w3c.dom.NamedNodeMap;	53	import org.w3c.dom.NamedNodeMap;
54	import org.w3c.dom.Node;	54	import org.w3c.dom.Node;
		55	import org.w3c.dom.NodeList;
55		56
56	// nakamori_TODO: check and remove CSS formatting	57	// nakamori_TODO: check and remove CSS formatting
57		58
Lines 105-114 Link Here
105	// there are any	106	// there are any
106	// insertMissingTags() will return the new missing start tag if one is	107	// insertMissingTags() will return the new missing start tag if one is
107	// missing	108	// missing
		109	// then compress any empty element tags
108	// applyTagNameCase() will return the renamed node.	110	// applyTagNameCase() will return the renamed node.
109	// The renamed/new node will be saved and returned to caller when all	111	// The renamed/new node will be saved and returned to caller when all
110	// cleanup is done.	112	// cleanup is done.
111	renamedNode = insertMissingTags(renamedNode);	113	renamedNode = insertMissingTags(renamedNode);
		114	renamedNode = compressEmptyElementTag(renamedNode);
112	renamedNode = insertRequiredAttrs(renamedNode);	115	renamedNode = insertRequiredAttrs(renamedNode);
113	renamedNode = applyTagNameCase(renamedNode);	116	renamedNode = applyTagNameCase(renamedNode);
114	applyAttrNameCase(renamedNode);	117	applyAttrNameCase(renamedNode);
Lines 692-695 Link Here
692		695
693	return result;	696	return result;
694	}	697	}
		698
		699	/**
		700	* <p>Compress empty element tags if the prefence is set to do so</p>
		701	*
		702	* @copyof org.eclipse.wst.xml.core.internal.cleanup.ElementNodeCleanupHandler#compressEmptyElementTag
		703	*
		704	* @param node the {@link IDOMNode} to possible compress
		705	* @return the compressed node if the given node should be compressed, else the node as it was given
		706	*/
		707	private IDOMNode compressEmptyElementTag(IDOMNode node) {
		708	boolean compressEmptyElementTags = getCleanupPreferences().getCompressEmptyElementTags();
		709	IDOMNode newNode = node;
		710
		711	IStructuredDocumentRegion startTagStructuredDocumentRegion = newNode.getFirstStructuredDocumentRegion();
		712	IStructuredDocumentRegion endTagStructuredDocumentRegion = newNode.getLastStructuredDocumentRegion();
		713
		714	if (compressEmptyElementTags && startTagStructuredDocumentRegion != endTagStructuredDocumentRegion && startTagStructuredDocumentRegion != null) {
		715	ITextRegionList regions = startTagStructuredDocumentRegion.getRegions();
		716	ITextRegion lastRegion = regions.get(regions.size() - 1);
		717	// format children and end tag if not empty element tag
		718	if (lastRegion.getType() != DOMRegionContext.XML_EMPTY_TAG_CLOSE) {
		719	NodeList childNodes = newNode.getChildNodes();
		720	if (childNodes == null \|\| childNodes.getLength() == 0 \|\| (childNodes.getLength() == 1 && (childNodes.item(0)).getNodeType() == Node.TEXT_NODE && ((childNodes.item(0)).getNodeValue().trim().length() == 0))) {
		721	IDOMModel structuredModel = newNode.getModel();
		722	IStructuredDocument structuredDocument = structuredModel.getStructuredDocument();
		723
		724	int startTagStartOffset = newNode.getStartOffset();
		725	int offset = endTagStructuredDocumentRegion.getStart();
		726	int length = endTagStructuredDocumentRegion.getLength();
		727	structuredDocument.replaceText(structuredDocument, offset, length, ""); //$NON-NLS-1$
		728	newNode = (IDOMNode) structuredModel.getIndexedRegion(startTagStartOffset); // save
		729
		730	offset = startTagStructuredDocumentRegion.getStart() + lastRegion.getStart();
		731	structuredDocument.replaceText(structuredDocument, offset, 0, "/"); //$NON-NLS-1$
		732	newNode = (IDOMNode) structuredModel.getIndexedRegion(startTagStartOffset); // save
		733	}
		734	}
		735	}
		736
		737	return newNode;
		738	}
695	}	739	}

Added Link Here

(-)testresources/HTMLCleanupProcessor/test2.html (+15 lines)
1	<?xml version="1.0" encoding="ISO-8859-1" ?>
2	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3	<html xmlns="http://www.w3.org/1999/xhtml">
4	<head>
5	<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
6	<title>Insert title here</title>
7	</head>
8	<body>
9
10	<br>
11
12	<br></br>
13
14	</body>
15	</html>

Added Link Here

(-)testresources/HTMLCleanupProcessor/test1-expected.html (+14 lines)
1	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2	<html>
3	<head>
4	<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
5	<title>Insert title here</title>
6	</head>
7	<body>
8
9	<br>
10
11	<br/>
12
13	</body>
14	</html>

Added Link Here

(-)src/org/eclipse/wst/html/core/tests/cleanup/TestHTMLCleanupProcessor.java (+234 lines)
1	/*******************************************************************************
2	* Copyright (c) 2009 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* IBM Corporation - initial API and implementation
10	*******************************************************************************/
11	package org.eclipse.wst.html.core.tests.cleanup;
12
13	import java.io.IOException;
14
15	import junit.extensions.TestSetup;
16	import junit.framework.Test;
17	import junit.framework.TestCase;
18	import junit.framework.TestSuite;
19
20	import org.eclipse.core.resources.IFile;
21	import org.eclipse.core.resources.IProject;
22	import org.eclipse.core.runtime.CoreException;
23	import org.eclipse.core.runtime.NullProgressMonitor;
24	import org.eclipse.jface.text.IDocument;
25	import org.eclipse.wst.html.core.internal.cleanup.HTMLCleanupProcessorImpl;
26	import org.eclipse.wst.html.core.tests.ProjectUtil;
27	import org.eclipse.wst.sse.core.StructuredModelManager;
28	import org.eclipse.wst.sse.core.internal.cleanup.AbstractStructuredCleanupProcessor;
29	import org.eclipse.wst.sse.core.internal.provisional.IStructuredModel;
30	import org.eclipse.wst.sse.core.utils.StringUtils;
31
32	public class TestHTMLCleanupProcessor extends TestCase {
33	/**
34	* The name of the project that all of these tests will use
35	*/
36	private static final String PROJECT_NAME = "TestHTMLCleanupProcessor";
37
38	/**
39	* The location of the testing files
40	*/
41	private static final String PROJECT_FILES = "/testresources/HTMLCleanupProcessor";
42
43	/**
44	* The project that all of the tests use
45	*/
46	private static IProject fProject;
47
48	/**
49	* Default constructor
50	*/
51	public TestHTMLCleanupProcessor() {
52	super("Test HTML Cleanup Processor");
53	}
54
55	/**
56	* Constructor that takes a test name.
57	*
58	* @param name The name this test run should have.
59	*/
60	public TestHTMLCleanupProcessor(String name) {
61	super(name);
62	}
63
64	/**
65	* <p>Use this method to add these tests to a larger test suite so set up
66	* and tear down can be performed</p>
67	*
68	* @return a {@link TestSetup} that will run all of the tests in this class
69	* with set up and tear down.
70	*/
71	public static Test suite() {
72	TestSuite ts = new TestSuite(TestHTMLCleanupProcessor.class);
73	return new TestHTMLCleanupProcessorSetup(ts);
74
75	}
76
77	/**
78	* <p><b>TEST:</b> collapsing empty tags in an html document</p>
79	*/
80	public void testCollapseEmptyTagsHTML()throws Exception {
81	HTMLCleanupProcessorImpl cleanupProcessor = getProcessorForForEmptyTagsTest();
82	runTest("test1.html", "test1-expected.html", cleanupProcessor);
83	}
84
85	/**
86	* <p><b>TEST:</b> collapsing empty tags in an xhtml document</p>
87	*/
88	public void testCollapseEmptyTagsXHTML()throws Exception {
89	HTMLCleanupProcessorImpl cleanupProcessor = getProcessorForForEmptyTagsTest();
90	runTest("test2.html", "test2-expected.html", cleanupProcessor);
91	}
92
93	/**
94	* @return a configured {@link HTMLCleanupProcessorImpl} for testing compressing empty tags
95	*/
96	private static HTMLCleanupProcessorImpl getProcessorForForEmptyTagsTest() {
97	HTMLCleanupProcessorImpl cleanupProcessor = new HTMLCleanupProcessorImpl();
98	cleanupProcessor.getCleanupPreferences().setCompressEmptyElementTags(true);
99	cleanupProcessor.getCleanupPreferences().setInsertRequiredAttrs(false);
100	cleanupProcessor.getCleanupPreferences().setInsertMissingTags(true);
101	cleanupProcessor.getCleanupPreferences().setQuoteAttrValues(false);
102	cleanupProcessor.getCleanupPreferences().setFormatSource(false);
103	cleanupProcessor.getCleanupPreferences().setConvertEOLCodes(false);
104
105	return cleanupProcessor;
106	}
107
108	/**
109	* <p>Runs an {@link AbstractStructuredCleanupProcessor} test</p>
110	*
111	* @param originalFile file to clean up
112	* @param expectedResultsFile expected results of cleaning up the original file
113	* @param configuredCleanupProcessor the processor to use to do the cleaning
114	*
115	* @throws Exception tests can throw exceptions now and then
116	*/
117	private void runTest(String originalFile, String expectedResultsFile,
118	AbstractStructuredCleanupProcessor configuredCleanupProcessor) throws Exception {
119
120	IStructuredModel model = null;
121	IStructuredModel expectedModel = null;
122	try {
123	model = getModelForEdit(originalFile);
124	expectedModel = getModelForEdit(expectedResultsFile);
125
126	configuredCleanupProcessor.refreshCleanupPreferences = false;
127	configuredCleanupProcessor.cleanupModel(model);
128	configuredCleanupProcessor.refreshCleanupPreferences = true;
129
130	model.save();
131
132	standardizeLineEndings(model.getStructuredDocument());
133	standardizeLineEndings(expectedModel.getStructuredDocument());
134
135	assertEquals("Clean up results did not match expected results",
136	expectedModel.getStructuredDocument().get(),
137	model.getStructuredDocument().get());
138	} finally {
139	if(model != null) {
140	model.releaseFromEdit();
141	}
142
143	if(expectedModel != null) {
144	expectedModel.releaseFromEdit();
145	}
146	}
147	}
148
149	/**
150	* <p>Given a file name in <code>fProject</code> attempts to get a model
151	* for it, if the file doesn't exist or it can't get the model the test fails.</p>
152	*
153	* @param filename
154	* @return
155	* @throws CoreException
156	* @throws IOException
157	*/
158	private IStructuredModel getModelForEdit(final String filename) throws IOException, CoreException {
159	IFile file = fProject.getFile(filename);
160	assertTrue("Test file " + file + " can not be found", file.exists());
161
162	IStructuredModel model = StructuredModelManager.getModelManager().getModelForEdit(file);
163	assertNotNull("Could not get model for " + file, model);
164
165	return model;
166	}
167
168
169	/**
170	* <p>Line endings can be an issue when running tests on different OSs.
171	* This function standardizes the line endings to use <code>\n</code></p>
172	*
173	* <p>It will get the text from the given editor, change the line endings,
174	* and then save the editor</p>
175	*
176	* @param editor standardize the line endings of the text presented in this
177	* editor.
178	*/
179	private void standardizeLineEndings(IDocument doc) {
180	String contents = doc.get();
181	contents = StringUtils.replace(contents, "\r\n", "\n");
182	contents = StringUtils.replace(contents, "\r", "\n");
183	doc.set(contents);
184	}
185
186	/**
187	* <p>This inner class is used to do set up and tear down before and
188	* after (respectively) all tests in the inclosing class have run.</p>
189	*/
190	private static class TestHTMLCleanupProcessorSetup extends TestSetup {
191	private static final String WTP_AUTOTEST_NONINTERACTIVE = "wtp.autotest.noninteractive";
192	private static String previousWTPAutoTestNonInteractivePropValue = null;
193
194	/**
195	* Default constructor
196	*
197	* @param test do setup for the given test
198	*/
199	public TestHTMLCleanupProcessorSetup(Test test) {
200	super(test);
201	}
202
203	/**
204	* <p>This is run once before all of the tests</p>
205	*
206	* @see junit.extensions.TestSetup#setUp()
207	*/
208	public void setUp() throws Exception {
209	fProject = ProjectUtil.createProject(PROJECT_NAME, null, null);
210	ProjectUtil.copyBundleEntriesIntoWorkspace(PROJECT_FILES, PROJECT_NAME);
211
212	String noninteractive = System.getProperty(WTP_AUTOTEST_NONINTERACTIVE);
213	if (noninteractive != null) {
214	previousWTPAutoTestNonInteractivePropValue = noninteractive;
215	} else {
216	previousWTPAutoTestNonInteractivePropValue = "false";
217	}
218	System.setProperty(WTP_AUTOTEST_NONINTERACTIVE, "true");
219	}
220
221	/**
222	* <p>This is run once after all of the tests have been run</p>
223	*
224	* @see junit.extensions.TestSetup#tearDown()
225	*/
226	public void tearDown() throws Exception {
227	fProject.delete(true, new NullProgressMonitor());
228
229	if (previousWTPAutoTestNonInteractivePropValue != null) {
230	System.setProperty(WTP_AUTOTEST_NONINTERACTIVE, previousWTPAutoTestNonInteractivePropValue);
231	}
232	}
233	}
234	}

Added Link Here

(-)src/org/eclipse/wst/html/core/tests/ProjectUtil.java (+127 lines)
1	/*******************************************************************************
2	* Copyright (c) 2009 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* IBM Corporation - initial API and implementation
10	*
11	*******************************************************************************/
12	package org.eclipse.wst.html.core.tests;
13
14	import java.io.ByteArrayInputStream;
15	import java.io.ByteArrayOutputStream;
16	import java.io.IOException;
17	import java.io.InputStream;
18	import java.net.URL;
19	import java.util.Enumeration;
20
21	import org.eclipse.core.resources.IFile;
22	import org.eclipse.core.resources.IFolder;
23	import org.eclipse.core.resources.IProject;
24	import org.eclipse.core.resources.IProjectDescription;
25	import org.eclipse.core.resources.IWorkspaceRunnable;
26	import org.eclipse.core.resources.ResourcesPlugin;
27	import org.eclipse.core.runtime.CoreException;
28	import org.eclipse.core.runtime.IPath;
29	import org.eclipse.core.runtime.IProgressMonitor;
30	import org.eclipse.core.runtime.NullProgressMonitor;
31	import org.eclipse.core.runtime.Path;
32
33	/**
34	*
35	* @see org.eclipse.wst.xml.ui.tests.ProjectUtil Similar Project Utils
36	* @see org.eclipse.wst.css.ui.tests.ProjectUtil Similar Project Utils
37	* @see org.eclipse.wst.dtd.ui.tests.ProjectUtil Similar Project Utils
38	*/
39	public class ProjectUtil {
40	public static IProject createProject(String name, IPath location, String[] natureIds) {
41	IProjectDescription description = ResourcesPlugin.getWorkspace().newProjectDescription(name);
42	if (location != null) {
43	description.setLocation(location);
44	}
45	if (natureIds != null) {
46	description.setNatureIds(natureIds);
47	}
48	IProject project = ResourcesPlugin.getWorkspace().getRoot().getProject(name);
49	try {
50	project.create(description, new NullProgressMonitor());
51	project.open(new NullProgressMonitor());
52	}
53	catch (CoreException e) {
54	e.printStackTrace();
55	}
56	return project;
57	}
58
59	/**
60	* @param rootEntry - avoid trailing separators
61	* @param fullTargetPath
62	*/
63	public static void copyBundleEntriesIntoWorkspace(final String rootEntry, final String fullTargetPath) {
64	IWorkspaceRunnable runnable = new IWorkspaceRunnable() {
65	public void run(IProgressMonitor monitor) throws CoreException {
66	_copyBundleEntriesIntoWorkspace(rootEntry, fullTargetPath);
67	ResourcesPlugin.getWorkspace().checkpoint(true);
68	}
69	};
70	try {
71	ResourcesPlugin.getWorkspace().run(runnable, new NullProgressMonitor());
72	}
73	catch (CoreException e) {
74	e.printStackTrace();
75	}
76	}
77
78	static void _copyBundleEntriesIntoWorkspace(final String rootEntry, final String fullTargetPath) throws CoreException {
79	Enumeration entries = HTMLCoreTestsPlugin.getDefault().getBundle().getEntryPaths(rootEntry);
80	while (entries != null && entries.hasMoreElements()) {
81	String entryPath = entries.nextElement().toString();
82	String targetPath = new Path(fullTargetPath + "/" + entryPath.substring(rootEntry.length())).toString();
83	if (entryPath.endsWith("/")) {
84	IFolder folder = ResourcesPlugin.getWorkspace().getRoot().getFolder(new Path(targetPath));
85	if (!folder.exists()) {
86	folder.create(true, true, new NullProgressMonitor());
87	}
88	_copyBundleEntriesIntoWorkspace(entryPath, targetPath);
89	}
90	else {
91	_copyBundleEntryIntoWorkspace(entryPath, targetPath);
92	}
93	}
94	}
95
96	static IFile _copyBundleEntryIntoWorkspace(String entryname, String fullPath) throws CoreException {
97	IFile file = null;
98	URL entry = HTMLCoreTestsPlugin.getDefault().getBundle().getEntry(entryname);
99	if (entry != null) {
100	try {
101	byte[] b = new byte[2048];
102	InputStream input = entry.openStream();
103	ByteArrayOutputStream output = new ByteArrayOutputStream();
104	int i = -1;
105	while ((i = input.read(b)) > -1) {
106	output.write(b, 0, i);
107	}
108	file = ResourcesPlugin.getWorkspace().getRoot().getFile(new Path(fullPath));
109	if (file != null) {
110	if (!file.exists()) {
111	file.create(new ByteArrayInputStream(output.toByteArray()), true, new NullProgressMonitor());
112	}
113	else {
114	file.setContents(new ByteArrayInputStream(output.toByteArray()), true, false, new NullProgressMonitor());
115	}
116	}
117	}
118	catch (IOException e) {
119	e.printStackTrace();
120	}
121	catch (CoreException e) {
122	e.printStackTrace();
123	}
124	}
125	return file;
126	}
127	}