reviser 0.0.2 → 0.0.3.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63f5c9bb8b13e12e15bfaa88826b18e740fd9c9c
-  data.tar.gz: 7b6da00d754cd3a1cf240b74dbfbff1210877b2c
+  metadata.gz: de86303651098bc8dc96d8c79d31d2fd3dfea923
+  data.tar.gz: 9e7d767dfb42f4f30264958a8f7bc25b9656ced8
 SHA512:
-  metadata.gz: 702d6ac5c42ba91b81c366d85d42f560a1243ba780c4575148da466137a690f01fe038d8ea411ee6f258ca8d42e615fad807625eb524c5d510cc4145c83a9c51
-  data.tar.gz: 75be96c7c3560d4385b6f2fd08e9543a0dc1b83aab5fcb1ad59e89e24c9a5d466d2ff4025ad77bafeda6c062f7acf131446bf3c87a85b1b48c281e63dea702e7
+  metadata.gz: 4cd682db9986a72d0c67214a9bed34781cec93badc1e8eb6ac535b68cbca68095e461401fb73e94e39925d0dd0d503990e3877e68774350ae829da95747c3888
+  data.tar.gz: 3780311419cb5cdcc2705ad1207d3ad4bbe22678b8a776493ba0c96a079be8f32ee8545c8fe227ecce1bf9e5aaed155ea6dd98a5eae4f9eb6139d6d47526b3bb

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/Gemfile

@@ -1,18 +1,17 @@
-source 'http://rubygems.org'
-
-gemspec
+source 'https://rubygems.org'
 
 # 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 'spreadsheet', '~> 1.0.1'
+# gem 'ruby-ole', '>= 1.0'
 gem 'thor', '~> 0.19.1'
-gem 'git', '~> 1.2.9.1'
-gem 'w3c_validators', '~> 1.2'
-gem 'colorize', '~> 0.7.5'
+# gem 'git', '~> 1.2.9.1'
+gem 'colorize', '~> 0.7.5'
+
+# To generate docs
+group :development do 
+	gem 'redcarpet'
+	gem 'yard'
+end

data/README.md

@@ -32,6 +32,22 @@ To perform the analysis, simply run:
 
 	reviser work
 
+###How it works
+---------------
+
+Our tool is divided into 4 main components :
+
+|Component|Role|
+|-------------|-------|
+|Archiver|Extracting all computing projects|
+|Organiser|Parsing students names and renaming directories appropriately|
+|Checker|Running the analysis based upon selected criteria and extensions|
+|Generator|Generating the analysis results in various formats|
+
+The basic idea is that each component can receive data from any of the components run before it.
+It shall requests that input upon loading. The *work* command actually runs the above components
+with the appropriate input data (e.g. *Generator* relies on *Checker* results).
+
 ###Configuration
 ---------------
 
@@ -65,7 +81,18 @@ Lives in *type/my_project.yml*.
 |*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|||
+|*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*|||
+
+###Labels configuration
+
+Each criterion is associated with a label. A label is some words, describing the criterion's result. For example, a criterion which checks the existence of a Makefile could have a label like 'Existence of Makefile'.
+
+By default, labels are generated with the name of the called method. You have the possibility to customize this label thanks to the command line tool:
+	
+	reviser add makefile? 'Existence of makefile'
+	#            method       associated label
+
+Labels are stored in reviser's installation directory, in a file called *labels.yml*. We don't include them in the workspace at this point, but we could later depending on feedback.
 
 ###Extensions
 Extensions are in fact Criteria we didn't want to include into reviser's core.
@@ -79,12 +106,16 @@ As of now, there are 2 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
+###Working on your own
+
+If you have very special needs, you may need to create your own components or extensions.
+You'll then need to load your components at the right time, and register your extensions for them to be available.
 
 ####Custom components
+
+*example/my_component.rb*
 ```
 #!ruby
-
 require 'json'
 require 'reviser'
 
@@ -117,18 +148,88 @@ class MyComponent < Reviser::Component
 		end
 	end
 end
+```
 
+####Custom extensions
+
+*example/my_extension.rb*
+```
+#!ruby
 #
-# Then we run it
+# A custom criteria for reviser
 #
+require 'reviser'
+
+module MyExtension
+	#
+	# This helper has the 'sources' methods
+	# that allow you to retrieve all sources
+	# files (files matching language extension)
+	#
+	include Reviser::Helpers::Project
+
+	def my_criteria
+		results = []
+		sources.each do |f|
+			results << f
+		end
+
+		#
+		# The manufacture method excepts
+		# a block which must describe the result contents
+		# for EACH format.
+		# You can also return raw data, then it'll be as it is
+		# for all formats.
+		#
+		manufacture do |format|
+			format.html { to_html results }
+			format.csv { ['This', 'is', 'power', 'of', 'Ruby', 'blocks'] }
+			format.xls { results }
+		end
+	end
+
+	private
+		#
+		# We just create a HTML list
+		#
+		def to_html data
+			html = '<ul>'
+			data.each do |el|
+				html << "<li>#{el}</li>"
+			end
+			html << '</ul>'
+
+			html
+		end
+end
+```
+
+### Putting it together
+*example/config.yml*
+```
+#!yaml
+extensions:
+  - my_criteria
+```
+
+*example/my_app.rb*
+```
+#!ruby
+require 'reviser'
+
+require_relative 'my_component'
+require_relative 'my_extension'
+
 module MyApp
 	include Reviser
 
-	def self.run config_file = '../config.yml'
+	def self.run config_file = 'config.yml'
 		#
 		# Setup reviser
 		#
 		Reviser::setup config_file
+
+		Reviser::register :extension => 'MyExtension'
 		
 		#
 		# You can load any built-in component (archiver, organiser, checker, generator)
@@ -137,18 +238,18 @@ module MyApp
 		# 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'
+		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 => 'my_component', :input_from => 'archiver', :local => true
 
-		# Reviser::load :component => 'checker', :input_from => 'organiser'
-		# Reviser::load :component => 'generator', :input_from => 'checker'
+		Reviser::load :component => 'checker', :input_from => 'organiser'
+		Reviser::load :component => 'generator', :input_from => 'checker'
 
 		#
 		# Run reviser
@@ -156,12 +257,23 @@ module MyApp
 		Reviser::run
 	end
 end
+```
 
+*example/main.rb*
+```
+#!ruby
+require_relative 'my_app'
+
+#
+# You can then run your app (don't forget you still need to be in a reviser workspace,
+# so type/ and res/ folders must exist, as well as config.yml)
+#
 MyApp::run
 ```
 
+
 Team
-----
+--------
 [Anthony Cerf]()
 
 [Yann Prono](https://github.com/mcdostone)

data/config.yml

@@ -65,6 +65,9 @@ criteria:
 extensions:
   - memleaks
 
+# Whether to create a git repository for each project
+# relies on 'git' gem
+create_git_repo: true
 
 # Options of all components
 # For the moment, there is just verbose option (for logger)

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 'w3c_validators'
 
 module Reviser
 	module Extensions
 		module WebValidators
 			include Helpers::Project
-			include W3CValidators
 
+			#
+			# Validates HTML and CSS
+			# if any
+			#
 			def validate_web
+				#
+				# TODO : explain the exception to the user
+				#
+				unless defined? W3CValidators
+					require_gem 'w3c_validators'
+
+					self.class.send(:include, W3CValidators)
+				end
+
 				results = validate(:html)
 				results.merge! validate(:css)
 
@@ -29,14 +40,6 @@ module Reviser
 				end
 			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
@@ -46,13 +49,14 @@ module Reviser
 				validator = nil
 				case lang
 				when :html
-					validator = MarkupValidator.new
+					validator = W3CValidators::MarkupValidator.new
 				when :css
-					validator = CSSValidator.new
+					validator = W3CValidators::CSSValidator.new
 				end
 
 				raise ArgumentError unless validator != nil
 
+				print "\t\t#{lang.upcase}\t["
 				files = sources.select { |s| File.extname(s) == ".#{lang}" }
 				files.each do |f|
 					begin
@@ -62,11 +66,14 @@ module Reviser
 							:errors => response.errors.length
 						}
 
-						puts "\t\t#{f} => #{results[f][:valid]}"
-					rescue ValidatorUnavailable => e
-						results[f] = { :status => 'Unknown', :errors => 'Unknown' }
+						print "="
+					rescue W3CValidators::ValidatorUnavailable => e
+						results[f] = e.message
+					rescue Exception => e
+						results[f] = e.message
 					end
 				end
+				puts "]"
 
 				results
 			end
@@ -76,17 +83,19 @@ module Reviser
 
 				headings = results.values.first.keys
 
-				html = '<table><caption>WebValidators results</caption><tr><th>File</th>'
-				headings.each { |heading| html << "<th>#{heading}</th>" }
+				html = '<table><tr><th>File</th>'
+				headings.each { |heading| html << "<th>#{heading.to_s.capitalize!}</th>" }
 				html << '</tr>'
 
 				results.each do |file, data|
-					html << '<tr>'
-					html << "<th>#{file}</th>"
-					data.values.each { |value| html << "<td>#{value}</td>" }
+					html << "<tr><th>#{file}</th>"
+					if data.is_a?(Hash)
+						data.values.each { |value| html << "<td>#{value}</td>" }
+					else
+						html << "<td>#{data}</td>"
+					end
 					html << '</tr>'
 				end
-
 				html << '</table>'
 
 				html

data/labels.yml

@@ -5,4 +5,5 @@ lines_count: Nombre de lignes de code
 comments_count: Nombre de lignes de commentaires
 compile: Resultats compilation
 execute: Resultats execution
-memleaks: Fuites memoires
+memleaks: Fuites memoires
+validate_web: Validite HTML/CSS W3C

data/lang/HTML.yml

@@ -21,13 +21,6 @@ compiled: false
 #
 regex_comments: !ruby/regexp '/<!--(.*?)-->/'
 
-#
-# In all HTML projects, we'll need
-# the html_validator extension
-#
-extensions:
-  validate_html: Validite HTML 5
-
 # Program prefix, needed especially for C
 # The execution command will look like this :
 # [execute_command=(java, ruby, python, ...)] [program_prefix]<program> [args]

data/lib/exec.rb

@@ -1,7 +1,9 @@
 require 'thor'
 require 'fileutils'
 require 'colorize'
+
 require_relative 'reviser'
+require_relative 'reviser/helpers/criteria'
 
 #
 # Module used for managing all actions in command line
@@ -13,7 +15,7 @@ require_relative 'reviser'
 module Reviser
 	class Exec < Thor
 
-		VERSION = '0.0.2'
+		VERSION = '0.0.3.rc1'
 
 		map '--version' => :version
 		map '-v' => :version
@@ -28,31 +30,17 @@ module Reviser
 			# If config.yml already exists in the working
 			# directory, then we setup reviser here
 			config_file = File.expand_path('config.yml')
-	    	setup config_file if File.exist? config_file
+			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)
-			message(msg, File.basename($template_path))
-
-	    setup File.expand_path(File.join(dir, File.basename($template_path))) unless @@setup
+			# Import all files and directories
+			init_workspace dir
+			
+			setup File.expand_path(File.join(dir, File.basename($template_path))) unless @@setup
 
 			puts "Customize config.yml to your needs @see docs".yellow
 			puts 'Then simply execute \'reviser work\' to launch analysis.'.yellow
@@ -100,9 +88,11 @@ module Reviser
 
 					Reviser::run
 				rescue Interrupt => i
-					message("...".yellow, "Bye bye")
+					puts 'Bye bye'
+				rescue Gem::LoadError => e
+					message('Missing gem'.light_red, e.message)
 				rescue Exception => e
-					message('Error'.red, "#{e.message}")
+					message('Error'.red, e.message)
 				end
 			else
 				message('Error'.red, "'config.yml' file doesn't exist! @see 'reviser init'")
@@ -117,9 +107,11 @@ module Reviser
 				
 				Reviser::run
 			rescue Interrupt => i
-				message("...".yellow, "Bye bye")
+				puts 'Bye bye'
+			rescue Gem::LoadError => e
+				message('Missing gem'.yellow, e.message)
 			rescue Exception => e
-				message('Error'.red, "#{e.message}")
+				message('Error'.red, e.message)
 			end
 		end
 
@@ -134,7 +126,7 @@ module Reviser
 		#
 		desc 'add METH \'LABEL\'', 'Associates LABEL with METH analysis def'
 		def add meth, label
-			res = Helpers::Labels.add meth, label
+			res = Helpers::Criteria::Labels.add meth, label
 			message "#{res} label".green,meth + " => " + label
 		end
 
@@ -156,8 +148,29 @@ module Reviser
 
 				@@setup = true
 			end
+
+			# Initialize workspace copying all files et directories.
+			# @param dir Directory to init.
+			def init_workspace dir
+				# First copy directories
+				[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
+
+				# Then the config file
+				FileUtils.cp $template_path, dir
+				basename = File.basename($template_path)
+				message('Create', dir == '.' && basename || File.join(dir, basename))
+			end
+
 		end
 
 	end
 end
-Reviser::Exec.start(ARGV)
+Reviser::Exec.start(ARGV)

data/lib/reviser/component.rb

@@ -1,15 +1,15 @@
 #
-# Author:: Renan Strauss
+# The abstract class Component
+# Even though Ruby doesn't have abstract classes,
+# we force inheriting classes to implement the run
+# method that will be called during reviser's execution
+#
+# @author Renan Strauss
 #
-require 'yaml'
 require_relative 'loggers/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
@@ -46,10 +46,11 @@ module Reviser
 			data
 		end
 
+		#
 		# Be kind to our childs and let them access
 		# ressources files easily
 		#
-		# @returns The specified resource path
+		# @return 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
@@ -62,6 +63,7 @@ module Reviser
 	protected
 		#
 		# @return all options for all components if they exist in config file.
+		#
 		def options
 			Cfg[:options]
 		end

data/lib/reviser/components/checker.rb

@@ -1,10 +1,10 @@
 #
-# Author:: Renan Strauss
+# @author Renan Strauss
 #
 # The Checker is a component that wraps
 # all required tools to do the analysis.
 # It adapts itself dynamically
-# to the language Cfg.
+# to the configuration
 #
 #
 require 'open3'
@@ -25,8 +25,15 @@ module Reviser
 
 				@logger.h1 Logger::INFO, "Loading modules"
 
-				load CRITERIA
-				load EXTENSIONS
+				load_modules CRITERIA
+				load_modules EXTENSIONS
+
+				#
+				# We also load user-registered extensions if any
+				#
+				Reviser.registered_extensions.each do |ext|
+					load_module_methods ext
+				end
 
 				@logger.h1 Logger::INFO, "Loading labels"
 
@@ -35,9 +42,10 @@ module Reviser
 				@results = {}
 			end
 
-			# Yann : je ne recupere pas les datas de l'organiser,
-			# Je considere que tous les projets sont dans le dossier courant.
-			# TODO a voir si cela marche dans certains cas particuliers
+			#
+			# For each project processed by Organiser,
+			# we run analysis and store results
+			#
 			def run
 				@data.each_with_index do |proj, i|
 					path = File.join(Cfg[:dest], proj)

data/lib/reviser/components/extractors.rb

@@ -118,7 +118,8 @@ module Reviser
 			# @param seven_zip_file	[String] the 7zip file.
 			# @param destination 	[String] Destination of extracted data.
 			def seven_zip seven_zip_file, destination
-				require 'seven_zip_ruby'
+				require_gem 'seven_zip' unless defined? SevenZipRuby
+
 				File.open(seven_zip_file, 'rb') do |file|
 		  			SevenZipRuby::Reader.open(file) do |szr|
 		    			szr.extract_all destination

data/lib/reviser/components/generators.rb

@@ -50,7 +50,8 @@ module Reviser
 
 			# Generates a Excel file
 			def xls data, ext = '.xls'
-				require 'spreadsheet'
+				require_gem 'spreadsheet' unless defined? Spreadsheet
+
 				Spreadsheet.client_encoding = 'UTF-8'
 				book = Spreadsheet::Workbook.new
 				sheet = book.create_worksheet :name => 'Results'

data/lib/reviser/components/organiser.rb

@@ -1,7 +1,7 @@
 require 'fileutils'
-require_relative '../helpers/git'
-require_relative '../helpers/project'
+require 'rubygems'
 
+require_relative '../helpers/project'
 
 module Reviser
 	module Components
@@ -18,9 +18,6 @@ module Reviser
 		# @author Renan Strauss
 		#
 		class Organiser < Component
-
-			# Include all tools
-			include Helpers::Git
 			include Helpers::Project::Naming
 
 			# All entries to ignore during sort and organization
@@ -47,6 +44,14 @@ module Reviser
 
 				# How many patterns are in the pseudo-regex?
 				@count_patterns = {}
+
+				# Is git present ?
+				if Cfg[:create_git_repo]
+					require_gem 'git'
+					require_relative '../helpers/git'
+
+					self.class.send(:include, Helpers::Git)
+				end
 			end
 
 			# Renames directories more clearly.
@@ -131,8 +136,10 @@ module Reviser
 					@logger.h1 Logger::INFO, "Structure project"
 					structure entry
 
-					@logger.h1 Logger::INFO, "Initializing git repo"
-					git entry
+					if Cfg[:create_git_repo]
+						@logger.h1 Logger::INFO, "Initializing git repo"
+						git entry
+					end
 
 					@logger.h1 Logger::INFO, "Renaming directory"
 					new_path = rename entry

data/lib/reviser/config.rb

@@ -1,6 +1,9 @@
 #
-# @author Renan Strauss
 # Externalises the configuration
+# Cfg acts like a hash whose entries are config keys
+# associated with their values
+#
+# @author Renan Strauss
 #
 require 'yaml'
 
@@ -19,6 +22,9 @@ module Reviser
 		# Project's type dir
 		TYPE_DIR = 'type'
 
+		# The available out formats
+		OUT_FORMATS = [:csv, :html, :xls]
+
 		# Is the config is loaded ?
 		@@loaded = false
 
@@ -36,7 +42,7 @@ module Reviser
 		end
 
 		#
-		# @returns The specified resource path
+		# @return 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
@@ -90,6 +96,8 @@ module Reviser
 			Cfg[:program_prefix] ||= ''
 			Cfg[:execution_command] ||= ''
 			Cfg[:execution_count] ||= 1
+
+			Cfg[:create_git_repo] ||= false
 		end
 
 	private

data/lib/reviser/criteria/code_analysis.rb

@@ -1,5 +1,5 @@
 #
-# @Author Renan Strauss
+# @author Renan Strauss
 #
 # Basic stuff needed for Checker
 #

data/lib/reviser/criteria/compilation.rb

@@ -1,6 +1,6 @@
 #
-# @Author Yann Prono
-# @Author Renan Strauss
+# @author Yann Prono
+# @author Renan Strauss
 #
 # Needed stuff for compiled languages
 # such as C, Java, and so on.

data/lib/reviser/criteria/execution.rb

@@ -1,5 +1,5 @@
 #
-# @Author Renan Strauss
+# @author Renan Strauss
 #
 # Needed stuff for Checker
 # when it comes to executing

data/lib/reviser/helpers/criteria.rb

@@ -55,7 +55,7 @@ module Reviser
 					@logger.h1(Logger::INFO, "Include methods of #{@criteria[meth]}") unless respond_to? meth
 					self.class.send(:include, @criteria[meth]) unless respond_to? meth
 
-					send meth 
+					send meth
 				else
 					nil
 				end
@@ -81,7 +81,7 @@ module Reviser
 			# Load all of modules available for the analysis
 			# @param directory Directory where search of modules is done.
 			# @param regex regex to find name of modules.
-			def load directory, regex = '*'
+			def load_modules directory, regex = '*'
 				@logger.h2 Logger::INFO, "Modules of #{directory}"
 				modules =  Dir[File.join(directory, regex)]
 
@@ -89,13 +89,21 @@ module Reviser
 				modules.each do |m|
 					require_relative m
 					ext = File.extname m
-					module_name = Object.const_get "#{namespace}::#{camelize(File.basename(m,ext))}", false
-					@logger.h3 Logger::INFO, "Load #{module_name}"
-					methods = module_name.instance_methods false
-					methods.each { |method| populate(method, module_name) }
+					module_name = "#{namespace}::#{camelize(File.basename(m,ext))}"
+					
+					load_module_methods module_name
 		 		end	
 		 	end
 
+		 	def load_module_methods module_name
+					mod = Object.const_get module_name, false
+
+					@logger.h3 Logger::INFO, "Load #{module_name}"
+
+					methods = mod.instance_methods false
+					methods.each { |method| populate(method, mod) }
+		 	end
+
 			# Gets the name of module 
 			# @param file_module Name of the file module.
 			def camelize file_module
@@ -110,15 +118,8 @@ module Reviser
 
 				if Cfg.has_key?(key) && Cfg[key].respond_to?('each')
 					Cfg[key].each do |meth|
-						if meth.respond_to?('each') && meth.respond_to?('[]')
-							label =  meth[meth.keys[0]]
-							@logger.h2(Logger::ERROR, "Undefined label for #{meth.keys[0]}, check your config file") if label == nil
-							label = create_label(meth.keys[0]) if label == nil
-							@output[meth.keys[0].to_sym] = label
-						else
-							label = (labels.respond_to?('[]') && labels.key?(meth.to_sym)) ? labels[meth.to_sym] : create_label(meth)
-							@output[meth.to_sym] = label
-						end
+						label = ((labels.respond_to?('each') && labels.key?(meth.to_sym))) && labels[meth.to_sym] || create_label(meth)
+						@output[meth.to_sym] = label
 					end
 				end
 			end
@@ -130,58 +131,57 @@ module Reviser
 				@logger.h2 Logger::ERROR, "Create label for #{meth}. You should custom your label (see 'reviser add')"
 				meth.to_s.split('_').each {|s| s.capitalize! }.join(' ')
 			end
-		end
-
-
-		# Manage all actions for adding, updating or getting labels of Reviser.
-		# A label is a a group of words, describing the associated criterion (method).
-		#
-		# @example  
-		#  	criterion => label
-		# 	all_files => all files of project
-		#
-		# known Labels are in the labels.yml file.
-		#
-		# @author Yann Prono
-		class Labels
-
-			# Current directory of this file
-			PWD = File.dirname __FILE__
-
-			# Path of label.yml file
-			LABELS = File.join File.dirname(File.dirname(File.dirname(PWD))), 'labels.yml'
 
+			# Manage all actions for adding, updating or getting labels of Reviser.
+			# A label is a a group of words, describing the associated criterion (method).
+			#
+			# @example  
+			#  	criterion => label
+			# 	all_files => all files of project
+			#
+			# known Labels are in the labels.yml file.
 			#
-			# Enable to associate a label to a criterion (method).
-			# The label will be saved in the 'labels.yml' file
-			# @param meth Method to link.
-			# @param label Label to link with the method.
-		    def self.add meth, label
-		    	res = "Create"
-				labels = YAML.load File.open(LABELS)
-				if labels.respond_to? '[]'
-					res = "Update" if labels.key? meth
-					labels[meth] = label
-					File.open(LABELS, 'w') { |f| f.write labels.to_yaml }
+			# @author Yann Prono
+			module Labels
+
+				# Current directory of this file
+				PWD = File.dirname __FILE__
+
+				# Path of label.yml file
+				LABELS = File.join File.dirname(File.dirname(File.dirname(PWD))), 'labels.yml'
+
+				#
+				# Enable to associate a label to a criterion (method).
+				# The label will be saved in the 'labels.yml' file
+				# @param meth Method to link.
+				# @param label Label to link with the method.
+				def self.add meth, label
+					res = "Create"
+					labels = YAML.load File.open(LABELS)
+					if labels.respond_to? '[]'
+						res = "Update" if labels.key? meth
+						labels[meth] = label
+						File.open(LABELS, 'w') { |f| f.write labels.to_yaml }
+					end
+					res
 				end
-				res
-			end
 
-			# @return Hash all known labels by reviser.
-			# :criterion => label
-			def self.load
-				Labels.populate(YAML.load(File.open(LABELS)))
-			end
+				# @return Hash all known labels by reviser.
+				# :criterion => label
+				def self.load
+					Labels.populate(YAML.load(File.open(LABELS)))
+				end
 
-			def self.populate hash
-				labels = {}
-				if hash.respond_to?('each')
-					hash.each do |meth, label|
-						labels[meth.to_sym] = label
+				def self.populate hash
+					labels = {}
+					if hash.respond_to?('each')
+						hash.each do |meth, label|
+							labels[meth.to_sym] = label
+						end
 					end
+					labels
 				end
-				labels
 			end
-	  	end
+		end
 	end
 end

data/lib/reviser/helpers/git.rb

@@ -4,8 +4,6 @@
 # @author Romain Ruez
 # @author Anthony Cerf
 #
-require 'git'
-
 module Reviser
 	module Helpers
 		module Git

data/lib/reviser/helpers/project.rb

@@ -43,16 +43,23 @@ module Reviser
 				Dir.glob("**/*").select { |f| (File.file?(f)) }
 			end
 
+			#
+			# @return all the files matching the project's language extension(s)
+			#
 			def sources
 				files.select { |f| Cfg[:extension].include? File.extname(f) }
 			end
 
+			#
+			# Yields a new Result for the criteria
+			# to define an out value for each format
+			#
 			def manufacture &block
 				format = Result.new
 				block.call format
 
 				format
-			end
+			end		
 
 			# This modules is used to scan the name of project
 			# in order to get all students who worked.

data/lib/reviser/helpers/system.rb

@@ -1,4 +1,6 @@
 #
+# Wraps methods for system calls
+# (external programs execution)
 # @author Renan Strauss
 #
 require 'open3'
@@ -18,7 +20,7 @@ module Reviser
 			# Executes the given command
 			# and kills it if its execution
 			# time > timeout
-			# @returns stdout, stderr & process_status
+			# @return stdout, stderr & process_status
 			#
 			def exec_with_timeout(cmd, timeout = Cfg[:timeout])
 				stdin, stdout, stderr, wait_thr = Open3.popen3(cmd)

data/lib/reviser/result.rb

@@ -3,6 +3,8 @@
 # It allows us to easily output well-formatted results for certain output formats
 # (eg HTML)
 #
+# @author Renan Strauss
+#
 module Reviser
 	class Result
 		#
@@ -20,8 +22,13 @@ module Reviser
 
 		#
 		# Does the magic ;-)
+		# When the user calls a method whose name is a valid format,
+		# we associate it with the given block value if a block is given,
+		# else we return the stored value
 		#
 		def method_missing m, *args, &block
+			raise NoMethodError, "Unknown format #{m}" unless Cfg::OUT_FORMATS.include?(m)
+
 			format = "@#{m}".to_sym
 
 			block_given? && instance_variable_set(format, block[]) || instance_variable_get(format)

data/lib/reviser.rb

@@ -1,5 +1,5 @@
 #
-# Author:: Renan Strauss
+# @author Renan Strauss
 #
 # This class is basically here to give the user
 # a generic and comprehensive way to use and
@@ -10,18 +10,40 @@
 #
 require 'mkmf'
 require 'colorize'
+require 'rubygems'
 
 require_relative 'reviser/component'
 require_relative 'reviser/config'
 
-require_relative 'reviser/helpers/git'
 require_relative 'reviser/helpers/project'
-require_relative 'reviser/helpers/system'
+require_relative 'reviser/helpers/system'	
 
+#
+# Very handy (that's why it's in global scope)
+# Raises an exception unless the given gem is installed
+# Requires the gem if it is installed
+#
+def require_gem gem_name
+	unless Gem::Specification::find_all_by_name(gem_name).any?
+		raise Gem::LoadError, "#{gem_name}".yellow + " => ".white + "gem install #{gem_name}".magenta
+	end
+
+	require gem_name
+end
+
+#
+# The API entry point
+#
 module Reviser
 	class Reviser
 		@@setup = false
+
 		@@loaded_components = {}
+		@@registered_extensions = []
+
+		def self.registered_extensions
+			@@registered_extensions
+		end
 
 		#
 		# Adds an entry with the specified data.
@@ -39,7 +61,20 @@ module Reviser
 				:data => nil
 			}
 		end
+		
+		#
+		# Registers the specified extension
+		# (its methods will be available for analysis)
+		#
+		def self.register(data)
+			raise ArgumentError unless data.has_key?(:extension)
+
+			@@registered_extensions << data[:extension]
+		end
 
+		#
+		# Loads the configuration from given config_file
+		#
 		def self.setup(config_file)
 			Cfg.load config_file
 			@@setup = true

data/type/example/Labyrinthe.yml

@@ -12,15 +12,6 @@ preferred_build_command: make
 required_files:
 - !ruby/regexp '/(M|m)akefile/'
 
-#
-# The extensions you want
-# In this case, ext/valgrind.rb
-# must exist
-#
-extensions:
-  #valgrind:
-   - memleaks: Fuites memoire
-
 # For interpreted languages
 # execute_command: 
 

data/type/example/Web.yml

@@ -5,19 +5,4 @@ language: HTML
 #
 extension:
 - .html 
-- .css
-
-#
-# The criteria's extensions.
-# Here we're using web_validators
-#
-extensions:
-- validate_web
-
-#
-# Let's configure it!
-# We tell the extension to save analysis details files
-# it got from W3C validator, so that we can check those
-# files ourselves for analysis :-)
-#
-web_validators_save_results: true
+- .css

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reviser
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3.rc2
 platform: ruby
 authors:
 - Renan Strauss
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-27 00:00:00.000000000 Z
+date: 2015-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -33,26 +33,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.5
-- !ruby/object:Gem::Dependency
-  name: thor
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.19'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.19.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.19'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.19.1
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -74,59 +54,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.1.7
 - !ruby/object:Gem::Dependency
-  name: spreadsheet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.3
-- !ruby/object:Gem::Dependency
-  name: git
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0.19'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.9.1
+        version: 0.19.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0.19'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.9.1
-- !ruby/object:Gem::Dependency
-  name: w3c_validators
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 0.19.1
 description: A semi-automatic tool for student's projects evaluation
 email: renan.strauss@gmail.com
 executables:
@@ -134,6 +80,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - Gemfile
 - README.md
 - bin/reviser
@@ -184,7 +131,7 @@ files:
 - type/example/Labyrinthe.yml
 - type/example/Pendu.yml
 - type/example/Web.yml
-homepage: https://bitbucket.org/renan-/reviser
+homepage: http://rubygems.org/gems/reviser
 licenses:
 - GPL-3
 metadata: {}
@@ -199,9 +146,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5
@@ -209,3 +156,4 @@ signing_key:
 specification_version: 4
 summary: Reviser
 test_files: []
+has_rdoc: