feat: Query Filter Builder for Cookbooks and Meal Plans

alembic/versions/2024-10-08-21.17.31_86054b40fd06_added_query_filter_string_to_cookbook_.py

@@ -0,0 +1,188 @@
+"""added query_filter_string to cookbook and mealplan
+
+Revision ID: 86054b40fd06
+Revises: 602927e1013e
+Create Date: 2024-10-08 21:17:31.601903
+
+"""
+
+import sqlalchemy as sa
+from sqlalchemy import orm
+
+from alembic import op
+from mealie.db.models._model_utils import guid
+
+# revision identifiers, used by Alembic.
+revision = "86054b40fd06"
+down_revision: str | None = "602927e1013e"
+branch_labels: str | tuple[str, ...] | None = None
+depends_on: str | tuple[str, ...] | None = None
+
+
+# Intermediate table definitions
+class SqlAlchemyBase(orm.DeclarativeBase):
+    pass
+
+
+class Category(SqlAlchemyBase):
+    __tablename__ = "categories"
+    id: orm.Mapped[guid.GUID] = orm.mapped_column(guid.GUID, primary_key=True, default=guid.GUID.generate)
+
+
+class Tag(SqlAlchemyBase):
+    __tablename__ = "tags"
+    id: orm.Mapped[guid.GUID] = orm.mapped_column(guid.GUID, primary_key=True, default=guid.GUID.generate)
+
+
+class Tool(SqlAlchemyBase):
+    __tablename__ = "tools"
+    id: orm.Mapped[guid.GUID] = orm.mapped_column(guid.GUID, primary_key=True, default=guid.GUID.generate)
+
+
+class Household(SqlAlchemyBase):
+    __tablename__ = "households"
+    id: orm.Mapped[guid.GUID] = orm.mapped_column(guid.GUID, primary_key=True, default=guid.GUID.generate)
+
+
+cookbooks_to_categories = sa.Table(
+    "cookbooks_to_categories",
+    SqlAlchemyBase.metadata,
+    sa.Column("cookbook_id", guid.GUID, sa.ForeignKey("cookbooks.id"), index=True),
+    sa.Column("category_id", guid.GUID, sa.ForeignKey("categories.id"), index=True),
+)
+
+cookbooks_to_tags = sa.Table(
+    "cookbooks_to_tags",
+    SqlAlchemyBase.metadata,
+    sa.Column("cookbook_id", guid.GUID, sa.ForeignKey("cookbooks.id"), index=True),
+    sa.Column("tag_id", guid.GUID, sa.ForeignKey("tags.id"), index=True),
+)
+
+cookbooks_to_tools = sa.Table(
+    "cookbooks_to_tools",
+    SqlAlchemyBase.metadata,
+    sa.Column("cookbook_id", guid.GUID, sa.ForeignKey("cookbooks.id"), index=True),
+    sa.Column("tool_id", guid.GUID, sa.ForeignKey("tools.id"), index=True),
+)
+
+plan_rules_to_categories = sa.Table(
+    "plan_rules_to_categories",
+    SqlAlchemyBase.metadata,
+    sa.Column("group_plan_rule_id", guid.GUID, sa.ForeignKey("group_meal_plan_rules.id"), index=True),
+    sa.Column("category_id", guid.GUID, sa.ForeignKey("categories.id"), index=True),
+)
+
+plan_rules_to_tags = sa.Table(
+    "plan_rules_to_tags",
+    SqlAlchemyBase.metadata,
+    sa.Column("plan_rule_id", guid.GUID, sa.ForeignKey("group_meal_plan_rules.id"), index=True),
+    sa.Column("tag_id", guid.GUID, sa.ForeignKey("tags.id"), index=True),
+)
+
+plan_rules_to_households = sa.Table(
+    "plan_rules_to_households",
+    SqlAlchemyBase.metadata,
+    sa.Column("group_plan_rule_id", guid.GUID, sa.ForeignKey("group_meal_plan_rules.id"), index=True),
+    sa.Column("household_id", guid.GUID, sa.ForeignKey("households.id"), index=True),
+)
+
+
+class CookBook(SqlAlchemyBase):
+    __tablename__ = "cookbooks"
+
+    id: orm.Mapped[guid.GUID] = orm.mapped_column(guid.GUID, primary_key=True, default=guid.GUID.generate)
+    query_filter_string: orm.Mapped[str] = orm.mapped_column(sa.String, nullable=False, default="")
+
+    categories: orm.Mapped[list[Category]] = orm.relationship(
+        Category, secondary=cookbooks_to_categories, single_parent=True
+    )
+    require_all_categories: orm.Mapped[bool | None] = orm.mapped_column(sa.Boolean, default=True)
+
+    tags: orm.Mapped[list[Tag]] = orm.relationship(Tag, secondary=cookbooks_to_tags, single_parent=True)
+    require_all_tags: orm.Mapped[bool | None] = orm.mapped_column(sa.Boolean, default=True)
+
+    tools: orm.Mapped[list[Tool]] = orm.relationship(Tool, secondary=cookbooks_to_tools, single_parent=True)
+    require_all_tools: orm.Mapped[bool | None] = orm.mapped_column(sa.Boolean, default=True)
+
+
+class GroupMealPlanRules(SqlAlchemyBase):
+    __tablename__ = "group_meal_plan_rules"
+
+    id: orm.Mapped[guid.GUID] = orm.mapped_column(guid.GUID, primary_key=True, default=guid.GUID.generate)
+    query_filter_string: orm.Mapped[str] = orm.mapped_column(sa.String, nullable=False, default="")
+
+    categories: orm.Mapped[list[Category]] = orm.relationship(Category, secondary=plan_rules_to_categories)
+    tags: orm.Mapped[list[Tag]] = orm.relationship(Tag, secondary=plan_rules_to_tags)
+    households: orm.Mapped[list["Household"]] = orm.relationship("Household", secondary=plan_rules_to_households)
+
+
+def migrate_cookbooks():
+    bind = op.get_bind()
+    session = orm.Session(bind=bind)
+
+    cookbooks = session.query(CookBook).all()
+    for cookbook in cookbooks:
+        parts = []
+        if cookbook.categories:
+            relop = "CONTAINS ALL" if cookbook.require_all_categories else "IN"
+            vals = ",".join([f'"{cat.id}"' for cat in cookbook.categories])
+            parts.append(f"recipe_category.id {relop} [{vals}]")
+        if cookbook.tags:
+            relop = "CONTAINS ALL" if cookbook.require_all_tags else "IN"
+            vals = ",".join([f'"{tag.id}"' for tag in cookbook.tags])
+            parts.append(f"tags.id {relop} [{vals}]")
+        if cookbook.tools:
+            relop = "CONTAINS ALL" if cookbook.require_all_tools else "IN"
+            vals = ",".join([f'"{tool.id}"' for tool in cookbook.tools])
+            parts.append(f"tools.id {relop} [{vals}]")
+
+        cookbook.query_filter_string = " AND ".join(parts)
+
+    session.commit()
+
+
+def migrate_mealplan_rules():
+    bind = op.get_bind()
+    session = orm.Session(bind=bind)
+
+    rules = session.query(GroupMealPlanRules).all()
+    for rule in rules:
+        parts = []
+        if rule.categories:
+            vals = ",".join([f'"{cat.id}"' for cat in rule.categories])
+            parts.append(f"recipe_category.id CONTAINS ALL [{vals}]")
+        if rule.tags:
+            vals = ",".join([f'"{tag.id}"' for tag in rule.tags])
+            parts.append(f"tags.id CONTAINS ALL [{vals}]")
+        if rule.households:
+            vals = ",".join([f'"{household.id}"' for household in rule.households])
+            parts.append(f"household_id IN [{vals}]")
+
+        rule.query_filter_string = " AND ".join(parts)
+
+    session.commit()
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table("cookbooks", schema=None) as batch_op:
+        batch_op.add_column(sa.Column("query_filter_string", sa.String(), nullable=False, server_default=""))
+
+    with op.batch_alter_table("group_meal_plan_rules", schema=None) as batch_op:
+        batch_op.add_column(sa.Column("query_filter_string", sa.String(), nullable=False, server_default=""))
+
+    # ### end Alembic commands ###
+
+    migrate_cookbooks()
+    migrate_mealplan_rules()
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table("group_meal_plan_rules", schema=None) as batch_op:
+        batch_op.drop_column("query_filter_string")
+
+    with op.batch_alter_table("cookbooks", schema=None) as batch_op:
+        batch_op.drop_column("query_filter_string")
+
+    # ### end Alembic commands ###

frontend/components/Domain/Cookbook/CookbookEditor.vue

@@ -1,11 +1,13 @@
 <template>
   <div>
-    <v-card-text v-if="cookbook">
+    <v-card-text v-if="cookbook" class="px-1">
       <v-text-field v-model="cookbook.name" :label="$t('cookbook.cookbook-name')"></v-text-field>
       <v-textarea v-model="cookbook.description" auto-grow :rows="2" :label="$t('recipe.description')"></v-textarea>
-      <RecipeOrganizerSelector v-model="cookbook.categories" selector-type="categories" />
-      <RecipeOrganizerSelector v-model="cookbook.tags" selector-type="tags" />
-      <RecipeOrganizerSelector v-model="cookbook.tools" selector-type="tools" />
+      <QueryFilterBuilder
+        :field-defs="fieldDefs"
+        :initial-query-filter="cookbook.queryFilter"
+        @input="handleInput"
+      />
       <v-switch v-model="cookbook.public" hide-details single-line>
         <template #label>
           {{ $t('cookbook.public-cookbook') }}
@@ -14,33 +16,19 @@
           </HelpIcon>
         </template>
       </v-switch>
-      <div class="mt-4">
-        <h3 class="text-subtitle-1 d-flex align-center mb-0 pb-0">
-          {{ $t('cookbook.filter-options') }}
-          <HelpIcon right small class="ml-2">
-            {{ $t('cookbook.filter-options-description') }}
-          </HelpIcon>
-        </h3>
-        <v-switch v-model="cookbook.requireAllCategories" class="mt-0" hide-details single-line>
-          <template #label> {{ $t('cookbook.require-all-categories') }} </template>
-        </v-switch>
-        <v-switch v-model="cookbook.requireAllTags" hide-details single-line>
-          <template #label> {{ $t('cookbook.require-all-tags') }} </template>
-        </v-switch>
-        <v-switch v-model="cookbook.requireAllTools" hide-details single-line>
-          <template #label> {{ $t('cookbook.require-all-tools') }} </template>
-        </v-switch>
-      </div>
     </v-card-text>
   </div>
 </template>
 
 <script lang="ts">
-import { defineComponent } from "@nuxtjs/composition-api";
+import { defineComponent, useContext } from "@nuxtjs/composition-api";
 import { ReadCookBook } from "~/lib/api/types/cookbook";
-import RecipeOrganizerSelector from "~/components/Domain/Recipe/RecipeOrganizerSelector.vue";
+import { Organizer } from "~/lib/api/types/non-generated";
+import QueryFilterBuilder from "~/components/Domain/QueryFilterBuilder.vue";
+import { FieldDefinition } from "~/composables/use-query-filter-builder";
+
 export default defineComponent({
-  components: { RecipeOrganizerSelector },
+  components: { QueryFilterBuilder },
   props: {
     cookbook: {
       type: Object as () => ReadCookBook,
@@ -51,5 +39,50 @@ export default defineComponent({
       required: true,
     },
   },
+  setup(props) {
+    const { i18n } = useContext();
+
+    function handleInput(value: string | undefined) {
+      props.cookbook.queryFilterString = value || "";
+    }
+
+    const fieldDefs: FieldDefinition[] = [
+      {
+        name: "recipe_category.id",
+        label: i18n.tc("category.categories"),
+        type: Organizer.Category,
+      },
+      {
+        name: "tags.id",
+        label: i18n.tc("tag.tags"),
+        type: Organizer.Tag,
+      },
+      {
+        name: "tools.id",
+        label: i18n.tc("tool.tools"),
+        type: Organizer.Tool,
+      },
+      {
+        name: "household_id",
+        label: i18n.tc("household.households"),
+        type: Organizer.Household,
+      },
+      {
+        name: "created_at",
+        label: i18n.tc("general.date-created"),
+        type: "date",
+      },
+      {
+        name: "updated_at",
+        label: i18n.tc("general.date-updated"),
+        type: "date",
+      },
+    ];
+
+    return {
+      handleInput,
+      fieldDefs,
+    };
+  },
 });
 </script>

frontend/components/Domain/Cookbook/CookbookPage.vue

@@ -4,11 +4,13 @@
     <BaseDialog
       v-if="editTarget"
       v-model="dialogStates.edit"
-      :width="650"
+      width="100%"
+      max-width="1100px"
       :icon="$globals.icons.pages"
       :title="$t('general.edit')"
       :submit-icon="$globals.icons.save"
       :submit-text="$tc('general.save')"
+      :submit-disabled="!editTarget.queryFilterString"
       @submit="editCookbook"
     >
       <v-card-text>