Merge branch 'dev' of

https://github.com/CfrancCyrille/sonar-icode-cnes-plugin into dev

# Conflicts:
#	src/main/js/components/MetricsSummaryTab/MetricsSummaryTab.js

Author: CfrancCyrille

.travis.yml

@@ -20,10 +20,10 @@ notifications:
 
 addons:
   sonarcloud:
-    organization: "AT-NicolasMetivier"
+    organization: "lequal"
     token:
       secure: projettest  # encrypted value of your token
 # Script to execute.
 
 script:
-  - mvn clean org.jacoco:jacoco-maven-plugin:prepare-agent install sonar:sonar -Dsonar.host.url=https://sonarcloud.io -Dsonar.organization=at-nicolasmetivier-github -Dsonar.login=d217f2a7b06684f932ec72bbc294e27e87d9c361
+  - mvn clean org.jacoco:jacoco-maven-plugin:prepare-agent install sonar:sonar -Dsonar.host.url=https://sonarcloud.io -Dsonar.organization=lequal -Dsonar.login=181e22946e5e05302ceb4513dae3dcc9f7161f2f

CONTRIBUTING.md

@@ -0,0 +1,81 @@
+# Contributing to sonar-icode-cnes-plugin
+
+First off, thanks for taking the time to contribute!
+
+The following is a set of guidelines for contributing to sonar-icode-cnes-plugin, which are hosted in the [Lequal Organization](https://github.com/lequal) on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
+
+#### Table Of Contents
+
+[Code of Conduct](#code-of-conduct)
+
+[How Can I Contribute?](#how-can-i-contribute)
+  * [Reporting Bugs](#reporting-bugs)
+  * [Suggesting Enhancements](#suggesting-enhancements)
+  * [Pull Requests](#pull-requests)
+
+[Git Commit Messages](#git-commit-messages)
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the [Lequal Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [[email protected]](mailto:[email protected]).
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+Before creating bug reports, please check if the problem has already been reported. 
+
+#### How Do I Submit A (Good) Bug Report?
+
+Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). Provide information by filling [the template](ISSUE_TEMPLATE.md).
+
+Explain the problem and include additional details to help maintainers reproduce the problem:
+
+* **Use a clear and descriptive title** for the issue to identify the problem.
+* **Describe the exact steps which reproduce the problem** in as many details as possible. When listing steps, don't just say what you did, but explain how you did it.
+* **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, which you use in those examples.
+* **Explain which behavior you expected and describe the behavior you observed** after following the steps and point out what exactly is the problem with that behavior.
+* **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux.
+* **If you're reporting that the plugin crashed**, include a crash report with a stack trace from the operating system.
+
+Provide more context by answering these questions:
+
+* **Did the problem start happening recently** (e.g. after updating to a new version of the plugin or SonarQube) or was this always a problem?
+* If the problem started happening recently, **can you reproduce the problem in an older version?** What's the most recent version in which the problem doesn't happen? You can download older versions from [the releases page](https://github.com/lequal/sonar-icode-cnes-plugin/releases).
+* **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
+
+Include details about your configuration and environment:
+
+* **Which SonarQube version are you using?** You can get the exact version at the bottom of your SonarQube instance.
+
+### Suggesting Enhancements
+
+Before creating enhancement suggestions, please check if the problem has already been suggested.
+
+#### How Do I Submit A (Good) Enhancement Suggestion?
+
+Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). To submit en enhancement suggestion, create an issue and provide the following information:
+
+* **Use a clear and descriptive title** for the issue to identify the suggestion.
+* **Provide a step-by-step description of the suggested enhancement** in as many details as possible.
+* **Provide specific examples to demonstrate the steps**. Include copy/pasteable snippets which you use in those examples, as [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines).
+* **Describe the current behavior** and **explain which behavior you expected to see instead** and why.
+* **Include screenshots and animated GIFs** which help you demonstrate the steps or point out the part of Atom which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux.
+* **Explain why this enhancement would be useful**
+* **Specify which version you're using.**
+* **Specify the SonarQube version you're using.** The SonarQube version is mentionned at the bottom of the web page.
+
+### Pull Requests
+
+* Fill in [the required template](PULL_REQUEST_TEMPLATE.md)
+* Do not include issue numbers in the PR title
+* Include screenshots and animated GIFs in your pull request whenever possible.
+* Follow the Java styleguides.
+
+## Git Commit Messages
+
+* Use the present tense ("Add feature" not "Added feature")
+* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+* Limit the first line to 72 characters or less
+* Reference issues and pull requests liberally after the first line
+* When only changing documentation, include `[ci skip]` in the commit description

pom.xml

@@ -46,7 +46,7 @@
 		<slf4j.version>1.7.25</slf4j.version>
 		<junit.version>4.12</junit.version>
 		<project.key>icode</project.key>
-		<sonar.sources>src/main/java,src/main/js</sonar.sources>
+		<sonar.sources>src/main/java</sonar.sources>
 	</properties>
 
 	<dependencies>
@@ -85,6 +85,19 @@
 
 	<build>
 		<plugins>
+		   <plugin>
+                <groupId>org.jacoco</groupId>
+                <artifactId>jacoco-maven-plugin</artifactId>
+                <version>0.7.6.201602180812</version>
+                <executions>
+                    <execution>
+                        <id>prepare-agent</id>
+                        <goals>
+                            <goal>prepare-agent</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
 			<plugin>
 				<groupId>org.sonarsource.sonar-packaging-maven-plugin</groupId>
 				<artifactId>sonar-packaging-maven-plugin</artifactId>

src/main/java/fr/cnes/sonarqube/plugins/icode/languages/ICodeLanguage.java

@@ -70,4 +70,29 @@ private String[] filterEmptyStrings(String[] stringArray) {
 		}
 		return nonEmptyStrings.toArray(new String[nonEmptyStrings.size()]);
 	}
+
+	@Override
+	public int hashCode() {
+		final int prime = 31;
+		int result = super.hashCode();
+		result = prime * result + ((settings == null) ? 0 : settings.hashCode());
+		return result;
+	}
+
+	@Override
+	public boolean equals(Object obj) {
+		if (this == obj)
+			return true;
+		if (!super.equals(obj))
+			return false;
+		if (getClass() != obj.getClass())
+			return false;
+		ICodeLanguage other = (ICodeLanguage) obj;
+		if (settings == null) {
+			if (other.settings != null)
+				return false;
+		} else if (!settings.equals(other.settings))
+			return false;
+		return true;
+	}
 }

src/main/java/fr/cnes/sonarqube/plugins/icode/languages/ICodeQualityProfile.java

@@ -20,17 +20,16 @@
 
 import org.sonar.api.profiles.ProfileDefinition;
 import org.sonar.api.profiles.RulesProfile;
-import org.sonar.api.rules.Rule;
 import org.sonar.api.utils.ValidationMessages;
 
 /**
  * Default Quality profile for the projects having files of language "icode"
  */
 public final class ICodeQualityProfile extends ProfileDefinition {
-	 @Override
-	  public RulesProfile createProfile(ValidationMessages validation) {
-	    RulesProfile profile = RulesProfile.create("ICode Rules", ICodeLanguage.KEY);
+	 static final String I_CODE_RULES_PROFILE_NAME = "ICode Rules";
 
-	    return profile;
+	@Override
+	  public RulesProfile createProfile(ValidationMessages validation) {
+	    return RulesProfile.create(I_CODE_RULES_PROFILE_NAME, ICodeLanguage.KEY);
 	  }
 }

src/main/java/fr/cnes/sonarqube/plugins/icode/measures/ComputeModuleF77CyclomaticStatistics.java

@@ -17,7 +17,6 @@
 */
 package fr.cnes.sonarqube.plugins.icode.measures;
 
-//import static fr.cnes.sonarqube.plugins.icode.measures.ICodeMetrics.DBG;
 import static fr.cnes.sonarqube.plugins.icode.measures.ICodeMetricsF77Cyclomatic.F77_CYCLOMATIC;
 import static fr.cnes.sonarqube.plugins.icode.measures.ICodeMetricsF77Cyclomatic.F77_CYCLOMATIC_MEAN;
 import static fr.cnes.sonarqube.plugins.icode.measures.ICodeMetricsF77Cyclomatic.F77_CYCLOMATIC_MIN;
@@ -41,10 +40,10 @@ public class ComputeModuleF77CyclomaticStatistics implements MeasureComputer {
 
 	@Override
 	public MeasureComputerDefinition define(MeasureComputerDefinitionContext defContext) {
-		
+		String[] metricTab = new String[] {F77_CYCLOMATIC.key(),F77_CYCLOMATIC_MEAN.key(),F77_CYCLOMATIC_MIN.key(),F77_CYCLOMATIC_MAX.key()};
 	    return defContext.newDefinitionBuilder()
-	    		.setInputMetrics(new String[] {F77_CYCLOMATIC.key(),F77_CYCLOMATIC_MEAN.key(),F77_CYCLOMATIC_MIN.key(),F77_CYCLOMATIC_MAX.key()})
-	    		.setOutputMetrics(new String[] {F77_CYCLOMATIC.key(),F77_CYCLOMATIC_MEAN.key(),F77_CYCLOMATIC_MIN.key(),F77_CYCLOMATIC_MAX.key()})//,DBG.key()})
+	    		.setInputMetrics(metricTab)
+	    		.setOutputMetrics(metricTab)
 	    		.build();
 	}
 
@@ -54,51 +53,53 @@ public void compute(MeasureComputerContext context) {
 		// Create module measures
 		if (context.getComponent().getType() != Component.Type.FILE) {
 
-//			// Search Cyclomatic measure for children files
-//			childrenMeasures = context.getChildrenMeasures(F77_CYCLOMATIC.key());
-//			if(childrenMeasures.iterator().hasNext()){
-//				int sum = 0;
-//				for (Measure child : childrenMeasures) {
-//					sum += child.getIntValue();
-//				}			
-//				context.addMeasure(F77_CYCLOMATIC.key(),sum);				
-//			}
-			
 			// Search Cyclomatic mean measure for children files
 			childrenMeasures = context.getChildrenMeasures(F77_CYCLOMATIC_MEAN.key());
-			if(childrenMeasures.iterator().hasNext()){
-				double sum = 0;
-				int nbItem = 0;
-				for (Measure child : childrenMeasures) {
-					sum += child.getDoubleValue();
-					nbItem++;
-				}
-				context.addMeasure(F77_CYCLOMATIC_MEAN.key(),(nbItem!=0)?sum/nbItem:sum);							
-			}
+			computeMean(context, childrenMeasures);
 
 			// Search Cyclomatic minimum measure for children files
 			childrenMeasures = context.getChildrenMeasures(F77_CYCLOMATIC_MIN.key());
-			if(childrenMeasures.iterator().hasNext()){
-				int min = 1000;
-				for (Measure child : childrenMeasures){
-					if(child.getIntValue() < min){
-						min = child.getIntValue();
-					}
-				}
-				context.addMeasure(F77_CYCLOMATIC_MIN.key(), min);
-			}
+			computeMin(context, childrenMeasures);
 
 			// Search Cyclomatic minimum measure for children files
 			childrenMeasures = context.getChildrenMeasures(F77_CYCLOMATIC_MAX.key());
-			if(childrenMeasures.iterator().hasNext()){
-				int max = 0;
-				for (Measure child : childrenMeasures){
-					if(child.getIntValue() > max){
-						max = child.getIntValue();
-					}
+			computeMax(context, childrenMeasures);
+		}
+	}
+
+	private void computeMax(MeasureComputerContext context, Iterable<Measure> childrenMeasures) {
+		if(childrenMeasures.iterator().hasNext()){
+			int max = 0;
+			for (Measure child : childrenMeasures){
+				if(child.getIntValue() > max){
+					max = child.getIntValue();
 				}
-				context.addMeasure(F77_CYCLOMATIC_MAX.key(), max);
 			}
+			context.addMeasure(F77_CYCLOMATIC_MAX.key(), max);
+		}
+	}
+
+	private void computeMin(MeasureComputerContext context, Iterable<Measure> childrenMeasures) {
+		if(childrenMeasures.iterator().hasNext()){
+			int min = 1000;
+			for (Measure child : childrenMeasures){
+				if(child.getIntValue() < min){
+					min = child.getIntValue();
+				}
+			}
+			context.addMeasure(F77_CYCLOMATIC_MIN.key(), min);
+		}
+	}
+
+	private void computeMean(MeasureComputerContext context, Iterable<Measure> childrenMeasures) {
+		if(childrenMeasures.iterator().hasNext()){
+			double sum = 0;
+			int nbItem = 0;
+			for (Measure child : childrenMeasures) {
+				sum += child.getDoubleValue();
+				nbItem++;
+			}
+			context.addMeasure(F77_CYCLOMATIC_MEAN.key(),(nbItem!=0)?sum/nbItem:sum);							
 		}
 	}
 }