Preparing for release 20170215215

Author: Leonardo Canessa

CHANGES.md

@@ -0,0 +1,39 @@
+#CHANGELOG
+
+## 20170215
+* Change in versioning to date based
+* Performance improvements
+  * Attendance Stats are now stored in the DB, in order to avoid having
+    to consistently calculate the statistics.
+    As such a job, __Attendance Stat Calc - SEE DOCS__, was created which will
+    calculate the stats and store them in the DB. Afterwards statistics will be
+    updated on the save of any record.
+    This job __must manually__ be run once after applying this update to calculate
+    statuses for older sites.
+    Afterwards, the job should be set up to run periodically at a user defined interval.
+    The job is necessary to run if you want stats to to be correct in case of users
+    no longer being present in the site.
+  * Records are now created only when needed (prior to saving a status)
+* Attendance Items are now added / edited via a modal window
+* Attendance Records now have improved styling and formating
+  * Statuses are now color coded
+  * Record input panel is now more responsive and will go vertical with labels
+  when the screen width is <800px.
+* Added new auto grading feature
+  * Allows for the ability to award points based on statuses (or have students lose
+  points)
+  For example: Present: 1-5 times, 1 point; Present: 6-10 times, 1 point.
+  * Based on user defined rules. NOTE: The rules are not validated (so they may overlap
+  or count twice if ill-defined).
+  * Have the ability to override an auto grade
+  * Grading occurs on each status update, as well as whenever the grading settings are
+  saved
+* Styling improvements
+* Bugfixes
+  * Sequence for ATTENDANCE\_GRADE\_T set correctly.
+  Oracle users should run the PSQL defined at the bottom of the 
+  [docs/sql/attendance-20170215-oracle.sql](attendance-20170215-oracle.sql) file.
+  * Minor fixes
+
+## 1.0
+* Initial Release

README.md

@@ -1,17 +1,23 @@
 # Attendance
 A simple [Sakai](https://github.com/sakaiproject/sakai) tool for tracking attendance that integrates with the Gradebook.
 
+## Performance Improvements - MUST READ
+With the release of 20170215, statistics are now stored in a table. As such, a job was created to calculate these stats.
+This job should be run once after the deployment of 201701; afterwards it may be run as needed or at regular interval
+as determined by the administrators. The job is only needed to be run to sync up the stats to the current roster (in
+the case of users attending an item and then later leaving the site). This job is titled "Attendance Stat Calc - SEE DOCS".
+
 ## Resources
 Pages: http://udayton.github.io/attendance/
 
 Presentation:
 http://prezi.com/m3dvmxokf8as/ - Delivered at Apereo 16.
 
 ## Compatibility
-Version 1.0 of Attendance is compatible with Sakai 11. Though, there are some UI changes which are still necessary. 
+Version 1.0+ of Attendance is compatible with Sakai 11. Though, there are some UI changes which are still necessary. 
 
 The Sakai property auto.ddl should be set to true when first starting this tool with Sakai.
-If not, queries for MySQL and Oracle can be found in [docs/sql/](docs/sql/)
+If not, queries for MySQL and Oracle can be found in [docs/sql/](docs/sql/), though use at your own risk.
 
 ## Contact
 If you have any questions please contact the LMS devs at the University of Dayton at lms-devs@udayton.edu.

api/pom.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-  ~  Copyright (c) 2016, University of Dayton
+  ~  Copyright (c) 2017, University of Dayton
   ~
   ~  Licensed under the Educational Community License, Version 2.0 (the "License");
   ~  you may not use this file except in compliance with the License.
@@ -20,7 +20,7 @@
 	<parent>
     <artifactId>attendance</artifactId>
     <groupId>org.sakaiproject.attendance</groupId>
-    <version>1.0</version>
+    <version>20170215</version>
   </parent>
 
 	<name>attendance - API</name>

api/src/java/org/sakaiproject/attendance/api/AttendanceGradebookProvider.java

@@ -1,5 +1,5 @@
 /*
- *  Copyright (c) 2016, University of Dayton
+ *  Copyright (c) 2017, University of Dayton
  *
  *  Licensed under the Educational Community License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.

api/src/java/org/sakaiproject/attendance/cache/CacheManager.java

@@ -1,5 +1,5 @@
 /*
- *  Copyright (c) 2016, University of Dayton
+ *  Copyright (c) 2017, University of Dayton
  *
  *  Licensed under the Educational Community License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.

api/src/java/org/sakaiproject/attendance/export/PDFEventExporter.java

@@ -1,5 +1,5 @@
 /*
- *  Copyright (c) 2016, University of Dayton
+ *  Copyright (c) 2017, University of Dayton
  *
  *  Licensed under the Educational Community License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.

api/src/java/org/sakaiproject/attendance/hbm/AttendanceEvent.hbm.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <!--
-  ~  Copyright (c) 2016, University of Dayton
+  ~  Copyright (c) 2017, University of Dayton
   ~
   ~  Licensed under the Educational Community License, Version 2.0 (the "License");
   ~  you may not use this file except in compliance with the License.

api/src/java/org/sakaiproject/attendance/hbm/AttendanceGrade.hbm.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <!--
-  ~  Copyright (c) 2016, University of Dayton
+  ~  Copyright (c) 2017, University of Dayton
   ~
   ~  Licensed under the Educational Community License, Version 2.0 (the "License");
   ~  you may not use this file except in compliance with the License.

api/src/java/org/sakaiproject/attendance/hbm/AttendanceItemStats.hbm.xml

@@ -1,20 +1,18 @@
 <?xml version="1.0"?>
 <!--
-  ~ /**
-  ~  * Copyright (c) 2016, University of Dayton
-  ~  *
-  ~  * Licensed under the Educational Community License, Version 2.0 (the "License");
-  ~  * you may not use this file except in compliance with the License.
-  ~  * You may obtain a copy of the License at
-  ~  *
-  ~  *             http://opensource.org/licenses/ecl2
-  ~  *
-  ~  * Unless required by applicable law or agreed to in writing, software
-  ~  * distributed under the License is distributed on an "AS IS" BASIS,
-  ~  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-  ~  * See the License for the specific language governing permissions and
-  ~  * limitations under the License.
-  ~  */
+  ~  Copyright (c) 2017, University of Dayton
+  ~
+  ~  Licensed under the Educational Community License, Version 2.0 (the "License");
+  ~  you may not use this file except in compliance with the License.
+  ~  You may obtain a copy of the License at
+  ~
+  ~              http://opensource.org/licenses/ecl2
+  ~
+  ~  Unless required by applicable law or agreed to in writing, software
+  ~  distributed under the License is distributed on an "AS IS" BASIS,
+  ~  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~  See the License for the specific language governing permissions and
+  ~  limitations under the License.
   -->
 
 <!DOCTYPE hibernate-mapping

api/src/java/org/sakaiproject/attendance/hbm/AttendanceRecord.hbm.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <!--
-  ~  Copyright (c) 2016, University of Dayton
+  ~  Copyright (c) 2017, University of Dayton
   ~
   ~  Licensed under the Educational Community License, Version 2.0 (the "License");
   ~  you may not use this file except in compliance with the License.