coradoc 1.1.7 → 2.0.2

data/coradoc-markdown/spec/fixtures/kramdown/span/extension/comment.html

@@ -0,0 +1,6 @@
+<p>This is a <!-- simple --> paragraph.
+This is a <!-- simple --> paragraph.
+This is a <!-- simple {:/other} paragraph -->.
+This is a  paragraph.
+This is a {:/comment} simple {:/} paragraph.
+This is a {::comment} paragraph.</p>

data/coradoc-markdown/spec/fixtures/kramdown/span/extension/comment.text

@@ -0,0 +1,6 @@
+This is a {::comment}simple{:/} paragraph.
+This is a {::comment}simple{:/comment} paragraph.
+This is a {::comment}simple {:/other} paragraph{:/comment}.
+This is a {::comment/} paragraph.
+This is a {:/comment} simple {:/} paragraph.
+This is a {::comment} paragraph.

data/coradoc-markdown/spec/fixtures/kramdown/span/extension/ignored.html

@@ -0,0 +1 @@
+<p>This is {::something}paragraph{:/}</p>

data/coradoc-markdown/spec/fixtures/kramdown/span/extension/ignored.text

@@ -0,0 +1 @@
+This is {::something}paragraph{:/}

data/coradoc-markdown/spec/fixtures/kramdown/span/extension/nomarkdown.html

@@ -0,0 +1 @@
+<p>This is *some* text.</p>

data/coradoc-markdown/spec/fixtures/kramdown/span/extension/nomarkdown.text

@@ -0,0 +1 @@
+This is {::nomarkdown}*some*{:/} text.

data/coradoc-markdown/spec/fixtures/kramdown/span/extension/options.html

@@ -0,0 +1 @@
+<p>This is an  option <span>*true*</span>!</p>

data/coradoc-markdown/spec/fixtures/kramdown/span/extension/options.text

@@ -0,0 +1 @@
+This is an {::options parse_span_html="false" /} option <span>*true*</span>!

data/coradoc-markdown/spec/fixtures/kramdown/span/ial/simple.html

@@ -0,0 +1,6 @@
+<p>This is a <code class="hund" id="dog">span</code>.</p>
+
+<p>This is a <code class="hund katz" id="dog" key="val">span</code>.</p>
+
+<p>This is an{: .ignored} span ial.
+This is an{: .escaped} span ial.</p>

data/coradoc-markdown/spec/fixtures/kramdown/span/ial/simple.text

@@ -0,0 +1,6 @@
+This is a `span`{: .hund #dog}.
+
+This is a `span`{: .hund #dog}{: .katz key='val'}.
+
+This is an{: .ignored} span ial.
+This is an\{: .escaped} span ial.

data/coradoc-markdown/spec/fixtures/kramdown/span/line_breaks/normal.html

@@ -0,0 +1,11 @@
+<p>This is a line<br />
+with a line break.</p>
+
+<p>This is a line 
+without a line break.</p>
+
+<p>This is a line <br />
+with a line\ <br />
+break.</p>
+
+<p>Line break on last line.</p>

data/coradoc-markdown/spec/fixtures/kramdown/span/line_breaks/normal.latex

@@ -0,0 +1,12 @@
+This is a line\newline
+with a line break.
+
+This is a line 
+without a line break.
+
+This is a line \newline
+with a line\textbackslash{} \newline
+break.
+
+Line break on last line.
+

data/coradoc-markdown/spec/fixtures/kramdown/span/line_breaks/normal.text

@@ -0,0 +1,11 @@
+This is a line  
+with a line break.  
+
+This is a line 
+without a line break.
+
+This is a line \\
+with a line\\   
+break.
+
+Line break on last line.  

data/coradoc-markdown/spec/fixtures/kramdown/span/math/no_engine.html

@@ -0,0 +1 @@
+<p><span class="kdmath">$5+5$</span> inline math</p>

data/coradoc-markdown/spec/fixtures/kramdown/span/math/no_engine.options

@@ -0,0 +1 @@
+:math_engine: ~

data/coradoc-markdown/spec/fixtures/kramdown/span/math/no_engine.text

@@ -0,0 +1 @@
+$$5+5$$ inline math

data/coradoc-markdown/spec/fixtures/kramdown/span/math/normal.html

@@ -0,0 +1,10 @@
+<p>This is \(\lambda_\alpha &gt; 5\) some math. With \(1
++ 1\) new line characters in between.</p>
+
+<p>\(5+5\) inline math, $5.00 $$no math$$</p>
+
+<p>$$5+5$$ inline math</p>
+
+<p>\(5+5\)</p>
+
+<p>$$5+5$$</p>

data/coradoc-markdown/spec/fixtures/kramdown/span/math/normal.text

@@ -0,0 +1,10 @@
+This is $$\lambda_\alpha > 5$$ some math. With $$1
++ 1$$ new line characters in between.
+
+$$5+5$$ inline math, $5.00 \$$no math$$
+
+\$\$5+5$$ inline math
+
+\$$5+5$$
+
+\$\$5+5$$

data/coradoc-markdown/spec/fixtures/kramdown/span/text_substitutions/entities.html

@@ -0,0 +1,6 @@
+<p>This is the A&amp;O. &copy; 2008 by me
+As well \&amp; as this. Some &#343; other
+values may &#xAF; may also show but
+not st. like &amp;#xYZ;.</p>
+
+<p>This &lt;span&gt; is BS&amp;T; done!</p>

data/coradoc-markdown/spec/fixtures/kramdown/span/text_substitutions/entities.options

@@ -0,0 +1 @@
+:entity_output: :as_input

data/coradoc-markdown/spec/fixtures/kramdown/span/text_substitutions/entities.text

@@ -0,0 +1,6 @@
+This is the A&O. © 2008 by me
+As well \& as this. Some ŗ other
+values may ¯ may also show but
+not st. like &#xYZ;.
+
+This <span> is BS&T; done!

data/coradoc-markdown/spec/fixtures/kramdown/span/text_substitutions/entities_as_char.html

@@ -0,0 +1 @@
+<p>This "is" 'the' A&amp;O. © 2008 by me ŗ and λ</p>

data/coradoc-markdown/spec/fixtures/kramdown/span/text_substitutions/entities_as_char.options

@@ -0,0 +1,2 @@
+:entity_output: :as_char
+:smart_quotes: apos,apos,quot,quot

data/coradoc-markdown/spec/fixtures/kramdown/span/text_substitutions/entities_as_char.text

@@ -0,0 +1 @@
+This "is" 'the' A&O. © 2008 by me ŗ and λ

data/coradoc-markdown/spec/fixtures/kramdown/span/text_substitutions/entities_as_input.html

@@ -0,0 +1 @@
+<p>This is the A&amp;O. &copy; 2008 by me &#343; and &#x3bb;</p>

data/coradoc-markdown/spec/fixtures/kramdown/span/text_substitutions/entities_as_input.options

@@ -0,0 +1 @@
+:entity_output: :as_input

data/coradoc-markdown/spec/fixtures/kramdown/span/text_substitutions/entities_as_input.text

@@ -0,0 +1 @@
+This is the A&O. © 2008 by me ŗ and λ

data/coradoc-markdown/spec/fixtures/kramdown/span/text_substitutions/entities_numeric.html

@@ -0,0 +1 @@
+<p>This is the A&amp;O. &#169; 2008 by me &#343; and &#955;</p>

data/coradoc-markdown/spec/fixtures/kramdown/span/text_substitutions/entities_numeric.options

@@ -0,0 +1 @@
+:entity_output: :numeric

data/coradoc-markdown/spec/fixtures/kramdown/span/text_substitutions/entities_numeric.text

@@ -0,0 +1 @@
+This is the A&O. © 2008 by me ŗ and λ

data/coradoc-markdown/spec/fixtures/kramdown/span/text_substitutions/entities_symbolic.html

@@ -0,0 +1 @@
+<p>This is the A&amp;O. &copy; 2008 by me &#343; and &lambda;</p>

data/coradoc-markdown/spec/fixtures/kramdown/span/text_substitutions/entities_symbolic.options

@@ -0,0 +1 @@
+:entity_output: :symbolic

data/coradoc-markdown/spec/fixtures/kramdown/span/text_substitutions/entities_symbolic.text

@@ -0,0 +1 @@
+This is the A&O. © 2008 by me ŗ and λ

data/coradoc-markdown/spec/fixtures/kramdown/span/text_substitutions/greaterthan.html

@@ -0,0 +1 @@
+<p>2 &gt; 1 &gt; 0</p>

data/coradoc-markdown/spec/fixtures/kramdown/span/text_substitutions/greaterthan.text

@@ -0,0 +1 @@
+2 > 1 > 0

data/coradoc-markdown/spec/fixtures/kramdown/span/text_substitutions/lowerthan.html

@@ -0,0 +1 @@
+<p>0 &lt; 1 &lt; 2</p>

data/coradoc-markdown/spec/fixtures/kramdown/span/text_substitutions/lowerthan.text

@@ -0,0 +1 @@
+0 < 1 < 2

data/coradoc-markdown/spec/fixtures/kramdown/span/text_substitutions/typography.html

@@ -0,0 +1,40 @@
+<p>This is&hellip; something&mdash;this too&ndash;!</p>
+
+<p>This &laquo;is&raquo; some text, &laquo;&nbsp;this&nbsp;&raquo; too!</p>
+
+<p>&ldquo;Fancy quotes&rdquo; are &lsquo;cool&rsquo;, even in the &rsquo;80s!
+Je t&rsquo; aime. You&rsquo;re a funny one! Thomas&rsquo; name
+Mark&rsquo;s name. &ldquo;&hellip;you&rdquo;
+&ldquo;&lsquo;Nested&rsquo; quotes are &lsquo;possible&rsquo;&rdquo;, too!
+&lsquo;&ldquo;Otherway&rdquo; is &ldquo;round&rdquo;&rsquo;!</p>
+
+<p>&lsquo;Opening now!&rsquo;</p>
+
+<p>&rsquo;80s are really cool.</p>
+
+<p><em>Cluster</em>&rsquo;s Last Stand.</p>
+
+<p>Nam liber tempor
+&ldquo;&hellip;At vero eos et accusam&rdquo;</p>
+
+<p>&ldquo;<em>Single underscores</em> should work.&rdquo;</p>
+
+<p>&ldquo;<em>Single asterisks</em> should work.&rdquo;</p>
+
+<p>&lsquo;<strong>Double underscores</strong> should work.&rsquo;</p>
+
+<p>&lsquo;<strong>Double asterisks</strong> should work.&rsquo;</p>
+
+<p>&ldquo;<em>Hurrah!</em>&rdquo;</p>
+
+<p>&lsquo;<strong>Absolutely</strong>.&rsquo;</p>
+
+<p>&ldquo;&hellip;some Text&rdquo;</p>
+
+<p>&ldquo;&hellip; some Text&rdquo;</p>
+
+<p>This: &ldquo;&hellip;some Text&rdquo;</p>
+
+<p>This: &ldquo;&hellip; some Text&rdquo;</p>
+
+<p>&rdquo;[foo]&rdquo; &ldquo;[foo]&rdquo; d &ldquo;[foo]&rdquo;</p>

data/coradoc-markdown/spec/fixtures/kramdown/span/text_substitutions/typography.options

@@ -0,0 +1 @@
+:entity_output: symbolic

data/coradoc-markdown/spec/fixtures/kramdown/span/text_substitutions/typography.text

@@ -0,0 +1,40 @@
+This is... something---this too--!
+
+This <<is>> some text, << this >> too!
+
+"Fancy quotes" are 'cool', even in the '80s!
+Je t' aime. You're a funny one! Thomas' name
+Mark's name. "...you"
+"'Nested' quotes are 'possible'", too!
+'"Otherway" is "round"'!
+
+'Opening now!'
+
+'80s are really cool.
+
+<em>Cluster</em>'s Last Stand.
+
+Nam liber tempor
+"...At vero eos et accusam"
+
+"_Single underscores_ should work."
+
+"*Single asterisks* should work."
+
+'__Double underscores__ should work.'
+
+'**Double asterisks** should work.'
+
+"_Hurrah!_"
+
+'__Absolutely__.'
+
+"...some Text"
+
+"... some Text"
+
+This: "...some Text"
+
+This: "... some Text"
+
+"\[foo]" "\[foo]" d "\[foo]"

data/coradoc-markdown/spec/fixtures/kramdown/span/text_substitutions/typography_subst.html

@@ -0,0 +1,3 @@
+<p>This ... something---this too--!</p>
+
+<p>This &lt;&lt;is&gt;&gt; some text, &lt;&lt; this &gt;&gt; too!</p>

data/coradoc-markdown/spec/fixtures/kramdown/span/text_substitutions/typography_subst.latex

@@ -0,0 +1,4 @@
+This ... something---this too--!
+
+This \textless{}\textless{}is\textgreater{}\textgreater{} some text, \textless{}\textless{} this \textgreater{}\textgreater{} too!
+

data/coradoc-markdown/spec/fixtures/kramdown/span/text_substitutions/typography_subst.options

@@ -0,0 +1,8 @@
+typographic_symbols:
+  hellip: '...'
+  mdash: '---'
+  ndash: '--'
+  laquo: '<<'
+  raquo: '>>'
+  laquo_space: '<< '
+  raquo_space: ' >>'

data/coradoc-markdown/spec/fixtures/kramdown/span/text_substitutions/typography_subst.text

@@ -0,0 +1,3 @@
+This ... something---this too--!
+
+This <<is>> some text, << this >> too!

data/coradoc-markdown/spec/kramdown_test_suite_spec.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'yaml'
+
+# Kramdown test runner for coradoc-markdown
+#
+# This spec runs tests ported from the kramdown test suite.
+# Each test has a .text file (markdown input) and a .html file (expected HTML output).
+#
+# We test by:
+# 1. Parsing the markdown to AST
+# 2. Verifying the AST is valid (no parse errors)
+# 3. Optionally comparing AST structure for specific test cases
+
+# Test categories to exclude (not relevant for our parser)
+EXCLUDED_TESTS = %w[
+  man/
+].freeze
+
+# Tests that are expected to fail (parser limitations)
+# Note: IAL, ALD, extensions, math, and HTML markdown attr are now implemented
+PENDING_TESTS = %w[].freeze
+
+def find_test_files
+  spec_dir = File.dirname(__FILE__)
+  fixtures_dir = File.join(spec_dir, 'fixtures', 'kramdown')
+  Dir[File.join(fixtures_dir, '**', '*.text')].sort
+end
+
+def excluded?(test_path)
+  EXCLUDED_TESTS.any? { |ex| test_path.include?(ex) }
+end
+
+def pending?(test_path)
+  PENDING_TESTS.any? { |ex| test_path.include?(ex) }
+end
+
+def load_test_case(text_file)
+  html_file = text_file.sub(/\.text$/, '.html')
+  options_file = text_file.sub(/\.text$/, '.options')
+
+  {
+    text: File.read(text_file, encoding: 'UTF-8'),
+    html: File.exist?(html_file) ? File.read(html_file, encoding: 'UTF-8') : nil,
+    options: File.exist?(options_file) ? YAML.load_file(options_file) : {}
+  }
+end
+
+def parse_markdown(text)
+  Coradoc::Markdown.parse(text)
+end
+
+# Generate tests dynamically
+RSpec.describe 'Kramdown Test Suite' do
+  find_test_files.each do |text_file|
+    relative_path = text_file.sub(%r{.*spec/fixtures/kramdown/}, '')
+
+    next if excluded?(relative_path)
+
+    test_name = relative_path.sub(/\.text$/, '').tr('/', '_')
+
+    if pending?(relative_path)
+      xit "parses #{test_name}" do
+        # Pending test
+      end
+
+      next
+    end
+
+    it "parses #{test_name}" do
+      test_case = load_test_case(text_file)
+
+      # Parse should not raise errors
+      expect do
+        result = parse_markdown(test_case[:text])
+        expect(result).not_to be_nil
+      end.not_to raise_error
+    end
+  end
+end

data/coradoc-markdown/spec/model/abbreviation_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Coradoc::Markdown::Abbreviation do
+  describe '.new' do
+    it 'creates an abbreviation with term and definition' do
+      abbr = described_class.new(term: 'HTML', definition: 'HyperText Markup Language')
+
+      expect(abbr.term).to eq('HTML')
+      expect(abbr.definition).to eq('HyperText Markup Language')
+    end
+  end
+end
+
+RSpec.describe 'Abbreviation Parsing' do
+  let(:parser) { Coradoc::Markdown::Parser::BlockParser.new }
+
+  describe 'abbreviation definition' do
+    it 'parses a simple abbreviation definition' do
+      result = parser.parse("*[HTML]: HyperText Markup Language\n")
+
+      expect(result).to be_an(Array)
+      expect(result.first).to have_key(:abbr_term)
+      expect(result.first).to have_key(:abbr_def)
+    end
+
+    it 'parses abbreviation with spaces in term' do
+      result = parser.parse("*[foo bar]: baz\n")
+
+      expect(result.first[:abbr_term].to_s).to eq('foo bar')
+    end
+  end
+
+  describe 'abbreviation model transformation' do
+    it 'transforms AST to Abbreviation model' do
+      doc = Coradoc::Markdown.parse("Some text\n\n*[HTML]: HyperText Markup Language\n")
+
+      expect(doc.blocks).to be_an(Array)
+      expect(doc.blocks.length).to eq(2)
+      expect(doc.blocks.first).to be_a(Coradoc::Markdown::Paragraph)
+      expect(doc.blocks.last).to be_a(Coradoc::Markdown::Abbreviation)
+      expect(doc.blocks.last.term).to eq('HTML')
+      expect(doc.blocks.last.definition).to eq('HyperText Markup Language')
+    end
+
+    it 'handles empty definition' do
+      doc = Coradoc::Markdown.parse("*[empty]: \n")
+
+      expect(doc.blocks.first).to be_a(Coradoc::Markdown::Abbreviation)
+      expect(doc.blocks.first.term).to eq('empty')
+      # Empty definitions may be parsed as empty array or empty string
+      expect(['', '[]']).to include(doc.blocks.first.definition)
+    end
+  end
+end

data/coradoc-markdown/spec/model/auto_id_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe 'Auto IDs' do
+  describe Coradoc::Markdown::Heading do
+    describe '#auto_id' do
+      it 'generates a slug from simple text' do
+        heading = described_class.new(text: 'Hello World')
+        expect(heading.auto_id).to eq('hello-world')
+      end
+
+      it 'handles punctuation' do
+        heading = described_class.new(text: 'Hello, World!')
+        expect(heading.auto_id).to eq('hello-world')
+      end
+
+      it 'handles multiple spaces' do
+        heading = described_class.new(text: 'Hello    World')
+        expect(heading.auto_id).to eq('hello-world')
+      end
+
+      it 'handles numbers' do
+        heading = described_class.new(text: 'Chapter 1: Introduction')
+        expect(heading.auto_id).to eq('chapter-1-introduction')
+      end
+
+      it 'handles leading and trailing special chars' do
+        heading = described_class.new(text: '--- Hello ---')
+        expect(heading.auto_id).to eq('hello')
+      end
+
+      it 'handles empty text' do
+        heading = described_class.new(text: '')
+        expect(heading.auto_id).to eq('')
+      end
+
+      it 'handles nil text' do
+        heading = described_class.new(text: nil)
+        expect(heading.auto_id).to eq('')
+      end
+
+      it 'handles only special characters' do
+        heading = described_class.new(text: '!!!')
+        expect(heading.auto_id).to eq('section')
+      end
+    end
+
+    describe '#heading_id' do
+      it 'returns auto_id when no explicit id is set' do
+        heading = described_class.new(text: 'Introduction')
+        expect(heading.heading_id).to eq('introduction')
+      end
+
+      it 'returns explicit id when set' do
+        heading = described_class.new(text: 'Introduction')
+        heading.id = 'custom-id'
+        expect(heading.heading_id).to eq('custom-id')
+      end
+    end
+  end
+end

data/coradoc-markdown/spec/model/definition_list_spec.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Coradoc::Markdown::DefinitionList do
+  describe '.new' do
+    it 'creates a definition list with items' do
+      term = Coradoc::Markdown::DefinitionTerm.new(
+        text: 'kramdown',
+        definitions: [
+          Coradoc::Markdown::DefinitionItem.new(content: 'A Markdown parser')
+        ]
+      )
+      list = described_class.new(items: [term])
+
+      expect(list.items).to be_an(Array)
+      expect(list.items.first).to be_a(Coradoc::Markdown::DefinitionTerm)
+      expect(list.items.first.text).to eq('kramdown')
+    end
+  end
+
+  describe '#to_md' do
+    it 'serializes to Markdown format' do
+      term = Coradoc::Markdown::DefinitionTerm.new(
+        text: 'term',
+        definitions: [
+          Coradoc::Markdown::DefinitionItem.new(content: 'definition')
+        ]
+      )
+      list = described_class.new(items: [term])
+
+      expect(list.to_md).to eq("term\n: definition")
+    end
+  end
+end
+
+RSpec.describe Coradoc::Markdown::DefinitionTerm do
+  describe '.new' do
+    it 'creates a term with text' do
+      term = described_class.new(text: 'API')
+
+      expect(term.text).to eq('API')
+      expect(term.definitions).to eq([])
+    end
+
+    it 'creates a term with definitions' do
+      defn = Coradoc::Markdown::DefinitionItem.new(content: 'Application Programming Interface')
+      term = described_class.new(text: 'API', definitions: [defn])
+
+      expect(term.definitions).to be_an(Array)
+      expect(term.definitions.first.content).to eq('Application Programming Interface')
+    end
+  end
+end
+
+RSpec.describe Coradoc::Markdown::DefinitionItem do
+  describe '.new' do
+    it 'creates a definition with content' do
+      defn = described_class.new(content: 'A definition')
+
+      expect(defn.content).to eq('A definition')
+    end
+  end
+end
+
+RSpec.describe 'Definition List Parsing' do
+  let(:parser) { Coradoc::Markdown::Parser::BlockParser.new }
+
+  describe 'simple definition list' do
+    it 'parses a single term with definition' do
+      result = parser.parse("kram\n: down\n")
+
+      expect(result).to be_an(Array)
+      expect(result.first).to have_key(:dl)
+      dl = result.first[:dl]
+      expect(dl).to be_an(Array)
+      expect(dl.first).to have_key(:def_term)
+      expect(dl[1]).to have_key(:def_content)
+    end
+
+    it 'parses multiple terms with definitions' do
+      result = parser.parse("kram\n: down\n\nanother\n: definition\n")
+
+      expect(result).to be_an(Array)
+      expect(result.first).to have_key(:dl)
+    end
+  end
+
+  describe 'definition list model transformation' do
+    it 'transforms AST to DefinitionList model' do
+      doc = Coradoc::Markdown.parse("kram\n: down\n")
+
+      expect(doc.blocks.first).to be_a(Coradoc::Markdown::DefinitionList)
+      list = doc.blocks.first
+      expect(list.items).to be_an(Array)
+      expect(list.items.first.text).to eq('kram')
+      expect(list.items.first.definitions.first.content).to eq('down')
+    end
+
+    it 'handles multiple terms and definitions' do
+      doc = Coradoc::Markdown.parse("term1\n: def1\n\nterm2\n: def2\n")
+
+      expect(doc.blocks.first).to be_a(Coradoc::Markdown::DefinitionList)
+      list = doc.blocks.first
+      expect(list.items.length).to eq(2)
+      expect(list.items[0].text).to eq('term1')
+      expect(list.items[1].text).to eq('term2')
+    end
+  end
+end