coradoc 0.2.0 → 1.0.0

data/lib/coradoc/element/list_item_definition.rb

@@ -0,0 +1,32 @@
+module Coradoc
+  module Element
+    class ListItemDefinition < Base
+      attr_accessor :id, :terms, :contents
+
+      declare_children :id, :terms, :contents
+
+      def initialize(terms, contents, options = {})
+        @terms = terms
+        @contents = contents
+        @id = options.fetch(:id, nil)
+        @anchor = @id.nil? ? nil : Inline::Anchor.new(@id)
+      end
+
+      def to_adoc(delimiter)
+        anchor = @anchor.nil? ? "" : @anchor.to_adoc.to_s
+        content = ""
+        if (@terms.is_a?(Array) && @terms.size == 1) || !@terms.is_a?(Array)
+          t = Coradoc::Generator.gen_adoc(@terms)
+          content << "#{anchor}#{t}#{delimiter} "
+        else
+          @terms.map do |term|
+            t = Coradoc::Generator.gen_adoc(term)
+            content << "#{t}#{delimiter}\n"
+          end
+        end
+        d = Coradoc::Generator.gen_adoc(@contents)
+        content << "#{d}\n"
+      end
+    end
+  end
+end

data/lib/coradoc/element/paragraph.rb

@@ -1,7 +1,9 @@
 module Coradoc
   module Element
-    class Paragraph
-      attr_reader :content, :anchor, :tdsinglepara
+    class Paragraph < Base
+      attr_accessor :content, :anchor, :tdsinglepara
+
+      declare_children :content, :anchor
 
       def initialize(content, options = {})
         @content = content
@@ -22,7 +24,7 @@ module Coradoc
       def to_adoc
         anchor = @anchor.nil? ? "" : "#{@anchor.to_adoc}\n"
         if @tdsinglepara
-          "#{anchor}" << Coradoc::Generator.gen_adoc(@content).strip
+          anchor.to_s << Coradoc::Generator.gen_adoc(@content).strip
         else
           "\n\n#{anchor}" << Coradoc::Generator.gen_adoc(@content).strip << "\n\n"
         end

data/lib/coradoc/element/revision.rb

@@ -1,22 +1,26 @@
 module Coradoc
-  class Element::Revision
-    attr_reader :number, :date, :remark
+  module Element
+    class Revision < Base
+      attr_accessor :number, :date, :remark
 
-    def initialize(number, options = {})
-      @number = number
-      @date = options.fetch(:date, nil)
-      @remark = options.fetch(:remark, nil)
-    end
+      declare_children :number, :date, :remark
+
+      def initialize(number, options = {})
+        @number = number
+        @date = options.fetch(:date, nil)
+        @remark = options.fetch(:remark, nil)
+      end
 
-    def to_adoc
-      if @date.nil? && @remark.nil?
-        "v#{@number}\n"
-      elsif @remark.nil?
-        "#{@number}, #{@date}\n"
-      elsif @date.nil?
-        "#{@number}: #{@remark}\n"
-      else
-        "#{@number}, #{@date}: #{@revision}\n"
+      def to_adoc
+        if @date.nil? && @remark.nil?
+          "v#{@number}\n"
+        elsif @remark.nil?
+          "#{@number}, #{@date}\n"
+        elsif @date.nil?
+          "#{@number}: #{@remark}\n"
+        else
+          "#{@number}, #{@date}: #{@revision}\n"
+        end
       end
     end
   end

data/lib/coradoc/element/section.rb

@@ -1,11 +1,14 @@
 module Coradoc
   module Element
-    class Section
-      attr_reader :id, :title, :contents, :sections
+    class Section < Base
+      attr_accessor :id, :title, :contents, :sections
+
+      declare_children :id, :title, :contents, :sections
 
       def initialize(title, options = {})
         @title = title
         @id = options.fetch(:id, nil)
+        @id = nil if @id == ""
         @contents = options.fetch(:contents, [])
         @sections = options.fetch(:sections, [])
         @anchor = @id.nil? ? nil : Inline::Anchor.new(@id)
@@ -23,14 +26,28 @@ module Coradoc
 
       def to_adoc
         anchor = @anchor.nil? ? "" : "#{@anchor.to_adoc}\n"
+        title = Coradoc::Generator.gen_adoc(@title)
         content = Coradoc::Generator.gen_adoc(@contents)
-        "\n#{anchor}" << content << "\n"
+        sections = Coradoc::Generator.gen_adoc(@sections)
+
+        # A block of " +\n"s isn't parsed correctly. It needs to start
+        # with something.
+        content = "&nbsp;#{content}" if content.start_with?(" +\n")
+
+        "\n#{anchor}" << title << content << sections << "\n"
+      end
+
+      # Check for cases when Section is simply an equivalent of an empty <DIV>
+      # 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?
       end
 
       private
 
       def extract_glossaries
-        contents.select { |c| c if c.is_a?(Coradoc::Element::Glossaries) }.first
+        contents.grep(Coradoc::Element::Glossaries).first
       end
     end
   end

data/lib/coradoc/element/table.rb

@@ -1,17 +1,18 @@
 module Coradoc
   module Element
-    class Table
-      attr_reader :title, :rows, :content, :id
+    class Table < Base
+      attr_accessor :title, :rows, :content, :id
+
+      declare_children :title, :rows, :id
 
       def initialize(title, rows, options = {})
         @rows = rows
         @title = title
         @id = options.fetch(:id, nil)
         @anchor = @id.nil? ? nil : Inline::Anchor.new(@id)
-        @attrs = options.fetch(:attrs, '')
+        @attrs = options.fetch(:attrs, "")
       end
 
-
       def to_adoc
         anchor = @anchor.nil? ? "" : "#{@anchor.to_adoc}\n"
         attrs = @attrs.to_s.empty? ? "" : "#{@attrs.to_adoc}\n"
@@ -21,45 +22,61 @@ module Coradoc
         "\n\n#{anchor}#{attrs}#{title}|===\n" << content << "\n|===\n"
       end
 
-      class Row
-        attr_reader :columns, :header
+      class Row < Base
+        attr_accessor :columns, :header
+
+        declare_children :columns
 
         def initialize(columns, header = false)
           @columns = columns
           @header = header
         end
-        
+
         def table_header_row?
           @header
         end
 
+        def asciidoc?
+          @columns.any?(&:asciidoc?)
+        end
+
         def to_adoc
-          content = Coradoc::Generator.gen_adoc(@columns).rstrip
+          delim = asciidoc? ? "\n" : " "
+          content = @columns.map { |col| Coradoc::Generator.gen_adoc(col) }.join(delim)
           result  = "#{content}\n"
+          result << "\n" if asciidoc?
           table_header_row? ? result + underline_for : result
         end
 
         def underline_for
           "\n"
         end
-
       end
-      class Cell
-        attr_reader :anchor
+
+      class Cell < Base
+        attr_accessor :content, :anchor, :id, :colrowattr, :alignattr, :style
+
+        declare_children :content, :anchor, :id
+
         def initialize(options = {})
+          super()
           @id = options.fetch(:id, nil)
           @anchor = @id.nil? ? nil : Inline::Anchor.new(@id)
-          @colrowattr = options.fetch(:colrowattr, '')
-          @alignattr = options.fetch(:alignattr, '')
-          @style = options.fetch(:style, '')
-          @content = options.fetch(:content, '')
-          @delim = options.fetch(:delim, '')
+          @colrowattr = options.fetch(:colrowattr, "")
+          @alignattr = options.fetch(:alignattr, "")
+          @style = options.fetch(:style, "")
+          @content = options.fetch(:content, "")
+        end
+
+        def asciidoc?
+          @style.include?("a")
         end
 
         def to_adoc
-          anchor = @anchor.nil? ? "" : "#{@anchor.to_adoc}"
-          content = Coradoc::Generator.gen_adoc(@content)
-          "#{@colrowattr}#{@alignattr}#{@style}| #{anchor}#{content}#{@delim}"
+          anchor = @anchor.nil? ? "" : @anchor.to_adoc.to_s
+          content = simplify_block_content(@content)
+          content = Coradoc::Generator.gen_adoc(content)
+          "#{@colrowattr}#{@alignattr}#{@style}| #{anchor}#{content}"
         end
       end
     end

data/lib/coradoc/element/text_element.rb

@@ -1,26 +1,72 @@
 module Coradoc
-  class Element::TextElement
-    attr_reader :id, :content, :line_break
+  module Element
+    class TextElement < Base
+      attr_accessor :id, :content, :line_break
 
-    def initialize(content, options = {})
-      @content = content#.to_s
-      @id = options.fetch(:id, nil)
-      @line_break = options.fetch(:line_break, "")
-    end
-    
-    def to_adoc
-      Coradoc::Generator.gen_adoc(@content)
+      declare_children :content
+
+      def initialize(content, options = {})
+        @content = content # .to_s
+        @id = options.fetch(:id, nil)
+        @line_break = options.fetch(:line_break, "")
+      end
+
+      def to_adoc
+        Coradoc::Generator.gen_adoc(treat_text_to_adoc(@content))
+      end
+
+      def treat_text_to_adoc(text)
+        text = preserve_nbsp(text)
+        text = remove_border_newlines(text)
+        text = remove_inner_newlines(text)
+        text = self.class.escape_keychars(text)
+
+        text = preserve_keychars_within_backticks(text)
+        escape_links(text)
+      end
+
+      def preserve_nbsp(text)
+        text.gsub(/\u00A0/, "&nbsp;")
+      end
+
+      def escape_links(text)
+        text.gsub(/<<([^ ][^>]*)>>/, "\\<<\\1>>")
+      end
+
+      def remove_border_newlines(text)
+        text.gsub(/\A\n+/, "").gsub(/\n+\z/, "")
+      end
+
+      def remove_inner_newlines(text)
+        text.tr("\n\t", " ").squeeze(" ")
+      end
+
+      def preserve_keychars_within_backticks(text)
+        text.gsub(/`.*?`/) do |match|
+          match.gsub('\_', "_").gsub('\*', "*")
+        end
+      end
+
+      def self.escape_keychars(string)
+        subs = { "*" => '\*', "_" => '\_' }
+        string
+          .gsub(/((?<=\s)[\*_]+)|[\*_]+(?=\s)/) do |n|
+          n.chars.map do |char|
+            subs[char]
+          end.join
+        end
+      end
     end
-  end
 
-  class Element::LineBreak
-    attr_reader :line_break
+    class LineBreak < Base
+      attr_reader :line_break
 
-    def initialize(line_break)
-      @line_break = line_break
+      def initialize(line_break)
+        @line_break = line_break
+      end
     end
-  end
 
-  class Element::Highlight < Element::TextElement
+    class Highlight < Element::TextElement
+    end
   end
 end

data/lib/coradoc/element/title.rb

@@ -1,7 +1,9 @@
 module Coradoc
   module Element
-    class Title
-      attr_reader :id, :content, :line_break
+    class Title < Base
+      attr_accessor :id, :content, :line_break, :style, :level_int
+
+      declare_children :id, :content
 
       def initialize(content, level, options = {})
         @level_int = level
@@ -10,30 +12,48 @@ module Coradoc
         @id = options.fetch(:id, nil)
         @anchor = @id.nil? ? nil : Inline::Anchor.new(@id)
         @line_break = options.fetch(:line_break, "")
+        @style = options.fetch(:style, nil)
       end
 
       def level
-        @level_str ||= level_from_string
+        @level ||= level_from_string
       end
 
       def to_adoc
         anchor = @anchor.nil? ? "" : "#{@anchor.to_adoc}\n"
         content = Coradoc::Generator.gen_adoc(@content)
-        level_str = "=" * (@level_int + 1)
-        content = ["\n", anchor, level_str, ' ', content, "\n"].join("")
+        <<~HERE
+
+        #{anchor}#{style_str}#{level_str} #{content}
+        HERE
+      end
+
+      def level_str
+        if @level_int <= 5
+          "=" * (@level_int + 1)
+        else
+          "======"
+        end
+      end
+
+      def style_str
+        style = [@style]
+        style << "level=#{@level_int}" if @level_int > 5
+        style = style.compact.join(",")
+
+        "[#{style}]\n" unless style.empty?
       end
 
       alias :text :content
 
       private
 
-      attr_reader :level_str
-
       def level_from_string
         case @level_int
         when 2 then :heading_two
         when 3 then :heading_three
         when 4 then :heading_four
+        when 5 then :heading_five
         else :unknown
         end
       end

data/lib/coradoc/element/video.rb

@@ -1,23 +1,50 @@
 module Coradoc
   module Element
-    class Video
-      attr_reader :id, :title, :src, :options
+    class Video < Base
+      attr_accessor :id, :title, :src, :options
+
+      declare_children :id, :anchor, :attributes
 
       def initialize(title, options = {})
         @title = title
         @id = options.fetch(:id, nil)
         @anchor = @id.nil? ? nil : Inline::Anchor.new(@id)
-        @src = options.fetch(:src, '')
-        @attributes = options.fetch(:attributes, [])
-        # @attributes.add_valid_named('opts')
+        @src = options.fetch(:src, "")
+        @attributes = options.fetch(:attributes, AttributeList.new)
+        if @attributes.any?
+          @attributes.validate_positional(VALIDATORS_POSITIONAL)
+          @attributes.validate_named(VALIDATORS_NAMED)
+        end
       end
 
       def to_adoc
         anchor = @anchor.nil? ? "" : "#{@anchor.to_adoc}\n"
         title = ".#{@title}\n" unless @title.empty?
-        attrs = @attributes.empty? ? "\[\]" : @attributes.to_adoc
+        attrs = @attributes.to_adoc
         [anchor, title, "video::", @src, attrs].join("")
       end
+
+      extend AttributeList::Matchers
+      VALIDATORS_POSITIONAL = [
+        [:alt, String],
+        [:width, Integer],
+        [:height, Integer],
+      ]
+
+      VALIDATORS_NAMED = {
+        title: String,
+        poster: String,
+        width: Integer,
+        height: Integer,
+        start: Integer,
+        end: Integer,
+        theme: one("dark", "light"),
+        lang: /[a-z]{2,3}(?:-[A-Z]{2})?/,
+        list: String,
+        playlist: String,
+        options: many("autoplay", "loop", "modest",
+                      "nocontrols", "nofullscreen", "muted"),
+      }
     end
   end
 end

data/lib/coradoc/generator.rb

@@ -4,13 +4,13 @@ module Coradoc
       if content.is_a?(Array)
         content.map do |elem|
           Coradoc::Generator.gen_adoc(elem)
-        end.join('')
+        end.join("")
       elsif content.respond_to? :to_adoc
         content.to_adoc
       elsif content.is_a?(String)
         content
       elsif content.nil?
-        ''
+        ""
       end
     end
   end

data/lib/coradoc/legacy_parser.rb

@@ -23,8 +23,8 @@ module Coradoc
 
     rule(:text_line) do
       special_character.absent? >>
-      match("[^\n]").repeat(1).as(:text) >>
-      line_ending.as(:break)
+        match("[^\n]").repeat(1).as(:text) >>
+        line_ending.as(:break)
     end
 
     # Common Helpers
@@ -33,52 +33,52 @@ module Coradoc
 
     # Document
     rule(:document) do
-       (
-         document_attributes.repeat(1).as(:document_attributes) |
-         section.as(:section) |
-         header.as(:header) |
-         block_with_title.as(:block) |
-         empty_line.repeat(1) |
-         any.as(:unparsed)
-       ).repeat(1).as(:document)
+      (
+        document_attributes.repeat(1).as(:document_attributes) |
+        section.as(:section) |
+        header.as(:header) |
+        block_with_title.as(:block) |
+        empty_line.repeat(1) |
+        any.as(:unparsed)
+      ).repeat(1).as(:document)
     end
 
     # Header
     rule(:header) do
       match("=") >> space? >> text.as(:title) >> newline >>
-      author.maybe.as(:author) >> revision.maybe.as(:revision)
+        author.maybe.as(:author) >> revision.maybe.as(:revision)
     end
 
     rule(:author) do
       words.as(:first_name) >> str(",") >> space? >> words.as(:last_name) >>
-      space? >> str("<") >> email.as(:email) >> str(">") >> endline
+        space? >> str("<") >> email.as(:email) >> str(">") >> endline
     end
 
     rule(:revision) do
       (word >> (str(".") >> word).maybe).as(:number) >>
-      str(",") >> space? >> word.as(:date) >>
-      str(":") >> space? >> words.as(:remark) >> newline
+        str(",") >> space? >> word.as(:date) >>
+        str(":") >> space? >> words.as(:remark) >> newline
     end
 
     # DocumentAttributes
     rule(:document_attributes) do
       str(":") >> attribute_name.as(:key) >> str(":") >>
-      space? >> attribute_value.as(:value) >> endline
+        space? >> attribute_value.as(:value) >> endline
     end
 
     # Section
     rule(:section) do
       heading.as(:title) >>
-      (list.as(:list) |
-       blocks.as(:blocks) |
-       paragraphs.as(:paragraphs)).maybe
+        (list.as(:list) |
+         blocks.as(:blocks) |
+         paragraphs.as(:paragraphs)).maybe
     end
 
     # Heading
     rule(:heading) do
       (anchor_name >> newline).maybe >>
-      match("=").repeat(2, 8).as(:level) >>
-      space? >> text.as(:text) >> endline.as(:break)
+        match("=").repeat(2, 8).as(:level) >>
+        space? >> text.as(:text) >> endline.as(:break)
     end
 
     rule(:anchor_name) { str("[#") >> keyword.as(:name) >> str("]") }
@@ -110,51 +110,51 @@ module Coradoc
     rule(:block_type) { str("[") >> keyword.as(:type) >> str("]") >> newline }
 
     rule(:block_attribute) do
-      str("[")  >> keyword.as(:key) >>
-      str("=") >> keyword.as(:value) >> str("]")
+      str("[") >> keyword.as(:key) >>
+        str("=") >> keyword.as(:value) >> str("]")
     end
 
     rule(:simple_block) do
       block_attribute.as(:attributes) >> newline >>
-      text_line.repeat(1).as(:lines)
+        text_line.repeat(1).as(:lines)
     end
 
     rule(:open_block) do
       block_title >>
-      block_type >>
-      str("--").as(:delimiter) >> newline >>
-      text_line.repeat.as(:lines) >>
-      str("--") >> line_ending
+        block_type >>
+        str("--").as(:delimiter) >> newline >>
+        text_line.repeat.as(:lines) >>
+        str("--") >> line_ending
     end
 
     rule(:example_block) do
       block_title >>
-      block_type >>
-      str("====").as(:delimiter) >> newline >>
-      text_line.repeat(1).as(:lines) >>
-      str("====") >> newline
+        block_type >>
+        str("====").as(:delimiter) >> newline >>
+        text_line.repeat(1).as(:lines) >>
+        str("====") >> newline
     end
 
     rule(:sidebar_block) do
       block_title >>
-      block_type.maybe >>
-      str("****").as(:delimiter) >> newline >>
-      text_line.repeat(1).as(:lines) >>
-      str("****") >> newline
+        block_type.maybe >>
+        str("****").as(:delimiter) >> newline >>
+        text_line.repeat(1).as(:lines) >>
+        str("****") >> newline
     end
 
     rule(:source_block) do
       block_title >>
-      str("----").as(:delimiter) >> newline >>
-      text_line.repeat(1).as(:lines) >>
-      str("----") >> newline
+        str("----").as(:delimiter) >> newline >>
+        text_line.repeat(1).as(:lines) >>
+        str("----") >> newline
     end
 
     rule(:quote_block) do
       block_title >>
-      str("____").as(:delimiter) >> newline >>
-      text_line.repeat.as(:lines) >>
-      str("____") >> newline
+        str("____").as(:delimiter) >> newline >>
+        text_line.repeat.as(:lines) >>
+        str("____") >> newline
     end
 
     rule(:block_with_title) do

data/lib/coradoc/oscal.rb

@@ -15,7 +15,7 @@ module Coradoc
     def to_oscal
       {
         "metadata" => _doc.document_attributes.to_hash,
-        "groups" => sections_as_groups
+        "groups" => sections_as_groups,
       }
     end
 
@@ -80,9 +80,7 @@ module Coradoc
     end
 
     def build_oscal_prose(paragraph)
-      if paragraph
-        paragraph.texts.join(" ")
-      end
+      paragraph&.texts&.join(" ")
     end
   end
 end