Merge pull request #32 from transifex/migrate-text-mode

Add direct text migration mode

Author: Dimitrios Bendilas

tests/native/django/test_commands/test_migratetransifex.py

@@ -5,6 +5,7 @@
 from django.core.management import call_command
 from tests.native.django.test_tools.test_migrations.test_templatetags import (
     DJANGO_TEMPLATE, TRANSIFEX_TEMPLATE)
+from transifex.common.console import Color
 from transifex.native.django.management.commands.transifex import Command
 from transifex.native.django.management.common import TranslatableFile
 from transifex.native.tools.migrations.review import (FileReviewPolicy,
@@ -341,3 +342,45 @@ def test_replace_save_string_review(mock_find_files, mock_read,
     assert mock_save_file.call_args[0][0] == 'dir1/dir2/1.html'
     migration_compile = mock_save_file.call_args[0][1]
     assert migration_compile() == HTML_COMPILED_1
+
+
+@mock.patch('transifex.common.console.Color.echo')
+def test_text_migration_template_code(mock_echo):
+    """Test the mode that migrates directly given text instead of files
+    (Django HTML templates)."""
+    command = Command()
+    call_command(command, 'migrate', text=DJANGO_TEMPLATE)
+    expected = Color.format(
+        '\n[high]Transifex Native syntax:[end]\n[green]{}[end]'.format(
+            TRANSIFEX_TEMPLATE
+        )
+    )
+    actual = Color.format(mock_echo.call_args_list[1][0][0])
+    assert expected == actual
+
+    # Make sure it's idempotent
+    mock_echo.reset_mock()
+    call_command(command, 'migrate', text=TRANSIFEX_TEMPLATE)
+    actual = Color.format(mock_echo.call_args_list[1][0][0])
+    assert expected == actual
+
+
+@mock.patch('transifex.common.console.Color.echo')
+def test_text_migration_python_code(mock_echo):
+    """Test the mode that migrates directly given text instead of files
+    (Python/gettext code)."""
+    command = Command()
+    call_command(command, 'migrate', text=PYTHON_SAMPLE)
+    expected = Color.format(
+        '\n[high]Transifex Native syntax:[end]\n[green]{}[end]'.format(
+            PYTHON_SAMPLE_MIGRATED
+        )
+    )
+    native = Color.format(mock_echo.call_args_list[1][0][0])
+    assert expected == native
+
+    # Make sure it's idempotent
+    mock_echo.reset_mock()
+    call_command(command, 'migrate', text=PYTHON_SAMPLE_MIGRATED)
+    actual = Color.format(mock_echo.call_args_list[1][0][0])
+    assert expected == actual

transifex/native/django/management/utils/migrate.py

@@ -13,7 +13,8 @@
 from transifex.native.tools.migrations.execution import (MARK_POLICY_OPTIONS,
                                                          REVIEW_POLICY_OPTIONS,
                                                          SAVE_POLICY_OPTIONS,
-                                                         MigrationExecutor)
+                                                         MigrationExecutor,
+                                                         migrate_text)
 from transifex.native.tools.migrations.gettext import (GettextMethods,
                                                        GettextMigrationBuilder)
 
@@ -93,6 +94,12 @@ def add_arguments(self, subparsers):
             '--path', '-p', dest='path',
             help='The path of the files to migrate. Finds files recursively.',
         )
+        parser.add_argument(
+            '--text', '-t', dest='text', default='',
+            help='If set, the migration command will display the result '
+                 'of converting the given text to Transifex Native syntax, '
+                 'and then exit.',
+        )
         parser.add_argument(
             '--save', dest='save_policy', default='new',
             help=('Determines where the migrated content will be saved: \n' +
@@ -120,6 +127,22 @@ def handle(self, *args, **options):
         self.stats = {
             'processed_files': 0, 'migrations': [], 'saved': [], 'errors': [],
         }
+
+        # Create a reusable migrator for templates code
+        self.django_migration_builder = DjangoTagMigrationBuilder()
+        self.gettext_migration_builder = GettextMigrationBuilder(
+            methods=GettextMethods(**GETTEXT_FUNCTIONS),
+            import_statement=T_IMPORT,
+        )
+
+        # -- Text mode: simply transform the given text and exit
+        text = options['text']
+        if text:
+            migrate_text(text, self._migrate_text)
+            return
+
+        # -- File mode: read all files based on the given options and migrate
+        # each of them
         self.executor = MigrationExecutor(
             options, file_migrator_func=self._migrate_file,
         )
@@ -138,18 +161,27 @@ def handle(self, *args, **options):
         else:
             files = self._find_files(self.path, 'migrate')
 
-        # Create a reusable migrator for templates code
-        self.django_migration_builder = DjangoTagMigrationBuilder()
-        self.gettext_migration_builder = GettextMigrationBuilder(
-            methods=GettextMethods(**GETTEXT_FUNCTIONS),
-            import_statement=T_IMPORT,
-        )
-
         # Execute the migration
         self.executor.migrate_files(files)
 
+    def _migrate_text(self, text):
+        """Create a migration to Native syntax for the given string.
+
+        Supports both Python files and Django template files.
+
+        :param unicode text: the code string
+        :return: an object with the migration info
+        :rtype: FileMigration
+        """
+        # Template code
+        if '{%' in text:
+            return self.django_migration_builder.build_migration(text, '')
+        # Python code
+        else:
+            return self.gettext_migration_builder.build_migration(text, '')
+
     def _migrate_file(self, translatable_file):
-        """Extract source strings from the given file.
+        """Create a migration to Native syntax for the given file.
 
         Supports both Python files and Django template files.
 

transifex/native/tools/migrations/execution.py

@@ -60,9 +60,8 @@ class MigrationExecutor(object):
     """Responsible for orchestrating a migration of multiple files
     to Transifex Native syntax.
 
-
     It guides the user throughout the process, providing important
-    feedback in the console. It supports various "review" and "save"
+    feedback in the console. It supports various "review", "save" and "mark"
     policies, that determine what the user is asked to accept or reject
     before being saved, and the file location the changes are saved in.
 
@@ -81,9 +80,9 @@ def __init__(self, options, file_migrator_func):
                 current location
              - 'review_policy' (see REVIEW_POLICY_OPTIONS)
              - 'save_policy' (SAVE_POLICY_OPTIONS)
-        :param func file_migrator_func: a function that is responsible for
-            getting a TranslatableFile object and returning a FileMigration
-            object
+        :param callable file_migrator_func: a callable that is responsible for
+            getting an object (e.g. a TranslatableFile) and returning
+            a FileMigration object
         """
         self.options = options
         self.file_migrator_func = file_migrator_func
@@ -428,3 +427,25 @@ def _show_results(self, files, stats):
             Color.echo(errors_str)
 
         Color.echo('')
+
+
+def migrate_text(text, migrator_func):
+    """Convert the given text from the original framework to Native syntax.
+
+    Supports both HTML/template syntax and Python/gettext syntax.
+    Prints out the result in the console.
+
+    :param unicode text: the text to migrate to Native syntax
+    :param callable migrator_func: a Callable[unicode] -> FileMigration object
+        that converts syntax to Transifex Native; provided externally
+        so that it can support any Python framework (e.g. Django)
+    """
+    Color.echo(
+        '[high]Original syntax:[end]\n[red]{}[end]'.format(text)
+    )
+    file_migration = migrator_func(text)
+    Color.echo(
+        '\n[high]Transifex Native syntax:[end]\n[green]{}[end]'.format(
+            file_migration.compile()
+        )
+    )