coradoc-adoc 2.0.0

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      # Bibliography block element for AsciiDoc documents.
+      #
+      # Bibliographies contain lists of bibliography entries (references)
+      # with support for various citation styles.
+      #
+      # @!attribute [r] id
+      #   @return [String, nil] Optional identifier for the bibliography
+      #
+      # @!attribute [r] title
+      #   @return [String, nil] Optional bibliography title
+      #
+      # @!attribute [r] entries
+      #   @return [Array<Coradoc::AsciiDoc::Model::BibliographyEntry>] Bibliography entry items
+      #
+      # @example Create a bibliography
+      #   bib = Coradoc::AsciiDoc::Model::Bibliography.new
+      #   bib.title = "References"
+      #   entry = Coradoc::AsciiDoc::Model::BibliographyEntry.new
+      #   bib.entries << entry
+      #
+      # @see Coradoc::AsciiDoc::Model::BibliographyEntry Individual bibliography entries
+      #
+      class Bibliography < Base
+        include Coradoc::AsciiDoc::Model::Anchorable
+
+        attribute :id, :string
+        attribute :title, :string
+        attribute :entries, Coradoc::AsciiDoc::Model::BibliographyEntry, collection: true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      # Individual bibliography entry for AsciiDoc documents.
+      #
+      # Bibliography entries represent single references within a bibliography,
+      # with anchor names for citation linking.
+      #
+      # @!attribute [r] anchor_name
+      #   @return [String, nil] The anchor name for citing this entry
+      #
+      # @!attribute [r] document_id
+      #   @return [String, nil] The document identifier
+      #
+      # @!attribute [r] ref_text
+      #   @return [String, nil] The reference text/citation
+      #
+      # @!attribute [r] line_break
+      #   @return [String] Line break character (default: "")
+      #
+      # @example Create a bibliography entry
+      #   entry = Coradoc::AsciiDoc::Model::BibliographyEntry.new
+      #   entry.anchor_name = "smith2023"
+      #   entry.ref_text = "Smith, J. (2023). Example citation."
+      #
+      # @see Coradoc::AsciiDoc::Model::Bibliography Bibliography container
+      #
+      class BibliographyEntry < Base
+        attribute :anchor_name, :string
+        attribute :document_id, :string
+        attribute :ref_text, :string
+        attribute :line_break, :string, default: -> { '' }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Block
+        # Base class for block elements in AsciiDoc documents.
+        #
+        # Block elements are delimited content sections that can contain
+        # multiple lines, titles, attributes, and attached blocks.
+        #
+        # Specific block types (Literal, Example, Listing, Quote, etc.) inherit
+        # from this class and define their delimiter characters.
+        #
+        # @!attribute [r] id
+        #   @return [String, nil] Optional identifier for the block
+        #
+        # @!attribute [r] title
+        #   @return [String, Array<Coradoc::AsciiDoc::Model::Base>, nil] Block title (string or array of Model objects)
+        #
+        # @!attribute [r] attributes
+        #   @return [Coradoc::AsciiDoc::Model::AttributeList] Block attributes
+        #
+        # @!attribute [r] lines
+        #   @return [Array<Lutaml::Model::Type::String, Coradoc::AsciiDoc::Model::TextElement>] Block content lines
+        #
+        # @!attribute [r] delimiter
+        #   @return [String, nil] Full delimiter string
+        #
+        # @!attribute [r] delimiter_char
+        #   @return [String, nil] Delimiter character (e.g., "=", "-", "*", "_", "+")
+        #
+        # @!attribute [r] delimiter_len
+        #   @return [Integer, nil] Delimiter length (number of repeated characters)
+        #
+        # @!attribute [r] lang
+        #   @return [String, nil] Language identifier for syntax highlighting
+        #
+        # @!attribute [r] type_str
+        #   @return [String, nil] Block type string
+        #
+        # @example Create a custom block
+        #   block = Coradoc::AsciiDoc::Model::Block::Core.new
+        #   block.delimiter_char = "-"
+        #   block.delimiter_len = 4
+        #   block.lines = ["Line 1", "Line 2"]
+        #
+        # @see Coradoc::AsciiDoc::Model::Block::Literal Literal block
+        # @see Coradoc::AsciiDoc::Model::Block::Example Example block
+        # @see Coradoc::AsciiDoc::Model::Block::Listing Listing block
+        # @see Coradoc::AsciiDoc::Model::Block::Quote Quote block
+        #
+        class Core < Attached
+          include Coradoc::AsciiDoc::Model::Anchorable
+
+          attribute :id, :string
+          attribute :title, :string, default: -> { nil } # Polymorphic: string or array of Model objects
+          attribute :attributes, Coradoc::AsciiDoc::Model::AttributeList, default: lambda {
+            Coradoc::AsciiDoc::Model::AttributeList.new
+          }
+          attribute :lines,
+                    Lutaml::Model::Serializable,
+                    collection: true,
+                    initialize_empty: true,
+                    polymorphic: [
+                      Lutaml::Model::Type::String,
+                      Coradoc::AsciiDoc::Model::TextElement
+                    ]
+          attribute :delimiter, :string
+          attribute :delimiter_char, :string
+          attribute :delimiter_len, :integer
+          attribute :lang, :string
+          attribute :type_str, :string
+
+          # Override title and lines setters to accept polymorphic content without coercion
+
+          attr_accessor :title
+
+          attr_writer :lines
+
+          def lines
+            @lines || []
+          end
+
+          def initialize(**attributes)
+            # Extract title and lines before super to avoid coercion
+            title_value = attributes.delete(:title)
+            lines_value = attributes.delete(:lines)
+            super
+            self.title = title_value if title_value
+            self.lines = lines_value if lines_value
+          end
+
+          # NOTE: This module provides core block functionality.
+          # Additional methods may be added as needed for specific block types.
+
+          # Generate the title string for this block
+          #
+          # @return [String] The formatted title (e.g., ".Title\n")
+          def gen_title
+            t = serialize_content(title)
+            return '' if t.nil? || t.empty?
+
+            ".#{t}\n"
+          end
+
+          # Generate the attributes string for this block
+          #
+          # @return [String] The formatted attributes
+          def gen_attributes
+            attrs = attributes.to_adoc(show_empty: false)
+            return "#{attrs}\n" unless attrs.empty?
+
+            ''
+          end
+
+          # Generate the delimiter string for this block
+          #
+          # @return [String] The delimiter (e.g., "----", "====")
+          # @return [String] Empty string if delimiter_char or delimiter_len is nil
+          def gen_delimiter
+            return '' if delimiter_char.nil? || delimiter_len.nil?
+
+            delimiter_char * delimiter_len
+          end
+
+          # Generate the lines content for this block
+          #
+          # @return [String] The serialized lines
+          def gen_lines
+            lines.map do |line|
+              serialize_content(line)
+            end.join
+          end
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/asciidoc/model/block/example.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Block
+        class Example < Core
+          attribute :delimiter_char, :string, default: -> { '=' }
+          attribute :delimiter_len, :integer, default: -> { 4 }
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/asciidoc/model/block/listing.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Block
+        class Listing < Core
+          attribute :delimiter_char, :string, default: -> { '-' }
+          attribute :delimiter_len, :integer, default: -> { 4 }
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/asciidoc/model/block/literal.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Block
+        class Literal < Core
+          attribute :delimiter_char, :string, default: -> { '.' }
+          attribute :delimiter_len, :integer, default: -> { 4 }
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/asciidoc/model/block/open.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Block
+        class Open < Core
+          attribute :delimiter_char, :string, default: -> { '-' }
+          attribute :delimiter_len, :integer, default: -> { 2 }
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/asciidoc/model/block/pass.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Block
+        class Pass < Core
+          attribute :delimiter_char, :string, default: -> { '+' }
+          attribute :delimiter_len, :integer, default: -> { 4 }
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/asciidoc/model/block/quote.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Block
+        class Quote < Core
+          attribute :delimiter_char, :string, default: -> { '_' }
+          attribute :delimiter_len, :integer, default: -> { 4 }
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/asciidoc/model/block/reviewer_comment.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Block
+        class ReviewerComment < Core
+          attribute :delimiter_char, :string, default: -> { '*' }
+          attribute :delimiter_len, :integer, default: -> { 4 }
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/asciidoc/model/block/side.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Block
+        class Side < Core
+          attribute :delimiter_char, :string, default: -> { '*' }
+          attribute :delimiter_len, :integer, default: -> { 4 }
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/asciidoc/model/block/source_code.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Block
+        class SourceCode < Core
+          attribute :delimiter_char, :string, default: -> { '-' }
+          attribute :delimiter_len, :integer, default: -> { 4 }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      module Block
+        # Autoload block types lazily
+        autoload :Core, 'coradoc/asciidoc/model/block/core'
+        autoload :Example, 'coradoc/asciidoc/model/block/example'
+        autoload :Literal, 'coradoc/asciidoc/model/block/literal'
+        autoload :Listing, 'coradoc/asciidoc/model/block/listing'
+        autoload :Open, 'coradoc/asciidoc/model/block/open'
+        autoload :Pass, 'coradoc/asciidoc/model/block/pass'
+        autoload :Quote, 'coradoc/asciidoc/model/block/quote'
+        autoload :Side, 'coradoc/asciidoc/model/block/side'
+        autoload :SourceCode, 'coradoc/asciidoc/model/block/source_code'
+        autoload :ReviewerComment, 'coradoc/asciidoc/model/block/reviewer_comment'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      # Thematic break elements for AsciiDoc documents.
+      #
+      module Break
+        # Thematic break (horizontal rule) for AsciiDoc documents.
+        #
+        # Represented by a line of three or more asterisks ('***') in AsciiDoc.
+        # Used to separate content sections visually.
+        #
+        # @example Create a thematic break
+        #   break = Coradoc::AsciiDoc::Model::Break::ThematicBreak.new
+        #
+        # @example Serialize to AsciiDoc
+        #   break = Coradoc::AsciiDoc::Model::Break::ThematicBreak.new
+        #   break.to_adoc # => "'''\n"
+        #
+        class ThematicBreak < Base
+        end
+
+        # Page break for AsciiDoc documents.
+        #
+        # Represented by <<< in AsciiDoc. Layout-only element;
+        # has no CoreModel equivalent and is filtered during ToCoreModel.
+        class PageBreak < Base
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      # Comment block element for AsciiDoc documents.
+      #
+      # Comment blocks contain multi-line comments that are not part
+      # of the final document output.
+      #
+      # @!attribute [r] text
+      #   @return [String] The comment text
+      #
+      # @!attribute [r] line_break
+      #   @return [String] Line break character (default: "\n")
+      #
+      # @example Create a comment block
+      #   comment = Coradoc::AsciiDoc::Model::CommentBlock.new
+      #   comment.text = "This is a multi-line comment"
+      #
+      # @see Coradoc::AsciiDoc::Model::CommentLine Single-line comments
+      #
+      class CommentBlock < Base
+        def block_level?
+          true
+        end
+
+        attribute :text, :string
+        attribute :line_break, :string, default: -> { "\n" }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module AsciiDoc
+    module Model
+      # Single-line comment element for AsciiDoc documents.
+      #
+      # Comment lines start with double slash (//) and are not included
+      # in the final document output.
+      #
+      # @!attribute [r] text
+      #   @return [String] The comment text
+      #
+      # @!attribute [r] line_break
+      #   @return [String] Line break character (default: "\n")
+      #
+      # @example Create a comment line
+      #   comment = Coradoc::AsciiDoc::Model::CommentLine.new
+      #   comment.text = "This is a comment"
+      #   comment.to_adoc # => "// This is a comment\n"
+      #
+      # @see Coradoc::AsciiDoc::Model::CommentBlock Multi-line comments
+      #
+      class CommentLine < Base
+        attribute :text, :string
+        attribute :line_break, :string, default: -> { "\n" }
+      end
+    end
+  end
+end