# # This file is part of m.css. # # Copyright © 2017, 2018, 2019, 2020, 2021, 2022, 2023 # Vladimír Vondruš # # Permission is hereby granted, free of charge, to any person obtaining a # copy of this software and associated documentation files (the "Software"), # to deal in the Software without restriction, including without limitation # the rights to use, copy, modify, merge, publish, distribute, sublicense, # and/or sell copies of the Software, and to permit persons to whom the # Software is furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included # in all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL # THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER # DEALINGS IN THE SOFTWARE. # import os import pickle import shutil import unittest from hashlib import sha1 from . import PelicanPluginTestCase class Math(PelicanPluginTestCase): def __init__(self, *args, **kwargs): super().__init__(__file__, '', *args, **kwargs) @unittest.skipUnless(shutil.which('latex'), "The math plugin requires LaTeX installed") def test(self): self.run_pelican({ 'PLUGINS': ['m.htmlsanity', 'm.components', 'm.math'], 'M_MATH_CACHE_FILE': None }) self.assertEqual(*self.actual_expected_contents('page.html')) # No file should be generated when math caching is disabled self.assertFalse(os.path.exists(os.path.join(self.path, 'm.math.cache'))) def test_code_fallback(self): self.run_pelican({ 'PLUGINS': ['m.htmlsanity', 'm.math'], 'M_MATH_RENDER_AS_CODE': True }) self.assertEqual(*self.actual_expected_contents('page.html', 'page-code-fallback.html')) # No file should be generated when there was nothing to cache self.assertFalse(os.path.exists(os.path.join(self.path, 'm.math.cache'))) # Actually generated from $\frac{\tau}{2}$ tho tau_half_hash = sha1("""$\pi$""".encode('utf-8')).digest() tau_half = """ """ # Actually generated from $$a^3 + b^3 \neq c^3$$ tho fermat_hash = sha1("""$$a^2 + b^2 = c^2$$""".encode('utf-8')).digest() fermat = """ """ class Cached(PelicanPluginTestCase): def __init__(self, *args, **kwargs): super().__init__(__file__, 'cached', *args, **kwargs) # This is using the cache, so doesn't matter if LaTeX is found or not def test(self): cache_file = os.path.join(self.path, 'math.cache') math_cache = (0, 5, { tau_half_hash: (5, 0.344841, tau_half), fermat_hash: (5, 0.0, fermat), b'does not exist': (5, 0.0, 'something')}) with open(cache_file, 'wb') as f: pickle.dump(math_cache, f) self.run_pelican({ 'PLUGINS': ['m.htmlsanity', 'm.math'], 'M_MATH_CACHE_FILE': cache_file }) self.assertEqual(*self.actual_expected_contents('page.html')) # Expect that after the operation the global cache age is bumped, # unused entries removed and used entries age bumped as well with open(cache_file, 'rb') as f: math_cache_actual = pickle.load(f) math_cache_expected = (0, 6, { tau_half_hash: (6, 0.344841, tau_half), fermat_hash: (6, 0.0, fermat)}) self.assertEqual(math_cache_actual, math_cache_expected) class Uncached(PelicanPluginTestCase): def __init__(self, *args, **kwargs): super().__init__(__file__, 'uncached', *args, **kwargs) @unittest.skipUnless(shutil.which('latex'), "Math rendering requires LaTeX installed") def test(self): cache_file = os.path.join(self.path, 'math.cache') # Write some bullshit there, which gets immediately reset with open(cache_file, 'wb') as f: pickle.dump((1337, 0, {"something different"}), f) self.run_pelican({ 'PLUGINS': ['m.htmlsanity', 'm.math'], 'M_MATH_CACHE_FILE': cache_file }) with open(os.path.join(self.path, '../math_cached/page.html')) as f: expected_contents = f.read().strip() # The file is the same expect for titles of the formulas. Replace them # and then compare. with open(os.path.join(self.path, 'output', 'page.html')) as f: actual_contents = f.read().strip().replace('a^3 + b^3 \\neq c^3', 'a^2 + b^2 = c^2').replace('\\frac{\\tau}{2}', '\pi') self.assertEqual(actual_contents, expected_contents) # Expect that after the operation the global cache is filled with open(cache_file, 'rb') as f: math_cache_actual = pickle.load(f) math_cache_expected = (0, 0, { sha1("$\\frac{\\tau}{2}$".encode('utf-8')).digest(): (0, 0.344841, tau_half), sha1("$$a^3 + b^3 \\neq c^3$$".encode('utf-8')).digest(): (0, 0.0, fermat)}) self.assertEqual(math_cache_actual, math_cache_expected)