com.paypal.butterfly.utilities.operations.properties.RemoveProperty Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of butterfly-utilities Show documentation
null
There is a newer version: 3.2.7
package com.paypal.butterfly.utilities.operations.properties;

import com.paypal.butterfly.extensions.api.TOExecutionResult;
import com.paypal.butterfly.extensions.api.TransformationContext;
import com.paypal.butterfly.extensions.api.TransformationOperation;
import com.paypal.butterfly.extensions.api.exception.TransformationOperationException;
import com.paypal.butterfly.utilities.operations.EolBufferedReader;

import java.io.*;
import java.nio.charset.StandardCharsets;
import java.util.regex.Pattern;

import static com.paypal.butterfly.utilities.operations.EolHelper.removeEol;

/**
 * Removes a property from a properties file.
 * If the specified property is not present, a warning is produced.
 *
 * @author facarvalho
 */
public class RemoveProperty extends TransformationOperation {

    private static final String DESCRIPTION = "Remove property %s from file %s";

    private String propertyName;

    /**
     * Operation to remove a property from a properties file.
     * If the specified property is not present, a warning is produced.
     */
    public RemoveProperty() {
    }

    /**
     * Operation to remove a property from a properties file.
     * If the specified property is not present, a warning is produced.
     *
     * @param propertyName name to the property to be removed
     */
    public RemoveProperty(String propertyName) {
        setPropertyName(propertyName);
    }

    public RemoveProperty setPropertyName(String propertyName) {
        checkForBlankString("Property Name", propertyName);
        this.propertyName = propertyName;
        return this;
    }

    public String getPropertyName() {
        return propertyName;
    }

    @Override
    public String getDescription() {
        return String.format(DESCRIPTION, propertyName, getRelativePath());
    }


    @Override
    @edu.umd.cs.findbugs.annotations.SuppressFBWarnings (value="NP_ALWAYS_NULL_EXCEPTION")
    protected TOExecutionResult execution(File transformedAppFolder, TransformationContext transformationContext) {
        String details;
        BufferedReader reader = null;
        BufferedWriter writer = null;
        TOExecutionResult result = null;
        File fileToBeChanged = getAbsoluteFile(transformedAppFolder, transformationContext);
        try {
            if (!fileToBeChanged.exists()) {
                // TODO Should this be done as pre-validation?
                details = String.format("Operation '%s' hasn't transformed the application because file '%s', where the property removal should happen, does not exist", getName(), getRelativePath(transformedAppFolder, fileToBeChanged));
                return TOExecutionResult.noOp(this, details);
            }
            File readFile = getOrCreateReadFile(transformedAppFolder, transformationContext);
            reader = new BufferedReader(new InputStreamReader(new FileInputStream(readFile), StandardCharsets.UTF_8));
            writer = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(fileToBeChanged), StandardCharsets.UTF_8));
            String currentLine;
            boolean foundFirstMatch = false;
            String regex = "(" + propertyName + ".*)";
            final Pattern pattern = Pattern.compile(regex);
            EolBufferedReader eolReader = new EolBufferedReader(reader);
            while((currentLine = eolReader.readLineKeepStartEol()) != null) {
                if(!foundFirstMatch && pattern.matcher(removeEol(currentLine)).matches()) {
                    foundFirstMatch = true;
                    continue;
                }
                writer.write(currentLine);
            }

            if (foundFirstMatch) {
                details = String.format("Property '%s' has been removed from '%s'", propertyName, getRelativePath());
                result = TOExecutionResult.success(this, details);
            } else {
                TransformationOperationException toex = new TransformationOperationException(String.format("Property '%s' has not been removed from '%s' because it is not present", propertyName, getRelativePath()));
                result = TOExecutionResult.warning(this, toex);
            }
        } catch (IOException e) {
            result = TOExecutionResult.error(this, e);
        } finally {
            try {
                if (writer != null) try {
                    writer.close();
                } catch (IOException e) {
                    result.addWarning(e);
                }
            } finally {
                if(reader != null) try {
                    reader.close();
                } catch (IOException e) {
                    result.addWarning(e);
                }
            }
        }

        return result;
    }

}