jspwiki-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From juanpa...@apache.org
Subject svn commit: r1453060 - in /incubator/jspwiki/trunk/tests/org/apache/wiki: TranslationsCheck.java site/ site/SiteGeneratorTest.java
Date Tue, 05 Mar 2013 22:48:31 GMT
Author: juanpablo
Date: Tue Mar  5 22:48:30 2013
New Revision: 1453060

URL: http://svn.apache.org/r1453060
Log:
* JSPWIKI-764: ChangeLog published on site [1/2]

Added:
    incubator/jspwiki/trunk/tests/org/apache/wiki/site/
    incubator/jspwiki/trunk/tests/org/apache/wiki/site/SiteGeneratorTest.java
Modified:
    incubator/jspwiki/trunk/tests/org/apache/wiki/TranslationsCheck.java

Modified: incubator/jspwiki/trunk/tests/org/apache/wiki/TranslationsCheck.java
URL: http://svn.apache.org/viewvc/incubator/jspwiki/trunk/tests/org/apache/wiki/TranslationsCheck.java?rev=1453060&r1=1453059&r2=1453060&view=diff
==============================================================================
--- incubator/jspwiki/trunk/tests/org/apache/wiki/TranslationsCheck.java (original)
+++ incubator/jspwiki/trunk/tests/org/apache/wiki/TranslationsCheck.java Tue Mar  5 22:48:30
2013
@@ -108,8 +108,9 @@ public class TranslationsCheck
         		"Moving them to a special section in the file may be the better solution.");
     }
 
-    public static void diff(String source1, String source2) throws FileNotFoundException,
IOException
+    public static Map< String, Integer > diff(String source1, String source2) throws
FileNotFoundException, IOException
     {
+        int missing = 0, outdated = 0;
         // Standard Properties
         Properties p1 = new Properties();
         p1.load(new FileInputStream(new File(base + source1)));
@@ -126,14 +127,15 @@ public class TranslationsCheck
 
         System.out.println("Missing:");
         System.out.println("--------");
-        Iterator iter = sortedNames(p1).iterator();
+        Iterator< String > iter = sortedNames(p1).iterator();
         while (iter.hasNext())
         {
-            String name = (String) iter.next();
+            String name = iter.next();
             String value = p1.getProperty(name);
 
             if (p2.get(name) == null)
             {
+                missing++;
                 System.out.println(name + " = " + value);
             }
         }
@@ -144,18 +146,23 @@ public class TranslationsCheck
         iter = sortedNames(p2).iterator();
         while (iter.hasNext())
         {
-            String name = (String) iter.next();
+            String name = iter.next();
             String value = p2.getProperty(name);
 
             if (p1.get(name) == null)
             {
+                outdated++;
                 System.out.println(name + " = " + value);
             }
         }
         System.out.println();
+        Map< String, Integer > diff = new HashMap< String, Integer >( 2 );
+        diff.put( "missing", missing );
+        diff.put( "outdated", outdated );
+        return diff;
     }
 
-    private static List sortedNames(Properties p)
+    private static List<String> sortedNames(Properties p)
     {
         List<String> list = new ArrayList<String>();
         Enumeration iter = p.propertyNames();
@@ -168,7 +175,7 @@ public class TranslationsCheck
         return list;
     }
     
-    private static void detectDuplicates(String source) throws IOException
+    public static int detectDuplicates(String source) throws IOException
     {
         Properties p = new Properties();
         p.load(new FileInputStream(new File(base + source)));
@@ -181,6 +188,16 @@ public class TranslationsCheck
             if (!allProps.add(currentStr))
                 duplProps.add(currentStr);
         }
+        return duplProps.size();
+    }
+    
+    /**
+     * Allows reuse from {@link org.apache.wiki.site.SiteGeneratorTest}
+     */
+    public static void clearDuplicates() 
+    {
+        allProps.clear();
+        duplProps.clear();
     }
     
 }

Added: incubator/jspwiki/trunk/tests/org/apache/wiki/site/SiteGeneratorTest.java
URL: http://svn.apache.org/viewvc/incubator/jspwiki/trunk/tests/org/apache/wiki/site/SiteGeneratorTest.java?rev=1453060&view=auto
==============================================================================
--- incubator/jspwiki/trunk/tests/org/apache/wiki/site/SiteGeneratorTest.java (added)
+++ incubator/jspwiki/trunk/tests/org/apache/wiki/site/SiteGeneratorTest.java Tue Mar  5 22:48:30
2013
@@ -0,0 +1,285 @@
+package org.apache.wiki.site;
+
+import java.io.BufferedOutputStream;
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.text.ParseException;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+import junit.framework.TestCase;
+
+import org.apache.commons.io.FileUtils;
+import org.apache.commons.lang.StringUtils;
+import org.apache.commons.lang.time.DateUtils;
+import org.apache.log4j.Logger;
+import org.apache.wiki.Release;
+import org.apache.wiki.TranslationsCheck;
+
+
+/**
+ * Generates the following site's pages:
+ * 
+ * <ul>
+ *  <li><code>release.mdtext</code>: used at the end of the sidebar; displays
JSPWiki version</li>
+ *  <li><code>changelog.mdtext</code>: prettifies the Changelog file and
turns it into Markdown syntax</li>
+ *  <li><code>translations.mdtext</code>: shows the % completed of the
different translations' status</li>
+ * </ul>
+ * 
+ * This test file assumes you've checked out both app and site trunk following this structure:
+ * <pre>
+ *  ./                     [http://svn.apache.org/repos/asf/incubator/jspwiki]
+ *  ./trunk                [http://svn.apache.org/repos/asf/incubator/jspwiki/trunk]
+ *  ./site/trunk           [http://svn.apache.org/repos/asf/incubator/jspwiki/site/trunk]
+ * </pre>
+ * 
+ * Once you've run this test you should be able to commit the site's changes. Hopefully,

+ * the CI job will publish the site later on (only if the build is successful, that is)
+ */
+public class SiteGeneratorTest extends TestCase
+{
+
+    private static final Logger LOG = Logger.getLogger( SiteGeneratorTest.class );
+    
+    private static final String BASE_FILE_NAME = "../site/trunk/";
+    
+    private static final String I18N_BASE = "/etc/i18n/";
+    private static final String I18N_CORE = I18N_BASE + "CoreResources.properties";
+    private static final String I18N_TEMPLATE = I18N_BASE + "templates/default.properties";
+    private static final String I18N_PLUGIN = I18N_BASE + "plugin/PluginResources.properties";
+    
+    private static final Pattern p = Pattern.compile("JSPWIKI\\-([0-9]+)");
+
+    /**
+     * Generates site's pages from source content.
+     */
+    public void testGenerateSiteFiles() 
+    {
+        generateReleaseFile();
+        generateI18nStatusFile();
+        generateChangelogFile();
+    }
+    
+    /**
+     * generates <code>release.mdtext</code>; used at the end of the sidebar,
displays JSPWiki version.
+     */
+    void generateReleaseFile() 
+    {
+        String file = BASE_FILE_NAME + "templates/release.mdtext";
+        String content = "JSPWiki v" + Release.VERSTR;
+        write( file, content );
+    }
+    
+    /**
+     * generates <code>translations.mdtext</code>; shows the % completed of the
different translations' status.
+     */
+    void generateI18nStatusFile()
+    {
+        String file = BASE_FILE_NAME + "content/jspwiki/development/translations.mdtext";
+        StringBuilder sb = new StringBuilder( "## I18n current status\n" );
+        
+        String[] locales = new String[] { "de", "es", "fi", "fr", "it", "nl", "pt_BR", "ru",
"zh_CN" };
+        for( String locale : locales ) 
+        {
+            generateI18nStatusForGivenLocale( sb, locale );
+        }
+        write( file, sb.toString() );
+    }
+    
+    /**
+     * generates the translation status related to a given locale.
+     * 
+     * @param sb current content.
+     * @param i18n given locale.
+     */
+    void generateI18nStatusForGivenLocale( StringBuilder sb, String i18n )
+    {
+        sb.append( "\n* *" ).append( i18n ).append( " locale*\n" );
+        try
+        {
+            generateI18nStatusFromFile( sb, i18n, I18N_CORE );
+            generateI18nStatusFromFile( sb, i18n, I18N_TEMPLATE );
+            generateI18nStatusFromFile( sb, i18n, I18N_PLUGIN );
+        }
+        catch (IOException e)
+        {
+            LOG.error( e.getMessage(), e );
+        }
+    }
+    
+    /**
+     * generates the translation status related to one of the i18n files, for a given locale.
+     * 
+     * @param sb current content
+     * @param i18n given locale
+     * @param file i18n file to examine
+     */
+    void generateI18nStatusFromFile( StringBuilder sb, String i18n, String file ) throws
IOException 
+    {
+        String i18nFile = StringUtils.replace( file, ".properties", "_" + i18n + ".properties"
);
+        Map< String, Integer > diff = TranslationsCheck.diff( file, i18nFile );
+        int dup = TranslationsCheck.detectDuplicates( i18nFile );
+        sb.append( "** " ).append( i18nFile ).append( "\n" )
+          .append( "*** Missing: " ).append( diff.get( "missing" ) ).append( "\n" )
+          .append( "*** Outdated: " ).append( diff.get( "outdated" ) ).append( "\n" )
+          .append( "*** Duplicated: " ).append( dup ).append( "\n" );
+        TranslationsCheck.clearDuplicates();
+    }
+    
+    /**
+     * generates <code>changelog.mdtext</code>; prettifies the ChangeLog file
and turns it into Markdown syntax.
+     */
+    void generateChangelogFile() 
+    {
+        String file = BASE_FILE_NAME + "content/jspwiki/development/changelog.mdtext";
+        StringBuilder sb = new StringBuilder( "## Changelog\n\n" );
+        List< String > links = new ArrayList< String >();
+        try 
+        {
+            for( String line : FileUtils.readLines( new File( "./ChangeLog") ) ) 
+            {
+                parseChangeLogLine( line, sb, links );
+            }
+        }
+        catch( IOException e )
+        {
+            LOG.error( e.getMessage(), e );
+        }
+        
+        sb.append( "\n<div class=\"external\">\n\n" );
+        append( links, sb );
+        sb.append( "\n</div>\n\n" );
+        
+        write( file, sb.toString() );
+    }
+    
+    /**
+     * generates the content for a given line. If the line begins with a date it's assumed
to be a 
+     * header, if it's not, then is a regular line.
+     * 
+     * @param line given line.
+     * @param sb current content.
+     * @param links collection of links, to be able to print JIRA links later on.
+     */
+    void parseChangeLogLine( String line, StringBuilder sb, List< String > links )

+    {
+        if( lineBeginsWithDate( line ) ) 
+        {
+            sb.append( "##### " ).append( line ).append( "\n" );
+        }
+        else 
+        {
+            parseRegularLine( line, sb, links );
+        }
+    }
+    
+    /**
+     * generates the content for a <em>regular</em> line. Initial blank space
from ChangeLog is 
+     * removed and JIRA id's are replaced by regular Markdown links and stored on the collection
+     * of links.
+     * 
+     * @param line given line.
+     * @param sb current content.
+     * @param links collection of links, to be able to print JIRA links later on.
+     */
+    void parseRegularLine( String line, StringBuilder sb, List< String > links ) 
+    {
+        line = StringUtils.replace( line, "       ", StringUtils.EMPTY );
+        Matcher m = p.matcher( line );
+        while( m.find() ) 
+        {
+            String replace = StringUtils.replace( m.group( 0 ), "JSPWIKI-", "[JSPWIKI " );
+            replace += "][JIRA-" + StringUtils.replace( m.group( 0 ), "JSPWIKI-", StringUtils.EMPTY
) + "]";
+            links.add( "JIRA-" + StringUtils.replace( m.group( 0 ), "JSPWIKI-", StringUtils.EMPTY
) );
+            line = m.replaceFirst( replace );
+            m = p.matcher( line );
+        }
+        sb.append( line ).append( "\n" );
+    }
+    
+    /**
+     * checks if a given line begins with a date or not.
+     * 
+     * @param line given line.
+     * @return {@code true} if it does, {@code false} otherwise. 
+     */
+    boolean lineBeginsWithDate( String line ) 
+    {
+        boolean begins = false;
+        try
+        {
+            DateUtils.parseDate( StringUtils.substring( line, 0, 10 ), 
+                                 new String[]{ "yyyy-mm-dd", "yyyy/mm/dd" } );
+            begins = true;
+        }
+        catch (ParseException e)
+        {
+            LOG.info( "Not a date, so it's not a heading" );
+        }
+        return begins;
+    }
+    
+    /**
+     * appends the collection of links to the generated content so far.
+     * 
+     * @param links collection of links.
+     * @param sb generated content so far.
+     */
+    void append( List< String > links, StringBuilder sb )
+    {
+        for( String link : links ) 
+        {
+            sb.append( "  [" ).append( link )
+              .append( "]: https://issues.apache.org/jira/browse/" )
+              .append( StringUtils.replace( link, "JIRA", "JSPWIKI" ) )
+              .append( "\n" );
+        }
+    }
+    
+    /**
+     * Writes the file with the given content.
+     * 
+     * @param filename where to write.
+     * @param content what to write.
+     */
+    void write( String filename, String content )  
+    {
+        BufferedOutputStream bos = null;
+        try
+        {
+            LOG.info( "Attempting to write " + filename );
+            File file = new File( filename );
+            if( !file.exists() ) 
+            {
+                file.createNewFile();
+            }
+            FileOutputStream fos = new FileOutputStream( file );
+            bos = new BufferedOutputStream( fos );
+            bos.write( content.getBytes() );
+        }
+        catch( IOException e )
+        {
+            LOG.error( e.getMessage(), e );
+        } 
+        finally 
+        {
+            if( bos != null )
+            {
+                try
+                {
+                    bos.flush();
+                    bos.close();
+                }
+                catch( IOException e )
+                {
+                    LOG.error( e.getMessage(), e );
+                }
+            }
+        }
+    }
+    
+}



Mime
View raw message