Merge pull request #2 from IronHeart7334/master

Release 2.5

Author: Matt-Crow

.gitignore

@@ -1,9 +1,11 @@
+# Ignored directories
 .gradle/
 .nb-gradle/
+
+# https://stackoverflow.com/questions/5533050/gitignore-exclude-folder-but-include-specific-subfolder
+/build/*
+!/build/libs/
+
+# Ignored files
 .nb-gradle-properties
-/build/classes/*
-/build/tmp/*
-/build/docs/*
-/build/distributions/*
-!/build/libs/*
 gradle.properties

README.md

@@ -1,5 +1,5 @@
 # AutoCAD Drawing Checker
-A simple, extendable Java program used to compare Excel exports from AutoCAD.
+A simple, extendable Java program used to compare Excel and CSV files
 
 ## Project Summary
 Instructors and teachers in college classes are expected to teach their students by giving lectures and providing learning resources.
@@ -10,6 +10,11 @@ Fortunately, computers are very good at doing tedious processes with objective s
 This program is meant to compare data exports from AutoCAD to each other, grading them based upon how similar they both are.
 These AutoCAD exports are in either XLS or XLSX format, which is easily parse-able by the Apache POI Library.
 
+This application also supports a wider variety of files, including:
+* any Excel file with headers in the first row
+* CSV data with or without headers
+* GPS survey data (see an example under src/main/resources/exports
+
 ## Required Software
 * Users need only ensure they have [Java](https://java.com/en/) installed on their computer to run the application.
 * Developers wishing to change this application for their own use will need [Gradle](https://gradle.org/) installed to build the application.
@@ -20,15 +25,19 @@ This file is a self-contained application, so you can move it wherever you want
 it doesn't rely on the other project files to run. Simply double-click the JAR file to run it.
 
 ### Steps
-* Step 1: Choosing instructor and student files. The first page of the application has you choose at least 2 files: 
+* Step 1: choose the file format. This tells the program the format of the data you will provide, and determines which criteria it can grade.
+* Step 2: Choosing instructor and student files. You will choose at least 2 files: 
 the instructor file, and 1 or more student files. The instructor file is what the student files will be graded on: 
 The more similar their file is to the instructor file, the higher their grade will be. When selecting student files, you have several options:
-    * Choose 1 or more Excel files
-    * Choose 1 or more folders. Note that the program locates all Excel files under this folder, so it's OK if it has other files in there, the program will just ignore them.
+    * Choose 1 or more Excel or CSV files
+    * Choose 1 or more folders. Note that the program locates all relevant files under this folder, so it's OK if it has other files in there, the program will just ignore them.
     * A combination of the above.
 Also of interest: you can drag and drop files into the two selectors instead of clicking the button.
-* Step 2: Choosing Grading Criteria. You can choose what the program grades students on by toggling these check boxes on or off. Regardless of what you select, the program will still grade every column in the instructor file.
-* Step 3: Running the Autograder. (Don't forget to click 'Run'!) Once the program is done grading, it will ask you where you want to save the grading report. Simply choose a folder, and the program will automatically name the file for you.
+* Step 3: Choosing Grading Criteria. You can choose what the program grades students on by toggling these check boxes on or off.
+* Step 4: Running the Autograder. The program will automatically run the grader when you get to the last page.
+Once the program is done grading, it will ask you where you want to save the grading report. 
+Simply choose a folder, and the program will automatically name the file for you.
+If you forget to save the file, just click "Run" to rerun the autograder.
 
 ### Troubleshooting
 If anything goes wrong, and you are unsure what to do about it, you'll want to click Log -> Save Log in the program menu bar along the top.
@@ -37,13 +46,14 @@ You can contact Matt if you need help, and you provide him with the Log file you
 ## Matt's To Do List
 * see AutoCADElementMatcher
 * Should we match rows for each comparison, or for the export as a whole? (wait on this)
-* Given double X and double Y, don't do "X == Y", instead do "Math.abs(X - Y) < threshold"
 * Look into Federal Section 508
     * https://www.epa.gov/accessibility/what-section-508
     * https://www.section508.gov/
     * https://www.section508.gov/create
     * https://www.access-board.gov/guidelines-and-standards/communications-and-it/about-the-ict-refresh/final-rule/text-of-the-standards-and-guidelines
-
+* maybe just add a check for AbstractGradingCriteria.canGradeDataType(...)
 
 ## Helpful Links
+* [Apache CLI](https://commons.apache.org/proper/commons-cli/javadocs/api-release/index.html)
+* [CSV Library](https://javadoc.io/doc/org.apache.commons/commons-csv/latest/index.html)
 * [Excel Library](https://poi.apache.org/apidocs/4.1/)

build.gradle

@@ -1,5 +1,15 @@
-apply plugin: 'java'
-apply plugin: 'application'
+plugins { // Double quotes evaluate some expressions a-la backticks in JS. Sounds like I should use single quotes by default
+    id 'java'
+    id 'application'
+}
+
+/*
+ * Needs this specific name to work with the application
+ * plugin. Change this property to set the main class for
+ * running and Jar-ing
+*/
+mainClassName = 'autocadDrawingChecker.start.Main'
+version = '2.5'
 
 sourceCompatibility = '1.8'
 [compileJava, compileTestJava]*.options*.encoding = 'UTF-8'
@@ -12,16 +22,16 @@ sourceCompatibility = '1.8'
 // prefer. In this case NetBeans will not add these tasks but you may rely on
 // your own implementation.
 if (!hasProperty('mainClass')) {
-    ext.mainClass = 'autocadDrawingChecker.start.Main'
+    ext.mainClass = mainClassName
 }
 
-mainClassName = 'autocadDrawingChecker.start.Main' // need this for the application plugin
-
 jar {
     //need to manually set main class, otherwise, it just compiles the JAR as a library
     manifest {
         attributes(
-            'Main-Class': 'autocadDrawingChecker.start.Main'
+            'Main-Class': mainClassName,
+            'Implementation-Title': project.name,
+            'Implementation-Version': project.version
         )
     }
 
@@ -39,6 +49,10 @@ jar {
     exclude 'META-INF/*.RSA', 'META-INF/*.SF','META-INF/*.DSA' 
 }
 
+tasks.withType(JavaCompile) {
+    options.compilerArgs << '-Xlint:unchecked'
+}
+
 repositories {
     mavenCentral()
     // You may define additional repositories, or even remove "mavenCentral()".
@@ -52,6 +66,11 @@ dependencies {
     //   http://www.gradle.org/docs/current/userguide/dependency_management.html#sec:how_to_declare_your_dependencies
     testCompile group: 'junit', name: 'junit', version: '4.10'
 
+    compile group: 'commons-cli', name: 'commons-cli', version: '1.4'
+    
+    // https://mvnrepository.com/artifact/org.apache.commons/commons-csv
+    compile group: 'org.apache.commons', name: 'commons-csv', version: '1.8'
+    
     // https://mvnrepository.com/artifact/org.apache.poi/poi
     compile group: 'org.apache.poi', name: 'poi', version: '4.1.2'