Skip to content
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
package org.codehaus.plexus.components.io.filemappers;

/*
* Copyright 2007 The Codehaus Foundation.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've just noticed that this is the old license header. Judging by the other new files in the codehaus-plexus project you can just delete this line and keep the rest (the Apache license).

*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

import javax.annotation.Nonnull;

import org.codehaus.plexus.util.StringUtils;

/**
* A file mapper, which maps by adding a suffix.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be nice if make it clear that the suffix is added before the dot. It is mentioned in the site docs but it would be nice if you state it here as well (so it is visible in the IDEs).

*/
public class SuffixFileMapper extends AbstractFileMapper
{
/**
* The suffix mappers role-hint: "suffix".
*/
public static final String ROLE_HINT = "suffix";

private String suffix;

@Nonnull public String getMappedFileName( @Nonnull String name )
{
final String s = super.getMappedFileName( name ); // Check for null, etc.
return getMappedFileName( suffix, s );
}

/**
* Returns the suffix to add.
*/
public String getSuffix()
{
return suffix;
}

/**
* Sets the suffix to add.
*/
public void setSuffix( String suffix )
{
this.suffix = suffix;

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As null is not valid value you can add check if suffix is null:

if ( suffix == null )
{
    throw new IllegalArgumentException( "The suffix is null." );
}

Not all marchers all have that (the regex one does not have) but I think as most have it is better this way.

}

/**
* Performs the mapping of a file name by adding a suffix.
*/
public static String getMappedFileName( String suffix, String name )

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess you followed the PrefixFileMapper code, but the rest does not have public static String getMappedFileName and I think it would be best to be consistent with them as PrefixFileMapper is a kind of exception. If you don't have other concerns I think it's best to move it to public String getMappedFileName( @Nonnull String name ).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok I have no problem with that
Indeed like you said I'm basically inspired of PrefixFileMapper because I didn't know plexus-io :(

{
String nameWithSuffix = name;
if ( StringUtils.isNotBlank( suffix ) )

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The rest of the mappers throw IllegalStateException if any of the params is not initialized. Would be nice if this mapper is consistent with the others (PrefixFileMapper is exception but I think it would be better if it stays the only exception).

{
if ( name.contains( "." ) )
{
String beforeExtension = name.substring( 0, name.indexOf('.') );

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing white space around '.'.

String afterExtension = name.substring( name.indexOf('.') + 1 ) ;
nameWithSuffix = beforeExtension + suffix + "." + afterExtension;
}
else
{
nameWithSuffix += suffix;
}
}
return nameWithSuffix;
}
}
7 changes: 7 additions & 0 deletions src/main/resources/META-INF/plexus/components.xml
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,13 @@
<instantiation-strategy>per-lookup</instantiation-strategy>
<configuration/>
</component>
<component>
<role>org.codehaus.plexus.components.io.filemappers.FileMapper</role>
<role-hint>suffix</role-hint>
<implementation>org.codehaus.plexus.components.io.filemappers.SuffixFileMapper</implementation>
<instantiation-strategy>per-lookup</instantiation-strategy>
<configuration/>
</component>
<component>
<role>org.codehaus.plexus.components.io.filemappers.FileMapper</role>
<role-hint>regexp</role-hint>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,22 @@ public void testPrefixMapper() throws Exception
mapper.setPrefix( prefix );
testFileMapper( mapper, SAMPLES, results );
}

public void testSuffixMapper() throws Exception
{
final String suffix = "suffix";
String[] results = getIdentityResults();
testFileMapper( new SuffixFileMapper(), SAMPLES, results );
testFileMapper( (SuffixFileMapper) lookup( FileMapper.ROLE, SuffixFileMapper.ROLE_HINT ), SAMPLES, results );

results = new String[] {null, null, "asuffix", "xyzsuffix.gif", "b/asuffix", "b/xyzsuffix.gif", "b\\asuffix", "b\\xyzsuffix.gif", "csuffix.c/a", "csuffix.c/xyz.gif", "csuffix.c\\a", "csuffix.c\\xyz.gif"};

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Splinting on two lines would make it more readable and there is missing space after the curly brace.

SuffixFileMapper mapper = new SuffixFileMapper();
mapper.setSuffix( suffix );
testFileMapper( mapper, SAMPLES, results );
mapper = (SuffixFileMapper) lookup( FileMapper.ROLE, SuffixFileMapper.ROLE_HINT );
mapper.setSuffix( suffix );
testFileMapper( mapper, SAMPLES, results );
}

private RegExpFileMapper configure( RegExpFileMapper pMapper, String pPattern, String pReplacement )
{
Expand Down