Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Draft: generate redirects for AWS #106

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Draft: generate redirects for AWS #106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
008cb00
Draft: generate redirects for AWS
goneall Mar 14, 2024
930d1b2
Change mk_redirects to create HTML files which redirect
goneall Mar 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions spec_parser/model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,11 +113,13 @@ def gen_all(self, dir, cfg):
from .mkdocs import gen_mkdocs
from .plantuml import gen_plantuml
from .rdf import gen_rdf
from .redirects import gen_redirects

gen_mkdocs(self, dir, cfg)
gen_rdf(self, dir, cfg)
gen_plantuml(self, dir, cfg)
gen_jsondump(self, dir, cfg)
gen_redirects(self, dir + '/redirects', cfg)



Expand Down
54 changes: 54 additions & 0 deletions spec_parser/redirects.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Creates redirects for the model references to the spec website

# SPDX-License-Identifier: Apache-2.0

import logging
from pathlib import Path


def gen_redirects(model, dir, cfg):
p = Path(dir)
if p.exists():
if not cfg.opt_force:
logging.error(f"Destination for redirects {dir} already exists, will not overwrite")
return

p.mkdir()

for ns in model.namespaces:
d = p / ns.name
d.mkdir()

''' The following does not work since it duplicates the name of the directory
f = p / ns.name

redirect = f'https://spdx.github.io/spdx-spec/v3.0/model/{ns.name}/{ns.name}/index.html'
page = gen_html_redirect(redirect)
f.write_text(page)
'''

def _generate_in_dir(dirname, group, tmplfname):
for s in group.values():
in_ns = s.ns
d = p / in_ns.name
d.mkdir(exist_ok=True)
f = d / s.name
redirect = f'https://spdx.github.io/spdx-spec/v3.0/model/{in_ns.name}/{dirname}/{s.name}/index.html'
page = gen_html_redirect(redirect)
f.write_text(page)

_generate_in_dir("Classes", model.classes, "class.md.j2")
_generate_in_dir("Properties", model.properties, "property.md.j2")
_generate_in_dir("Vocabularies", model.vocabularies, "vocabulary.md.j2")
_generate_in_dir("Individuals", model.individuals, "individual.md.j2")
_generate_in_dir("Datatypes", model.datatypes, "datatype.md.j2")

def gen_html_redirect(redirect):
retval = '<!DOCTYPE html>\n'
retval = retval + '<html lang="en">\n'
retval = retval + ' <head>\n'
retval = retval + ' <title>SPDX Model</title>\n'
retval = retval + f' <meta http-equiv="refresh" content="0; URL={redirect}">\n'
retval = retval + ' </head>\n'
retval = retval + '</html>'
return retval