coradoc-adoc 2.0.0

data/lib/coradoc/asciidoc/model/image/core/attribute_list.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Image
+        class Core < Coradoc::AsciiDoc::Model::Base
+          class AttributeList < Coradoc::AsciiDoc::Model::AttributeList
+            extend AttributeList::Matchers
+
+            def named_validators
+              super.merge(
+                {
+                  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
+      end
+    end
+  end
+end

data/lib/coradoc/asciidoc/model/image/core.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Image
+        # Base class for image elements in AsciiDoc documents.
+        #
+        # Images can be block-level (standalone paragraphs) or inline (within text).
+        # This base class provides common functionality for both types.
+        #
+        # @!attribute [r] id
+        #   @return [String, nil] Optional identifier for the image
+        #
+        # @!attribute [r] title
+        #   @return [String, nil] Optional image title/alt text
+        #
+        # @!attribute [r] src
+        #   @return [String] The image source URL or path
+        #
+        # @!attribute [r] attributes
+        #   @return [Coradoc::AsciiDoc::Model::Image::Core::AttributeList] Image-specific attributes
+        #
+        # @!attribute [r] annotate_missing
+        #   @return [String, nil] Annotation text for missing images
+        #
+        # @!attribute [r] line_break
+        #   @return [String] Line break character (default: "")
+        #
+        # @!attribute [r] colons
+        #   @return [String, nil] Colon positioning for attributes
+        #
+        # @see Coradoc::AsciiDoc::Model::Image::BlockImage Block-level images
+        # @see Coradoc::AsciiDoc::Model::Image::InlineImage Inline images
+        #
+        class Core < Coradoc::AsciiDoc::Model::Base
+          # Autoload nested AttributeList class
+          autoload :AttributeList, 'coradoc/asciidoc/model/image/core/attribute_list'
+
+          include Coradoc::AsciiDoc::Model::Anchorable
+
+          attribute :id, :string
+          attribute :title, :string
+          attribute :src, :string
+          attribute :attributes,
+                    Coradoc::AsciiDoc::Model::Image::Core::AttributeList,
+                    default: lambda {
+                      ::Coradoc::AsciiDoc::Model::AttributeList.new
+                    }
+          attribute :annotate_missing, :string
+          attribute :line_break, :string, default: -> { '' }
+          attribute :colons, :string
+
+          # Aliases for common attribute accessors
+          alias path src
+          alias alt title
+
+          # Custom to_adoc implementation that uses ElementRegistry directly
+          # to avoid recursion issues with image serialization.
+          #
+          # @return [String] AsciiDoc representation of this image
+          def to_adoc
+            # Use the registered serializer rather than Coradoc::AsciiDoc::Serializer.serialize
+            # to avoid recursion
+            serializer_class = Coradoc::AsciiDoc::Serializer::ElementRegistry.lookup(self.class)
+            serializer_class.new.to_adoc(self)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/asciidoc/model/image/inline_image.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Image
+        class InlineImage < Coradoc::AsciiDoc::Model::Image::Core
+          def inline?
+            true
+          end
+
+          attribute :colons, :string, default: -> { ':' }
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/asciidoc/model/image.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Image
+        # Autoload image types lazily
+        autoload :Core, 'coradoc/asciidoc/model/image/core'
+        autoload :InlineImage, 'coradoc/asciidoc/model/image/inline_image'
+        autoload :BlockImage, 'coradoc/asciidoc/model/image/block_image'
+      end
+    end
+  end
+end

data/lib/coradoc/asciidoc/model/include.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      autoload :Resolvable, "#{__dir__}/resolvable"
+
+      # Include directive element for AsciiDoc documents.
+      #
+      # Include directives allow incorporating content from external files
+      # into the current document at processing time.
+      #
+      # @!attribute [r] path
+      #   @return [String] The path to the file to include
+      #
+      # @!attribute [r] attributes
+      #   @return [Coradoc::AsciiDoc::Model::AttributeList] Include attributes
+      #
+      # @!attribute [r] line_break
+      #   @return [String] Line break character (default: "\n")
+      #
+      # @example Create an include directive
+      #   inc = Coradoc::AsciiDoc::Model::Include.new
+      #   inc.path = "chapter1.adoc"
+      #   inc.to_adoc # => "include::chapter1.adoc[]\n"
+      #
+      class Include < Base
+        include Resolvable
+
+        attribute :path, :string
+        attribute :attributes, Coradoc::AsciiDoc::Model::AttributeList, default: lambda {
+          Coradoc::AsciiDoc::Model::AttributeList.new
+        }
+        attribute :line_break, :string, default: -> { "\n" }
+
+        # @return [String] the path to the included file
+        def reference_path
+          path
+        end
+
+        # @return [Symbol] the reference type
+        def reference_type
+          :include
+        end
+
+        # @return [Hash] include options (leveloffset, lines, tags, etc.)
+        def reference_options
+          options = {}
+          if attributes.is_a?(Coradoc::AsciiDoc::Model::AttributeList)
+            attributes.named.each do |attr|
+              case attr.name.to_s
+              when 'leveloffset'
+                options[:leveloffset] = attr.value
+              when 'lines'
+                options[:lines] = attr.value
+              when 'tags'
+                options[:tags] = attr.value.to_s.split(';')
+              end
+            end
+          end
+          options
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/asciidoc/model/inline/anchor.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Inline
+        # Anchor inline element for creating cross-reference targets in AsciiDoc documents.
+        #
+        # Anchors create reference points that can be linked to from other parts
+        # of the document using cross-references.
+        #
+        # @!attribute [r] id
+        #   @return [String] The anchor identifier
+        #
+        # @example Create an anchor
+        #   anchor = Coradoc::AsciiDoc::Model::Inline::Anchor.new
+        #   anchor.id = "section1"
+        #   anchor.to_adoc # => "[[section1]]"
+        #
+        # @example Validation fails without id
+        #   anchor = Coradoc::AsciiDoc::Model::Inline::Anchor.new
+        #   anchor.validate # Returns validation errors
+        #
+        # @see Coradoc::AsciiDoc::Model::Anchorable Mixin for adding anchor support
+        # @see Coradoc::AsciiDoc::Model::Inline::CrossReference Linking to anchors
+        #
+        class Anchor < Base
+          attribute :id, :string
+
+          def validate
+            errors = super
+            return unless id.nil? || id.empty?
+
+            errors <<
+              Lutaml::Model::Error.new('ID cannot be nil or empty for Anchor')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/asciidoc/model/inline/attribute_reference.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Inline
+        # Attribute reference inline element for AsciiDoc documents.
+        #
+        # Attribute references insert the value of a document attribute.
+        #
+        # @!attribute [r] name
+        #   @return [String] The attribute name to reference
+        #
+        # @example Create an attribute reference
+        #   ref = Coradoc::AsciiDoc::Model::Inline::AttributeReference.new
+        #   ref.name = "author"
+        #   ref.to_adoc # => "{author}"
+        #
+        class AttributeReference < Base
+          attribute :name, :string
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/asciidoc/model/inline/base.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Inline
+        class Base < Coradoc::AsciiDoc::Model::Base
+          def inline?
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/asciidoc/model/inline/bold.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Inline
+        # Bold inline text formatting for AsciiDoc documents.
+        #
+        # Bold text is rendered with asterisks: *bold text*.
+        #
+        # @!attribute [r] content
+        #   @return [String, Array<Lutaml::Model::Serializable>] The text content to format as bold
+        #
+        # @!attribute [r] unconstrained
+        #   @return [Boolean] Whether to use unconstrained formatting (default: true)
+        #
+        # @example Create bold text
+        #   bold = Coradoc::AsciiDoc::Model::Inline::Bold.new
+        #   bold.content = "Important text"
+        #   bold.to_adoc # => "*Important text*"
+        #
+        # @see Coradoc::AsciiDoc::Model::Inline::Italic Italic text
+        # @see Coradoc::AsciiDoc::Model::Inline::Monospace Monospace text
+        #
+        class Bold < Base
+          attribute :content,
+                    Lutaml::Model::Serializable,
+                    default: -> { nil },
+                    polymorphic: [
+                      Lutaml::Model::Type::String,
+                      :array
+                    ]
+          attribute :unconstrained, :boolean, default: -> { true }
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/asciidoc/model/inline/cross_reference.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Inline
+        # Cross-reference (xref) inline element for AsciiDoc documents.
+        #
+        # Cross-references create links to other sections or documents.
+        #
+        # @!attribute [r] href
+        #   @return [String] The target reference ID
+        #
+        # @!attribute [r] args
+        #   @return [Array<String>] Optional reference arguments
+        #
+        # @example Create a cross-reference
+        #   xref = Coradoc::AsciiDoc::Model::Inline::CrossReference.new
+        #   xref.href = "section-id"
+        #   xref.to_adoc # => "<<section-id>>"
+        #
+        class CrossReference < Base
+          attribute :href, :string
+          attribute :args, :string, collection: true
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/asciidoc/model/inline/cross_reference_arg.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Inline
+        class CrossReferenceArg < Base
+          attribute :key, :string
+          attribute :delimiter, :string
+          attribute :value, :string
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/asciidoc/model/inline/footnote.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Inline
+        # Footnote inline element for AsciiDoc documents.
+        #
+        # Footnotes are referenced with numeric IDs: footnote:[text] or footnoteref:[id].
+        #
+        # @!attribute [r] text
+        #   @return [String] The footnote text content
+        #
+        # @!attribute [r] id
+        #   @return [String, nil] Optional footnote reference ID
+        #
+        # @example Create a footnote
+        #   footnote = Coradoc::AsciiDoc::Model::Inline::Footnote.new
+        #   footnote.text = "Additional information"
+        #   footnote.to_adoc # => "footnote:[Additional information]"
+        #
+        # @example Create a footnote reference
+        #   footnote = Coradoc::AsciiDoc::Model::Inline::Footnote.new
+        #   footnote.id = "note1"
+        #   footnote.to_adoc # => "footnoteref:[note1]"
+        #
+        class Footnote < Base
+          attribute :text, :string
+          attribute :id, :string
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/asciidoc/model/inline/hard_line_break.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Inline
+        # Hard line break inline element for AsciiDoc documents.
+        #
+        # Hard line breaks force a line break at a specific point.
+        # Rendered as a plus sign at the end of a line: +.
+        #
+        # @example Create a hard line break
+        #   break = Coradoc::AsciiDoc::Model::Inline::HardLineBreak.new
+        #   break.to_adoc # => " +"
+        #
+        class HardLineBreak < Base
+          def inline?
+            :hardbreak
+          end
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/asciidoc/model/inline/highlight.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Inline
+        # Highlight (marked) inline text formatting for AsciiDoc documents.
+        #
+        # Highlighted text is rendered with hash marks: #highlighted text#.
+        # Used to draw attention to specific text.
+        #
+        # @!attribute [r] content
+        #   @return [String, Array<Lutaml::Model::Serializable>] The text content to highlight
+        #
+        # @!attribute [r] unconstrained
+        #   @return [Boolean] Whether to use unconstrained formatting (default: false)
+        #
+        # @example Create highlighted text
+        #   highlight = Coradoc::AsciiDoc::Model::Inline::Highlight.new
+        #   highlight.content = "Important"
+        #   highlight.to_adoc # => "#Important#"
+        #
+        class Highlight < Base
+          attribute :content,
+                    Lutaml::Model::Serializable,
+                    default: -> { nil },
+                    polymorphic: [
+                      Lutaml::Model::Type::String,
+                      :array
+                    ]
+          attribute :unconstrained, :boolean, default: -> { false }
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/asciidoc/model/inline/italic.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Inline
+        # Italic inline text formatting for AsciiDoc documents.
+        #
+        # Italic text is rendered with underscores: _italic text_.
+        #
+        # @!attribute [r] content
+        #   @return [String, Array<Lutaml::Model::Serializable>] The text content to format as italic
+        #
+        # @!attribute [r] unconstrained
+        #   @return [Boolean] Whether to use unconstrained formatting (default: true)
+        #
+        # @example Create italic text
+        #   italic = Coradoc::AsciiDoc::Model::Inline::Italic.new
+        #   italic.content = "Emphasized text"
+        #   italic.to_adoc # => "_Emphasized text_"
+        #
+        # @see Coradoc::AsciiDoc::Model::Inline::Bold Bold text
+        # @see Coradoc::AsciiDoc::Model::Inline::Monospace Monospace text
+        #
+        class Italic < Base
+          attribute :content,
+                    Lutaml::Model::Serializable,
+                    default: -> { nil },
+                    polymorphic: [
+                      Lutaml::Model::Type::String,
+                      :array
+                    ]
+          attribute :unconstrained, :boolean, default: -> { true }
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/asciidoc/model/inline/link.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Inline
+        # Link inline element for AsciiDoc documents.
+        #
+        # Links can be external URLs or internal references.
+        #
+        # @!attribute [r] path
+        #   @return [String] The URL or path the link points to
+        #
+        # @!attribute [r] title
+        #   @return [String, nil] Optional tooltip text for the link
+        #
+        # @!attribute [r] name
+        #   @return [String, nil] Optional link text/alias
+        #
+        # @!attribute [r] right_constrain
+        #   @return [Boolean] Whether to constrain the link on the right (default: false)
+        #
+        # @example Create an external link
+        #   link = Coradoc::AsciiDoc::Model::Inline::Link.new
+        #   link.path = "https://example.com"
+        #   link.name = "Example Site"
+        #   link.to_adoc # => "https://example.com[Example Site]"
+        #
+        # @example Create a link with title
+        #   link = Coradoc::AsciiDoc::Model::Inline::Link.new
+        #   link.path = "https://example.com"
+        #   link.title = "Visit example"
+        #   link.name = "Click here"
+        #
+        class Link < Base
+          attribute :path, :string
+          attribute :title, :string
+          attribute :name, :string
+          attribute :right_constrain, :boolean, default: -> { false }
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/asciidoc/model/inline/monospace.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Inline
+        # Monospace inline text formatting for AsciiDoc documents.
+        #
+        # Monospace text is rendered with backticks: `monospace text`.
+        # Used for code, commands, and technical terms.
+        #
+        # @!attribute [r] content
+        #   @return [String, Array<Lutaml::Model::Serializable>] The text content to format as monospace
+        #
+        # @!attribute [r] unconstrained
+        #   @return [Boolean] Whether to use unconstrained formatting (default: true)
+        #
+        # @example Create monospace text
+        #   mono = Coradoc::AsciiDoc::Model::Inline::Monospace.new
+        #   mono.content = "code"
+        #   mono.to_adoc # => "`code`"
+        #
+        # @see Coradoc::AsciiDoc::Model::Inline::Bold Bold text
+        # @see Coradoc::AsciiDoc::Model::Inline::Italic Italic text
+        #
+        class Monospace < Base
+          attribute :content,
+                    Lutaml::Model::Serializable,
+                    default: -> { nil },
+                    polymorphic: [
+                      Lutaml::Model::Type::String,
+                      :array
+                    ]
+          attribute :unconstrained, :boolean, default: -> { true }
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/asciidoc/model/inline/quotation.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Inline
+        # Quotation (single-quoted text) inline element for AsciiDoc documents.
+        #
+        # Quoted text is rendered with single backticks: `quoted text`.
+        #
+        # @!attribute [r] content
+        #   @return [String] The text content to quote
+        #
+        # @example Create quoted text
+        #   quote = Coradoc::AsciiDoc::Model::Inline::Quotation.new
+        #   quote.content = "He said"
+        #   quote.to_adoc # => "`He said`"
+        #
+        class Quotation < Base
+          attribute :content, :string
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/asciidoc/model/inline/small.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Inline
+        # Small text inline element for AsciiDoc documents.
+        #
+        # Small text is rendered with a size role: [.small]#text#.
+        #
+        # @!attribute [r] text
+        #   @return [String] The text content to make smaller
+        #
+        # @example Create small text
+        #   small = Coradoc::AsciiDoc::Model::Inline::Small.new
+        #   small.text = "Fine print"
+        #   small.to_adoc # => "[.small]#Fine print#"
+        #
+        class Small < Base
+          attribute :text, :string
+        end
+      end
+    end
+  end
+end