reviser 0.0.2.rc1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb2455e95c3f150c2af8cb0e01b481ce485bb948
-  data.tar.gz: 12663cbeb09dadc6df0f608da12dc4fd28bdb1e4
+  metadata.gz: 63f5c9bb8b13e12e15bfaa88826b18e740fd9c9c
+  data.tar.gz: 7b6da00d754cd3a1cf240b74dbfbff1210877b2c
 SHA512:
-  metadata.gz: f6540ffb673966602d288d9799589ec50ba082d500e93f354e0b8b3bdf0da505ed497105fa76ce79486249d25fa7bd9716093d38926c45c44f680fe262dcd2dd
-  data.tar.gz: c0e78b08ca268ad9a465d10cc4de75d597fb55b0381999015d1c30c90104dd58ceae9efb134bab017f2313a588c75fa134955d478832d5c31845b84f3dffb483
+  metadata.gz: 702d6ac5c42ba91b81c366d85d42f560a1243ba780c4575148da466137a690f01fe038d8ea411ee6f258ca8d42e615fad807625eb524c5d510cc4145c83a9c51
+  data.tar.gz: 75be96c7c3560d4385b6f2fd08e9543a0dc1b83aab5fcb1ad59e89e24c9a5d466d2ff4025ad77bafeda6c062f7acf131446bf3c87a85b1b48c281e63dea702e7

data/Gemfile

@@ -14,5 +14,5 @@ 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 'w3c_validators', '~> 1.2'
 gem 'colorize', '~> 0.7.5'

data/README.md

@@ -1,32 +1,165 @@
 Reviser
 ====================
 
-Description
+###Description
 ---------------
 [Reviser](https://rubygems.org/gems/reviser) is a semi-automatic tool for student's projects evaluation, written in Ruby.
 
-Installation
+###Installation
 ---------------
 
-###Gem Installation
-
 Download and install the gem with the following command line.
 
 	gem install reviser
 
 
-###Usage
+###Basic usage
+---------------
+
+To create a new workspace in the current directory, simply run the following command in a terminal: 
+
 
-To create a new workspace, run this following: 
+	reviser init .
 
-	reviser init
+	Create		res
+	Create		type
+	Create		config.yml
 
-After this, edit the config.yml file generated by reviser. You maybe have to create a type project config file too.
+You see reviser has created *res* and *type/example* folders for you.
+Now you'll have to customize *config.yml* to your own needs, and add a *type/your_project.yml*
 
-To launch a complete cycle of analysis, run:
+To perform the analysis, simply run:
 
 	reviser work
 
+###Configuration
+---------------
+
+This tool was thought to be very adaptable, thus it relies on YAML configuration files.
+
+###Global configuration
+Lives in *config.yml*.
+
+|Key   |Description|Values|Required|
+|------|-----------|-----|:--------:|
+|*src*|Path to the archive containing projects||![checkbox.png](https://bitbucket.org/repo/AyGgAx/images/3281147034-checkbox.png)|
+|*dest*|Path to a directory where projects will be extracted||![checkbox.png](https://bitbucket.org/repo/AyGgAx/images/3281147034-checkbox.png)|
+|*projects_names*|Naming convention for projects|`^GROUP_NAME_NAME` `^GROUP_NAME(_NAME)*` `^TP_NAME_FIRSTN`|![checkbox.png](https://bitbucket.org/repo/AyGgAx/images/3281147034-checkbox.png)|
+|*type*|The type of the project|`my_project` (*type/my_project.yml* must exist)|![checkbox.png](https://bitbucket.org/repo/AyGgAx/images/3281147034-checkbox.png)|
+|*criteria*|The criteria you want for analysis|`all_files` `src_files` `lines_count` `comments_count` `compile` `execute`|![checkbox.png](https://bitbucket.org/repo/AyGgAx/images/3281147034-checkbox.png)|
+|*extensions*|The list of extensions you want for analysis|See below||
+|*out*|The name of the analysis output file|Default *results*||
+|*out_format*|The formats that will be generated|Default `html` `xls` `csv`||
+|*options*|A hash to set options|`:verbose` `:log_dir` `:log_mode`||
+
+###Project configuration
+Lives in *type/my_project.yml*.
+
+|Key   |Description|Values|Required|
+|------|-----------|-----|:--------:|
+|*language*|The target language|`C` `Java` `HTML` `Ruby`|![checkbox.png](https://bitbucket.org/repo/AyGgAx/images/3281147034-checkbox.png)|
+|*timeout*|In seconds. Compilation and execution will halt if not completed within the defined timeout|Default *4*||
+|*required_files*|A list of required files|Tip: you can use regular expressions||
+|*preferred_build_command*|The command to build the program with|`make`||
+|*execute_command*|The name of the interpreter|`java` `ruby`||
+|*program_prefix*|The program prefix|`pkg.` for Java||
+|*program_name*|The name of the program|`a.out` `Main`||
+|*execution_count*|The amount of times to execute the program|Default *1*||
+|*execution_value*|The optional parameter to pass to the program when executing|A list of values whose length shall be one if *execution_count* is not greater than 1|||
+
+###Extensions
+Extensions are in fact Criteria we didn't want to include into reviser's core.
+Reviser's core aims to rely as much as possible on native Ruby APIs to ensure its portability.
+That's why Extensions exist: they basically are Criteria which relies on platform-spefic-features.
+
+As of now, there are 2 extensions:
+
+|Extension|Description|Add it to your workspace extensions|
+|------------|--------------|----------------------------------------------|
+|Valgrind|Runs a memcheck through system call to valgrind|`memleaks`|
+|WebValidators|Validates HTML and CSS through W3C API calls|`validate_web` `validate_html` `validate_css`|
+
+###Extending
+
+####Custom components
+```
+#!ruby
+
+require 'json'
+require 'reviser'
+
+#
+# Let's build a custom component !
+# It just parses an example JSON file and prints it
+#
+class MyComponent < Reviser::Component 
+	#
+	# Don't forget to call super !
+	#
+	# If you told Reviser to take input from another
+	# component, @data will contains it
+	#
+	def initialize data
+		super data
+
+		@logger.info { "Initialized, got data => #{data}" }
+	end
+
+	#
+	# All components must implement a run method
+	#
+	def run
+		puts 'Hello World from MyComponent, got @data = ' + @data.to_s
+
+		my_resource = resource 'example/data.json'
+		JSON.parse(File.read(my_resource)).each do |k, v|
+			puts "Got #{k} => #{v}"
+		end
+	end
+end
+
+#
+# Then we run it
+#
+module MyApp
+	include Reviser
+
+	def self.run config_file = '../config.yml'
+		#
+		# Setup reviser
+		#
+		Reviser::setup config_file
+		
+		#
+		# You can load any built-in component (archiver, organiser, checker, generator)
+		# But be aware that they have to be ran in this order, and that
+		# organiser takes input from archiver, checker from organiser and generator from checker
+		# If you don't respect that, nothing will work.
+		# But you can run your component at any step, this won't break the process.
+		#
+		# Reviser::load :component => 'archiver'
+		# Reviser::load :component => 'organiser', :input_from => 'archiver'
+
+		#
+		# Tell reviser not to look for our component
+		# in its core ones but to let us include it
+		# ourselves instead
+		#
+		Reviser::load :component => 'my_component', :local => true #, :input_from => 'archiver'
+
+		# Reviser::load :component => 'checker', :input_from => 'organiser'
+		# Reviser::load :component => 'generator', :input_from => 'checker'
+
+		#
+		# Run reviser
+		#
+		Reviser::run
+	end
+end
+
+MyApp::run
+```
+
 Team
 ----
 [Anthony Cerf]()
@@ -43,4 +176,4 @@ Other stuff
 
 |Question 	|   	Answer		 |
 | ------------- | ------------------------------ |
-| Requires      | Ruby 2.0.0 or later	 	 |
+| Requires      | Ruby 1.9.3 or later	 	 |

data/bin/reviser

@@ -3,4 +3,4 @@
 require 'scrub_rb' unless RUBY_VERSION.split('.')[0] == '2'
 
 # Command line interface
-require_relative '../lib/exec'
+require_relative '../lib/exec'

data/config.yml

@@ -36,15 +36,10 @@ out_format:
 - csv
 - html
 
-# Ressources directory
-# (needed for html format)
-res_dir: res
-
-
 ########	Reviser config		########
 
 # The type of project (<type>.yml must exists)
-type: Labyrinthe
+type: example/Labyrinthe
 
 # Default timeout
 # shall be overriden in sorts

data/ext/valgrind.rb

@@ -1,7 +1,6 @@
 module Reviser
 	module Extensions
 		module Valgrind
-
 			include Helpers::System
 
 			VALGRIND_FILE = "valgrind.txt"
@@ -19,9 +18,14 @@ module Reviser
 				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)
+				
+				result = File.join(FileUtils.pwd, VALGRIND_FILE)
+				manufacture do |format|
+					format.html { '<a href="' + result + '" target="_blank">' + result + '</a>' }
+					format.csv { result }
+					format.xls { result }
+				end
 			end
-
 		end
 	end
 end

data/ext/web_validators.rb

@@ -7,15 +7,26 @@
 # It's very simple at that point, but feel free to
 # make the extension better :-)
 #
-require 'rest_client'
+require 'w3c_validators'
 
 module Reviser
 	module Extensions
 		module WebValidators
 			include Helpers::Project
+			include W3CValidators
 
 			def validate_web
-				{ html: validate(:html), css: validate(:css) }
+				results = validate(:html)
+				results.merge! validate(:css)
+
+				#
+				# We want a pretty HTML output :-)
+				# 
+				manufacture do |format|
+					format.html { prettify results }
+					format.csv { results }
+					format.xls { results }
+				end
 			end
 
 			def validate_html
@@ -27,105 +38,58 @@ module Reviser
 			end
 
 			private
-
 			#
 			# @returns a hash matching all files for this lang to a resultset
 			#
 			def validate lang
 				results = {}
+				validator = nil
+				case lang
+				when :html
+					validator = MarkupValidator.new
+				when :css
+					validator = CSSValidator.new
+				end
+
+				raise ArgumentError unless validator != nil
 
 				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
+					begin
+						response = validator.validate_file(File.new(f))
 						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'
+							:valid => response.errors.length == 0,
+							:errors => response.errors.length
 						}
-					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 }
+						puts "\t\t#{f} => #{results[f][:valid]}"
+					rescue ValidatorUnavailable => e
+						results[f] = { :status => 'Unknown', :errors => 'Unknown' }
 					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'
-				}
+			def prettify results
+				return results unless results.values.first
 
-				#
-				# @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
+				headings = results.values.first.keys
 
-				#
-				# W3C HTML Validator API expects a POST uploaded_file
-				#
-				def self::html file
-					RestClient.post(VALIDATORS[:html], :uploaded_file => File.new(file))
-				end
+				html = '<table><caption>WebValidators results</caption><tr><th>File</th>'
+				headings.each { |heading| html << "<th>#{heading}</th>" }
+				html << '</tr>'
 
-				#
-				# 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)))
+				results.each do |file, data|
+					html << '<tr>'
+					html << "<th>#{file}</th>"
+					data.values.each { |value| html << "<td>#{value}</td>" }
+					html << '</tr>'
 				end
+
+				html << '</table>'
+
+				html
 			end
 		end
 	end

data/lang/HTML.yml

@@ -16,6 +16,11 @@ extension:
 # Whether it's a compiled or an interpreted language
 compiled: false
 
+#
+# Regex for HTML comments
+#
+regex_comments: !ruby/regexp '/<!--(.*?)-->/'
+
 #
 # In all HTML projects, we'll need
 # the html_validator extension

data/lib/exec.rb

@@ -1,9 +1,7 @@
 require 'thor'
 require 'fileutils'
 require 'colorize'
-
 require_relative 'reviser'
-require_relative 'helpers/criteria'
 
 #
 # Module used for managing all actions in command line
@@ -15,7 +13,7 @@ require_relative 'helpers/criteria'
 module Reviser
 	class Exec < Thor
 
-		VERSION = '0.0.1.1'
+		VERSION = '0.0.2'
 
 		map '--version' => :version
 		map '-v' => :version
@@ -33,12 +31,22 @@ module Reviser
 	    	setup config_file if File.exist? config_file
 		end
 
-
 		# Create a environnment for checking projects
 		# This method only copies the config file into the current directory.
 		desc 'init DIRECTORY', 'Initialize Reviser workspace. DIRECTORY ||= \'.\''
 		def init(dir = '.')
 			pwd = FileUtils.pwd
+
+			[Cfg::RES_DIR, Cfg::TYPE_DIR].each do |d|
+				path = File.join(Cfg::ROOT, d)
+				if File.directory? path
+					unless File.directory? File.join(dir, d)
+						FileUtils.cp_r(path, dir)
+						message('Create', dir == '.' && d || File.join(dir, d))
+					end
+				end
+			end
+
 			msg = File.exist?(File.join(pwd,dir,File.basename($template_path))) && 'Recreate' || 'Create'
 			FileUtils.mkdir_p dir unless Dir.exist?(File.join(pwd, dir))
 			FileUtils.cp($template_path, dir)
@@ -46,13 +54,6 @@ module Reviser
 
 	    setup File.expand_path(File.join(dir, File.basename($template_path))) unless @@setup
 
-	    if not File.exist?(File.join(FileUtils.pwd, Cfg[:res_dir]))
-	    	path_res = File.join(File.dirname(File.dirname(__FILE__)),"#{Cfg[:res_dir]}")
-				FileUtils.cp_r(path_res, FileUtils.pwd) unless 
-
-				message('Create', File.join(dir, Cfg[:res_dir]))
-			end
-
 			puts "Customize config.yml to your needs @see docs".yellow
 			puts 'Then simply execute \'reviser work\' to launch analysis.'.yellow
 		end
@@ -88,16 +89,21 @@ module Reviser
 
 		# Let do it for analysis.
 		# @param current_dir [String] the directory where the programm has to be launched.
-		desc 'work', 'Run components to analysis computing projects'
+		desc 'work', 'Run components to analyse computing projects'
 		def work
-
 			if File.exists? 'config.yml'
-				Reviser::load :component => 'archiver'
-				Reviser::load :component => 'organiser', :inputFrom => 'archiver'
-				Reviser::load :component => 'checker', :inputFrom => 'organiser'
-				Reviser::load :component => 'generator', :inputFrom => 'checker'
-
-				Reviser::run
+				begin
+					Reviser::load :component => 'archiver'
+					Reviser::load :component => 'organiser', :input_from => 'archiver'
+					Reviser::load :component => 'checker', :input_from => 'organiser'
+					Reviser::load :component => 'generator', :input_from => 'checker'
+
+					Reviser::run
+				rescue Interrupt => i
+					message("...".yellow, "Bye bye")
+				rescue Exception => e
+					message('Error'.red, "#{e.message}")
+				end
 			else
 				message('Error'.red, "'config.yml' file doesn't exist! @see 'reviser init'")
 			end
@@ -105,10 +111,16 @@ module Reviser
 
 		desc 'extract', 'Extract and organise all computing projects'
 		def extract
-			Reviser::load :component => 'archiver'
-			Reviser::load :component => 'organiser', :inputFrom => 'archiver'
-			
-			Reviser::run
+			begin
+				Reviser::load :component => 'archiver'
+				Reviser::load :component => 'organiser', :input_from => 'archiver'
+				
+				Reviser::run
+			rescue Interrupt => i
+				message("...".yellow, "Bye bye")
+			rescue Exception => e
+				message('Error'.red, "#{e.message}")
+			end
 		end
 
 		#
@@ -129,7 +141,7 @@ module Reviser
 		desc 'version', 'Print out version information'
 		def version
 			puts "Reviser #{VERSION}"
-			puts 'Released under the MIT License.'
+			puts 'Released under the GPLv3 License.'
 		end
 
 

data/lib/{component.rb → reviser/component.rb}

@@ -18,8 +18,9 @@ module Reviser
 		#
 		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}")
+			
+			ext = options[:log_mode]
+			log_file = File.join(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,
@@ -45,11 +46,24 @@ module Reviser
 			data
 		end
 
+		# Be kind to our childs and let them access
+		# ressources files easily
+		#
+		# @returns The specified resource path
+		# TODO : put resources in dedicated folders
+		# for each component or extension, so that
+		# the user can omit <lang>/<ext_name>/ when
+		# calling this method
+		#
+		def resource path
+			Cfg::resource path
+		end
+
 	protected
 		#
 		# @return all options for all components if they exist in config file.
 		def options
-			(Cfg.has_key? :options) && Cfg[:options] || { :verbose => false }
+			Cfg[:options]
 		end
 	end
 end

data/lib/{components → reviser/components}/archiver.rb

@@ -53,14 +53,15 @@ module Reviser
 			# @param destination 	[String] The destination directory.
 			#
 			def self.extract(file_name, destination = '.')
-				raise Errno::ENOENT unless File.exist? file_name
+				raise "#{file_name} not found, please check in the current directory." unless File.exist? file_name
 
 				# 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)
+				raise "Unknown compression format '#{ext}'" unless respond_to?(ext)
+
 				# Check if destination exists
 				self::destination? destination
 
@@ -93,7 +94,7 @@ module Reviser
 
 					ext = File.extname entry
 					basename = File.basename entry, ext
-					begin
+					#begin
 						file_name = File.join(@destination,File.basename(entry))
 						destination = File.join(@destination,basename)
 
@@ -104,11 +105,6 @@ module Reviser
 						@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

data/lib/{components → reviser/components}/checker.rb

@@ -9,6 +9,7 @@
 #
 require 'open3'
 
+require_relative '../result'
 require_relative '../helpers/criteria'
 
 module Reviser
@@ -24,8 +25,8 @@ module Reviser
 
 				@logger.h1 Logger::INFO, "Loading modules"
 
-				load PWD, '../criteria/*'
-				load EXT, '*'
+				load CRITERIA
+				load EXTENSIONS
 
 				@logger.h1 Logger::INFO, "Loading labels"
 
@@ -61,7 +62,9 @@ module Reviser
 				# for each method asked by user with its label
 				@output.each do |meth, label|
 					if @criteria.has_key? meth
-						@results[proj][label] = call meth 
+						result = call meth
+						data = result.is_a?(Result) && result || Result.new(result)
+						@results[proj][label] = data
 					else
 						@logger.h1(Logger::ERROR, "Unknown method '#{meth}'' for project #{proj}")
 					end

data/lib/{components → reviser/components}/extractors.rb

@@ -110,7 +110,7 @@ module Reviser
 		 			destination = Shellwords.escape(destination)
 		 			`unrar e #{src} #{destination}`
 				else
-					puts 'Please install unrar : sudo apt-get install unrar'
+					raise 'Please install unrar : sudo apt-get install unrar (winRar for Windows)'
 				end
 			end