Generate animations for new/modified datasets/shapes (#222)

---------

Signed-off-by: Daniel Schaefer <[email protected]>
Co-authored-by: Stefanie Molin <[email protected]>

Author: JohnAZoidberg

.github/workflows/check-pr.yml

@@ -25,7 +25,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b  # v5.3.0
         with:
-          python-version: "3.11"
+          python-version: "3.x"
 
       - name: Install Dependencies
         run: |

.github/workflows/ci.yml

@@ -12,6 +12,7 @@ on:
     branches: [ "main" ]
     paths:
       - '**'
+      - '!bin/**'
       - '!docs/**'
       - '!.github/**'
       - '.github/workflows/ci.yml'

.github/workflows/generate-morphs.yml

@@ -0,0 +1,99 @@
+# This workflow runs Data Morph on datasets and/or shapes that have
+# been added or modified.
+#
+# Author: Stefanie Molin, Daniel Schaefer
+
+name: Generate Morphs
+
+on:
+  pull_request:
+    paths:
+      - 'src/**'
+      - 'pyproject.toml'
+      - '.github/workflows/generate-morphs.yml'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  generate-morphs:
+    name: Run Data Morph on new/altered datasets/shapes
+
+    # Just generate on one operating system (they should all be the same)
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        shell: bash -e {0}
+
+    strategy:
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
+
+      - name: Set up Python
+        uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b  # v5.3.0
+        with:
+          python-version: "3.x"
+
+      - name: Install Data Morph
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install setuptools --upgrade
+          python -m pip install .
+
+      # docs for this action: https://github.com/tj-actions/changed-files
+      - name: Get all dataset and shape files that have changed
+        id: changed-files-yaml
+        uses: tj-actions/changed-files@4edd678ac3f81e2dc578756871e4d00c19191daf  # v45.0.4
+        with:
+          files_yaml: |
+            dataset:
+              - src/data_morph/data/starter_shapes/*
+            shape:
+              - src/data_morph/shapes/**
+
+      # If datasets were added or changed in this PR
+      - name: Generate morphs from new or changed datasets
+        if: steps.changed-files-yaml.outputs.dataset_any_changed == 'true'
+        env:
+          DATASET_ALL_CHANGED_FILES: ${{ steps.changed-files-yaml.outputs.dataset_all_changed_files }}
+        run: |
+          echo "Detected changes to dataset(s): $DATASET_ALL_CHANGED_FILES"
+          DATASET_ARGS=$(python bin/ci.py $DATASET_ALL_CHANGED_FILES)
+          echo "Generating morphs for the following datasets: $DATASET_ARGS"
+          parallel -j0 data-morph \
+               --start-shape $DATASET_ARGS \
+               --target-shape {} \
+               ::: bullseye heart rectangle star slant_up
+
+      # If shapes are added or modified in this PR
+      - name: Generate morphs from new or changed shapes
+        if: steps.changed-files-yaml.outputs.shape_any_changed == 'true'
+        env:
+          SHAPE_ALL_CHANGED_FILES: ${{ steps.changed-files-yaml.outputs.shape_all_changed_files }}
+        run: |
+          echo "Detected changes to shape(s): $SHAPE_ALL_CHANGED_FILES"
+          SHAPE_ARGS=$(python bin/ci.py $SHAPE_ALL_CHANGED_FILES)
+          echo "Generating morphs for the following shapes: $SHAPE_ARGS"
+          parallel -j0 data-morph \
+               --start-shape music \
+               --target-shape {} \
+               ::: $SHAPE_ARGS
+
+      # For core code changes, we want to do a couple morphs to see if they still look ok
+      # Only need to run if neither of the previous two morphs ran
+      - name: Morph shapes with core code changes
+        if: steps.changed-files-yaml.outputs.dataset_any_changed != 'true' && steps.changed-files-yaml.outputs.shape_any_changed != 'true'
+        run: |
+          parallel -j0 data-morph \
+               --start-shape music \
+               --target-shape {} \
+               ::: bullseye heart rectangle star slant_up
+
+      - uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882  # v4.4.3
+        with:
+          name: morphed-data-pr${{ github.event.number }}-${{ github.sha }}
+          path: morphed_data

bin/ci.py

@@ -0,0 +1,58 @@
+#!/usr/bin/env python
+"""
+Call this script with the names of files that have changed to get the
+datasets and shapes to test with the CLI.
+
+Examples
+--------
+
+$ python bin/ci.py src/data_morph/shapes/circles.py
+bullseye circle rings
+
+$ python bin/ci.py src/data_morph/shapes/bases/line_collection.py
+high_lines h_lines slant_down slant_up v_lines wide_lines x diamond rectangle star
+
+$ python bin/ci.py src/data_morph/shapes/points/heart.py
+heart spade
+
+$ python bin/ci.py src/data_morph/data/starter_shapes/superdatascience.csv
+SDS
+"""
+
+import sys
+from pathlib import Path
+
+from data_morph.data.loader import DataLoader
+from data_morph.shapes.factory import ShapeFactory
+
+new_paths = sys.argv[1:]
+
+args = []
+
+# Figure out argument of datasets based on .csv filename
+for dataset, filename in DataLoader._DATASETS.items():
+    for new_file in new_paths:
+        if filename in new_file:
+            args.append(dataset)
+
+# Figure out argument of shapes based on .py filename
+new_files = [Path(x).name for x in new_paths]
+for shape, shape_cls in ShapeFactory._SHAPE_MAPPING.items():
+    # Find the class and all parent classes and get their module name
+    # We get the module name because it ends in the Python file without .py extension
+    mro = [
+        x.__module__ for x in shape_cls.__mro__ if x.__module__.startswith('data_morph')
+    ]
+
+    if shape == 'spade':
+        mro.append('heart')
+
+    all_modules = [f'{x}.py' for x in mro]
+
+    for new_file in new_files:
+        for module in all_modules:
+            if module.endswith(new_file):
+                args.append(shape)
+                break
+
+print(' '.join(args))