make_new_module.py

#!/usr/bin/env python

# This script is for creating a new herd animal.  Just run this script
# from the "stork" directory supplying a new animal name and it should
# create a complete application template built with support for both
# MOOSE and ELK.  Enjoy!

import os, sys, string, re, subprocess
from optparse import OptionParser
from shutil import copytree, ignore_patterns

global_ignores = ['.svn', '.git']
global_app_name = ''
global_app_name_stripped = ''
global_rename_suffix = 'module'

def renameFiles(app_path):
  rename_pattern = re.compile(r'(stork)(.*)', re.I)
  suffix_pattern = re.compile(r'(.*)\.' + global_rename_suffix + '$')

  for dirpath, dirnames, filenames in os.walk(app_path):
    # Don't traverse into ignored directories
    for ignore in global_ignores:
      if ignore in dirnames:
        dirnames.remove(ignore)

    for file in filenames:
      match = rename_pattern.match(file)

      # Replace 'stork' in the contents
      replaceNameInContents(dirpath + '/' + file)

      # See if the file needs to be renamed and rename
      if match != None:
        replace_string = replacementFunction(match)
        os.rename(dirpath + '/' + file, dirpath + '/' + replace_string + match.group(2))
        # update the file
        file = replace_string + match.group(2)

      # If there are files with .app suffixes drop the suffix
      match = suffix_pattern.search(file)
      if match != None:
        os.rename(dirpath + '/' + file, dirpath + '/' + match.group(1))


def replaceNameInContents(filename):
  f = open(filename)
  text = f.read()
  f.close()

  # Replace all instances of the word stork with the right case
  pattern = re.compile(r'(stork)', re.I)
  text = pattern.sub(replacementFunction, text)

  # Retrieve original file attribute to be applied later
  mode = os.stat(filename).st_mode

  # Now write the file back out
  f = open(filename + '~tmp', 'w')
  f.write(text)
  f.close()
  os.chmod(filename + '~tmp', mode)
  os.rename(filename + '~tmp', filename)

def replacementFunction(match):
  # There are 3 "case" cases
  # Case 1: all lower case
  if match.group(1) == 'stork':
    return global_app_name_stripped

  # Case 2: all upper case
  if match.group(1) == 'STORK':
    return string.upper(global_app_name_stripped)

  # Case 3: First letter is capitalized
  if match.group(1) == 'Stork':
    name = global_app_name_stripped.replace("_", " ")
    name = name.title()
    name = name.replace(" ", "")
    return name
  
  print match.group(0) + "\nBad Case Detected!"
  sys.exit(1)

def printUsage():
  print './make_new_module.py <module name> <moose dir>'
  sys.exit()

if __name__ == '__main__':
  parser = OptionParser()
  (global_options, args) = parser.parse_args()

  # Make sure an animal name was supplied (args[0])
  if len(args) != 2:
    printUsage()

  modules_dir = args[1] + '/modules/'
  if not os.path.exists(modules_dir):
    print "Unable to access ", modules_dir
    sys.exit()

  global_app_name = string.lower(args[0])
  global_app_name_stripped = global_app_name
  m = re.search(r'(\D*)', global_app_name)
  if m != None:
    global_app_name_stripped = m.group(1)

  # Copy the directory
  copytree('.', modules_dir + global_app_name, ignore=ignore_patterns('.svn', '.git', '*.app', 'make_new*', 'LICENSE'))

  renameFiles(modules_dir + global_app_name)

  print 'Your new module should be ready!\nYou need to edit the following files to include your new module into MOOSE:'
  print  modules_dir + 'modules.mk'
  print  modules_dir + 'combined/src/base/ModulesApp.C'