immosquare-cleaner 0.1.115 → 0.1.116

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19779dc732954ca8de22b3c3fa9ed64570df1c5962ddd692d3eaead3795bcb33
-  data.tar.gz: 8482c46bb1437146f369e6a9e3995f29e9e8e240b08f54adabf2bc22211bf74f
+  metadata.gz: d3bb81cf1641c678335ba6485d0457824ad4f2efd9bec1ad6a3e7973a83617e7
+  data.tar.gz: b66e76e63984cd595a981fae0a84eb82d4bd47a64092b1373878223da757889b
 SHA512:
-  metadata.gz: c6651cf24dc96341e01b8e7d94977dbb476725f9d86b2aa7a75f815d36d14ccc2b923511b28aae3d9634e5579d454d630739efab8c7caf4bfb8c490afb6f7dcc
-  data.tar.gz: 8f10906affbec34cf93fc92c26af2cf8cf9f9c10e48b7aedfc364fdb5b96a2931f365a503963aa7aa91a8edc6e0b34e0e91e74b022a7488b6719ad3e9ddb2888
+  metadata.gz: d00cc397871e5131c6cdb3edc8ef9ed40422677c98b9903ce1a2844273f28993c6c679ba8032ed27edfa06b2387d48794fdf5b1dfecc67729336c2a36d29ef82
+  data.tar.gz: 4e5097e2d7b6db8a2d94ef4e45d6513a065c4d2e7da8be077e2ec2acc3f3588d9a39df20e27162bd3d5e84a49f71c5cf551d638ddc3ba102a02ec5dc8644b231

data/lib/immosquare-cleaner/markdown.rb

@@ -17,16 +17,60 @@ module ImmosquareCleaner
       ##============================================================##
       FENCE_REGEX = /\A\s*(```|~~~)/
 
+      ##============================================================##
+      ## A list item marker is `*`, `+` or `-` followed by a space,
+      ## or alone on its line. The space is what makes it a list:
+      ## without that requirement `---` — a thematic break, and the
+      ## fence of a YAML frontmatter — and `*emphasis*` opening a
+      ## line are both read as list items, which injects a blank
+      ## line right after them. Inside a frontmatter that blank line
+      ## lands between the opening fence and the first key.
+      ##============================================================##
+      LIST_ITEM_REGEX = /\A[*+-](\s|\z)/
+
+      ##============================================================##
+      ## The fence of a YAML frontmatter: `---` alone on its line.
+      ##============================================================##
+      FRONTMATTER_FENCE_REGEX = /\A---\s*\z/
+
       def clean(file_path)
-        results        = []
-        array_to_parse = []
-        lines          = []
-        fence_marker   = nil
+        results            = []
+        array_to_parse     = []
+        lines              = []
+        fence_marker       = nil
+        frontmatter_last   = frontmatter_last_index(file_path)
+        frontmatter_opened = false
 
         ##============================================================##
         ## We parse each line of the file
         ##============================================================##
-        File.foreach(file_path) do |current_line|
+        File.foreach(file_path).with_index do |current_line, index|
+          ##============================================================##
+          ## A frontmatter is YAML, not markdown: it goes through
+          ## verbatim. Neither the list spacing nor the table rules
+          ## mean anything between its fences, and applying them adds
+          ## a blank line after the opening fence — or before the
+          ## closing one when the last key holds a list.
+          ##
+          ## Its leading blank lines are the one exception, and they
+          ## are dropped: never meaningful in YAML, and earlier
+          ## versions of this cleaner injected one there by taking the
+          ## opening `---` for a list item. Removing it here repairs
+          ## the files that already carry it.
+          ##============================================================##
+          if frontmatter_last && index <= frontmatter_last
+            lines << current_line
+
+            if index > 0 && index < frontmatter_last && !frontmatter_opened
+              next if current_line.strip.empty?
+
+              frontmatter_opened = true
+            end
+
+            results << current_line
+            next
+          end
+
           ##============================================================##
           ## We save the last line to know if we need to add a newline
           ##============================================================##
@@ -81,6 +125,25 @@ module ImmosquareCleaner
 
       private
 
+      ##============================================================##
+      ## Index of the closing fence of the frontmatter, or nil when
+      ## the file has none. A frontmatter only exists when `---` is
+      ## the very first line AND a closing `---` follows: without
+      ## that second condition, a file opening on a thematic break
+      ## would be emitted verbatim from end to end.
+      ##============================================================##
+      def frontmatter_last_index(file_path)
+        first_line = File.foreach(file_path).first
+        return nil if first_line.nil? || !first_line.match?(FRONTMATTER_FENCE_REGEX)
+
+        File.foreach(file_path).with_index do |line, index|
+          next if index == 0
+          return index if line.match?(FRONTMATTER_FENCE_REGEX)
+        end
+
+        nil
+      end
+
       ##============================================================##
       ## we want to clean the markdown files to have a uniform style
       ## for the tables.
@@ -156,8 +219,8 @@ module ImmosquareCleaner
 
         cleaned_previous = previous_line.rstrip
         blank_line       = current_line.gsub("\n", "").empty?
-        previous_is_list = cleaned_previous.lstrip.start_with?("*", "-", "+")
-        current_is_list  = cleaned_current.lstrip.start_with?("*", "-", "+")
+        previous_is_list = cleaned_previous.lstrip.match?(LIST_ITEM_REGEX)
+        current_is_list  = cleaned_current.lstrip.match?(LIST_ITEM_REGEX)
         final            = previous_is_list && !current_is_list && !blank_line ? ["\n"] : []
         final << ["#{cleaned_current}\n"]
       end

data/lib/immosquare-cleaner/version.rb

@@ -1,3 +1,3 @@
 module ImmosquareCleaner
-  VERSION = "0.1.115".freeze
+  VERSION = "0.1.116".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: immosquare-cleaner
 version: !ruby/object:Gem::Version
-  version: 0.1.115
+  version: 0.1.116
 platform: ruby
 authors:
 - immosquare