[MASSEMBLY-748] ability so specifiy encoding for unpackOptions

git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk@1674674 13f79535-47bb-0310-9956-ffa450edef68

Author: krosenvold

pom.xml

@@ -57,7 +57,7 @@ under the License.
   </distributionManagement>
 
   <properties>
-    <mdoVersion>1.1.2</mdoVersion>
+    <mdoVersion>1.1.3</mdoVersion>
     <mavenArchiverVersion>2.5</mavenArchiverVersion>
     <mavenFilteringVersion>1.3</mavenFilteringVersion>
     <mavenVersion>2.2.1</mavenVersion>
@@ -124,7 +124,7 @@ under the License.
     <dependency>
       <groupId>org.codehaus.plexus</groupId>
       <artifactId>plexus-archiver</artifactId>
-      <version>2.9.1</version>
+      <version>2.10</version>
     </dependency>
     <dependency>
       <groupId>org.apache.maven.shared</groupId>
@@ -149,7 +149,7 @@ under the License.
     <dependency>
       <groupId>org.codehaus.plexus</groupId>
       <artifactId>plexus-io</artifactId>
-      <version>2.4.1</version>
+      <version>2.6</version>
     </dependency>
     <dependency>
       <groupId>org.apache.maven</groupId>

src/main/java/org/apache/maven/plugin/assembly/archive/archiver/AssemblyProxyArchiver.java

@@ -41,6 +41,7 @@
 import java.io.FileInputStream;
 import java.io.IOException;
 import java.io.InputStream;
+import java.nio.charset.Charset;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
@@ -661,6 +662,25 @@ public void addArchivedFileSet( final ArchivedFileSet fileSet )
         }
     }
 
+    public void addArchivedFileSet( ArchivedFileSet archivedFileSet, Charset charset )
+        throws ArchiverException
+    {
+        inPublicApi.set( Boolean.TRUE );
+        try
+        {
+            final PrefixedArchivedFileSet fs = new PrefixedArchivedFileSet( archivedFileSet, rootPrefix, selectors );
+
+            debug( "Adding archived file-set in: " + archivedFileSet.getArchive() + " to archive location: "
+                       + fs.getPrefix() );
+
+            delegate.addArchivedFileSet( fs, charset );
+        }
+        finally
+        {
+            inPublicApi.set( null );
+        }
+    }
+
     /**
      * {@inheritDoc}
      */

src/main/java/org/apache/maven/plugin/assembly/archive/phase/ModuleSetAssemblyPhase.java

@@ -339,7 +339,7 @@ void addModuleArtifact( final Artifact artifact, final MavenProject project, fin
                     + "Please ensure the package phase is run before the assembly is generated." );
         }
 
-        final AddArtifactTask task = new AddArtifactTask( artifact, getLogger() );
+        final AddArtifactTask task = new AddArtifactTask( artifact, getLogger(), null );
 
         task.setFileNameMapping( binaries.getOutputFileNameMapping() );
         task.setOutputDirectory( binaries.getOutputDirectory() );

src/main/java/org/apache/maven/plugin/assembly/archive/task/AddArtifactTask.java

@@ -37,6 +37,7 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.nio.charset.Charset;
 import java.util.List;
 
 import static org.apache.maven.plugin.assembly.utils.AssemblyFormatUtils.artifactProjectInterpolator;
@@ -76,16 +77,20 @@ public class AddArtifactTask
 
     private final InputStreamTransformer transformer;
 
-    public AddArtifactTask( final Artifact artifact, final Logger logger, InputStreamTransformer transformer )
+    private final Charset encoding;
+
+    public AddArtifactTask( final Artifact artifact, final Logger logger, InputStreamTransformer transformer,
+                            Charset encoding )
     {
         this.artifact = artifact;
         this.logger = logger;
         this.transformer = transformer;
+        this.encoding = encoding;
     }
 
-    public AddArtifactTask( final Artifact artifact, final Logger logger )
+    public AddArtifactTask( final Artifact artifact, final Logger logger, Charset encoding )
     {
-        this( artifact, logger, null );
+        this( artifact, logger, null, encoding );
     }
 
     public void execute( final Archiver archiver, final AssemblerConfigurationSource configSource )
@@ -229,7 +234,7 @@ else if ( artifactFile.isDirectory() )
                 afs.setExcludes( excludesArray );
                 afs.setPrefix( outputLocation );
                 afs.setStreamTransformer( transformer );
-                archiver.addArchivedFileSet( afs );
+                archiver.addArchivedFileSet( afs, encoding );
             }
         }
         catch ( final ArchiverException e )
@@ -246,7 +251,7 @@ private File moveArtifactSomewhereElse( AssemblerConfigurationSource configSourc
         final File tempArtifactFile = new File( tempRoot, artifact.getFile().getName() );
 
         logger.warn( "Artifact: " + artifact.getId() + " references the same file as the assembly destination file. "
-            + "Moving it to a temporary location for inclusion." );
+                         + "Moving it to a temporary location for inclusion." );
         try
         {
             FileUtils.copyFile( artifact.getFile(), tempArtifactFile );

src/main/java/org/apache/maven/plugin/assembly/archive/task/AddDependencySetsTask.java

@@ -43,6 +43,7 @@
 import org.codehaus.plexus.logging.Logger;
 
 import java.io.File;
+import java.nio.charset.Charset;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.LinkedHashSet;
@@ -222,7 +223,9 @@ private void addNormalArtifact( final DependencySet dependencySet, final Artifac
     {
         logger.debug( "Adding dependency artifact " + depArtifact.getId() + "." );
 
-        final AddArtifactTask task = new AddArtifactTask( depArtifact, logger, fileSetTransformers );
+        String encoding = isUnpackWithOptions( dependencySet ) ? dependencySet.getUnpackOptions().getEncoding() : null;
+        Charset charset = encoding != null ? Charset.forName( encoding ) : null;
+        final AddArtifactTask task = new AddArtifactTask( depArtifact, logger, fileSetTransformers, charset );
 
         task.setProject( depProject );
         task.setModuleProject( moduleProject );

src/main/mdo/component.mdo

@@ -1255,7 +1255,19 @@
             metadata files, should be used when calculating the files affected by this set.
             For backward compatibility, the default value is true. (Since 2.2)
           </description>
-        </field>
+         </field>
+         <field>
+            <name>encoding</name>
+            <version>1.1.3+</version>
+            <type>String</type>
+            <description>
+              <![CDATA[
+              Allows to specify the encoding to use when unpacking archives, for unarchivers
+              that support specifying encoding. If unspecified, archiver default will be used.
+              Archiver defaults generally represent sane (modern) values.
+              ]]>
+            </description>
+         </field>
       </fields>
     </class>
     <class>

src/main/mdo/descriptor.mdo

@@ -1366,6 +1366,18 @@
             For backward compatibility, the default value is true. (Since 2.2)
           </description>
         </field>
+        <field>
+          <name>encoding</name>
+          <version>1.1.3+</version>
+          <type>String</type>
+          <description>
+            <![CDATA[
+            Allows to specify the encoding to use when unpacking archives, for unarchivers
+            that support specifying encoding. If unspecified, archiver default will be used.
+            Archiver defaults generally represent sane (modern) values.
+            ]]>
+          </description>
+        </field>
       </fields>
     </class>
     <class>

src/test/java/org/apache/maven/plugin/assembly/archive/task/AddArtifactTaskTest.java

@@ -19,6 +19,7 @@
  * under the License.
  */
 
+import junit.framework.TestCase;
 import org.apache.maven.artifact.Artifact;
 import org.apache.maven.model.Model;
 import org.apache.maven.plugin.assembly.archive.ArchiveCreationException;
@@ -32,14 +33,13 @@
 import org.codehaus.plexus.archiver.ArchiverException;
 import org.codehaus.plexus.logging.Logger;
 import org.codehaus.plexus.logging.console.ConsoleLogger;
+import org.easymock.classextension.EasyMockSupport;
 
 import java.io.File;
 import java.io.IOException;
+import java.nio.charset.Charset;
 import java.util.Arrays;
 
-import junit.framework.TestCase;
-import org.easymock.classextension.EasyMockSupport;
-
 import static org.easymock.EasyMock.anyObject;
 
 public class AddArtifactTaskTest
@@ -78,7 +78,7 @@ public void testShouldAddArchiveFileWithoutUnpacking()
         mac.expectGetDestFile( new File( "junk" ) );
         mac.expectAddFile( artifactFile, outputLocation );
         mac.expectInterpolators();
-        
+
         mockManager.replayAll();
 
         AddArtifactTask task = createTask( artifactMock.getArtifact() );
@@ -108,7 +108,8 @@ public void testShouldAddArchiveFileWithDefaultOutputLocation()
         mac.expectInterpolators();
         mockManager.replayAll();
 
-        AddArtifactTask task = new AddArtifactTask( mock.getArtifact(), new ConsoleLogger( Logger.LEVEL_DEBUG, "test" ) );
+        AddArtifactTask task =
+            new AddArtifactTask( mock.getArtifact(), new ConsoleLogger( Logger.LEVEL_DEBUG, "test" ), null );
         task.setOutputDirectory( outputDir );
         task.setFileNameMapping( new DependencySet().getOutputFileNameMapping() );
 
@@ -126,7 +127,7 @@ public void testShouldAddArchiveFileWithDefaultOutputLocation()
 
     private AddArtifactTask createTask( Artifact artifact )
     {
-        AddArtifactTask task = new AddArtifactTask( artifact, new ConsoleLogger( Logger.LEVEL_DEBUG, "test" ) );
+        AddArtifactTask task = new AddArtifactTask( artifact, new ConsoleLogger( Logger.LEVEL_DEBUG, "test" ), null );
 
         task.setFileNameMapping( "artifact" );
 
@@ -139,8 +140,6 @@ public void testShouldAddArchiveFileWithUnpack()
         mac.expectModeChange( -1, -1, -1, -1, 1 );
         mac.expectInterpolators();
 
-
-
         ArtifactMock artifactMock = new ArtifactMock( mockManager, "group", "artifact", "version", "jar", false );
         File artifactFile = artifactMock.setNewFile();
 
@@ -149,8 +148,9 @@ public void testShouldAddArchiveFileWithUnpack()
         mac.expectGetDestFile( new File( "junk" ) );
         try
         {
-//            mac.archiver.addArchivedFileSet( artifactFile, outputLocation, AddArtifactTask.DEFAULT_INCLUDES_ARRAY, null );
-            mac.archiver.addArchivedFileSet((ArchivedFileSet) anyObject());
+//            mac.archiver.addArchivedFileSet( artifactFile, outputLocation, AddArtifactTask.DEFAULT_INCLUDES_ARRAY,
+// null );
+            mac.archiver.addArchivedFileSet( (ArchivedFileSet) anyObject(), (Charset) anyObject() );
         }
         catch ( ArchiverException e )
         {
@@ -177,8 +177,6 @@ public void testShouldAddArchiveFileWithUnpackAndModes()
         mac.expectModeChange( -1, -1, directoryMode, fileMode, 2 );
         mac.expectInterpolators();
 
-
-
 //        mac.expectIsSnapshot( false );
 
         String outputLocation = "";
@@ -189,7 +187,7 @@ public void testShouldAddArchiveFileWithUnpackAndModes()
         mac.expectGetDestFile( new File( "junk" ) );
         try
         {
-            mac.archiver.addArchivedFileSet((ArchivedFileSet) anyObject());
+            mac.archiver.addArchivedFileSet( (ArchivedFileSet) anyObject(), (Charset) anyObject()  );
         }
         catch ( ArchiverException e )
         {
@@ -201,7 +199,7 @@ public void testShouldAddArchiveFileWithUnpackAndModes()
         AddArtifactTask task = createTask( artifactMock.getArtifact() );
 
         task.setUnpack( true );
-        
+
         task.setDirectoryMode( directoryMode );
         task.setFileMode( fileMode );
 

src/test/java/org/apache/maven/plugin/assembly/archive/task/testutils/MockAndControlForAddArtifactTask.java

@@ -20,6 +20,7 @@
  */
 
 import java.io.File;
+import java.nio.charset.Charset;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Set;
@@ -103,7 +104,7 @@ public void expectAddArchivedFileSet()
         {
             archiver.addArchivedFileSet( (File)anyObject(), (String)anyObject(), (String[])anyObject(), (String[])anyObject() );
             EasyMock.expectLastCall().anyTimes();
-            archiver.addArchivedFileSet((ArchivedFileSet) anyObject());
+            archiver.addArchivedFileSet((ArchivedFileSet) anyObject(), (Charset) anyObject() );
             EasyMock.expectLastCall().anyTimes();
 
         }

src/test/java/org/apache/maven/plugin/assembly/archive/task/testutils/MockAndControlForAddDependencySetsTask.java

@@ -20,6 +20,7 @@
  */
 
 import java.io.File;
+import java.nio.charset.Charset;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Set;
@@ -99,7 +100,7 @@ public void expectAddArchivedFileSet()
             archiver.addArchivedFileSet( (File) anyObject(), (String) anyObject(), (String[]) anyObject(),
                                              (String[]) anyObject() );
             EasyMock.expectLastCall().anyTimes();
-            archiver.addArchivedFileSet( (ArchivedFileSet)anyObject() );
+            archiver.addArchivedFileSet( (ArchivedFileSet)anyObject(), (Charset) anyObject()  );
             EasyMock.expectLastCall().anyTimes();
 
         }