cubeengine / pericopist

Generates message catalogs.

Core: Maven plugin:

Description

The pericopist project consists of different modules. The main task of the project is to generate a message catalog containing all the string literals of a project by parsing its source tree.

Modules

• core
• maven-plugin

pericopist's Issues

Provide a default context

I'd like to get as much information out of the raw source code and into the messages catalogs as somehow possible.
Translations offen suffer from translators that don't have a clue of the context, a message is used in.
This context information usually has to be added manually where necessary, but we could also add some default context information based on the method the message was extracted from. Methods like sendTranslated() or the annotation fields provide a solid context.
This is also a place where updating ves generating makes a difference: generate would override the translations with the default context while update would not override the contexts already provided

Spoon as JDT replacement

Investigate https://github.com/INRIA/spoon as a replacement for JDT which provides a full blown meta model of the code.

Configurable charset

In the context of I18n It is fundamentally important to be able to specify the charset the the message catalogs will be encoded with.

To follow maven's build-by convention the plugin should take the project.build.sourceEncoding property as the default value for this. The project wide encoding should be consitent accross all files anyway

Read Annotations in Annotations

Reading Annotations in Annotations seems to not work yet

@MyAnnotation(@TranslateThis("I am translated"))

Load configuration from URI

For the CubeEngine we'll need to be able to load the configuration from an URI

Follow redirects for remote configurations

URLConnection does not handle HTTP 3XX redirects automatically.
Either handle them manually or switch to a different client (PLEASE)

Maybe something like Apache's http-comonents library.

Verify methods

Just like the verification of annotations this should be simple to implement.
Would be useful for the _() marker method.

Configuration fallbacks

A way to add multiple configuration in order to have fallbacks in case of the config files is not available.

Example:

1. ${basedir}/messagecatalog_configuration.xml
2. ${basedir}/../messagecatalog_configuration.xml
3. https://raw.github.com/CubeEngineDev/CubeEngine/master/messagecatalog_configuration.xml

Make file generation thread safe

Currently the message catalog is generated right where the user wants it, which might cause conflicts if to instances of the generator work on the same file.

For that reason I suggest writing the file to a temporary location using File.createTempFile() and then replacing the target file atomically using the approach suggested here: http://stackoverflow.com/a/10532430/1827771

Autodetect translation functions

Instead of using the manually created XML configuration to specify the functions that do translation, an auto detection mechanism would be great.

In Java, this could easily be implemented using an annotation with source retention. This annotation could provide the same details as the XML configuration:

@Percopist(singlar = 0, plurals = {1})

Other languages could use comments or source macros.

rename to messageextractor-maven-plugin

messagecatalog tells not much about the actual functionality of the plugin

Link source comments to the message

http://stackoverflow.com/questions/7665274/gettext-automatic-comments-generation

Inconsistant pot entry order across systems

Possibly a locale issue in the ordering

Read Arrays in Annotations

public @interface MyAnnotation
{
    String[] value();
}

Each String should be translated separatly

Extraction from annotation message does not work

The extraction from the label annotation field of that annotation doesn't work:

@IParams({@Grouped(@Indexed(label = "name")),
              @Grouped(req = false, value = @Indexed(label = "universe"))})

but the following works:

@IParams(@Grouped(@Indexed(label = "name")))

Maybe it's because there is more than one Grouped annotation specified in the first case?

Configurable metadata

Messages catalog formats like Gettext also contain meta information.
This information should be configurable for new catalogs and should be retained when updating existing catalogs.

Read messages from constructor calls

I encountered this during the merge of the command branch in the CubeEngine project.
Some of the exceptions there carry user messages which need to be translated.

implement ScalaMessageExtractor

implement a MessageExtractor class for the language Scala. Hint

Configuration inheritance

the summary nails it

Only write the catalog if changed

Currently the catalogs are always rewritten with a new timestamp even though they didn't change, that causes unnecessary diffs

implement CMessageExtractor

implement a MessageExtractor class for the C language. Hint