Author: tchemit Date: 2009-01-28 10:07:21 +0000 (Wed, 28 Jan 2009) New Revision: 300 Added: lutin-enforcer-rules/trunk/LICENSE.txt lutin-enforcer-rules/trunk/README.txt lutin-enforcer-rules/trunk/changelog.txt lutin-enforcer-rules/trunk/src/main/java/org/codelutin/enforcer/CheckLabsPropertiesRule.java lutin-enforcer-rules/trunk/src/site/fr/ lutin-enforcer-rules/trunk/src/site/fr/rst/ lutin-enforcer-rules/trunk/src/site/fr/rst/Todo.rst lutin-enforcer-rules/trunk/src/site/fr/rst/index.rst lutin-enforcer-rules/trunk/src/site/site.xml Modified: lutin-enforcer-rules/trunk/pom.xml Log: cr?\195?\169ation d'un projet maven pour pouvoir ajouter nos regles enforcer Added: lutin-enforcer-rules/trunk/LICENSE.txt =================================================================== --- lutin-enforcer-rules/trunk/LICENSE.txt (rev 0) +++ lutin-enforcer-rules/trunk/LICENSE.txt 2009-01-28 10:07:21 UTC (rev 300) @@ -0,0 +1,166 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser 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 +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. + Added: lutin-enforcer-rules/trunk/README.txt =================================================================== --- lutin-enforcer-rules/trunk/README.txt (rev 0) +++ lutin-enforcer-rules/trunk/README.txt 2009-01-28 10:07:21 UTC (rev 300) @@ -0,0 +1,2 @@ +To deploy new version of pom: mvn deploy +To install localy: mvn install Added: lutin-enforcer-rules/trunk/changelog.txt =================================================================== --- lutin-enforcer-rules/trunk/changelog.txt (rev 0) +++ lutin-enforcer-rules/trunk/changelog.txt 2009-01-28 10:07:21 UTC (rev 300) @@ -0,0 +1,3 @@ +1.0 chemit 20090128 + * 20090128 [chemit] - initial version + \ No newline at end of file Modified: lutin-enforcer-rules/trunk/pom.xml =================================================================== --- lutin-enforcer-rules/trunk/pom.xml 2009-01-28 09:14:24 UTC (rev 299) +++ lutin-enforcer-rules/trunk/pom.xml 2009-01-28 10:07:21 UTC (rev 300) @@ -11,48 +11,55 @@ <parent> <groupId>org.codelutin</groupId> <artifactId>lutinpluginproject</artifactId> - <version>3.4-SNAPSHOT</version> + <version>3.3</version> </parent> <artifactId>lutin-enforcer-rules</artifactId> <version>0.1-SNAPSHOT</version> -<dependencies> - <dependency> - <groupId>org.apache.maven.enforcer</groupId> - <artifactId>enforcer-api</artifactId> - <version>${api.version}</version> - </dependency> - <dependency> - <groupId>org.apache.maven</groupId> - <artifactId>maven-project</artifactId> - <version>${maven.version}</version> - </dependency> - <dependency> - <groupId>org.apache.maven</groupId> - <artifactId>maven-core</artifactId> - <version>${maven.version}</version> - </dependency> - <dependency> - <groupId>org.apache.maven</groupId> - <artifactId>maven-artifact</artifactId> - <version>${maven.version}</version> - </dependency> - <dependency> - <groupId>org.apache.maven</groupId> - <artifactId>maven-plugin-api</artifactId> - <version>${maven.version}</version> - </dependency> - <dependency> - <groupId>org.codehaus.plexus</groupId> - <artifactId>plexus-container-default</artifactId> - <version>1.0-alpha-9</version> - </dependency> + <dependencies> + <dependency> + <groupId>org.apache.maven.enforcer</groupId> + <artifactId>enforcer-api</artifactId> + <version>${api.version}</version> + </dependency> + <dependency> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-enforcer-plugin</artifactId> + <version>${api.version}</version> + </dependency> - </dependencies> + <dependency> + <groupId>org.apache.maven</groupId> + <artifactId>maven-project</artifactId> + <version>${maven.version}</version> + </dependency> + <dependency> + <groupId>org.apache.maven</groupId> + <artifactId>maven-core</artifactId> + <version>${maven.version}</version> + </dependency> + <dependency> + <groupId>org.apache.maven</groupId> + <artifactId>maven-artifact</artifactId> + <version>${maven.version}</version> + </dependency> + <dependency> + <groupId>org.apache.maven</groupId> + <artifactId>maven-plugin-api</artifactId> + <version>${maven.version}</version> + </dependency> + <dependency> + <groupId>org.codehaus.plexus</groupId> + <artifactId>plexus-container-default</artifactId> + <version>1.0-alpha-9</version> + </dependency> + </dependencies> + + <!-- ************************************************************* --> <!-- *** Project Information ************************************* --> <!-- ************************************************************* --> @@ -72,15 +79,19 @@ <properties> <!-- id du projet du labs --> - <labs.id>12</labs.id> + <labs.id>11</labs.id> <!-- nom du projet sur le labs --> - <labs.project>lutinutil</labs.project> + <labs.project>lutinbuilder</labs.project> - <api.version>1.0-alpha-4</api.version> - + <api.version>1.0-alpha-4</api.version> + <maven.version>2.0.9</maven.version> </properties> + <build> + <defaultGoal>install</defaultGoal> + </build> + <!-- ************************************************************* --> <!-- *** Build Environment ************************************** --> <!-- ************************************************************* --> Added: lutin-enforcer-rules/trunk/src/main/java/org/codelutin/enforcer/CheckLabsPropertiesRule.java =================================================================== --- lutin-enforcer-rules/trunk/src/main/java/org/codelutin/enforcer/CheckLabsPropertiesRule.java (rev 0) +++ lutin-enforcer-rules/trunk/src/main/java/org/codelutin/enforcer/CheckLabsPropertiesRule.java 2009-01-28 10:07:21 UTC (rev 300) @@ -0,0 +1,73 @@ +package org.codelutin.enforcer; + +import org.apache.maven.enforcer.rule.api.EnforcerRule; +import org.apache.maven.enforcer.rule.api.EnforcerRuleException; +import org.apache.maven.enforcer.rule.api.EnforcerRuleHelper; +import org.apache.maven.plugin.logging.Log; +import org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException; + +import java.util.Arrays; +import java.util.List; + +/** + * Permet de vérifier que les propriétés <code>labs.id</code> et <code>labs.name</code> sont correctement positionnés. + * + * @author chemit + */ +public class CheckLabsPropertiesRule implements EnforcerRule { + + public static final String LUTINBUILDER_LABS_NAME = "lutinbuilder"; + public static final String LUTINBUILDER_LABS_ID = "11"; + + public static final List<String> LUTINBUILDER_PROJECT_ARTIFACT_IDS = Arrays.asList("lutinproject", "lutinpluginproject", "maven-lutin-skin", "lutin-enforcer-rules"); + + @Override + public void execute(EnforcerRuleHelper helper) throws EnforcerRuleException { + Log log = helper.getLog(); + + try { + // get the various expressions out of the helper. + //MavenProject project = (MavenProject) helper.evaluate("${project}"); + //MavenSession session = (MavenSession) helper.evaluate("${session}"); + + String labsName = (String) helper.evaluate("${labs.name}"); + String labsId = (String) helper.evaluate("${labs.id}"); + String artifactId = (String) helper.evaluate("${project.artifactId}"); + + if (log.isDebugEnabled()) { + log.debug("Retrieved ArtifactId: " + artifactId); + log.debug("Retrieved LabsId: " + labsId); + log.debug("Retrieved LabsName: " + labsName); + + } + if (LUTINBUILDER_LABS_ID.equals(labsId) || LUTINBUILDER_LABS_NAME.equals(labsName)) { + // must check we are on a lutinbuilder project + if (!LUTINBUILDER_PROJECT_ARTIFACT_IDS.contains(artifactId)) { + // a none lutinbuilder project can not have this labs.id value + throw new EnforcerRuleException("labs.id and labs.name must be override for your project, but was not!"); + } + } + + + } + catch (ExpressionEvaluationException e) { + throw new EnforcerRuleException("Unable to lookup an expression " + e.getLocalizedMessage(), e); + } + + } + + @Override + public boolean isCacheable() { + return false; + } + + @Override + public boolean isResultValid(EnforcerRule cachedRule) { + return false; + } + + @Override + public String getCacheId() { + return null; + } +} Added: lutin-enforcer-rules/trunk/src/site/fr/rst/Todo.rst =================================================================== --- lutin-enforcer-rules/trunk/src/site/fr/rst/Todo.rst (rev 0) +++ lutin-enforcer-rules/trunk/src/site/fr/rst/Todo.rst 2009-01-28 10:07:21 UTC (rev 300) @@ -0,0 +1,5 @@ +==== +TODO +==== + +TODO :) \ No newline at end of file Added: lutin-enforcer-rules/trunk/src/site/fr/rst/index.rst =================================================================== --- lutin-enforcer-rules/trunk/src/site/fr/rst/index.rst (rev 0) +++ lutin-enforcer-rules/trunk/src/site/fr/rst/index.rst 2009-01-28 10:07:21 UTC (rev 300) @@ -0,0 +1,11 @@ +lutin-enforcer-rules +==================== + +.. contents:: + + +Présentation +------------ + +Librairie qui permet d'ajouter nos propores règles de vérification de projet mavan utilisé par Enforcer. + Added: lutin-enforcer-rules/trunk/src/site/site.xml =================================================================== --- lutin-enforcer-rules/trunk/src/site/site.xml (rev 0) +++ lutin-enforcer-rules/trunk/src/site/site.xml 2009-01-28 10:07:21 UTC (rev 300) @@ -0,0 +1,60 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project name="${project.name}"> + + <publishDate format="dd/MM/yyyy"/> + + <skin> + <groupId>org.codelutin</groupId> + <artifactId>maven-lutin-skin</artifactId> + <version>0.2.2</version> + </skin> + + <bannerLeft> + <name>${project.name}</name> + <src>${site.home.url}</src> + <href>index.html</href> + </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}"/> + <item name="lutin project" href="../lutinproject"/> + <item name="maven-lutin-skin project" href="../maven-lutin-skin"/> + <item name="lutin-enforcer-rules" href="../lutin-enforcer-rules"/> + <item name="lutin maven repository" href="../maven2"/> + </links> + + <menu name="Utilisateur"> + <item name="Accueil" href="index.html"/> + </menu> + + <menu name="Téléchargement"> + <item href="../maven2/org/codelutin/${project.artifactId}/${project.version}" + name="Télécharger la dernière version"/> + <item href="../maven2/org/codelutin/${project.artifactId}" + name="Voir toutes les versions"/> + </menu> + + <menu name="Développeur"> + <item name="best practices" href="MavenPluginBestPractices.html"/> + <item name="A faire" href="Todo.html"/> + </menu> + + <menu ref="reports"/> + + <menu ref="modules"/> + + </body> +</project>