immosquare-cleaner 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50795a36ff8dc13390b41e0b9dd90bfc022369bee4e16f42d143e913340fbbb1
-  data.tar.gz: 995716de9e442829586399ad171d12090fe78a343f6c4085318074c321665a36
+  metadata.gz: ab3996336fc3c838878d792d3a32f07f39bb28c403851d5e6e14997ee210df90
+  data.tar.gz: cbe3806e171f5aa52f2dac90ab0959e297dcb81b0e78699eee61f4dd49a5e8f1
 SHA512:
-  metadata.gz: d80eac3c3314a34b279a1fe3c2ede81ec840b919cbc22ffc7fa3266f234a860b46d0651a16f59b03a148841c623dde689a1d87e272934a0d96ad3c3401c5e486
-  data.tar.gz: 1ce219e30239ad611e26c3dff48860bdfcbb7fd3024501fcde44733733d1835de09b8943425cf94ff896b7c54f32a3138c45cb27254026f27ea6132a24aa462d
+  metadata.gz: b3de83f33a8c826458e50c7b9801687d5a6c14dca1c52126bc63d38bfb7a8f900086506b3304e5cc17df582ebf8c335a7da4c816bb2a6df89fd8742734bd18ea
+  data.tar.gz: '039ec5621025a918e3c2a75ff7e0a7466c322548e8c92574ee735a4e4b4671b42f4e57c4c01290a992de2186b3e61fb47f1c5d4c681b051c6e25e7a39b7ea0dd'

data/lib/immosquare-cleaner/markdown.rb

@@ -0,0 +1,102 @@
+module ImmosquareCleaner
+  module Markdown
+    class << self
+
+
+      ##============================================================##
+      ## we want to clean the markdown files to have a uniform style
+      ## for the tables.
+      ##============================================================##
+      def clean(file_path)
+        results           = []
+        array_to_parse    = []
+        prev_line_special = false
+
+        ##============================================================##
+        ## We parse each line of the file
+        ##============================================================##
+        File.foreach(file_path) do |line|
+          if line.lstrip.start_with?("|")
+            array_to_parse << line
+          else
+            if !array_to_parse.empty?
+              results << cleaned_array(array_to_parse)
+              array_to_parse = []
+            end
+            new_line, prev_line_special = cleaned_line(line, prev_line_special)
+            results << new_line
+          end
+        end
+
+        ##============================================================##
+        ## Handle the case where the file ends with a table
+        ##============================================================##
+        results << cleaned_array(array_to_parse) if !array_to_parse.empty?
+
+        results.join
+      end
+
+
+      private
+
+      def cleaned_array(array_to_clean)
+        ##============================================================##
+        ## We split each line of the array and remove the empty cells
+        ## we also save the max lenght of each position in x.
+        ##============================================================##
+        elements_size = []
+        rows = array_to_clean.map do |line|
+          cells = line.split("|").map(&:strip).reject(&:empty?)
+
+          ##============================================================##
+          ## We increase the size of the array if needed
+          ##============================================================##
+          elements_size += Array.new(cells.length - elements_size.size, 0) if cells.length > elements_size.length
+
+          ##============================================================##
+          ## We update the max length of each position in x
+          ##============================================================##
+          cells.map(&:length).zip(elements_size).each_with_index do |(cell_length, max_length), index|
+            elements_size[index] = [cell_length, max_length].max
+          end
+
+          cells
+        end
+
+        ##============================================================##
+        ## We fill the empty cells with nil to have uniform rows
+        ##============================================================##
+        rows.each {|row| row.fill(nil, row.length...elements_size.size) }
+
+
+        formatted_rows = rows.map do |row|
+          line = row.each_with_index.map do |cell, index|
+            max_length = elements_size[index]
+            cell =
+              if cell&.match(/^-*$/)
+                "-" * max_length
+              else
+                cell.to_s.ljust(max_length)
+              end
+          end.join(" | ")
+          "| #{line} |"
+        end
+
+        "#{formatted_rows.join("\n")}\n"
+      end
+
+      ##============================================================##
+      ## We simply add a newline at the end of the line if needed
+      ##============================================================##
+      def cleaned_line(line, prev_line_special)
+        cleaned           = line.rstrip
+        blank_line        = line.gsub("\n", "").empty?
+        special           = cleaned.lstrip.start_with?("*", "-", "+")
+        new_line          = "#{"\n" if prev_line_special && !blank_line}#{cleaned}\n"
+        prev_line_special = special
+        [new_line, prev_line_special]
+      end
+
+    end
+  end
+end

data/lib/immosquare-cleaner/version.rb

@@ -1,3 +1,3 @@
 module ImmosquareCleaner
-  VERSION = "0.1.10".freeze
+  VERSION = "0.1.11".freeze
 end

data/lib/immosquare-cleaner.rb

@@ -2,6 +2,7 @@ require "English"
 require "immosquare-yaml"
 require "immosquare-extensions"
 require_relative "immosquare-cleaner/configuration"
+require_relative "immosquare-cleaner/markdown"
 require_relative "immosquare-cleaner/railtie" if defined?(Rails)
 
 ##===========================================================================##
@@ -91,6 +92,17 @@ module ImmosquareCleaner
           return
         end
 
+        ##============================================================##
+        ## Markdown files
+        ##============================================================##
+        if file_path.end_with?(".md", ".md.erb")
+          formatted_md = ImmosquareCleaner::Markdown.clean(file_path)
+          File.write(file_path, formatted_md)
+          normalize_last_line(file_path)
+          return
+        end
+
+
         ##============================================================##
         ## Autres formats
         ##============================================================##

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: immosquare-cleaner
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
 platform: ruby
 authors:
 - IMMO SQUARE
@@ -10,20 +10,6 @@ bindir: bin
 cert_chain: []
 date: 2023-10-01 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
 - !ruby/object:Gem::Dependency
   name: erb_lint
   requirement: !ruby/object:Gem::Requirement
@@ -92,6 +78,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.16
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 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.
@@ -105,6 +105,7 @@ files:
 - bin/immosquare-cleaner
 - lib/immosquare-cleaner.rb
 - lib/immosquare-cleaner/configuration.rb
+- lib/immosquare-cleaner/markdown.rb
 - lib/immosquare-cleaner/railtie.rb
 - lib/immosquare-cleaner/version.rb
 - lib/tasks/immosquare_cleaner.rake