reviser 0.0.3.rc2 → 0.0.3

data/config.yml

@@ -1,7 +1,27 @@
----
+#
+#   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/>.
+#
 
 ################################################
-# 	           Config file   	       #
+# 	           Template config file   	       #
 ################################################
 
 
@@ -41,10 +61,6 @@ out_format:
 # The type of project (<type>.yml must exists)
 type: example/Labyrinthe
 
-# Default timeout
-# shall be overriden in sorts
-timeout: 5
-
 
 ########	Global config		########
 
@@ -67,7 +83,7 @@ extensions:
 
 # Whether to create a git repository for each project
 # relies on 'git' gem
-create_git_repo: true
+# create_git_repo: true
 
 # Options of all components
 # For the moment, there is just verbose option (for logger)

data/ext/valgrind.rb

@@ -1,3 +1,28 @@
+#
+#   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
+#
 module Reviser
 	module Extensions
 		module Valgrind

data/ext/web_validators.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 Renan Strauss
 #
@@ -7,7 +29,6 @@
 # It's very simple at that point, but feel free to
 # make the extension better :-)
 #
-
 module Reviser
 	module Extensions
 		module WebValidators
@@ -18,9 +39,6 @@ module Reviser
 			# if any
 			#
 			def validate_web
-				#
-				# TODO : explain the exception to the user
-				#
 				unless defined? W3CValidators
 					require_gem 'w3c_validators'
 
@@ -60,7 +78,7 @@ module Reviser
 				files = sources.select { |s| File.extname(s) == ".#{lang}" }
 				files.each do |f|
 					begin
-						response = validator.validate_file(File.new(f))
+						response = validator.validate_file(File.new(f, :encoding => 'utf-8'))
 						results[f] = {
 							:valid => response.errors.length == 0,
 							:errors => response.errors.length
@@ -68,9 +86,9 @@ module Reviser
 
 						print "="
 					rescue W3CValidators::ValidatorUnavailable => e
-						results[f] = e.message
+						results[f] = { valid: e.message, errors: 1 }
 					rescue Exception => e
-						results[f] = e.message
+						results[f] = { valid: e.message, errors: 1 }
 					end
 				end
 				puts "]"
@@ -79,21 +97,13 @@ module Reviser
 			end
 
 			def prettify results
-				return results unless results.values.first
-
-				headings = results.values.first.keys
-
 				html = '<table><tr><th>File</th>'
-				headings.each { |heading| html << "<th>#{heading.to_s.capitalize!}</th>" }
+				results.values.first.keys.each { |heading| html << "<th>#{heading.to_s.capitalize!}</th>" }
 				html << '</tr>'
 
 				results.each do |file, data|
 					html << "<tr><th>#{file}</th>"
-					if data.is_a?(Hash)
-						data.values.each { |value| html << "<td>#{value}</td>" }
-					else
-						html << "<td>#{data}</td>"
-					end
+					data.values.each { |value| html << "<td>#{value}</td>" }
 					html << '</tr>'
 				end
 				html << '</table>'

data/lang/C.yml

@@ -1,5 +1,28 @@
----
+#
+#   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/>.
+#
+
+#
 # C language
+#
 
 # List of source files extensions
 extension:

data/lang/HTML.yml

@@ -1,6 +1,28 @@
----
+#
+#   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/>.
+#
 
+#
 # HTML language
+#
 
 # List of source files extensions
 # !!!!! Recent changes make me think

data/lang/Java.yml

@@ -1,5 +1,28 @@
----
+#
+#   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/>.
+#
+
+#
 # Java language
+#
 
 # List of source files extensions
 extension:

data/lang/Ruby.yml

@@ -1,5 +1,28 @@
----
+#
+#   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/>.
+#
+
+#
 # Ruby language
+#
 
 # List of source files extensions
 extension:

data/lib/exec.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 'thor'
 require 'fileutils'
 require 'colorize'
@@ -15,7 +36,7 @@ require_relative 'reviser/helpers/criteria'
 module Reviser
 	class Exec < Thor
 
-		VERSION = '0.0.3.rc1'
+		VERSION = '0.0.3'
 
 		map '--version' => :version
 		map '-v' => :version
@@ -132,8 +153,7 @@ module Reviser
 
 		desc 'version', 'Print out version information'
 		def version
-			puts "Reviser #{VERSION}"
-			puts 'Released under the GPLv3 License.'
+			puts "Reviser".yellow + " " + "#{VERSION}".light_red + " Copyright (C) 2015  Renan Strauss, Yann Prono, Anthony Cerf, Romain Ruez"
 		end
 
 

data/lib/reviser.rb

@@ -1,12 +1,23 @@
 #
-# @author Renan Strauss
+#   Reviser => a semi-automatic tool for student's projects evaluation
 #
-# This class is basically here to give the user
-# a generic and comprehensive way to use and
-# customize the behavior of our tool.
-# The main idea is that the user should not
-# instantiate components himself, nor worry
-# about the data these components exchange.
+#   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 'mkmf'
 require 'colorize'
@@ -32,7 +43,15 @@ def require_gem gem_name
 end
 
 #
-# The API entry point
+# @author Renan Strauss
+#
+# This class is basically here to give the user
+# a generic and comprehensive way to use and
+# customize the behavior of our tool.
+# The main idea is that the user should not
+# instantiate components himself, nor worry
+# about the data these components exchange.
+# It is the API entry point.
 #
 module Reviser
 	class Reviser

data/lib/reviser/component.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_relative 'loggers/logger'
+
 #
 # The abstract class Component
 # Even though Ruby doesn't have abstract classes,
@@ -6,8 +29,6 @@
 #
 # @author Renan Strauss
 #
-require_relative 'loggers/logger'
-
 module Reviser
 	class Component
 		#

data/lib/reviser/components/archiver.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_relative 'extractors'
 

data/lib/reviser/components/checker.rb

@@ -1,17 +1,38 @@
 #
-# @author Renan Strauss
+#   Reviser => a semi-automatic tool for student's projects evaluation
 #
-# The Checker is a component that wraps
-# all required tools to do the analysis.
-# It adapts itself dynamically
-# to the configuration
+#   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_relative '../result'
 require_relative '../helpers/criteria'
 
+#
+# @author Renan Strauss
+#
+# The Checker is a component that wraps
+# all required tools to do the analysis.
+# It adapts itself dynamically
+# to the configuration
+#
+#
 module Reviser
 	module Components
 		class Checker < Component