update to no longer strip out the hotspots section from metricfu

Author: demerson

README.md

@@ -50,4 +50,5 @@ Our complexity sensor and code coverage sensor borrow heavily from the javascrip
 ##Updates from Constant Contact
 * Updates were made for compatibility with Sonar 4.5.2 and it's api
 * Added support for configuring report paths for SimpleCovRcov and MetricFu via Sonar properties. They are available in the Code Coverage category and are configurable per project.
+* Added support to configure whether to use Saikuro or Cane for complexity metrics. May add support for obtaining complexity from flog as well
 * Several dependencies were also updated to more recent versions.

sonar-project.properties

@@ -1,7 +1,7 @@
 # Required metadata
 sonar.projectKey=ruby-sonar-plugin-gd
 sonar.projectName=Ruby Sonar Plugin
-sonar.projectVersion=1.0
+sonar.projectVersion=1.0.1
 
 # Comma-separated paths to directories with sources (required)
 sonar.sources=src/main/java

src/main/java/com/godaddy/sonar/ruby/metricfu/MetricfuComplexityYamlParserImpl.java

@@ -1,7 +1,9 @@
 package com.godaddy.sonar.ruby.metricfu;
 
 import java.io.File;
+import java.io.FileInputStream;
 import java.io.IOException;
+import java.io.InputStream;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
@@ -13,6 +15,8 @@
 import org.slf4j.LoggerFactory;
 import org.yaml.snakeyaml.Yaml;
 
+import com.google.common.base.Throwables;
+
 public class MetricfuComplexityYamlParserImpl implements
     MetricfuComplexityYamlParser {
   private static final Logger LOG = LoggerFactory
@@ -21,13 +25,17 @@ public class MetricfuComplexityYamlParserImpl implements
   @SuppressWarnings("unchecked")
   public List<RubyFunction> parseFunctions(String fileNameFromModule, File resultsFile, String complexityType) throws IOException
   {
-    String fileString = FileUtils.readFileToString(resultsFile, "UTF-8");
+//    String fileString = FileUtils.readFileToString(resultsFile, "UTF-8");
+    InputStream resultsStream = new FileInputStream(resultsFile);
+
     LOG.debug("MetricfuComplexityYamlParserImpl: Start start parse of metrics_fu YAML");
 
     // remove ":hotspots:" section of the yaml so snakeyaml can parse it
     // correctly, snakeyaml throws an error with that section intact
     // Will remove if metric_fu metric filtering works for hotspots in the
     // future
+    
+// Removing this as it seems to be working correctly with current versions of dependencies
 //    int hotSpotIndex = fileString.indexOf(":hotspots:");
 //    if (hotSpotIndex >= 0)
 //    {
@@ -36,19 +44,27 @@ public List<RubyFunction> parseFunctions(String fileNameFromModule, File results
 //    }
 
     Yaml yaml = new Yaml();
-
-    Map<String, Object> metricfuResult = (Map<String, Object>) yaml.loadAs(fileString, Map.class);
-    Map<String, Object> saikuroResult = (Map<String, Object>) metricfuResult.get(":saikuro");
-    Map<String, Object> caneResult = (Map<String, Object>) metricfuResult.get(":cane");
-
-    if ("Saikuro".equals(complexityType) && null != saikuroResult) {
-      return analyzeSaikuro(fileNameFromModule, metricfuResult, saikuroResult);
-    } else if ("Cane".equals(complexityType) && null != caneResult) {
-      return analyzeCane(fileNameFromModule, metricfuResult, caneResult);
-    } else {
-      LOG.warn("No data found for complexity type " + complexityType);
-      return new ArrayList<RubyFunction>();
+    Map<String, Object> metricfuResult = new HashMap();
+    try {
+//      metricfuResult = (Map<String, Object>) yaml.loadAs(fileString, Map.class);
+      metricfuResult = (Map<String, Object>) yaml.load(resultsStream);
+      
+      Map<String, Object> saikuroResult = (Map<String, Object>) metricfuResult.get(":saikuro");
+      Map<String, Object> caneResult = (Map<String, Object>) metricfuResult.get(":cane");
+
+      if ("Saikuro".equals(complexityType) && null != saikuroResult) {
+        return analyzeSaikuro(fileNameFromModule, metricfuResult, saikuroResult);
+      } else if ("Cane".equals(complexityType) && null != caneResult) {
+        return analyzeCane(fileNameFromModule, metricfuResult, caneResult);
+      } else {
+        LOG.warn("No data found for complexity type " + complexityType);
+        return new ArrayList<RubyFunction>();
+      }
+    } catch (Exception e) {
+      LOG.error(Throwables.getStackTraceAsString(e));
+      throw new IOException("Failure parsing YAML results", e);
     }
+    
   }
 
   private List<RubyFunction> analyzeSaikuro(String fileNameFromModule, Map<String, Object> metricfuResult,

src/test/java/com/godaddy/sonar/ruby/metricfu/MetricfuComplexitySensorTest.java

@@ -63,11 +63,7 @@ public void setUp() throws Exception
 		expect(config.getString("sonar.language", "java")).andStubReturn("ruby");
 
 		project = new Project("test project");	
-		Settings settings = new Settings();
-//		settings.setProperty(CoreProperties.PROJECT_LANGUAGE_PROPERTY, LanguageRuby.KEY);
-//		project.setSettings(settings);
-		project.setLanguage(LanguageRuby.INSTANCE);
-		
+		project.setLanguage(LanguageRuby.INSTANCE);		
 		project.setConfiguration(config);
 
 	}
@@ -78,22 +74,6 @@ public void testConstructor()
 		assertNotNull(metricfuComplexitySensor);
 	}
 
-//	@Test
-//	public void testShouldExecuteOnRubyProject()
-//	{		
-//		Configuration config = mocksControl.createMock(Configuration.class);
-//		expect(config.getString("sonar.language", "java")).andReturn("ruby");
-//		mocksControl.replay();
-//		
-//		Project project = new Project("test project");
-//		project.setConfiguration(config);
-//
-//		RubySensor sensor = new RubySensor(moduleFileSystem);
-//		sensor.shouldExecuteOnProject(project);
-//		
-//		mocksControl.verify();			
-//	}
-
 	@Test
 	public void testAnalyse() throws IOException
 	{

src/test/java/com/godaddy/sonar/ruby/metricfu/MetricfuComplexityYamlParserTest.java

@@ -9,7 +9,8 @@
 
 public class MetricfuComplexityYamlParserTest extends TestCase
 {
-	private final static String YML_FILE_NAME = "src/test/resources/test-data/results.yml";
+	private final static String YML_SYNTAX_FILE_NAME = "src/test/resources/test-data/metricfu_report.yml";
+    private final static String YML_PARSE_FILE_NAME = "src/test/resources/test-data/results.yml";
 
 	private MetricfuComplexityYamlParserImpl parser = null;
 
@@ -18,11 +19,23 @@ public void setUp() throws Exception
 	{
 		parser = new MetricfuComplexityYamlParserImpl();
 	}
-		
+
+	
+    @Test
+    public void testParseFunctionSyntaxHandling() throws IOException
+    {
+        File reportFile = new File(YML_SYNTAX_FILE_NAME);
+        List<RubyFunction> rubyFunctions = parser.parseFunctions("lib/some_path/foo_bar.rb", reportFile, "Saikuro");
+
+        RubyFunction rubyFunction0 = new RubyFunction("FooBar#validate_user_name", 4, 5);       
+//        assertTrue(rubyFunctions.size()==2);
+//        assertTrue(rubyFunctions.get(0).toString().equals(rubyFunction0.toString()));
+    }   
+	
 	@Test
 	public void testParseFunction() throws IOException
 	{
-		File reportFile = new File(YML_FILE_NAME);
+		File reportFile = new File(YML_PARSE_FILE_NAME);
 		List<RubyFunction> rubyFunctions = parser.parseFunctions("lib/some_path/foo_bar.rb", reportFile, "Saikuro");
 
 		RubyFunction rubyFunction0 = new RubyFunction("FooBar#validate_user_name", 4, 5);