reviser 0.0.1.1.pre.beta → 0.0.2.rc1

data/lib/components/generators.rb

@@ -1,130 +1,134 @@
-
-# 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)
+module Reviser
+	module Components
+
+		# 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 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
-		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'
+			# 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
+				# 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
+				(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	
+				# 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
+				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
+			# 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>"
+						# 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 += '</tr>'
-			end
 
-			out += '</tbody></table>'
+				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 += '<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>'
+				out += '</body></html>'
 
-	    File.open(out(ext), 'w') { |f| f.write(out) }
-		end
+		    File.open(out(ext), 'w') { |f| f.write(out) }
+			end
 
-	private
+		private
 
-		def out(ext)
-			Cfg[:out] + ext
-		end
+			def out(ext)
+				Cfg[:out] + ext
+			end
 
-		def file? path
-			File.exist? path.to_s
-		end
+			# Checks if result is a existing file.
+			# @param path [String] of possible file
+			# @return [Boolean] True if the path is a real file.
+			def file? path
+				File.exist? path.to_s
+			end
 
+		end
 	end
 end

data/lib/components/organiser.rb

@@ -1,181 +1,193 @@
 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
+require_relative '../helpers/project'
 
-		# 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)}"
+
+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)
+		# During this step, a git repository will be created, with an initial commit.
+		#
+		# The other important task of Organiser is to detect all students, all binoms and all groups, 
+		# thank to the directory name.
+		#
+		# @author Yann Prono
+		# @author Renan Strauss
+		#
+		class Organiser < Component
+
+			# Include all tools
+			include Helpers::Git
+			include Helpers::Project::Naming
+
+			# All entries to ignore during sort and organization
+			$rejected_entries = ['.', '..', '__MACOSX']
+
+			# initializes tool.
+			# The initialization will prepare all to 
+			# crate a git repo, save all detected students as well someone who 
+			# doesn't respect convention ...
+			Organiser 
+			def initialize(data)
+				raise ArgumentError if data == nil || !data.respond_to?('each')
+
+				super data
+
+				@directory = Cfg[:dest]
+				@path = @directory
+				@git = nil
+				@students = []
+				@binoms = []
+				@projects_per_group = {}
+				@unknown = []
+				@results = []
+
+				# How many patterns are in the pseudo-regex?
+				@count_patterns = {}
+			end
+
+			# Renames 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::INFO, "#{entry} has not been renamed}, already formatted"
+					@logger.h2 Logger::ERROR, "Can't rename #{File.basename(entry)} - Datas not found in name"
 				end
-			else
-				@logger.h2 Logger::ERROR, "Can't rename #{File.basename(entry)} - Datas not found in name"
+				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
+			# 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))
+				# 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
-				@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
+				@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
+			# Initializes 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
-		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
+			# 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
 
-				@logger.h1 Logger::INFO, "Initializing git repo"
-				git 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, "Renaming directory"
+					new_path = rename entry
+					@logger.newline
+					@results << new_path
+				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"
+				@logger.h1 Logger::INFO, "#{@projects_per_group.keys.size} group#{'s' if @projects_per_group.keys.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:")
+				formalized = []
+				@projects_per_group.each { |k,v| formalized << "#{k.to_s}: #{v} project#{'s' if v > 1}" }
+				log_resume(formalized, 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
+				log_resume(@unknown, Logger::ERROR, "\n#{@unknown.size} projects didn't matched with regex")
+				
+				@results
+			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
+		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 directories
+				all.select { |e| File.directory? File.join(@path, e) }
+			end
 
-		def chdir(dir)
-			base = @path
-			@path = File.join(base, dir)
-		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}" }
+			# Shortcut 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
 end