immosquare-cleaner 0.1.9 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98bc0c5d08586d949016612f1b71710b03b39a61bdcc58cdb2f8b50f50ef7267
-  data.tar.gz: a79fa8ac332aae164826244e4f9c29cb87fcf7805139ae86935e95826630e2bd
+  metadata.gz: ab3996336fc3c838878d792d3a32f07f39bb28c403851d5e6e14997ee210df90
+  data.tar.gz: cbe3806e171f5aa52f2dac90ab0959e297dcb81b0e78699eee61f4dd49a5e8f1
 SHA512:
-  metadata.gz: 05b155d7be55971a077c178fd654b8b873ce99679ae84752a24943b928601ef2c2418fb7009f71717f070438f4fe82d292410a93c57be4a31cc4946e7357965d
-  data.tar.gz: eced9939a2eac63dd18dfd7fbce06bf641459bd78f984055de86d79a410445fb31f7d8fb001d72b89be84208fd9b410f912c342282a3b648cc1a67b75d1feac8
+  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.9".freeze
+  VERSION = "0.1.11".freeze
 end

data/lib/immosquare-cleaner.rb

@@ -1,6 +1,8 @@
 require "English"
-require "neatjson"
+require "immosquare-yaml"
+require "immosquare-extensions"
 require_relative "immosquare-cleaner/configuration"
+require_relative "immosquare-cleaner/markdown"
 require_relative "immosquare-cleaner/railtie" if defined?(Rails)
 
 ##===========================================================================##
@@ -84,12 +86,23 @@ module ImmosquareCleaner
         if file_path.end_with?(".json")
           json_str    = File.read(file_path)
           parsed_data = JSON.parse(json_str)
-          formated    = JSON.neat_generate(parsed_data, :aligned => true)
+          formated    = parsed_data.to_beautiful_json
           File.write(file_path, formated)
           normalize_last_line(file_path)
           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
         ##============================================================##

data/linters/eslintrc.json

@@ -1,30 +1,57 @@
 {
-  "env"           :{"browser":true,"es2021":true},
-  "ignorePatterns":["package.json"],
-  "extends"       :["airbnb-base","plugin:jsonc/recommended-with-jsonc"],
-  "overrides"     :[],
-  "parserOptions" :{"ecmaVersion":"latest","sourceType":"module"},
-  "rules"         :{
-    "quotes"                 :[2,"double"],
-    "semi"                   :[2,"never"],
-    "camelcase"              :0,
-    "no-console"             :0,
-    "no-restricted-globals"  :0,
-    "no-multi-spaces"        :0,
-    "no-undef"               :0,
-    "radix"                  :0,
-    "key-spacing"            :[2,{"align":"value"}],
-    "max-len"                :0,
-    "no-unused-expressions"  :0,
-    "padded-blocks"          :0,
-    "no-multiple-empty-lines":0,
-    "default-case"           :0,
-    "no-alert"               :0,
-    "no-lonely-if"           :0,
-    "no-nested-ternary"      :0,
-    "no-param-reassign"      :["error",{"props":false}],
-    "comma-dangle"           :["error","never"],
-    "jsonc/auto"             :2,
-    "jsonc/indent"           :["error",2,{}]
+  "env":            {
+    "browser": true,
+    "es2021":  true
+  },
+  "ignorePatterns": [
+    "package.json"
+  ],
+  "extends":        [
+    "airbnb-base"
+  ],
+  "overrides":      [],
+  "parserOptions":  {
+    "ecmaVersion": "latest",
+    "sourceType":  "module"
+  },
+  "rules":          {
+    "quotes":                  [
+      2,
+      "double"
+    ],
+    "semi":                    [
+      2,
+      "never"
+    ],
+    "camelcase":               0,
+    "no-console":              0,
+    "no-restricted-globals":   0,
+    "no-multi-spaces":         0,
+    "no-undef":                0,
+    "radix":                   0,
+    "key-spacing":             [
+      2,
+      {
+        "align": "value"
+      }
+    ],
+    "max-len":                 0,
+    "no-unused-expressions":   0,
+    "padded-blocks":           0,
+    "no-multiple-empty-lines": 0,
+    "default-case":            0,
+    "no-alert":                0,
+    "no-lonely-if":            0,
+    "no-nested-ternary":       0,
+    "no-param-reassign":       [
+      "error",
+      {
+        "props": false
+      }
+    ],
+    "comma-dangle":            [
+      "error",
+      "never"
+    ]
   }
 }

data/package.json

@@ -1,11 +1,10 @@
 {
-  "name"        :"immosquare-cleaner",
-  "private"     :true,
-  "dependencies":{
-    "eslint"                   :"^8.50.0",
-    "prettier"                 :"^3.0.3",
-    "eslint-config-airbnb-base":"^15.0.0",
-    "eslint-plugin-import"     :"^2.28.1",
-    "eslint-plugin-jsonc"      :"^2.9.0"
+  "name":         "immosquare-cleaner",
+  "private":      true,
+  "dependencies": {
+    "eslint":                    "^8.50.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-plugin-import":      "^2.28.1",
+    "prettier":                  "^3.0.3"
   }
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: immosquare-cleaner
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.11
 platform: ruby
 authors:
 - IMMO SQUARE
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-29 00:00:00.000000000 Z
+date: 2023-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb_lint
@@ -39,12 +39,15 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1'
 - !ruby/object:Gem::Dependency
-  name: immosquare-yaml
+  name: immosquare-extensions
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -52,13 +55,19 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.5
 - !ruby/object:Gem::Dependency
-  name: neatjson
+  name: immosquare-yaml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.16
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -66,6 +75,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+    - - ">="
+      - !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.
@@ -79,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
@@ -2602,71 +2629,6 @@ files:
 - node_modules/eslint-plugin-import/node_modules/doctrine/lib/utility.js
 - node_modules/eslint-plugin-import/node_modules/doctrine/package.json
 - node_modules/eslint-plugin-import/package.json
-- node_modules/eslint-plugin-jsonc/LICENSE
-- node_modules/eslint-plugin-jsonc/README.md
-- node_modules/eslint-plugin-jsonc/conf/eslint-all.js
-- node_modules/eslint-plugin-jsonc/conf/eslint-recommended.js
-- node_modules/eslint-plugin-jsonc/conf/rules.js
-- node_modules/eslint-plugin-jsonc/dist/configs/all.js
-- node_modules/eslint-plugin-jsonc/dist/configs/auto-config.js
-- node_modules/eslint-plugin-jsonc/dist/configs/base.js
-- node_modules/eslint-plugin-jsonc/dist/configs/prettier.js
-- node_modules/eslint-plugin-jsonc/dist/configs/recommended-with-json.js
-- node_modules/eslint-plugin-jsonc/dist/configs/recommended-with-json5.js
-- node_modules/eslint-plugin-jsonc/dist/configs/recommended-with-jsonc.js
-- node_modules/eslint-plugin-jsonc/dist/index.js
-- node_modules/eslint-plugin-jsonc/dist/meta.js
-- node_modules/eslint-plugin-jsonc/dist/rules/array-bracket-newline.js
-- node_modules/eslint-plugin-jsonc/dist/rules/array-bracket-spacing.js
-- node_modules/eslint-plugin-jsonc/dist/rules/array-element-newline.js
-- node_modules/eslint-plugin-jsonc/dist/rules/auto.js
-- node_modules/eslint-plugin-jsonc/dist/rules/comma-dangle.js
-- node_modules/eslint-plugin-jsonc/dist/rules/comma-style.js
-- node_modules/eslint-plugin-jsonc/dist/rules/indent.js
-- node_modules/eslint-plugin-jsonc/dist/rules/key-name-casing.js
-- node_modules/eslint-plugin-jsonc/dist/rules/key-spacing.js
-- node_modules/eslint-plugin-jsonc/dist/rules/no-bigint-literals.js
-- node_modules/eslint-plugin-jsonc/dist/rules/no-binary-expression.js
-- node_modules/eslint-plugin-jsonc/dist/rules/no-binary-numeric-literals.js
-- node_modules/eslint-plugin-jsonc/dist/rules/no-comments.js
-- node_modules/eslint-plugin-jsonc/dist/rules/no-dupe-keys.js
-- node_modules/eslint-plugin-jsonc/dist/rules/no-escape-sequence-in-identifier.js
-- node_modules/eslint-plugin-jsonc/dist/rules/no-floating-decimal.js
-- node_modules/eslint-plugin-jsonc/dist/rules/no-hexadecimal-numeric-literals.js
-- node_modules/eslint-plugin-jsonc/dist/rules/no-infinity.js
-- node_modules/eslint-plugin-jsonc/dist/rules/no-irregular-whitespace.js
-- node_modules/eslint-plugin-jsonc/dist/rules/no-multi-str.js
-- node_modules/eslint-plugin-jsonc/dist/rules/no-nan.js
-- node_modules/eslint-plugin-jsonc/dist/rules/no-number-props.js
-- node_modules/eslint-plugin-jsonc/dist/rules/no-numeric-separators.js
-- node_modules/eslint-plugin-jsonc/dist/rules/no-octal-escape.js
-- node_modules/eslint-plugin-jsonc/dist/rules/no-octal-numeric-literals.js
-- node_modules/eslint-plugin-jsonc/dist/rules/no-octal.js
-- node_modules/eslint-plugin-jsonc/dist/rules/no-parenthesized.js
-- node_modules/eslint-plugin-jsonc/dist/rules/no-plus-sign.js
-- node_modules/eslint-plugin-jsonc/dist/rules/no-regexp-literals.js
-- node_modules/eslint-plugin-jsonc/dist/rules/no-sparse-arrays.js
-- node_modules/eslint-plugin-jsonc/dist/rules/no-template-literals.js
-- node_modules/eslint-plugin-jsonc/dist/rules/no-undefined-value.js
-- node_modules/eslint-plugin-jsonc/dist/rules/no-unicode-codepoint-escapes.js
-- node_modules/eslint-plugin-jsonc/dist/rules/no-useless-escape.js
-- node_modules/eslint-plugin-jsonc/dist/rules/object-curly-newline.js
-- node_modules/eslint-plugin-jsonc/dist/rules/object-curly-spacing.js
-- node_modules/eslint-plugin-jsonc/dist/rules/object-property-newline.js
-- node_modules/eslint-plugin-jsonc/dist/rules/quote-props.js
-- node_modules/eslint-plugin-jsonc/dist/rules/quotes.js
-- node_modules/eslint-plugin-jsonc/dist/rules/sort-array-values.js
-- node_modules/eslint-plugin-jsonc/dist/rules/sort-keys.js
-- node_modules/eslint-plugin-jsonc/dist/rules/space-unary-ops.js
-- node_modules/eslint-plugin-jsonc/dist/rules/valid-json-number.js
-- node_modules/eslint-plugin-jsonc/dist/rules/vue-custom-block/no-parsing-error.js
-- node_modules/eslint-plugin-jsonc/dist/types.js
-- node_modules/eslint-plugin-jsonc/dist/utils/casing.js
-- node_modules/eslint-plugin-jsonc/dist/utils/get-auto-jsonc-rules-config.js
-- node_modules/eslint-plugin-jsonc/dist/utils/index.js
-- node_modules/eslint-plugin-jsonc/dist/utils/rules.js
-- node_modules/eslint-plugin-jsonc/index.d.ts
-- node_modules/eslint-plugin-jsonc/package.json
 - node_modules/eslint-scope/LICENSE
 - node_modules/eslint-scope/README.md
 - node_modules/eslint-scope/dist/eslint-scope.cjs

data/node_modules/eslint-plugin-jsonc/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2020 Yosuke Ota
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.