implement rule ps-one-constructor-minimum

java-feedback-rascal/src/Assignment01Rules.rsc

@@ -27,7 +27,7 @@ set[Message] a01_group(M3 model) = assertExists(findClass, model, "Group");
 set[Message] a01_io(M3 model)
 {
   // we assume there is only one main method, which lets us identify the main class
-  loc mainClass = getOneFrom(range(domainR(invert(model.containment), getMainMethods(model))));
+  loc mainClass = getMainClass(model);
 
   // find all methods that use System
   set[loc] ioMethods =

java-feedback-rascal/src/CodingRules.rsc

@@ -69,9 +69,9 @@ set[Message] ps_dedicated_main(M3 model)
 
 set[Message] ps_explicit_access_modifiers(M3 model)
 {
-  set[loc] thingsToCheck = range(declaredMethods(model)) + range(declaredFields(model));
+  set[loc] artifactsOfInterest = range(declaredMethods(model)) + range(declaredFields(model));
   set[Message] result = {};
-  for( thing <- thingsToCheck )
+  for( thing <- artifactsOfInterest )
   {
     // & is set intersection
     if( isEmpty(model.modifiers[thing] & {\public(), \protected(), \private()}) )
@@ -94,4 +94,11 @@ set[Message] ps_public_attributes(M3 model) =
 
 set[Message] ps_one_constructor_minimum(M3 model)
 {
+  loc mainClass = getMainClass(model);
+  return
+    { error("All classes should have at least one constructor", c)
+    | c <- classes(model)
+    , c != mainClass
+    , isEmpty(constructors(model, c))
+    };
 }
\ No newline at end of file

java-feedback-rascal/src/Util.rsc

@@ -15,4 +15,8 @@ set[loc] getMainMethods(M3 model)
   publicStatics = domain(invert(declaredMethods(model, checkModifiers = {\public(), \static()})));
   mains = { func | func <- publicStatics, getName(model, func) == "main" };
   return mains;
-}
\ No newline at end of file
+}
+
+// Assumes that there is exactly one Main class in the project
+loc getMainClass(M3 model) =
+  getOneFrom(range(domainR(invert(model.containment), getMainMethods(model))));
\ No newline at end of file

java-feedback-rascal/test-data/ps-constructor-missing/.classpath

+<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/>
+	<classpathentry kind="src" path="Assignment 1/src"/>
+	<classpathentry kind="output" path="bin"/>
+</classpath>

java-feedback-rascal/test-data/ps-constructor-missing/.project

+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>ps-constructor-missing</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.eclipse.jdt.core.javabuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.eclipse.jdt.core.javanature</nature>
+	</natures>
+</projectDescription>

java-feedback-rascal/test-data/ps-constructor-missing/Assignment 1/build.xml

+<?xml version="1.0" encoding="UTF-8"?>
+<!-- You may freely edit this file. See commented blocks below for -->
+<!-- some examples of how to customize the build. -->
+<!-- (If you delete it and reopen the project it will be recreated.) -->
+<!-- By default, only the Clean and Build commands use this build script. -->
+<!-- Commands such as Run, Debug, and Test only use this build script if -->
+<!-- the Compile on Save feature is turned off for the project. -->
+<!-- You can turn off the Compile on Save (or Deploy on Save) setting -->
+<!-- in the project's Project Properties dialog box.-->
+<project name="Assignment_1" default="default" basedir=".">
+    <description>Builds, tests, and runs the project Assignment 1.</description>
+    <import file="nbproject/build-impl.xml"/>
+    <!--
+
+    There exist several targets which are by default empty and which can be 
+    used for execution of your tasks. These targets are usually executed 
+    before and after some main targets. They are: 
+
+      -pre-init:                 called before initialization of project properties
+      -post-init:                called after initialization of project properties
+      -pre-compile:              called before javac compilation
+      -post-compile:             called after javac compilation
+      -pre-compile-single:       called before javac compilation of single file
+      -post-compile-single:      called after javac compilation of single file
+      -pre-compile-test:         called before javac compilation of JUnit tests
+      -post-compile-test:        called after javac compilation of JUnit tests
+      -pre-compile-test-single:  called before javac compilation of single JUnit test
+      -post-compile-test-single: called after javac compilation of single JUunit test
+      -pre-jar:                  called before JAR building
+      -post-jar:                 called after JAR building
+      -post-clean:               called after cleaning build products
+
+    (Targets beginning with '-' are not intended to be called on their own.)
+
+    Example of inserting an obfuscator after compilation could look like this:
+
+        <target name="-post-compile">
+            <obfuscate>
+                <fileset dir="${build.classes.dir}"/>
+            </obfuscate>
+        </target>
+
+    For list of available properties check the imported 
+    nbproject/build-impl.xml file. 
+
+
+    Another way to customize the build is by overriding existing main targets.
+    The targets of interest are: 
+
+      -init-macrodef-javac:     defines macro for javac compilation
+      -init-macrodef-junit:     defines macro for junit execution
+      -init-macrodef-debug:     defines macro for class debugging
+      -init-macrodef-java:      defines macro for class execution
+      -do-jar:                  JAR building
+      run:                      execution of project 
+      -javadoc-build:           Javadoc generation
+      test-report:              JUnit report generation
+
+    An example of overriding the target for project execution could look like this:
+
+        <target name="run" depends="Assignment_1-impl.jar">
+            <exec dir="bin" executable="launcher.exe">
+                <arg file="${dist.jar}"/>
+            </exec>
+        </target>
+
+    Notice that the overridden target depends on the jar target and not only on 
+    the compile target as the regular run target does. Again, for a list of available 
+    properties which you can use, check the target you are overriding in the
+    nbproject/build-impl.xml file. 
+
+    -->
+</project>

java-feedback-rascal/test-data/ps-constructor-missing/Assignment 1/manifest.mf

+Manifest-Version: 1.0
+X-COMMENT: Main-Class will be added automatically by build
+

java-feedback-rascal/test-data/ps-constructor-missing/Assignment 1/nbproject/genfiles.properties

+build.xml.data.CRC32=8abb193b
+build.xml.script.CRC32=877cb2ee
+build.xml.stylesheet.CRC32=f85dc8f2@1.90.1.48
+# This file is used by a NetBeans-based IDE to track changes in generated files such as build-impl.xml.
+# Do not edit this file. You may delete it but then the IDE will never regenerate such files for you.
+nbproject/build-impl.xml.data.CRC32=8abb193b
+nbproject/build-impl.xml.script.CRC32=e4f9ef34
+nbproject/build-impl.xml.stylesheet.CRC32=3a2fa800@1.90.1.48

java-feedback-rascal/test-data/ps-constructor-missing/Assignment 1/nbproject/project.properties

+annotation.processing.enabled=true
+annotation.processing.enabled.in.editor=false
+annotation.processing.processor.options=
+annotation.processing.processors.list=
+annotation.processing.run.all.processors=true
+annotation.processing.source.output=${build.generated.sources.dir}/ap-source-output
+build.classes.dir=${build.dir}/classes
+build.classes.excludes=**/*.java,**/*.form
+# This directory is removed when the project is cleaned:
+build.dir=build
+build.generated.dir=${build.dir}/generated
+build.generated.sources.dir=${build.dir}/generated-sources
+# Only compile against the classpath explicitly listed here:
+build.sysclasspath=ignore
+build.test.classes.dir=${build.dir}/test/classes
+build.test.results.dir=${build.dir}/test/results
+# Uncomment to specify the preferred debugger connection transport:
+#debug.transport=dt_socket
+debug.classpath=\
+    ${run.classpath}
+debug.modulepath=\
+    ${run.modulepath}
+debug.test.classpath=\
+    ${run.test.classpath}
+debug.test.modulepath=\
+    ${run.test.modulepath}
+# Files in build.classes.dir which should be excluded from distribution jar
+dist.archive.excludes=
+# This directory is removed when the project is cleaned:
+dist.dir=dist
+dist.jar=${dist.dir}/Assignment_1.jar
+dist.javadoc.dir=${dist.dir}/javadoc
+dist.jlink.dir=${dist.dir}/jlink
+dist.jlink.output=${dist.jlink.dir}/Assignment_1
+excludes=
+includes=**
+jar.compress=false
+javac.classpath=
+# Space-separated list of extra javac options
+javac.compilerargs=
+javac.deprecation=false
+javac.external.vm=true
+javac.modulepath=
+javac.processormodulepath=
+javac.processorpath=\
+    ${javac.classpath}
+javac.source=1.8
+javac.target=1.8
+javac.test.classpath=\
+    ${javac.classpath}:\
+    ${build.classes.dir}
+javac.test.modulepath=\
+    ${javac.modulepath}
+javac.test.processorpath=\
+    ${javac.test.classpath}
+javadoc.additionalparam=
+javadoc.author=false
+javadoc.encoding=${source.encoding}
+javadoc.html5=false
+javadoc.noindex=false
+javadoc.nonavbar=false
+javadoc.notree=false
+javadoc.private=false
+javadoc.splitindex=true
+javadoc.use=true
+javadoc.version=false
+javadoc.windowtitle=
+# The jlink additional root modules to resolve
+jlink.additionalmodules=
+# The jlink additional command line parameters
+jlink.additionalparam=
+jlink.launcher=true
+jlink.launcher.name=Assignment_1
+main.class=Main
+manifest.file=manifest.mf
+meta.inf.dir=${src.dir}/META-INF
+mkdist.disabled=false
+platform.active=default_platform
+run.classpath=\
+    ${javac.classpath}:\
+    ${build.classes.dir}
+# Space-separated list of JVM arguments used when running the project.
+# You may also define separate properties like run-sys-prop.name=value instead of -Dname=value.
+# To set system properties for unit tests define test-sys-prop.name=value:
+run.jvmargs=
+run.modulepath=\
+    ${javac.modulepath}
+run.test.classpath=\
+    ${javac.test.classpath}:\
+    ${build.test.classes.dir}
+run.test.modulepath=\
+    ${javac.test.modulepath}
+source.encoding=UTF-8
+src.dir=src
+test.src.dir=test

java-feedback-rascal/test-data/ps-constructor-missing/Assignment 1/nbproject/project.xml

+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://www.netbeans.org/ns/project/1">
+    <type>org.netbeans.modules.java.j2seproject</type>
+    <configuration>
+        <data xmlns="http://www.netbeans.org/ns/j2se-project/3">
+            <name>Assignment 1</name>
+            <source-roots>
+                <root id="src.dir"/>
+            </source-roots>
+            <test-roots>
+                <root id="test.src.dir"/>
+            </test-roots>
+        </data>
+    </configuration>
+</project>

java-feedback-rascal/test-data/ps-constructor-missing/Assignment 1/src/Group.java

+public class Group {
+    private int size;
+    private int currentindex = 0;
+    private Student[] members;
+
+    public Group(int size) {
+        this.size = size;
+        this.members = new Student[size];
+    }
+
+    public int addMember(Student member) {
+        if (this.currentindex + 1 <= size) {
+            this.members[this.currentindex++] = member;
+            return this.currentindex;
+        } else {
+            return -1;
+        }
+    }
+
+    public int hasMember(int student_number) {
+        for (int i = 0; i < this.size; i++) {
+            if (this.members[i].getStudent_number() == student_number) {
+                return i;
+            }
+        }
+        return -1;
+    }
+
+    public boolean changeMemberName(int student_number, String new_firstname, String new_surname) {
+        int index = this.hasMember(student_number);
+        if (index >= 0) {
+            this.members[index].setFirst_Name(new_firstname);
+            this.members[index].setSur_name(new_surname);
+        } else {
+            return false;
+        }
+        return true;
+    }
+
+    @Override
+    public String toString() {
+        StringBuilder sb = new StringBuilder();
+        sb.append("The group now contains:\n");
+        for (int i = 0; i < currentindex; i++) {
+            sb.append(this.members[i].toString());
+        }
+        return sb.toString();
+    }
+}
+

java-feedback-rascal/test-data/ps-constructor-missing/Assignment 1/src/Main.java

+import java.util.Scanner;
+
+public class Main {
+
+    // static final is constant
+    public static final int NUM_FOOBARS = 3;
+
+    public static void main(String[] args) {
+       System.out.print ("Enter a group size.\n");
+
+       Scanner scan = new Scanner(System.in);
+       int group_size = scan.nextInt();
+
+       Group group = new Group(group_size);
+       Student student = null;
+
+       do {
+           System.out.println("Please enter a student.");
+           int student_number = scan.nextInt();
+           String firstname = scan.next();
+           String surname = scan.next();
+           student = new Student(student_number, firstname, surname);
+        } while (group.addMember(student) < group_size);
+
+       System.out.print (group.toString());
+
+       int s_number = 0;
+
+       while (s_number >= 0) {
+          System.out.print ("Student number and new given/family name.\n");
+          s_number = scan.nextInt();
+          if (s_number < 0) break;
+          String firstname = scan.next();
+          String surname = scan.next();
+          if (!group.changeMemberName(s_number, firstname, surname)){
+             System.out.print ("Student number does not exist.");
+         } else {
+            System.out.print (group.toString());
+         }
+      }
+      System.out.print ("Bye!");
+    }
+}

java-feedback-rascal/test-data/ps-constructor-missing/Assignment 1/src/NoConstructor.java

+
+public class NoConstructor {
+
+	private int answer = 42;
+
+	public int getAnswer() {
+		return answer;
+	}
+
+}

java-feedback-rascal/test-data/ps-constructor-missing/Assignment 1/src/Student.java

+public class Student {
+    private int student_number;
+    private String first_name;
+    private String sur_name;
+
+    public Student (int student_number, String firstname, String surname){
+        this.student_number = student_number;
+        this.first_name = firstname;
+        this.sur_name = surname;
+    }
+
+    public int getStudent_number() {
+        return student_number;
+    }
+
+    public String getFirst_Name() {
+        return first_name;
+    }
+
+    public void setFirst_Name(String name) {
+        this.first_name = name;
+    }
+
+    public String getSur_name() {
+        return sur_name;
+    }
+
+    public void setSur_name(String sur_name) {
+        this.sur_name = sur_name;
+    }
+
+    @Override
+    public String toString(){
+        StringBuilder sb = new StringBuilder();
+        sb.append(first_name);
+        sb.append(" " + sur_name);
+        sb.append(", s" + student_number + "\n");
+
+        return sb.toString();
+    }
+}

java-feedback-rascal/test/CodingRulesSpec.rsc

@@ -74,4 +74,13 @@ test bool nonFinalPublicAttribute()
   return
     { "Only final attributes may be public" } <=
     { message | error(message,_) <- errors };
+}
+
+test bool constructorMissing()
+{
+  errors = ps_one_constructor_minimum(loadTestProject("ps-constructor-missing"));
+  return
+    size(errors) == 1 && // main class has no constructor, but that's okay
+    { "All classes should have at least one constructor" } <=
+    { message | error(message,_) <- errors };
 }
\ No newline at end of file