RubyGems - reviser - Versions diffs - 0.0.1.1.pre.beta - Mend

reviser 0.0.1.1.pre.beta

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (38) hide show

checksums.yaml +7 -0
data/bin/reviser +6 -0
data/config.yml +80 -0
data/ext/html_validator.rb +21 -0
data/ext/valgrind.rb +24 -0
data/labels.yml +8 -0
data/lang/C.yml +22 -0
data/lang/HTML.yml +49 -0
data/lang/Java.yml +15 -0
data/lang/Ruby.yml +26 -0
data/lib/component.rb +53 -0
data/lib/components/archiver.rb +118 -0
data/lib/components/checker.rb +78 -0
data/lib/components/extractors.rb +139 -0
data/lib/components/generator.rb +47 -0
data/lib/components/generators.rb +130 -0
data/lib/components/organiser.rb +181 -0
data/lib/config.rb +48 -0
data/lib/exec.rb +136 -0
data/lib/helpers/code_analysis.rb +64 -0
data/lib/helpers/compilation.rb +40 -0
data/lib/helpers/criteria.rb +186 -0
data/lib/helpers/execution.rb +83 -0
data/lib/helpers/git.rb +37 -0
data/lib/helpers/project.rb +39 -0
data/lib/helpers/system.rb +56 -0
data/lib/loggers/logger.rb +41 -0
data/lib/loggers/modes.rb +74 -0
data/lib/project.rb +155 -0
data/lib/reviser.rb +68 -0
data/res/css/component.css +115 -0
data/res/css/normalize.css +1 -0
data/res/js/jquery.stickyheader.js +149 -0
data/type/CProject.yml +32 -0
data/type/HelloWorldRuby.yml +2 -0
data/type/HtmlASRALL.yml +1 -0
data/type/Labyrinthe.yml +42 -0
metadata +83 -0

data/lib/components/generator.rb ADDED Viewed

@@ -0,0 +1,47 @@
+require_relative 'generators'
+module Components
+	# Generator is used to create a file result after the analysis.
+	# Currently, Generator supports HTML, XLS and CSV format.
+	#
+	# @author 	Renan Strauss
+	# @author 	Yann Prono
+	#
+	class Generator < Component
+		# Include all supported formats
+		include Generators
+		def initialize(data)
+			super data
+		end
+		# Run the generation of results file in all asked formats by user.
+		def run
+			begin
+				if Cfg[:out_format].respond_to? 'each'
+					Cfg[:out_format].each { |f| send f.to_sym }
+				else
+					send Cfg[:out_format].to_sym
+				end
+			rescue Object => e
+				@logger.h1 Logger::FATAL, "Wrong format : #{e.to_s}"
+			end
+		end
+		# Get all criterias of marking
+		# used to display informations in documents.
+		# @return [Array] Array with all criterias.
+		def criterias
+			@data.values.first.keys.unshift.map! { |cri| Generator.titleize(cri.to_s) }
+		end
+		# Quite handy
+		def self.titleize(str)
+			str.split(/_/).join(' ').capitalize
+		end
+	end
+end

data/lib/components/generators.rb ADDED Viewed

@@ -0,0 +1,130 @@
+# Module containing all methods for writing results.
+#
+# Convention over configuration !
+#
+# To add a new format, you need maybe to install a gem.
+# Find a gem which supports a specified format on rubygems.org.
+# Add the line "gem <gem>" in the Gemfile and execute "bundle install"
+#
+# Now, you can write the method corresponding to the format.
+# The name of the method corresponds to the format.
+# For example, if you want to generate a word file (.doc), the name of the method will be: "doc"
+# Don't forget to require the gem: "require <gem>" at the beginning of the method !
+# the header of method looks like the following block:
+#
+#  		def <format> (ext = '<format>')
+# 			require <gem>
+# 			...
+# 		end
+#
+# To write results, you have to go through in the data instance variable.
+# data is a [Hash]:
+# 		- key: 		The person's name.
+#		- value: 	Results of analysis
+#
+# Each value of data is also a [Hash]:
+# 		- key: 		the name of criterion checked.
+#		- value: 	The result of criterion.
+#
+#
+# @author Renan Strauss
+# @author Yann Prono
+#
+module Components
+	module Generators
+		# Generates the CSV file
+		def csv(ext = '.csv')
+			require 'csv'
+			CSV.open(out(ext), 'wb') do |f|
+				# Criterias as columns
+				f << (criterias).unshift('projet')
+				# Values for each project as rows
+				@data.keys.each do |proj|
+					f << @data[proj].values.unshift(proj)
+				end
+			end
+		end
+		# Generates a Excel file
+		def xls(ext = '.xls')
+			require 'spreadsheet'
+			Spreadsheet.client_encoding = 'UTF-8'
+			book = Spreadsheet::Workbook.new
+			sheet = book.create_worksheet :name => 'Results'
+			# header
+			format = Spreadsheet::Format.new :weight => :bold, :size => 14 ,
+			:horizontal_align => :center
+			(criterias.unshift('Projets')).each_with_index do |crit, i|
+				sheet[0,i] = crit
+				sheet.column(i).width = (crit.size * format.font.size/10) + 5
+			end
+			sheet.row(0).default_format = format
+			sheet.row(0).height = 18
+			# Values for each project as rows
+			@data.keys.each_with_index do |proj, i|
+				sheet.insert_row(i+1,@data[proj].values.unshift(proj))
+			end
+			book.write out(ext)
+		end
+		# Generates an HTML file
+		def html(ext = '.html')
+			out = '<!DOCTYPE html><html><head>'
+			out += '<meta charset= "UTF-8">'
+			out += "<link rel=\"stylesheet\" href=\"#{Cfg[:res_dir]}/css/component.css\" />"
+			out += "<link rel=\"stylesheet\" href=\"#{Cfg[:res_dir]}/css/normalize.css\" />"
+			out += '<script src="res/js/component.css"></script>'
+			out += '<title>Results</title>'
+			out += "</head>\n<body><table><thead>"
+			out += '  <tr>'
+			criterias.unshift('Projet').each { |crit| out += "<th>#{crit}</th>" }
+			out += '</tr></thead><tbody>'
+	 		# Values for each project as rows
+			@data.keys.each do |proj|
+				out += "<tr><th>#{proj}</th>"
+				@data[proj].each do |k, v|
+					if k.to_s[/(compilation|execution)/]
+						out += '<td class="console">'
+					else
+						out += '<td>'
+					end
+					# If file, generate a link, else do nothing !
+					out += file?(v) && "<pre><a href=\"#{v.gsub(' ','%20')}\" target=\"_blank\">#{v}</a></pre></td>" ||"<pre>#{v}</pre></td>"
+				end
+				out += '</tr>'
+			end
+			out += '</tbody></table>'
+			out += '<script src="http://ajax.googleapis.com/ajax/libs/jquery/1/jquery.min.js"></script>'
+			out += '<script src="http://cdnjs.cloudflare.com/ajax/libs/jquery-throttle-debounce/1.1/jquery.ba-throttle-debounce.min.js"></script>'
+			#out += "<script src=\"#{Cfg[:res_dir]}/js/jquery.stickyheader.js\"></script>"
+			out += '</body></html>'
+	    File.open(out(ext), 'w') { |f| f.write(out) }
+		end
+	private
+		def out(ext)
+			Cfg[:out] + ext
+		end
+		def file? path
+			File.exist? path.to_s
+		end
+	end
+end

data/lib/components/organiser.rb ADDED Viewed

@@ -0,0 +1,181 @@
+require 'fileutils'
+require_relative '../helpers/git'
+require_relative '../project'
+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)
+	# During this step, a git repository will be created, with an initial commit.
+	#
+	# @author Yann Prono
+	# @author Renan Strauss
+	#
+	class Organiser < Component
+		# Include all tools
+		include Helpers::Git
+		include Project
+		# All entries to ignore during sort and organization
+		$rejected_entries = ['.', '..', '__MACOSX']
+		# initialize tool.
+		# Organiser has to :
+		#  - get all students
+		#  - get all groups (classes)
+		#  - get all teams (binoms)
+		#  - get all unknown soldiers ...
+		def initialize(data)
+			raise ArgumentError if data == nil || !data.respond_to?('each')
+			super data
+			@directory = Cfg[:dest]
+			@path = @directory
+			@git = nil
+			@students = []
+			@binoms = []
+			@groups = []
+			@unknown = []
+			# How many patterns are in the pseudo-regex?
+			@count_patterns = {}
+		end
+		# Rename directories more clearly.
+		# @param entry [String] path of the entry to rename.
+		def rename(entry)
+			name = format entry
+			if name != nil
+				if name != entry
+					new_path = File.join(@directory, name)
+					FileUtils.mkdir_p new_path.split(File.basename(new_path))[0]
+					FileUtils.mv(File.join(@directory, entry), new_path, :force => true)
+					@logger.h2 Logger::INFO, "renaming #{File.basename(entry)} to #{File.basename(name)}"
+				else
+					@logger.h2 Logger::INFO, "#{entry} has not been renamed}, already formatted"
+				end
+			else
+				@logger.h2 Logger::ERROR, "Can't rename #{File.basename(entry)} - Datas not found in name"
+			end
+		end
+		# Method which moves project's directories in order to
+		# have the same hierarchy for all project.
+		# @param entry [String] path of the entry to structure.
+		def structure(entry)
+			chdir entry
+			@logger.h2 Logger::INFO, "#{entry} => #{@path}"
+			level = 0
+			@logger.h2 Logger::INFO, "Files in #{@path}"
+			@logger.h3 Logger::INFO, "#{all}"
+			@logger.h2 Logger::INFO, "Dirs in #{@path}"
+			@logger.h3 Logger::INFO, "#{directories}"
+			# directory to delete if the project directory is not structured
+			rm = directories.first
+			# Loop to find the core of project
+			#
+			# Basically running through
+			# each level of directories
+			# while there are only directories
+			# in the current directory
+			#
+			while all == directories
+				level += 1
+				@logger.h2 Logger::DEBUG, "Level += 1\nPath = #{@path}"
+				chdir directories.first
+				@logger.h2 Logger::DEBUG, "New path = #{@path}"
+			end
+			# If the core of project is not at the root of directory ...
+			if level >= 1
+				Dir.glob(File.join(@path,'*')).each do |file|
+					FileUtils.mv(file,File.join(@directory, entry))
+				end
+				@logger.h2 Logger::INFO, "Structuring #{File.join(@path)}"
+				@logger.h2 Logger::INFO, "Removing #{File.join(@directory, entry, rm)}"
+				FileUtils.rm_rf(File.join(@directory, entry, rm))
+			end
+			@path = @directory
+		end
+		# Initialize a git repo.
+		# @param entry [String] Directory to process.
+		def git(entry)
+			Dir.chdir File.join(@directory, entry) do
+				git_init
+				git_add
+				git_commit
+			end
+		end
+		# Method which run 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
+				@logger.h1 Logger::INFO, "Initializing git repo"
+				git entry
+				@logger.h1 Logger::INFO, "Renaming directory"
+				rename entry
+				@logger.newline
+			end
+			@logger.h1 Logger::INFO, "#{@groups.size} group#{'s' if @groups.size > 1} have been detected"
+			@logger.h1 Logger::INFO, "#{@students.size} student#{'s' if @students.size > 1} have been detected"
+			@logger.h1 Logger::INFO, "#{@binoms.size} binom#{'s' if @binoms.size > 1} have been detected"
+			log_resume(@groups, Logger::INFO, "Groups:")
+			log_resume(@students, Logger::INFO, "Students:")
+			log_resume(@binoms, Logger::INFO, "Binoms:")
+			log_resume(@unknown, Logger::ERROR, "\n#{@unknown.size} projects didn't matched with regex")
+		end
+	private
+		#
+		# Take attention : these accessors
+		# are meant to be used by structure
+		# only ! Because @path is initialized
+		# for that, and used only in this def
+		#
+		def all
+			Dir.entries(@path) - $rejected_entries
+		end
+		def directories
+			all.select { |e| File.directory? File.join(@path, e) }
+		end
+		def chdir(dir)
+			base = @path
+			@path = File.join(base, dir)
+		end
+		# Shortuct for logs ...
+		# @param data [Array] to loop.
+		# @param severity [Integer] Severity of the log.
+		# @param message [String] Message to log before writing data..
+		def log_resume(data ,severity, message)
+			unless data.empty?
+				@logger.newline
+				@logger.h1 severity, message
+				data.each {|d| @logger.h2 severity, "#{d}" }
+			end
+		end
+	end
+end

data/lib/config.rb ADDED Viewed

@@ -0,0 +1,48 @@
+#
+# @author Renan Strauss
+# Externalises the configuration
+#
+require 'yaml'
+class Cfg
+	# Path for specialized config files for projects
+	ROOT = File.join(File.dirname(File.dirname(__FILE__)))
+	# Is the config is loaded ?
+	@@loaded = false
+	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
+	# 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}
+	end
+end

data/lib/exec.rb ADDED Viewed

@@ -0,0 +1,136 @@
+require 'thor'
+require 'fileutils'
+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
+#
+class Exec < Thor
+	@@setup = false
+	# path of config template file.
+	$template_path = File.join(File.dirname(File.dirname(__FILE__)),'config.yml')
+	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
+	# Say hello to the user !
+	desc 'hello','Say hello to the user !'
+	def hello
+		puts 'Hello, I am reviser'
+	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))
+    	setup File.expand_path(File.join(dir, File.basename($template_path))) unless @@setup
+	end
+	# 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)
+			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.")
+		end
+	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'
+		Reviser::run
+	end
+	# Launch archiver !
+	desc 'extract', 'Launch archiver and extract all projects.'
+	def extract
+		Reviser::load :component => 'archiver'
+		Reviser::run
+	end
+	# Launch organiser !
+	desc 'organise', 'Launch organiser and prepare all projects for analysis'
+	def organise
+		Reviser::load :component => 'organiser'
+		Reviser::run
+	end
+	# 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
+	# 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
+	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
+			path_res = File.join(File.dirname(File.dirname(__FILE__)),"#{Cfg[:res_dir]}")
+			FileUtils.cp_r(path_res, FileUtils.pwd)
+			@@setup = true
+		end
+	end
+end
+Exec.start(ARGV)

data/lib/helpers/code_analysis.rb ADDED Viewed

@@ -0,0 +1,64 @@
+#
+# @Author Renan Strauss
+#
+# Basic stuff needed for Checker
+#
+module Helpers
+	module CodeAnalysis
+		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
+	private
+		#
+		# @return all the files in the project's folder
+		#
+		def files
+			Dir.glob("**/*").select { |f| (File.file?(f)) }
+		end
+		def sources
+			files.select { |f| Cfg[:extension].include? File.extname(f) }
+		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

data/lib/helpers/compilation.rb ADDED Viewed

@@ -0,0 +1,40 @@
+#
+# @Author Yann Prono
+# @Author Renan Strauss
+#
+# Needed stuff for compiled languages
+# such as C, Java, and so on.
+#
+module Helpers
+	module Compilation
+		include Project
+		include 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