immosquare-cleaner 0.1.53 → 0.1.55

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9196f9f8512b09892046a08e62a7d88651c64a303de24c06939f879892e52cf7
-  data.tar.gz: ebb02f2943eec1220d90bd122fb8eb74e93924e08e140d03d869dc9a046f2f35
+  metadata.gz: 65d2e535ec442aca2a519d4fabfcd0b12f657d5de198c23113f10408c1eb29d8
+  data.tar.gz: 599c4fa0d4699527fa9d3f120beab4ef1ba632e57de22a47f85528e63f88bb89
 SHA512:
-  metadata.gz: fad7b547a77506b0c92bc672a395e0ccee00ca2f7092fb838d9b621138e059bd57bc74e5317d0fbb4228a65899d1c591704e2f30fa8e0118afa0ce65c133da3a
-  data.tar.gz: ea5754c29eaf9d6bcd7f2e7b1531808d8a540a021f28f446d36cbd159ccd400c33cf2a1ed691da9b43ce096bf86408f5b4f625f3ed897d417029daa336b6e1da
+  metadata.gz: 777ae6c1cfbf3513c31d1c26f407821a9eb8885f4d06ea5b5bd8c9d43f7e18ab88f24acf1828da08e0b393ab51d28c059e38b9d8be9336f3f48abe6f5793f115
+  data.tar.gz: b8c2d69225ec9b7e09ddb81610899a191b65387dafbd22a74693f0ec1e28aa1eb19388f80aee252fd9d4c91f14a0f8993a9d7d954449e6950b5969d5c134c98b

data/bin/immosquare-cleaner

@@ -4,9 +4,9 @@ require "immosquare-cleaner"
 require "optparse"
 
 
-##===========================================================================##
+##============================================================##
 ## We check if bun.sh is installed
-##===========================================================================##
+##============================================================##
 def bun_installed?
   system("which bun > /dev/null 2>&1")
 end
@@ -18,49 +18,49 @@ end
 
 
 options = {}
-##===========================================================================##
-## optparse is a standard library of ruby, it's used to parse command line   ##
-##===========================================================================##
+##============================================================##
+## optparse is a standard library of ruby, it's used to parse command line
+##============================================================##
 OptionParser.new do |opts|
   opts.banner = "Usage: immosquare-cleaner [options] file"
 
-  ##===========================================================================##
-  ## Capture all single-letter options (like '-t', '-a', etc.)                 ##
-  ##===========================================================================##
+  ##============================================================##
+  ## Capture all single-letter options (like '-t', '-a', etc.)
+  ##============================================================##
   ("a".."z").each do |letter|
     opts.on("-#{letter} [OPTION]", "Option -#{letter}") do |value|
       options[letter.to_sym] = value
     end
   end
 
-  ##===========================================================================##
-  ## If you also want to capture longer options, add them here                 ##
-  ## Example:                                                                  ##
-  ## opts.on("--tag TAG", "Tag option") do |t|                                 ##
-  ##   options[:tag] = t                                                       ##
-  ## end                                                                       ##
-  ##===========================================================================##
+  ##============================================================##
+  ## If you also want to capture longer options, add them here
+  ## Example:
+  ## opts.on("--tag TAG", "Tag option") do |t|
+  ##   options[:tag] = t
+  ## end
+  ##============================================================##
 end.parse!
 
-##===========================================================================##
-## Check if the file path is provided                                         ##
-##===========================================================================##
+##============================================================##
+## Check if the file path is provided
+##============================================================##
 file_path = ARGV[0]
 if !file_path
   puts("Error: Please provide a file path.")
   exit 1
 end
 
-##===========================================================================##
-## Check if the file exists                                                   ##
-##===========================================================================##
+##============================================================##
+## Check if the file exists
+##============================================================##
 if !File.exist?(file_path)
   puts("Error: The file '#{file_path}' does not exist.")
   exit 1
 end
 
 
-##===========================================================================##
-## We can now call the clean method, passing the file path and options        ##
-##===========================================================================##
+##============================================================##
+## We can now call the clean method, passing the file path and options
+##============================================================##
 ImmosquareCleaner.clean(file_path, **options)

data/lib/immosquare-cleaner/version.rb

@@ -1,3 +1,3 @@
 module ImmosquareCleaner
-  VERSION = "0.1.53".freeze
+  VERSION = "0.1.55".freeze
 end

data/lib/immosquare-cleaner.rb

@@ -7,24 +7,24 @@ require_relative "immosquare-cleaner/configuration"
 require_relative "immosquare-cleaner/markdown"
 require_relative "immosquare-cleaner/railtie" if defined?(Rails)
 
-##===========================================================================##
+##============================================================##
 ## Importing the 'English' library allows us to use more human-readable
 ## global variables, such as $INPUT_RECORD_SEPARATOR instead of $/,
 ## which enhances code clarity and makes it easier to understand
 ## the purpose of these variables in our code.
-##===========================================================================##
+##============================================================##
 module ImmosquareCleaner
   class << self
 
-    ##===========================================================================##
+    ##============================================================##
     ## Constants
-    ##===========================================================================##
+    ##============================================================##
     SHEBANG    = "#!/usr/bin/env ruby".freeze
     RUBY_FILES = [".rb", ".rake", "Gemfile", "Rakefile", ".axlsx", ".gemspec", ".ru", ".podspec", ".jbuilder", ".rabl", ".thor", "config.ru", "Berksfile", "Capfile", "Guardfile", "Podfile", "Thorfile", "Vagrantfile"].freeze
 
-    ##===========================================================================##
+    ##============================================================##
     ## Gem configuration
-    ##===========================================================================##
+    ##============================================================##
     attr_writer :configuration
 
     def configuration
@@ -72,7 +72,13 @@ module ImmosquareCleaner
             File.write(rubocop_config_with_version_path, rubocop_config.to_yaml)
           end
 
-          cmds = ["bundle exec rubocop -c #{rubocop_config_with_version_path} \"#{file_path}\" #{ImmosquareCleaner.configuration.rubocop_options || "--autocorrect-all"}"]
+          ##============================================================##
+          ## --autocorrect-all : Auto-correct all offenses that RuboCop can correct, and leave all other offenses unchanged.
+          ## --no-parallel : Disable RuboCop's parallel processing for performance reasons because we pass only one file
+          ##============================================================##
+          rubocop_options = ImmosquareCleaner.configuration.rubocop_options || "--autocorrect-all --no-parallel"
+
+          cmds = ["bundle exec rubocop -c #{rubocop_config_with_version_path} \"#{file_path}\" #{rubocop_options}"]
           launch_cmds(cmds)
           File.normalize_last_line(file_path)
           return
@@ -89,13 +95,15 @@ module ImmosquareCleaner
         ##============================================================##
         ## JS files
         ## 16/05/2024
-        ## Depuis eslint V9 (acutellement en V9.2.0), il y a des
+        ## ---------
+        ## Depuis eslint V9 (acutellement en V9.15.0), il y a des
         ## erreurs/warnings
         ## File ignored because of a matching ignore pattern. Use "--no-ignore" to disable file ignore settings or use "--no-warn-ignored" to suppress this warning
-        ## alors que le fichier ne devrait pas être ignoré...
+        ## ---------
         ## Cela se produit quand le fichier est dans un dossier supérieur
-        ## à celui de la racine du gem. Pour éviter ce problème on
-        ## met le fichier dans un dossier temporaire et on le supprime
+        ## à celui de la racine du gem. (donc quand on lance depuis une application)
+        ## le fichier est ignoré par eslint car il est dans un dossier supérieur
+        ## Pour éviter ce problème on met le fichier dans un dossier temporaire et on le supprime
         ## par la suite.
         ##============================================================##
         begin
@@ -157,10 +165,10 @@ module ImmosquareCleaner
       File.expand_path("..", __dir__)
     end
 
-    ##===========================================================================##
+    ##============================================================##
     ## We change the current directory to the gem root to ensure the gem's paths
     ## are used when executing the commands
-    ##===========================================================================##
+    ##============================================================##
     def launch_cmds(cmds)
       Dir.chdir(gem_root) do
         cmds.each {|cmd| system(cmd) }

data/lib/tasks/immosquare_cleaner.rake

@@ -1,18 +1,18 @@
 namespace :immosquare_cleaner do
   ##============================================================##
-  ## Function to clean translation files in rails app
+  ## Function to clean files in rails app
   ##============================================================##
-  desc "Clean translation files in rails app"
-  task :clean => :environment do
+  desc "clean files in rails app"
+  task :clean_app => :environment do
     file_paths = Dir.glob("#{Rails.root}/**/*").reject do |file_path|
-      test1 = file_path.gsub("#{Rails.root}/", "")
-      File.directory?(file_path) ||
-        test1.start_with?("node_modules", "tmp", "public", "log", "app/assets/builds", "app/assets/fonts", "app/assets/images", "vendor") ||
-        file_path.end_with?(".lock", ".lockb")
+      File.directory?(file_path) || file_path.gsub("#{Rails.root}/", "").start_with?("node_modules", "tmp", "public", "log", "app/assets/builds", "app/assets/fonts", "app/assets/images", "vendor") || file_path.end_with?(".lock", ".lockb")
     end
-    file_paths.each do |file|
-      puts file
-      ImmosquareCleaner.clean(file)
+
+    puts "Cleaning files..."
+
+    file_paths.each.with_index do |file_path, index|
+      puts "#{index + 1}/#{file_paths.size} - #{file_path}"
+      ImmosquareCleaner.clean(file_path)
     end
   end
 end

data/linters/rubocop/cop/custom_cops/style/comment_normalization.rb

@@ -0,0 +1,132 @@
+module RuboCop
+  module Cop
+    module CustomCops
+      module Style
+        class CommentNormalization < Base
+
+          extend AutoCorrector
+
+          MSG         = "Comments should be normalized with the standard format if start with ##".freeze
+          BORDER_LINE = "###{"=" * 60}##".freeze
+          SPACE       = " ".freeze
+
+          def on_new_investigation
+            comment_blocks = find_comment_blocks(processed_source.comments)
+
+            comment_blocks.each do |block|
+              if needs_correction?(block)
+                ##============================================================##
+                ## Pour désactiver les cops suivants
+                ##============================================================##
+                buffer    = processed_source.buffer
+                start_pos = buffer.line_range(block.first.location.line).begin_pos
+                end_pos   = buffer.line_range(block.last.location.line).end_pos
+                range     = Parser::Source::Range.new(buffer, start_pos, end_pos)
+                ignore_node(range)
+
+                ##============================================================##
+                ## Puis, on ajoute l'offense
+                ##============================================================##
+                add_offense(block.first) do |corrector|
+                  corrector.replace(range, normalize_comment_block(block))
+                end
+              end
+            end
+          end
+
+          private
+
+
+          ##============================================================##
+          ## On ne veut traiter que les commentaires qui :
+          ## - commencent par ## (et non #)
+          ## - ne sont pas des commentaires de fin de ligne ruby
+          ##============================================================##
+          def find_comment_blocks(comments)
+            blocks            = []
+            current_block     = []
+            filtered_comments = comments.select {|comment| line_content(comment).strip.start_with?("##") }
+
+            filtered_comments.each do |comment|
+              if current_block.empty? || comment.location.line == current_block.last.location.line + 1
+                current_block << comment
+              else
+                blocks << current_block
+                current_block = [comment]
+              end
+            end
+
+            blocks << current_block
+            blocks
+          end
+
+          ##============================================================##
+          ## Nous n'avons pas besoin de corriger les commentaires si :
+          ## - le premier et le dernier commentaire sont des lignes de bordure
+          ## - tous les commentaires commencent par ##
+          ## - il n'y a pas de ligne autre que les lignes de bordure qui commence par ##=
+          ##============================================================##
+          def needs_correction?(block)
+            return false if block.compact.empty?
+
+
+            return false if block.first.text == BORDER_LINE &&
+                            block.last.text == BORDER_LINE &&
+                            block.all? {|comment| comment.text.start_with?("##") } &&
+                            block.each_with_index.none? do |comment, index|
+                              index != 0 &&
+                              index != block.length - 1 &&
+                              comment.text.start_with?("##=")
+                            end
+
+            true
+          end
+
+          ##============================================================##
+          ## Pour formater correctement le block de commentaires
+          ##============================================================##
+          def normalize_comment_block(block)
+            indent_level = indent_level(block.first)
+            body         = block.map.with_index do |comment, index|
+              ##============================================================##
+              ## On met un espace après les ## si le caractère n'est pas un espace
+              ##============================================================##
+              text = comment.text.to_s.strip
+              text = text.gsub(/^##(?![=\s])/, "###{SPACE}")
+              if text.start_with?("##=")
+                index == 0 || index == block.size - 1 ? nil : "###{SPACE}---------"
+              else
+                text = "###{SPACE}#{text}" if !text.start_with?("###{SPACE}")
+                text = text.chomp("##").strip
+                text
+              end
+            end.compact
+
+
+            ##============================================================##
+            ## Le block va être remis à la place du block original sur
+            ## la colone du block original. Donc la première ligne du block
+            ## ne doit pas être indentée manuellement. Par contre les autres
+            ## lignes doivent être indentées sur la même colonne que la première
+            ##============================================================##
+            [BORDER_LINE, body, BORDER_LINE].flatten.map.with_index {|line, index| index == 0 ? line : "#{SPACE * indent_level}#{line}" }.join("\n")
+          end
+
+          ##============================================================##
+          ## Pour récupérer le contenu de la ligne courante
+          ##============================================================##
+          def line_content(comment)
+            processed_source.lines[comment.location.line - 1]
+          end
+
+          def indent_level(line)
+            line_content(line)[/\A */].size
+          end
+
+
+
+        end
+      end
+    end
+  end
+end

data/linters/rubocop-3.3.6.yml

@@ -2,6 +2,7 @@
 require:
 - rubocop/cop/style/method_call_with_args_parentheses_override
 - rubocop/cop/custom_cops/style/use_credentials_instead_of_env
+- rubocop/cop/custom_cops/style/comment_normalization
 AllCops:
   NewCops: enable
   EnabledByDefault: false
@@ -93,5 +94,7 @@ Style/MethodCallWithArgsParentheses:
   Enabled: true
 CustomCops/Style/UseCredentialsInsteadOfEnv:
   Enabled: true
+CustomCops/Style/CommentNormalization:
+  Enabled: true
 Gemspec/RequireMFA:
   Enabled: false

data/linters/rubocop.yml

@@ -1,6 +1,7 @@
 require:
   - rubocop/cop/style/method_call_with_args_parentheses_override
   - rubocop/cop/custom_cops/style/use_credentials_instead_of_env
+  - rubocop/cop/custom_cops/style/comment_normalization
 
 # Pour activer toutes les méthodes de Rubocop et activer le cache pour les gros fichiers
 AllCops:
@@ -108,6 +109,8 @@ Style/MethodCallWithArgsParentheses:
 #################### CUSTOMS ###########################
 CustomCops/Style/UseCredentialsInsteadOfEnv:
   Enabled: true # On veut forcer l'utilisation de credentials au lieu de ENV pour les secrets
+CustomCops/Style/CommentNormalization:
+  Enabled: true # On veut forcer la normalisation des commentaires
 
 #################### GEM ###########################
 Gemspec/RequireMFA:

metadata

@@ -1,103 +1,114 @@
 --- !ruby/object:Gem::Specification
 name: immosquare-cleaner
 version: !ruby/object:Gem::Version
-  version: 0.1.53
+  version: 0.1.55
 platform: ruby
-original_platform: ''
 authors:
 - immosquare
 bindir: bin
 cert_chain: []
-date: 2024-12-20 00:00:00.000000000 Z
+date: 2024-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb_lint
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1000.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '1000.0'
 - !ruby/object:Gem::Dependency
   name: htmlbeautifier
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.4'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '1000.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1000.0'
 - !ruby/object:Gem::Dependency
   name: immosquare-extensions
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.18
+        version: '0.1'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '1000.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.18
+        version: '0.1'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '1000.0'
 - !ruby/object:Gem::Dependency
   name: immosquare-yaml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.26
+        version: '0.1'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '1000.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.26
+        version: '0.1'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '1000.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.62.1
+        version: '1.68'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '1000.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.62.1
+        version: '1.68'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '1000.0'
 description: Immosquare-cleaner streamlines Rails applications by running tools like
   RuboCop, ERBLint, Stylelint and more. It ensures code quality, readability, and
   consistency across the application.
@@ -121,6 +132,7 @@ files:
 - linters/prettier.yml
 - linters/rubocop-3.3.6.yml
 - linters/rubocop.yml
+- linters/rubocop/cop/custom_cops/style/comment_normalization.rb
 - linters/rubocop/cop/custom_cops/style/use_credentials_instead_of_env.rb
 - linters/rubocop/cop/style/method_call_with_args_parentheses_override.rb
 - node_modules/.bin/acorn
@@ -34471,7 +34483,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.2
+      version: 3.1.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="