arches-querysets 0.1.0__tar.gz

arches_querysets-0.1.0/.babelrc

@@ -0,0 +1,7 @@
+{
+    "presets": [
+        [
+            "@babel/preset-env"
+        ]
+    ]
+}

arches_querysets-0.1.0/.browserslistrc

@@ -0,0 +1,10 @@
+[production staging]
+>5%
+last 2 versions
+Firefox ESR
+not ie < 11
+
+[development]
+last 1 chrome version
+last 1 firefox version
+last 1 edge version

arches_querysets-0.1.0/.coveragerc

@@ -0,0 +1,30 @@
+[run]
+source =
+    arches_querysets/
+
+omit =
+    */python?.?/*
+    */migrations/*
+    */settings*.py
+    */urls.py
+    */wsgi.py
+    */hosts.py
+    */celery.py
+    */__init__.py
+
+data_file = coverage/python/.coverage
+
+[report]
+show_missing = true
+
+exclude_lines =
+    pragma: no cover
+
+[html]
+directory = coverage/python/htmlcov
+
+[xml]
+output = coverage/python/coverage.xml
+
+[json]
+output = coverage/python/coverage.json

arches_querysets-0.1.0/.gitattributes

@@ -0,0 +1,11 @@
+# Set the default behavior, in case people don't have core.autocrlf set.
+* text=auto
+
+# Known binary formats
+*.png binary
+*.jpg binary
+*.ico binary
+*.gif binary
+*.ttf binary
+*.woff binary
+*.woff2 binary

arches_querysets-0.1.0/.github/actions/build-and-test-branch/action.yml

@@ -0,0 +1,109 @@
+name: 'Build and test branch'
+description: 'Builds and tests a branch'
+inputs: 
+  branch-type:
+    description: 'String denoting either `target` or `feature` branch'
+    required: true
+  project-name:
+    description: 'String denoting the name of the project'
+    required: true
+  secrets:
+    description: 'Secrets from main.yml as JSON'
+runs:
+  using: 'composite'
+  steps:
+    - name: Install Java, GDAL, and other system dependencies
+      run: |
+        sudo apt update
+        sudo apt-get install libxml2-dev libpq-dev openjdk-8-jdk libgdal-dev libxslt-dev
+        echo Postgres and ES dependencies installed
+      shell: bash
+
+    - name: Set up Elasticsearch
+      uses: ankane/setup-elasticsearch@v1
+      with:
+        elasticsearch-version: 8
+
+    - name: Install Python packages
+      run: |
+        python -m pip install --upgrade pip
+        pip install '.[dev]'
+        echo Python packages installed
+      shell: bash
+    
+    - name: Ensure frontend configuration files exist
+      run: |
+          python manage.py check
+      shell: bash
+
+    - name: Install Arches applications
+      uses: ./.github/actions/install-arches-applications
+      with:
+        secrets: ${{ inputs.secrets }}
+
+    - name: Install frontend dependencies
+      run: |
+          npm install
+      shell: bash
+
+    - name: Webpack frontend files
+      run: |
+          npm run build_test
+      shell: bash
+
+    - name: Check frontend formatting with prettier
+      run: |
+        npm run prettier:check
+      shell: bash
+
+    - name: Check backend formatting with black
+      run: |
+        black . --check --exclude=node_modules
+      shell: bash
+
+    - name: Check line endings on all but ontology (.xml) files
+      run: |
+        ! git ls-files --eol | grep -v '.xml' | grep 'w/crlf\|w/mixed'
+      shell: bash
+
+    # - name: Run frontend tests
+    #   run: |
+    #     npm run vitest
+    #     mv coverage/frontend/coverage.xml ${{ inputs.branch-type }}_branch_frontend_coverage.xml
+    #   shell: bash
+
+    - name: Check for missing migrations
+      run: |
+        python manage.py makemigrations --check
+      shell: bash
+
+    - name: Ensure previous Python coverage data is erased
+      run: |
+        coverage erase
+      shell: bash
+
+    - name: Run Python unit tests
+      run: |
+        python -W default::DeprecationWarning -m coverage run manage.py test tests --settings="tests.test_settings"
+      shell: bash
+
+    - name: Generate Python report coverage
+      run: |
+        coverage report
+        coverage json
+        mv coverage/python/coverage.json ${{ inputs.branch-type }}_branch_python_coverage.json
+      shell: bash
+
+    # - name: Upload frontend coverage report as artifact
+    #   uses: actions/upload-artifact@v4
+    #   with:
+    #     name: ${{ inputs.branch-type }}-branch-frontend-coverage-report
+    #     path: ${{ inputs.branch-type }}_branch_frontend_coverage.xml
+    #     overwrite: true
+
+    - name: Upload Python coverage report as artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: ${{ inputs.branch-type }}-branch-python-coverage-report
+        path: ${{ inputs.branch-type }}_branch_python_coverage.json
+        overwrite: true

arches_querysets-0.1.0/.github/actions/install-arches-applications/action.yml

@@ -0,0 +1,29 @@
+name: 'Install Arches Applications'
+description: 'Manually edit this file to install all Arches Applications declared in settings.py, but not declared in `pyproject.toml`'
+inputs: 
+  secrets:
+    description: 'Secrets from main.yml as JSON'
+runs:
+  using: 'composite'
+  steps:
+
+    # Manually add any ARCHES_APPLICATIONS to this file if not already declared in `pyproject.toml`. 
+    # Below is a template for adding an application in a private repository. 
+    # Be sure to delete the `no-op step` if adding when updating this file.
+
+    - name: No-op step to maintain workflow structure
+      run: echo "No-op step"
+      shell: bash
+
+    # - name: Checkout ${my_arches_application_name}
+    #   uses: actions/checkout@v4
+    #   with:
+    #     repository: ${my_arches_application_repository}/${my_arches_application_name}
+    #     token: ${{ fromJSON(inputs.secrets).${my_github_personal_access_token} }}
+    #     path: ${my_arches_application_name}
+
+    # - name: Install ${my_arches_application_name}
+    #   run: |
+    #     pip install ./${my_arches_application_name}
+    #     echo ${my_arches_application_name} installed
+    #   shell: bash

arches_querysets-0.1.0/.github/workflows/main.yml

@@ -0,0 +1,272 @@
+name: CI
+
+on: 
+  # push: -- just run on PRs for now
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  build_target_branch:
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgis/postgis:13-3.0
+        env:
+          POSTGRES_PASSWORD: postgis
+          POSTGRES_DB: arches_querysets
+        ports:
+          - 5432:5432
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          check-latest: true
+
+      - name: Checkout into target branch
+        uses: actions/checkout@v4
+        with:
+          repository: ${{ github.repository }}
+          ref: ${{ github.event.pull_request.base.ref }}
+          path: .
+
+      - name: Build and test branch
+        uses: ./.github/actions/build-and-test-branch
+        with:
+          secrets: ${{ toJSON(secrets) }}
+          project-name: 'arches_querysets'
+          branch-type: 'target'
+
+  build_feature_branch:
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgis/postgis:13-3.0
+        env:
+          POSTGRES_PASSWORD: postgis
+          POSTGRES_DB: arches_querysets
+        ports:
+          - 5432:5432
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          check-latest: true
+
+      - name: Checkout into feature branch
+        uses: actions/checkout@v4
+        with:
+          repository: ${{ github.repository }}
+          ref: ${{ github.ref }}
+          path: .
+
+      - name: Build and test branch
+        uses: ./.github/actions/build-and-test-branch
+        with:
+          secrets: ${{ toJSON(secrets) }}
+          project-name: 'arches_querysets'
+          branch-type: 'feature'
+
+  # check_frontend_coverage:
+  #   runs-on: ubuntu-latest
+  #   needs: [build_feature_branch, build_target_branch]
+  #   steps:
+  #     - uses: actions/checkout@v4
+
+  #     - name: Set up Python
+  #       uses: actions/setup-python@v5
+  #       with:
+  #         python-version: '3.x' # Use the latest available version
+  #         check-latest: true
+
+  #     - name: Download feature branch frontend coverage report artifact
+  #       uses: actions/download-artifact@v4
+  #       with:
+  #         name: feature-branch-frontend-coverage-report
+  #         path: .
+
+  #     - name: Extract feature branch frontend coverage data
+  #       shell: pwsh
+  #       run: |
+  #         [xml]$xml = Get-Content feature_branch_frontend_coverage.xml
+  #         $metrics = $xml.coverage.project.metrics
+
+  #         $statements = [double]$metrics.statements
+  #         $coveredstatements = [double]$metrics.coveredstatements
+  #         $conditionals = [double]$metrics.conditionals
+  #         $coveredconditionals = [double]$metrics.coveredconditionals
+  #         $methods = [double]$metrics.methods
+  #         $coveredmethods = [double]$metrics.coveredmethods
+  #         $elements = [double]$metrics.elements
+  #         $coveredelements = [double]$metrics.coveredelements
+
+  #         $statement_coverage = 0.0
+  #         $conditional_coverage = 0.0
+  #         $method_coverage = 0.0
+  #         $element_coverage = 0.0
+
+  #         if ($statements -gt 0) {
+  #             $statement_coverage = ($coveredstatements / $statements) * 100
+  #         }
+  #         if ($conditionals -gt 0) {
+  #             $conditional_coverage = ($coveredconditionals / $conditionals) * 100
+  #         }
+  #         if ($methods -gt 0) {
+  #             $method_coverage = ($coveredmethods / $methods) * 100
+  #         }
+  #         if ($elements -gt 0) {
+  #             $element_coverage = ($coveredelements / $elements) * 100
+  #         }
+
+  #         $nonZeroCount = 0
+  #         $totalCoverage = 0.0
+
+  #         if ($statements -gt 0) { $nonZeroCount++; $totalCoverage += $statement_coverage }
+  #         if ($conditionals -gt 0) { $nonZeroCount++; $totalCoverage += $conditional_coverage }
+  #         if ($methods -gt 0) { $nonZeroCount++; $totalCoverage += $method_coverage }
+  #         if ($elements -gt 0) { $nonZeroCount++; $totalCoverage += $element_coverage }
+
+  #         $feature_branch_frontend_coverage = 0.0
+  #         if ($nonZeroCount -gt 0) {
+  #             $feature_branch_frontend_coverage = $totalCoverage / $nonZeroCount
+  #         }
+
+  #         Write-Output "feature_branch_frontend_coverage=$feature_branch_frontend_coverage" | Out-File -Append $env:GITHUB_ENV
+
+  #     - name: Download target branch frontend coverage report artifact
+  #       continue-on-error: true
+  #       uses: actions/download-artifact@v4
+  #       with:
+  #         name: target-branch-frontend-coverage-report
+  #         path: .
+
+  #     - name: Check if target branch frontend coverage report artifact exists
+  #       run: |
+  #         if [ -f target_branch_frontend_coverage.xml ]; then
+  #           echo "target_branch_frontend_coverage_artifact_exists=true" >> $GITHUB_ENV
+  #         else
+  #           echo "Target branch coverage not found. Defaulting to 0% coverage."
+  #           echo "target_branch_frontend_coverage_artifact_exists=false" >> $GITHUB_ENV
+  #         fi
+
+  #     - name: Extract target branch frontend coverage data
+  #       if: ${{ env.target_branch_frontend_coverage_artifact_exists == 'true' }}
+  #       shell: pwsh
+  #       run: |
+  #         [xml]$xml = Get-Content target_branch_frontend_coverage.xml
+  #         $metrics = $xml.coverage.project.metrics
+
+  #         $statements = [double]$metrics.statements
+  #         $coveredstatements = [double]$metrics.coveredstatements
+  #         $conditionals = [double]$metrics.conditionals
+  #         $coveredconditionals = [double]$metrics.coveredconditionals
+  #         $methods = [double]$metrics.methods
+  #         $coveredmethods = [double]$metrics.coveredmethods
+  #         $elements = [double]$metrics.elements
+  #         $coveredelements = [double]$metrics.coveredelements
+
+  #         $statement_coverage = 0.0
+  #         $conditional_coverage = 0.0
+  #         $method_coverage = 0.0
+  #         $element_coverage = 0.0
+
+  #         if ($statements -gt 0) {
+  #             $statement_coverage = ($coveredstatements / $statements) * 100
+  #         }
+  #         if ($conditionals -gt 0) {
+  #             $conditional_coverage = ($coveredconditionals / $conditionals) * 100
+  #         }
+  #         if ($methods -gt 0) {
+  #             $method_coverage = ($coveredmethods / $methods) * 100
+  #         }
+  #         if ($elements -gt 0) {
+  #             $element_coverage = ($coveredelements / $elements) * 100
+  #         }
+
+  #         $nonZeroCount = 0
+  #         $totalCoverage = 0.0
+
+  #         if ($statements -gt 0) { $nonZeroCount++; $totalCoverage += $statement_coverage }
+  #         if ($conditionals -gt 0) { $nonZeroCount++; $totalCoverage += $conditional_coverage }
+  #         if ($methods -gt 0) { $nonZeroCount++; $totalCoverage += $method_coverage }
+  #         if ($elements -gt 0) { $nonZeroCount++; $totalCoverage += $element_coverage }
+
+  #         $target_branch_frontend_coverage = 0.0
+  #         if ($nonZeroCount -gt 0) {
+  #             $target_branch_frontend_coverage = $totalCoverage / $nonZeroCount
+  #         }
+
+  #         Write-Output "target_branch_frontend_coverage=$target_branch_frontend_coverage" | Out-File -Append $env:GITHUB_ENV
+
+  #     - name: Compare frontend feature coverage with target coverage
+  #       if: github.event_name == 'pull_request'
+  #       run: |
+  #         feature_branch_frontend_coverage=${feature_branch_frontend_coverage}
+  #         target_branch_frontend_coverage=${target_branch_frontend_coverage:-0.0}
+
+  #         # Compare feature coverage with target coverage using floating-point comparison
+  #         if awk -v feature="$feature_branch_frontend_coverage" -v target="$target_branch_frontend_coverage" 'BEGIN { exit (feature < target) ? 0 : 1 }'; then
+  #           echo "Coverage decreased from $target_branch_frontend_coverage% to $feature_branch_frontend_coverage%. Please add or update tests to increase coverage."
+  #           exit 1
+  #         else
+  #           echo "Feature branch coverage ($feature_branch_frontend_coverage%) >= Target branch coverage ($target_branch_frontend_coverage%)."
+  #         fi
+
+  check_python_coverage:
+    runs-on: ubuntu-latest
+    needs: [build_feature_branch, build_target_branch]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x' # Use the latest available version
+          check-latest: true
+
+      - name: Download feature branch Python coverage report artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: feature-branch-python-coverage-report
+          path: .
+
+      - name: Download target branch Python coverage report artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: target-branch-python-coverage-report
+          path: .
+
+      - name: Compare Python feature coverage with target coverage
+        if: github.event_name == 'pull_request'
+        run: |
+          feature_branch_python_coverage=$(cat feature_branch_python_coverage.json | grep -o '"totals": {[^}]*' | grep -o '"percent_covered": [0-9.]*' | awk -F ': ' '{print $2}')
+          target_branch_python_coverage=$(cat target_branch_python_coverage.json | grep -o '"totals": {[^}]*' | grep -o '"percent_covered": [0-9.]*' | awk -F ': ' '{print $2}')
+
+          # Compare feature coverage with target coverage using floating-point comparison
+          if awk -v feature="$feature_branch_python_coverage" -v target="$target_branch_python_coverage" 'BEGIN { exit (feature < target) ? 0 : 1 }'; then
+            echo "Coverage decreased from $target_branch_python_coverage% to $feature_branch_python_coverage%. Please add or update tests to increase coverage."
+            exit 1
+          else
+            echo "Feature branch coverage ($feature_branch_python_coverage%) >= Target branch coverage ($target_branch_python_coverage%)."
+          fi

arches_querysets-0.1.0/.gitignore

@@ -0,0 +1,23 @@
+*.pyc
+*.log
+node_modules
+coverage/
+arches_querysets/logs
+arches_querysets/export_deliverables
+arches_querysets/cantaloupe/*
+arches_querysets/staticfiles
+arches_querysets/media/packages
+arches_querysets/media/build/
+arches_querysets/uploadedfiles/*
+arches_querysets/settings_local.py
+webpack-stats.json
+.vscode/
+*.egg-info
+.DS_STORE
+CACHE
+.tsconfig-paths.json
+.frontend-configuration-settings.json
+
+# Packaging
+build/
+dist

arches_querysets-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,34 @@
+---
+repos:
+
+  - repo: meta
+    hooks:
+      - id: check-hooks-apply
+
+  - repo: https://github.com/psf/black
+    rev: 24.4.2
+    hooks:
+      - id: black
+        args: [--quiet]
+        exclude: node_modules
+
+  - repo: local
+    hooks:
+      - id: prettier
+        name: prettier
+        entry: npm run prettier:fix
+        language: system
+        files: arches_querysets/src
+      - id: eslint
+        name: eslint
+        entry: npm run eslint:fix
+        language: system
+        files: arches_querysets/src
+      - id: typescript
+        name: typescript
+        entry: bash -c 'npm run ts:check'
+        language: system
+        types_or: [
+          "ts",
+          "vue",
+        ]

arches_querysets-0.1.0/.prettierrc

@@ -0,0 +1,4 @@
+{
+    "singleAttributePerLine": true,
+    "tabWidth": 4
+}

arches_querysets-0.1.0/.stylelintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "stylelint-config-standard"
+}