reviser 0.0.1.1.pre.beta → 0.0.2.rc1

data/lib/components/checker.rb

@@ -11,68 +11,62 @@ require 'open3'
 
 require_relative '../helpers/criteria'
 
-module Components
-	class Checker < Component
-		include Helpers::Criteria
+module Reviser
+	module Components
+		class Checker < Component
+			include Helpers::Criteria
 
-		def initialize(data)
-			super data
+			def initialize(data)
+				super data
 
-			init_criteria_helper
+				@criteria = Hash.new
+				@output = Hash.new
 
-			@results = {}
-		end
+				@logger.h1 Logger::INFO, "Loading modules"
 
-		# 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
-		def run
-			# We'll work in the dest directory
-			Dir.chdir Cfg[:dest] do
-				projects = Dir.entries('.') - ['.','..']
-				projects.each_with_index do |proj, i| 
-					puts "\t[#{i+1}/#{projects.size}]\t#{proj}"
-					Dir.chdir(proj) { check proj }
-				end
-			end
+				load PWD, '../criteria/*'
+				load EXT, '*'
 
-			@results
-		end
+				@logger.h1 Logger::INFO, "Loading labels"
+
+				[:criteria, :extensions].each { |x| load_labels x }
 
-	private
+				@results = {}
+			end
 
-		#
-		# Being called in the project's directory,
-		# this methods maps all the criterias to
-		# their analysis value
-		#
-		def check(proj)		
-			# Init results
-			@results[proj] = {}
-			
-			# for each method asked by user with its label
-			@output.each do |meth, label|
-				if @criteria.has_key? meth
-					@results[proj][label] = call meth 
-				else
-					@logger.h1(Logger::ERROR, "Unknown method '#{meth}'' for project #{proj}")
+			# 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
+			def run
+				@data.each_with_index do |proj, i|
+					path = File.join(Cfg[:dest], proj)
+					puts "\t[#{i+1}/#{@data.size}]\t#{proj}"
+					Dir.chdir(path) { check proj }
 				end
+		
+				@results
 			end
-		end
 
-		#
-		# This method is what would be the constructor
-		# of criteria_helper if it was a class
-		#
-		def init_criteria_helper
-			@criteria = Hash.new
-			@output = Hash.new
-			@logger.h1 Logger::INFO, "Loading modules"
-			load PWD, '../helpers/*'
-			load EXT, '*'
-			@logger.h1 Logger::INFO, "Loading labels"
-			[:criteria, :extensions].each { |x| load_labels x }
-		end
+		private
 
+			#
+			# Being called in the project's directory,
+			# this methods maps all the criterias to
+			# their analysis value
+			#
+			def check(proj)		
+				# Init results
+				@results[proj] = {}
+				
+				# for each method asked by user with its label
+				@output.each do |meth, label|
+					if @criteria.has_key? meth
+						@results[proj][label] = call meth 
+					else
+						@logger.h1(Logger::ERROR, "Unknown method '#{meth}'' for project #{proj}")
+					end
+				end
+			end
+		end
 	end
 end

data/lib/components/extractors.rb

@@ -1,139 +1,140 @@
 require 'rubygems'
 require 'fileutils'
 
-module Components
+module Reviser
+	module Components
 
-	# The module contains all methods to extract an archive
-	# regardless the format.
-	#
-	# Convention over configuration !
-	#
-	# To add a new format, maybe you need to install the a gem.
-	# Find your  gem which uncompress 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 use 'rar' format, the name of the method will be: "rar"
-	# 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> (archive, destination)
-	# 			require <gem>
-	# 			...
-	# 		end
-	#
-	# @author 	Anthony Cerf
-	# @author 	Yann Prono
-	#
-	module Extractors	
+		# The module contains all methods to extract an archive
+		# regardless the format.
+		#
+		# Convention over configuration !
+		#
+		# To add a new format, maybe you need to install the a gem.
+		# Find your  gem which uncompress 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 use 'rar' format, the name of the method will be: "rar"
+		# 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> (archive, destination)		require <gem> 	...		end
+		#
+		#
+		#
+		# @author 	Anthony Cerf
+		# @author 	Yann Prono
+		#
+		module Extractors	
 
-		# Method which unzip a file.
-		# @param zip_file 		[String] the zip file.
-		# @param destination 	[String] Destination of extracted data.
-		def zip zip_file, destination
-			require 'zip'
-			# Cfg the gem
-			Zip.on_exists_proc = true
-			Zip.continue_on_exists_proc = true
+			# Method which unzips a file.
+			# @param zip_file 		[String] the zip file.
+			# @param destination 	[String] Destination of extracted data.
+			def zip zip_file, destination
+				require 'zip'
+				# Cfg the gem
+				Zip.on_exists_proc = true
+				Zip.continue_on_exists_proc = true
 
-			Zip::File.open(zip_file) do |archive|
-				#Entry = file or directory
-				archive.each do |entry|
-	  				#Create filepath
-	 				filepath = File.join(destination, entry.name)
+				Zip::File.open(zip_file) do |archive|
+					#Entry = file or directory
+					archive.each do |entry|
+		  				#Create filepath
+		 				filepath = File.join(destination, entry.name)
 
-		  			# Check if it doesn't exist because of directories (overwrite)
-					unless File.exist?(filepath)
-						# Create directories to access file
-						FileUtils.mkdir_p(File.dirname(filepath))
-						entry.extract(filepath)
-					end
-	  			end
+			  			# Check if it doesn't exist because of directories (overwrite)
+						unless File.exist?(filepath)
+							# Create directories to access file
+							FileUtils.mkdir_p(File.dirname(filepath))
+							entry.extract(filepath)
+						end
+		  			end
+				end
 			end
-		end
-		
-		# Method which ungz a file.
-		# @param gz_file 		[String] the gz file.
-		# @param destination 	[String] Destination of extracted data.
-		def gz gz_file, destination
-			require 'zlib'
-			file = Zlib::GzipReader.open(gz_file)
-			unzipped = StringIO.new(file.read)
-			file.close
-			tar(unzipped, destination)
-		end
-
-		# Alias for format shortcut
-		# CC Dominique Colnet!
-		alias :tgz :gz 
-	    
-	    # Method which untar a tarfile.
-		# @param tar_file 		[String] the tar file.
-		# @param destination 	[String] Destination of extracted data.
-		def tar tar_file, destination
-			require 'rubygems/package'
-	    	# test if src is String (filename) or IO stream
-			if tar_file.is_a? String
-				stream = File.open(tar_file)
-			else
-				stream = tar_file
+			
+			# Method which ungz a file.
+			# @param gz_file 		[String] the gz file.
+			# @param destination 	[String] Destination of extracted data.
+			def gz gz_file, destination
+				require 'zlib'
+				file = Zlib::GzipReader.open(gz_file)
+				unzipped = StringIO.new(file.read)
+				file.close
+				tar(unzipped, destination)
 			end
 
-	    	Gem::Package::TarReader.new(stream) do |tar|
-		        tar.each do |tarfile|
-		          	destination_file = File.join destination, tarfile.full_name
-		          	if tarfile.directory?
-		            	FileUtils.mkdir_p destination_file
-					else
-			            destination_directory = File.dirname(destination_file)
-			            FileUtils.mkdir_p destination_directory unless File.directory?(destination_directory)
-			            File.open destination_file, 'wb' do |f|
-			              	f.print tarfile.read
-			          	end
-		     		end
-		     		tarfile.close unless tarfile.closed?
+			# Alias for format shortcut
+			# CC Dominique Colnet!
+			alias :tgz :gz 
+		    
+		    # Method which untar a tarfile.
+			# @param tar_file 		[String] the tar file.
+			# @param destination 	[String] Destination of extracted data.
+			def tar tar_file, destination
+				require 'rubygems/package'
+		    	# test if src is String (filename) or IO stream
+				if tar_file.is_a? String
+					stream = File.open(tar_file)
+				else
+					stream = tar_file
+				end
+
+		    	Gem::Package::TarReader.new(stream) do |tar|
+			        tar.each do |tarfile|
+			          	destination_file = File.join destination, tarfile.full_name
+			          	if tarfile.directory?
+			            	FileUtils.mkdir_p destination_file
+						else
+				            destination_directory = File.dirname(destination_file)
+				            FileUtils.mkdir_p destination_directory unless File.directory?(destination_directory)
+				            File.open destination_file, 'wb' do |f|
+				              	f.print tarfile.read
+				          	end
+			     		end
+			     		tarfile.close unless tarfile.closed?
+			  		end
+			  		tar.close
 		  		end
-		  		tar.close
-	  		end
-	  		stream.close
-		end
+		  		stream.close
+			end
 
-		# Method which unrar a rar file, if it is possible (proprietary format grr ...)
-		# @param rar_file 		[String] the rar file.
-		# @param destination 	[String] Destination of extracted data.
-		def rar rar_file, destination
-			require 'shellwords'
-	 		`which unrar`
-	 		if $?.success?
-	 			src = Shellwords.escape(rar_file)
-	 			destination = Shellwords.escape(destination)
-	 			`unrar e #{src} #{destination}`
-			else
-				puts 'Please install unrar : sudo apt-get install unrar'
+			# Method which unrar a rar file, if it is possible (proprietary format grr ...)
+			# @param rar_file 		[String] the rar file.
+			# @param destination 	[String] Destination of extracted data.
+			def rar rar_file, destination
+				require 'shellwords'
+		 		`which unrar`
+		 		if $?.success?
+		 			src = Shellwords.escape(rar_file)
+		 			destination = Shellwords.escape(destination)
+		 			`unrar e #{src} #{destination}`
+				else
+					puts 'Please install unrar : sudo apt-get install unrar'
+				end
 			end
-		end
 
-		# Method which un7zip a 7zip file.
-		# @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'
-			File.open(seven_zip_file, 'rb') do |file|
-	  			SevenZipRuby::Reader.open(file) do |szr|
-	    			szr.extract_all destination
-	  			end
+			# Method which un7zip a 7zip file.
+			# @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'
+				File.open(seven_zip_file, 'rb') do |file|
+		  			SevenZipRuby::Reader.open(file) do |szr|
+		    			szr.extract_all destination
+		  			end
+				end
 			end
-		end
 
-		# Use first of all for seven zip format (little tip, can't call it directly).
-		def method_missing(m, *args, &block)
-	    	if (ext = File.extname(args[0]).delete('.') == '7z')
-	    		seven_zip(args[0], args[1])
-	    	else 
-	    		raise "Format '#{ext.delete('.')}' not supported"
-	    	end
-	  	end
+			# Use first of all for seven zip format (little tip, can't call it directly).
+			def method_missing(m, *args, &block)
+		    	if (ext = File.extname(args[0]).delete('.') == '7z')
+		    		seven_zip(args[0], args[1])
+		    	else 
+		    		raise "Format '#{ext.delete('.')}' not supported"
+		    	end
+		  	end
 
+		end
 	end
 end

data/lib/components/generator.rb

@@ -1,47 +1,50 @@
 require_relative 'generators'
 
+module Reviser
+	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
 
-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
+			# Runs 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
-			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
+			# Gets 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
+			# Quite handy
+			# @param str [String] string to titleize
+			# @return [String] cute string !
+			def self.titleize(str)
+				str.split(/_/).join(' ').capitalize
+			end
 
+		end
 	end
 end