coradoc 1.1.1 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0187fda1ca8860383e973840ca92de0d24b7de0f4b548eb92364b83dc76773c2'
-  data.tar.gz: bcccecebdf83ef11138182fc66ad27f5e24bb01d0b2824fa8b470d3c32ba413a
+  metadata.gz: 4f515fbc05baa87f58f84a59737c9818603c6e9f0fc8835cdeb9bd6be9eb39e4
+  data.tar.gz: ce51ff395a3dfb4bf77c37f6b54fe745a14a7262911df50479088d43392d4927
 SHA512:
-  metadata.gz: 37f09a7b2ba8fc861c4cf88f8c5638e6c654cc19a65b1b6c68314c6d9ff1b45f046559d573a849ee972b4dfa0422384271c1951ce5baa02491dc1c03000c2e77
-  data.tar.gz: c6844f3ccad625662b838cba656fa6e1f773675548d4fe664278f93569f7cf0ae86edcd70e26de2e60cb487090d3873720bc0c6e0f6892f8559e77a78129af4d
+  metadata.gz: 3269512745aea59b9780e5df2d872af7c3f19851666868335bc4876a534e50c64df410c5257a335324e9a9e0ad573dacf00058752ee00fd4b830f2f150cadeb2
+  data.tar.gz: 00e4122ec5e234e8e7e54d3e5769e03df15ad0f9851059576dadde7de58c0e2dd87f3c18ab14283574347bda6c95536cf31ee3ce6c202ea8b4c3f0da96f3f399

data/coradoc.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "premailer", "~> 1.11.0"
   spec.add_dependency "word-to-markdown"
   spec.add_dependency "base64"
-  spec.add_dependency "thor"
+  spec.add_dependency "thor", ">= 1.3.0"
   spec.add_development_dependency "codeclimate-test-reporter"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake"

data/lib/coradoc/element/attribute_list.rb

@@ -12,6 +12,16 @@ module Coradoc
         @rejected_named = []
       end
 
+      def inspect
+        "AttributeList: " +
+          [
+            @positional.map(&:inspect).join(", "),
+            @named.map { |k, v| "#{k}: #{v.inspect}" }.join(", "),
+            (@rejected_positional.empty? or "rejected: #{@rejected_positional.inspect}"),
+            (@rejected_positional.empty? or "rejected: #{@rejected_named.inspect}"),
+          ].reject { |i| i == true || i.empty? }.join(", ")
+      end
+
       def add_positional(*attr)
         @positional += attr
       end
@@ -65,7 +75,9 @@ module Coradoc
 
         adoc = +""
         if !@positional.empty?
-          adoc << @positional.map { |p| [nil, ""].include?(p) ? '""' : p }.join(",")
+          adoc << @positional.map do |p|
+            [nil, ""].include?(p) ? '""' : p
+          end.join(",")
         end
         adoc << "," if @positional.any? && @named.any?
         adoc << @named.map do |k, v|

data/lib/coradoc/element/base.rb

@@ -14,6 +14,8 @@ module Coradoc
           when Coradoc::Element::Section
             return content unless i.safe_to_collapse?
 
+            collected_content << i.anchor if i.anchor
+
             simplified = simplify_block_content(i.contents)
 
             if simplified && !simplified.empty?

data/lib/coradoc/element/section.rb

@@ -1,7 +1,7 @@
 module Coradoc
   module Element
     class Section < Base
-      attr_accessor :id, :title, :attrs, :contents, :sections
+      attr_accessor :id, :title, :attrs, :contents, :sections, :anchor
 
       declare_children :id, :title, :contents, :sections
 
@@ -49,7 +49,7 @@ module Coradoc
       # HTML element and if it happens inside some other block element, can be
       # safely collapsed.
       def safe_to_collapse?
-        @title.nil? && @id.nil? && @sections.empty?
+        @title.nil? && @sections.empty?
       end
 
       private

data/lib/coradoc/element/text_element.rb

@@ -15,6 +15,15 @@ module Coradoc
         end
       end
 
+      def inspect
+        str = "TextElement"
+        str += "(#{@id})" if @id
+        str += ": "
+        str += @content.inspect
+        str += " + #{@line_break.inspect}" unless line_break.empty?
+        str
+      end
+
       def to_adoc
         Coradoc::Generator.gen_adoc(@content) + @line_break
       end

data/lib/coradoc/input/html/converters/base.rb

@@ -10,9 +10,9 @@ module Coradoc::Input::HTML
 
       # Note: treat_children won't run plugin hooks
       def treat_children(node, state)
-        node.children.inject("") do |memo, child|
-          memo << treat(child, state)
-        end
+        node.children.map do |child|
+          treat(child, state)
+        end.join
       end
 
       def treat(node, state)
@@ -20,9 +20,9 @@ module Coradoc::Input::HTML
       end
 
       def treat_children_coradoc(node, state)
-        node.children.inject([]) do |memo, child|
-          memo << treat_coradoc(child, state)
-        end.flatten.reject { |x| x == "" || x.nil? }
+        node.children.map do |child|
+          treat_coradoc(child, state)
+        end.flatten.reject { |x| x.to_s.empty? }
       end
 
       def treat_coradoc(node, state)
@@ -72,14 +72,14 @@ module Coradoc::Input::HTML
         leading_whitespace = $1
         if !leading_whitespace.nil?
           first_text = node.at_xpath("./text()[1]")
-          first_text.replace(first_text.text.lstrip)
+          first_text.replace(first_text.text.lstrip) if first_text
           leading_whitespace = " "
         end
         node.text =~ /(\s+)$/
         trailing_whitespace = $1
         if !trailing_whitespace.nil?
           last_text = node.at_xpath("./text()[last()]")
-          last_text.replace(last_text.text.rstrip)
+          last_text.replace(last_text.text.rstrip) if last_text
           trailing_whitespace = " "
         end
         [leading_whitespace, trailing_whitespace]

data/lib/coradoc/input/html/converters/div.rb

@@ -10,5 +10,6 @@ module Coradoc::Input::HTML
 
     register :div,     Div.new
     register :article, Div.new
+    register :center,  Div.new
   end
 end

data/lib/coradoc/input/html/converters/h.rb

@@ -6,7 +6,9 @@ module Coradoc::Input::HTML
         internal_anchor = treat_children_anchors(node, state)
 
         if id.to_s.empty? && internal_anchor.size.positive?
-          id = internal_anchor.first.id
+          if internal_anchor.first.respond_to? :id
+            id = internal_anchor.first.id
+          end
         end
 
         level = node.name[/\d/].to_i
@@ -16,14 +18,14 @@ module Coradoc::Input::HTML
       end
 
       def treat_children_no_anchors(node, state)
-        node.children.reject { |a| a.name == "a" }.inject([]) do |memo, child|
-          memo << treat_coradoc(child, state)
+        node.children.reject { |a| a.name == "a" }.map do |child|
+          treat_coradoc(child, state)
         end
       end
 
       def treat_children_anchors(node, state)
-        node.children.select { |a| a.name == "a" }.inject([]) do |memo, child|
-          memo << treat_coradoc(child, state)
+        node.children.select { |a| a.name == "a" }.map do |child|
+          treat_coradoc(child, state)
         end
       end
     end

data/lib/coradoc/input/html/postprocessor.rb

@@ -4,6 +4,8 @@ module Coradoc::Input::HTML
   # is compatible with what we would get out of Coradoc, if
   # it parsed it directly.
   class Postprocessor
+    Element = Coradoc::Element
+
     def self.process(coradoc)
       new(coradoc).process
     end
@@ -12,17 +14,74 @@ module Coradoc::Input::HTML
       @tree = coradoc
     end
 
+    # Extracts titles from lists. This happens in HTML files
+    # generated from DOCX documents by LibreOffice.
+    #
+    # We are interested in a particular tree:
+    # Element::List::Ordered items:
+    #   Element::List::Ordered items: (any depth)
+    #     Element::ListItem content:
+    #       Element::Title
+    #       (any number of other titles of the same scheme)
+    #
+    # This tree is flattened into:
+    # Element::Title
+    # Element::Title (any number of titles)
+    def extract_titles_from_lists
+      @tree = Element::Base.visit(@tree) do |elem, dir|
+        next elem unless dir == :pre
+        next elem unless elem.is_a?(Element::List::Ordered)
+        next elem if elem.items.length != 1
+
+        anchors = []
+        anchors << elem.anchor if elem.anchor
+
+        # Extract ListItem from any depth of List::Ordered
+        processed = elem
+        while processed.is_a?(Element::List::Ordered)
+          if processed.items.length != 1
+            backtrack = true
+            break
+          end
+          anchors << processed.anchor if processed.anchor
+          processed = processed.items.first
+        end
+
+        # Something went wrong? Anything not matching on the way?
+        next elem if backtrack
+        next elem unless processed.is_a?(Element::ListItem)
+
+        anchors << processed.anchor if processed.anchor
+
+        # Now we must have a title (or titles).
+        titles = processed.content.flatten
+
+        # Don't bother if there's no title in there.
+        next elem unless titles.any? { |i| i.is_a? Element::Title }
+
+        # Ordered is another iteration for our cleanup.
+        next elem unless titles.all? do |i|
+          i.is_a?(Element::Title) || i.is_a?(Element::List::Ordered)
+        end
+
+        # We are done now.
+        titles + anchors
+      end
+    end
+
     # Collapse DIVs that only have a title, or nest another DIV.
     def collapse_meaningless_sections
-      @tree = Coradoc::Element::Base.visit(@tree) do |elem, _dir|
-        if elem.is_a?(Coradoc::Element::Section) && elem.safe_to_collapse?
+      @tree = Element::Base.visit(@tree) do |elem, _dir|
+        if elem.is_a?(Element::Section) && elem.safe_to_collapse?
           children_classes = Array(elem.contents).map(&:class)
           count = children_classes.length
-          safe_classes = [Coradoc::Element::Section, Coradoc::Element::Title]
+          safe_classes = [Element::Section, Element::Title]
 
           # Count > 0 because some documents use <div> as a <br>.
           if count > 0 && children_classes.all? { |i| safe_classes.include?(i) }
-            next elem.contents
+            contents = elem.contents.dup
+            contents.prepend(elem.anchor) if elem.anchor
+            next contents
           end
         end
         elem
@@ -32,12 +91,14 @@ module Coradoc::Input::HTML
     # tree should now be more cleaned up, so we can progress with
     # creating meaningful sections
     def generate_meaningful_sections
-      @tree = Coradoc::Element::Base.visit(@tree) do |elem, dir|
+      @tree = Element::Base.visit(@tree) do |elem, dir|
         # We are searching for an array, that has a title. This
         # will be a candidate for our section array.
         if dir == :post &&
             elem.is_a?(Array) &&
-            !elem.grep(Coradoc::Element::Title).empty?
+            !elem.flatten.grep(Element::Title).empty?
+
+          elem = elem.flatten
 
           new_array = []
           content_array = new_array
@@ -47,12 +108,12 @@ module Coradoc::Input::HTML
           # all descendant sections into those sections. Otherwise, we push
           # an element as content of current section.
           elem.each do |e|
-            if e.is_a? Coradoc::Element::Title
+            if e.is_a? Element::Title
               title = e
               content_array = []
               section_array = []
               level = title.level_int
-              section = Coradoc::Element::Section.new(
+              section = Element::Section.new(
                 title, contents: content_array, sections: section_array
               )
               # Some documents may not be consistent and eg. follow H4 after
@@ -82,11 +143,11 @@ module Coradoc::Input::HTML
       previous_sections = {}
 
       determine_section_id = ->(elem) do
-        if elem.title.style == "appendix"
-          level = "A"
-        else
-          level = 1
-        end
+        level = if elem.title.style == "appendix"
+                  "A"
+                else
+                  1
+                end
 
         section = previous_sections[elem]
         while section
@@ -102,8 +163,8 @@ module Coradoc::Input::HTML
         style
       end
 
-      @tree = Coradoc::Element::Base.visit(@tree) do |elem, dir|
-        title = elem.title if elem.is_a?(Coradoc::Element::Section)
+      @tree = Element::Base.visit(@tree) do |elem, dir|
+        title = elem.title if elem.is_a?(Element::Section)
 
         if title && title.level_int <= max_level
           if dir == :pre
@@ -137,6 +198,7 @@ module Coradoc::Input::HTML
     end
 
     def process
+      extract_titles_from_lists
       collapse_meaningless_sections
       generate_meaningful_sections
       # Do it again to simplify the document further.

data/lib/coradoc/reverse_adoc.rb

@@ -0,0 +1,18 @@
+warn <<~WARN
+  Deprecated: coradoc/reverse_adoc has been renamed to coradoc/input/html.
+  | Please update your references from:
+  |   require 'coradoc/reverse_adoc'
+  | To:
+  |   require 'coradoc/input/html'
+  |
+  | You are referencing an old require here:
+  |   #{caller.join("\n|   ")}
+  |
+  | Please also ensure that you replace all references to Coradoc::ReverseAdoc
+  | in your code with Coradoc::Input::HTML.
+WARN
+
+require 'coradoc'
+require 'coradoc/input/html'
+
+Coradoc::ReverseAdoc = Coradoc::Input::HTML

data/lib/coradoc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Coradoc
-  VERSION = "1.1.1"
+  VERSION = "1.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coradoc
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.3
 platform: ruby
 authors:
 - Ribose Inc.
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-09-17 00:00:00.000000000 Z
+date: 2024-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: marcel
@@ -129,14 +129,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -411,6 +411,7 @@ files:
 - lib/coradoc/parser/asciidoc/table.rb
 - lib/coradoc/parser/asciidoc/term.rb
 - lib/coradoc/parser/base.rb
+- lib/coradoc/reverse_adoc.rb
 - lib/coradoc/transformer.rb
 - lib/coradoc/util.rb
 - lib/coradoc/version.rb