reviser 0.0.3.rc2 → 0.0.3

data/lib/reviser/components/extractors.rb

@@ -1,3 +1,24 @@
+#
+#   Reviser => a semi-automatic tool for student's projects evaluation
+#
+#   Copyright (C) 2015 Renan Strauss
+#   Copyright (C) 2015 Yann Prono
+#   Copyright (C) 2015 Romain Ruez
+#   Copyright (C) 2015 Anthony Cerf
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
 require 'rubygems'
 require 'fileutils'
 

data/lib/reviser/components/generator.rb

@@ -1,5 +1,25 @@
+#
+#   Reviser => a semi-automatic tool for student's projects evaluation
+#
+#   Copyright (C) 2015 Renan Strauss
+#   Copyright (C) 2015 Yann Prono
+#   Copyright (C) 2015 Romain Ruez
+#   Copyright (C) 2015 Anthony Cerf
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
 require_relative 'generators'
-
 require_relative '../result'
 
 module Reviser

data/lib/reviser/components/generators.rb

@@ -1,3 +1,24 @@
+#
+#   Reviser => a semi-automatic tool for student's projects evaluation
+#
+#   Copyright (C) 2015 Renan Strauss
+#   Copyright (C) 2015 Yann Prono
+#   Copyright (C) 2015 Romain Ruez
+#   Copyright (C) 2015 Anthony Cerf
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
 module Reviser
 	module Components
 

data/lib/reviser/components/organiser.rb

@@ -1,3 +1,24 @@
+#
+#   Reviser => a semi-automatic tool for student's projects evaluation
+#
+#   Copyright (C) 2015 Renan Strauss
+#   Copyright (C) 2015 Yann Prono
+#   Copyright (C) 2015 Romain Ruez
+#   Copyright (C) 2015 Anthony Cerf
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
 require 'fileutils'
 require 'rubygems'
 
@@ -91,12 +112,13 @@ module Reviser
 				
 				# Loop to find the core of project
 				#
-				# Basically running through
-				# each level of directories
-				# while there are only directories
-				# in the current directory
+				# Basically running through each level of directories
+				# while there is only one directory in the current directory.
+				# Sometimes needed when archives have a sub-folder with their name.
+				# In case the student created multiple nested folders, we don't
+				# do anything.
 				#
-				while all == directories
+				while all == directories && directories.size == 1
 					level += 1
 					@logger.h2 Logger::DEBUG, "Level += 1\nPath = #{@path}"
 					chdir directories.first

data/lib/reviser/config.rb

@@ -1,3 +1,26 @@
+#
+#   Reviser => a semi-automatic tool for student's projects evaluation
+#
+#   Copyright (C) 2015 Renan Strauss
+#   Copyright (C) 2015 Yann Prono
+#   Copyright (C) 2015 Romain Ruez
+#   Copyright (C) 2015 Anthony Cerf
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+require 'yaml'
+
 #
 # Externalises the configuration
 # Cfg acts like a hash whose entries are config keys
@@ -5,8 +28,6 @@
 #
 # @author Renan Strauss
 #
-require 'yaml'
-
 module Reviser
 	class Cfg
 		# Path for specialized config files for projects

data/lib/reviser/criteria/code_analysis.rb

@@ -1,14 +1,38 @@
 #
-# @author Renan Strauss
+#   Reviser => a semi-automatic tool for student's projects evaluation
+#
+#   Copyright (C) 2015 Renan Strauss
+#   Copyright (C) 2015 Yann Prono
+#   Copyright (C) 2015 Romain Ruez
+#   Copyright (C) 2015 Anthony Cerf
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
 #
-# Basic stuff needed for Checker
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
+#
+# @author Renan Strauss
+#
+# Basic criteria
+#
 module Reviser
 	module Criteria
 		module CodeAnalysis
 			include Helpers::Project
 
+			#
+			# @return project's directory contents
+			#
 			def all_files
 				files.join("\r")
 			end

data/lib/reviser/criteria/compilation.rb

@@ -1,3 +1,25 @@
+#
+#   Reviser => a semi-automatic tool for student's projects evaluation
+#
+#   Copyright (C) 2015 Renan Strauss
+#   Copyright (C) 2015 Yann Prono
+#   Copyright (C) 2015 Romain Ruez
+#   Copyright (C) 2015 Anthony Cerf
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
 #
 # @author Yann Prono
 # @author Renan Strauss
@@ -5,7 +27,6 @@
 # Needed stuff for compiled languages
 # such as C, Java, and so on.
 #
-
 module Reviser
 	module Criteria
 		module Compilation

data/lib/reviser/criteria/execution.rb

@@ -1,3 +1,26 @@
+#
+#   Reviser => a semi-automatic tool for student's projects evaluation
+#
+#   Copyright (C) 2015 Renan Strauss
+#   Copyright (C) 2015 Yann Prono
+#   Copyright (C) 2015 Romain Ruez
+#   Copyright (C) 2015 Anthony Cerf
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+require 'timeout'
+
 #
 # @author Renan Strauss
 #
@@ -6,9 +29,6 @@
 # both compiled and interpreted
 # languages
 #
-
-require 'timeout'
-
 module Reviser
 	module Criteria
 		module Execution

data/lib/reviser/helpers/criteria.rb

@@ -1,5 +1,28 @@
-# Manage criteria and labels.
+#
+#   Reviser => a semi-automatic tool for student's projects evaluation
+#
+#   Copyright (C) 2015 Renan Strauss
+#   Copyright (C) 2015 Yann Prono
+#   Copyright (C) 2015 Romain Ruez
+#   Copyright (C) 2015 Anthony Cerf
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
 
+#
+# Manage criteria and labels.
+#
 # @example Call a criterion (in the config File):
 #   criteria:
 #     - :count_lines: Number of lines

data/lib/reviser/helpers/git.rb

@@ -1,3 +1,25 @@
+#
+#   Reviser => a semi-automatic tool for student's projects evaluation
+#
+#   Copyright (C) 2015 Renan Strauss
+#   Copyright (C) 2015 Yann Prono
+#   Copyright (C) 2015 Romain Ruez
+#   Copyright (C) 2015 Anthony Cerf
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
 # Class which organizes all directories for use them with git.
 # Its another component of the project
 #

data/lib/reviser/helpers/project.rb

@@ -1,12 +1,33 @@
 #
-# Provide important methods
-# for compilation or something like that.
+#   Reviser => a semi-automatic tool for student's projects evaluation
 #
-# @author Renan Strauss
-# @author Yann Prono
+#   Copyright (C) 2015 Renan Strauss
+#   Copyright (C) 2015 Yann Prono
+#   Copyright (C) 2015 Romain Ruez
+#   Copyright (C) 2015 Anthony Cerf
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 require_relative '../result'
 
+#
+# Provide useful methods for projects evaluation
+# as well as a naming module for custom regexes
+#
+# @author Renan Strauss
+# @author Yann Prono
+#
 module Reviser
 	module Helpers
 		module Project

data/lib/reviser/helpers/system.rb

@@ -1,11 +1,33 @@
 #
-# Wraps methods for system calls
-# (external programs execution)
-# @author Renan Strauss
+#   Reviser => a semi-automatic tool for student's projects evaluation
+#
+#   Copyright (C) 2015 Renan Strauss
+#   Copyright (C) 2015 Yann Prono
+#   Copyright (C) 2015 Romain Ruez
+#   Copyright (C) 2015 Anthony Cerf
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 require 'open3'
 require 'timeout'
 
+
+#
+# Wraps methods for system calls
+# (external programs execution)
+# @author Renan Strauss
+#
 module Reviser
 	module Helpers
 		module System

data/lib/reviser/loggers/logger.rb

@@ -1,3 +1,24 @@
+#
+#   Reviser => a semi-automatic tool for student's projects evaluation
+#
+#   Copyright (C) 2015 Renan Strauss
+#   Copyright (C) 2015 Yann Prono
+#   Copyright (C) 2015 Romain Ruez
+#   Copyright (C) 2015 Anthony Cerf
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
 require 'logger'
 require_relative 'modes'
 

data/lib/reviser/loggers/modes.rb

@@ -1,3 +1,24 @@
+#
+#   Reviser => a semi-automatic tool for student's projects evaluation
+#
+#   Copyright (C) 2015 Renan Strauss
+#   Copyright (C) 2015 Yann Prono
+#   Copyright (C) 2015 Romain Ruez
+#   Copyright (C) 2015 Anthony Cerf
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
 require 'logger'
 
 module Reviser