expub_compendium/web/app/schemas.py

# @name: schemas.py
# @creation_date: 2023-01-16
# @license: The MIT License <https://opensource.org/licenses/MIT>
# @author: Simon Bowie <ad7588@coventry.ac.uk>
# @purpose: Data schemas for API export
# @acknowledgements:
# https://marshmallow.readthedocs.io/en/stable/quickstart.html#next-steps
# https://stackoverflow.com/questions/59721478/serializing-sqlalchemy-with-marshmallow

from . import ma
import os
from marshmallow import Schema, fields, post_dump
from flask_marshmallow import Marshmallow

# schema for JSON transformation of User table via Marshmallow
class UserSchema(ma.Schema):
    class Meta:
        fields = ('id', 'email', 'name')
        ordered = True

# schema for JSON transformation of Resource table via Marshmallow
class ToolSchema(ma.Schema):
    class Meta:
        fields = ('id', 'name', 'description', 'developer', 'developerUrl', 'projectUrl', 'repositoryUrl', 'license', 'scriptingLanguage', 'expertiseToUse', 'expertiseToHost', 'dependencies', 'ingestFormats', 'outputFormats', 'videoUrl', 'status')
        ordered = True

class PracticeSchema(ma.Schema):
    class Meta:
        fields = ('id', 'name', 'content')
        ordered = True

    id = fields.Int(required=True)
    name = fields.Str(required=True)
    content = fields.Str(dump_only=True)  # Will store the Markdown content

    @post_dump
    def load_markdown(self, data, **kwargs):
        practice_name = data['name'].replace(" ", "_")
        # Reads the markdown content based on the name field after serialization.
        file_path = f"content/practices/{practice_name}.md"  # Adjust the path as needed
        if os.path.exists(file_path):
            with open(file_path, "r", encoding="utf-8") as file:
                data["content"] = file.read()
        else:
            data["content"] = "Markdown file not found."
        return data

class BookSchema(ma.Schema):
    class Meta:
        fields = ('id', 'name', 'description', 'author', 'year', 'bookUrl', 'videoUrl', 'isbn')
        ordered = True

# subschemas for nested fields
class DeveloperSchema(ma.Schema):
    class Meta:
        fields = ('developer', 'developerUrl')
        ordered = True