com.sap.prd.mobile.ios.mios.XCodeChangeVersionInPListMojo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xcode-maven-plugin

This plugin is used to run iOS Xcode builds with Maven. It also uses the Maven integration with a central artifact repository and the dependency resolution.

There is a newer version: 1.14.7

Show newest version

/*
 * #%L
 * xcode-maven-plugin
 * %%
 * Copyright (C) 2012 SAP AG
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package com.sap.prd.mobile.ios.mios;

import java.io.File;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashSet;

import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;

/**
 * Updates the properties CFBundleVersion and CFBundleShortVersionString inside the plist file(s)
 * that is/are denoted for the given configurations and sdks. The version is updated with a version
 * derived from the maven project version. For CFBundleVersion all version parts containing only
 * numbers are retained. The leading numbers of the first version part containing characters are
 * also retained. Any subsequent version part is ommited.
 * 
 * For CFBundleShortVersion the same strategy as described for CFBundleVersion applies. Additionally
 * the version is truncated so that it consists of three numbers separated by two dots.
 * 
 * @goal change-versions-in-plist
 * @since 1.7.0
 */
public class XCodeChangeVersionInPListMojo extends BuildContextAwareMojo
{
  /**
   * If this parameter is set to true no version will be transferred into the Xcode
   * project.
   * 
   * @parameter expression="${xcode.skipVersionUpdate}" default-value="false"
   */
  private boolean skipVersionUpdate;

  @Override
  public void execute() throws MojoExecutionException, MojoFailureException
  {
    if (skipVersionUpdate) {
      getLog().info("Update of versions in info plist will be skipped.");
      return;
    }

    final Collection alreadyUpdatedPlists = new HashSet();

    Collection updateTasks = new HashSet(Arrays.asList(
          new UpdateCFBundleShortVersionStringInPListTask(),
          new UpdateCFBundleVersionInPListTask()));

    for (final String configuration : getConfigurations()) {
      for (final String sdk : getSDKs()) {
        File infoPlistFile = null;
        try {
          infoPlistFile = getPListFile(XCodeContext.SourceCodeLocation.WORKING_COPY, configuration, sdk);
        }
        catch (XCodeException e) {
          throw new MojoExecutionException(e.getMessage(), e);
        }
        if (alreadyUpdatedPlists.contains(infoPlistFile)) {
          getLog().debug("Version in PList file '" + infoPlistFile.getName()
                + "' was already updated for another configuration. This file will be skipped.");
        }
        else {

          try {

            ensurePListFileIsWritable(infoPlistFile);

            for (UpdateVersionInPListTask updateVersionInPListTask : updateTasks) {
              updateVersionInPListTask.setPListFile(infoPlistFile).setVersion(project.getVersion())
                .execute();
            }

            alreadyUpdatedPlists.add(infoPlistFile);

          }
          catch (XCodeException ex) {
            throw new MojoExecutionException(ex.getMessage(), ex);
          }
        }
      }
    }
  }

  private void ensurePListFileIsWritable(File pListFile) throws XCodeException
  {
    if (!pListFile.canWrite()) {
      if (!pListFile.setWritable(true, true))
        throw new XCodeException("Could not make plist file '" + pListFile + "' writable.");

      getLog().info("Made PList file '" + pListFile + "' writable.");
    }
  }
}