closure.py

#!/usr/bin/python
#
# Copyright 2011 Google Inc. All Rights Reserved.
#
# 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.


"""Functionality related to the closure and soy compilers."""

__author__ = 'jasonstredwick@google.com (Jason Stredwick)'


import os
import sys

import deps as DEPS
import tools as TOOLS
import utils


COMMAND = 'command'
INPUTS = 'inputs'
OUTPUTS = 'outputs'


def CreateCssFlags():
  return [
    '--add_copyright',
    '--allow_unrecognized_functions',
    '--allowed_non_standard_function=color-stop',
    '--allowed_non_standard_pseudo_type=nth-child',
    '--allowed_non_standard_function=-moz-linear-gradient',
    '--allowed_non_standard_function=-webkit-gradient',
    '--allowed_non_standard_function=from',
    '--allowed_non_standard_function=to',
    '--allowed_non_standard_function=alpha',
    '--allow_ie_function_syntax',
    '--allow_unrecognized_pseudo_types',
    '--simplify_css',
    '--eliminate_dead_styles',
  ]


def CreateClosureCompilerCommand(deps, flags, controls, deps_location=''):
  builder = os.path.join(deps_location, deps[DEPS.CLOSURE_LIB][DEPS.ROOT],
                         'closure', 'bin', 'build', 'closurebuilder.py')

  compiler = deps[DEPS.CLOSURE_COMPILER][DEPS.ROOT]
  if deps_location:
    compiler = os.path.join(deps_location, compiler)

  command_base = [sys.executable,
                  builder,
                  '--output_mode=compiled',
                  '--compiler_jar=%s' % compiler]
  return {
    COMMAND: command_base + controls + flags,
    INPUTS: '--input=%s',
    OUTPUTS: '--output_file=%s'
  }


def CreateClosureCompilerFlags(deps, debug=True, deps_location=''):
  deps_src = os.path.join(deps_location, deps[DEPS.CLOSURE_LIB][DEPS.ROOT],
                          'closure', 'goog', 'deps.js')

  debug_flags = [
    '--compiler_flags=--formatting=pretty_print',
    '--compiler_flags=--generate_exports',
    '--compiler_flags=--js=%s' % deps_src
  ]

  prod_flags = [
  ]

  if debug:
    compile_level = debug_flags
  else:
    compile_level = prod_flags

  return compile_level + [
    #'--compiler_flags=--aggressive_var_check_level=ERROR',
    #'--compiler_flags=--check_global_names_level=ERROR',
    '--compiler_flags=--jscomp_error=accessControls',
    '--compiler_flags=--jscomp_error=ambiguousFunctionDecl',
    '--compiler_flags=--jscomp_error=checkRegExp',
    #'--compiler_flags=--jscomp_error=checkTypes',
    #'--compiler_flags=--jscomp_error=checkVars',
    '--compiler_flags=--jscomp_error=constantProperty',
    '--compiler_flags=--jscomp_error=deprecated',
    '--compiler_flags=--jscomp_error=fileoverviewTags',
    '--compiler_flags=--jscomp_error=globalThis',
    '--compiler_flags=--jscomp_error=invalidCasts',
    '--compiler_flags=--jscomp_error=missingProperties',
    '--compiler_flags=--jscomp_error=nonStandardJsDocs',
    '--compiler_flags=--jscomp_error=strictModuleDepCheck',
    '--compiler_flags=--jscomp_error=undefinedVars',
    '--compiler_flags=--jscomp_error=unknownDefines',
    '--compiler_flags=--jscomp_error=visibility'
  ]


def CreateSoyCompilerCommand(deps, flags, deps_location=''):
  compiler = os.path.join(deps_location,
                          deps[DEPS.CLOSURE_SOY_COMPILER][DEPS.ROOT])

  java = TOOLS.GetExecutable(TOOLS.JAVA)
  return {
    COMMAND: ['java', '-jar', compiler] + flags + ['--outputPathFormat'],
    INPUTS: '%s',
    OUTPUTS: '%s'
  }


def CreateSoyCompilerFlags():
  return [
    '--shouldProvideRequireSoyNamespaces',
    '--shouldGenerateJsdoc'
  ]


def CompileScript(src, dst, command, on_complete=None, force_compile=False):
  """Compile a script based on the given input file.

  Args:
    src: The target source file to be compiled. (string)
    dst: The file to create. (string)
    command: The compile command to use.

  Returns:
    The process which actually is executing the command.
  """
  # For speed, only compile the script if it is not already compiled.
  if not force_compile and os.path.exists(dst):
    return None

  if os.path.exists(dst):
    os.remove(dst)

  inputs = command[INPUTS] % src
  outputs = command[OUTPUTS] % dst
  full_command = command[COMMAND] + [outputs, inputs] # Specific order
  # TODO (jason.stredwick): Temporary fix for Windows under new build.
  no_wait = True
  if utils.IsOsWindows():
    no_wait = False
  return utils.ExecuteCommand(full_command, on_complete=on_complete,
                              no_wait=no_wait)


class OnComplete:
  def __init__(self, src, dst, verbose, fail_early, indent=0):
    self.src = src
    self.dst = dst
    self.verbose = verbose
    self.fail_early = fail_early
    self.indent = utils.GetIndentString(indent)

  def __call__(self, success, out, cancelled=False):
    try:
      if cancelled:
        raise Exception

      if success and os.path.exists(self.dst):
        if self.verbose:
          print '%s[SUCCESS] Compiling %s' % (self.indent, self.src)
      else:
        raise Exception
    except Exception:
      if os.path.exists(self.dst):
        os.remove(self.dst)

      if cancelled:
        return

      print '%s[FAILED]  Compiling %s' % (self.indent, self.src)
      if out:
        print out
        print ''

      if self.fail_early:
        exit()