Changeset 3875

Timestamp:

05/10/09 16:02:03 (3 years ago)

Author:

MichaelTempest

Message:

Item1535: Inserted span elements when WYSIWYG_TT class is applied to other elements. Added unit tests to replicate fault.

Also updated the internal test documentation in TranslatorTest.pm. (CDot: Thanks for explaining things)

Added explicit event handlers for each type of event generated by HTML::Parser, to eliminate the empty text elements generated from the start_document and end_document events. The default event handler should never be called, now.

Location:

trunk/WysiwygPlugin

Files:

• lib/Foswiki/Plugins/WysiwygPlugin/HTML2TML.pm (modified) (2 diffs)
• lib/Foswiki/Plugins/WysiwygPlugin/HTML2TML/Node.pm (modified) (5 diffs)
• lib/Foswiki/Plugins/WysiwygPlugin/TML2HTML.pm (modified) (1 diff)
• test/unit/WysiwygPlugin/TranslatorTests.pm (modified) (3 diffs)

trunk/WysiwygPlugin/lib/Foswiki/Plugins/WysiwygPlugin/HTML2TML.pm

@@ -66 +66 @@
 
     my $this = new HTML::Parser(
-        start_h       => [ \&_openTag,  'self,tagname,attr' ],
-        end_h         => [ \&_closeTag, 'self,tagname' ],
-        declaration_h => [ \&_ignore,   'self' ],
-        default_h     => [ \&_text,     'self,text' ],
-        comment_h     => [ \&_comment,  'self,text' ]
+        start_h          => [ \&_openTag,  'self,tagname,attr' ],
+        end_h            => [ \&_closeTag, 'self,tagname' ],
+        text_h           => [ \&_text,     'self,text' ],
+        comment_h        => [ \&_comment,  'self,text' ],
+        declaration_h    => [ \&_ignore,   'self' ],
+        start_document_h => [ \&_ignore,   'self' ],
+        end_document_h   => [ \&_ignore,   'self' ],
+                default_h        => [ \&_default,  'self,event,text' ]
     );
 
@@ -220 +223 @@
 }
 
+sub _default {
+        my ( $this, $event, $text ) = @_;
+    # Unexpected $event event from HTML::Parser; text contains '$text'
+        ASSERT(0);
+}
+
 sub _apply {
     my ( $this, $tag ) = @_;

trunk/WysiwygPlugin/lib/Foswiki/Plugins/WysiwygPlugin/HTML2TML/Node.pm

@@ -363 +363 @@
 
 # Collapse adjacent VERBATIM nodes together
-# Collapse a <p> than contains only a protected span into a protected P
+# Collapse a <p> that contains only a protected span into a protected P
 # Collapse em in em
 # Collapse adjacent text nodes
@@ -444 +444 @@
 }
 
+# If this node has the specified class, insert a new "span" node with that
+# class between this node and all of this node's children.
+sub _moveClassToSpan
+{
+    my $this = shift;
+    my $class = shift;
+
+    if ( $this->{tag} and 
+         lc($this->{tag}) ne 'span' and
+         $this->_removeClass($class) ) {
+         
+        my $newspan = new Foswiki::Plugins::WysiwygPlugin::HTML2TML::Node( $this->{context}, 'span', { class => $class } );
+        my $kid = $this->{head};
+        while ($kid) {
+            $newspan->addChild($kid);
+            $kid = $kid->{next};
+        }
+        $this->{head} = $this->{tail} = $newspan;
+    }
+}
+
 # the actual generate function. rootGenerate is only applied to the root node.
 sub generate {
@@ -487 +508 @@
     $tag =~ s/!//;    # DOCTYPE
     my $tmlFn = '_handle' . uc($tag);
+
+    $this->_moveClassToSpan('WYSIWYG_TT');
 
     # See if we have a TML translation function for this tag
@@ -839 +862 @@
     while ($kid) {
         if ( $kid->{tag} eq 'th' ) {
+            $kid->_moveClassToSpan('WYSIWYG_TT');
             ( $flags, $text ) = $kid->_flatten($options);
             $text = _TDtrim($text);
@@ -844 +868 @@
         }
         elsif ( $kid->{tag} eq 'td' ) {
+            $kid->_moveClassToSpan('WYSIWYG_TT');
             ( $flags, $text ) = $kid->_flatten($options);
             $text = _TDtrim($text);

trunk/WysiwygPlugin/lib/Foswiki/Plugins/WysiwygPlugin/TML2HTML.pm

@@ -470 +470 @@
       (CGI::span({class => 'WYSIWYG_TT'}, $1))gem;
 
-    # Handle [[][] and [[]] links
+    # Handle [[][]] and [[]] links
 
     # We _not_ support [[http://link text]] syntax

trunk/WysiwygPlugin/test/unit/WysiwygPlugin/TranslatorTests.pm

@@ -39 +39 @@
 my $HTML2TML  = 1 << 1;    # test html => finaltml (default tml)
 my $ROUNDTRIP = 1 << 2;    # test tml => => finaltml
+# Note: ROUNDTRIP is *not* the same as the combination of 
+# HTML2TML and TML2HTML. The HTML and TML comparisons are both
+# somewhat "flexible". This is necessry because, for example,
+# the nature of whitespace in the TML may change.
+# ROUNDTRIP tests are intended to isolate gradual degradation 
+# of the TML, where TML -> HTML -> not quite TML -> HTML
+# -> even worse TML, ad nauseum
 
 # Bit mask for selected test types
@@ -55 +62 @@
 
 # Each testcase is a subhash with fields as follows:
-# exec => 1 to test TML -> HTML, 2 to test HTML -> TML, 3 to
-# test both, anything else to skin the test.
+# exec => $TML2HTML to test TML -> HTML, $HTML2TML to test HTML -> TML, 
+#   $ROUNDTRIP to test TML-> ->TML, all other bits are ignored.
+#   They may be OR'd togoether to perform multiple tests. 
+#   For example: $TML2HTML | $HTML2TML to test both 
+#   TML -> HTML and HTML -> TML
 # name => identifier (used to compose the testcase function name)
 # tml => source topic meta-language
-# html => expected html from expanding tml
+# html => expected html from expanding tml (not used in roundtrip tests)
 # finaltml => optional expected tml from translating html. If not there,
 # will use tml. Only use where round-trip can't be closed because
@@ -152 +162 @@
     },
     {
+        exec => $TML2HTML | $HTML2TML,
+        name => 'codeToFromHtml',
+        html => <<'BLAH',
+<p>
+<span class="WYSIWYG_TT">Code</span>
+</p>
+BLAH
+        tml  => '=Code='
+    },
+    {
         exec => $ROUNDTRIP,
         name => 'strongCode',
         html => '<b><code>Bold Code</code></b>',
         tml  => '==Bold Code=='
+    },
+    {
+        exec => $TML2HTML |  $HTML2TML,
+        name => 'bToFromHtml',
+        html => '<p><b>Bold</b></p>',
+        tml  => '*Bold*'
+    },
+    {
+        exec => $TML2HTML |  $HTML2TML,
+        name => 'strongCodeToFromHtml',
+        html => <<'BLAH',
+<p>
+<b><span class="WYSIWYG_TT">Code</span></b>
+</p>
+BLAH
+        tml  => '==Code=='
+    },
+    {
+        exec => $HTML2TML,
+        name => 'spanWithTtClassWithStrong',
+        html => <<'BLAH',
+<p>
+<span class="WYSIWYG_TT"><strong>Code</strong></span>
+</p>
+BLAH
+        tml  => '==Code=='
+    },
+    {
+        exec => $HTML2TML,
+        name => 'strongWithSpanWithTtClass',
+        html => <<'BLAH',
+<p>
+<strong><span class="WYSIWYG_TT">Code</span></strong>
+</p>
+BLAH
+        tml  => '==Code=='
+    },
+    {
+        exec => $HTML2TML,
+        name => 'strongWithTtClass',
+        html => <<'BLAH',
+<p>
+<strong class="WYSIWYG_TT">Code</strong>
+</p>
+BLAH
+        tml  => '==Code=='
+    },
+    {
+        exec => $HTML2TML,
+        name => 'bWithTtClass',
+        html => "<p>\n<b class=\"WYSIWYG_TT\">Code</b>\n</p>",
+        tml  => '==Code=='
+    },
+    {
+        exec => $HTML2TML | $ROUNDTRIP,
+        name => 'ttClassInTable',
+        html => '<table><tr><td class="WYSIWYG_TT">Code</td></tr></table>',
+        tml  => '| =Code= |'
     },
     {