coradoc-html 1.1.18 → 1.1.19

data/lib/coradoc/html/input_config.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'tmpdir'
+
+module Coradoc
+  module Html
+    class InputConfig
+      def initialize
+        @unknown_tags     = :pass_through
+        @input_format     = :html
+        @mathml2asciimath = false
+        @external_images  = false
+
+        @destination      = nil
+        @sourcedir        = nil
+
+        @image_counter = 1
+        @image_counter_pattern = '%03d'
+
+        @em_delimiter     = '_'
+        @strong_delimiter = '*'
+        @inline_options   = {}
+        @tag_border       = ' '
+
+        @split_sections   = nil
+
+        @doc_width        = 1000
+
+        @plugins          = []
+
+        @track_time       = false
+      end
+
+      def with(options = {})
+        old_options = @inline_options
+        @inline_options = options
+        result = yield
+        @inline_options = old_options
+        result
+      end
+
+      def self.declare_option(option)
+        attr_accessor option
+
+        original_reader = instance_method(option)
+        define_method(option) do
+          @inline_options[option] || original_reader.bind_call(self)
+        end
+      end
+
+      declare_option :unknown_tags
+      declare_option :tag_border
+      declare_option :mathml2asciimath
+      declare_option :external_images
+      declare_option :destination
+      declare_option :sourcedir
+      declare_option :image_counter
+      declare_option :image_counter_pattern
+      declare_option :input_format
+      declare_option :split_sections
+      declare_option :doc_width
+      declare_option :plugins
+      declare_option :track_time
+    end
+  end
+end

data/lib/coradoc/html/plugin.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module Html
+    class Plugin
+      def self.new(&)
+        if self == Plugin
+          Class.new(Plugin, &)
+        else
+          super
+        end
+      end
+
+      def initialize
+        @html_tree_hooks_pre = {}
+        @html_tree_hooks_post = {}
+      end
+
+      def name
+        self.class.name
+      end
+
+      def preprocess_html_tree; end
+      def postprocess_coremodel_tree; end
+      def postprocess_output_string; end
+
+      attr_accessor :html_tree, :coremodel_tree, :output_string
+
+      def html_tree_change_tag_name_by_css(css, new_name)
+        html_tree.css(css).each do |e|
+          e.name = new_name
+        end
+      end
+
+      def html_tree_change_properties_by_css(css, properties)
+        html_tree.css(css).each do |e|
+          properties.each do |k, v|
+            e[k.to_s] = v
+          end
+        end
+      end
+
+      def html_tree_remove_by_css(css)
+        html_tree.css(css).each(&:remove)
+      end
+
+      def html_tree_replace_with_children_by_css(css)
+        html_tree.css(css).each do |e|
+          e.replace(e.children)
+        end
+      end
+
+      def html_tree_process_to_coremodel(tree, state = {})
+        Coradoc::Html::Converters.process_coradoc(tree, state)
+      end
+
+      def html_tree_add_hook_pre(element, &block)
+        @html_tree_hooks_pre[element] = block
+      end
+
+      def html_tree_add_hook_pre_by_css(css, &block)
+        html_tree.css(css).each do |e|
+          html_tree_add_hook_pre(e, &block)
+        end
+      end
+
+      def html_tree_add_hook_post(element, &block)
+        @html_tree_hooks_post[element] = block
+      end
+
+      def html_tree_add_hook_post_by_css(css, &block)
+        html_tree.css(css).each do |e|
+          html_tree_add_hook_post(e, &block)
+        end
+      end
+
+      def html_tree_run_hooks(node, state, &)
+        hook_pre = @html_tree_hooks_pre[node]
+        hook_post = @html_tree_hooks_post[node]
+
+        coremodel = hook_pre.call(node, state) if hook_pre
+        coremodel ||= yield node, state
+
+        coremodel = hook_post.call(node, coremodel, state) if hook_post
+
+        coremodel
+      end
+    end
+  end
+end

data/lib/coradoc/html/plugins/plateau.rb

@@ -0,0 +1,212 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module Html
+    class Plugin
+      # This plugin enhances documents from the PLATEAU project
+      # to extract more data.
+      #
+      # Usage:
+      # coradoc convert -rcoradoc/html/plugins/plateau
+      #   --external-images -u raise --output _out/index.adoc index.html
+      class Plateau < Plugin
+        def name
+          'PLATEAU'
+        end
+
+        def preprocess_html_tree
+          # Remove side menu, so we can generate TOC ourselves
+          html_tree_remove_by_css('.sideMenu')
+
+          # Correct non-semantic classes into semantic HTML tags
+          html_tree_change_tag_name_by_css('.titledata', 'h1')
+          html_tree_change_tag_name_by_css('.subtitledata', 'h2')
+          html_tree_change_tag_name_by_css('.pitemdata', 'h3')
+          html_tree_change_tag_name_by_css('.sitemdata', 'h4')
+          html_tree_change_tag_name_by_css('td[bgcolor="#D0CECE"]', 'th')
+          html_tree_change_tag_name_by_css('td[bgcolor="#d0cece"]', 'th')
+          html_tree_change_tag_name_by_css(
+            '.framedata, .frame_container_box',
+            'aside'
+          )
+          html_tree_change_tag_name_by_css('.frame2data', 'pre')
+          # Assumption that all code snippets in those documents are XML...
+          html_tree_change_properties_by_css(
+            '.frame2data',
+            class: 'brush:xml;'
+          )
+
+          # Remove some CSS ids that are not important to us
+          html_tree_change_properties_by_css('#__nuxt', id: nil)
+          html_tree_change_properties_by_css('#__layout', id: nil)
+          html_tree_change_properties_by_css('#app', id: nil)
+
+          # Handle lists of document 02
+          html_tree_replace_with_children_by_css('.list_num-wrap')
+
+          # Convert table/img caption to become a caption
+          html_tree.css('.imagedata').each do |e|
+            table = e.parent.next&.children&.first
+            if table&.name == 'table'
+              e.name = 'caption'
+              table.prepend_child(e)
+              next
+            end
+
+            img = e.parent.previous&.children&.first
+            next unless img&.name == 'img' && img['src']
+
+            title = e.text.strip
+            img['title'] = title
+            e.remove
+            next
+          end
+
+          # Add hooks for H1, H2, H3, H4
+          html_tree_add_hook_post_by_css(
+            'h1, h2, h3',
+            &method(:handle_headers)
+          )
+          html_tree_add_hook_post_by_css('h4', &method(:handle_headers_h4))
+
+          # Table cells aligned to center
+          html_tree_change_properties_by_css(
+            '.tableTopCenter',
+            align: 'center'
+          )
+
+          # Handle non-semantic lists and indentation
+          html_tree_add_hook_pre_by_css '.text2data' do |node,|
+            text = html_tree_process_to_coremodel(node).strip
+            next '' if text.empty? || text == "\u3000"
+
+            if text.start_with?(/\d+\./)
+              text = text.sub(/\A\d+.\s*/, '')
+              ".. #{text}\n"
+            else
+              text = text.gsub(/^/, '** ')
+              "\n\n//-PT2D\n#{text}\n//-ENDPT2D\n\n"
+            end
+          end
+
+          (3..4).each do |i|
+            html_tree_add_hook_pre_by_css ".text#{i}data" do |node,|
+              text = html_tree_process_to_coremodel(node).strip
+              next '' if text.empty? || text == "\u3000"
+
+              text = text.strip.gsub(/^/, "#{'*' * i} ")
+              "\n\n//-PT#{i}D\n#{text}\n//-ENDPT#{i}D\n\n"
+            end
+          end
+
+          (2..3).each do |i|
+            html_tree_add_hook_pre_by_css ".text#{i}data_point ul" do |node,|
+              text = html_tree_process_to_coremodel(node.children.first.children).strip
+
+              "#{'*' * i} #{text}\n"
+            end
+          end
+
+          (1..20).each do |i|
+            html_tree_add_hook_pre_by_css ".numtextdata_num .list_num#{i}" do |node,|
+              text = html_tree_process_to_coremodel(node).strip
+
+              "[start=#{i}]\n. #{text}\n"
+            end
+          end
+        end
+
+        IM = /[A-Z0-9]{1,3}/
+
+        def handle_headers(node, coradoc, _state)
+          content = coradoc.content.map(&:content).join
+
+          if %w[toc0 toc_0].any? { |i| coradoc.id&.start_with?(i) }
+            # Special content
+            case content.strip
+            when 'はじめに' # Introduction
+              coradoc.style = 'abstract' # The older version document has ".preface"
+              coradoc.level_int = 1
+            when '改定の概要' # Revision overview
+              coradoc.style = 'abstract' # The older version document has ".preface"
+              coradoc.level_int = 1
+            when '参考文献' # Bibliography
+              coradoc.style = 'bibliography'
+              coradoc.level_int = 1
+            when '改訂履歴' # Document history
+              coradoc.style = 'appendix'
+              coradoc.level_int = 1
+            when '0　概要' # Overview
+              coradoc.style = 'abstract' # I'm not sure this is correct
+              coradoc.level_int = 1
+            when '索引' # Index
+              coradoc.style = 'index' # I'm not sure this is correct
+              coradoc.level_int = 1
+            else
+              warn "Unknown section #{content.inspect}"
+            end
+          end
+
+          if node.name == 'h1' && content.start_with?('Annex')
+            coradoc.style = 'appendix'
+            coradoc.content.first.content.sub!(/\AAnnex [A-Z]/, '')
+          end
+
+          # Remove numbers
+          coradoc.content.first.content.sub!(
+            /\A(#{IM}\.)*#{IM}[[:space:]]/o,
+            ''
+          )
+
+          coradoc
+        end
+
+        def handle_headers_h4(_node, coradoc, _state)
+          title = Coradoc.strip_unicode(coradoc.content.first.content)
+          case title
+          when /\A\(\d+\)(.*)/
+            coradoc.level_int = 4
+            coradoc.content.first.content = ::Regexp.last_match(1).strip
+            coradoc
+          when /\A\d+\)(.*)/
+            coradoc.level_int = 5
+            coradoc.content.first.content = ::Regexp.last_match(1).strip
+            coradoc
+          when /\A#{IM}\.#{IM}\.#{IM}\.#{IM}(.*)/o
+            coradoc.level_int = 4
+            coradoc.content.first.content = ::Regexp.last_match(1).strip
+          else
+            if title.empty?
+              # Strip instances of faulty empty paragraphs
+              nil
+            else
+              ["// Unhandled h4 content\n", coradoc]
+            end
+          end
+        end
+
+        def postprocess_output_string
+          str = output_string
+
+          ### Custom indentation handling
+          # If there's a step up, add [none]
+          str = str.gsub(%r{\s+//-ENDPT2D\s+//-PT3D\s+}, "\n[none]\n")
+          str = str.gsub(%r{\s+//-ENDPT2D\s+//-PT4D\s+}, "\n[none]\n")
+          str = str.gsub(%r{\s+//-ENDPT3D\s+//-PT4D\s+}, "\n[none]\n")
+          # Collapse blocks of text[2,3]data
+          str = str.gsub(%r{\s+//-ENDPT[234]D\s+//-PT[234]D\s+}, "\n\n")
+          # In the beginning, add [none]
+          str = str.gsub(%r{\s+//-PT[234]D\s+}, "\n\n[none]\n")
+          # If following with another list, ensure we readd styling
+          str = str.gsub(%r{\s+//-ENDPT[234]D\s+\*}, "\n\n[disc]\n*")
+          # Otherwise, clean up
+          str = str.gsub(%r{\s+//-ENDPT[234]D\s+}, "\n\n")
+
+          self.output_string = str
+        end
+      end
+    end
+  end
+end
+
+Coradoc::Html.input_config.plugins << Coradoc::Html::Plugin::Plateau

data/lib/coradoc/html/postprocessor.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module Html
+    class Postprocessor
+      def self.process(coradoc)
+        new(coradoc).process
+      end
+
+      def initialize(coradoc)
+        @tree = coradoc
+      end
+
+      def process
+        @tree
+      end
+    end
+  end
+end

data/lib/coradoc/html/spa.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'renderer'
-
 module Coradoc
   module Html
     autoload :ConverterBase, "#{__dir__}/converter_base"

data/lib/coradoc/html/static.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'renderer'
-
 module Coradoc
   module Html
     autoload :ConverterBase, "#{__dir__}/converter_base"

data/lib/coradoc/html/tag_mapping.rb

@@ -83,7 +83,9 @@ module Coradoc
       ELEMENT_CSS_CLASS = {
         example: 'example',
         sidebar: 'sidebar',
-        literal: 'literal'
+        literal: 'literal',
+        stem: 'stem',
+        term: 'term'
       }.freeze
 
       def self.tag_for(element_type)

data/lib/coradoc/html/transform/from_core_model.rb

@@ -10,8 +10,6 @@ module Coradoc
       # This transformer converts CoreModel to HTML strings by delegating
       # to the existing theme/renderer pipeline.
       class FromCoreModel
-        include Coradoc::Transform::Base
-
         class << self
           # Transform a CoreModel to HTML string
           #
@@ -29,6 +27,8 @@ module Coradoc
             end
           end
         end
+
+        def transform(model, options = {}) = self.class.transform(model, options)
       end
     end
   end

data/lib/coradoc/html/transform/to_core_model.rb

@@ -12,8 +12,6 @@ module Coradoc
       # Nokogiri::XML::Document or Nokogiri::XML::Node objects into CoreModel
       # by delegating to the existing input converter pipeline.
       class ToCoreModel
-        include Coradoc::Transform::Base
-
         class << self
           # Transform an HTML model (Nokogiri node) to CoreModel
           #
@@ -25,7 +23,7 @@ module Coradoc
             when Coradoc::CoreModel::Base
               model
             when Nokogiri::XML::Document, Nokogiri::XML::Node
-              ::Coradoc::Input::Html::HtmlConverter.to_core_model(model)
+              ::Coradoc::Html::HtmlConverter.to_core_model(model)
             when Array
               model.map { |item| transform(item) }
             else
@@ -33,6 +31,8 @@ module Coradoc
             end
           end
         end
+
+        def transform(model) = self.class.transform(model)
       end
     end
   end

data/lib/coradoc/html/version.rb

@@ -2,6 +2,6 @@
 
 module Coradoc
   module Html
-    VERSION = '1.1.18'
+    VERSION = '1.1.19'
   end
 end

data/lib/coradoc/html.rb

@@ -12,10 +12,35 @@ module Coradoc
   end
 end
 
-# Load HTML input module to register with Coradoc::Input
-require_relative 'html/input'
-# Load HTML output module to register with Coradoc::Output
-require_relative 'html/output'
+module Coradoc
+  module Html
+    autoload :InputConfig, 'coradoc/html/input_config'
+    autoload :Cleaner, 'coradoc/html/cleaner'
+    autoload :Errors, 'coradoc/html/errors'
+    autoload :Plugin, 'coradoc/html/plugin'
+    autoload :Postprocessor, 'coradoc/html/postprocessor'
+    autoload :Converters, 'coradoc/html/converters'
+    autoload :HtmlConverter, 'coradoc/html/html_converter'
+
+    def self.input_config
+      @input_config ||= InputConfig.new
+      yield @input_config if block_given?
+      @input_config
+    end
+
+    def self.reset_input_config!
+      @input_config = nil
+    end
+
+    def self.cleaner
+      @cleaner ||= Cleaner.new
+    end
+
+    def self.to_coradoc(html, options = {})
+      HtmlConverter.to_core_model(html, options)
+    end
+  end
+end
 
 module Coradoc
   module Html
@@ -77,7 +102,7 @@ module Coradoc
 
     # Parse HTML content and return CoreModel elements (may be an Array)
     def self.parse(html, options = {})
-      ::Coradoc::Input::Html.to_coradoc(html, options)
+      HtmlConverter.to_core_model(html, options)
     end
 
     # Parse HTML content directly into a CoreModel document

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coradoc-html
 version: !ruby/object:Gem::Version
-  version: 1.1.18
+  version: 1.1.19
 platform: ruby
 authors:
 - Ribose Inc.
@@ -118,8 +118,46 @@ files:
 - LICENSE.txt
 - lib/coradoc/html.rb
 - lib/coradoc/html/asset_resolver.rb
+- lib/coradoc/html/cleaner.rb
 - lib/coradoc/html/config.rb
 - lib/coradoc/html/converter_base.rb
+- lib/coradoc/html/converters.rb
+- lib/coradoc/html/converters/a.rb
+- lib/coradoc/html/converters/aside.rb
+- lib/coradoc/html/converters/audio.rb
+- lib/coradoc/html/converters/base.rb
+- lib/coradoc/html/converters/blockquote.rb
+- lib/coradoc/html/converters/br.rb
+- lib/coradoc/html/converters/bypass.rb
+- lib/coradoc/html/converters/code.rb
+- lib/coradoc/html/converters/div.rb
+- lib/coradoc/html/converters/dl.rb
+- lib/coradoc/html/converters/drop.rb
+- lib/coradoc/html/converters/em.rb
+- lib/coradoc/html/converters/figure.rb
+- lib/coradoc/html/converters/h.rb
+- lib/coradoc/html/converters/head.rb
+- lib/coradoc/html/converters/hr.rb
+- lib/coradoc/html/converters/img.rb
+- lib/coradoc/html/converters/li.rb
+- lib/coradoc/html/converters/mark.rb
+- lib/coradoc/html/converters/markup.rb
+- lib/coradoc/html/converters/math.rb
+- lib/coradoc/html/converters/media_base.rb
+- lib/coradoc/html/converters/ol.rb
+- lib/coradoc/html/converters/p.rb
+- lib/coradoc/html/converters/pass_through.rb
+- lib/coradoc/html/converters/positional_formatting.rb
+- lib/coradoc/html/converters/pre.rb
+- lib/coradoc/html/converters/q.rb
+- lib/coradoc/html/converters/strong.rb
+- lib/coradoc/html/converters/sub.rb
+- lib/coradoc/html/converters/sup.rb
+- lib/coradoc/html/converters/table.rb
+- lib/coradoc/html/converters/td.rb
+- lib/coradoc/html/converters/text.rb
+- lib/coradoc/html/converters/tr.rb
+- lib/coradoc/html/converters/video.rb
 - lib/coradoc/html/drop.rb
 - lib/coradoc/html/drop/annotation_drop.rb
 - lib/coradoc/html/drop/base.rb
@@ -135,6 +173,7 @@ files:
 - lib/coradoc/html/drop/inline_element_drop.rb
 - lib/coradoc/html/drop/list_block_drop.rb
 - lib/coradoc/html/drop/list_item_drop.rb
+- lib/coradoc/html/drop/raw_inline_element_drop.rb
 - lib/coradoc/html/drop/table_cell_drop.rb
 - lib/coradoc/html/drop/table_drop.rb
 - lib/coradoc/html/drop/table_row_drop.rb
@@ -142,55 +181,15 @@ files:
 - lib/coradoc/html/drop/text_content_drop.rb
 - lib/coradoc/html/drop/toc_drop.rb
 - lib/coradoc/html/drop/toc_entry_drop.rb
+- lib/coradoc/html/errors.rb
 - lib/coradoc/html/escape.rb
 - lib/coradoc/html/frontmatter_meta.rb
-- lib/coradoc/html/input.rb
-- lib/coradoc/html/input/cleaner.rb
-- lib/coradoc/html/input/config.rb
-- lib/coradoc/html/input/converters.rb
-- lib/coradoc/html/input/converters/a.rb
-- lib/coradoc/html/input/converters/aside.rb
-- lib/coradoc/html/input/converters/audio.rb
-- lib/coradoc/html/input/converters/base.rb
-- lib/coradoc/html/input/converters/blockquote.rb
-- lib/coradoc/html/input/converters/br.rb
-- lib/coradoc/html/input/converters/bypass.rb
-- lib/coradoc/html/input/converters/code.rb
-- lib/coradoc/html/input/converters/div.rb
-- lib/coradoc/html/input/converters/dl.rb
-- lib/coradoc/html/input/converters/drop.rb
-- lib/coradoc/html/input/converters/em.rb
-- lib/coradoc/html/input/converters/figure.rb
-- lib/coradoc/html/input/converters/h.rb
-- lib/coradoc/html/input/converters/head.rb
-- lib/coradoc/html/input/converters/hr.rb
-- lib/coradoc/html/input/converters/img.rb
-- lib/coradoc/html/input/converters/li.rb
-- lib/coradoc/html/input/converters/mark.rb
-- lib/coradoc/html/input/converters/markup.rb
-- lib/coradoc/html/input/converters/math.rb
-- lib/coradoc/html/input/converters/media_base.rb
-- lib/coradoc/html/input/converters/ol.rb
-- lib/coradoc/html/input/converters/p.rb
-- lib/coradoc/html/input/converters/pass_through.rb
-- lib/coradoc/html/input/converters/positional_formatting.rb
-- lib/coradoc/html/input/converters/pre.rb
-- lib/coradoc/html/input/converters/q.rb
-- lib/coradoc/html/input/converters/strong.rb
-- lib/coradoc/html/input/converters/sub.rb
-- lib/coradoc/html/input/converters/sup.rb
-- lib/coradoc/html/input/converters/table.rb
-- lib/coradoc/html/input/converters/td.rb
-- lib/coradoc/html/input/converters/text.rb
-- lib/coradoc/html/input/converters/tr.rb
-- lib/coradoc/html/input/converters/video.rb
-- lib/coradoc/html/input/errors.rb
-- lib/coradoc/html/input/html_converter.rb
-- lib/coradoc/html/input/plugin.rb
-- lib/coradoc/html/input/plugins/plateau.rb
-- lib/coradoc/html/input/postprocessor.rb
+- lib/coradoc/html/html_converter.rb
+- lib/coradoc/html/input_config.rb
 - lib/coradoc/html/layout_renderer.rb
-- lib/coradoc/html/output.rb
+- lib/coradoc/html/plugin.rb
+- lib/coradoc/html/plugins/plateau.rb
+- lib/coradoc/html/postprocessor.rb
 - lib/coradoc/html/render_options.rb
 - lib/coradoc/html/renderer.rb
 - lib/coradoc/html/section_numberable.rb