reviser 0.0.1.1.pre.beta → 0.0.2.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ad369beae7c279013559eaca2a371be84de43a0
-  data.tar.gz: d08c27df554743428484267bf53872053bf75fb0
+  metadata.gz: eb2455e95c3f150c2af8cb0e01b481ce485bb948
+  data.tar.gz: 12663cbeb09dadc6df0f608da12dc4fd28bdb1e4
 SHA512:
-  metadata.gz: 27115ae008fd154acc4e3c0ff6ee9b7cb0da06578634d78f14817b790a3a2bf1e30ba4c376f2d90f9e8becabeccf9bc3882f64cdea7c559ee44764877a5a3181
-  data.tar.gz: fda1bc73fb4ff4bb9d90e9a005554dab160601a9cef5a6eb8c8ed2768a9e2ea35452862b5ec9102b84c8ab25ab8f005aca23c6a1db1e3812e33ebc54926e09ee
+  metadata.gz: f6540ffb673966602d288d9799589ec50ba082d500e93f354e0b8b3bdf0da505ed497105fa76ce79486249d25fa7bd9716093d38926c45c44f680fe262dcd2dd
+  data.tar.gz: c0e78b08ca268ad9a465d10cc4de75d597fb55b0381999015d1c30c90104dd58ceae9efb134bab017f2313a588c75fa134955d478832d5c31845b84f3dffb483

data/Gemfile

@@ -0,0 +1,18 @@
+source 'http://rubygems.org'
+
+gemspec
+
+# String.scrub for ruby 1.9.x
+gem 'scrub_rb' unless RUBY_VERSION.split('.')[0] == '2'
+
+gem 'rubyzip', '~> 1.1.6'
+#gem 'seven_zip_ruby', '~> 1.2.4'
+#gem 'yard', '~> 0.8.7.6'
+#gem 'redcarpet', '~> 3.2.2'
+gem 'spreadsheet', '~> 1.0.1'
+gem 'ruby-ole', '>= 1.0'
+gem 'rake', '~> 10.4.2'
+gem 'thor', '~> 0.19.1'
+gem 'git', '~> 1.2.9.1'
+gem 'rest-client', '~> 1.7.3'
+gem 'colorize', '~> 0.7.5'

data/README.md

@@ -0,0 +1,46 @@
+Reviser
+====================
+
+Description
+---------------
+[Reviser](https://rubygems.org/gems/reviser) is a semi-automatic tool for student's projects evaluation, written in Ruby.
+
+Installation
+---------------
+
+###Gem Installation
+
+Download and install the gem with the following command line.
+
+	gem install reviser
+
+
+###Usage
+
+To create a new workspace, run this following: 
+
+	reviser init
+
+After this, edit the config.yml file generated by reviser. You maybe have to create a type project config file too.
+
+To launch a complete cycle of analysis, run:
+
+	reviser work
+
+Team
+----
+[Anthony Cerf]()
+
+[Yann Prono](https://github.com/mcdostone)
+
+[Romain Ruez]()
+
+[Renan Strauss](https://github.com/renan-)
+
+
+Other stuff
+-------------
+
+|Question 	|   	Answer		 |
+| ------------- | ------------------------------ |
+| Requires      | Ruby 2.0.0 or later	 	 |

data/ext/valgrind.rb

@@ -1,24 +1,27 @@
-module Extensions
-	module Valgrind
+module Reviser
+	module Extensions
+		module Valgrind
 
-		include Helpers::Execution
-		include Helpers::System
+			include Helpers::System
 
-		VALGRIND_FILE = "valgrind.txt"
+			VALGRIND_FILE = "valgrind.txt"
 
-		#
-		# Check memory leaks of the program
-		# The module uses execution value written in the config file of the project 
-		#
-		def memleaks
-			executable = find_executable
-			program = "#{Cfg[:program_prefix]}#{executable}"
-			param = Cfg.has_key?(:execution_value) ? Cfg[:execution_value].first : ''
-			cmd = "valgrind --leak-check=full --track-origins=yes --show-reachable=yes #{program} #{param}"
-			out = exec_with_timeout cmd
-			File.open(VALGRIND_FILE, 'w') { |f| f.write "$ #{cmd}\r#{out[:stdout]}\r#{out[:stderr]}" }
-			File.join(FileUtils.pwd, VALGRIND_FILE)
-		end
+			#
+			# Check memory leaks of the program
+			# The module uses execution value written in the config file of the project
+			#
+			# Yann, execution_count shall be taken in count imo 
+			#
+			def memleaks
+				executable = find_executable
+				program = "#{Cfg[:program_prefix]}#{executable}"
+				param = Cfg.has_key?(:execution_value) ? Cfg[:execution_value].first : ''
+				cmd = "valgrind --leak-check=full --track-origins=yes --show-reachable=yes #{program} #{param}"
+				out = exec_with_timeout cmd
+				File.open(VALGRIND_FILE, 'w') { |f| f.write "$ #{cmd}\r#{out[:stdout]}\r#{out[:stderr]}" }
+				File.join(FileUtils.pwd, VALGRIND_FILE)
+			end
 
+		end
 	end
 end

data/ext/web_validators.rb

@@ -0,0 +1,132 @@
+#
+# @author Renan Strauss
+#
+# A tool to validate what we call web languages,
+# in other words languages that can't be analysed
+# by compilation nor by execution
+# It's very simple at that point, but feel free to
+# make the extension better :-)
+#
+require 'rest_client'
+
+module Reviser
+	module Extensions
+		module WebValidators
+			include Helpers::Project
+
+			def validate_web
+				{ html: validate(:html), css: validate(:css) }
+			end
+
+			def validate_html
+				validate :html
+			end
+
+			def validate_css
+				validate :css
+			end
+
+			private
+
+			#
+			# @returns a hash matching all files for this lang to a resultset
+			#
+			def validate lang
+				results = {}
+
+				files = sources.select { |s| File.extname(s) == ".#{lang}" }
+				files.each do |f|
+					response = W3C::validate(lang, f)
+
+					if response.is_a?(Hash) && response.has_key?(:exception)
+						results[f] = { :status => response[:exception].to_s }
+					else
+						results[f] = {
+							:status => response.headers.has_key?(:x_w3c_validator_status) && response.headers[:x_w3c_validator_status] || 'Not available',
+							:errors => response.headers.has_key?(:x_w3c_validator_errors) && response.headers[:x_w3c_validator_errors] || 'Not available',
+							:warnings => response.headers.has_key?(:x_w3c_validator_warnings) && response.headers[:x_w3c_validator_warnings] || 'Not available'
+						}
+					end
+
+					puts "\t\t#{f} => #{results[f][:status]}"
+
+					#
+					# Generate a file
+					# Simply add 'web_validators_save_results: true'
+					# in your project's type config file
+					#
+					Cfg[:web_validators_save_results] ||= false
+
+					#
+					# We generate only if config key is set and
+					# response is not a raw string
+					#
+					if Cfg[:web_validators_save_results] and not response.headers.empty?
+						body = response.to_str
+						#
+						# W3C uses scss so we need to replace imports by the
+						# actual css...
+						#
+						case lang
+						when :html
+							body.sub! '@import "./style/base";', File.read(Cfg::resource 'css/web_validators/html-base.css')
+							body.sub! '@import "./style/results";', File.read(Cfg::resource 'css/web_validators/html-results.css')
+						when :css
+							body.sub! 'style/base.css', Cfg::resource('css/web_validators/css-base.css').to_path
+							body.sub! 'style/results.css', Cfg::resource('css/web_validators/css-results.css').to_path
+
+							body.sub! 'file://localhost/TextArea', f
+						end
+
+						File.open(f + '.WEB_VALIDATORS.html', 'w') { |x| x.write body }
+					end
+				end
+
+				results
+			end
+
+			#
+			# This class is wrapping up
+			# W3C API
+			#
+			class W3C
+				VALIDATORS = {
+					:html => 'validator.w3.org/check',
+					:css  => 'jigsaw.w3.org/css-validator/validator'
+				}
+
+				#
+				# @returns responses from the request made to the validator
+				#
+				def self::validate lang, file
+					raise ArgumentError unless VALIDATORS.include? lang
+					#
+					# W3C is a free service and we shall not overflow it
+					# with our requests so accordingly to their doc,
+					# we sleep 1s between each request
+					#
+					sleep 1
+					begin
+						send lang, file
+					rescue => e
+						{ exception: e }
+					end
+				end
+
+				#
+				# W3C HTML Validator API expects a POST uploaded_file
+				#
+				def self::html file
+					RestClient.post(VALIDATORS[:html], :uploaded_file => File.new(file))
+				end
+
+				#
+				# Whereas W3C CSS Validator API doesn't accept uploaded
+				# files, so we need to pass the raw text
+				def self::css file
+					RestClient.get(VALIDATORS[:css] + '?text=' + CGI.escape(File.read(file)))
+				end
+			end
+		end
+	end
+end

data/lang/HTML.yml

@@ -21,8 +21,7 @@ compiled: false
 # the html_validator extension
 #
 extensions:
-  html_validator:
-    :valid: Validite HTML 5
+  validate_html: Validite HTML 5
 
 # Program prefix, needed especially for C
 # The execution command will look like this :
@@ -35,15 +34,4 @@ extensions:
 
 # If not specified, the first
 # executable file found will be executed
-# program_name: main.rb
-
-regex_comments: !ruby/regexp '/#([^{].*)$/'
-
-criteria:
-  - all_files
-  - src_files
-  - lines_count
-  - comments_count
-
-extensions:
-  - validate_html
+# program_name: main.rb

data/lib/component.rb

@@ -4,50 +4,52 @@
 require 'yaml'
 require_relative 'loggers/logger'
 
-class Component
-	
-	# Each component has a logger (currently a txt file)
-	# $logger
+module Reviser
+	class Component
+		
+		# Each component has a logger (currently a txt file)
+		# $logger
 
-	#
-	# Don't forget to call super in your component's initializer !
-	# This method is all about : it stores the data from another
-	# component accordingly to what you told to Reviser, and
-	# creates a hash for child to easily access config file values
-	#
-	def initialize(data = nil)
-		@data = data
-		ext = options.has_key?(:log_mode) && options[:log_mode] || 'txt'
-		log_file = File.join(options.has_key?(:log_dir) && options[:log_dir] || '.', "#{ self.class.name.split('::').last || ''}.#{ext}")
+		#
+		# Don't forget to call super in your component's initializer !
+		# This method is all about : it stores the data from another
+		# component accordingly to what you told to Reviser, and
+		# creates a hash for child to easily access config file values
+		#
+		def initialize(data = nil)
+			@data = data
+			ext = options.has_key?(:log_mode) && options[:log_mode] || 'txt'
+			log_file = File.join(options.has_key?(:log_dir) && options[:log_dir] || '.', "#{ self.class.name.split('::').last || ''}.#{ext}")
 
-		# For now, we output to stderr if verbose option is not set
-		# In the future, it would be a good idea to always have logs,
-		# but to let the user change the level
-		@logger = Loggers::Logger.new(options[:verbose] && log_file || STDERR)
-	end 
+			# For now, we output to stderr if verbose option is not set
+			# In the future, it would be a good idea to always have logs,
+			# but to let the user change the level
+			@logger = Loggers::Logger.new(options[:verbose] && log_file || STDERR)
+		end 
 
-	# Place-holder
-	# Just like an abstract method
-	def run
-		raise NotImplementedError, 'All components must implement a run method'
-	end
+		# Place-holder
+		# Just like an abstract method
+		def run
+			raise NotImplementedError, 'All components must implement a run method'
+		end
 
-	# Method template
-	# So that when somebody implements a custom
-	# Component, he doesn't have to carry about
-	# logger being closed or not.
-	# Might be even more useful at some point
-	def work
-		data = run
-		@logger.close
+		# Method template
+		# So that when somebody implements a custom
+		# Component, he doesn't have to carry about
+		# logger being closed or not.
+		# Might be even more useful at some point
+		def work
+			data = run
+			@logger.close
 
-		data
-	end
+			data
+		end
 
-protected
-	#
-	# @return all options for all components if they exist in config file.
-	def options
-		(Cfg.has_key? :options) && Cfg[:options] || { :verbose => false }
+	protected
+		#
+		# @return all options for all components if they exist in config file.
+		def options
+			(Cfg.has_key? :options) && Cfg[:options] || { :verbose => false }
+		end
 	end
 end

data/lib/components/archiver.rb

@@ -2,117 +2,121 @@ require 'fileutils'
 require_relative 'extractors'
 
 
-module Components
-
-	# Manages uncompression of archive.
-	# Archiver extracts all data in a given compressed file.
-	#
-	# In case of the University of Lorraine,
-	# the archive contains all computing projects, compressed too.
-	#
-	# @example The simple way to extract a compressed file is :
-	#		Archiver.extract(myFile, myDirectory)
-	#
-	# @author	Yann Prono
-	#
-	class Archiver < Component
-
-		# methods for each different archive format
-		extend Extractors
-
-		# Ignored entries
-		$rejected = ['.','..']
-		
-		# Initialize archive file and the directory of destination.
-		def initialize(data)
-			super data
-			@src = Cfg[:src]
-			@destination = Cfg[:dest]
-			@results = []
-		end
-
+module Reviser
+	module Components
 
-		# Check if the directory destination exists.
-		# else create it.
-		# For the moment, if the directory exists // TODO little input to confirm
-		# @param destination [String] the destination directory
+		# Manages uncompression of archive.
+		# Archiver extracts all data in a given compressed file.
+		#
+		# In case of the University of Lorraine,
+		# the archive contains all computing projects, compressed too.
+		#
+		# If you want to add support of archive format, @see Extractors.
+		#
+		# @example The simple way to extract a compressed file is :
+		#		Archiver.extract(myFile, myDirectory)
+		#
+		# @author	Yann Prono
 		#
-		def self.destination?(destination)
-			unless $rejected.include? File.basename destination
-				FileUtils.rm_rf(destination) if Dir.exists? destination
-				FileUtils.mkdir_p destination, :mode => 0700
+		class Archiver < Component
+
+			# methods for each different archive format
+			extend Extractors
+
+			# Ignored entries
+			$rejected = ['.','..']
+			
+			# Initializes archive file and the directory of destination.
+			def initialize(data)
+				super data
+				@src = Cfg[:src]
+				@destination = Cfg[:dest]
+				@results = []
 			end
-		end
-		
 
-		# Extract the archive into the destination directory.
-		# @param file_name 		[String] The name of the archive.
-		# @param destination 	[String] The destination directory.
-		#
-		def self.extract(file_name, destination = '.')
-			raise Errno::ENOENT unless File.exist? file_name
 
-			# Get extension of file_name to know which method calls
-			ext = File.extname(file_name)
-			ext = ext.delete('.')
+			# Checks if the destination directory exists.
+			# else create it.
+			# For the moment, if the directory exists // TODO little input to confirm
+			# @param destination [String] the destination directory
+			#
+			def self.destination?(destination)
+				unless $rejected.include? File.basename destination
+					FileUtils.rm_rf(destination) if Dir.exists? destination
+					FileUtils.mkdir_p destination, :mode => 0700
+				end
+			end
+			
 
-			# Raise exception if the format is unknown by Archiver
-			raise "Unknown format '#{r}'" unless respond_to?(ext)
-			# Check if destination exists
-			self::destination? destination
+			# Extracts the archive into the destination directory.
+			# @param file_name 		[String] The name of the archive.
+			# @param destination 	[String] The destination directory.
+			#
+			def self.extract(file_name, destination = '.')
+				raise Errno::ENOENT unless File.exist? file_name
 
-			# Run extraction!
-			send(ext,file_name, destination)
-		end
+				# Get extension of file_name to know which method calls
+				ext = File.extname(file_name)
+				ext = ext.delete('.')
 
+				# Raise exception if the format is unknown by Archiver
+				raise "Unknown format '#{r}'" unless respond_to?(ext)
+				# Check if destination exists
+				self::destination? destination
 
-		# Method which extract an archive
-		# which contains all computing projects.
-		#
-		# This method extracts,in first time,the archive
-		# given in the constructor and after, all extracted files.
-		#
-		# Use this method in a global usage of Reviser!
-		# Options are for the moment :verbose
-		#
-		def run
-			@logger.h1 Logger::INFO,"First extraction - #{@src}"
-			# Extract the original archive
-			Archiver.extract(@src, @destination)
+				# Run extraction!
+				send(ext,file_name, destination)
+			end
 
-			@logger.h1 Logger::INFO,'Extraction of sub archives'
-			
-			# Extract all sub archives
-			entries = Dir.entries(@destination) - $rejected
-			extracted = 0
-
-			entries.each do |entry|
-
-				ext = File.extname entry
-				basename = File.basename entry, ext
-				begin
-					file_name = File.join(@destination,File.basename(entry))
-					destination = File.join(@destination,basename)
-
-					# Run extraction!
-	  				Archiver.extract(file_name, destination)
-					extracted += 1
-
-					@logger.h2 Logger::INFO, "extracting #{file_name} to #{destination}"
-					@results << basename
-
-				# In case of it can't extract the file
-	  			rescue => e
-	  				@logger.h2 Logger::ERROR, "Can't extract #{entry}: #{e.message}"
-	  				puts e
-	  			end
-				# Delete in all case the archive (useless after this step				
-				FileUtils.rm_rf file_name
-	  		end
-	  		@logger.h1 Logger::INFO, "[#{extracted}/#{entries.size}] projects have been processed"
-
-			@results
+
+			# Method which extracts an archive
+			# which contains all computing projects.
+			#
+			# This method extracts,in first time,the archive
+			# given in the constructor and after, all extracted files.
+			#
+			# Use this method in a global usage of Reviser!
+			# Options are for the moment :verbose
+			#
+			def run
+				@logger.h1 Logger::INFO,"First extraction - #{@src}"
+				# Extract the original archive
+				Archiver.extract(@src, @destination)
+
+				@logger.h1 Logger::INFO,'Extraction of sub archives'
+				
+				# Extract all sub archives
+				entries = Dir.entries(@destination) - $rejected
+				extracted = 0
+
+				entries.each do |entry|
+
+					ext = File.extname entry
+					basename = File.basename entry, ext
+					begin
+						file_name = File.join(@destination,File.basename(entry))
+						destination = File.join(@destination,basename)
+
+						# Run extraction!
+		  				Archiver.extract(file_name, destination)
+						extracted += 1
+
+						@logger.h2 Logger::INFO, "extracting #{file_name} to #{destination}"
+						@results << basename
+
+					# In case of it can't extract the file
+		  			rescue => e
+		  				@logger.h2 Logger::ERROR, "Can't extract #{entry}: #{e.message}"
+		  			end
+
+					# Delete in all case the archive (useless after this step)
+					FileUtils.rm_rf file_name
+		  		end
+		  		@logger.h1 Logger::INFO, "[#{extracted}/#{entries.size}] projects have been processed"
+
+				@results
+			end
 		end
-	end
 
+	end
 end