coradoc 0.2.0 → 1.0.0

data/lib/coradoc/element/block/core.rb

@@ -3,15 +3,17 @@ require_relative "../inline/anchor"
 module Coradoc
   module Element
     module Block
-      class Core
-        attr_reader :title, :lines, :attributes, :lang, :id
+      class Core < Base
+        attr_accessor :title, :lines, :attributes, :lang, :id
+
+        declare_children :title, :lines, :attributes, :lang, :id
 
         def initialize(title, options = {})
           @title = title
           @lines = options.fetch(:lines, [])
           @type_str = options.fetch(:type, nil)
           @delimiter = options.fetch(:delimiter, "")
-          @attributes = options.fetch(:attributes, {})
+          @attributes = options.fetch(:attributes, AttributeList.new)
           @lang = options.fetch(:lang, nil)
           @id = options.fetch(:id, nil)
           @anchor = @id.nil? ? nil : Inline::Anchor.new(@id)
@@ -28,11 +30,14 @@ module Coradoc
         def gen_title
           t = Coradoc::Generator.gen_adoc(@title)
           return "" if t.empty?
+
           ".#{t}\n"
         end
 
         def gen_attributes
-          @attributes.nil? ? "" : "#{@attributes.to_adoc}\n"
+          attrs = @attributes.to_adoc(false)
+          return "#{attrs}\n" if !attrs.empty?
+          ""
         end
 
         def gen_delimiter
@@ -59,10 +64,9 @@ module Coradoc
             "****" => :side,
             "----" => :source,
             "====" => :example,
-            "...." => :literal
+            "...." => :literal,
           }
         end
-
       end
     end
   end

data/lib/coradoc/element/block/literal.rb

@@ -2,7 +2,7 @@ module Coradoc
   module Element
     module Block
       class Literal < Core
-        def initialize(title, options = {})
+        def initialize(_title, options = {})
           @id = options.fetch(:id, nil)
           @anchor = @id.nil? ? nil : Inline::Anchor.new(@id)
           @lines = options.fetch(:lines, [])

data/lib/coradoc/element/block/quote.rb

@@ -4,7 +4,7 @@ module Coradoc
       class Quote < Core
         def initialize(title, options = {})
           @title = title
-          @attributes = options.fetch(:attributes, {})
+          @attributes = options.fetch(:attributes, AttributeList.new)
           @lines = options.fetch(:lines, [])
           @delimiter_char = "_"
           @delimiter_len = options.fetch(:delimiter_len, 4)

data/lib/coradoc/element/block/sourcecode.rb

@@ -2,10 +2,10 @@ module Coradoc
   module Element
     module Block
       class SourceCode < Core
-        def initialize(title, options = {})
+        def initialize(_title, options = {})
           @id = options.fetch(:id, nil)
           @anchor = @id.nil? ? nil : Inline::Anchor.new(@id)
-          @lang = options.fetch(:lang, '')
+          @lang = options.fetch(:lang, "")
           @lines = options.fetch(:lines, [])
           @delimiter_char = "-"
           @delimiter_len = options.fetch(:delimiter_len, 4)

data/lib/coradoc/element/break.rb

@@ -1,7 +1,7 @@
 module Coradoc
   module Element
     module Break
-      class ThematicBreak
+      class ThematicBreak < Base
         def to_adoc
           "\n* * *\n"
         end

data/lib/coradoc/element/document_attributes.rb

@@ -1,7 +1,9 @@
 module Coradoc
   module Element
-    class DocumentAttributes
-      attr_reader :data
+    class DocumentAttributes < Base
+      attr_accessor :data
+
+      declare_children :data
 
       def initialize(data = {}, options = {})
         @data = data
@@ -9,10 +11,8 @@ module Coradoc
       end
 
       def to_hash
-        Hash.new.tap do |hash|
-          data.each do |attribute|
-            hash[attribute.key.to_s] = attribute.value.to_s.gsub("'", "")
-          end
+        data.to_h do |attribute|
+          [attribute.key.to_s, attribute.value.to_s.gsub("'", "")]
         end
       end
     end

data/lib/coradoc/element/header.rb

@@ -1,7 +1,9 @@
 module Coradoc
   module Element
-    class Header
-      attr_reader :title, :author, :revision
+    class Header < Base
+      attr_accessor :title, :author, :revision
+
+      declare_children :title
 
       def initialize(title, options = {})
         @title = title

data/lib/coradoc/element/image/block_image.rb

@@ -2,10 +2,21 @@ module Coradoc
   module Element
     module Image
       class BlockImage < Core
-        def initialize(title, id, src, options = ())
-          super(title, id, src, options)
+        def initialize(title, id, src, options = {})
+          super
           @colons = "::"
         end
+
+        def validate_named
+          @attributes.validate_named(VALIDATORS_NAMED, VALIDATORS_NAMED_BLOCK)
+        end
+
+        extend AttributeList::Matchers
+        VALIDATORS_NAMED_BLOCK = {
+          caption: String,
+          align: one("left", "center", "right"),
+          float: one("left", "right"),
+        }
       end
     end
   end

data/lib/coradoc/element/image/core.rb

@@ -1,23 +1,53 @@
 module Coradoc
   module Element
     module Image
-      class Core
-        attr_reader :title, :id, :src, :attributes
-        def initialize(title, id, src, options = ())
+      class Core < Base
+        attr_accessor :title, :id, :src, :attributes
+
+        declare_children :id, :src, :title, :attributes
+
+        def initialize(title, id, src, options = {})
           @title = title
           @id = id
           @anchor = @id.nil? ? nil : Coradoc::Element::Inline::Anchor.new(@id)
           @src = src
-          @attributes = options.fetch(:attributes, [])
+          @attributes = options.fetch(:attributes, AttributeList.new)
           @title = options.fetch(:title, nil)
+          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.to_s.empty?
-          attrs = @attributes.empty? ? "\[\]" : @attributes.to_adoc
+          attrs = @attributes.to_adoc
           [anchor, title, "image", @colons, @src, attrs].join("")
         end
+
+        extend AttributeList::Matchers
+        VALIDATORS_POSITIONAL = [
+          [:alt, String],
+          [:width, Integer],
+          [:height, Integer],
+        ]
+
+        VALIDATORS_NAMED = {
+          id: String,
+          alt: String,
+          fallback: String,
+          title: String,
+          width: Integer,
+          height: Integer,
+          link: String, # change to that URI regexp
+          window: String,
+          scale: Integer,
+          scaledwidth: /\A[0-9]{1,2}%\z/,
+          pdfwidth: /\A[0-9]+vw\z/,
+          role: many(/.*/, "left", "right", "th", "thumb", "related", "rel"),
+          opts: many("nofollow", "noopener", "inline", "interactive"),
+        }
       end
     end
   end

data/lib/coradoc/element/image/inline_image.rb

@@ -2,8 +2,8 @@ module Coradoc
   module Element
     module Image
       class InlineImage < Core
-        def initialize(title, id, src, options = ())
-          super(title, id, src, options)
+        def initialize(title, id, src, options = {})
+          super
           @colons = ":"
         end
       end

data/lib/coradoc/element/image.rb

@@ -1,7 +1,6 @@
 module Coradoc
   module Element
     module Image
-
     end
   end
 end

data/lib/coradoc/element/inline/anchor.rb

@@ -1,8 +1,10 @@
 module Coradoc
   module Element
     module Inline
-      class Anchor
-        attr_reader :id
+      class Anchor < Base
+        attr_accessor :id
+
+        declare_children :id
 
         def initialize(id)
           @id = id

data/lib/coradoc/element/inline/bold.rb

@@ -1,17 +1,23 @@
 module Coradoc
   module Element
     module Inline
-      class Bold
+      class Bold < Base
         attr_accessor :content, :unconstrained
-        def initialize(content, unconstrained = true)
+
+        declare_children :content
+
+        def initialize(content, unconstrained: true)
           @content = content
           @unconstrained = unconstrained
         end
 
         def to_adoc
           content = Coradoc::Generator.gen_adoc(@content)
-          doubled = @unconstrained ? "*" : ""
-          "#{doubled}*#{content.strip}*#{doubled}#{content[/\s+$/]}"
+          if @unconstrained
+            "**#{content}**"
+          else
+            "*#{content}*"
+          end
         end
       end
     end

data/lib/coradoc/element/inline/cross_reference.rb

@@ -1,8 +1,10 @@
 module Coradoc
   module Element
     module Inline
-      class CrossReference
-        attr_reader :href, :name
+      class CrossReference < Base
+        attr_accessor :href, :name
+
+        declare_children :href, :name
 
         def initialize(href, name = nil)
           @href = href

data/lib/coradoc/element/inline/hard_line_break.rb

@@ -1,7 +1,7 @@
 module Coradoc
   module Element
     module Inline
-      class HardLineBreak
+      class HardLineBreak < Base
         def to_adoc
           " +\n"
         end

data/lib/coradoc/element/inline/highlight.rb

@@ -1,17 +1,23 @@
 module Coradoc
   module Element
     module Inline
-      class Highlight
-        attr_accessor :content
-        def initialize(content, constrained = true)
+      class Highlight < Base
+        attr_accessor :content, :unconstrained
+
+        declare_children :content
+
+        def initialize(content, unconstrained: true)
           @content = content
-          @constrained = constrained
+          @unconstrained = unconstrained
         end
 
         def to_adoc
           content = Coradoc::Generator.gen_adoc(@content)
-          doubled = @constrained ? "" : "#"
-          "#{content[/^\s*/]}#{doubled}##{content.strip}##{doubled}#{content[/\s*$/]}"
+          if @unconstrained
+            "###{content}##"
+          else
+            "##{content}#"
+          end
         end
       end
     end

data/lib/coradoc/element/inline/italic.rb

@@ -1,17 +1,23 @@
 module Coradoc
   module Element
     module Inline
-      class Italic
+      class Italic < Base
         attr_accessor :content, :unconstrained
-        def initialize(content, unconstrained = true)
+
+        declare_children :content
+
+        def initialize(content, unconstrained: true)
           @content = content
           @unconstrained = unconstrained
         end
 
         def to_adoc
           content = Coradoc::Generator.gen_adoc(@content)
-          doubled = @unconstrained ? "_" : ""
-          "#{content[/^\s+/]}#{doubled}_#{content.strip}_#{doubled}#{content[/\s+$/]}"
+          if @unconstrained
+            "__#{content}__"
+          else
+            "_#{content}_"
+          end
         end
       end
     end

data/lib/coradoc/element/inline/link.rb

@@ -1,23 +1,39 @@
+require "uri"
+
 module Coradoc
   module Element
     module Inline
-      class Link
-        attr_reader :path, :title, :name
+      class Link < Base
+        attr_accessor :path, :title, :name, :right_constrain
+
+        declare_children :path, :title, :name
 
         def initialize(options = {})
-          @path = options.fetch(:path,nil)
+          @path = options.fetch(:path, nil)
           @title = options.fetch(:title, nil)
-          @name = options.fetch(:name,nil)
+          @name = options.fetch(:name, nil)
+          @right_constrain = options.fetch(:right_constrain, false)
         end
 
         def to_adoc
-          link = @path.to_s =~ URI::DEFAULT_PARSER.make_regexp ? @path : "link:#{@path}"
-          if @name.to_s.empty?
-            link << "[#{@title}]"
-          else
-            link << "[#{@name}]"
+          link = @path
+          unless @path.to_s&.match?(URI::DEFAULT_PARSER.make_regexp)
+            link = "link:#{link}"
           end
-          link.prepend(' ')
+
+          name_empty = @name.to_s.empty?
+          title_empty = @title.to_s.empty?
+          valid_empty_name_link = link.start_with?(%r{https?://})
+
+          link << if name_empty && !title_empty
+                    "[#{@title}]"
+                  elsif !name_empty
+                    "[#{@name}]"
+                  elsif valid_empty_name_link && !right_constrain
+                    ""
+                  else
+                    "[]"
+                  end
           link
         end
       end

data/lib/coradoc/element/inline/monospace.rb

@@ -1,17 +1,23 @@
 module Coradoc
   module Element
     module Inline
-      class Monospace
+      class Monospace < Base
         attr_accessor :content, :constrained
-        def initialize(content, unconstrained = true)
+
+        declare_children :content
+
+        def initialize(content, unconstrained: true)
           @content = content
           @unconstrained = unconstrained
         end
 
         def to_adoc
           content = Coradoc::Generator.gen_adoc(@content)
-          doubled = @unconstrained ? "`" : ""
-          "#{doubled}`#{content}`#{doubled}"
+          if @unconstrained
+            "``#{content}``"
+          else
+            "`#{content}`"
+          end
         end
       end
     end

data/lib/coradoc/element/inline/quotation.rb

@@ -1,8 +1,11 @@
 module Coradoc
   module Element
     module Inline
-      class Quotation
+      class Quotation < Base
         attr_accessor :content
+
+        declare_children :content
+
         def initialize(content)
           @content = content
         end

data/lib/coradoc/element/inline/subscript.rb

@@ -1,15 +1,18 @@
 module Coradoc
   module Element
     module Inline
-      class Subscript
+      class Subscript < Base
         attr_accessor :content
+
+        declare_children :content
+
         def initialize(content)
           @content = content
         end
 
         def to_adoc
           content = Coradoc::Generator.gen_adoc(@content)
-          "#{content[/^\s*/]}~#{content.strip}~#{content[/\s*$/]}"
+          "~#{content}~"
         end
       end
     end

data/lib/coradoc/element/inline/superscript.rb

@@ -1,15 +1,18 @@
 module Coradoc
   module Element
     module Inline
-      class Superscript
+      class Superscript < Base
         attr_accessor :content
+
+        declare_children :content
+
         def initialize(content)
           @content = content
         end
 
         def to_adoc
           content = Coradoc::Generator.gen_adoc(@content)
-          "#{content[/^\s*/]}^#{content.strip}^#{content[/\s*$/]}"
+          "^#{content}^"
         end
       end
     end

data/lib/coradoc/element/inline.rb

@@ -1,7 +1,6 @@
 module Coradoc
   module Element
     module Inline
-
     end
   end
 end

data/lib/coradoc/element/list/core.rb

@@ -4,32 +4,34 @@ require_relative "core"
 module Coradoc
   module Element
     module List
-      class Core
-        attr_reader :items, :prefix, :id, :ol_count, :anchor
+      class Core < Base
+        attr_accessor :items, :prefix, :id, :ol_count, :anchor
+
+        declare_children :items, :anchor, :id
 
         def initialize(items, options = {})
           @items = items
           @items = [@items] unless @items.is_a?(Array)
           @id = options.fetch(:id, nil)
           @anchor = @id.nil? ? nil : Inline::Anchor.new(@id)
-          @ol_count = options.fetch(:ol_count, 0)
-          @attrs = options.fetch(:attrs, nil)
+          @ol_count = options.fetch(:ol_count, 1)
+          @attrs = options.fetch(:attrs, AttributeList.new)
         end
 
         def to_adoc
+          anchor = @anchor.nil? ? "" : @anchor.to_adoc.to_s
+          attrs = @attrs.to_adoc(false).to_s
           content = "\n"
           @items.each do |item|
             c = Coradoc::Generator.gen_adoc(item)
             if !c.empty?
-              content << "#{prefix}"
+              content << prefix.to_s
+              content << " " if c[0]!=" "
               content << c
             end
           end
-          anchor = @anchor.nil? ? "" : "#{@anchor.to_adoc}"
-          attrs = @attrs.nil? ? "" : "#{@attrs.to_adoc}"
           "\n#{anchor}#{attrs}" + content
         end
-
       end
     end
   end

data/lib/coradoc/element/list/definition.rb

@@ -2,6 +2,25 @@ module Coradoc
   module Element
     module List
       class Definition < Core
+        attr_accessor :items, :delimiter
+
+        def initialize(items, options = {})
+          @items = items
+          @delimiter = options.fetch(:delimiter, "::")
+          # super(items, options)
+        end
+
+        def prefix
+          @delimiter
+        end
+
+        def to_adoc
+          content = "\n"
+          @items.each do |item|
+            content << item.to_adoc(@delimiter)
+          end
+          content
+        end
       end
     end
   end

data/lib/coradoc/element/list/ordered.rb

@@ -7,7 +7,7 @@ module Coradoc
         end
 
         def prefix
-          "." * [@ol_count, 0].max
+          "." * [@ol_count, 1].max
         end
       end
     end

data/lib/coradoc/element/list/unordered.rb

@@ -7,7 +7,7 @@ module Coradoc
         end
 
         def prefix
-          "*" * [@ol_count, 0].max
+          "*" * [@ol_count, 1].max
         end
       end
     end

data/lib/coradoc/element/list.rb

@@ -1,12 +1,12 @@
 module Coradoc
   module Element
     module List
-
     end
   end
 end
 
 require_relative "list_item"
+require_relative "list_item_definition"
 require_relative "list/core"
 require_relative "list/ordered"
 require_relative "list/unordered"

data/lib/coradoc/element/list_item.rb

@@ -1,7 +1,9 @@
 module Coradoc
   module Element
-    class ListItem
-      attr_reader :id
+    class ListItem < Base
+      attr_accessor :id
+
+      declare_children :content, :id, :anchor
 
       def initialize(content, options = {})
         @content = content
@@ -10,8 +12,11 @@ module Coradoc
       end
 
       def to_adoc
-        anchor = @anchor.nil? ? "" : "#{@anchor.to_adoc}"
-        content = Coradoc::Generator.gen_adoc(@content).chomp
+        anchor = @anchor.nil? ? "" : @anchor.to_adoc.to_s
+        content = Array(@content).map do |subitem|
+          Coradoc::Generator.gen_adoc(subitem).chomp
+        end.join("\n+\n")
+
         " #{anchor}#{content.chomp}\n"
       end
     end