blacklight 9.0.0.beta1 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4ffba1fbfab58e820f1953e4c0b1ff8d3bbcd57da645c10a44aa2f0a09f4a7a
-  data.tar.gz: 323b2afff4d4a8b308486ad81978b64f3a88aa8414e890ea5563bd3ae7820d0e
+  metadata.gz: 7e40641612cebe399faf9868c171d6cf711b59d66c1bc473785ebc801fc5529b
+  data.tar.gz: 68c5ee0c75357603704e1ff05c3b0cf05e9671d5d4f59f5980e795031125da79
 SHA512:
-  metadata.gz: 8d3bbad62d2d7ecfa2b19657d43dab0186e6a945dbd6093c120f2fa5ba833be91b78f75ccd73379008bfb20e199a44702ce49000ce5561203baae41029a5cd3f
-  data.tar.gz: 6a2837ca8deb3fd6650b947197d8dd5c5320631a339ac04a3e804aa1cc930050c50ed097f6fbff27ad3e50aab1c84b0bfe2817e91a466926dc0d0fd0202945b8
+  metadata.gz: 6c2775c6c51e94929bfb33f8fe539e827999e5622d0a02b2bce5b9df9c7c756b6e2e12143e6e26e3a179a1d2a56bf53b42ca9d452f1309ffebeb3566cef9b2ff
+  data.tar.gz: e99e05050ac7160926a2ce94a9581a6a6454d7d611e63a59881ce4d2882364bf7c346c96722a839ff43f1efbf3d44b010b9ab54792e7be339c0146599c8114a9

data/.docker/app/Dockerfile

@@ -12,7 +12,8 @@ RUN apk add --update --no-cache \
   shared-mime-info \
   sqlite-dev \
   tzdata \
-  yarn
+  yarn \
+  yaml-dev
 
 RUN mkdir /app
 WORKDIR /app

data/.github/matrix.json

@@ -0,0 +1,55 @@
+{
+  "ruby": ["3.4"],
+  "rails_version": ["8.1.1"],
+  "bootstrap_version": [null],
+  "view_component_version": ["~> 4.0"],
+  "api": [null],
+  "additional_engine_cart_rails_options": ["--css=bootstrap"],
+  "additional_name": [""],
+  "include": [
+    {
+      "ruby": "3.4",
+      "rails_version": "8.1.1",
+      "additional_engine_cart_rails_options": "--css=bootstrap --js=esbuild",
+      "additional_name": "| esbuild"
+    },
+    {
+      "ruby": "3.4",
+      "rails_version": "8.0.4",
+      "additional_engine_cart_rails_options": "--css=bootstrap",
+      "view_component_version": "~> 3.0",
+      "additional_name": "ViewComponent 3"
+    },
+    {
+      "ruby": "3.3",
+      "rails_version": "8.0.4",
+      "additional_engine_cart_rails_options": "--css=bootstrap",
+      "additional_name": "| Rails 8.0 + Ruby 3.3"
+    },
+    {
+      "ruby": "3.4",
+      "rails_version": "8.0.4",
+      "additional_engine_cart_rails_options": "--css=bootstrap --js=esbuild",
+      "additional_name": "| esbuild"
+    },
+    {
+      "ruby": "3.2",
+      "rails_version": "8.0.4",
+      "solr_version": "8.11.2",
+      "additional_name": "| Solr 8.11.2 and Ruby 3.2"
+    },
+    {
+      "ruby": "3.4",
+      "rails_version": "8.1.1",
+      "api": "true",
+      "additional_engine_cart_rails_options": "--api --skip-yarn",
+      "additional_name": "| API"
+    },
+    {
+      "ruby": "3.4",
+      "rails_version": "7.2.3",
+      "additional_engine_cart_rails_options": "-a propshaft --css=bootstrap --js=esbuild",
+      "additional_name": "| Rails 7.2 + Propshaft, esbuild"
+    }
+  ]
+}

data/.github/workflows/build.yml

@@ -0,0 +1,16 @@
+on:
+  workflow_call:
+    inputs:
+      ref:
+        required: false
+        type: string
+        default: ''
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.ref }}
+      - name: Build docker image
+        run: docker compose build app

data/.github/workflows/lint.yml

@@ -0,0 +1,25 @@
+on:
+  workflow_call:
+    inputs:
+      ref:
+        required: false
+        type: string
+        default: ''
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.ref }}
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2
+          bundler: "latest"
+      - name: Change permissions
+        run: "chmod -f -R o-w /opt/hostedtoolcache/Ruby/3.2.5/x64/lib/ruby/gems/3.2.0/gems | :"
+      - name: Install dependencies
+        run: bundle install
+      - name: Run linter
+        run: bundle exec rake rubocop

data/.github/workflows/main.yml

@@ -0,0 +1,22 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+      - "release-*"
+  pull_request:
+jobs:
+  lint:
+    uses: ./.github/workflows/lint.yml
+  test:
+    uses: ./.github/workflows/test.yml
+  docker_build:
+    uses: ./.github/workflows/build.yml

data/.github/workflows/release_7_x_scheduled.yml

@@ -0,0 +1,39 @@
+# If there are failures running this workflow, please resolve them on the release-7.x branch
+# and then port any necessary changes to this branch.
+
+name: release-7.x scheduled
+
+on:
+  workflow_dispatch:
+  schedule:
+    # Weekly at 9:35 on Friday
+    # Somewhat weird timing so that it isn't delayed too much
+    - cron: '35 9 * * 5'
+jobs:
+  lint:
+    uses: projectblacklight/blacklight/.github/workflows/lint.yml@release-7.x
+    with:
+      ref: release-7.x
+  test:
+    uses: projectblacklight/blacklight/.github/workflows/test.yml@release-7.x
+    with:
+      ref: release-7.x
+  docker_build:
+    uses: projectblacklight/blacklight/.github/workflows/build.yml@release-7.x
+    with:
+      ref: release-7.x
+  report:
+    runs-on: ubuntu-latest
+    if: ${{ always() && contains(join(needs.*.result, ','), 'failure') }}
+    needs: [lint, test, docker_build]
+    steps:
+      - name: Report on failure of any dependent job
+        env:
+          NEEDS: ${{ toJSON(needs) }}
+        uses: slackapi/slack-github-action@v2.0.0
+        with:
+          method: chat.postMessage
+          token: ${{ secrets.SLACK_BOT_TOKEN }}
+          payload: |
+            channel: ${{ secrets.SLACK_CHANNEL_ID }}
+            text: "The weekly CI run of the release-7.x branch has failed"

data/.github/workflows/release_8_x_scheduled.yml

@@ -0,0 +1,39 @@
+# If there are failures running this workflow, please resolve them on the release-8.x branch
+# and then port any necessary changes to this branch.
+
+name: release-8.x scheduled
+
+on:
+  workflow_dispatch:
+  schedule:
+    # Weekly at 9:35 on Friday
+    # Somewhat weird timing so that it isn't delayed too much
+    - cron: '35 9 * * 5'
+jobs:
+  lint:
+    uses: projectblacklight/blacklight/.github/workflows/lint.yml@release-8.x
+    with:
+      ref: release-8.x
+  test:
+    uses: projectblacklight/blacklight/.github/workflows/test.yml@release-8.x
+    with:
+      ref: release-8.x
+  docker_build:
+    uses: projectblacklight/blacklight/.github/workflows/build.yml@release-8.x
+    with:
+      ref: release-8.x
+  report:
+    runs-on: ubuntu-latest
+    if: ${{ always() && contains(join(needs.*.result, ','), 'failure') }}
+    needs: [lint, test, docker_build]
+    steps:
+      - name: Report on failure of any dependent job
+        env:
+          NEEDS: ${{ toJSON(needs) }}
+        uses: slackapi/slack-github-action@v2.0.0
+        with:
+          method: chat.postMessage
+          token: ${{ secrets.SLACK_BOT_TOKEN }}
+          payload: |
+            channel: ${{ secrets.SLACK_CHANNEL_ID }}
+            text: "The weekly CI run of the release-8.x branch has failed"

data/.github/workflows/test.yml

@@ -0,0 +1,53 @@
+on:
+  workflow_call:
+    inputs:
+      ref:
+        required: false
+        type: string
+        default: ''
+        description: The branch or reference to run the workflow against
+jobs:
+  set_matrix:
+    runs-on: ubuntu-latest
+    outputs:
+      matrix: ${{ steps.matrix.outputs.matrix }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ inputs.ref }}
+      - name: Echo ./.github/matrix.json
+        id: matrix
+        run: |
+          echo "matrix<<EOF" >> $GITHUB_OUTPUT
+          cat ./.github/matrix.json >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+  test:
+    needs: set_matrix
+    runs-on: ubuntu-latest
+    name: ruby ${{ matrix.ruby }} | rails ${{ matrix.rails_version }} ${{ matrix.additional_name }}
+    strategy:
+      fail-fast: false
+      matrix: ${{fromJson(needs.set_matrix.outputs.matrix)}}
+    env:
+      RAILS_VERSION: ${{ matrix.rails_version }}
+      SOLR_VERSION: ${{ matrix.solr_version || 'latest' }}
+      VIEW_COMPONENT_VERSION: ${{ matrix.view_component_version }}
+      BOOTSTRAP_VERSION: ${{ matrix.bootstrap_version }}
+      BLACKLIGHT_API_TEST: ${{ matrix.api }}
+      ENGINE_CART_RAILS_OPTIONS: "--skip-git --skip-listen --skip-spring --skip-keeps --skip-kamal --skip-solid --skip-coffee --skip-test ${{ matrix.additional_engine_cart_rails_options }}"
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.ref }}
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler: "latest"
+          ruby-version: ${{ matrix.ruby }}
+      - name: Change permissions
+        run: "chmod -f -R o-w /opt/hostedtoolcache/Ruby/3.2.5/x64/lib/ruby/gems/3.2.0/gems | :"
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake ci

data/.rubocop.yml

@@ -1,4 +1,4 @@
-require:
+plugins:
   - rubocop-capybara
   - rubocop-rspec
   - rubocop-rspec_rails
@@ -10,7 +10,7 @@ inherit_from:
 
 AllCops:
   DisplayCopNames: true
-  TargetRubyVersion: 3.1
+  TargetRubyVersion: 3.2
   TargetRailsVersion: 7.0
   Exclude:
     - "lib/generators/blacklight/templates/**/*"
@@ -75,7 +75,7 @@ Naming/MethodParameterName:
     - of
     - by
 
-Naming/PredicateName:
+Naming/PredicatePrefix:
   ForbiddenPrefixes:
     - is_
 
@@ -585,3 +585,81 @@ Rails/WhereRange: # new in 2.25
   Enabled: true
 Gemspec/AddRuntimeDependency: # new in 1.65
   Enabled: true
+Lint/ArrayLiteralInRegexp: # new in 1.71
+  Enabled: true
+Lint/ConstantReassignment: # new in 1.70
+  Enabled: true
+Lint/DuplicateSetElement: # new in 1.67
+  Enabled: true
+Lint/HashNewWithKeywordArgumentsAsDefault: # new in 1.69
+  Enabled: true
+Lint/NumericOperationWithConstantResult: # new in 1.69
+  Enabled: true
+Lint/SharedMutableDefault: # new in 1.70
+  Enabled: true
+Lint/UnescapedBracketInRegexp: # new in 1.68
+  Enabled: true
+Lint/UselessDefined: # new in 1.69
+  Enabled: true
+Lint/UselessNumericOperation: # new in 1.66
+  Enabled: true
+Style/AmbiguousEndlessMethodDefinition: # new in 1.68
+  Enabled: true
+Style/BitwisePredicate: # new in 1.68
+  Enabled: true
+Style/CombinableDefined: # new in 1.68
+  Enabled: true
+Style/DigChain: # new in 1.69
+  Enabled: true
+Style/FileNull: # new in 1.69
+  Enabled: true
+Style/FileTouch: # new in 1.69
+  Enabled: true
+Style/HashSlice: # new in 1.71
+  Enabled: true
+Style/ItAssignment: # new in 1.70
+  Enabled: true
+Style/KeywordArgumentsMerging: # new in 1.68
+  Enabled: true
+Style/RedundantInterpolationUnfreeze: # new in 1.66
+  Enabled: true
+Style/SafeNavigationChainLength: # new in 1.68
+  Enabled: true
+Rails/EnumSyntax: # new in 2.26
+  Enabled: true
+Rails/MultipleRoutePaths: # new in 2.29
+  Enabled: true
+Rails/StrongParametersExpect: # new in 2.29
+  Enabled: true
+Lint/CopDirectiveSyntax: # new in 1.72
+  Enabled: true
+Lint/RedundantTypeConversion: # new in 1.72
+  Enabled: true
+Lint/SuppressedExceptionInNumberConversion: # new in 1.72
+  Enabled: true
+Lint/UselessConstantScoping: # new in 1.72
+  Enabled: true
+Style/ComparableBetween: # new in 1.74
+  Enabled: true
+Style/HashFetchChain: # new in 1.75
+  Enabled: true
+Style/ItBlockParameter: # new in 1.75
+  Enabled: true
+Style/RedundantFormat: # new in 1.72
+  Enabled: true
+Capybara/FindAllFirst: # new in 2.22
+  Enabled: true
+Capybara/NegationMatcherAfterVisit: # new in 2.22
+  Enabled: true
+RSpec/IncludeExamples: # new in 3.6
+  Enabled: true
+Lint/UselessDefaultValueArgument: # new in 1.76
+  Enabled: true
+Lint/UselessOr: # new in 1.76
+  Enabled: true
+Naming/PredicateMethod: # new in 1.76
+  Enabled: true
+Style/EmptyStringInsideInterpolation: # new in 1.76
+  Enabled: true
+Style/RedundantArrayFlatten: # new in 1.76
+  Enabled: true