nodejs/org.eclipse.wst.jsdt.js.bower/src/org/eclipse/wst/jsdt/js/bower/util/BowerUtil.java

/*******************************************************************************
 * Copyright (c) 2015,2016 Red Hat, Inc. 
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * 	Contributors:
 * 		 Red Hat Inc. - initial API and implementation and/or initial documentation
 *******************************************************************************/
package org.eclipse.wst.jsdt.js.bower.util;

import java.io.InputStreamReader;
import java.io.Reader;
import java.io.UnsupportedEncodingException;
import java.util.ArrayList;
import java.util.List;

import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IFolder;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.IResourceVisitor;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.wst.jsdt.js.bower.BowerJson;
import org.eclipse.wst.jsdt.js.bower.Bowerrc;
import org.eclipse.wst.jsdt.js.bower.internal.BowerConstants;
import org.eclipse.wst.jsdt.js.common.util.WorkbenchResourceUtil;

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;

/**
 * @author "Ilya Buziuk (ibuziuk)"
 */
public final class BowerUtil {

	private BowerUtil() {
	}

	public static boolean isBowerJsonExist(final IProject project) throws CoreException {
		IFile bowerJson = null;
		if (project != null && project.isAccessible()) {
			bowerJson = WorkbenchResourceUtil.findFileRecursively(project, BowerConstants.BOWER_JSON);
		}
		return (bowerJson != null && bowerJson.exists());
	}

	public static boolean hasBowerJson(final IFolder folder) throws CoreException {
		IResource bowerJson = folder.findMember(BowerConstants.BOWER_JSON);
		return (bowerJson != null && bowerJson.exists());
	}

	public static boolean isBowerJson(final IResource resource) {
		return (resource != null && BowerConstants.BOWER_JSON.equals(resource.getName()) && resource.exists());
	}

	public static String generateJson(BowerJson bowerJson) {
		Gson gson = new GsonBuilder().setPrettyPrinting().disableHtmlEscaping().create();
		return gson.toJson(bowerJson);
	}
	
	/**
	 * .bowerrc is an optional file for bower configuration. The "directory"
	 * property defines the path in which installed components should be saved.
	 * If not specified the default "bower_components" folder will be used.
	 * 
	 * @throws CoreException
	 * @see <a href="http://bower.io/docs/config/#bowerrc-specification">.bowerrc specification</a>
	 */
	public static IFile getBowerrc(IProject project) throws CoreException {
		IFile bowerrc = null;
		if (project != null && project.exists()) {
			bowerrc = WorkbenchResourceUtil.findFileRecursively(project, BowerConstants.BOWERRC);
		}
		return bowerrc;
	}
	
	/**
	 * @return path to directory in which native bower call must be performed. Basically, the method scans 
	 * project for bower.json file and returns it's parent, ignoring components directories i.e "bower_components" 
	 * or defined in .bowerrc file  
	 * @throws CoreException
	 */
	public static IPath getBowerWorkingDir(IProject project, final String... ignores) throws CoreException {
		IPath workingDir = null;
		final List<IFile> foundFiles = new ArrayList<>();
		if (project != null && project.exists()) {
			project.accept(new IResourceVisitor() {

				@Override
				public boolean visit(IResource resource) throws CoreException {
					if (!foundFiles.isEmpty()) {
						return false;
					} else if (resource.getType() == IResource.FOLDER && ignores != null) {
						for (String ignore : ignores) {
							if (resource.getName().equals(ignore)) {
								return false;
							}
						}
					} else if (resource.getType() == IResource.FILE
							&& BowerConstants.BOWER_JSON.equals(resource.getName())) {
						foundFiles.add((IFile) resource);
					}
					return true;
				}
			});
		}
		if (!foundFiles.isEmpty()) {
			workingDir = foundFiles.get(0).getParent().getLocation();
		}
		return workingDir;
	}
	
	/**
	 * @return name of the directory in which bower components would be unpacked according to the .bowerrc
	 * @throws CoreException 
	 * @throws UnsupportedEncodingException 
	 * @see <a href="http://bower.io/docs/config/#directory">Directory property</a> 
	 */
	public static String getDirectoryName(IFile bowerrc) throws UnsupportedEncodingException, CoreException {
		String directoryName = null;
		if (bowerrc != null && bowerrc.exists()) {
			Reader reader = new InputStreamReader(bowerrc.getContents(), BowerConstants.UTF_8);
			Bowerrc model = new Gson().fromJson(reader, Bowerrc.class);
			String directory = model.getDirectory();
			if (directory != null) {
				String[] split = directory.split("/"); //$NON-NLS-1$
				int length = split.length;
				if (length > 0) {
					directoryName = split[length - 1];
				}
			}
		}
		return directoryName;
	}

}