reviser 0.0.1.1.pre.beta → 0.0.2.rc1

data/lib/config.rb

@@ -4,45 +4,63 @@
 #
 require 'yaml'
 
-class Cfg
-	# Path for specialized config files for projects
-	ROOT = File.join(File.dirname(File.dirname(__FILE__)))
+module Reviser
+	class Cfg
+		# Path for specialized config files for projects
+		ROOT = File.join(File.dirname(File.dirname(__FILE__)))
 
-	# Is the config is loaded ?
-	@@loaded = false
+		# Is the config is loaded ?
+		@@loaded = false
 
-	def self.[](key)
-    	@@mem[key] if @@loaded
-	end
+		def self.[](key)
+	    @@mem[key] if @@loaded
+		end
 
-	# @return true if there is the key in the config
-	def self.has_key?(key)
-		@@mem.has_key? key
-	end
+		def self.[]=(key, value)
+			@@mem[key] = value if @@loaded
+		end
 
-	# Method class alias
-	# might remove this at some point ( sorry Yannou I know u worked hard :( )
-	self.singleton_class.send(:alias_method, :=~, :has_key?)
-
-	def self.load(cfg_file)
-		@@loaded = true
-		@@mem = {}
-
-		populate YAML.load(File.read(cfg_file))
-		type_file = File.join(ROOT,'type',"#{@@mem[:type]}.yml")
-		type_cfg  = YAML.load(File.read(type_file))
-		populate YAML.load(File.read(File.join(ROOT,'lang',"#{type_cfg['language']}.yml")))
-		# So that project's type Cfg overrides
-		# lang Cfg
-		populate type_cfg
-	end
+		# @return true if there is the key in the config
+		def self.has_key?(key)
+			@@mem.has_key? key
+		end
+
+		#
+		# @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 self.resource path
+			abs = File.join(ROOT, Cfg[:res_dir], path)
+			File.new abs if File.exists? abs
+		end
+
+		# Method class alias
+		# might remove this at some point ( sorry Yannou I know u worked hard :( )
+		self.singleton_class.send(:alias_method, :=~, :has_key?)
+
+		def self.load(cfg_file)
+			@@loaded = true
+			@@mem = {}
+
+			populate YAML.load(File.read(cfg_file))
+			type_file = File.join(ROOT,'type',"#{@@mem[:type]}.yml")
+			type_cfg  = YAML.load(File.read(type_file))
+			populate YAML.load(File.read(File.join(ROOT,'lang',"#{type_cfg['language']}.yml")))
+			# So that project's type Cfg overrides
+			# lang Cfg
+			populate type_cfg
+		end
 
-private
-	#
-	# Handy method to convert string keys
-	# read from Cfg file to symbols
-	#
-	def self.populate(hash)
-		hash.each { |k, v| @@mem[k.to_sym] = v}
+	private
+		#
+		# Handy method to convert string keys
+		# read from Cfg file to symbols
+		#
+		def self.populate(hash)
+			hash.each { |k, v| @@mem[k.to_sym] = v}
+		end
 	end
 end

data/lib/criteria/code_analysis.rb

@@ -0,0 +1,54 @@
+#
+# @Author Renan Strauss
+#
+# Basic stuff needed for Checker
+#
+
+module Reviser
+	module Criteria
+		module CodeAnalysis
+			include Helpers::Project
+
+			def all_files
+				files.join("\r")
+			end
+
+			#
+			# @return all files matching the 
+			# 		  extenstion language list (note that Cfg[:extension] must be an array)
+			#
+			def src_files
+				sources.join("\r")
+			end
+
+			#
+			# @return the total amount of lines of code
+			#
+			def lines_count
+				count = sources.inject(0) { |sum, f|
+					sum + File.open(f).readlines.select { |l| !l.chomp.empty? }.size
+				}
+
+				count - comments_count # FIXME
+			end
+
+			#
+			# @return the number of lines of comments
+			#
+			def comments_count
+				tab_comments = sources.inject([]) { |t, f| t << IO.read(f).scrub.scan(Cfg[:regex_comments]) }
+				lines = tab_comments.inject('') { |s, comm| s << find_comments(comm) }.split "\n"
+
+				lines.size
+			end
+
+			#
+			# Translates a sub-match returned by scan
+			# into raw comments string
+			#
+			def find_comments(comm)
+				comm.inject('') { |t, l| t << l.detect { |a| (a != nil) && !a.strip.empty? } + "\n" }
+			end
+		end
+	end
+end

data/lib/criteria/compilation.rb

@@ -0,0 +1,42 @@
+#
+# @Author Yann Prono
+# @Author Renan Strauss
+#
+# Needed stuff for compiled languages
+# such as C, Java, and so on.
+#
+
+module Reviser
+	module Criteria
+		module Compilation
+			include Helpers::Project
+			include Helpers::System
+			
+			#
+			# Only here for compiled language,
+			#
+			def compile
+				#
+				# For now, we compile only if there's
+				# no missing file
+				# We should maybe make it more
+				# understandable in the Cfg
+				#
+				if missing_files.empty?
+					cmd = "#{Cfg[(Cfg.has_key? :preferred_build_command) && :preferred_build_command || :default_build_command]}"
+					out = exec_with_timeout cmd
+
+					if out.has_key? :process_status
+						return "Exit status: 0\r#{out[:stdout]}" unless out[:process_status].exitstatus != 0
+					end
+
+					if Cfg.has_key? :preferred_build_command
+						out = exec_with_timeout Cfg[:default_build_command]
+					end
+
+					(out[:process_status].exitstatus == 0) ? "Exit status: 0\r#{out[:stdout]}" : "#{out[:stdout]}\r#{out[:stderr]}"
+				end
+			end
+		end
+	end
+end

data/lib/criteria/execution.rb

@@ -0,0 +1,78 @@
+#
+# @Author Renan Strauss
+#
+# Needed stuff for Checker
+# when it comes to executing
+# both compiled and interpreted
+# languages
+#
+
+require 'timeout'
+
+module Reviser
+	module Criteria
+		module Execution
+			#
+			# Determines how to execute the program
+			# thanks to Cfg, then returns its exec
+			# status(es)
+			#
+			def execute
+				outputs = []
+				if  Cfg.has_key? :execution_value
+					if Cfg[:execution_value].respond_to? 'each'
+						Cfg[:execution_value].each do |v|
+							outputs << exec(v)
+						end
+					else
+						if Cfg.has_key? :execution_count
+							outputs[Cfg[:execution_value]] = []
+							Cfg[:execution_count].times do
+								outputs << exec(Cfg[:execution_value])
+							end
+						else
+							outputs << exec(Cfg[:execution_value])
+						end
+					end
+				else
+						if Cfg.has_key? :execution_count
+							Cfg[:execution_count].times do
+								outputs << exec
+							end
+						else
+							return exec
+						end
+				end
+
+				outputs.join("\r")
+			end
+
+		private
+
+			#
+			# The method that actually
+			# executes the program.
+			# If no program name is specified
+			# in the Cfg, it executes the
+			# first executable found.
+			# It helps with C (a.out) when no 
+			# Makefile is avalaible, but it
+			# might not be a good idea regarding
+			# security
+			#
+			def exec(param = nil)
+				program = (Cfg.has_key? :program_name) && Cfg[:program_name] || find_executable
+
+				return 'Program not found' unless program != nil
+
+				program = "#{Cfg[:program_prefix]}#{program}"
+				argument = (param == nil) && '' || param
+
+				cmd = "#{(Cfg.has_key? :execute_command) && Cfg[:execute_command] || ''} #{program} #{argument}"
+				out = exec_with_timeout cmd
+				
+				"$ #{cmd}\r#{out[:stdout]}\r#{out[:stderr]}"
+			end
+		end
+	end
+end

data/lib/exec.rb

@@ -1,5 +1,6 @@
 require 'thor'
 require 'fileutils'
+require 'colorize'
 
 require_relative 'reviser'
 require_relative 'helpers/criteria'
@@ -7,130 +8,144 @@ 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
+# It use the powerful toolkit Thor for building command line interfaces
 #
 # @author Yann Prono
 #
-class Exec < Thor
+module Reviser
+	class Exec < Thor
 
-	@@setup = false
+		VERSION = '0.0.1.1'
 
-	# path of config template file.
-	$template_path = File.join(File.dirname(File.dirname(__FILE__)),'config.yml')
+		map '--version' => :version
+		map '-v' => :version
 
-	def initialize(*args)
-		super
-		# 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
-	end
+		@@setup = false
 
+		# path of config template file.
+		$template_path = File.join(File.dirname(File.dirname(__FILE__)),'config.yml')
 
-	# Say hello to the user !
-	desc 'hello','Say hello to the user !'
-	def hello
-		puts 'Hello, I am reviser'
-	end
+		def initialize(*args)
+			super
+			# 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
+		end
 
 
-	# Create a environnment for checking projects
-	# This method only copies the config file into the current directory.
-	desc 'init DIRECTORY', 'Create a new App project. By default,DIRECTORY is the current.'
-	def init(dir = '.')
-		pwd = FileUtils.pwd
-		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))
+		# 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
+			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
-	end
+	    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 
 
-	# Clean the directory of logs, projects and results.
-	desc 'clean', 'Delete datas creating by the App (logs, projects, results files ...).'
-	def clean
-		if File.exist? 'config.yml'
-			FileUtils.rm_rf(Cfg[:dest], :verbose => true)
-			if Cfg.has_key?(:options) && Cfg[:options].has_key?(:log_dir)
-				FileUtils.rm_rf(Cfg[:options][:log_dir], :verbose => true)
-			else
-				FileUtils.rm_f(Dir['*.txt'], :verbose => true)
-			end
-
-			if Cfg[:out_format].respond_to? 'each'
-				Cfg[:out_format].each { |format| FileUtils.rm_f(Dir["*.#{format}"], :verbose => true) }
-			else
-				FileUtils.rm_f(Dir["*.#{Cfg[:out_format]}"], :verbose => true)
+				message('Create', File.join(dir, Cfg[:res_dir]))
 			end
 
-			FileUtils.rm_rf(Cfg[:res_dir], :verbose => true)
-		else
-			message("Error", "'config.yml' doesn't exist! Check if you are in the good directory.")
+			puts "Customize config.yml to your needs @see docs".yellow
+			puts 'Then simply execute \'reviser work\' to launch analysis.'.yellow
 		end
 
-	end
 
+		# Clean the directory of logs, projects and results.
+		desc 'clean', 'Remove generated files (logs, projects, results files ...)'
+		def clean
+			if File.exist? 'config.yml'
+				FileUtils.rm_rf(Cfg[:dest], :verbose => true)
+				if Cfg.has_key?(:options) && Cfg[:options].has_key?(:log_dir)
+					FileUtils.rm_rf(Cfg[:options][:log_dir], :verbose => true)
+				else
+					FileUtils.rm_f(Dir['*.txt'], :verbose => true)
+				end
+
+				if Cfg[:out_format].respond_to? 'each'
+					Cfg[:out_format].each { |format| FileUtils.rm_f(Dir["*.#{format}"], :verbose => true) }
+				else
+					FileUtils.rm_f(Dir["*.#{Cfg[:out_format]}"], :verbose => true)
+				end
+
+				# We shall not delete it because the user is likely to
+				# add his own files and doesn't want to lose them every
+				# single time
+				#FileUtils.rm_rf(Cfg[:res_dir], :verbose => true)
+			else
+				message("Error".red, "'config.yml' doesn't exist! Check if you are in the good directory.")
+			end
 
-	# 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.'
-	def work
-		Reviser::load :component => 'archiver'
-		Reviser::load :component => 'organiser', :inputFrom => 'archiver'
-		Reviser::load :component => 'checker', :inputFrom => 'organiser'
-		Reviser::load :component => 'generator', :inputFrom => 'checker'
+		end
 
-		Reviser::run
-	end
 
-	# Launch archiver !
-	desc 'extract', 'Launch archiver and extract all projects.'
-	def extract
-		Reviser::load :component => 'archiver'
-		Reviser::run
-	end
+		# 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'
+		def work
 
-	# Launch organiser !
-	desc 'organise', 'Launch organiser and prepare all projects for analysis'
-	def organise
-		Reviser::load :component => 'organiser'
-		Reviser::run
-	end
+			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'
 
-	# Launch checker and generator as well !
-	desc 'check', 'Launch checker for analysis and generate results.'
-	def check
-		Reviser::load :component => 'checker'
-		Reviser::load :component => 'generator', :inputFrom => 'checker'
-		Reviser::run
-	end
+				Reviser::run
+			else
+				message('Error'.red, "'config.yml' file doesn't exist! @see 'reviser init'")
+			end
+		end
 
-	# For the moment, associate a label to a criterion (method).
-	desc 'add METH "LABEL" ', 'Add to the method METH a associated LABEL'
-	def add meth, label
-		res = Criteria::Labels.add meth, label
-		message "#{res} label",meth + " => " + label
-	end
+		desc 'extract', 'Extract and organise all computing projects'
+		def extract
+			Reviser::load :component => 'archiver'
+			Reviser::load :component => 'organiser', :inputFrom => 'archiver'
+			
+			Reviser::run
+		end
 
+		#
+		# For the moment, associate a label to a criterion (method).
+		#
+		# Cette methode me fait penser qu'on devrait vraiment configurer
+		# le dossier de base ici, et le passer dans la config parce que,
+		# par defaut, les modifs sur le fichier labels.yml seront faites
+		# sur le fichier labels.yml dans le dossier ou est le programme,
+		# et non dans le dossier ou travaille l'utilisateur
+		#
+		desc 'add METH \'LABEL\'', 'Associates LABEL with METH analysis def'
+		def add meth, label
+			res = Helpers::Labels.add meth, label
+			message "#{res} label".green,meth + " => " + label
+		end
 
-	no_tasks do
-  		# A Formatter message for command line
-  		def message(keyword, desc)
-  			puts "\t#{keyword}\t\t#{desc}"
+		desc 'version', 'Print out version information'
+		def version
+			puts "Reviser #{VERSION}"
+			puts 'Released under the MIT License.'
 		end
 
-		def setup(config_file)
-			Reviser::setup config_file
 
-			path_res = File.join(File.dirname(File.dirname(__FILE__)),"#{Cfg[:res_dir]}")
-			FileUtils.cp_r(path_res, FileUtils.pwd)
+		no_tasks do
+	  		# A Formatter message for command line
+	  		def message(keyword, desc)
+	  			puts "\t#{keyword}\t\t#{desc}"
+			end
+
+			def setup(config_file)
+				Reviser::setup config_file
 
-			@@setup = true
+				@@setup = true
+			end
 		end
-	end
 
+	end
 end
-
-Exec.start(ARGV)
+Reviser::Exec.start(ARGV)