Skip to content

Commit 0cae47d

Browse files
authored
Merge pull request #1 from IronHeart7334/master
Ready for Testing
2 parents bdb22bc + 7352730 commit 0cae47d

File tree

69 files changed

+1706
-1198
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+1706
-1198
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
.gradle/
22
.nb-gradle/
3+
.nb-gradle-properties
34
/build/classes/*
45
/build/tmp/*
6+
/build/docs/*
7+
/build/distributions/*
58
!/build/libs/*
69
gradle.properties

LICENSE.txt

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 Matt Crow
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,49 @@
1-
# AutoCADDrawingChecker
2-
A simple, extendable Java program used to compare vector exports from AutoCAD.
1+
# AutoCAD Drawing Checker
2+
A simple, extendable Java program used to compare Excel exports from AutoCAD.
33

44
## Project Summary
5+
Instructors and teachers in college classes are expected to teach their students by giving lectures and providing learning resources.
6+
One of the most common elements of college classes is the use of homework to practice the concepts taught in class.
7+
Of course, homework can be tedious and time consuming for the instructor to grade, and is an inefficient process when a single objective solution exists for any given problem.
8+
Fortunately, computers are very good at doing tedious processes with objective solutions.
9+
10+
This program is meant to compare data exports from AutoCAD to each other, grading them based upon how similar they both are.
11+
These AutoCAD exports are in either XLS or XLSX format, which is easily parse-able by the Apache POI Library.
12+
13+
## Required Software
14+
* Users need only ensure they have [Java](https://java.com/en/) installed on their computer to run the application.
15+
* Developers wishing to change this application for their own use will need [Gradle](https://gradle.org/) installed to build the application.
516

617
## How to Use the Application
718
The application is stored in the JAR file under ```/build/libs/AutoCADDrawingChecker.jar```.
819
This file is a self-contained application, so you can move it wherever you want on your computer:
920
it doesn't rely on the other project files to run. Simply double-click the JAR file to run it.
21+
1022
### Steps
1123
* Step 1: Choosing instructor and student files. The first page of the application has you choose at least 2 files:
1224
the instructor file, and 1 or more student files. The instructor file is what the student files will be graded on:
1325
The more similar their file is to the instructor file, the higher their grade will be. When selecting student files, you have several options:
1426
* Choose 1 or more Excel files
1527
* 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.
1628
* A combination of the above.
17-
* Step 2: Choosing Grading Criteria. You can choose what the program grades students on by toggling these check boxes on or off.
18-
* Step 3: Running the Autograder. Once the program is done grading, it will ask you where you want to save the grading report.
19-
The program automatically adds an xlsx extension if you don't provide one, so no need to worry about that.
29+
Also of interest: you can drag and drop files into the two selectors instead of clicking the button.
30+
* 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.
31+
* 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.
2032

21-
## To Do
22-
* Make AutoCADExcelParser easier to work with and extend.
23-
Maybe have an ElementLoader which checks if it has an element type for each element name
33+
### Troubleshooting
34+
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.
35+
You can contact Matt if you need help, and you provide him with the Log file you just created: This will help him figure out what went wrong.
36+
37+
## Matt's To Do List
2438
* see AutoCADElementMatcher
25-
* Should we match rows for each comparison, or for the export as a whole?
39+
* Should we match rows for each comparison, or for the export as a whole? (wait on this)
40+
* Given double X and double Y, don't do "X == Y", instead do "Math.abs(X - Y) < threshold"
41+
* Look into Federal Section 508
42+
* https://www.epa.gov/accessibility/what-section-508
43+
* https://www.section508.gov/
44+
* https://www.section508.gov/create
45+
* https://www.access-board.gov/guidelines-and-standards/communications-and-it/about-the-ict-refresh/final-rule/text-of-the-standards-and-guidelines
46+
2647

2748
## Helpful Links
2849
* [Excel Library](https://poi.apache.org/apidocs/4.1/)

build.gradle

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
apply plugin: 'java'
2+
apply plugin: 'application'
23

34
sourceCompatibility = '1.8'
45
[compileJava, compileTestJava]*.options*.encoding = 'UTF-8'
@@ -14,6 +15,8 @@ if (!hasProperty('mainClass')) {
1415
ext.mainClass = 'autocadDrawingChecker.start.Main'
1516
}
1617

18+
mainClassName = 'autocadDrawingChecker.start.Main' // need this for the application plugin
19+
1720
jar {
1821
//need to manually set main class, otherwise, it just compiles the JAR as a library
1922
manifest {
1.47 KB
Binary file not shown.
Lines changed: 188 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
1+
#!/usr/bin/env sh
2+
3+
#
4+
# Copyright 2015 the original author or authors.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# https://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#
18+
19+
##############################################################################
20+
##
21+
## AutoCADDrawingChecker start up script for UN*X
22+
##
23+
##############################################################################
24+
25+
# Attempt to set APP_HOME
26+
# Resolve links: $0 may be a link
27+
PRG="$0"
28+
# Need this for relative symlinks.
29+
while [ -h "$PRG" ] ; do
30+
ls=`ls -ld "$PRG"`
31+
link=`expr "$ls" : '.*-> \(.*\)$'`
32+
if expr "$link" : '/.*' > /dev/null; then
33+
PRG="$link"
34+
else
35+
PRG=`dirname "$PRG"`"/$link"
36+
fi
37+
done
38+
SAVED="`pwd`"
39+
cd "`dirname \"$PRG\"`/.." >/dev/null
40+
APP_HOME="`pwd -P`"
41+
cd "$SAVED" >/dev/null
42+
43+
APP_NAME="AutoCADDrawingChecker"
44+
APP_BASE_NAME=`basename "$0"`
45+
46+
# Add default JVM options here. You can also use JAVA_OPTS and AUTO_CAD_DRAWING_CHECKER_OPTS to pass JVM options to this script.
47+
DEFAULT_JVM_OPTS=""
48+
49+
# Use the maximum available, or set MAX_FD != -1 to use that value.
50+
MAX_FD="maximum"
51+
52+
warn () {
53+
echo "$*"
54+
}
55+
56+
die () {
57+
echo
58+
echo "$*"
59+
echo
60+
exit 1
61+
}
62+
63+
# OS specific support (must be 'true' or 'false').
64+
cygwin=false
65+
msys=false
66+
darwin=false
67+
nonstop=false
68+
case "`uname`" in
69+
CYGWIN* )
70+
cygwin=true
71+
;;
72+
Darwin* )
73+
darwin=true
74+
;;
75+
MINGW* )
76+
msys=true
77+
;;
78+
NONSTOP* )
79+
nonstop=true
80+
;;
81+
esac
82+
83+
CLASSPATH=$APP_HOME/lib/AutoCADDrawingChecker.jar:$APP_HOME/lib/poi-ooxml-4.1.2.jar:$APP_HOME/lib/poi-4.1.2.jar:$APP_HOME/lib/commons-codec-1.13.jar:$APP_HOME/lib/commons-collections4-4.4.jar:$APP_HOME/lib/commons-math3-3.6.1.jar:$APP_HOME/lib/SparseBitSet-1.2.jar:$APP_HOME/lib/poi-ooxml-schemas-4.1.2.jar:$APP_HOME/lib/commons-compress-1.19.jar:$APP_HOME/lib/curvesapi-1.06.jar:$APP_HOME/lib/xmlbeans-3.1.0.jar
84+
85+
# Determine the Java command to use to start the JVM.
86+
if [ -n "$JAVA_HOME" ] ; then
87+
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
88+
# IBM's JDK on AIX uses strange locations for the executables
89+
JAVACMD="$JAVA_HOME/jre/sh/java"
90+
else
91+
JAVACMD="$JAVA_HOME/bin/java"
92+
fi
93+
if [ ! -x "$JAVACMD" ] ; then
94+
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
95+
96+
Please set the JAVA_HOME variable in your environment to match the
97+
location of your Java installation."
98+
fi
99+
else
100+
JAVACMD="java"
101+
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
102+
103+
Please set the JAVA_HOME variable in your environment to match the
104+
location of your Java installation."
105+
fi
106+
107+
# Increase the maximum file descriptors if we can.
108+
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
109+
MAX_FD_LIMIT=`ulimit -H -n`
110+
if [ $? -eq 0 ] ; then
111+
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
112+
MAX_FD="$MAX_FD_LIMIT"
113+
fi
114+
ulimit -n $MAX_FD
115+
if [ $? -ne 0 ] ; then
116+
warn "Could not set maximum file descriptor limit: $MAX_FD"
117+
fi
118+
else
119+
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
120+
fi
121+
fi
122+
123+
# For Darwin, add options to specify how the application appears in the dock
124+
if $darwin; then
125+
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
126+
fi
127+
128+
# For Cygwin or MSYS, switch paths to Windows format before running java
129+
if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
130+
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
131+
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
132+
JAVACMD=`cygpath --unix "$JAVACMD"`
133+
134+
# We build the pattern for arguments to be converted via cygpath
135+
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
136+
SEP=""
137+
for dir in $ROOTDIRSRAW ; do
138+
ROOTDIRS="$ROOTDIRS$SEP$dir"
139+
SEP="|"
140+
done
141+
OURCYGPATTERN="(^($ROOTDIRS))"
142+
# Add a user-defined pattern to the cygpath arguments
143+
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
144+
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
145+
fi
146+
# Now convert the arguments - kludge to limit ourselves to /bin/sh
147+
i=0
148+
for arg in "$@" ; do
149+
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
150+
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
151+
152+
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
153+
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
154+
else
155+
eval `echo args$i`="\"$arg\""
156+
fi
157+
i=$((i+1))
158+
done
159+
case $i in
160+
(0) set -- ;;
161+
(1) set -- "$args0" ;;
162+
(2) set -- "$args0" "$args1" ;;
163+
(3) set -- "$args0" "$args1" "$args2" ;;
164+
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
165+
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
166+
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
167+
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
168+
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
169+
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
170+
esac
171+
fi
172+
173+
# Escape application args
174+
save () {
175+
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
176+
echo " "
177+
}
178+
APP_ARGS=$(save "$@")
179+
180+
# Collect all arguments for the java command, following the shell quoting and substitution rules
181+
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $AUTO_CAD_DRAWING_CHECKER_OPTS -classpath "\"$CLASSPATH\"" autocadDrawingChecker.start.Main "$APP_ARGS"
182+
183+
# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
184+
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
185+
cd "$(dirname "$0")"
186+
fi
187+
188+
exec "$JAVACMD" "$@"
Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
@rem
2+
@rem Copyright 2015 the original author or authors.
3+
@rem
4+
@rem Licensed under the Apache License, Version 2.0 (the "License");
5+
@rem you may not use this file except in compliance with the License.
6+
@rem You may obtain a copy of the License at
7+
@rem
8+
@rem https://www.apache.org/licenses/LICENSE-2.0
9+
@rem
10+
@rem Unless required by applicable law or agreed to in writing, software
11+
@rem distributed under the License is distributed on an "AS IS" BASIS,
12+
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
@rem See the License for the specific language governing permissions and
14+
@rem limitations under the License.
15+
@rem
16+
17+
@if "%DEBUG%" == "" @echo off
18+
@rem ##########################################################################
19+
@rem
20+
@rem AutoCADDrawingChecker startup script for Windows
21+
@rem
22+
@rem ##########################################################################
23+
24+
@rem Set local scope for the variables with windows NT shell
25+
if "%OS%"=="Windows_NT" setlocal
26+
27+
set DIRNAME=%~dp0
28+
if "%DIRNAME%" == "" set DIRNAME=.
29+
set APP_BASE_NAME=%~n0
30+
set APP_HOME=%DIRNAME%..
31+
32+
@rem Add default JVM options here. You can also use JAVA_OPTS and AUTO_CAD_DRAWING_CHECKER_OPTS to pass JVM options to this script.
33+
set DEFAULT_JVM_OPTS=
34+
35+
@rem Find java.exe
36+
if defined JAVA_HOME goto findJavaFromJavaHome
37+
38+
set JAVA_EXE=java.exe
39+
%JAVA_EXE% -version >NUL 2>&1
40+
if "%ERRORLEVEL%" == "0" goto init
41+
42+
echo.
43+
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
44+
echo.
45+
echo Please set the JAVA_HOME variable in your environment to match the
46+
echo location of your Java installation.
47+
48+
goto fail
49+
50+
:findJavaFromJavaHome
51+
set JAVA_HOME=%JAVA_HOME:"=%
52+
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
53+
54+
if exist "%JAVA_EXE%" goto init
55+
56+
echo.
57+
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
58+
echo.
59+
echo Please set the JAVA_HOME variable in your environment to match the
60+
echo location of your Java installation.
61+
62+
goto fail
63+
64+
:init
65+
@rem Get command-line arguments, handling Windows variants
66+
67+
if not "%OS%" == "Windows_NT" goto win9xME_args
68+
69+
:win9xME_args
70+
@rem Slurp the command line arguments.
71+
set CMD_LINE_ARGS=
72+
set _SKIP=2
73+
74+
:win9xME_args_slurp
75+
if "x%~1" == "x" goto execute
76+
77+
set CMD_LINE_ARGS=%*
78+
79+
:execute
80+
@rem Setup the command line
81+
82+
set CLASSPATH=%APP_HOME%\lib\AutoCADDrawingChecker.jar;%APP_HOME%\lib\poi-ooxml-4.1.2.jar;%APP_HOME%\lib\poi-4.1.2.jar;%APP_HOME%\lib\commons-codec-1.13.jar;%APP_HOME%\lib\commons-collections4-4.4.jar;%APP_HOME%\lib\commons-math3-3.6.1.jar;%APP_HOME%\lib\SparseBitSet-1.2.jar;%APP_HOME%\lib\poi-ooxml-schemas-4.1.2.jar;%APP_HOME%\lib\commons-compress-1.19.jar;%APP_HOME%\lib\curvesapi-1.06.jar;%APP_HOME%\lib\xmlbeans-3.1.0.jar
83+
84+
@rem Execute AutoCADDrawingChecker
85+
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %AUTO_CAD_DRAWING_CHECKER_OPTS% -classpath "%CLASSPATH%" autocadDrawingChecker.start.Main %CMD_LINE_ARGS%
86+
87+
:end
88+
@rem End local scope for the variables with windows NT shell
89+
if "%ERRORLEVEL%"=="0" goto mainEnd
90+
91+
:fail
92+
rem Set variable AUTO_CAD_DRAWING_CHECKER_EXIT_CONSOLE if you need the _script_ return code instead of
93+
rem the _cmd.exe /c_ return code!
94+
if not "" == "%AUTO_CAD_DRAWING_CHECKER_EXIT_CONSOLE%" exit 1
95+
exit /b 1
96+
97+
:mainEnd
98+
if "%OS%"=="Windows_NT" endlocal
99+
100+
:omega

0 commit comments

Comments
 (0)