Added source importing and very basic syntax coloring (keywords, reserved variables, and comments).

Author: wpgreenway

src/main/java/com/pica/sonarplugins/ruby/RubyPlugin.java

@@ -1,6 +1,8 @@
 package com.pica.sonarplugins.ruby;
 
 import com.pica.sonarplugins.ruby.core.Ruby;
+import com.pica.sonarplugins.ruby.core.RubySourceCodeColorizer;
+import com.pica.sonarplugins.ruby.core.RubySourceImporter;
 import org.sonar.api.Plugin;
 import org.sonar.api.Properties;
 
@@ -26,7 +28,9 @@ public String getDescription() {
     public List getExtensions() {
         return Arrays.asList(
                 Ruby.class,
-                RubySensor.class
+                RubySensor.class,
+                RubySourceImporter.class,
+                RubySourceCodeColorizer.class
         );
     }
 

src/main/java/com/pica/sonarplugins/ruby/core/Ruby.java

@@ -7,6 +7,17 @@ public class Ruby extends AbstractLanguage {
     public static final String KEY = "ruby";
     public static Ruby INSTANCE = new Ruby();
 
+    static final String[] RUBY_KEYWORDS_ARRAY = new String[]{
+            "alias", "and", "BEGIN", "begin", "break", "case", "class", "def", "defined?",
+            "do", "else", "elsif", "END", "end", "ensure", "false", "for", "if", "in", "module",
+            "next", "nil", "not", "or", "redo", "rescue", "retry", "return", "self", "super",
+            "then", "true", "undef", "unless", "until", "when", "while", "yield"
+    };
+
+    static final String[] RUBY_RESERVED_VARIABLES_ARRAY = new String[]{
+            "__FILE__", "__LINE__"
+    };
+
     public Ruby() {
         super(KEY, "Ruby");
     }

src/main/java/com/pica/sonarplugins/ruby/core/RubyFile.java

@@ -112,7 +112,7 @@ public static RubyFile fromIOFile(File file, List<File> sourceDirs) {
 
   /**
    * Creates a {@link RubyFile} from a file in the source directories.
-   * 
+   *
    * @param unitTest whether it is a unit test file or a source file
    * @return the {@link RubyFile} created if exists, null otherwise
    */

src/main/java/com/pica/sonarplugins/ruby/core/RubySourceCodeColorizer.java

@@ -0,0 +1,41 @@
+package com.pica.sonarplugins.ruby.core;
+
+import static com.pica.sonarplugins.ruby.core.Ruby.RUBY_KEYWORDS_ARRAY;
+import static com.pica.sonarplugins.ruby.core.Ruby.RUBY_RESERVED_VARIABLES_ARRAY;
+
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+
+import org.sonar.api.web.CodeColorizerFormat;
+import org.sonar.colorizer.KeywordsTokenizer;
+import org.sonar.colorizer.RegexpTokenizer;
+import org.sonar.colorizer.StringTokenizer;
+import org.sonar.colorizer.Tokenizer;
+
+public class RubySourceCodeColorizer extends CodeColorizerFormat {
+
+    private static final Set<String> RUBY_KEYWORDS = new HashSet<String>();
+    private static final Set<String> RUBY_RESERVED_VARIABLES = new HashSet<String>();
+
+    static {
+        Collections.addAll(RUBY_KEYWORDS, RUBY_KEYWORDS_ARRAY);
+        Collections.addAll(RUBY_RESERVED_VARIABLES, RUBY_RESERVED_VARIABLES_ARRAY);
+    }
+
+    public RubySourceCodeColorizer() {
+        super(Ruby.KEY);
+    }
+    
+    @Override
+    public List<Tokenizer> getTokenizers() {
+        String tagAfter = "</span>";
+        KeywordsTokenizer rubyKeyWordsTokenizer = new KeywordsTokenizer("<span class=\"k\">", tagAfter, RUBY_KEYWORDS);
+        KeywordsTokenizer rubyVariablesTokenizer = new KeywordsTokenizer("<span class=\"c\">", tagAfter, RUBY_RESERVED_VARIABLES);
+        RegexpTokenizer rubyCommentsTokenizer = new RegexpTokenizer("<span class=\"cd\">", tagAfter, "#.*");
+        StringTokenizer stringTokenizer = new StringTokenizer("<span class=\"s\">", tagAfter);
+        return Collections.unmodifiableList(Arrays.asList(rubyKeyWordsTokenizer, rubyVariablesTokenizer, rubyCommentsTokenizer, stringTokenizer));
+    }
+}

src/main/java/com/pica/sonarplugins/ruby/core/RubySourceImporter.java

@@ -0,0 +1,78 @@
+package com.pica.sonarplugins.ruby.core;
+
+import static com.pica.sonarplugins.ruby.core.Ruby.INSTANCE;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.charset.Charset;
+import java.util.List;
+
+import org.apache.commons.lang.builder.ToStringBuilder;
+import org.apache.commons.lang.builder.ToStringStyle;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.sonar.api.batch.AbstractSourceImporter;
+import org.sonar.api.batch.Phase;
+import org.sonar.api.batch.SensorContext;
+import org.sonar.api.resources.Project;
+import org.sonar.api.resources.ProjectFileSystem;
+import org.sonar.api.utils.SonarException;
+
+@Phase(name = Phase.Name.PRE)
+
+public class RubySourceImporter extends AbstractSourceImporter {
+
+    private static final Logger LOG = LoggerFactory.getLogger(RubySourceImporter.class);
+    private Project project;
+
+    public RubySourceImporter(Project project) {
+        super(Ruby.INSTANCE);
+        this.project = project;
+    }
+
+    @Override
+    public void analyse(Project project, SensorContext context) {
+        try {
+            LOG.info("Importing files from project " + project.getName());
+            doAnalyse(project, context);
+        } catch (IOException e) {
+            throw new SonarException("Parsing source files ended abnormally", e);
+        }
+    }
+
+    @Override
+    protected RubyFile createResource(File file, List<File> sourceDirs, boolean unitTest) {
+        return file != null ? RubyFile.fromIOFile(file, sourceDirs, unitTest) : null;
+    }
+
+    protected void doAnalyse(Project project, SensorContext context) throws IOException {
+        // Importing source files
+        ProjectFileSystem fileSystem = project.getFileSystem();
+        Charset sourceCharset = fileSystem.getSourceCharset();
+
+        List<File> sourceDirs = fileSystem.getSourceDirs();
+        List<File> sourceFiles = fileSystem.getSourceFiles(INSTANCE);
+        parseDirs(context, sourceFiles, sourceDirs, false, sourceCharset);
+        for (File directory : sourceDirs) {
+            LOG.info(directory.getName());
+        }
+
+        // Importing tests files
+        List<File> testDirs = fileSystem.getTestDirs();
+        List<File> testFiles = fileSystem.getTestFiles(INSTANCE);
+        parseDirs(context, testFiles, testDirs, true, sourceCharset);
+        // Display source dirs and tests directories if info level is enabled.
+        for (File directory : testDirs) {
+            LOG.info(directory.getName());
+        }
+    }
+
+    @Override
+    public String toString() {
+        ToStringBuilder builder = new ToStringBuilder(this, ToStringStyle.SHORT_PREFIX_STYLE);
+        builder.append("getLanguage()", getLanguage());
+        builder.append("getClass()", getClass());
+        return builder.toString();
+    }
+
+}