-
Notifications
You must be signed in to change notification settings - Fork 642
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
44b0776
commit d72c22b
Showing
9 changed files
with
393 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,18 @@ | ||
from sqlalchemy.orm import Mapped, mapped_column | ||
from sqlalchemy.orm import Mapped, mapped_column, relationship | ||
from ..db import db | ||
|
||
class Goal(db.Model): | ||
id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) | ||
title: Mapped[str] | ||
tasks: Mapped[list["Task"]] = relationship(back_populates="goal") | ||
|
||
def to_dict(self): | ||
return { | ||
"id": self.id, | ||
"title": self.title, | ||
} | ||
|
||
@classmethod | ||
def from_dict(cls, goal_data): | ||
new_goal = cls(title=goal_data["title"]) | ||
return new_goal |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,46 @@ | ||
from sqlalchemy.orm import Mapped, mapped_column | ||
from sqlalchemy.orm import Mapped, mapped_column, relationship | ||
from ..db import db | ||
from datetime import datetime | ||
from typing import Optional | ||
from sqlalchemy import ForeignKey | ||
|
||
|
||
class Task(db.Model): | ||
id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) | ||
title: Mapped[str] | ||
description: Mapped[str] | ||
completed_at: Mapped[Optional[datetime]] | ||
goal_id: Mapped[Optional[int]] = mapped_column(ForeignKey("goal.id")) | ||
goal: Mapped[Optional["Goal"]] = relationship(back_populates="tasks") | ||
|
||
def to_dict(self): | ||
if self.completed_at: | ||
completed = True | ||
else: | ||
completed = False | ||
|
||
task_dict = { | ||
"id": self.id, | ||
"title": self.title, | ||
"description": self.description, | ||
"is_complete": completed, | ||
} | ||
|
||
if self.goal_id: | ||
task_dict["goal_id"] = self.goal_id | ||
|
||
return task_dict | ||
|
||
@classmethod | ||
def from_dict(cls, task_data): | ||
completed_at = task_data.get("completed_at") | ||
goal_id = task_data.get("goal_id") | ||
|
||
new_task = cls( | ||
title=task_data["title"], | ||
description=task_data["description"], | ||
completed_at=completed_at, | ||
goal_id=goal_id | ||
) | ||
|
||
return new_task |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,89 @@ | ||
from flask import Blueprint | ||
from flask import Blueprint, request, abort, make_response, Response | ||
from .route_utilities import validate_model | ||
from app.models.goal import Goal | ||
from app.models.task import Task | ||
from ..db import db | ||
|
||
|
||
bp = Blueprint("goals_bp", __name__, url_prefix="/goals") | ||
|
||
@bp.get("") | ||
def get_all_goals(): | ||
query = db.select(Goal) | ||
goals = db.session.scalars(query) | ||
goals_response = [goal.to_dict() for goal in goals] | ||
return goals_response | ||
|
||
|
||
@bp.get("/<goal_id>") | ||
def get_one_goal(goal_id): | ||
goal = validate_model(Goal, goal_id) | ||
return {"goal": goal.to_dict()} | ||
|
||
|
||
@bp.put("/<goal_id>") | ||
def update_goal(goal_id): | ||
goal = validate_model(Goal, goal_id) | ||
request_body = request.get_json() | ||
goal.title = request_body["title"] | ||
|
||
db.session.add(goal) | ||
db.session.commit() | ||
|
||
return {"goal": goal.to_dict()} | ||
|
||
|
||
@bp.post("") | ||
def create_goal(): | ||
request_body = request.get_json() | ||
|
||
try: | ||
new_goal = Goal.from_dict(request_body) | ||
|
||
except KeyError as error: | ||
response = {"details": f"Invalid data"} | ||
abort(make_response(response, 400)) | ||
|
||
db.session.add(new_goal) | ||
db.session.commit() | ||
|
||
return {"goal": new_goal.to_dict()}, 201 | ||
|
||
|
||
@bp.delete("/<goal_id>") | ||
def delete_goal(goal_id): | ||
goal = validate_model(Goal, goal_id) | ||
db.session.delete(goal) | ||
db.session.commit() | ||
|
||
message = f"Goal {goal_id} \"{goal.title}\" successfully deleted" | ||
return {"details": message} | ||
|
||
|
||
@bp.get("/<goal_id>/tasks") | ||
def get_tasks_from_goal(goal_id): | ||
goal = validate_model(Goal, goal_id) | ||
tasks = [task.to_dict() for task in goal.tasks] | ||
|
||
response = goal.to_dict() | ||
response["tasks"] = tasks | ||
return response | ||
|
||
|
||
@bp.post("/<goal_id>/tasks") | ||
def add_tasks_tp_goal(goal_id): | ||
goal = validate_model(Goal, goal_id) | ||
request_body = request.get_json() | ||
task_ids = request_body["task_ids"] | ||
|
||
for task_id in task_ids: | ||
task = validate_model(Task, task_id) | ||
goal.tasks.append(task) | ||
|
||
db.session.commit() | ||
|
||
response = { | ||
"id": goal.id, | ||
"task_ids": task_ids, | ||
} | ||
return response |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
from flask import abort, make_response | ||
from ..db import db | ||
|
||
def validate_model(cls, model_id): | ||
try: | ||
model_id = int(model_id) | ||
except: | ||
response = {"message": f"{cls.__name__} {model_id} invalid"} | ||
abort(make_response(response , 400)) | ||
|
||
query = db.select(cls).where(cls.id == model_id) | ||
model = db.session.scalar(query) | ||
|
||
if not model: | ||
response = {"message": f"{cls.__name__} {model_id} not found"} | ||
abort(make_response(response, 404)) | ||
|
||
return model |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Single-database configuration for Flask. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
# A generic, single database configuration. | ||
|
||
[alembic] | ||
# template used to generate migration files | ||
# file_template = %%(rev)s_%%(slug)s | ||
|
||
# set to 'true' to run the environment during | ||
# the 'revision' command, regardless of autogenerate | ||
# revision_environment = false | ||
|
||
|
||
# Logging configuration | ||
[loggers] | ||
keys = root,sqlalchemy,alembic,flask_migrate | ||
|
||
[handlers] | ||
keys = console | ||
|
||
[formatters] | ||
keys = generic | ||
|
||
[logger_root] | ||
level = WARN | ||
handlers = console | ||
qualname = | ||
|
||
[logger_sqlalchemy] | ||
level = WARN | ||
handlers = | ||
qualname = sqlalchemy.engine | ||
|
||
[logger_alembic] | ||
level = INFO | ||
handlers = | ||
qualname = alembic | ||
|
||
[logger_flask_migrate] | ||
level = INFO | ||
handlers = | ||
qualname = flask_migrate | ||
|
||
[handler_console] | ||
class = StreamHandler | ||
args = (sys.stderr,) | ||
level = NOTSET | ||
formatter = generic | ||
|
||
[formatter_generic] | ||
format = %(levelname)-5.5s [%(name)s] %(message)s | ||
datefmt = %H:%M:%S |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,113 @@ | ||
import logging | ||
from logging.config import fileConfig | ||
|
||
from flask import current_app | ||
|
||
from alembic import context | ||
|
||
# this is the Alembic Config object, which provides | ||
# access to the values within the .ini file in use. | ||
config = context.config | ||
|
||
# Interpret the config file for Python logging. | ||
# This line sets up loggers basically. | ||
fileConfig(config.config_file_name) | ||
logger = logging.getLogger('alembic.env') | ||
|
||
|
||
def get_engine(): | ||
try: | ||
# this works with Flask-SQLAlchemy<3 and Alchemical | ||
return current_app.extensions['migrate'].db.get_engine() | ||
except (TypeError, AttributeError): | ||
# this works with Flask-SQLAlchemy>=3 | ||
return current_app.extensions['migrate'].db.engine | ||
|
||
|
||
def get_engine_url(): | ||
try: | ||
return get_engine().url.render_as_string(hide_password=False).replace( | ||
'%', '%%') | ||
except AttributeError: | ||
return str(get_engine().url).replace('%', '%%') | ||
|
||
|
||
# add your model's MetaData object here | ||
# for 'autogenerate' support | ||
# from myapp import mymodel | ||
# target_metadata = mymodel.Base.metadata | ||
config.set_main_option('sqlalchemy.url', get_engine_url()) | ||
target_db = current_app.extensions['migrate'].db | ||
|
||
# other values from the config, defined by the needs of env.py, | ||
# can be acquired: | ||
# my_important_option = config.get_main_option("my_important_option") | ||
# ... etc. | ||
|
||
|
||
def get_metadata(): | ||
if hasattr(target_db, 'metadatas'): | ||
return target_db.metadatas[None] | ||
return target_db.metadata | ||
|
||
|
||
def run_migrations_offline(): | ||
"""Run migrations in 'offline' mode. | ||
This configures the context with just a URL | ||
and not an Engine, though an Engine is acceptable | ||
here as well. By skipping the Engine creation | ||
we don't even need a DBAPI to be available. | ||
Calls to context.execute() here emit the given string to the | ||
script output. | ||
""" | ||
url = config.get_main_option("sqlalchemy.url") | ||
context.configure( | ||
url=url, target_metadata=get_metadata(), literal_binds=True | ||
) | ||
|
||
with context.begin_transaction(): | ||
context.run_migrations() | ||
|
||
|
||
def run_migrations_online(): | ||
"""Run migrations in 'online' mode. | ||
In this scenario we need to create an Engine | ||
and associate a connection with the context. | ||
""" | ||
|
||
# this callback is used to prevent an auto-migration from being generated | ||
# when there are no changes to the schema | ||
# reference: http://alembic.zzzcomputing.com/en/latest/cookbook.html | ||
def process_revision_directives(context, revision, directives): | ||
if getattr(config.cmd_opts, 'autogenerate', False): | ||
script = directives[0] | ||
if script.upgrade_ops.is_empty(): | ||
directives[:] = [] | ||
logger.info('No changes in schema detected.') | ||
|
||
conf_args = current_app.extensions['migrate'].configure_args | ||
if conf_args.get("process_revision_directives") is None: | ||
conf_args["process_revision_directives"] = process_revision_directives | ||
|
||
connectable = get_engine() | ||
|
||
with connectable.connect() as connection: | ||
context.configure( | ||
connection=connection, | ||
target_metadata=get_metadata(), | ||
**conf_args | ||
) | ||
|
||
with context.begin_transaction(): | ||
context.run_migrations() | ||
|
||
|
||
if context.is_offline_mode(): | ||
run_migrations_offline() | ||
else: | ||
run_migrations_online() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
"""${message} | ||
|
||
Revision ID: ${up_revision} | ||
Revises: ${down_revision | comma,n} | ||
Create Date: ${create_date} | ||
|
||
""" | ||
from alembic import op | ||
import sqlalchemy as sa | ||
${imports if imports else ""} | ||
|
||
# revision identifiers, used by Alembic. | ||
revision = ${repr(up_revision)} | ||
down_revision = ${repr(down_revision)} | ||
branch_labels = ${repr(branch_labels)} | ||
depends_on = ${repr(depends_on)} | ||
|
||
|
||
def upgrade(): | ||
${upgrades if upgrades else "pass"} | ||
|
||
|
||
def downgrade(): | ||
${downgrades if downgrades else "pass"} |
Oops, something went wrong.