Author: tchemit Date: 2008-08-15 16:59:21 +0000 (Fri, 15 Aug 2008) New Revision: 1026 Added: trunk/lutinpluginutil/ trunk/lutinpluginutil/LICENSE.txt trunk/lutinpluginutil/changelog trunk/lutinpluginutil/pom.xml trunk/lutinpluginutil/src/ trunk/lutinpluginutil/src/main/ trunk/lutinpluginutil/src/main/java/ trunk/lutinpluginutil/src/main/java/org/ trunk/lutinpluginutil/src/main/java/org/codelutin/ trunk/lutinpluginutil/src/main/java/org/codelutin/util/ trunk/lutinpluginutil/src/main/java/org/codelutin/util/FileUpdater.java trunk/lutinpluginutil/src/main/java/org/codelutin/util/FileUpdaterHelper.java trunk/lutinpluginutil/src/main/java/org/codelutin/util/MirroredFileUpdater.java trunk/lutinpluginutil/src/main/java/org/codelutin/util/package.html trunk/lutinpluginutil/src/main/resources/ trunk/lutinpluginutil/src/site/ trunk/lutinpluginutil/src/site/site.xml trunk/lutinpluginutil/src/site/xdoc/ trunk/lutinpluginutil/src/site/xdoc/fr/ trunk/lutinpluginutil/src/site/xdoc/fr/rst/ trunk/lutinpluginutil/src/site/xdoc/fr/rst/Todo.rst trunk/lutinpluginutil/src/site/xdoc/fr/rst/index.rst trunk/lutinpluginutil/src/test/ trunk/lutinpluginutil/src/test/java/ trunk/lutinpluginutil/src/test/java/org/ trunk/lutinpluginutil/src/test/java/org/codelutin/ trunk/lutinpluginutil/src/test/java/org/codelutin/util/ trunk/lutinpluginutil/src/test/java/org/codelutin/util/JavaDummy.java trunk/lutinpluginutil/src/test/java/org/codelutin/util/JavaFileUpdaterTest.java trunk/lutinpluginutil/src/test/java/org/codelutin/util/JaxxDummy.java trunk/lutinpluginutil/src/test/java/org/codelutin/util/JaxxFileUpdaterTest.java trunk/lutinpluginutil/src/test/resources/ trunk/lutinpluginutil/src/test/resources/log4j.properties trunk/lutinpluginutil/src/test/resources/org/ trunk/lutinpluginutil/src/test/resources/org/codelutin/ trunk/lutinpluginutil/src/test/resources/org/codelutin/util/ trunk/lutinpluginutil/src/test/resources/org/codelutin/util/JaxxDummy.jaxx Log: creation de org.codelutin:lutinpluginutil:0.1 avec les classes utilitaires des plugins maven. Property changes on: trunk/lutinpluginutil ___________________________________________________________________ Name: svn:ignore + target Added: trunk/lutinpluginutil/LICENSE.txt =================================================================== --- trunk/lutinpluginutil/LICENSE.txt (rev 0) +++ trunk/lutinpluginutil/LICENSE.txt 2008-08-15 16:59:21 UTC (rev 1026) @@ -0,0 +1,280 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS Added: trunk/lutinpluginutil/changelog =================================================================== --- trunk/lutinpluginutil/changelog (rev 0) +++ trunk/lutinpluginutil/changelog 2008-08-15 16:59:21 UTC (rev 1026) @@ -0,0 +1,2 @@ +ver-0-1 chemit 2008???? + * initial version with only FileUpdater \ No newline at end of file Added: trunk/lutinpluginutil/pom.xml =================================================================== --- trunk/lutinpluginutil/pom.xml (rev 0) +++ trunk/lutinpluginutil/pom.xml 2008-08-15 16:59:21 UTC (rev 1026) @@ -0,0 +1,71 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> + + <modelVersion>4.0.0</modelVersion> + + <!-- ************************************************************* --> + <!-- *** POM Relationships *************************************** --> + <!-- ************************************************************* --> + + <parent> + <groupId>org.codelutin</groupId> + <artifactId>lutinproject</artifactId> + <version>2.4</version> + </parent> + + <artifactId>lutinpluginutil</artifactId> + + <dependencies> + + </dependencies> + + + <!-- ************************************************************* --> + <!-- *** Project Information ************************************* --> + <!-- ************************************************************* --> + + <name>Lutin plugin utilities library</name> + <version>0.1</version> + <description>Library of usefull class to be used in any maven plugin.</description> + <inceptionYear>2008</inceptionYear> + <url>${labs.project.url}</url> + + <!-- ************************************************************* --> + <!-- *** Build Settings ****************************************** --> + <!-- ************************************************************* --> + + <packaging>jar</packaging> + + <properties> + + <!-- id du projet du labs --> + <labs.id>12</labs.id> + + <!-- nom du projet sur le labs --> + <labs.project>lutinutil</labs.project> + + <!-- BE WARE, this value must rewritten here since it will be otherwise suffixed by inheritance --> + <maven.scm.url>https://${labs.host}/plugins/scmsvn/viewcvs.php/trunk/${pom.artifactId}?root=${labs.project} + </maven.scm.url> + + </properties> + + <scm> + <url>${maven.scm.url}</url> + </scm> + + <build> + + <plugins> + + <!-- jrst --> + <plugin> + <groupId>lutinplugin</groupId> + <artifactId>maven-jrst-plugin</artifactId> + </plugin> + + </plugins> + </build> + +</project> Added: trunk/lutinpluginutil/src/main/java/org/codelutin/util/FileUpdater.java =================================================================== --- trunk/lutinpluginutil/src/main/java/org/codelutin/util/FileUpdater.java (rev 0) +++ trunk/lutinpluginutil/src/main/java/org/codelutin/util/FileUpdater.java 2008-08-15 16:59:21 UTC (rev 1026) @@ -0,0 +1,34 @@ +/** + * # #% Copyright (C) 2008 Code Lutin, Tony Chemit + * This program is free software; you + * can redistribute it and/or modify it under the terms of the GNU General + * Public License as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. This program is + * distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; + * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A + * PARTICULAR PURPOSE. See the GNU General Public License for more details. You + * should have received a copy of the GNU General Public License along with this + * program; if not, write to the Free Software Foundation, Inc., 59 Temple Place + * - Suite 330, Boston, MA 02111-1307, USA. + * # #% + */ +package org.codelutin.util; + +import java.io.File; + +/** + * Contract to be realized to test if a file is up to date. + * <p/> + * use {@link #isFileUpToDate(java.io.File)} to determine if a file is up to date. + * + * @author chemit + */ +public interface FileUpdater { + + /** + * @param f file to test + * @return <code>true</code> if file is up to date, <code>false</code> otherwise + */ + boolean isFileUpToDate(File f); + +} Added: trunk/lutinpluginutil/src/main/java/org/codelutin/util/FileUpdaterHelper.java =================================================================== --- trunk/lutinpluginutil/src/main/java/org/codelutin/util/FileUpdaterHelper.java (rev 0) +++ trunk/lutinpluginutil/src/main/java/org/codelutin/util/FileUpdaterHelper.java 2008-08-15 16:59:21 UTC (rev 1026) @@ -0,0 +1,66 @@ +/** + * # #% Copyright (C) 2008 Code Lutin, Tony Chemit + * This program is free software; you + * can redistribute it and/or modify it under the terms of the GNU General + * Public License as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. This program is + * distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; + * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A + * PARTICULAR PURPOSE. See the GNU General Public License for more details. You + * should have received a copy of the GNU General Public License along with this + * program; if not, write to the Free Software Foundation, Inc., 59 Temple Place + * - Suite 330, Boston, MA 02111-1307, USA. + * # #% + */ +package org.codelutin.util; + +import java.io.File; + +/** @author chemit */ +public class FileUpdaterHelper { + + static public FileUpdater newJavaFileUpdater(File src, File dst) { + return new JavaFileUpdater(src, dst); + } + + static public FileUpdater newJaxxFileUpdater(File src, File dst) { + return new JaxxFileUpdater(src, dst); + } + + /** + * To test if a java source file is newser than his compiled class + * + * @author chemit + */ + public static class JavaFileUpdater extends MirroredFileUpdater { + + protected JavaFileUpdater(File sourceDirectory, File destinationDirectory) { + super(sourceDirectory, destinationDirectory); + } + + public File getMirrorFile(File f) { + String file = f.getAbsolutePath().substring(prefixSourceDirecotory); + String mirrorRelativePath = file.substring(0, file.length() - 4) + "class"; + return new File(destinationDirectory + File.separator + mirrorRelativePath); + } + } + + /** + * To test if a jaxx source file is newser than his generated java source file + * + * @author chemit + */ + public static class JaxxFileUpdater extends MirroredFileUpdater { + + protected JaxxFileUpdater(File sourceDirectory, File destinationDirectory) { + super(sourceDirectory, destinationDirectory); + } + + public File getMirrorFile(File f) { + String file = f.getAbsolutePath().substring(prefixSourceDirecotory); + String mirrorRelativePath = file.substring(0, file.length() - 4) + "java"; + return new File(destinationDirectory + File.separator + mirrorRelativePath); + } + + } +} Added: trunk/lutinpluginutil/src/main/java/org/codelutin/util/MirroredFileUpdater.java =================================================================== --- trunk/lutinpluginutil/src/main/java/org/codelutin/util/MirroredFileUpdater.java (rev 0) +++ trunk/lutinpluginutil/src/main/java/org/codelutin/util/MirroredFileUpdater.java 2008-08-15 16:59:21 UTC (rev 1026) @@ -0,0 +1,69 @@ +/** + * # #% Copyright (C) 2008 Code Lutin, Tony Chemit + * This program is free software; you + * can redistribute it and/or modify it under the terms of the GNU General + * Public License as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. This program is + * distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; + * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A + * PARTICULAR PURPOSE. See the GNU General Public License for more details. You + * should have received a copy of the GNU General Public License along with this + * program; if not, write to the Free Software Foundation, Inc., 59 Temple Place + * - Suite 330, Boston, MA 02111-1307, USA. + * # #% + */ +package org.codelutin.util; + +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +import java.io.File; + +/** + * Simple base implementation of a {@link FileUpdater} for an updater with a sourcedir and a destinationdir. + * + * @author chemit + */ +public abstract class MirroredFileUpdater implements FileUpdater { + + /** to use log facility, just put in your code: log.info(\"...\"); */ + static private final Log log = LogFactory.getLog(MirroredFileUpdater.class); + + /** source basedir */ + protected File sourceDirectory; + + /** length of source basedir absolute path */ + protected int prefixSourceDirecotory; + + /** destination basedir */ + protected File destinationDirectory; + + protected MirroredFileUpdater(File sourceDirectory, File destinationDirectory) { + this.sourceDirectory = sourceDirectory; + this.destinationDirectory = destinationDirectory; + this.prefixSourceDirecotory = sourceDirectory.getAbsolutePath().length(); + if (log.isDebugEnabled()) { + log.debug(this); + } + } + + public File getSourceDirectory() { + return sourceDirectory; + } + + public File getDestinationDirectory() { + return destinationDirectory; + } + + public abstract File getMirrorFile(File f); + + public boolean isFileUpToDate(File f) { + File mirror = getMirrorFile(f); + return mirror.exists() && f.lastModified() < mirror.lastModified(); + } + + @Override + public String toString() { + return super.toString() + "<srcdir:" + sourceDirectory + ", destdir:" + destinationDirectory + ">"; + } +} Added: trunk/lutinpluginutil/src/main/java/org/codelutin/util/package.html =================================================================== --- trunk/lutinpluginutil/src/main/java/org/codelutin/util/package.html (rev 0) +++ trunk/lutinpluginutil/src/main/java/org/codelutin/util/package.html 2008-08-15 16:59:21 UTC (rev 1026) @@ -0,0 +1,7 @@ +<html> +<body> +<h1>Lutin plugin util</h1> +Ensemble de classe Java permettant de simplifier le developpement de plugins maven en +factorisant des besoins que l'on retrouve dans tous les developpements. +</body> +</html> \ No newline at end of file Added: trunk/lutinpluginutil/src/site/site.xml =================================================================== --- trunk/lutinpluginutil/src/site/site.xml (rev 0) +++ trunk/lutinpluginutil/src/site/site.xml 2008-08-15 16:59:21 UTC (rev 1026) @@ -0,0 +1,50 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project name="${project.name}"> + + <skin> + <groupId>lutinlib</groupId> + <artifactId>lutin-site-skin</artifactId> + <version>0.1</version> + </skin> + + <bannerLeft> + <name>${project.name}</name> + </bannerLeft> + + <bannerRight> + <src>http://www.codelutin.com/images/lutinorange-codelutin.png</src> + <href>${project.organization.url}</href> + </bannerRight> + + <poweredBy> + <logo href="http://maven.apache.org" name="Maven" img="images/logos/maven-feather.png"/> + <logo href="http://jrst.labs.libre-entreprise.org" name="JRst" img="images/jrst-logo.png"/> + <logo href="http://docutils.sourceforge.net/rst.html" name="ReStructuredText" + img="images/restructuredtext-logo.png"/> + </poweredBy> + + <body> + <links> + <item name="Labs" href="http://labs.libre-entreprise.org/"/> + <item name="${project.organization.name}" href="${project.organization.url}"/> + </links> + + <menu name="Utilisateur"> + <item name="Accueil" href="index.html"/> + </menu> + + <menu name="Téléchargement"> + <item href="${labs.builder.url}/org/codelutin/${project.artifactId}/${project.version}" + name="Télécharger la dernière version"/> + <item href="${labs.builder.url}/org/codelutin/${project.artifactId}" + name="Voir toutes les versions"/> + </menu> + + <menu name="Développeur"> + <item name="A faire" href="Todo.html"/> + </menu> + + <menu ref="reports"/> + + </body> +</project> Added: trunk/lutinpluginutil/src/site/xdoc/fr/rst/Todo.rst =================================================================== --- trunk/lutinpluginutil/src/site/xdoc/fr/rst/Todo.rst (rev 0) +++ trunk/lutinpluginutil/src/site/xdoc/fr/rst/Todo.rst 2008-08-15 16:59:21 UTC (rev 1026) @@ -0,0 +1,2 @@ +TODO +==== Added: trunk/lutinpluginutil/src/site/xdoc/fr/rst/index.rst =================================================================== --- trunk/lutinpluginutil/src/site/xdoc/fr/rst/index.rst (rev 0) +++ trunk/lutinpluginutil/src/site/xdoc/fr/rst/index.rst 2008-08-15 16:59:21 UTC (rev 1026) @@ -0,0 +1,20 @@ +LutinPluginUtil +=============== + +.. contents:: + + +Présentation +------------ + +Ensemble de classe Java permettant de simplifier le développement de plugin +maven en factorisant des besoins que l'on retrouve dans tous les développements... + +FileUpdater +----------- + +Mecanisme permettant de savoir si un fichier est a jour (utile pour les plugins de generation). + + +**Veuillez consulter la JavaDoc pour de plus ample details sur les differentes +librairies.** Added: trunk/lutinpluginutil/src/test/java/org/codelutin/util/JavaDummy.java =================================================================== --- trunk/lutinpluginutil/src/test/java/org/codelutin/util/JavaDummy.java (rev 0) +++ trunk/lutinpluginutil/src/test/java/org/codelutin/util/JavaDummy.java 2008-08-15 16:59:21 UTC (rev 1026) @@ -0,0 +1,22 @@ +/** + * # #% Copyright (C) 2008 Code Lutin, Tony Chemit + * This program is free software; you + * can redistribute it and/or modify it under the terms of the GNU General + * Public License as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. This program is + * distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; + * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A + * PARTICULAR PURPOSE. See the GNU General Public License for more details. You + * should have received a copy of the GNU General Public License along with this + * program; if not, write to the Free Software Foundation, Inc., 59 Temple Place + * - Suite 330, Boston, MA 02111-1307, USA. + * # #% + */ +package org.codelutin.util; + +/** @author chemit */ +public class JavaDummy { + /** + * A dummy file to test {@link org.codelutin.util.FileUpdaterHelper.JavaFileUpdater} in {@link JavaFileUpdaterTest} + */ +} \ No newline at end of file Added: trunk/lutinpluginutil/src/test/java/org/codelutin/util/JavaFileUpdaterTest.java =================================================================== --- trunk/lutinpluginutil/src/test/java/org/codelutin/util/JavaFileUpdaterTest.java (rev 0) +++ trunk/lutinpluginutil/src/test/java/org/codelutin/util/JavaFileUpdaterTest.java 2008-08-15 16:59:21 UTC (rev 1026) @@ -0,0 +1,135 @@ +/* + * Copyright (C) 2002-2008 Code Lutin, Benjamin Poussin + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + * USA. + */ + +package org.codelutin.util; + +import junit.framework.TestCase; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.codelutin.util.FileUpdaterHelper.JavaFileUpdater; + +import java.io.File; + +/** + * Test of a {@link JavaFileUpdater} on the test sourcepath and test-classpath + * + * @author chemit + */ +public class JavaFileUpdaterTest extends TestCase { + + /** to use log facility, just put in your code: log.info(\"...\"); */ + static private final Log log = LogFactory.getLog(FileUpdaterHelper.class); + + + static final char SEP = File.separatorChar; + + static MirroredFileUpdater fileUpdater; + + static File sourceFile; + static File mirrorFile; + + public void testInitUpdater() throws Exception { + + String basedir = System.getProperty("basedir"); + if (basedir == null) { + log.warn("basedir not found, test is not executed from maven..."); + basedir = new File(new File("").getAbsolutePath()).getAbsolutePath(); + } + + log.info("basedir = " + basedir); + + File src = new File(basedir, "src" + SEP + "test" + SEP + "java"); + File dir = new File(basedir, "target" + SEP + "test-classes"); + fileUpdater = (MirroredFileUpdater) FileUpdaterHelper.newJavaFileUpdater(src, dir); + log.info(fileUpdater); + + // test source dir exists + File sourceDirectory = fileUpdater.getSourceDirectory(); + assertTrue("sourcedir is null", sourceDirectory != null); + assertTrue("sourcedir does not exists " + sourceDirectory, sourceDirectory.exists()); + + // test destination dir exists + File destinationDirectory = fileUpdater.getDestinationDirectory(); + assertTrue("destinationDirectory is null", destinationDirectory != null); + assertTrue("destinationDirectory does not exists " + destinationDirectory, destinationDirectory.exists()); + + sourceFile = new File(fileUpdater.getSourceDirectory(), "org" + SEP + "codelutin" + SEP + "util" + SEP + JavaDummy.class.getSimpleName() + ".java"); + + } + + public void testSourceFileIsUptoDate() throws Exception { + + assertTrue("fileUpdater was not init", fileUpdater != null); + assertTrue("sourceFile was not init ", sourceFile != null); + assertTrue("could not find source of this test " + sourceFile, sourceFile.exists()); + + // java file is up to date since it was compiled to launch this test + assertTrue(sourceFile + " should be uptodate", fileUpdater.isFileUpToDate(sourceFile)); + + mirrorFile = fileUpdater.getMirrorFile(sourceFile); + } + + + public void testSourceFileDoesNotHaveMirrorFile() throws Exception { + + assertTrue("fileUpdater was not init", fileUpdater != null); + assertTrue("sourceFile was not init ", sourceFile != null); + assertTrue("could not find source of this test " + sourceFile, sourceFile.exists()); + assertTrue("mirrorFile was not init ", mirrorFile != null); + assertTrue("could not find mirrorFile " + mirrorFile, mirrorFile.exists()); + + // now rename mirror Class, so source file is no more up to date + File mirrorClassRenamed = new File(fileUpdater.getMirrorFile(sourceFile).getAbsolutePath() + "2"); + mirrorFile.renameTo(mirrorClassRenamed); + + // java file is no more up to date + assertFalse(sourceFile + " should not be uptodate", fileUpdater.isFileUpToDate(sourceFile)); + + // renmae mirror Class to his original name + mirrorClassRenamed.renameTo(mirrorFile); + + // java file is now up to date (rename method does not affect lasmodified property on a file) + assertTrue(sourceFile + " should be uptodate", fileUpdater.isFileUpToDate(sourceFile)); + } + + public void testSourceFileIsNewerThanMirrorFile() throws Exception { + + assertTrue("fileUpdater was not init", fileUpdater != null); + assertTrue("sourceFile was not init ", sourceFile != null); + assertTrue("could not find source of this test " + sourceFile, sourceFile.exists()); + assertTrue("mirrorFile was not init ", mirrorFile != null); + assertTrue("could not find mirrorFile " + mirrorFile, mirrorFile.exists()); + + long sourceTime = sourceFile.lastModified(); + long mirrorTime = mirrorFile.lastModified(); + + // make source file newer than mirror file + sourceFile.setLastModified(mirrorTime + 10); + + // java file is no more up to date + assertFalse(sourceFile + " should not be uptodate", fileUpdater.isFileUpToDate(sourceFile)); + + // put back old time to source file + sourceFile.setLastModified(sourceTime); + + // java file is now up to date (rename method does not affect lasmodified property on a file) + assertTrue(sourceFile + " should be uptodate", fileUpdater.isFileUpToDate(sourceFile)); + } + +} Added: trunk/lutinpluginutil/src/test/java/org/codelutin/util/JaxxDummy.java =================================================================== --- trunk/lutinpluginutil/src/test/java/org/codelutin/util/JaxxDummy.java (rev 0) +++ trunk/lutinpluginutil/src/test/java/org/codelutin/util/JaxxDummy.java 2008-08-15 16:59:21 UTC (rev 1026) @@ -0,0 +1,22 @@ +/** + * # #% Copyright (C) 2008 Code Lutin, Tony Chemit + * This program is free software; you + * can redistribute it and/or modify it under the terms of the GNU General + * Public License as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. This program is + * distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; + * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A + * PARTICULAR PURPOSE. See the GNU General Public License for more details. You + * should have received a copy of the GNU General Public License along with this + * program; if not, write to the Free Software Foundation, Inc., 59 Temple Place + * - Suite 330, Boston, MA 02111-1307, USA. + * # #% + */ +package org.codelutin.util; + +/** @author chemit */ +public class JaxxDummy { + /** + * A dummy file to test {@link org.codelutin.util.FileUpdaterHelper.JaxxFileUpdater} in {@link JaxxFileUpdaterTest} + */ +} Added: trunk/lutinpluginutil/src/test/java/org/codelutin/util/JaxxFileUpdaterTest.java =================================================================== --- trunk/lutinpluginutil/src/test/java/org/codelutin/util/JaxxFileUpdaterTest.java (rev 0) +++ trunk/lutinpluginutil/src/test/java/org/codelutin/util/JaxxFileUpdaterTest.java 2008-08-15 16:59:21 UTC (rev 1026) @@ -0,0 +1,145 @@ +/* + * Copyright (C) 2002-2008 Code Lutin, Benjamin Poussin + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, + * USA. + */ + +package org.codelutin.util; + +import junit.framework.TestCase; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; + +import java.io.File; + +/** + * Test of a {@link org.codelutin.util.FileUpdaterHelper.JaxxFileUpdater} on the test sourcepath + * + * @author chemit + */ +public class JaxxFileUpdaterTest extends TestCase { + + /** to use log facility, just put in your code: log.info(\"...\"); */ + static private final Log log = LogFactory.getLog(FileUpdaterHelper.class); + + + static final char SEP = File.separatorChar; + + static MirroredFileUpdater fileUpdater; + + static File sourceFile; + static File mirrorFile; + + public void testInitUpdater() throws Exception { + + String basedir = System.getProperty("basedir"); + if (basedir == null) { + log.warn("basedir not found, test is not executed from maven..."); + basedir = new File(new File("").getAbsolutePath()).getAbsolutePath(); + } + + log.info("basedir = " + basedir); + + File src = new File(basedir, "src" + SEP + "test" + SEP + "resources"); + File dir = new File(basedir, "src" + SEP + "test" + SEP + "java"); + fileUpdater = (MirroredFileUpdater) FileUpdaterHelper.newJaxxFileUpdater(src, dir); + log.info(fileUpdater); + + // test source dir exists + File sourceDirectory = fileUpdater.getSourceDirectory(); + assertTrue("sourcedir is null", sourceDirectory != null); + assertTrue("sourcedir does not exists " + sourceDirectory, sourceDirectory.exists()); + + // test destination dir exists + File destinationDirectory = fileUpdater.getDestinationDirectory(); + assertTrue("destinationDirectory is null", destinationDirectory != null); + assertTrue("destinationDirectory does not exists " + destinationDirectory, destinationDirectory.exists()); + + sourceFile = new File(fileUpdater.getSourceDirectory(), "org" + SEP + "codelutin" + SEP + "util" + SEP + JaxxDummy.class.getSimpleName() + ".jaxx"); + + } + + public void testSourceFileIsUptoDate() throws Exception { + + assertTrue("fileUpdater was not init", fileUpdater != null); + + assertTrue("sourceFile was not init ", sourceFile != null); + assertTrue("could not find source of this test " + sourceFile, sourceFile.exists()); + + mirrorFile = fileUpdater.getMirrorFile(sourceFile); + + // we do not know if jaxx file is newer than the dummy java source ? + + sourceFile.setLastModified(mirrorFile.lastModified() - 10); + + // java file is up to date since it was compiled to launch this test + assertTrue(sourceFile + " should be uptodate", fileUpdater.isFileUpToDate(sourceFile)); + + + } + + + public void testSourceFileDoesNotHaveMirrorFile() throws Exception { + + assertTrue("fileUpdater was not init", fileUpdater != null); + + assertTrue("sourceFile was not init ", sourceFile != null); + assertTrue("could not find source of this test " + sourceFile, sourceFile.exists()); + + assertTrue("mirrorFile was not init ", mirrorFile != null); + assertTrue("could not find mirrorFile " + mirrorFile, mirrorFile.exists()); + + // now rename mirror Class, so source file is no more up to date + File mirrorClassRenamed = new File(fileUpdater.getMirrorFile(sourceFile).getAbsolutePath() + "2"); + mirrorFile.renameTo(mirrorClassRenamed); + + // java file is no more up to date + assertFalse(sourceFile + " should not be uptodate", fileUpdater.isFileUpToDate(sourceFile)); + + // renmae mirror Class to his original name + mirrorClassRenamed.renameTo(mirrorFile); + + // java file is now up to date (rename method does not affect lasmodified property on a file) + assertTrue(sourceFile + " should be uptodate", fileUpdater.isFileUpToDate(sourceFile)); + } + + public void testSourceFileIsNewerThanMirrorFile() throws Exception { + + assertTrue("fileUpdater was not init", fileUpdater != null); + + assertTrue("sourceFile was not init ", sourceFile != null); + assertTrue("could not find source of this test " + sourceFile, sourceFile.exists()); + + assertTrue("mirrorFile was not init ", mirrorFile != null); + assertTrue("could not find mirrorFile " + mirrorFile, mirrorFile.exists()); + + long sourceTime = sourceFile.lastModified(); + long mirrorTime = mirrorFile.lastModified(); + + // make source file newer than mirror file + sourceFile.setLastModified(mirrorTime + 10); + + // java file is no more up to date + assertFalse(sourceFile + " should not be uptodate", fileUpdater.isFileUpToDate(sourceFile)); + + // put back old time to source file + sourceFile.setLastModified(sourceTime); + + // java file is now up to date (rename method does not affect lasmodified property on a file) + assertTrue(sourceFile + " should be uptodate", fileUpdater.isFileUpToDate(sourceFile)); + } + +} \ No newline at end of file Added: trunk/lutinpluginutil/src/test/resources/log4j.properties =================================================================== --- trunk/lutinpluginutil/src/test/resources/log4j.properties (rev 0) +++ trunk/lutinpluginutil/src/test/resources/log4j.properties 2008-08-15 16:59:21 UTC (rev 1026) @@ -0,0 +1,10 @@ +# Global logging configuration +log4j.rootLogger=ERROR, stdout +# Console output... +log4j.appender.stdout=org.apache.log4j.ConsoleAppender +log4j.appender.stdout.layout=org.apache.log4j.PatternLayout +log4j.appender.stdout.layout.ConversionPattern=%5p [%t] (%F:%L) %M - %m%n + +# package level +log4j.logger.org.codelutin.util=DEBUG + Added: trunk/lutinpluginutil/src/test/resources/org/codelutin/util/JaxxDummy.jaxx =================================================================== --- trunk/lutinpluginutil/src/test/resources/org/codelutin/util/JaxxDummy.jaxx (rev 0) +++ trunk/lutinpluginutil/src/test/resources/org/codelutin/util/JaxxDummy.jaxx 2008-08-15 16:59:21 UTC (rev 1026) @@ -0,0 +1,3 @@ +<Object> + Dummy file to test org.codelutin.util.FileUpdaterHelper.JaxxFileUpdater +</Object> \ No newline at end of file