Merge pull request #889 from pillar-markup/IntroduceRawParagraph

Introduce raw paragraph
pillar-markup · Sep 30, 2024 · 6d4364a · 6d4364a
2 parents c4534dc + 3040a84
commit 6d4364a
Show file tree

Hide file tree

Showing 30 changed files with 215 additions and 59 deletions.
diff --git a/src/Microdown-BrowserExtensions/Class.extension.st b/src/Microdown-BrowserExtensions/Class.extension.st
@@ -29,18 +29,8 @@ Class >> addDocumentSectionTo: aBuilder label: label methods: methods [
 { #category : '*Microdown-BrowserExtensions' }
 Class >> buildMicroDownUsing: aBuilder withComment: aString [
 
-	aBuilder 
-		header: [ aBuilder text: 'Class: '.
-					aBuilder text: self name ] withLevel: 1;
-		horizontalLine;
-		text: aString.
-
-	self addDocumentSectionExampleCodeTo: aBuilder.
-
-	self 
-		addDocumentSectionTo: aBuilder  
-		label: 'Examples' 
-		methods: (self class methods select: [ :each | each protocol = self documentExamplesProtocol ])
+	aString.
+
 ]
 
 { #category : '*Microdown-BrowserExtensions' }

diff --git a/src/Microdown-Tests/MicElementTest.class.st b/src/Microdown-Tests/MicElementTest.class.st
@@ -5,7 +5,7 @@ Class {
 		'parser'
 	],
 	#pools : [
-		'MicMicrodownSharedPool'
+		'MicSharedPool'
 	],
 	#category : 'Microdown-Tests-Parser',
 	#package : 'Microdown-Tests',

diff --git a/src/Microdown-Tests/MicInlineBlockTest.class.st b/src/Microdown-Tests/MicInlineBlockTest.class.st
@@ -2,7 +2,7 @@ Class {
 	#name : 'MicInlineBlockTest',
 	#superclass : 'TestCase',
 	#pools : [
-		'MicMicrodownSharedPool'
+		'MicSharedPool'
 	],
 	#category : 'Microdown-Tests-InlineParser',
 	#package : 'Microdown-Tests',

diff --git a/src/Microdown-Tests/MicInlineParserTest.class.st b/src/Microdown-Tests/MicInlineParserTest.class.st
@@ -2,7 +2,7 @@ Class {
 	#name : 'MicInlineParserTest',
 	#superclass : 'TestCase',
 	#pools : [
-		'MicMicrodownSharedPool'
+		'MicSharedPool'
 	],
 	#category : 'Microdown-Tests-InlineParser',
 	#package : 'Microdown-Tests',

diff --git a/src/Microdown-Tests/MicInlineTokenStreamTest.class.st b/src/Microdown-Tests/MicInlineTokenStreamTest.class.st
@@ -5,7 +5,7 @@ Class {
 	#name : 'MicInlineTokenStreamTest',
 	#superclass : 'TestCase',
 	#pools : [
-		'MicMicrodownSharedPool'
+		'MicSharedPool'
 	],
 	#category : 'Microdown-Tests-InlineParser',
 	#package : 'Microdown-Tests',

diff --git a/src/Microdown-Tests/MicMicrodownSnippetFactory.class.st b/src/Microdown-Tests/MicMicrodownSnippetFactory.class.st
@@ -26,7 +26,7 @@ Class {
 		'parserClass'
 	],
 	#pools : [
-		'MicMicrodownSharedPool'
+		'MicSharedPool'
 	],
 	#category : 'Microdown-Tests-Snippets',
 	#package : 'Microdown-Tests',

diff --git a/src/Microdown-Tests/MicMicrodownTextualBuilderTest.class.st b/src/Microdown-Tests/MicMicrodownTextualBuilderTest.class.st
@@ -9,7 +9,7 @@ Class {
 		'builder'
 	],
 	#pools : [
-		'MicMicrodownSharedPool'
+		'MicSharedPool'
 	],
 	#category : 'Microdown-Tests-Builder',
 	#package : 'Microdown-Tests',

diff --git a/src/Microdown-Tests/MicParserTest.class.st b/src/Microdown-Tests/MicParserTest.class.st
@@ -5,7 +5,7 @@ Class {
 		'parser'
 	],
 	#pools : [
-		'MicMicrodownSharedPool'
+		'MicSharedPool'
 	],
 	#category : 'Microdown-Tests-Parser',
 	#package : 'Microdown-Tests',

diff --git a/src/Microdown-Tests/MicRawBlockTest.class.st b/src/Microdown-Tests/MicRawBlockTest.class.st
@@ -11,6 +11,17 @@ MicRawBlockTest >> subjectClass [
 	^ MicRawBlock  
 ]
 
+{ #category : 'tests' }
+MicRawBlockTest >> testASimpleRawParagaaph [
+	| mic |
+	mic := (parser parse: '<title> 
+No idea what it is :)
+</title>') children first.
+	self assert: mic class equals: MicRawParagraphBlock. 
+	self assert: mic label equals: 'title'.
+
+]
+
 { #category : 'tests' }
 MicRawBlockTest >> testRaw [
 

diff --git a/src/Microdown-Tests/MicRawParagraphBlockTest.class.st b/src/Microdown-Tests/MicRawParagraphBlockTest.class.st
@@ -0,0 +1,74 @@
+Class {
+	#name : 'MicRawParagraphBlockTest',
+	#superclass : 'MicBlockTest',
+	#category : 'Microdown-Tests',
+	#package : 'Microdown-Tests'
+}
+
+{ #category : 'tests' }
+MicRawParagraphBlockTest >> subjectClass [ 
+	^ MicRawParagraphBlock 
+]
+
+{ #category : 'tests' }
+MicRawParagraphBlockTest >> testASimpleRawParagraph [
+	| mic |
+	mic := (parser parse: '<title> 
+No idea what it is :)
+</title>') children first.
+	self assert: mic class equals: MicRawParagraphBlock. 
+	self assert: mic label equals: 'title'.
+
+]
+
+{ #category : 'tests' }
+MicRawParagraphBlockTest >> testNotASimpleRawParagraph [
+	| mic |
+	mic := (parser parse: '<toto> 
+No idea what it is :)
+</toto>') children first.
+	self assert: mic class equals: MicParagraphBlock. 
+
+]
+
+{ #category : 'tests' }
+MicRawParagraphBlockTest >> testNotASimpleRawParagraphNoSpaceInFrontToClose [
+	| children |
+	children := (parser parse: '<title> 
+No idea what it is :)
+       </title>
+
+And after we get a paragraph') children.
+	self assert: children size equals: 1. 
+	"so far we eat as much as we can and put everything in the raw"
+
+
+	self assert: children first class equals: MicRawParagraphBlock. 
+
+]
+
+{ #category : 'tests' }
+MicRawParagraphBlockTest >> testRawParagraphCannotBeNested [
+	| children |
+	children := (parser parse: '<title> 
+No idea what it is :)
+
+<button>
+hkhkjhkj
+</button>
+</title>') children.
+	self assert: children size equals: 1. 
+	self assert: children first class equals: MicRawParagraphBlock. 
+	self assert: children first label equals: 'title'.
+
+]
+
+{ #category : 'tests' }
+MicRawParagraphBlockTest >> testThereIsNoValidationIfThetagStartWithAKnowHtml [
+	| mic |
+	mic := (parser parse: '<titleunkniw> 
+No idea what it is :)
+</titleunkniw>') children first.
+	self assert: mic class equals: MicRawParagraphBlock. 
+
+]
diff --git a/src/Microdown-Tests/MicScriptBlockExtensionTest.class.st b/src/Microdown-Tests/MicScriptBlockExtensionTest.class.st
@@ -2,7 +2,7 @@ Class {
 	#name : 'MicScriptBlockExtensionTest',
 	#superclass : 'TestCase',
 	#pools : [
-		'MicMicrodownSharedPool'
+		'MicSharedPool'
 	],
 	#category : 'Microdown-Tests-Extensions',
 	#package : 'Microdown-Tests',

diff --git a/src/Microdown-Tests/MicrodownParserTest.class.st b/src/Microdown-Tests/MicrodownParserTest.class.st
@@ -5,7 +5,7 @@ Class {
 		'parser'
 	],
 	#pools : [
-		'MicMicrodownSharedPool'
+		'MicSharedPool'
 	],
 	#category : 'Microdown-Tests-Parser',
 	#package : 'Microdown-Tests',

diff --git a/src/Microdown/MicAbstractBlock.class.st b/src/Microdown/MicAbstractBlock.class.st
@@ -21,7 +21,8 @@ Class {
 { #category : 'public' }
 MicAbstractBlock class >> alternateBlockClassFor: line [
 	"This hook supports extensions of environments. 
-	we get <?slide ... and we do not create an environment but a slideBlock"
+	we get <!slide ... and we do not create an environment but a slideBlock"
+
 	^ self
 ]
 
@@ -53,7 +54,12 @@ MicAbstractBlock >> blockExtensionStarterClassFrom: line [
 
 { #category : 'public' }
 MicAbstractBlock >> blockStarterClassFrom: line [
-	"return the class of a block which can start with line, or nil if none"
+	"Return the class of a block which can start with line, or nil if none.
+	The principle is the following 
+		- first we get a class 
+		- then such class as environment are asked since they can act as factory 
+		and return other classes. 
+		For example <!citation does not return an environment but a MicCitationBlock"
 
 	^ (self parser blockStarterClassFrom: line) ifNotNil: [ :c | c alternateBlockClassFor: line ]
 ]

diff --git a/src/Microdown/MicAbstractMicrodownTextualBuilder.class.st b/src/Microdown/MicAbstractMicrodownTextualBuilder.class.st
@@ -11,7 +11,7 @@ Class {
 		'newLineCharacterString'
 	],
 	#pools : [
-		'MicMicrodownSharedPool'
+		'MicSharedPool'
 	],
 	#category : 'Microdown-Parser',
 	#package : 'Microdown',

diff --git a/src/Microdown/MicElement.class.st b/src/Microdown/MicElement.class.st
@@ -6,7 +6,7 @@ Class {
 		'properties'
 	],
 	#pools : [
-		'MicMicrodownSharedPool'
+		'MicSharedPool'
 	],
 	#category : 'Microdown-Model',
 	#package : 'Microdown',

diff --git a/src/Microdown/MicEnvironmentBlock.class.st b/src/Microdown/MicEnvironmentBlock.class.st
@@ -73,9 +73,9 @@ MicEnvironmentBlock class >> addDocumentDefinedEnvironments: aBuilder [
 { #category : 'public' }
 MicEnvironmentBlock class >> alternateBlockClassFor: line [
 
-	"If there is one subclass with the corresponding tag, returns it, else resturn the current class."
+	"If there is one subclass with the corresponding tag, returns it, else return the current class."
 	"line is of the form <!slide|title=Schedule"
-	"We know that the two first characters are <? else we would be invoked"
+	"We know that the two first characters are <! else we would not be invoked"
 
 	| tag |
 	tag := ((line allButFirst: EnvironmentOpeningBlockMarkup size) 

diff --git a/src/Microdown/MicInlineAlternativesDelimiter.class.st b/src/Microdown/MicInlineAlternativesDelimiter.class.st
@@ -9,7 +9,7 @@ Class {
 	#name : 'MicInlineAlternativesDelimiter',
 	#superclass : 'MicInlineStandardDelimiter',
 	#pools : [
-		'MicMicrodownSharedPool'
+		'MicSharedPool'
 	],
 	#category : 'Microdown-InlineParser',
 	#package : 'Microdown',

diff --git a/src/Microdown/MicInlineDelimiter.class.st b/src/Microdown/MicInlineDelimiter.class.st
@@ -14,7 +14,7 @@ Class {
 		'Regex'
 	],
 	#pools : [
-		'MicMicrodownSharedPool'
+		'MicSharedPool'
 	],
 	#category : 'Microdown-InlineParser',
 	#package : 'Microdown',

diff --git a/src/Microdown/MicInlineHttpDelimiter.class.st b/src/Microdown/MicInlineHttpDelimiter.class.st
@@ -8,7 +8,7 @@ Class {
 	#name : 'MicInlineHttpDelimiter',
 	#superclass : 'MicInlineDelimiter',
 	#pools : [
-		'MicMicrodownSharedPool'
+		'MicSharedPool'
 	],
 	#category : 'Microdown-InlineParser',
 	#package : 'Microdown',

diff --git a/src/Microdown/MicInlineParser.class.st b/src/Microdown/MicInlineParser.class.st
@@ -7,7 +7,7 @@ Class {
 	#name : 'MicInlineParser',
 	#superclass : 'Object',
 	#pools : [
-		'MicMicrodownSharedPool'
+		'MicSharedPool'
 	],
 	#category : 'Microdown-InlineParser',
 	#package : 'Microdown',

diff --git a/src/Microdown/MicInlineStandardDelimiter.class.st b/src/Microdown/MicInlineStandardDelimiter.class.st
@@ -10,7 +10,7 @@ Class {
 		'blockClass'
 	],
 	#pools : [
-		'MicMicrodownSharedPool'
+		'MicSharedPool'
 	],
 	#category : 'Microdown-InlineParser',
 	#package : 'Microdown',

diff --git a/src/Microdown/MicInlineToken.class.st b/src/Microdown/MicInlineToken.class.st
@@ -13,7 +13,7 @@ Class {
 		'string'
 	],
 	#pools : [
-		'MicMicrodownSharedPool'
+		'MicSharedPool'
 	],
 	#category : 'Microdown-InlineParser',
 	#package : 'Microdown',

diff --git a/src/Microdown/MicInlineTokenStream.class.st b/src/Microdown/MicInlineTokenStream.class.st
@@ -9,7 +9,7 @@ Class {
 		'tokens'
 	],
 	#pools : [
-		'MicMicrodownSharedPool'
+		'MicSharedPool'
 	],
 	#category : 'Microdown-InlineParser',
 	#package : 'Microdown',

diff --git a/src/Microdown/MicMailtoResourceReference.class.st b/src/Microdown/MicMailtoResourceReference.class.st
@@ -0,0 +1,12 @@
+Class {
+	#name : 'MicMailtoResourceReference',
+	#superclass : 'MicAbsoluteResourceReference',
+	#category : 'Microdown-Core',
+	#package : 'Microdown',
+	#tag : 'Core'
+}
+
+{ #category : 'instance creation' }
+MicMailtoResourceReference class >> handlesUriScheme: scheme [
+	^ scheme beginsWith: 'mailto'
+]
diff --git a/src/Microdown/MicMetaDataBlock.class.st b/src/Microdown/MicMetaDataBlock.class.st
@@ -21,9 +21,9 @@ Class {
 	#instVars : [
 		'bogusParsing'
 	],
-	#category : 'Microdown-BookRelated',
+	#category : 'Microdown-Extensions',
 	#package : 'Microdown',
-	#tag : 'BookRelated'
+	#tag : 'Extensions'
 }
 
 { #category : 'markups' }

diff --git a/src/Microdown/MicRawParagraphBlock.class.st b/src/Microdown/MicRawParagraphBlock.class.st
@@ -0,0 +1,37 @@
+Class {
+	#name : 'MicRawParagraphBlock',
+	#superclass : 'MicStartStopMarkupBlock',
+	#instVars : [
+		'label'
+	],
+	#category : 'Microdown-Extensions',
+	#package : 'Microdown',
+	#tag : 'Extensions'
+}
+
+{ #category : 'handle' }
+MicRawParagraphBlock >> bodyFromLine: line [
+
+	(self doesLineStartWithStopMarkup: line)
+		ifTrue: [ isClosed := true ]
+		ifFalse: [ body := body ifNil: [ line ] ifNotNil: [ body , String cr , line ] ]
+]
+
+{ #category : 'handle' }
+MicRawParagraphBlock >> extractFirstLineFrom: line [
+	"we cannot know in advance the markup so we have to guess and store it for closing."
+
+	label := line allButFirst copyUpToSubstring: '>'
+
+]
+
+{ #category : 'accessing' }
+MicRawParagraphBlock >> label [
+	^ label
+]
+
+{ #category : 'markups' }
+MicRawParagraphBlock >> lineStopMarkup [
+
+	^ '</', label, '>'
+]