Merge pull request #4020 from edx/clytwynec/rake2paver-i18n

Clytwynec/rake2paver i18n

docs/en_us/developers/source/i18n.rst

@@ -217,18 +217,17 @@ the strings, or checking the translations into Github, see use cases).
    take a minute or two to complete::
 
     $ cd edx-platform
-    $ rake assets
-    $ rake i18n:extract
+    $ paver i18n_extract
 
 2. Generate dummy strings:  See coverage testing (below) for more details. This
    will create an "Esperanto" translation that is actually over-accented
    English.  Use this to create fake translations::
 
-    $ rake i18n:dummy
+    $ paver i18n_dummy
     
-3. Run the rake i18n:generate command to create machine-readable .mo files::
+3. Run the paver i18n_generate command to create machine-readable .mo files::
  
-    $ rake i18n:generate
+    $ paver i18n_generate
 
 4. Django should be ready to go. The next time you run Studio or LMS, append
    ``?preview-lang=eo`` to the URL to turn on Esperanto as a dark language. The
@@ -259,7 +258,7 @@ and correct specific gaps in compliance.
 
 Use the coverage tool to generate dummy files::
 
-    $ rake i18n:dummy
+    $ paver i18n_dummy
     
 This will create new dummy translations in the Esperanto directory
 (edx-platform/conf/local/eo/LC_MESSAGES).

pavelib/__init__.py

 """
 paver commands
 """
-from . import assets, servers, docs, prereqs, quality, tests, js_test
+from . import assets, servers, docs, prereqs, quality, tests, js_test, i18n

pavelib/assets.py

@@ -3,7 +3,7 @@ Asset compilation and collection.
 """
 from __future__ import print_function
 import argparse
-from paver.easy import sh, path, task, cmdopts, needs, consume_args, call_task
+from paver.easy import sh, path, task, cmdopts, needs, consume_args, call_task, no_help
 from watchdog.observers import Observer
 from watchdog.events import PatternMatchingEventHandler
 import glob
@@ -113,6 +113,8 @@ def coffeescript_files():
     return cmd('find', dirs, '-type f', '-name \"*.coffee\"')
 
 
+@task
+@no_help
 def compile_coffeescript(*files):
     """
     Compile CoffeeScript to JavaScript.

pavelib/i18n.py

+"""
+Internationalization tasks
+"""
+import sys
+import subprocess
+from path import path
+from paver.easy import task, cmdopts, needs, sh
+from pavelib.utils.envs import Env
+
+try:
+    from pygments.console import colorize
+except ImportError:
+    colorize = lambda color, text: text  # pylint: disable-msg=invalid-name
+
+
+@task
+@needs(
+    "pavelib.i18n.i18n_validate_gettext",
+    "pavelib.assets.compile_coffeescript",
+)
+@cmdopts([
+    ("verbose", "v", "Sets 'verbose' to True"),
+])
+def i18n_extract(options):
+    """
+    Extract localizable strings from sources
+    """
+    verbose = getattr(options, "verbose", None)
+    cmd = Env.REPO_ROOT / "i18n" / "extract.py"
+
+    if verbose:
+        cmd += " -vv"
+
+    sh(cmd)
+
+
+@task
+@needs("pavelib.i18n.i18n_extract")
+def i18n_generate():
+    """
+    Compile localizable strings from sources, extracting strings first.
+    """
+    cmd = Env.REPO_ROOT / "i18n" / "generate.py"
+    sh(cmd)
+
+
+@task
+@needs("pavelib.i18n.i18n_extract")
+def i18n_generate_strict():
+    """
+    Compile localizable strings from sources, extracting strings first.
+    Complains if files are missing.
+    """
+    cmd = Env.REPO_ROOT / "i18n" / "generate.py"
+    sh(cmd + " --strict")
+
+
+@task
+@needs("pavelib.i18n.i18n_extract")
+def i18n_dummy():
+    """
+    Simulate international translation by generating dummy strings
+    corresponding to source strings.
+    """
+    cmd = Env.REPO_ROOT / "i18n" / "dummy.py"
+    sh(cmd)
+
+
+@task
+def i18n_validate_gettext():
+    """
+    Make sure GNU gettext utilities are available
+    """
+
+    returncode = subprocess.call(['which', 'xgettext'])
+
+    if returncode != 0:
+        msg = colorize(
+            'red',
+            "Cannot locate GNU gettext utilities, which are "
+            "required by django for internationalization.\n (see "
+            "https://docs.djangoproject.com/en/dev/topics/i18n/"
+            "translation/#message-files)\nTry downloading them from "
+            "http://www.gnu.org/software/gettext/ \n"
+        )
+
+        sys.stderr.write(msg)
+        sys.exit(1)
+
+
+@task
+def i18n_validate_transifex_config():
+    """
+    Make sure config file with username/password exists
+    """
+    home = path('~').expanduser()
+    config = home / '.transifexrc'
+
+    if not config.isfile or config.getsize == 0:
+        msg = colorize(
+            'red',
+            "Cannot connect to Transifex, config file is missing"
+            " or empty: {config} \nSee "
+            "http://help.transifex.com/features/client/#transifexrc \n".format(
+                config=config,
+            )
+        )
+
+        sys.stderr.write(msg)
+        sys.exit(1)
+
+
+@task
+@needs("pavelib.i18n.i18n_validate_transifex_config")
+def i18n_transifex_push():
+    """
+    Push source strings to Transifex for translation
+    """
+    cmd = Env.REPO_ROOT / "i18n" / "transifex.py"
+    sh("{cmd} push".format(cmd=cmd))
+
+
+@task
+@needs("pavelib.i18n.i18n_validate_transifex_config")
+def i18n_transifex_pull():
+    """
+    Pull translated strings from Transifex
+    """
+    cmd = Env.REPO_ROOT / "i18n" / "transifex.py"
+    sh("{cmd} pull".format(cmd=cmd))
+
+
+@task
+@needs(
+    "pavelib.i18n.i18n_transifex_pull",
+    "pavelib.i18n.i18n_extract",
+    "pavelib.i18n.i18n_dummy",
+    "pavelib.i18n.i18n_generate_strict",
+)
+def i18n_robot_pull():
+    """
+    Pull source strings, generate po and mo files, and validate
+    """
+    sh('git clean -fdX conf/locale')
+    sh('paver test_i18n')
+    sh('git add conf/locale')
+
+    sh(
+        'git commit --message="Update translations '
+        '(autogenerated message)" --edit'
+    )
+
+
+@task
+@needs(
+    "pavelib.i18n.i18n_extract",
+    "pavelib.i18n.i18n_transifex_push",
+)
+def i18n_robot_push():
+    """
+    Extract new strings, and push to transifex
+    """
+    pass

rakelib/helpers.rb

@@ -4,15 +4,6 @@ require 'colorize'
 require 'timeout'
 require 'net/http'
 
-def find_executable(exec)
-    path = %x(which #{exec}).strip
-    $?.exitstatus == 0 ? path : nil
-end
-
-def select_executable(*cmds)
-    cmds.find_all{ |cmd| !find_executable(cmd).nil? }[0] || fail("No executables found from #{cmds.join(', ')}")
-end
-
 def django_admin(system, env, command, *args)
     return "./manage.py #{system} --settings #{env} #{command} --traceback #{args.join(' ')}"
 end

rakelib/i18n.rake

-# --- Internationalization tasks
-
-I18N_REPORT_DIR = report_dir_path('i18n')
-I18N_XUNIT_REPORT = File.join(I18N_REPORT_DIR, 'nosetests.xml')
-
-directory I18N_REPORT_DIR
-
-
-namespace :i18n do
-
-  desc "Extract localizable strings from sources"
-  task :extract => ["i18n:validate:gettext", "assets:coffee"] do
-    command = File.join(REPO_ROOT, "i18n", "extract.py")
-    if verbose == true
-      command += " -vv"
-    end
-    sh(command)
-  end
-
-  desc "Compile localizable strings from sources, extracting strings first."
-  task :generate => "i18n:extract" do
-    cmd = File.join(REPO_ROOT, "i18n", "generate.py")
-    sh("#{cmd}")
-  end
-
-  desc "Compile localizable strings from sources, extracting strings first, and complain if files are missing."
-  task :generate_strict => "i18n:extract" do
-    cmd = File.join(REPO_ROOT, "i18n", "generate.py")
-    sh("#{cmd} --strict")
-  end
-
-  desc "Simulate international translation by generating dummy strings corresponding to source strings."
-  task :dummy => "i18n:extract" do
-    sh(File.join(REPO_ROOT, "i18n", "dummy.py"))
-  end
-
-  namespace :validate do
-
-    desc "Make sure GNU gettext utilities are available"
-    task :gettext do
-      begin
-        select_executable('xgettext')
-      rescue
-        msg = "Cannot locate GNU gettext utilities, which are required by django for internationalization.\n"
-        msg += "(see https://docs.djangoproject.com/en/dev/topics/i18n/translation/#message-files)\n"
-        msg += "Try downloading them from http://www.gnu.org/software/gettext/"
-        abort(msg.red)
-      end
-    end
-
-    desc "Make sure config file with username/password exists"
-    task :transifex_config do
-      config_file = "#{Dir.home}/.transifexrc"
-      if !File.file?(config_file) or File.size(config_file)==0
-        msg ="Cannot connect to Transifex, config file is missing or empty: #{config_file}\n"
-        msg += "See http://help.transifex.com/features/client/#transifexrc"
-        abort(msg.red)
-      end
-    end
-  end
-
-  namespace :transifex do
-    desc "Push source strings to Transifex for translation"
-    task :push => "i18n:validate:transifex_config" do
-      cmd = File.join(REPO_ROOT, "i18n", "transifex.py")
-      sh("#{cmd} push")
-    end
-
-    desc "Pull translated strings from Transifex"
-    task :pull => "i18n:validate:transifex_config" do
-      cmd = File.join(REPO_ROOT, "i18n", "transifex.py")
-      sh("#{cmd} pull")
-    end
-  end
-
-  # Commands for automating the process of including translations in edx-platform.
-  # Will eventually be run by jenkins.
-  namespace :robot do
-    desc "Pull source strings, generate po and mo files, and validate"
-    task :pull => ["i18n:transifex:pull", "i18n:extract", "i18n:dummy", "i18n:generate_strict"] do
-      sh('git clean -fdX conf/locale')
-      Rake::Task["i18n:test"].invoke
-      sh('git add conf/locale')
-      sh('git commit --message="Update translations (autogenerated message)" --edit')
-    end
-
-    desc "Extract new strings, and push to transifex"
-    task :push => ["i18n:extract", "i18n:transifex:push"]
-  end
-
-end

rakelib/i18n_deprecated.rake

+# Internationalization tasks deprecated to paver
+
+require 'colorize'
+
+def deprecated(deprecated, deprecated_by, *args)
+
+    task deprecated do
+
+        # Need to install paver dependencies for the commands to work!
+        sh("pip install -r requirements/edx/paver.txt")
+
+        new_cmd = deprecated_by
+
+        puts("Task #{deprecated} has been deprecated. Using #{deprecated_by} instead.".red)
+        sh(new_cmd)
+        exit
+    end
+end
+
+deprecated("i18n:extract", "paver i18n_extract")
+deprecated("i18n:generate", "paver i18n_generate")
+deprecated("i18n:generate_strict", "paver i18n_generate_strict")
+deprecated("i18n:dummy", "paver i18n_dummy")
+deprecated("i18n:validate:gettext", "paver i18n_validate_gettext")
+deprecated("i18n:validate:transifex_config", "paver i18n_validate_transifex_config")
+deprecated("i18n:transifex:push", "paver i18n_transifex_push")
+deprecated("i18n:transifex:pull", "paver i18n_transifex_pull")
+deprecated("i18n:robot:push", "paver i18n_robot_push")
+deprecated("i18n:robot:pull", "paver i18n_robot_pull")