normono.rb

#!/usr/bin/ruby

require 'optparse'
require 'tmpdir'

class String
  def each_char
    split('').each { |i| yield i }
  end

  def add_style(color_code)
    "\e[#{color_code}m#{self}\e[0m"
  end

  def black
    add_style(31)
  end

  def red
    add_style(31)
  end

  def green
    add_style(32)
  end

  def yellow
    add_style(33)
  end

  def blue
    add_style(34)
  end

  def magenta
    add_style(35)
  end

  def cyan
    add_style(36)
  end

  def grey
    add_style(37)
  end

  def bold
    add_style(1)
  end

  def italic
    add_style(3)
  end

  def underline
    add_style(4)
  end
end

module FileType
  UNKNOWN = 0
  DIRECTORY = 1
  MAKEFILE = 2
  HEADER = 3
  SOURCE = 4
end

class FileManager
  attr_accessor :path
  attr_accessor :type

  def initialize(path, type)
    @path = path
    @type = type
    @type = get_file_type if @type == FileType::UNKNOWN
  end

  def get_file_type
    @type = if @path =~ /Makefile$/
              FileType::MAKEFILE
            elsif @path =~ /[.]h$/
              FileType::HEADER
            elsif @path =~ /[.]c$/
              FileType::SOURCE
            else
              FileType::UNKNOWN
            end
  end

  def get_content
    file = File.open(@path)
    content = file.read
    file.close
    content
  end
end

class FilesRetriever
  @@ignore = nil

  def initialize
    @files = Dir['**/*'].select { |f| File.file? f }
    @files.delete_if { |f| f =~ /.rb/ }
    @files.delete_if { |f| f =~ /.md/ }
    @files.delete_if { |f| f =~ /test/ }
    @files.delete_if { |f| f =~ /criterion/ }
    @files.delete_if { |f| f =~ /Makefile/ }
    if File.file?('.gitignore')
      line_num = 0
      gitignore = FileManager.new('.gitignore', FileType::UNKNOWN).get_content
      gitignore.gsub!(/\r\n?/, "\n")
      @@ignore = []
      gitignore.each_line do |line|
        if !line.start_with?('#') && line !~ /^\s*$/
          @@ignore.push(line.chomp)
        end
      end
    end
    @nb_files = @files.size
    @idx_files = 0

    @dirs = Dir['**/*'].select { |d| File.directory? d }
    @nb_dirs = @dirs.size
    @idx_dirs = 0
  end

  def is_ignored_file(file)
    @@ignore.each do |ignored_file|
      if file.include?(ignored_file) || file.include?(ignored_file.tr('*', ''))
        return true
      end
    end
    false
  end

  def get_next_file
    if @idx_files < @nb_files
      file = FileManager.new(@files[@idx_files], FileType::UNKNOWN)
      @idx_files += 1
      file = get_next_file if !@@ignore.nil? && is_ignored_file(file.path)
      return file
    elsif @idx_dirs < @nb_dirs
      file = FileManager.new(@dirs[@idx_dirs], FileType::DIRECTORY)
      @idx_dirs += 1
      file = get_next_file if !@@ignore.nil? && is_ignored_file(file.path)
      return file
    end
    nil
  end
end

class CodingStyleChecker
  def initialize(file_manager)
    @file_path = file_manager.path
    @type = file_manager.type
    @file = nil
    if (@type != FileType::UNKNOWN) && (@type != FileType::DIRECTORY)
      @file = file_manager.get_content
    end
    check_file
  end

  def check_file
    if @type == FileType::UNKNOWN
      unless $options.include? :ignorefiles
        msg_brackets = '[' + @file_path + ']'
        msg_error = ' Forbidden or useless file.'
        puts(msg_brackets.bold.red + msg_error.bold)
      end
      return
    end
    if @type == FileType::DIRECTORY
      check_dirname
      return
    end
    check_trailing_spaces_tabs
    check_spaces_in_indentation
    if @type != FileType::MAKEFILE
      check_filename
      check_too_many_columns
      check_too_broad_filename
      # check_header
      check_several_assignments
      # check_forbidden_keyword_func
      check_too_many_else_if
      check_empty_parenthesis
      check_too_many_parameters
      check_space_after_keywords
      check_misplaced_pointer_symbol
      check_comma_missing_space
      check_misplaced_comments
      check_operators_spaces
      check_condition_assignment
      if @type == FileType::SOURCE
        check_functions_per_file
        check_function_lines
        check_empty_line_between_functions
      end
      check_macro_used_as_constant if @type == FileType::HEADER
    elsif @type == FileType::MAKEFILE
      # check_header_makefile
    end
  end

  def check_dirname
    filename = File.basename(@file_path)
    if filename !~ /^[a-z0-9]+([a-z0-9_]+[a-z0-9]+)*$/
      msg_brackets = '[' + @file_path + ']'
      msg_error = ' Directory name does not respect snake_case.'
      puts(msg_brackets.bold.red + msg_error.bold)
    end
  end

  def check_filename
    filename = File.basename(@file_path)
    if filename !~ /^[a-z0-9]+([a-z0-9_]+[a-z0-9]+)*[.][ch]$/
      msg_brackets = '[' + @file_path + ']'
      msg_error = ' Filename does not respect snake_case.'
      puts(msg_brackets.bold.red + msg_error.bold)
    end
  end

  def check_too_many_columns
    line_nb = 1
    @file.each_line do |line|
      length = 0
      line.each_char do |char|
        length += if char == "\t"
                    8
                  else
                    1
                  end
      end
      if length - 1 > 80
        msg_brackets = '[' + @file_path + ': L' + line_nb.to_s + ']'
        msg_error = ' Too many columns (' + (length - 1).to_s + ' > 80).'
        puts(msg_brackets.bold.red + msg_error.bold)
      end
      line_nb += 1
    end
  end

  def check_too_broad_filename
    if @file_path =~ /(.*\/|^)(string.c|str.c|my_string.c|my_str.c|algorithm.c|my_algorithm.c|algo.c|my_algo.c|program.c|my_program.c|prog.c|my_prog.c)$/
      msg_brackets = '[' + @file_path + ']'
      msg_error = ' Too broad filename. You should rename this file.'
      puts(msg_brackets.bold.red + msg_error.bold)
    end
  end

  def check_header
    if @file !~ /\/\*\n\*\* EPITECH PROJECT, [0-9]{4}\n\*\* .*\n\*\* File description:\n(\*\* .*\n)+\*\/\n.*/
      msg_brackets = '[' + @file_path + ']'
      msg_error = ' Missing or corrupted header.'
      puts(msg_brackets.bold.red + msg_error.bold)
    end
  end

  def check_function_lines
    count = level = 0
    line_nb = function_start = 1
    @file.each_line do |line|
      if line =~ /{[ \t]*$/
        if level == 0
          function_start = line_nb
          count = -1
        end
        level += 1
      elsif line =~ /^[ \t]*}[ \t]*$/
        level -= 1
        if (level == 0) && (count > 20)
          msg_brackets = '[' + @file_path + ':' + function_start.to_s + ']'
          msg_error = ' More than 20 lines (' + count.to_s + ' > 20).'
          puts(msg_brackets.bold.red + msg_error.bold)
        end
      end
      count += 1
      line_nb += 1
    end
  end

  def check_several_assignments
    line_nb = 1
    @file.each_line do |line|
      if line =~ /^[ \t]*for ?\(/
        line_nb += 1
        next
      end
      assignments = 0
      line.each_char do |char|
        assignments += 1 if char == ';'
      end
      if assignments > 1
        msg_brackets = '[' + @file_path + ':' + line_nb.to_s + ']'
        msg_error = ' Several assignments on the same line.'
        puts(msg_brackets.bold.red + msg_error.bold)
      end
      line_nb += 1
    end
  end

  def check_forbidden_keyword_func
    line_nb = 1
    @file.each_line do |line|
      line.scan(/(^|[^0-9a-zA-Z_])(printf|dprintf|fprintf|vprintf|sprintf|snprintf|vprintf|vfprintf|vsprintf|vsnprintf|asprintf|scranf|memcpy|memset|memmove|strcat|strchar|strcpy|atoi|strlen|strstr|strncat|strncpy|strcasestr|strncasestr|strcmp|strncmp|strtok|strnlen|strdup|realloc)[^0-9a-zA-Z]/) do
        unless $options.include? :ignorefunctions
          msg_brackets = '[' + @file_path + ':' + line_nb.to_s + ']'
          msg_error = " Function may be forbidden: '".bold
          msg_error += Regexp.last_match(2).bold.red
          msg_error += "'?".bold
          puts(msg_brackets.bold.red + msg_error)
        end
      end
      line.scan(/(^|[^0-9a-zA-Z_])(goto)[^0-9a-zA-Z]/) do
        msg_brackets = '[' + @file_path + ':' + line_nb.to_s + ']'
        msg_error = " Keyword may be forbidden: '".bold
        msg_error += Regexp.last_match(2).bold.red
        msg_error += "'?".bold
        puts(msg_brackets.bold.red + msg_error)
      end
      line_nb += 1
    end
  end

  def check_too_many_else_if
    line_nb = condition_start = 1
    count = 0
    @file.each_line do |line|
      line[0] = '' while [' ', "\t"].include?(line[0])
      if line =~ /^if ?\(/
        condition_start = line_nb
        count = 1
      elsif line =~ /^else if ?\(/ || line =~ /^else ?\(/
        count += 1
        if count > 3
          msg_brackets = '[' + @file_path + ':' + condition_start.to_s + ']'
          msg_error = ' Too many "else if".'
          puts(msg_brackets.bold.green + msg_error.bold)
        end
      end
      line_nb += 1
    end
  end

  def check_trailing_spaces_tabs
    line_nb = 1
    @file.each_line do |line|
      if line =~ / $/
        msg_brackets = '[' + @file_path + ':' + line_nb.to_s + ']'
        msg_error = ' Trailing space, end of the line.'
        puts(msg_brackets.bold.green + msg_error.bold)
      elsif line =~ /\t$/
        msg_brackets = '[' + @file_path + ':' + line_nb.to_s + ']'
        msg_error = ' Trailing tab(s), end of the line.'
        puts(msg_brackets.bold.green + msg_error.bold)
      end
      line_nb += 1
    end
  end

  def check_spaces_in_indentation
    line_nb = 1
    @file.each_line do |line|
      if line =~ /^\/\**/ # skip block comment start
        line_nb += 1
        next
      elsif line =~ /^*\*\// # skip block comment end
        line_nb += 1
        next
      elsif line =~ /^\/\/*/ # skip comment
        line_nb += 1
        next
      elsif line =~ /^ \**/ # skip doxygen lines
        line_nb += 1
        next
      end

      indent = 0
      while line[indent] == " "
        indent += 1
      end
      if indent % 4 != 0
        msg_brackets = '[' + @file_path + ':' + line_nb.to_s + ']'
        msg_error = ' Wrong indentation.'
        puts(msg_brackets.bold.green + msg_error.bold)
      end
      line_nb += 1
    end
  end

  def check_functions_per_file
    functions = 0
    @file.each_line do |line|
      functions += 1 if line =~ /^{/
    end
    if functions > 5
      msg_brackets = '[' + @file_path + ']'
      msg_error = ' More than 5 functions (' + functions.to_s + ' > 5).'
      puts(msg_brackets.bold.red + msg_error.bold)
    end
  end

  def check_empty_parenthesis
    line_nb = 1
    missing_bracket = false
    @file.each_line do |line|
      if missing_bracket
        if line =~ /^{$/
          msg_brackets = '[' + @file_path + ':' + line_nb.to_s + ']'
          msg_error = " No-parameter function should take void as argument."
          puts(msg_brackets.bold.red + msg_error.bold)
        elsif line !~ /^[\t ]*$/
          missing_bracket = false
        end
      elsif line =~ /\(\)[\t ]*{$/
        msg_brackets = '[' + @file_path + ':' + line_nb.to_s + ']'
          msg_error = " No-parameter function should take void as argument."
        puts(msg_brackets.bold.red + msg_error.bold)
      elsif line =~ /\(\)[ \t]*$/
        missing_bracket = true
      end
      line_nb += 1
    end
  end

  def check_too_many_parameters
    @file.scan(/\(([^(),]*,){4,}[^()]*\)[ \t\n]+{/).each do |_match|
      msg_brackets = '[' + @file_path + ']'
      msg_error = " Function takes more than 4 arguments."
      puts(msg_brackets.bold.red + msg_error.bold)
    end
  end

  def check_space_after_keywords
    line_nb = 1
    @file.each_line do |line|
      line.scan(/(return|if|else if|else|while|for)\(/) do |match|
        msg_brackets = '[' + @file_path + ':' + line_nb.to_s + ']'
        msg_error = " Missing space after '" + match[0] + "'."
        puts(msg_brackets.bold.green + msg_error.bold)
      end
      line_nb += 1
    end
  end

  def check_misplaced_pointer_symbol
    line_nb = 1
    @file.each_line do |line|
      if line =~ /^ \**/ # skip doxygen lines
        line_nb += 1
        next
      end
      line.scan(/([^(\t ]+_t|int|signed|unsigned|char|long|short|float|double|void|const|struct [^ ]+)\*/) do |match|
        msg_brackets = '[' + @file_path + ':' + line_nb.to_s + ']'
        msg_error = " Misplaced pointer symbol after '" + match[0] + "'."
        puts(msg_brackets.bold.green + msg_error.bold)
      end
      line_nb += 1
    end
  end

  def check_macro_used_as_constant
    line_nb = 1
    @file.each_line do |line|
      if line =~ /#define [^ ]+ [0-9]+([.][0-9]+)?/
        msg_brackets = '[' + @file_path + ':' + line_nb.to_s + ']'
        msg_error = ' Macros should not be used for constants.'
        puts(msg_brackets.bold.green + msg_error.bold)
      end
      line_nb += 1
    end
  end

  def check_header_makefile
    if @file !~ /##\n## EPITECH PROJECT, [0-9]{4}\n## .*\n## File description:\n## .*\n##\n.*/
      msg_brackets = '[' + @file_path + ']'
      msg_error = ' Missing or corrupted header.'
      puts(msg_brackets.bold.red + msg_error.bold)
    end
  end

  def check_misplaced_comments
    level = 0
    line_nb = 1
    @file.each_line do |line|
      level += line.count '{'
      level -= line.count '}'
      if (level != 0) && (line =~ /\/\*/ || line =~ /\/\//)
        msg_brackets = '[' + @file_path + ':' + line_nb.to_s + ']'
        msg_error = ' Comment in the code.'
        puts(msg_brackets.bold.green + msg_error.bold)
      end
      line_nb += 1
    end
  end

  def check_comma_missing_space
    line_nb = 1
    @file.each_line do |line|
      line.scan(/,[^ \n]/) do
        msg_brackets = '[' + @file_path + ':' + line_nb.to_s + ']'
        msg_error = ' Missing space after comma.'
        puts(msg_brackets.bold.green + msg_error.bold)
      end
      line_nb += 1
    end
  end

  def put_error_sign(sign, line_nb)
    msg_brackets = '[' + @file_path + ':' + line_nb.to_s + ']'
    msg_error = " Misplaced space(s) around '" + sign + "' sign."
    puts(msg_brackets.bold.green + msg_error.bold)
  end

  def check_operators_spaces
    line_nb = 1
    @file.each_line do |line|
      # A space on both ends
      line.scan(/([^\t&|=^><+\-*%\/! ]=[^=]|[^&|=^><+\-*%\/!]=[^= \n])/) do
        put_error_sign('=', line_nb)
      end
      line.scan(/([^\t ]==|==[^ \n])/) do
        put_error_sign('==', line_nb)
      end
      line.scan(/([^\t ]!=|!=[^ \n])/) do
        put_error_sign('!=', line_nb)
      end
      line.scan(/([^\t <]<=|[^<]<=[^ \n])/) do
        put_error_sign('<=', line_nb)
      end
      line.scan(/([^\t >]>=|[^>]>=[^ \n])/) do
        put_error_sign('>=', line_nb)
      end
      line.scan(/([^\t ]&&|&&[^ \n])/) do
        put_error_sign('&&', line_nb)
      end
      line.scan(/([^\t ]\|\||\|\|[^ \n])/) do
        put_error_sign('||', line_nb)
      end
      line.scan(/([^\t ]\+=|\+=[^ \n])/) do
        put_error_sign('+=', line_nb)
      end
      line.scan(/([^\t ]-=|-=[^ \n])/) do
        put_error_sign('-=', line_nb)
      end
      line.scan(/([^\t ]\*=|\*=[^ \n])/) do
        put_error_sign('*=', line_nb)
      end
      line.scan(/([^\t ]\/=|\/=[^ \n])/) do
        put_error_sign('/=', line_nb)
      end
      line.scan(/([^\t ]%=|%=[^ \n])/) do
        put_error_sign('%=', line_nb)
      end
      line.scan(/([^\t ]&=|&=[^ \n])/) do
        put_error_sign('&=', line_nb)
      end
      line.scan(/([^\t ]\^=|\^=[^ \n])/) do
        put_error_sign('^=', line_nb)
      end
      line.scan(/([^\t ]\|=|\|=[^ \n])/) do
        put_error_sign('|=', line_nb)
      end
      line.scan(/([^\t |]\|[^|]|[^|]\|[^ =|\n])/) do
        # Minifix for Matchstick
        line.scan(/([^']\|[^'])/) do
          put_error_sign('|', line_nb)
        end
      end
      line.scan(/([^\t ]\^|\^[^ =\n])/) do
        put_error_sign('^', line_nb)
      end
      line.scan(/([^\t ]>>[^=]|>>[^ =\n])/) do
        put_error_sign('>>', line_nb)
      end
      line.scan(/([^\t ]<<[^=]|<<[^ =\n])/) do
        put_error_sign('<<', line_nb)
      end
      line.scan(/([^\t ]>>=|>>=[^ \n])/) do
        put_error_sign('>>=', line_nb)
      end
      line.scan(/([^\t ]<<=|<<=[^ \n])/) do
        put_error_sign('<<=', line_nb)
      end
      # No space after
      line.scan(/([^!]! )/) do
        put_error_sign('!', line_nb)
      end
      line.scan(/([^a-zA-Z0-9]sizeof )/) do
        put_error_sign('sizeof', line_nb)
      end
      line.scan(/([^a-zA-Z)\]]\+\+[^(\[*a-zA-Z])/) do
        put_error_sign('++', line_nb)
      end
      line.scan(/([^a-zA-Z)\]]--[^\[(*a-zA-Z])/) do
        put_error_sign('--', line_nb)
      end
      line_nb += 1
    end
  end

  def check_condition_assignment
    line_nb = 1
    @file.each_line do |line|
      line.scan(/(if.*[^&|=^><+\-*%\/!]=[^=].*==.*)|(if.*==.*[^&|=^><+\-*%\/!]=[^=].*)/) do
        msg_brackets = '[' + @file_path + ':' + line_nb.to_s + ']'
        msg_error = ' Condition and assignment on the same line.'
        puts(msg_brackets.bold.green + msg_error.bold)
      end
      line_nb += 1
    end
  end

  def check_empty_line_between_functions
    @file.scan(/\n{3,}^[^ \n\t]+ [^ \n\t]+\([^\n\t]*\)/).each do |_match|
      msg_brackets = '[' + @file_path + ']'
      msg_error = ' Empty lines between functions.'
      puts(msg_brackets.bold.green + msg_error.bold)
    end
    @file.scan(/[^\n]\n^[^ \n\t]+ [^ \n\t]+\([^\n\t]*\)/).each do |_match|
/      msg_brackets = '[' + @file_path + ']'
      msg_error = ' Missing empty line between functions.'
      puts(msg_brackets.bold.green + msg_error.bold)
/   end
  end
end

class UpdateManager
  def initialize(script_path)
    path = File.dirname(script_path)
    tmp_dir = Dir.tmpdir
    @script_path = script_path
    @remote_path = "#{tmp_dir}/__normez_remote"
    @backup_path = "#{tmp_dir}/__normez_backup"
    @remote = system("curl -s https://raw.githubusercontent.com/ronanboiteau/NormEZ/master/NormEZ.rb > #{@remote_path}")
  end

  def clean_update_files
    system("rm -rf #{@backup_path}")
    system("rm -rf #{@remote_path}")
  end

  def can_update
    unless @remote
      clean_update_files
      return false
    end
    @current = `cat #{@script_path} | grep 'NormEZ_v' | cut -c 11- | head -1 | tr -d '.'`
    @latest = `cat #{@remote_path} | grep 'NormEZ_v' | cut -c 11- | head -1 | tr -d '.'`
    @latest_disp = `cat #{@remote_path} | grep 'NormEZ_v' | cut -c 11- | head -1`
    return true if @current < @latest
    clean_update_files
    false
  end

  def update
    if @current < @latest
      update_msg = `cat #{@remote_path} | grep 'Changelog: ' | cut -c 14- | head -1 | tr -d '.'`
      print("A new version is available: Norminette v#{@latest_disp}".bold.yellow)
      print(' => Changelog: '.bold)
      print(update_msg.to_s.bold.blue)
      response = nil
      Kernel.loop do
        print('Update NormEZ? [Y/n]: ')
        response = gets.chomp
        break if ['N', 'n', 'no', 'Y', 'y', 'yes', ''].include?(response)
      end
      if %w[N n no].include?(response)
        puts('Update skipped. You can also use the --no-update (or -u) option to prevent auto-updating.'.bold.blue)
        clean_update_files
        return
      end
      puts('Downloading update...')
      system("cat #{@script_path} > #{@backup_path}")
      exit_code = system("cat #{@remote_path} > #{@script_path}")
      unless exit_code
        print('Error while updating! Cancelling...'.bold.red)
        system("cat #{@backup_path} > #{@script_path}")
        clean_update_files
        Kernel.exit(false)
      end
      clean_update_files
      puts('NormEZ has been successfully updated!'.bold.green)
      Kernel.exit(true)
    end
  end
end

$options = {}
opt_parser = OptionParser.new do |opts|
  opts.banner = 'Usage: `ruby ' + $PROGRAM_NAME + ' [-ufmi]`'
  opts.on('-u', '--no-update', "Don't check for updates") do |o|
    $options[:noupdate] = o
  end
  opts.on('-f', '--ignore-files', 'Ignore forbidden files') do |o|
    $options[:ignorefiles] = o
  end
  opts.on('-m', '--ignore-functions', 'Ignore forbidden functions') do |o|
    $options[:ignorefunctions] = o
  end
  opts.on('-i', '--ignore-all', 'Ignore forbidden files & forbidden functions (same as `-fm`)') do |o|
    $options[:ignorefiles] = o
    $options[:ignorefunctions] = o
  end
end

begin
  opt_parser.parse!
rescue OptionParser::InvalidOption => e
  puts('Error: ' + e.to_s)
  puts(opt_parser.banner)
  Kernel.exit(false)
end

unless $options.include?(:noupdate)
  updater = UpdateManager.new($PROGRAM_NAME)
  updater.update if updater.can_update
end

files_retriever = FilesRetriever.new
while (next_file = files_retriever.get_next_file)
  CodingStyleChecker.new(next_file)
end