com.github.edgarespina.mwa.wro4j.RequireJSContribution Maven / Gradle / Ivy

Go to download
package com.github.edgarespina.mwa.wro4j;

import static org.apache.commons.io.FilenameUtils.getBaseName;
import static org.apache.commons.io.FilenameUtils.getName;
import static org.apache.commons.io.FilenameUtils.getPath;

import java.io.IOException;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.apache.commons.io.FilenameUtils;
import org.apache.commons.lang3.Validate;
import org.springframework.web.servlet.ModelAndView;

import ro.isdc.wro.manager.factory.BaseWroManagerFactory;
import ro.isdc.wro.model.group.Group;
import ro.isdc.wro.model.resource.Resource;

import com.google.common.collect.Sets;

/**
 * Publish a module attribute that define a require.js bootstrapping function.
 * It takes care of dev/no-dev environments.
 * This contribution read a wro.xml file and use wro groups to build
 * require.config instructions.
 * FIXME: make me better and use r.js
 *
 * @author edgar.espina
 * @since 0.2.2
 */
public class RequireJSContribution extends WroContribution {

  /**
   * Require.js default timeout.
   */
  private static final int DEFAULT_TIMEOUT = 7;

  /**
   * Specify if a require.js module should wait for a dom-ready event before
   * start loading.
   *
   * @author [email protected]
   * @since 0.6
   */
  public static enum LoadOn {
    /**
     * No wait, load inmediately.
     */
    INMEDIATELY {
      @Override
      public String load(final String module) {
        return "require([\"" + module + "\"]);\n";
      }
    },

    /**
     * Wait for dom-ready and use jQuery.
     */
    JQUERY_DOM_READY {
      @Override
      public String load(final String module) {
        StringBuilder buffer = new StringBuilder();
        buffer.append("require(['jquery'], function($) {\n");
        buffer.append("  $(function() {\n");
        buffer.append("    require(['").append(module).append("']);\n");
        buffer.append("  });\n");
        buffer.append("});\n");
        return buffer.toString();
      }
    },

    /**
     * Wait for dom-ready and use require.js dom ready module.
     */
    REQUIRE_DOM_READY {
      @Override
      public String load(final String module) {
        throw new UnsupportedOperationException();
      }
    };

    /**
     * Build the load call.
     *
     * @param module The module.
     * @return The load script call.
     */
    public abstract String load(String module);
  }

  /**
   * The default variable's name.
   */
  public static final String VARIABLE_NAME = "requireConfig";

  /**
   * The variable's name.
   */
  private String variableName;

  /**
   * The number of seconds to wait before giving up on loading a script. The
   * default is 7 seconds.
   */
  private int waitSeconds = DEFAULT_TIMEOUT;

  /**
   * Should the require.js call wait for dom ready or not?
   */
  private LoadOn loadOn = LoadOn.INMEDIATELY;

  /**
   * Creates a new {@link RequireJSContributionFixed} and publish require
   * bootstrapping script as a model attribute using the {@link #VARIABLE_NAME}.
   *
   * @param wroManagerFactory The {@link BaseWroManagerFactory}. Required.
   */
  public RequireJSContribution(
      final BaseWroManagerFactory wroManagerFactory) {
    super(wroManagerFactory);
    this.variableName = VARIABLE_NAME;
  }

  /**
   * Publish a module attribute that define a require.js bootstrapping function.
   * It takes care of dev/no-dev environments.
   * This contribution read a wro.xml file and use wro groups to build
   * require.config instructions. {@inheritDoc}
   */
  @Override
  protected void doContribution(final Group group,
      final ModelAndView modelAndView, final Map groups)
      throws IOException {
    String view = modelAndView.getViewName();
    List resources = group.getResources();
    String contextPath = (String) modelAndView.getModel().get(CONTEXT_PATH);
    StringBuilder buffer = new StringBuilder();
    // 1. Add the require.js script
    buffer.append("\n");
    // 2. require.config
    buffer.append("\n");
    // 5. Publish as a model attribute.
    modelAndView.getModel().put(variableName, buffer.toString());
    logger.debug("Publishing {}:\n{}", variableName, buffer);
  }

  /**
   * The number of seconds to wait before giving up on loading a script. The
   * default is 7 seconds.
   *
   * @param waitSeconds The number of seconds to wait before giving up on
   *        loading a script. The default is 7 seconds.
   * @return This {@link RequireJSContributionFixed}.
   */
  public RequireJSContribution waitSeconds(final int waitSeconds) {
    this.waitSeconds = waitSeconds;
    return this;
  }

  /**
   * Should the require.js call wait for dom ready or not?
   *
   * @param loadOn The load-on strategy. Required.
   * @return This require contribution.
   */
  public RequireJSContribution withLoadOn(final LoadOn loadOn) {
    Validate.notNull(loadOn, "The load-on strategy is required.");
    this.loadOn = loadOn;
    return this;
  }

  /**
   * Read from wro.xml the 'require' group and return the location of it.
   *
   * @param requireJs The require.js group.
   * @return The location of 'require.js'.
   */
  private String requireJs(final Group requireJs) {
    String uri = requireJs.getResources().get(0).getUri();
    return uri;
  }

  @Override
  protected Set additionalGroups() {
    return Sets.newHashSet("require");
  }

  @Override
  protected String varName() {
    return VARIABLE_NAME;
  }

  @Override
  protected String resourcesVarName() {
    return "";
  }
}