reviser 0.0.3.1 → 0.0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47778f95556ef386df98ca2e951922cbf814d9c5
-  data.tar.gz: 3dfdcb68d7f82de0d32e500e46964b2411cbfa03
+  metadata.gz: ce478a2f380a88e5c081cf86228f34bd8d627ec7
+  data.tar.gz: f0220a06d2b6875f68cf57d44f4c73a1d856fd2f
 SHA512:
-  metadata.gz: 76db74d7c0fcefd3dce71721a2baa7c9d70f094cd69a354f8aa46b0d9d5a284e53d1cf2ce41703e1f95583fc8fbc6d895c6973ba9fb7b1678cd74c9459ee27eb
-  data.tar.gz: 4f43cb85efc0be84bd7db3f71b28803defb40fdd9b9ef8dc7a7b695b2306d090de59a56f7b9dbb14e6007431bc36d4db0dc83bc68c1b362ceb19693c31af05e9
+  metadata.gz: f0f697cab681a1e9850ade6eec9a96f1945320a50fad9559c3002cdaed84d0acb35044b7058ff387c98822faed0f0da774b773d86757bf2e5b69fcebc7040317
+  data.tar.gz: f8bd54b314d3390cda11409e1da27b9abe7d2fc43560aa2661802fa7af069fba225b8f210698e5a261ef7f13f3637b28d4f4cde4b2ce3c5336f07dd45acb6fec

data/README.md

@@ -61,11 +61,12 @@ Lives in *config.yml*.
 |*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)|
+|*create_git_repo*|Whether to create a git repository for each project or not (requires *git* gem)|Default `false`||
 |*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`||
+|*out_format*|The formats that will be generated|Default `csv` `html` (`xls` also available with *spreadsheet* gem)||
 |*options*|A hash to set options|`:verbose` `:log_dir` `:log_mode`||
 
 ###Project configuration
@@ -81,7 +82,7 @@ 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 *execution_count* or *1*. It can contains paths for files located in resources folder|||
 
 ###Labels configuration
 
@@ -104,7 +105,7 @@ 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`|
+|WebValidators|Validates HTML and CSS through W3C API calls|`validate_web`|
 
 ###Working on your own
 
@@ -114,8 +115,8 @@ You'll then need to load your components at the right time, and register your ex
 ####Custom components
 
 *example/my_component.rb*
-```
-#!ruby
+
+``` ruby
 require 'json'
 require 'reviser'
 
@@ -153,8 +154,8 @@ end
 ####Custom extensions
 
 *example/my_extension.rb*
-```
-#!ruby
+
+``` ruby
 #
 # A custom criteria for reviser
 #
@@ -206,15 +207,15 @@ end
 
 ### Putting it together
 *example/config.yml*
-```
-#!yaml
+
+``` yaml
 extensions:
   - my_criteria
 ```
 
 *example/my_app.rb*
-```
-#!ruby
+
+``` ruby
 require 'reviser'
 
 require_relative 'my_component'

data/lib/reviser/component.rb

@@ -21,15 +21,15 @@
 #
 require_relative 'loggers/logger'
 
-#
-# 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
-#
 module Reviser
+	#
+	# 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
+	#
 	class Component
 		#
 		# Don't forget to call super in your component's initializer !

data/lib/reviser/components/archiver.rb

@@ -25,7 +25,7 @@ require_relative 'extractors'
 
 module Reviser
 	module Components
-
+		#
 		# Manages uncompression of archive.
 		# Archiver extracts all data in a given compressed file.
 		#
@@ -112,6 +112,7 @@ module Reviser
 				extracted = 0
 
 				entries.each do |entry|
+					puts "----[#{extracted+1}/#{entries.size}]\t#{entry}"
 
 					ext = File.extname entry
 					basename = File.basename entry, ext

data/lib/reviser/components/checker.rb

@@ -24,17 +24,17 @@ 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
+		#
+		# @author Renan Strauss
+		#
+		# The Checker is a component that wraps
+		# all required tools to do the analysis.
+		# It adapts itself dynamically
+		# to the configuration
+		#
+		#
 		class Checker < Component
 			include Helpers::Criteria
 
@@ -70,7 +70,7 @@ module Reviser
 			def run
 				@data.each_with_index do |proj, i|
 					path = File.join(Cfg[:dest], proj)
-					puts "\t[#{i+1}/#{@data.size}]\t#{proj}"
+					puts "----[#{i+1}/#{@data.size}]\t#{proj}"
 					Dir.chdir(path) { check proj }
 				end
 		

data/lib/reviser/components/extractors.rb

@@ -24,7 +24,7 @@ require 'fileutils'
 
 module Reviser
 	module Components
-
+		#
 		# The module contains all methods to extract an archive
 		# regardless the format.
 		#

data/lib/reviser/components/generator.rb

@@ -24,7 +24,7 @@ require_relative '../result'
 
 module Reviser
 	module Components
-
+		#
 		# Generator is used to create a file result after the analysis.
 		# Currently, Generator supports HTML, XLS and CSV format.
 		#
@@ -43,9 +43,12 @@ module Reviser
 			# Runs the generation of results file in all asked formats by user.
 			def run
 				#begin
+					i = 0
 					Cfg[:out_format].each do |format|
 						# Deep copy !!!
 						arg = Marshal.load(Marshal.dump(@data))
+
+						puts "----[#{i+1}/#{Cfg[:out_format].size}] #{format.upcase}"
 						arg.each do |project, results|
 							results.each do |criterion, value|
 								arg[project][criterion] = value.send(format.to_sym).to_s.encode! 'utf-8', :invalid => :replace
@@ -53,6 +56,8 @@ module Reviser
 						end
 
 						send format.to_sym, arg
+
+						i += 1
 					end
 				#rescue Object => e
 				#	@logger.h1 Logger::FATAL, "Wrong format : #{e.to_s}"

data/lib/reviser/components/generators.rb

@@ -21,7 +21,7 @@
 #
 module Reviser
 	module Components
-
+		#
 		# Module containing all methods for writing results.
 		#
 		# Convention over configuration !

data/lib/reviser/components/organiser.rb

@@ -26,7 +26,7 @@ require_relative '../helpers/project'
 
 module Reviser
 	module Components
-
+		#
 		# Class which organizes all directories to simplify projects' analysis.
 		# Organiser renames projects folders and organises the whole of projects
 		# in order to have a structured folder (files at the root of folder)
@@ -92,7 +92,7 @@ module Reviser
 				else
 					@logger.h2 Logger::ERROR, "Can't rename #{File.basename(entry)} - Datas not found in name"
 				end
-				name
+				@results << name
 			end
 
 			# Method which moves project's directories in order to
@@ -152,21 +152,17 @@ module Reviser
 			# Method which runs the organiser.
 			# It will apply all importants methods of this class for each project.
 			def run
-				@data.each do |entry|
-					
-					@logger.h1 Logger::INFO, "Work on #{entry}"
-					@logger.h1 Logger::INFO, "Structure project"
-					structure entry
-
-					if Cfg[:create_git_repo]
-						@logger.h1 Logger::INFO, "Initializing git repo"
-						git entry
+				to_do = [:structure, :git, :rename]
+				to_do.delete(:git) unless Cfg[:create_git_repo]
+
+				i = 0
+				to_do.each do |method|
+					puts "----[#{i+1}/#{to_do.size}] #{method.capitalize}"
+					@logger.h1 Logger::INFO, "#{method.capitalize}"
+					@data.each do |entry|
+						send method, entry
 					end
-
-					@logger.h1 Logger::INFO, "Renaming directory"
-					new_path = rename entry
-					@logger.newline
-					@results << new_path
+					i += 1
 				end
 
 				@logger.h1 Logger::INFO, "#{@projects_per_group.keys.size} group#{'s' if @projects_per_group.keys.size > 1} have been detected"

data/lib/reviser/config.rb

@@ -1,5 +1,5 @@
 #
-#   Reviser => a semi-automatic tool for student's projects evaluation
+#   Reviser => a semi-automatic tool for students projects evaluation
 #
 #   Copyright (C) 2015 Renan Strauss
 #   Copyright (C) 2015 Yann Prono
@@ -21,14 +21,14 @@
 #
 require 'yaml'
 
-#
-# Externalises the configuration
-# Cfg acts like a hash whose entries are config keys
-# associated with their values
-#
-# @author Renan Strauss
-#
 module Reviser
+	#
+	# Externalises the configuration
+	# Cfg acts like a hash whose entries are config keys
+	# associated with their values
+	#
+	# @author Renan Strauss
+	#
 	class Cfg
 		# Path for specialized config files for projects
 		ROOT = File.join(File.dirname(File.dirname(File.dirname(__FILE__))))
@@ -60,6 +60,14 @@ module Reviser
 		# @return true if there is the key in the config
 		def self.has_key?(key)
 			@@mem.has_key? key
+
+		end
+
+		#
+		# @return The specified 
+		def self.workspace_file f
+			path = File.join @@workspace_root, f
+			File.exists?(path) && File.new(path) || nil
 		end
 
 		#
@@ -70,8 +78,7 @@ module Reviser
 		# calling this method
 		#
 		def self.resource path
-			abs = File.join @@workspace_root, RES_DIR, path
-			File.new abs if File.exists? abs
+			self.workspace_file File.join(RES_DIR, path)
 		end
 
 
@@ -111,7 +118,7 @@ module Reviser
 			Cfg[:options] ||= { verbose: true, log_dir:'logs', log_mode: 'org' }
 			Cfg[:timeout] ||= 4
 			Cfg[:out] ||= 'results'
-			Cfg[:out_format] ||= ['html', 'csv', 'xls']
+			Cfg[:out_format] ||= ['csv', 'html']
 			Cfg[:required_files] ||= []
 
 			Cfg[:program_prefix] ||= ''

data/lib/reviser/criteria/code_analysis.rb

@@ -20,13 +20,13 @@
 #   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-#
-# @author Renan Strauss
-#
-# Basic criteria
-#
 module Reviser
 	module Criteria
+		#
+		# @author Renan Strauss
+		#
+		# Basic criteria
+		#
 		module CodeAnalysis
 			include Helpers::Project
 

data/lib/reviser/criteria/compilation.rb

@@ -20,15 +20,15 @@
 #   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-#
-# @author Yann Prono
-# @author Renan Strauss
-#
-# Needed stuff for compiled languages
-# such as C, Java, and so on.
-#
 module Reviser
 	module Criteria
+		#
+		# @author Yann Prono
+		# @author Renan Strauss
+		#
+		# Needed stuff for compiled languages
+		# such as C, Java, and so on.
+		#
 		module Compilation
 			include Helpers::System
 			

data/lib/reviser/criteria/execution.rb

@@ -21,16 +21,16 @@
 #
 require 'timeout'
 
-#
-# @author Renan Strauss
-#
-# Needed stuff for Checker
-# when it comes to executing
-# both compiled and interpreted
-# languages
-#
 module Reviser
 	module Criteria
+		#
+		# @author Renan Strauss
+		#
+		# Needed stuff for Checker
+		# when it comes to executing
+		# both compiled and interpreted
+		# languages
+		#
 		module Execution
 			#
 			# Determines how to execute the program

data/lib/reviser/exec.rb

@@ -26,26 +26,23 @@ require 'colorize'
 require_relative '../reviser'
 require_relative 'helpers/criteria'
 
-#
-# Module used for managing all actions in command line
-# This module enables to user the programm in command line.
-# It use the powerful toolkit Thor for building command line interfaces
-#
-# @author Yann Prono
-#
 module Reviser
+	#
+	# Class used for managing all actions in command line
+	# This class enables the user to interact with the programm in command line.
+	# It use the powerful toolkit Thor for building command line interfaces
+	#
+	# @author Yann Prono
+	#
 	class Exec < Thor
 
-		VERSION = '0.0.3.1'
+		VERSION = '0.0.3.3'
 
 		map '--version' => :version
 		map '-v' => :version
 
 		@@setup = false
 
-		# path of config template file.
-		$template_path = File.join(Cfg::ROOT, 'config.yml')
-
 		def initialize(*args)
 			super
 			# If config.yml already exists in the working
@@ -61,7 +58,7 @@ module Reviser
 			# Import all files and directories
 			init_workspace dir
 			
-			setup File.expand_path(File.join(dir, File.basename($template_path))) unless @@setup
+			setup File.expand_path(File.join(dir, 'config.yml')) unless @@setup
 
 			puts "Customize config.yml to your needs @see docs".yellow
 			puts 'Then simply execute \'reviser work\' to launch analysis.'.yellow
@@ -172,6 +169,8 @@ module Reviser
 			# Initialize workspace copying all files et directories.
 			# @param dir Directory to init.
 			def init_workspace dir
+				FileUtils.mkdir dir unless File.directory? dir
+
 				# First copy directories
 				[Cfg::RES_DIR, Cfg::TYPE_DIR].each do |d|
 					path = File.join(Cfg::ROOT, d)
@@ -184,9 +183,10 @@ module Reviser
 				end
 
 				# Then the config file
-				FileUtils.cp $template_path, dir
-				basename = File.basename($template_path)
-				message('Create', dir == '.' && basename || File.join(dir, basename))
+				['config.yml', 'labels.yml'].each do |tpl|
+					FileUtils.cp File.join(Cfg::ROOT, tpl), dir
+					message('Create', dir == '.' && tpl || File.join(dir, tpl))
+				end
 			end
 
 		end

data/lib/reviser/helpers/criteria.rb

@@ -58,7 +58,7 @@ module Reviser
 			# Path of criteria
 			CRITERIA = File.join File.dirname(PWD), 'criteria'
 			# Path of extensions
-			EXTENSIONS = File.join File.dirname(File.dirname(File.dirname(PWD))), 'ext'
+			EXTENSIONS = File.join Cfg::ROOT, 'ext'
 
 			attr_reader :criteria
 			attr_reader :output
@@ -166,12 +166,8 @@ module Reviser
 			#
 			# @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'
+				LABELS = 'labels.yml'
 
 				#
 				# Enable to associate a label to a criterion (method).
@@ -180,7 +176,7 @@ module Reviser
 				# @param label Label to link with the method.
 				def self.add meth, label
 					res = "Create"
-					labels = YAML.load File.open(LABELS)
+					labels = YAML.load File.read(Cfg.workspace_file LABELS)
 					if labels.respond_to? '[]'
 						res = "Update" if labels.key? meth
 						labels[meth] = label
@@ -192,7 +188,7 @@ module Reviser
 				# @return Hash all known labels by reviser.
 				# :criterion => label
 				def self.load
-					Labels.populate(YAML.load(File.open(LABELS)))
+					self.populate YAML.load File.read(Cfg.workspace_file LABELS)
 				end
 
 				def self.populate hash

data/lib/reviser/helpers/project.rb

@@ -21,15 +21,15 @@
 #
 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
+		#
+		# Provide useful methods for projects evaluation
+		# as well as a naming module for custom regexes
+		#
+		# @author Renan Strauss
+		# @author Yann Prono
+		#
 		module Project
 			#
 			# For interpreted languages
@@ -88,7 +88,6 @@ module Reviser
 			#
 			# @author Yann Prono
 			#
-
 			module Naming
 
 				# Dictionnary for regex in config file

data/lib/reviser/helpers/system.rb

@@ -22,14 +22,13 @@
 require 'open3'
 require 'timeout'
 
-
-#
-# Wraps methods for system calls
-# (external programs execution)
-# @author Renan Strauss
-#
 module Reviser
 	module Helpers
+		#
+		# Wraps methods for system calls
+		# (external programs execution)
+		# @author Renan Strauss
+		#
 		module System
 			#
 			# @return the first executable found

data/lib/reviser/result.rb

@@ -20,14 +20,14 @@
 #   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-#
-# This class represents an analysis result
-# It allows us to easily output well-formatted results for certain output formats
-# (eg HTML)
-#
-# @author Renan Strauss
-#
 module Reviser
+	#
+	# This class represents an analysis result
+	# It allows us to easily output well-formatted results for certain output formats
+	# (eg HTML)
+	#
+	# @author Renan Strauss
+	#
 	class Result
 		#
 		# In case no call to manufacture was made,

data/lib/reviser.rb

@@ -42,18 +42,18 @@ def require_gem gem_name
 	require gem_name
 end
 
-#
-# @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
+	#
+	# @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.
+	#
 	class Reviser
 		@@setup = false
 
@@ -115,7 +115,7 @@ module Reviser
 			# let users load their own components
 			#
 			@@loaded_components.each do |comp, conf|
-				puts "Reviser is now running "+"#{Reviser.titleize comp}".green + "..."
+				puts "[ " + "Running ".yellow + "#{Reviser.titleize comp}".blue + " ]"
 
 				require_relative "reviser/components/#{comp}" unless conf[:local]
 
@@ -126,7 +126,7 @@ module Reviser
 
 				@@loaded_components[comp][:data] = c.work
 				
-				puts 'Done'
+				puts "[ " + "Done".green + " ]"
 			end
 
 			# To handle multiple loads

data/res/example/labfich11.txt

@@ -0,0 +1,19 @@
+62 18
+**************************************************************
+*  *                *                     *            *     *
+*      *    *       *    *    ******             *           *
+E  **********  ******  *****       ******************* *******
+*           *       *    *    *                     *        S
+*******  *******    ************************** *********** ***
+*        *     *        *      *            *           *    *
+*  *******  *  *    *   *      *     ****************   *    *
+*  *   *    ** ******   *      *                *   *   *    *
+*  *   ***  *       *   *    ***** **********                *
+*  *        *       *   *       *      *    ******************
+* ** ****** *  ***  *** *    *         *    *            *   *
+*    *    *    *    *   ***  *****************************   *
+*    *  * ***********    *   *   *          *      *         *
+*       *      *    *** **** *   *    *     *   *        *   S
+***********  ***** **        *   *********  *   **********   *
+*                   *   *                   *            *   *
+***E**********************************************************

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reviser
 version: !ruby/object:Gem::Version
-  version: 0.0.3.1
+  version: 0.0.3.3
 platform: ruby
 authors:
 - Renan Strauss
@@ -117,6 +117,7 @@ files:
 - res/css/normalize.css
 - res/css/style_logs.css
 - res/example/data.json
+- res/example/labfich11.txt
 - res/scss/style_logs.scss
 - type/example/CProject.yml
 - type/example/HelloWorldRuby.yml