reviser 0.0.1.1.pre.beta → 0.0.2.rc1

data/lib/helpers/criteria.rb

@@ -1,5 +1,3 @@
-require_relative '../config'
-
 # Manage criteria and labels.
 
 # @example Call a criterion (in the config File):
@@ -11,176 +9,176 @@ require_relative '../config'
 # @author Yann Prono
 # @author Renan Strauss
 #
-module Helpers
-	# This module enables to 
-	# imports automaticlly all modules for the analysis
-	#
-	# Convention over configuration !
-	# A analysis module contains the word 'tool' in its filename.
-	# You also have the possibility to put code in the ext folder.
-	#
-	# @example Call a criterion during analysis (in the config File):
-	#   criteria:
-	#     - :count_lines
-	#     - :list_files
-	#     - :<method>: <custom label>
-	#
-	# In the last item of the list, the custom label will overwrite the label 
-	# in labels.yml if it exist.
-	# 
-	module Criteria
-		
-		# Where I am ?	
-		PWD = File.dirname __FILE__
-		# Path of extensions
-		EXT = File.join File.dirname(File.dirname(PWD)), 'ext'
-
-		attr_reader :criteria
-		attr_reader :output
-
-		# All criterias available.
-		# :criterion => Name of the module
-		@criteria
-
-		# :criterion => label of criterion
-		@output
-
-		# Enable to call a specified method.
-		# @param meth [String] Method to call.
-		# @return results of the method.
-		def call meth
-			if @criteria.key? meth
-				@logger.h1(Logger::INFO, "Include methods of #{@criteria[meth]}") unless respond_to? meth
-				self.class.send(:include, @criteria[meth]) unless respond_to? meth
-
-				send meth 
-			else
-				nil
+module Reviser
+	module Helpers
+		# This module enables to 
+		# imports automaticlly all modules for the analysis
+		#
+		# Convention over configuration !
+		# A analysis module contains the word 'tool' in its filename.
+		# You also have the possibility to put code in the ext folder.
+		#
+		# @example Call a criterion during analysis (in the config File):
+		#   criteria:
+		#     - :count_lines
+		#     - :list_files
+		#     - :<method>: <custom label>
+		#
+		# In the last item of the list, the custom label will overwrite the label 
+		# in labels.yml if it exist.
+		# 
+		module Criteria
+			
+			# Where I am ?	
+			PWD = File.dirname __FILE__
+			# Path of extensions
+			EXT = File.join File.dirname(File.dirname(PWD)), 'ext'
+
+			attr_reader :criteria
+			attr_reader :output
+
+			# All criterias available.
+			# :criterion => Name of the module
+			@criteria
+
+			# :criterion => label of criterion
+			@output
+
+			# Enable to call a specified method.
+			# @param meth [String] Method to call.
+			# @return results of the method.
+			def call meth
+				if @criteria.key? meth
+					@logger.h1(Logger::INFO, "Include methods of #{@criteria[meth]}") unless respond_to? meth
+					self.class.send(:include, @criteria[meth]) unless respond_to? meth
+
+					send meth 
+				else
+					nil
+				end
 			end
-		end
 
 
-	protected
+		protected
 
-		# Get all criteria which can be used.
-		# @return [Array] all criteria
-		def all
-			@criteria.keys.map &:to_sym
-		end
+			# Get all criteria which can be used.
+			# @return [Array] all criteria
+			def all
+				@criteria.keys.map &:to_sym
+			end
 
-		#  from Cfg file to symbols
-		# @param criterion The criteria
-		# @param module_name The name of the module.
-		def populate criterion, module_name
-			raise "Criterion '#{criterion}' is already defined in #{@criteria[criterion.to_sym]} (#{criterion}/#{module_name}).\nPlease change the name of the method in one of modules." if @criteria.has_key? criterion.to_sym
-			@criteria[criterion.to_sym] = module_name
-		end
+			#  from Cfg file to symbols
+			# @param criterion The criteria
+			# @param module_name The name of the module.
+			def populate criterion, module_name
+				raise "Criterion '#{criterion}' is already defined in #{@criteria[criterion.to_sym]} (#{criterion}/#{module_name}).\nPlease change the name of the method in one of modules." if @criteria.has_key? criterion.to_sym
+				@criteria[criterion.to_sym] = module_name
+			end
 
-		# Load all of modules available for the analysis
-		# @param directory Directory where search of modules is done.
-		# @param regex regex to find name of modules.
-		def load directory, regex = '*'
-			@logger.h2 Logger::INFO, "Modules of #{directory}"
-			modules =  Dir[File.join(directory, regex)]
-
-			namespace = directory == EXT && 'Extensions' || 'Helpers'
-			modules.each do |m|
-				next if m =~ /(criteria)/
-
-				require_relative m
-				ext = File.extname m
-				module_name = Object.const_get "#{namespace}::#{camelize(File.basename(m,ext))}", false
-				@logger.h3 Logger::INFO, "Load #{module_name}"
-				methods = module_name.instance_methods false
-				methods.each { |method| populate(method, module_name) }
-	 		end	
-	 	end
-
-		# Gets the name of module 
-		# @param file_module Name of the file module.
-		def camelize file_module
-			file_module.split('_').each {|s| s.capitalize! }.join('')
-		end
+			# Load all of modules available for the analysis
+			# @param directory Directory where search of modules is done.
+			# @param regex regex to find name of modules.
+			def load directory, regex = '*'
+				@logger.h2 Logger::INFO, "Modules of #{directory}"
+				modules =  Dir[File.join(directory, regex)]
+
+				namespace = directory == EXT && 'Reviser::Extensions' || 'Reviser::Criteria'
+				modules.each do |m|
+					require_relative m
+					ext = File.extname m
+					module_name = Object.const_get "#{namespace}::#{camelize(File.basename(m,ext))}", false
+					@logger.h3 Logger::INFO, "Load #{module_name}"
+					methods = module_name.instance_methods false
+					methods.each { |method| populate(method, module_name) }
+		 		end	
+		 	end
+
+			# Gets the name of module 
+			# @param file_module Name of the file module.
+			def camelize file_module
+				file_module.split('_').each {|s| s.capitalize! }.join('')
+			end
 
-		# Load labels given by the user.
-		# If the label doesn't exist, it will created with the name of the method.
-		# @param key Key of criteria in config file
-		def load_labels key
-			labels = Labels.load
-
-			if Cfg.has_key?(key) && Cfg[key].respond_to?('each')
-				Cfg[key].each do |meth|
-					if meth.respond_to?('each') && meth.respond_to?('[]')
-						label =  meth[meth.keys[0]]
-						@logger.h2(Logger::ERROR, "Undefined label for #{meth.keys[0]}, check your config file") if label == nil
-						label = create_label(meth.keys[0]) if label == nil
-						@output[meth.keys[0].to_sym] = label
-					else
-						label = (labels.respond_to?('[]') && labels.key?(meth.to_sym)) ? labels[meth.to_sym] : create_label(meth)
-						@output[meth.to_sym] = label
+			# Load labels given by the user.
+			# If the label doesn't exist, it will created with the name of the method.
+			# @param key Key of criteria in config file
+			def load_labels key
+				labels = Labels.load
+
+				if Cfg.has_key?(key) && Cfg[key].respond_to?('each')
+					Cfg[key].each do |meth|
+						if meth.respond_to?('each') && meth.respond_to?('[]')
+							label =  meth[meth.keys[0]]
+							@logger.h2(Logger::ERROR, "Undefined label for #{meth.keys[0]}, check your config file") if label == nil
+							label = create_label(meth.keys[0]) if label == nil
+							@output[meth.keys[0].to_sym] = label
+						else
+							label = (labels.respond_to?('[]') && labels.key?(meth.to_sym)) ? labels[meth.to_sym] : create_label(meth)
+							@output[meth.to_sym] = label
+						end
 					end
 				end
 			end
-		end
 
-		# Create label for a method.
-		# @param meth [String] method linked to the label
-		# @return [String] Renamed Label inspired of the name of the method
-		def create_label meth
-			@logger.h2 Logger::ERROR, "Create label for #{meth}. You should custom your label (see 'reviser add')"
-			meth.to_s.split('_').each {|s| s.capitalize! }.join(' ')
+			# Create label for a method.
+			# @param meth [String] method linked to the label
+			# @return [String] Renamed Label inspired of the name of the method
+			def create_label meth
+				@logger.h2 Logger::ERROR, "Create label for #{meth}. You should custom your label (see 'reviser add')"
+				meth.to_s.split('_').each {|s| s.capitalize! }.join(' ')
+			end
 		end
-	end
-
-
-	# Manage all actions for adding, updating or getting labels of Reviser.
-	# A label is a a group of words, describing the associated criterion (method).
-	#
-	# @example  
-	#  	criterion => label
-	# 	all_files => all files of project
-	#
-	# known Labels are in the labels.yml file.
-	#
-	# @author Yann Prono
-	class Labels
-
-		# Current directory of this file
-		PWD = File.dirname __FILE__
 
-		# Path of label.yml file
-		LABELS = File.join(File.dirname(File.dirname(PWD)), 'labels.yml')
 
+		# Manage all actions for adding, updating or getting labels of Reviser.
+		# A label is a a group of words, describing the associated criterion (method).
 		#
-		# Enable to associate a label to a criterion (method).
-		# The label will be saved in the 'labels.yml' file
-		# @param meth Method to link.
-		# @param label Label to link with the method.
-	    def self.add meth, label
-	    	res = "Create"
-			labels = YAML.load File.open(LABELS)
-			if labels.respond_to? '[]'
-				res = "Update" if labels.key? meth
-				labels[meth] = label
-				File.open(LABELS, 'w') { |f| f.write labels.to_yaml }
+		# @example  
+		#  	criterion => label
+		# 	all_files => all files of project
+		#
+		# known Labels are in the labels.yml file.
+		#
+		# @author Yann Prono
+		class Labels
+
+			# Current directory of this file
+			PWD = File.dirname __FILE__
+
+			# Path of label.yml file
+			LABELS = File.join(File.dirname(File.dirname(PWD)), 'labels.yml')
+
+			#
+			# Enable to associate a label to a criterion (method).
+			# The label will be saved in the 'labels.yml' file
+			# @param meth Method to link.
+			# @param label Label to link with the method.
+		    def self.add meth, label
+		    	res = "Create"
+				labels = YAML.load File.open(LABELS)
+				if labels.respond_to? '[]'
+					res = "Update" if labels.key? meth
+					labels[meth] = label
+					File.open(LABELS, 'w') { |f| f.write labels.to_yaml }
+				end
+				res
 			end
-			res
-		end
 
-		# @return Hash all known labels by reviser.
-		# :criterion => label
-		def self.load
-			Labels.populate(YAML.load(File.open(LABELS)))
-		end
+			# @return Hash all known labels by reviser.
+			# :criterion => label
+			def self.load
+				Labels.populate(YAML.load(File.open(LABELS)))
+			end
 
-		def self.populate hash
-			labels = {}
-			if hash.respond_to?('each')
-				hash.each do |meth, label|
-					labels[meth.to_sym] = label
+			def self.populate hash
+				labels = {}
+				if hash.respond_to?('each')
+					hash.each do |meth, label|
+						labels[meth.to_sym] = label
+					end
 				end
+				labels
 			end
-			labels
-		end
-  	end
+	  	end
+	end
 end

data/lib/helpers/git.rb

@@ -6,32 +6,34 @@
 #
 require 'git'
 
-module Helpers
-	module Git
-		# method which initialize a git repository
-		def git_init
-			@git = ::Git.init
-		end
+module Reviser
+	module Helpers
+		module Git
+			# method which initialize a git repository
+			def git_init
+				@git = ::Git.init
+			end
 
-		# method which allows the user to add something on the repository
-		def git_add
-			@git.add(:all=>true)
-		end
+			# method which allows the user to add something on the repository
+			def git_add
+				@git.add(:all=>true)
+			end
 
-		# method for displaying a message when the repository is configured
-		def git_commit
-			@git.commit_all('initialization of git repertory')		 
-		end
+			# method for displaying a message when the repository is configured
+			def git_commit
+				@git.commit_all('initialization of git repertory')		 
+			end
 
-		def git_push
-			@git.push
-		end
+			def git_push
+				@git.push
+			end
 
-		# method which allows the user to see the differences between two last commits
-		# I have to know the current commit and the last but how ?
-		# and do a diff between these 2 commits.
-		def git_diff
+			# method which allows the user to see the differences between two last commits
+			# I have to know the current commit and the last but how ?
+			# and do a diff between these 2 commits.
+			def git_diff
 
+			end
 		end
 	end
 end

data/lib/helpers/project.rb

@@ -5,35 +5,214 @@
 # @author Renan Strauss
 # @author Yann Prono
 #
-module Helpers
-	module Project
+module Reviser
+	module Helpers
+		module Project
+			#
+			# For interpreted languages
+			# We only check for missing files
+			#
+			def prepare
+				missing_files.empty? && 'None' || res
+			end
+
+			# Check if the project has all files needed
+			def missing_files
+				return [] unless Cfg =~ :required_files
+
+				dir = Dir['*']
+
+				#
+				# Check if there is any regexp
+				# If it's the case, if any file
+				# matches, we delete the entry
+				# for diff to work properly
+				#
+				Cfg[:required_files].each_with_index do |e, i|
+					if dir.any? { |f| (e.respond_to?(:match)) && (e =~ f) }
+						Cfg[:required_files].delete_at i
+					end
+				end
+
+				Cfg[:required_files] - dir
+			end
+
 		#
-		# For interpreted languages
-		# We only check for missing files
+		# @return all the files in the project's folder
 		#
-		def prepare
-			missing_files.empty? && 'None' || res
+		def files
+			Dir.glob("**/*").select { |f| (File.file?(f)) }
 		end
 
-		# Check if the project has all files needed
-		def missing_files
-			return [] unless Cfg =~ :required_files
+		def sources
+			files.select { |f| Cfg[:extension].include? File.extname(f) }
+		end
 
-			dir = Dir['*']
 
+			# This modules is used to scan the name of project
+			# in order to get all students who worked.
+			# This analysis uses regex of convention given by teachers (config file).
 			#
-			# Check if there is any regexp
-			# If it's the case, if any file
-			# matches, we delete the entry
-			# for diff to work properly
+			# @author Yann Prono
 			#
-			Cfg[:required_files].each_with_index do |e, i|
-				if dir.any? { |f| (e.respond_to?(:match)) && (e =~ f) }
-					Cfg[:required_files].delete_at i
+
+			module Naming
+
+				# Dictionnary for regex in config file
+				SYMBOLS = {
+					:group 		=> 'GROUP',
+					:firstname 	=> 'FIRSTN',
+					:name 		=> 'NAME',
+					:user		=> 'USER',
+					:lambda		=> 'LAMBDA'
+				}
+
+				# Regex to associate, depending the used word in Cfg
+				REGEX = {
+					:group 		=> '([A-Za-z0-9]{3,4})',
+					:firstname 	=> '([A-Za-z\-]+)',
+					:name 		=> '([A-Za-z]+)',
+					:user 		=> '([^_]*)',
+					:lambda 	=> '[a-zA-Z0-9 _]*'
+				}
+
+
+				# Get formatter written in the config file
+				# and count occurences of each word in the dictionnary SYMBOLS.
+				# @return [Hash] sym => count.
+				#
+				def analyze_formatter
+					regex = Cfg[:projects_names]
+					# Foreach known symbols
+					SYMBOLS.each do |k, _|
+						# Get numbers of occurences of the word k in regex 
+						matches = regex.scan(SYMBOLS[k]).size
+						# the word K => number of occurences
+						@count_patterns[k] = matches if matches > 0
+					end
 				end
-			end
 
-			Cfg[:required_files] - dir
+
+				# Analyze et get all informations 
+				# that could be useful in the name of the
+				# directory project.
+				# @param entry [String] name of directory to analysis.
+				#
+				def format entry
+					ext = File.extname entry
+					entry = File.basename entry, ext
+
+					analyze_formatter if @count_patterns.empty?
+
+			    	group = check_entry_name entry
+					generate_label group
+				end
+
+
+				# Generate new name of project.
+				# @param infos [Hash] All informations used for generate a name for the directory.
+				# @return [String] the formatted name for directory project
+				#
+				def generate_label infos
+					unless infos.empty?
+						label = ''
+						infos.reject { |k| k == :group }.each { |_, v|
+							if v.respond_to?('each')
+								v.each { |data|
+								label += data +' '
+							}
+							else
+								label += v + ' '
+							end
+						}
+						# Inject group of project before name : group/name
+						label = infos.key?(:group) && File.join(infos[:group], label) || label
+						label
+					end
+				end
+
+				# I'm not pround of this method ...
+				# associate to a symbol, his position in the regex
+				# @example NAME_FIRSTN
+				# will give : {
+				#	1 => :name,
+				#	2 => :firstname
+				#}
+				def get_position regex
+					res = {}
+					SYMBOLS.each do |k,v|
+						regex.scan(v) do |_|
+							res[$~.offset(0)[0]] = k
+						end
+					end
+
+					res = (res.sort_by { |k, _| k }).to_h
+					tmp = {}
+
+					index = 1
+					res.each do |_,v|
+						tmp[index] = v
+						index += 1
+					end
+					tmp
+				end
+
+
+				# Apply regex of user on the entry name
+				# and try to get all interested matched values.
+				def check_entry_name entry
+					regex = Cfg[:projects_names]
+					# who work on the current project (entry) ?
+					position = get_position regex
+
+					@count_patterns.each do |k, _|
+						regex = regex.gsub SYMBOLS[k], REGEX[k]
+					end
+					
+					# Apply created regex
+					entry.match Regexp.new(regex)
+					pos = 1
+					infos = {}
+
+					# Get matched values
+					begin
+						tmp = eval "$#{pos}"
+						if tmp != nil && tmp != ''
+							tmp = tmp.delete '_'
+							infos.has_key?(position[pos]) && infos[position[pos]] << tmp || infos[position[pos]] = [tmp]
+						end
+						pos += 1
+					end while pos <= position.size
+
+					if infos.empty?
+						infos[:unknown] = entry
+					end
+					sort_infos infos
+					infos
+				end
+
+
+				# Put all datas found in respective variables (students, groups, teams ...).
+				# @param infos [Hash] Informations found by regex.
+				def sort_infos infos
+					if infos.has_key?(:name)
+						infos[:name].respond_to?('each') && infos[:name].each { |n| @students << n } || @students << infos[:name] 
+						@binoms << infos[:name]
+					end
+					if infos.has_key?(:group)
+						infos[:group] = infos[:group][0].upcase
+						sym_group = infos[:group].to_sym
+						@projects_per_group[sym_group] = @projects_per_group.key?(sym_group) && @projects_per_group[sym_group] + 1 || 1 
+					end
+					
+					@unknown << infos[:unknown] if infos.key? :unknown
+				end
+
+
+				def ask entry
+				end
+
+			end
 		end
 	end
 end