test raw cell inclusion based on raw_format metadata

IPython/nbconvert/exporters/tests/files/rawtest.ipynb

@@ -0,0 +1,84 b''
+{
+ "metadata": {
+  "name": ""
+ },
+ "nbformat": 3,
+ "nbformat_minor": 0,
+ "worksheets": [
+  {
+   "cells": [
+    {
+     "cell_type": "raw",
+     "metadata": {
+      "raw_format": "html"
+     },
+     "source": [
+      "<b>raw html</b>"
+     ]
+    },
+    {
+     "cell_type": "raw",
+     "metadata": {
+      "raw_format": "markdown"
+     },
+     "source": [
+      "* raw markdown\n",
+      "* bullet\n",
+      "* list"
+     ]
+    },
+    {
+     "cell_type": "raw",
+     "metadata": {
+      "raw_format": "rst"
+     },
+     "source": [
+      "``raw rst``\n",
+      "\n",
+      ".. sourcecode:: python\n",
+      "\n",
+      "    def foo(): pass\n"
+     ]
+    },
+    {
+     "cell_type": "raw",
+     "metadata": {
+      "raw_format": "python"
+     },
+     "source": [
+      "def bar():\n",
+      "    \"\"\"raw python\"\"\"\n",
+      "    pass"
+     ]
+    },
+    {
+     "cell_type": "raw",
+     "metadata": {
+      "raw_format": "latex"
+     },
+     "source": [
+      "\\LaTeX\n",
+      "% raw latex"
+     ]
+    },
+    {
+     "cell_type": "raw",
+     "metadata": {},
+     "source": [
+      "# no raw_format metadata, should be included by default"
+     ]
+    },
+    {
+     "cell_type": "raw",
+     "metadata": {
+      "raw_format": "doesnotexist"
+     },
+     "source": [
+      "garbage format defined, should never be included"
+     ]
+    }
+   ],
+   "metadata": {}
+  }
+ ]
+}
  No newline at end of file

IPython/nbconvert/exporters/tests/base.py

@@ -1,30 +1,48 b''
-"""
-Module with tests base for exporters
-"""
+"""Base TestCase class for testing Exporters"""
 
 #-----------------------------------------------------------------------------
 # Copyright (c) 2013, the IPython Development Team.
 #
 # Distributed under the terms of the Modified BSD License.
 #
 # The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 
 import os
 
+from IPython.testing.decorators import onlyif_cmds_exist
+
 from ...tests.base import TestsBase
 
 #-----------------------------------------------------------------------------
 # Class
 #-----------------------------------------------------------------------------
 
+all_raw_formats = set(['markdown', 'html', 'rst', 'python', 'latex'])
+
 class ExportersTestsBase(TestsBase):
     """Contains base test functions for exporters"""
-
-    def _get_notebook(self):
-        return os.path.join(self._get_files_path(), 'notebook2.ipynb')
-                
+    
+    exporter_class = None
+    should_include_raw = None
+    
+    def _get_notebook(self, nb_name='notebook2.ipynb'):
+        return os.path.join(self._get_files_path(), nb_name)
+    
+    @onlyif_cmds_exist('pandoc')
+    def test_raw_cell_inclusion(self):
+        """test raw cell inclusion based on raw_format metadata"""
+        if self.should_include_raw is None:
+            return
+        exporter = self.exporter_class()
+        (output, resources) = exporter.from_filename(self._get_notebook('rawtest.ipynb'))
+        for inc in self.should_include_raw:
+            self.assertIn('raw %s' % inc, output, "should include %s" % inc)
+        self.assertIn('no raw_format metadata', output)
+        for exc in all_raw_formats.difference(self.should_include_raw):
+            self.assertNotIn('raw %s' % exc, output, "should exclude %s" % exc)
+        self.assertNotIn('never be included', output)

IPython/nbconvert/exporters/tests/test_html.py

@@ -1,59 +1,61 b''
-"""
-Module with tests for html.py
-"""
+"""Tests for HTMLExporter"""
 
 #-----------------------------------------------------------------------------
 # Copyright (c) 2013, the IPython Development Team.
 #
 # Distributed under the terms of the Modified BSD License.
 #
 # The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 
 from .base import ExportersTestsBase
 from ..html import HTMLExporter
 from IPython.testing.decorators import onlyif_cmds_exist
 
 #-----------------------------------------------------------------------------
 # Class
 #-----------------------------------------------------------------------------
 
 class TestHTMLExporter(ExportersTestsBase):
-    """Contains test functions for html.py"""
+    """Tests for HTMLExporter"""
+    
+    exporter_class = HTMLExporter
+    should_include_raw = ['html']
 
     def test_constructor(self):
         """
         Can a HTMLExporter be constructed?
         """
         HTMLExporter()
 
 
     @onlyif_cmds_exist('pandoc')
     def test_export(self):
         """
         Can a HTMLExporter export something?
         """
         (output, resources) = HTMLExporter().from_filename(self._get_notebook())
         assert len(output) > 0
 
 
     @onlyif_cmds_exist('pandoc')
     def test_export_basic(self):
         """
         Can a HTMLExporter export using the 'basic' template?
         """
         (output, resources) = HTMLExporter(template_file='basic').from_filename(self._get_notebook())
         assert len(output) > 0
 
 
     @onlyif_cmds_exist('pandoc')
     def test_export_full(self):
         """
         Can a HTMLExporter export using the 'full' template?
         """
         (output, resources) = HTMLExporter(template_file='full').from_filename(self._get_notebook())
         assert len(output) > 0
+

IPython/nbconvert/exporters/tests/test_latex.py

@@ -1,68 +1,71 b''
 """
 Module with tests for latex.py
 """
 
 #-----------------------------------------------------------------------------
 # Copyright (c) 2013, the IPython Development Team.
 #
 # Distributed under the terms of the Modified BSD License.
 #
 # The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 
 from .base import ExportersTestsBase
 from ..latex import LatexExporter
 from IPython.testing.decorators import onlyif_cmds_exist
 
 #-----------------------------------------------------------------------------
 # Class
 #-----------------------------------------------------------------------------
 
 class TestLatexExporter(ExportersTestsBase):
     """Contains test functions for latex.py"""
 
+    exporter_class = LatexExporter
+    should_include_raw = ['latex']
+
     def test_constructor(self):
         """
         Can a LatexExporter be constructed?
         """
         LatexExporter()
 
 
     @onlyif_cmds_exist('pandoc')
     def test_export(self):
         """
         Can a LatexExporter export something?
         """
         (output, resources) = LatexExporter().from_filename(self._get_notebook())
         assert len(output) > 0
 
 
     @onlyif_cmds_exist('pandoc')
     def test_export_book(self):
         """
         Can a LatexExporter export using 'report' template?
         """
         (output, resources) = LatexExporter(template_file='report').from_filename(self._get_notebook())
         assert len(output) > 0
 
 
     @onlyif_cmds_exist('pandoc')
     def test_export_basic(self):
         """
         Can a LatexExporter export using 'article' template?
         """
         (output, resources) = LatexExporter(template_file='article').from_filename(self._get_notebook())
         assert len(output) > 0
 
 
     @onlyif_cmds_exist('pandoc')
     def test_export_article(self):
         """
         Can a LatexExporter export using 'article' template?
         """
         (output, resources) = LatexExporter(template_file='article').from_filename(self._get_notebook())
         assert len(output) > 0
  No newline at end of file

IPython/nbconvert/exporters/tests/test_markdown.py

@@ -1,39 +1,40 b''
-"""
-Module with tests for markdown.py
-"""
+"""Tests for MarkdownExporter"""
 
 #-----------------------------------------------------------------------------
 # Copyright (c) 2013, the IPython Development Team.
 #
 # Distributed under the terms of the Modified BSD License.
 #
 # The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 
 from .base import ExportersTestsBase
 from ..markdown import MarkdownExporter
 
 #-----------------------------------------------------------------------------
 # Class
 #-----------------------------------------------------------------------------
 
 class TestMarkdownExporter(ExportersTestsBase):
-    """Contains test functions for markdown.py"""
+    """Tests for MarkdownExporter"""
+
+    exporter_class = MarkdownExporter
+    should_include_raw = ['markdown', 'html']
 
     def test_constructor(self):
         """
         Can a MarkdownExporter be constructed?
         """
         MarkdownExporter()
 
 
     def test_export(self):
         """
         Can a MarkdownExporter export something?
         """
         (output, resources) = MarkdownExporter().from_filename(self._get_notebook())
         assert len(output) > 0
  No newline at end of file

IPython/nbconvert/exporters/tests/test_python.py

@@ -1,39 +1,40 b''
-"""
-Module with tests for python.py
-"""
+"""Tests for PythonExporter"""
 
 #-----------------------------------------------------------------------------
 # Copyright (c) 2013, the IPython Development Team.
 #
 # Distributed under the terms of the Modified BSD License.
 #
 # The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 
 from .base import ExportersTestsBase
 from ..python import PythonExporter
 
 #-----------------------------------------------------------------------------
 # Class
 #-----------------------------------------------------------------------------
 
 class TestPythonExporter(ExportersTestsBase):
-    """Contains test functions for python.py"""
+    """Tests for PythonExporter"""
+
+    exporter_class = PythonExporter
+    should_include_raw = ['python']
 
     def test_constructor(self):
         """
         Can a PythonExporter be constructed?
         """
         PythonExporter()
 
 
     def test_export(self):
         """
         Can a PythonExporter export something?
         """
         (output, resources) = PythonExporter().from_filename(self._get_notebook())
         assert len(output) > 0
  No newline at end of file

IPython/nbconvert/exporters/tests/test_rst.py

@@ -1,41 +1,42 b''
-"""
-Module with tests for rst.py
-"""
+"""Tests for RSTExporter"""
 
 #-----------------------------------------------------------------------------
 # Copyright (c) 2013, the IPython Development Team.
 #
 # Distributed under the terms of the Modified BSD License.
 #
 # The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 
 from .base import ExportersTestsBase
 from ..rst import RSTExporter
 from IPython.testing.decorators import onlyif_cmds_exist
 
 #-----------------------------------------------------------------------------
 # Class
 #-----------------------------------------------------------------------------
 
 class TestRSTExporter(ExportersTestsBase):
-    """Contains test functions for rst.py"""
+    """Tests for RSTExporter"""
+
+    exporter_class = RSTExporter
+    should_include_raw = ['rst']
 
     def test_constructor(self):
         """
         Can a RSTExporter be constructed?
         """
         RSTExporter()
 
 
     @onlyif_cmds_exist('pandoc')
     def test_export(self):
         """
         Can a RSTExporter export something?
         """
         (output, resources) = RSTExporter().from_filename(self._get_notebook())
         assert len(output) > 0

IPython/nbconvert/exporters/tests/test_slides.py

@@ -1,50 +1,51 b''
-"""
-Module with tests for slides.py
-"""
+"""Tests for SlidesExporter"""
 
 #-----------------------------------------------------------------------------
 # Copyright (c) 2013, the IPython Development Team.
 #
 # Distributed under the terms of the Modified BSD License.
 #
 # The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 
 from .base import ExportersTestsBase
 from ..slides import SlidesExporter
 from IPython.testing.decorators import onlyif_cmds_exist
 
 #-----------------------------------------------------------------------------
 # Class
 #-----------------------------------------------------------------------------
 
 class TestSlidesExporter(ExportersTestsBase):
-    """Contains test functions for slides.py"""
+    """Tests for SlidesExporter"""
+
+    exporter_class = SlidesExporter
+    should_include_raw = ['html']
 
     def test_constructor(self):
         """
         Can a SlidesExporter be constructed?
         """
         SlidesExporter()
 
 
     @onlyif_cmds_exist('pandoc')
     def test_export(self):
         """
         Can a SlidesExporter export something?
         """
         (output, resources) = SlidesExporter().from_filename(self._get_notebook())
         assert len(output) > 0
 
 
     @onlyif_cmds_exist('pandoc')
     def test_export_reveal(self):
         """
         Can a SlidesExporter export using the 'reveal' template?
         """
         (output, resources) = SlidesExporter(template_file='reveal').from_filename(self._get_notebook())
         assert len(output) > 0