test_ok2/py/apigen/testing/test_apigen_example.py

# -*- coding: UTF-8 -*-
import py
html = py.xml.html
from py.__.apigen.linker import TempLinker
from py.__.apigen.htmlgen import *
from py.__.apigen.tracer.docstorage import DocStorage, DocStorageAccessor
from py.__.apigen.tracer.tracer import Tracer
from py.__.apigen.layout import LayoutPage
from py.__.apigen.project import Project
from py.__.test.web import webcheck
from py.__.apigen.conftest import option
from py.__.path.svn.testing.svntestbase import make_test_repo

def run_string_sequence_test(data, seq):
    currpos = -1
    for s in seq:
        newpos = data.find(s)
        if currpos >= newpos:
            if newpos == -1:
                message = 'not found'
            else:
                message = 'unexpected position: %s' % (newpos,)
            py.test.fail('string %r: %s' % (s, message))
        currpos = newpos

def setup_fs_project(temp):
    temp.ensure("pkg/func.py").write(py.code.Source("""\
        def func(arg1):
            "docstring"
    """))
    temp.ensure('pkg/someclass.py').write(py.code.Source("""\
        class SomeClass(object):
            " docstring someclass "
            def __init__(self, somevar):
                self.somevar = somevar
                
            def get_somevar(self):
                " get_somevar docstring "
                return self.somevar
        SomeInstance = SomeClass(10)
        class SomeHiddenClass(object):
            " docstring somehiddenclass "
            __apigen_hide_from_nav__ = True # hide it from the navigation
    """))
    temp.ensure('pkg/somesubclass.py').write(py.code.Source("""\
        from someclass import SomeClass
        class SomeSubClass(SomeClass):
            " docstring somesubclass "
            def get_somevar(self):
                return self.somevar + 1
    """))
    temp.ensure('pkg/somenamespace.py').write(py.code.Source("""\
        def foo():
            return 'bar'
        def baz(qux):
            return qux
    """))
    temp.ensure("pkg/__init__.py").write(py.code.Source("""\
        from py.initpkg import initpkg
        initpkg(__name__, exportdefs = {
            'main.sub.func': ("./func.py", "func"),
            'main.SomeClass': ('./someclass.py', 'SomeClass'),
            'main.SomeInstance': ('./someclass.py', 'SomeInstance'),
            'main.SomeSubClass': ('./somesubclass.py', 'SomeSubClass'),
            'main.SomeSubClass': ('./somesubclass.py', 'SomeSubClass'),
            'main.SomeHiddenClass': ('./someclass.py', 'SomeHiddenClass'),
            'other':             ('./somenamespace.py', '*'),
            '_test':             ('./somenamespace.py', '*'),
        })
    """))
    return temp, 'pkg'

def get_dsa(fsroot, pkgname):
    py.std.sys.path.insert(0, str(fsroot))
    pkg = __import__(pkgname)
    ds = DocStorage()
    ds.from_pkg(pkg)
    dsa = DocStorageAccessor(ds)
    return ds, dsa

def _checkhtml(htmlstring):
    if isinstance(htmlstring, unicode):
        htmlstring = htmlstring.encode('UTF-8', 'replace')
    assert isinstance(htmlstring, str)
    if option.webcheck:
        webcheck.check_html(htmlstring)
    else:
        py.test.skip("pass --webcheck to validate html produced in tests "
                     "(partial skip: the test has succeeded up until here)")

def _checkhtmlsnippet(htmlstring):
    # XXX wrap page around snippet and validate 
    pass
    #newstring = """<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
    #"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\n""" + unicode(h)
    #_checkhtml(newstring)

class LayoutTestPage(LayoutPage):
    def get_relpath(self):
        return '../'

class AbstractBuilderTest(object):
    def setup_class(cls):
        temp = py.test.ensuretemp('apigen_example')
        cls.fs_root, cls.pkg_name = setup_fs_project(temp)
        cls.ds, cls.dsa = get_dsa(cls.fs_root, cls.pkg_name)
        cls.project = Project()

    def setup_method(self, meth):
        self.base = base = py.test.ensuretemp('%s_%s' % (
                            self.__class__.__name__, meth.im_func.func_name))
        self.linker = linker = TempLinker()
        namespace_tree = create_namespace_tree(['main.sub',
                                                'main.sub.func',
                                                'main.SomeClass',
                                                'main.SomeSubClass',
                                                'main.SomeInstance',
                                                'main.SomeHiddenClass',
                                                'other.foo',
                                                'other.baz',
                                                '_test'])
        self.namespace_tree = namespace_tree
        self.apb = ApiPageBuilder(base, linker, self.dsa,
                                  self.fs_root.join(self.pkg_name),
                                  namespace_tree, self.project)
        self.spb = SourcePageBuilder(base, linker,
                                     self.fs_root.join(self.pkg_name),
                                     self.project)
        self.apb.pageclass = self.spb.pageclass = LayoutTestPage

class TestApiPageBuilder(AbstractBuilderTest):
    def test_build_callable_view(self):
        ds, dsa = get_dsa(self.fs_root, self.pkg_name)
        t = Tracer(ds)
        t.start_tracing()
        pkg = __import__(self.pkg_name)
        pkg.main.sub.func(10)
        pkg.main.sub.func(pkg.main.SomeClass(10))
        t.end_tracing()
        apb = ApiPageBuilder(self.base, self.linker, dsa, self.fs_root,
                             self.namespace_tree, self.project)
        snippet = apb.build_callable_view('main.sub.func')
        html = snippet.unicode()
        print html
        # XXX somewhat grokky tests because the order of the items may change
        assert 'arg1: AnyOf(' in html
        pos1 = html.find('arg1: AnyOf(')
        assert pos1 > -1
        pos2 = html.find('href="', pos1)
        assert pos2 > pos1
        pos3 = html.find('Class SomeClass', pos2)
        assert pos3 > pos2
        pos4 = html.find('Int&gt;', pos1)
        assert pos4 > pos1
        pos5 = html.find('return value:', pos4)
        assert pos5 > pos4 and pos5 > pos3
        pos6 = html.find('&lt;None&gt;', pos5)
        assert pos6 > pos5
        sourcefile = self.fs_root.join('pkg/func.py')
        pos7 = html.find('source: %s' % (get_rel_sourcepath(apb.projpath,
                                                            sourcefile),),
                         pos6)
        assert pos7 > pos6
        _checkhtmlsnippet(html)

    def test_build_function_pages(self):
        self.apb.build_function_pages(['main.sub.func'])
        funcfile = self.base.join('api/main.sub.func.html')
        assert funcfile.check()
        html = funcfile.read()
        _checkhtml(html)

    def test_build_class_view(self):
        snippet = self.apb.build_class_view('main.SomeClass')
        html = snippet.unicode()
        _checkhtmlsnippet(html)

    def test_build_class_pages(self):
        self.apb.build_class_pages(['main.SomeClass', 'main.SomeSubClass'])
        clsfile = self.base.join('api/main.SomeClass.html')
        assert clsfile.check()
        html = clsfile.read()
        _checkhtml(html)

    def test_build_class_pages_instance(self):
        self.apb.build_class_pages(['main.SomeClass',
                                    'main.SomeSubClass',
                                    'main.SomeInstance'])
        clsfile = self.base.join('api/main.SomeInstance.html')
        assert clsfile.check()
        html = clsfile.read()
        print html
        run_string_sequence_test(html, [
            'instance of SomeClass()',
        ])

    def test_build_class_pages_nav_links(self):
        self.apb.build_class_pages(['main.SomeSubClass',
                                    'main.SomeClass'])
        self.apb.build_namespace_pages()
        # fake some stuff that would be built from other methods
        self.linker.replace_dirpath(self.base, False)
        clsfile = self.base.join('api/main.SomeClass.html')
        assert clsfile.check()
        html = clsfile.read()
        print html
        run_string_sequence_test(html, [
            'href="../style.css"',
            'href="../apigen_style.css"',
            'src="../api.js"',
            'href="index.html">pkg',
            'href="main.html">main',
            'href="main.SomeClass.html">SomeClass',
            'href="main.SomeSubClass.html">SomeSubClass',
        ])
        assert 'href="main.sub.func.html"' not in html
        assert 'href="_test' not in html
        assert 'href="main.sub.html">sub' in html
        _checkhtml(html)

    def test_build_class_pages_base_link(self):
        self.apb.build_class_pages(['main.SomeSubClass',
                                    'main.SomeClass'])
        self.linker.replace_dirpath(self.base, False)
        clsfile = self.base.join('api/main.SomeSubClass.html')
        assert clsfile.check()
        html = clsfile.read()
        print html
        run_string_sequence_test(html, [
            'href="../style.css"',
            'href="main.SomeClass.html">main.SomeClass',
        ])
        _checkhtml(html)

    def test_source_links(self):
        self.apb.build_class_pages(['main.SomeSubClass', 'main.SomeClass'])
        self.spb.build_pages(self.fs_root)
        self.linker.replace_dirpath(self.base, False)
        funchtml = self.base.join('api/main.SomeClass.html').read()
        assert funchtml.find('href="../source/pkg/someclass.py.html"') > -1
        _checkhtml(funchtml)

    def test_build_namespace_pages(self):
        self.apb.build_namespace_pages()
        mainfile = self.base.join('api/main.html')
        assert mainfile.check()
        html = mainfile.read()
        print html
        run_string_sequence_test(html, [
            'index of main',
        ])
        otherfile = self.base.join('api/other.html')
        assert otherfile.check()
        otherhtml = otherfile.read()
        print otherhtml
        run_string_sequence_test(otherhtml, [
            'index of other',
        ])
        _checkhtml(html)
        _checkhtml(otherhtml)

    def test_build_namespace_pages_index(self):
        self.apb.build_namespace_pages()
        pkgfile = self.base.join('api/index.html')
        assert pkgfile.check()
        html = pkgfile.read()
        assert 'index of pkg' in html
        _checkhtml(html)

    def test_build_namespace_pages_subnamespace(self):
        self.apb.build_namespace_pages()
        subfile = self.base.join('api/main.sub.html')
        assert subfile.check()
        html = subfile.read()
        _checkhtml(html)

    def test_build_function_api_pages_nav(self):
        self.linker.set_link('main.sub', 'api/main.sub.html')
        self.linker.set_link('', 'api/index.html')
        self.linker.set_link('main', 'api/main.html')
        self.apb.build_function_pages(['main.sub.func'])
        self.linker.replace_dirpath(self.base, False)
        funcfile = self.base.join('api/main.sub.func.html')
        html = funcfile.read()
        print html
        run_string_sequence_test(html, [
            '<a href="index.html">',
            '<a href="main.html">',
            '<a href="main.sub.html">',
            '<a href="main.sub.func.html">',
        ])
        _checkhtml(html)

    def test_build_function_navigation(self):
        self.apb.build_namespace_pages()
        self.apb.build_function_pages(['main.sub.func'])
        self.apb.build_class_pages(['main.SomeClass',
                                    'main.SomeSubClass',
                                    'main.SomeInstance',
                                    'main.SomeHiddenClass'])
        self.linker.replace_dirpath(self.base, False)
        html = self.base.join('api/main.sub.func.html').read()
        print html
        # XXX NOTE: do not mess with the string below, the spaces between the
        # <div> and <a> are actually UTF-8 \xa0 characters (non-breaking
        # spaces)!
        assert """\
    <div class="sidebar">
      <div class="selected"><a href="index.html">pkg</a></div>
      <div class="selected">  <a href="main.html">main</a></div>
      <div>    <a href="main.SomeClass.html">SomeClass</a></div>
      <div>    <a href="main.SomeInstance.html">SomeInstance</a></div>
      <div>    <a href="main.SomeSubClass.html">SomeSubClass</a></div>
      <div class="selected">    <a href="main.sub.html">sub</a></div>
      <div class="selected">      <a href="main.sub.func.html">func</a></div>
      <div>  <a href="other.html">other</a></div></div>
""" in html

    def test_build_root_namespace_view(self):
        self.apb.build_namespace_pages()
        self.linker.replace_dirpath(self.base, False)
        rootfile = self.base.join('api/index.html')
        assert rootfile.check()
        html = rootfile.read()
        assert '<a href="main.html">' in html
        _checkhtml(html)

    def test_get_revision(self):
        py.test.skip('XXX changed implementation (temporarily?)')
        if py.std.sys.platform.startswith('win'):
            py.test.skip('broken on win32 for some reason (svn caching?), '
                         'skipping')
        # XXX a lot of setup required for this one... more like a functional
        # test I fear
        
        # create test repo and checkout
        repo = make_test_repo('test_get_revision_api_repo')
        wc = py.path.svnwc(py.test.ensuretemp('test_get_revision_api_wc'))
        wc.checkout(repo.url)
        assert wc.status().rev == '0'

        # create a temp package inside the working copy
        fs_root, pkg_name = setup_fs_project(wc)
        ds, dsa = get_dsa(self.fs_root, self.pkg_name)
        wc.commit('test get revision commit')
        wc.update()

        # clear cache
        py.__.apigen.htmlgen._get_obj_cache = {}

        # fiddle about a bit with paths so that our package is picked up :|
        old_path = py.std.sys.path
        try:
            py.std.sys.path.insert(0, fs_root.strpath)
            pkgkeys = [k for k in py.std.sys.modules.keys() if
                       k == 'pkg' or k.startswith('pkg.')]
            # remove modules from sys.modules
            for key in pkgkeys:
                del py.std.sys.modules[key]

            # now create a new apb that uses the wc pkg
            apb = ApiPageBuilder(self.base, self.linker, dsa,
                                 fs_root.join(pkg_name),
                                 self.namespace_tree, self.project)
            apb._revcache = {} # clear cache, this is on class level!!

            pkg = wc.join('pkg')
            assert pkg.check(versioned=True)
            assert pkg.info().created_rev == 1

            funcpath = pkg.join('func.py')
            classpath = pkg.join('someclass.py')
            assert funcpath.check(versioned=True)
            assert classpath.check(versioned=True)
            assert apb.get_revision('main.sub.func') == 1
            assert apb.get_revision('main.SomeClass') == 1
            assert apb.get_revision('') == 1
            assert apb.get_revision('main.sub') == 1
            funcpath.write(funcpath.read() + '\n')
            funcpath.commit('updated func')
            wc.update()
            apb._revcache = {} # clear cache
            assert apb.get_revision('main.sub.func') == 2
            assert apb.get_revision('') == 1
            assert apb.get_revision('main.SomeClass') == 1
        finally:
            py.std.sys.path = old_path
            # clear caches again
            py.__.apigen.htmlgen._get_obj_cache = {}
            apb._revcache = {}

class TestSourcePageBuilder(AbstractBuilderTest):
    def test_build_pages(self):
        self.spb.build_pages(self.fs_root)
        somesource = self.base.join('source/pkg/func.py.html').read()
        _checkhtml(somesource)

    def test_build_pages_nav(self):
        self.spb.build_pages(self.fs_root)
        self.linker.replace_dirpath(self.base, False)
        funcsource = self.base.join('source/pkg/func.py.html')
        assert funcsource.check(file=True)
        html = funcsource.read()
        print html
        run_string_sequence_test(html, [
            'href="../style.css"',
            '<a href="index.html">pkg</a>',
            '<a href="someclass.py.html">someclass.py</a>',
            '<a href="somesubclass.py.html">somesubclass.py</a>',
        ])

    def test_build_dir_page(self):
        self.spb.build_pages(self.fs_root)
        self.linker.replace_dirpath(self.base, False)
        pkgindex = self.base.join('source/pkg/index.html')
        assert pkgindex.check(file=True)
        html = pkgindex.read()
        print html
        run_string_sequence_test(html, [
            'href="../style.css"',
            '<a href="index.html">pkg</a>',
            '<a href="func.py.html">func.py</a>',
            '<a href="someclass.py.html">someclass.py</a>',
            '<a href="somesubclass.py.html">somesubclass.py</a>',
            '<h2>directories</h2>',
            '<h2>files</h2>'])
        _checkhtml(html)

    def test_build_source_page(self):
        self.spb.build_pages(self.fs_root)
        self.linker.replace_dirpath(self.base, False)
        funcsource = self.base.join('source/pkg/func.py.html')
        assert funcsource.check(file=True)
        html = funcsource.read()
        print html
        assert ('<span class="alt_keyword">def</span> func(arg1)') in html

    def test_build_navigation_root(self):
        self.spb.build_pages(self.fs_root)
        self.linker.replace_dirpath(self.base)
        html = self.base.join('source/pkg/index.html').read()
        print html
        run_string_sequence_test(html, [
            'href="index.html">pkg',
            'href="func.py.html">func.py',
            'href="someclass.py.html">someclass.py',
            'href="somesubclass.py.html">somesubclass.py',
        ])

    def test_get_revision(self):
        py.test.skip('XXX changed implementation (temporarily?)')
        if py.std.sys.platform.startswith('win'):
            py.test.skip('broken on win32 for some reason (svn caching?), '
                         'skipping')
        repo = make_test_repo('test_get_revision_source_repo')
        wc = py.path.svnwc(py.test.ensuretemp('test_get_revision_source_wc'))
        wc.checkout(repo.url)

        dir = wc.ensure('dir', dir=True)
        file = dir.ensure('file.py', file=True)
        wc.commit('added dir and file')
        wc.update()
        assert file.check(versioned=True)
        assert wc.status().rev == '1'

        assert self.spb.get_revision(dir) == 1
        assert self.spb.get_revision(file) == 1

        file.write('while 1:\n  print "py lib is cool\n"')
        file.commit('added some code')
        assert file.status().rev == '2'
        self.spb._revcache = {}
        assert self.spb.get_revision(file) == 2
        assert self.spb.get_revision(dir) == 1
-												[svn r38043] Changed the way the lazy linking is handled: instead of building the pages
and replacing the links all in memory, pages are now written to disk with
temporary hrefs, which are replaced afterwards.

--HG--
branch : trunk

											
										
										
											2007-02-07 08:24:21 +08:00
+								# -*- coding: UTF-8 -*-
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								import py
 								html = py.xml.html
-												[svn r38043] Changed the way the lazy linking is handled: instead of building the pages
and replacing the links all in memory, pages are now written to disk with
temporary hrefs, which are replaced afterwards.

--HG--
branch : trunk

											
										
										
											2007-02-07 08:24:21 +08:00
+								from py.__.apigen.linker import TempLinker
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								from py.__.apigen.htmlgen import *
 								from py.__.apigen.tracer.docstorage import DocStorage, DocStorageAccessor
 								from py.__.apigen.tracer.tracer import Tracer
-												[svn r38770] Removed option --apigen_relpath, added options --docpath and --apigenpath, both
of which are not only used for building the navigation, but also to actually
tell py.test where docs should be generated. Also cleaned up and fixed the
situation regarding relative links in the navigation menu and stylesheet/js
paths.

--HG--
branch : trunk

											
										
										
											2007-02-14 07:56:57 +08:00
+								from py.__.apigen.layout import LayoutPage
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								from py.__.apigen.project import Project
 								from py.__.test.web import webcheck
 								from py.__.apigen.conftest import option
-												[svn r38571] Using wcpath.info().created_rev (last changed revision) rather than
wcpath.status().rev (current wc rev) as revision, added revision for source and
namespace pages.

--HG--
branch : trunk

											
										
										
											2007-02-12 23:21:35 +08:00
+								from py.__.path.svn.testing.svntestbase import make_test_repo
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
 								def run_string_sequence_test(data, seq):
 								    currpos = -1
 								    for s in seq:
 								        newpos = data.find(s)
 								        if currpos >= newpos:
 								            if newpos == -1:
 								                message = 'not found'
 								            else:
 								                message = 'unexpected position: %s' % (newpos,)
 								            py.test.fail('string %r: %s' % (s, message))
 								        currpos = newpos
-												[svn r38571] Using wcpath.info().created_rev (last changed revision) rather than
wcpath.status().rev (current wc rev) as revision, added revision for source and
namespace pages.

--HG--
branch : trunk

											
										
										
											2007-02-12 23:21:35 +08:00
+								def setup_fs_project(temp):
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								    temp.ensure("pkg/func.py").write(py.code.Source("""\
 								        def func(arg1):
 								            "docstring"
 								    """))
 								    temp.ensure('pkg/someclass.py').write(py.code.Source("""\
 								        class SomeClass(object):
 								            " docstring someclass "
 								            def __init__(self, somevar):
 								                self.somevar = somevar
 								            def get_somevar(self):
 								                " get_somevar docstring "
 								                return self.somevar
 								        SomeInstance = SomeClass(10)
-												[svn r38439] Fixed a list of things suggested by hpk: changed method order in class pages,
changed page titles, added links to the api and source index from the nav bar
(also in py/doc html), changed function views, made it possible to remove an
item from the navigation, changed header 'properties' to 'class attributes and
properties', removed duplicate stack traces (in a somewhat unsatisfying way,
needs revisiting later I think).

--HG--
branch : trunk

											
										
										
											2007-02-11 10:04:36 +08:00
+								        class SomeHiddenClass(object):
 								            " docstring somehiddenclass "
 								            __apigen_hide_from_nav__ = True # hide it from the navigation
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								    """))
 								    temp.ensure('pkg/somesubclass.py').write(py.code.Source("""\
 								        from someclass import SomeClass
 								        class SomeSubClass(SomeClass):
 								            " docstring somesubclass "
 								            def get_somevar(self):
 								                return self.somevar + 1
 								    """))
 								    temp.ensure('pkg/somenamespace.py').write(py.code.Source("""\
 								        def foo():
 								            return 'bar'
 								        def baz(qux):
 								            return qux
 								    """))
 								    temp.ensure("pkg/__init__.py").write(py.code.Source("""\
 								        from py.initpkg import initpkg
 								        initpkg(__name__, exportdefs = {
 								            'main.sub.func': ("./func.py", "func"),
 								            'main.SomeClass': ('./someclass.py', 'SomeClass'),
 								            'main.SomeInstance': ('./someclass.py', 'SomeInstance'),
 								            'main.SomeSubClass': ('./somesubclass.py', 'SomeSubClass'),
 								            'main.SomeSubClass': ('./somesubclass.py', 'SomeSubClass'),
-												[svn r38439] Fixed a list of things suggested by hpk: changed method order in class pages,
changed page titles, added links to the api and source index from the nav bar
(also in py/doc html), changed function views, made it possible to remove an
item from the navigation, changed header 'properties' to 'class attributes and
properties', removed duplicate stack traces (in a somewhat unsatisfying way,
needs revisiting later I think).

--HG--
branch : trunk

											
										
										
											2007-02-11 10:04:36 +08:00
+								            'main.SomeHiddenClass': ('./someclass.py', 'SomeHiddenClass'),
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								            'other':             ('./somenamespace.py', '*'),
-												[svn r37616] All code snippets are colored now, also properly fixed hiding of _* names
in the navigation.

--HG--
branch : trunk

											
										
										
											2007-01-31 00:29:33 +08:00
+								            '_test':             ('./somenamespace.py', '*'),
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								        })
 								    """))
 								    return temp, 'pkg'
 								def get_dsa(fsroot, pkgname):
 								    py.std.sys.path.insert(0, str(fsroot))
 								    pkg = __import__(pkgname)
 								    ds = DocStorage()
 								    ds.from_pkg(pkg)
 								    dsa = DocStorageAccessor(ds)
 								    return ds, dsa
 								def _checkhtml(htmlstring):
 								    if isinstance(htmlstring, unicode):
 								        htmlstring = htmlstring.encode('UTF-8', 'replace')
 								    assert isinstance(htmlstring, str)
 								    if option.webcheck:
 								        webcheck.check_html(htmlstring)
 								    else:
 								        py.test.skip("pass --webcheck to validate html produced in tests "
 								                     "(partial skip: the test has succeeded up until here)")
 								def _checkhtmlsnippet(htmlstring):
 								    # XXX wrap page around snippet and validate
 								    pass
 								    #newstring = """<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
 								    #"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\n""" + unicode(h)
 								    #_checkhtml(newstring)
-												[svn r38770] Removed option --apigen_relpath, added options --docpath and --apigenpath, both
of which are not only used for building the navigation, but also to actually
tell py.test where docs should be generated. Also cleaned up and fixed the
situation regarding relative links in the navigation menu and stylesheet/js
paths.

--HG--
branch : trunk

											
										
										
											2007-02-14 07:56:57 +08:00
+								class LayoutTestPage(LayoutPage):
 								    def get_relpath(self):
 								        return '../'
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								class AbstractBuilderTest(object):
 								    def setup_class(cls):
-												[svn r38571] Using wcpath.info().created_rev (last changed revision) rather than
wcpath.status().rev (current wc rev) as revision, added revision for source and
namespace pages.

--HG--
branch : trunk

											
										
										
											2007-02-12 23:21:35 +08:00
+								        temp = py.test.ensuretemp('apigen_example')
 								        cls.fs_root, cls.pkg_name = setup_fs_project(temp)
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								        cls.ds, cls.dsa = get_dsa(cls.fs_root, cls.pkg_name)
 								        cls.project = Project()
 								    def setup_method(self, meth):
 								        self.base = base = py.test.ensuretemp('%s_%s' % (
 								                            self.__class__.__name__, meth.im_func.func_name))
-												[svn r38043] Changed the way the lazy linking is handled: instead of building the pages
and replacing the links all in memory, pages are now written to disk with
temporary hrefs, which are replaced afterwards.

--HG--
branch : trunk

											
										
										
											2007-02-07 08:24:21 +08:00
+								        self.linker = linker = TempLinker()
-												[svn r37395] Fixed some small issues in source nav, turned namespace_tree into an instance
var (finally! :), changed the api nav so it now shows the full tree with the
current item unfolded + siblings of itself and all parents (+ children if it's
a namespace item).

--HG--
branch : trunk

											
										
										
											2007-01-26 23:34:28 +08:00
+								        namespace_tree = create_namespace_tree(['main.sub',
 								                                                'main.sub.func',
 								                                                'main.SomeClass',
 								                                                'main.SomeSubClass',
 								                                                'main.SomeInstance',
-												[svn r38439] Fixed a list of things suggested by hpk: changed method order in class pages,
changed page titles, added links to the api and source index from the nav bar
(also in py/doc html), changed function views, made it possible to remove an
item from the navigation, changed header 'properties' to 'class attributes and
properties', removed duplicate stack traces (in a somewhat unsatisfying way,
needs revisiting later I think).

--HG--
branch : trunk

											
										
										
											2007-02-11 10:04:36 +08:00
+								                                                'main.SomeHiddenClass',
-												[svn r37395] Fixed some small issues in source nav, turned namespace_tree into an instance
var (finally! :), changed the api nav so it now shows the full tree with the
current item unfolded + siblings of itself and all parents (+ children if it's
a namespace item).

--HG--
branch : trunk

											
										
										
											2007-01-26 23:34:28 +08:00
+								                                                'other.foo',
-												[svn r38439] Fixed a list of things suggested by hpk: changed method order in class pages,
changed page titles, added links to the api and source index from the nav bar
(also in py/doc html), changed function views, made it possible to remove an
item from the navigation, changed header 'properties' to 'class attributes and
properties', removed duplicate stack traces (in a somewhat unsatisfying way,
needs revisiting later I think).

--HG--
branch : trunk

											
										
										
											2007-02-11 10:04:36 +08:00
+								                                                'other.baz',
-												[svn r37616] All code snippets are colored now, also properly fixed hiding of _* names
in the navigation.

--HG--
branch : trunk

											
										
										
											2007-01-31 00:29:33 +08:00
+								                                                '_test'])
-												[svn r37395] Fixed some small issues in source nav, turned namespace_tree into an instance
var (finally! :), changed the api nav so it now shows the full tree with the
current item unfolded + siblings of itself and all parents (+ children if it's
a namespace item).

--HG--
branch : trunk

											
										
										
											2007-01-26 23:34:28 +08:00
+								        self.namespace_tree = namespace_tree
 								        self.apb = ApiPageBuilder(base, linker, self.dsa,
 								                                  self.fs_root.join(self.pkg_name),
-												[svn r38043] Changed the way the lazy linking is handled: instead of building the pages
and replacing the links all in memory, pages are now written to disk with
temporary hrefs, which are replaced afterwards.

--HG--
branch : trunk

											
										
										
											2007-02-07 08:24:21 +08:00
+								                                  namespace_tree, self.project)
-												[svn r37395] Fixed some small issues in source nav, turned namespace_tree into an instance
var (finally! :), changed the api nav so it now shows the full tree with the
current item unfolded + siblings of itself and all parents (+ children if it's
a namespace item).

--HG--
branch : trunk

											
										
										
											2007-01-26 23:34:28 +08:00
+								        self.spb = SourcePageBuilder(base, linker,
-												[svn r38043] Changed the way the lazy linking is handled: instead of building the pages
and replacing the links all in memory, pages are now written to disk with
temporary hrefs, which are replaced afterwards.

--HG--
branch : trunk

											
										
										
											2007-02-07 08:24:21 +08:00
+								                                     self.fs_root.join(self.pkg_name),
 								                                     self.project)
-												[svn r38770] Removed option --apigen_relpath, added options --docpath and --apigenpath, both
of which are not only used for building the navigation, but also to actually
tell py.test where docs should be generated. Also cleaned up and fixed the
situation regarding relative links in the navigation menu and stylesheet/js
paths.

--HG--
branch : trunk

											
										
										
											2007-02-14 07:56:57 +08:00
+								        self.apb.pageclass = self.spb.pageclass = LayoutTestPage
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
 								class TestApiPageBuilder(AbstractBuilderTest):
 								    def test_build_callable_view(self):
 								        ds, dsa = get_dsa(self.fs_root, self.pkg_name)
 								        t = Tracer(ds)
 								        t.start_tracing()
 								        pkg = __import__(self.pkg_name)
 								        pkg.main.sub.func(10)
 								        pkg.main.sub.func(pkg.main.SomeClass(10))
 								        t.end_tracing()
-												[svn r37395] Fixed some small issues in source nav, turned namespace_tree into an instance
var (finally! :), changed the api nav so it now shows the full tree with the
current item unfolded + siblings of itself and all parents (+ children if it's
a namespace item).

--HG--
branch : trunk

											
										
										
											2007-01-26 23:34:28 +08:00
+								        apb = ApiPageBuilder(self.base, self.linker, dsa, self.fs_root,
-												[svn r38150] Fixed test that failed after the last change in apigen (removing the stacks
from the callable info boxes).

--HG--
branch : trunk

											
										
										
											2007-02-08 23:14:21 +08:00
+								                             self.namespace_tree, self.project)
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								        snippet = apb.build_callable_view('main.sub.func')
 								        html = snippet.unicode()
 								        print html
-												[svn r37297] Fixed dependency on order in the function argument formatting tests.

--HG--
branch : trunk

											
										
										
											2007-01-25 05:04:18 +08:00
+								        # XXX somewhat grokky tests because the order of the items may change
 								        assert 'arg1: AnyOf(' in html
 								        pos1 = html.find('arg1: AnyOf(')
 								        assert pos1 > -1
 								        pos2 = html.find('href="', pos1)
 								        assert pos2 > pos1
 								        pos3 = html.find('Class SomeClass', pos2)
 								        assert pos3 > pos2
 								        pos4 = html.find('Int&gt;', pos1)
 								        assert pos4 > pos1
 								        pos5 = html.find('return value:', pos4)
 								        assert pos5 > pos4 and pos5 > pos3
 								        pos6 = html.find('&lt;None&gt;', pos5)
 								        assert pos6 > pos5
-												[svn r38393] Made (displayed) paths to source files relative whenever possible.

--HG--
branch : trunk

											
										
										
											2007-02-10 23:19:17 +08:00
+								        sourcefile = self.fs_root.join('pkg/func.py')
 								        pos7 = html.find('source: %s' % (get_rel_sourcepath(apb.projpath,
 								                                                            sourcefile),),
 								                         pos6)
-												[svn r37297] Fixed dependency on order in the function argument formatting tests.

--HG--
branch : trunk

											
										
										
											2007-01-25 05:04:18 +08:00
+								        assert pos7 > pos6
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								        _checkhtmlsnippet(html)
 								    def test_build_function_pages(self):
-												[svn r38043] Changed the way the lazy linking is handled: instead of building the pages
and replacing the links all in memory, pages are now written to disk with
temporary hrefs, which are replaced afterwards.

--HG--
branch : trunk

											
										
										
											2007-02-07 08:24:21 +08:00
+								        self.apb.build_function_pages(['main.sub.func'])
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								        funcfile = self.base.join('api/main.sub.func.html')
 								        assert funcfile.check()
 								        html = funcfile.read()
 								        _checkhtml(html)
 								    def test_build_class_view(self):
 								        snippet = self.apb.build_class_view('main.SomeClass')
 								        html = snippet.unicode()
 								        _checkhtmlsnippet(html)
 								    def test_build_class_pages(self):
-												[svn r38043] Changed the way the lazy linking is handled: instead of building the pages
and replacing the links all in memory, pages are now written to disk with
temporary hrefs, which are replaced afterwards.

--HG--
branch : trunk

											
										
										
											2007-02-07 08:24:21 +08:00
+								        self.apb.build_class_pages(['main.SomeClass', 'main.SomeSubClass'])
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								        clsfile = self.base.join('api/main.SomeClass.html')
 								        assert clsfile.check()
 								        html = clsfile.read()
 								        _checkhtml(html)
 								    def test_build_class_pages_instance(self):
-												[svn r38043] Changed the way the lazy linking is handled: instead of building the pages
and replacing the links all in memory, pages are now written to disk with
temporary hrefs, which are replaced afterwards.

--HG--
branch : trunk

											
										
										
											2007-02-07 08:24:21 +08:00
+								        self.apb.build_class_pages(['main.SomeClass',
 								                                    'main.SomeSubClass',
 								                                    'main.SomeInstance'])
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								        clsfile = self.base.join('api/main.SomeInstance.html')
 								        assert clsfile.check()
 								        html = clsfile.read()
 								        print html
 								        run_string_sequence_test(html, [
 								            'instance of SomeClass()',
 								        ])
 								    def test_build_class_pages_nav_links(self):
-												[svn r38043] Changed the way the lazy linking is handled: instead of building the pages
and replacing the links all in memory, pages are now written to disk with
temporary hrefs, which are replaced afterwards.

--HG--
branch : trunk

											
										
										
											2007-02-07 08:24:21 +08:00
+								        self.apb.build_class_pages(['main.SomeSubClass',
 								                                    'main.SomeClass'])
 								        self.apb.build_namespace_pages()
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								        # fake some stuff that would be built from other methods
-												[svn r38043] Changed the way the lazy linking is handled: instead of building the pages
and replacing the links all in memory, pages are now written to disk with
temporary hrefs, which are replaced afterwards.

--HG--
branch : trunk

											
										
										
											2007-02-07 08:24:21 +08:00
+								        self.linker.replace_dirpath(self.base, False)
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								        clsfile = self.base.join('api/main.SomeClass.html')
 								        assert clsfile.check()
 								        html = clsfile.read()
 								        print html
 								        run_string_sequence_test(html, [
 								            'href="../style.css"',
-												[svn r37812] Using style.css from the doc directory for apigen now, with some overrides in
a seperate stylesheet. Cleaned up the stylesheet and script handling a bit:
stylesheets and scripts are now defined in the LayoutPage class (where they're
easily customizable). Also removed some old unused code and moved the H class
(html related) stuff to its own file. The idea is that this will become the
place where all the layout is defined.

--HG--
branch : trunk

											
										
										
											2007-02-02 23:49:58 +08:00
+								            'href="../apigen_style.css"',
-												[svn r37305] Added some JavaScript to show and hide function information (source and such).

--HG--
branch : trunk

											
										
										
											2007-01-25 05:58:21 +08:00
+								            'src="../api.js"',
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								            'href="index.html">pkg',
 								            'href="main.html">main',
 								            'href="main.SomeClass.html">SomeClass',
 								            'href="main.SomeSubClass.html">SomeSubClass',
 								        ])
-												[svn r37616] All code snippets are colored now, also properly fixed hiding of _* names
in the navigation.

--HG--
branch : trunk

											
										
										
											2007-01-31 00:29:33 +08:00
+								        assert 'href="main.sub.func.html"' not in html
 								        assert 'href="_test' not in html
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								        assert 'href="main.sub.html">sub' in html
 								        _checkhtml(html)
 								    def test_build_class_pages_base_link(self):
-												[svn r38043] Changed the way the lazy linking is handled: instead of building the pages
and replacing the links all in memory, pages are now written to disk with
temporary hrefs, which are replaced afterwards.

--HG--
branch : trunk

											
										
										
											2007-02-07 08:24:21 +08:00
+								        self.apb.build_class_pages(['main.SomeSubClass',
 								                                    'main.SomeClass'])
 								        self.linker.replace_dirpath(self.base, False)
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								        clsfile = self.base.join('api/main.SomeSubClass.html')
 								        assert clsfile.check()
 								        html = clsfile.read()
 								        print html
 								        run_string_sequence_test(html, [
 								            'href="../style.css"',
 								            'href="main.SomeClass.html">main.SomeClass',
 								        ])
 								        _checkhtml(html)
 								    def test_source_links(self):
-												[svn r38043] Changed the way the lazy linking is handled: instead of building the pages
and replacing the links all in memory, pages are now written to disk with
temporary hrefs, which are replaced afterwards.

--HG--
branch : trunk

											
										
										
											2007-02-07 08:24:21 +08:00
+								        self.apb.build_class_pages(['main.SomeSubClass', 'main.SomeClass'])
 								        self.spb.build_pages(self.fs_root)
 								        self.linker.replace_dirpath(self.base, False)
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								        funchtml = self.base.join('api/main.SomeClass.html').read()
 								        assert funchtml.find('href="../source/pkg/someclass.py.html"') > -1
 								        _checkhtml(funchtml)
 								    def test_build_namespace_pages(self):
-												[svn r38043] Changed the way the lazy linking is handled: instead of building the pages
and replacing the links all in memory, pages are now written to disk with
temporary hrefs, which are replaced afterwards.

--HG--
branch : trunk

											
										
										
											2007-02-07 08:24:21 +08:00
+								        self.apb.build_namespace_pages()
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								        mainfile = self.base.join('api/main.html')
 								        assert mainfile.check()
 								        html = mainfile.read()
 								        print html
 								        run_string_sequence_test(html, [
-												[svn r38571] Using wcpath.info().created_rev (last changed revision) rather than
wcpath.status().rev (current wc rev) as revision, added revision for source and
namespace pages.

--HG--
branch : trunk

											
										
										
											2007-02-12 23:21:35 +08:00
+								            'index of main',
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								        ])
 								        otherfile = self.base.join('api/other.html')
 								        assert otherfile.check()
 								        otherhtml = otherfile.read()
 								        print otherhtml
 								        run_string_sequence_test(otherhtml, [
-												[svn r38571] Using wcpath.info().created_rev (last changed revision) rather than
wcpath.status().rev (current wc rev) as revision, added revision for source and
namespace pages.

--HG--
branch : trunk

											
										
										
											2007-02-12 23:21:35 +08:00
+								            'index of other',
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								        ])
 								        _checkhtml(html)
 								        _checkhtml(otherhtml)
 								    def test_build_namespace_pages_index(self):
-												[svn r38043] Changed the way the lazy linking is handled: instead of building the pages
and replacing the links all in memory, pages are now written to disk with
temporary hrefs, which are replaced afterwards.

--HG--
branch : trunk

											
										
										
											2007-02-07 08:24:21 +08:00
+								        self.apb.build_namespace_pages()
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								        pkgfile = self.base.join('api/index.html')
 								        assert pkgfile.check()
 								        html = pkgfile.read()
-												[svn r38571] Using wcpath.info().created_rev (last changed revision) rather than
wcpath.status().rev (current wc rev) as revision, added revision for source and
namespace pages.

--HG--
branch : trunk

											
										
										
											2007-02-12 23:21:35 +08:00
+								        assert 'index of pkg' in html
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								        _checkhtml(html)
 								    def test_build_namespace_pages_subnamespace(self):
-												[svn r38043] Changed the way the lazy linking is handled: instead of building the pages
and replacing the links all in memory, pages are now written to disk with
temporary hrefs, which are replaced afterwards.

--HG--
branch : trunk

											
										
										
											2007-02-07 08:24:21 +08:00
+								        self.apb.build_namespace_pages()
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								        subfile = self.base.join('api/main.sub.html')
 								        assert subfile.check()
 								        html = subfile.read()
 								        _checkhtml(html)
 								    def test_build_function_api_pages_nav(self):
-												[svn r38043] Changed the way the lazy linking is handled: instead of building the pages
and replacing the links all in memory, pages are now written to disk with
temporary hrefs, which are replaced afterwards.

--HG--
branch : trunk

											
										
										
											2007-02-07 08:24:21 +08:00
+								        self.linker.set_link('main.sub', 'api/main.sub.html')
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								        self.linker.set_link('', 'api/index.html')
 								        self.linker.set_link('main', 'api/main.html')
-												[svn r38043] Changed the way the lazy linking is handled: instead of building the pages
and replacing the links all in memory, pages are now written to disk with
temporary hrefs, which are replaced afterwards.

--HG--
branch : trunk

											
										
										
											2007-02-07 08:24:21 +08:00
+								        self.apb.build_function_pages(['main.sub.func'])
 								        self.linker.replace_dirpath(self.base, False)
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								        funcfile = self.base.join('api/main.sub.func.html')
 								        html = funcfile.read()
 								        print html
 								        run_string_sequence_test(html, [
 								            '<a href="index.html">',
 								            '<a href="main.html">',
 								            '<a href="main.sub.html">',
 								            '<a href="main.sub.func.html">',
 								        ])
 								        _checkhtml(html)
 								    def test_build_function_navigation(self):
-												[svn r38043] Changed the way the lazy linking is handled: instead of building the pages
and replacing the links all in memory, pages are now written to disk with
temporary hrefs, which are replaced afterwards.

--HG--
branch : trunk

											
										
										
											2007-02-07 08:24:21 +08:00
+								        self.apb.build_namespace_pages()
 								        self.apb.build_function_pages(['main.sub.func'])
 								        self.apb.build_class_pages(['main.SomeClass',
 								                                    'main.SomeSubClass',
-												[svn r38439] Fixed a list of things suggested by hpk: changed method order in class pages,
changed page titles, added links to the api and source index from the nav bar
(also in py/doc html), changed function views, made it possible to remove an
item from the navigation, changed header 'properties' to 'class attributes and
properties', removed duplicate stack traces (in a somewhat unsatisfying way,
needs revisiting later I think).

--HG--
branch : trunk

											
										
										
											2007-02-11 10:04:36 +08:00
+								                                    'main.SomeInstance',
 								                                    'main.SomeHiddenClass'])
-												[svn r38043] Changed the way the lazy linking is handled: instead of building the pages
and replacing the links all in memory, pages are now written to disk with
temporary hrefs, which are replaced afterwards.

--HG--
branch : trunk

											
										
										
											2007-02-07 08:24:21 +08:00
+								        self.linker.replace_dirpath(self.base, False)
 								        html = self.base.join('api/main.sub.func.html').read()
 								        print html
 								        # XXX NOTE: do not mess with the string below, the spaces between the
 								        # <div> and <a> are actually UTF-8 \xa0 characters (non-breaking
 								        # spaces)!
 								        assert """\
 								    <div class="sidebar">
 								      <div class="selected"><a href="index.html">pkg</a></div>
 								      <div class="selected">  <a href="main.html">main</a></div>
 								      <div>    <a href="main.SomeClass.html">SomeClass</a></div>
 								      <div>    <a href="main.SomeInstance.html">SomeInstance</a></div>
 								      <div>    <a href="main.SomeSubClass.html">SomeSubClass</a></div>
 								      <div class="selected">    <a href="main.sub.html">sub</a></div>
 								      <div class="selected">      <a href="main.sub.func.html">func</a></div>
 								      <div>  <a href="other.html">other</a></div></div>
 								""" in html
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
 								    def test_build_root_namespace_view(self):
-												[svn r38043] Changed the way the lazy linking is handled: instead of building the pages
and replacing the links all in memory, pages are now written to disk with
temporary hrefs, which are replaced afterwards.

--HG--
branch : trunk

											
										
										
											2007-02-07 08:24:21 +08:00
+								        self.apb.build_namespace_pages()
 								        self.linker.replace_dirpath(self.base, False)
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								        rootfile = self.base.join('api/index.html')
 								        assert rootfile.check()
 								        html = rootfile.read()
 								        assert '<a href="main.html">' in html
 								        _checkhtml(html)
-												[svn r38571] Using wcpath.info().created_rev (last changed revision) rather than
wcpath.status().rev (current wc rev) as revision, added revision for source and
namespace pages.

--HG--
branch : trunk

											
										
										
											2007-02-12 23:21:35 +08:00
+								    def test_get_revision(self):
-												[svn r38779] Made that the package revision is now shown in the title rather than each
file's individual revision.

--HG--
branch : trunk

											
										
										
											2007-02-14 10:03:51 +08:00
+								        py.test.skip('XXX changed implementation (temporarily?)')
-												[svn r38653] Skipping some tests on win32, for some reason svnwc.info().created_rev seems
to fail (need to look into it in more detail later).

--HG--
branch : trunk

											
										
										
											2007-02-13 09:11:30 +08:00
+								        if py.std.sys.platform.startswith('win'):
 								            py.test.skip('broken on win32 for some reason (svn caching?), '
 								                         'skipping')
-												[svn r38571] Using wcpath.info().created_rev (last changed revision) rather than
wcpath.status().rev (current wc rev) as revision, added revision for source and
namespace pages.

--HG--
branch : trunk

											
										
										
											2007-02-12 23:21:35 +08:00
+								        # XXX a lot of setup required for this one... more like a functional
 								        # test I fear
 								        # create test repo and checkout
 								        repo = make_test_repo('test_get_revision_api_repo')
 								        wc = py.path.svnwc(py.test.ensuretemp('test_get_revision_api_wc'))
 								        wc.checkout(repo.url)
 								        assert wc.status().rev == '0'
 								        # create a temp package inside the working copy
 								        fs_root, pkg_name = setup_fs_project(wc)
 								        ds, dsa = get_dsa(self.fs_root, self.pkg_name)
 								        wc.commit('test get revision commit')
 								        wc.update()
 								        # clear cache
 								        py.__.apigen.htmlgen._get_obj_cache = {}
 								        # fiddle about a bit with paths so that our package is picked up :|
 								        old_path = py.std.sys.path
 								        try:
 								            py.std.sys.path.insert(0, fs_root.strpath)
 								            pkgkeys = [k for k in py.std.sys.modules.keys() if
 								                       k == 'pkg' or k.startswith('pkg.')]
 								            # remove modules from sys.modules
 								            for key in pkgkeys:
 								                del py.std.sys.modules[key]
 								            # now create a new apb that uses the wc pkg
 								            apb = ApiPageBuilder(self.base, self.linker, dsa,
 								                                 fs_root.join(pkg_name),
 								                                 self.namespace_tree, self.project)
 								            apb._revcache = {} # clear cache, this is on class level!!
 								            pkg = wc.join('pkg')
 								            assert pkg.check(versioned=True)
 								            assert pkg.info().created_rev == 1
 								            funcpath = pkg.join('func.py')
 								            classpath = pkg.join('someclass.py')
 								            assert funcpath.check(versioned=True)
 								            assert classpath.check(versioned=True)
 								            assert apb.get_revision('main.sub.func') == 1
 								            assert apb.get_revision('main.SomeClass') == 1
 								            assert apb.get_revision('') == 1
 								            assert apb.get_revision('main.sub') == 1
 								            funcpath.write(funcpath.read() + '\n')
 								            funcpath.commit('updated func')
 								            wc.update()
 								            apb._revcache = {} # clear cache
 								            assert apb.get_revision('main.sub.func') == 2
 								            assert apb.get_revision('') == 1
 								            assert apb.get_revision('main.SomeClass') == 1
 								        finally:
 								            py.std.sys.path = old_path
 								            # clear caches again
 								            py.__.apigen.htmlgen._get_obj_cache = {}
 								            apb._revcache = {}
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								class TestSourcePageBuilder(AbstractBuilderTest):
 								    def test_build_pages(self):
-												[svn r38043] Changed the way the lazy linking is handled: instead of building the pages
and replacing the links all in memory, pages are now written to disk with
temporary hrefs, which are replaced afterwards.

--HG--
branch : trunk

											
										
										
											2007-02-07 08:24:21 +08:00
+								        self.spb.build_pages(self.fs_root)
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								        somesource = self.base.join('source/pkg/func.py.html').read()
 								        _checkhtml(somesource)
 								    def test_build_pages_nav(self):
-												[svn r38043] Changed the way the lazy linking is handled: instead of building the pages
and replacing the links all in memory, pages are now written to disk with
temporary hrefs, which are replaced afterwards.

--HG--
branch : trunk

											
										
										
											2007-02-07 08:24:21 +08:00
+								        self.spb.build_pages(self.fs_root)
 								        self.linker.replace_dirpath(self.base, False)
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								        funcsource = self.base.join('source/pkg/func.py.html')
 								        assert funcsource.check(file=True)
 								        html = funcsource.read()
 								        print html
 								        run_string_sequence_test(html, [
-												[svn r38770] Removed option --apigen_relpath, added options --docpath and --apigenpath, both
of which are not only used for building the navigation, but also to actually
tell py.test where docs should be generated. Also cleaned up and fixed the
situation regarding relative links in the navigation menu and stylesheet/js
paths.

--HG--
branch : trunk

											
										
										
											2007-02-14 07:56:57 +08:00
+								            'href="../style.css"',
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								            '<a href="index.html">pkg</a>',
 								            '<a href="someclass.py.html">someclass.py</a>',
 								            '<a href="somesubclass.py.html">somesubclass.py</a>',
 								        ])
 								    def test_build_dir_page(self):
-												[svn r38043] Changed the way the lazy linking is handled: instead of building the pages
and replacing the links all in memory, pages are now written to disk with
temporary hrefs, which are replaced afterwards.

--HG--
branch : trunk

											
										
										
											2007-02-07 08:24:21 +08:00
+								        self.spb.build_pages(self.fs_root)
 								        self.linker.replace_dirpath(self.base, False)
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								        pkgindex = self.base.join('source/pkg/index.html')
 								        assert pkgindex.check(file=True)
 								        html = pkgindex.read()
 								        print html
 								        run_string_sequence_test(html, [
-												[svn r38770] Removed option --apigen_relpath, added options --docpath and --apigenpath, both
of which are not only used for building the navigation, but also to actually
tell py.test where docs should be generated. Also cleaned up and fixed the
situation regarding relative links in the navigation menu and stylesheet/js
paths.

--HG--
branch : trunk

											
										
										
											2007-02-14 07:56:57 +08:00
+								            'href="../style.css"',
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								            '<a href="index.html">pkg</a>',
 								            '<a href="func.py.html">func.py</a>',
 								            '<a href="someclass.py.html">someclass.py</a>',
 								            '<a href="somesubclass.py.html">somesubclass.py</a>',
 								            '<h2>directories</h2>',
 								            '<h2>files</h2>'])
 								        _checkhtml(html)
-												[svn r37837] A bit of cleanup of the HTML generation: some of the layout related stuff is
moved to the classes in the H namespace. This hopefully (when done, more can
definitely be done later) seperates the HTML generation better from the
presentation-related code.

--HG--
branch : trunk

											
										
										
											2007-02-03 07:29:01 +08:00
+								    def test_build_source_page(self):
-												[svn r38043] Changed the way the lazy linking is handled: instead of building the pages
and replacing the links all in memory, pages are now written to disk with
temporary hrefs, which are replaced afterwards.

--HG--
branch : trunk

											
										
										
											2007-02-07 08:24:21 +08:00
+								        self.spb.build_pages(self.fs_root)
 								        self.linker.replace_dirpath(self.base, False)
-												[svn r37837] A bit of cleanup of the HTML generation: some of the layout related stuff is
moved to the classes in the H namespace. This hopefully (when done, more can
definitely be done later) seperates the HTML generation better from the
presentation-related code.

--HG--
branch : trunk

											
										
										
											2007-02-03 07:29:01 +08:00
+								        funcsource = self.base.join('source/pkg/func.py.html')
 								        assert funcsource.check(file=True)
 								        html = funcsource.read()
 								        print html
-												[svn r37913] Some more cleanups in HTML generation, fixed support for docstrings in
namespaces, in order to do this I had to change the way objects are retrieved:
instead of getting them from the DSA I now walk the package tree, small change
in apigen.py: to allow re-using the get_documentable_items function I split it
up in a generic and a specific part.

--HG--
branch : trunk

											
										
										
											2007-02-04 22:35:28 +08:00
+								        assert ('<span class="alt_keyword">def</span> func(arg1)') in html
-												[svn r37837] A bit of cleanup of the HTML generation: some of the layout related stuff is
moved to the classes in the H namespace. This hopefully (when done, more can
definitely be done later) seperates the HTML generation better from the
presentation-related code.

--HG--
branch : trunk

											
										
										
											2007-02-03 07:29:01 +08:00
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								    def test_build_navigation_root(self):
-												[svn r38043] Changed the way the lazy linking is handled: instead of building the pages
and replacing the links all in memory, pages are now written to disk with
temporary hrefs, which are replaced afterwards.

--HG--
branch : trunk

											
										
										
											2007-02-07 08:24:21 +08:00
+								        self.spb.build_pages(self.fs_root)
 								        self.linker.replace_dirpath(self.base)
 								        html = self.base.join('source/pkg/index.html').read()
 								        print html
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								        run_string_sequence_test(html, [
-												[svn r38043] Changed the way the lazy linking is handled: instead of building the pages
and replacing the links all in memory, pages are now written to disk with
temporary hrefs, which are replaced afterwards.

--HG--
branch : trunk

											
										
										
											2007-02-07 08:24:21 +08:00
+								            'href="index.html">pkg',
 								            'href="func.py.html">func.py',
 								            'href="someclass.py.html">someclass.py',
 								            'href="somesubclass.py.html">somesubclass.py',
-												[svn r37264] create the new development trunk

--HG--
branch : trunk

											
										
										
											2007-01-24 22:24:01 +08:00
+								        ])
-												[svn r38571] Using wcpath.info().created_rev (last changed revision) rather than
wcpath.status().rev (current wc rev) as revision, added revision for source and
namespace pages.

--HG--
branch : trunk

											
										
										
											2007-02-12 23:21:35 +08:00
+								    def test_get_revision(self):
-												[svn r38779] Made that the package revision is now shown in the title rather than each
file's individual revision.

--HG--
branch : trunk

											
										
										
											2007-02-14 10:03:51 +08:00
+								        py.test.skip('XXX changed implementation (temporarily?)')
-												[svn r38653] Skipping some tests on win32, for some reason svnwc.info().created_rev seems
to fail (need to look into it in more detail later).

--HG--
branch : trunk

											
										
										
											2007-02-13 09:11:30 +08:00
+								        if py.std.sys.platform.startswith('win'):
 								            py.test.skip('broken on win32 for some reason (svn caching?), '
 								                         'skipping')
-												[svn r38571] Using wcpath.info().created_rev (last changed revision) rather than
wcpath.status().rev (current wc rev) as revision, added revision for source and
namespace pages.

--HG--
branch : trunk

											
										
										
											2007-02-12 23:21:35 +08:00
+								        repo = make_test_repo('test_get_revision_source_repo')
 								        wc = py.path.svnwc(py.test.ensuretemp('test_get_revision_source_wc'))
 								        wc.checkout(repo.url)
 								        dir = wc.ensure('dir', dir=True)
 								        file = dir.ensure('file.py', file=True)
 								        wc.commit('added dir and file')
 								        wc.update()
 								        assert file.check(versioned=True)
 								        assert wc.status().rev == '1'
 								        assert self.spb.get_revision(dir) == 1
 								        assert self.spb.get_revision(file) == 1
 								        file.write('while 1:\n  print "py lib is cool\n"')
 								        file.commit('added some code')
 								        assert file.status().rev == '2'
 								        self.spb._revcache = {}
 								        assert self.spb.get_revision(file) == 2
 								        assert self.spb.get_revision(dir) == 1