lint codebase, add lint/test to CI, add some tests (Islandora#86)

* Add lint/test CI
* phpcbf
* phpcs
* Add some tests
* fix bug

Author: joecorall

.github/workflows/build-2.x.yml

@@ -0,0 +1,49 @@
+name: CI
+
+on:
+  push:
+    branches: [ 2.x ]
+  pull_request:
+    branches: [ 2.x ]
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-24.04
+    continue-on-error: false
+    strategy:
+      fail-fast: false
+      matrix:
+        php-versions: ["8.3", "8.4"]
+        drupal-version: ["10.5", "10.6", "11.2", "11.3"]
+    name: PHP ${{ matrix.php-versions }} | drupal ${{ matrix.drupal-version }}
+    steps:
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
+
+      - name: create docker network
+        run: docker network create ci-default
+
+      - name: Start chromedriver
+        run: |-
+          docker run -d \
+            --name chromedriver \
+            --network ci-default \
+            drupalci/webdriver-chromedriver:production \
+            chromedriver --log-path=/dev/null --verbose --allowed-ips= --allowed-origins=*
+
+      - name: PHPUNIT tests
+        run: |
+          docker run \
+            --rm \
+            --name drupal \
+            --hostname drupal \
+            --volume $(pwd):/var/www/drupal/web/modules/contrib/$ENABLE_MODULES:ro \
+            --env ENABLE_MODULES \
+            --network ci-default \
+           ghcr.io/islandora/ci:${{ matrix.drupal-version }}-php${{ matrix.php-versions }}
+        env:
+          ENABLE_MODULES: advanced_search

advanced_search.module

@@ -18,9 +18,7 @@ use Drupal\Core\Form\FormStateInterface;
 use Drupal\advanced_search\AdvancedSearchQuery;
 use Drupal\advanced_search\Form\SettingsForm;
 use Drupal\advanced_search\Utilities;
-use Drupal\search_api\Query\QueryInterface as DrupalQueryInterface;
 use Drupal\views\ViewExecutable;
-use Solarium\Core\Query\QueryInterface as SolariumQueryInterface;
 
 /**
  * Implements hook_theme().

src/AdvancedSearchQuery.php

@@ -151,8 +151,7 @@ public function alterQuery(Request $request, SolariumQueryInterface &$solarium_q
       $field_mapping = $backend->getSolrFieldNamesKeyedByLanguage($language_ids, $index);
 
       // Disable for Lucene and wildcard
-      //$q[] = "{!boost b=boost_document}";
-      
+      // $q[] = "{!boost b=boost_document}";
       // Create a flag for active/inactive dismax.
       $config = \Drupal::config(SettingsForm::CONFIG_NAME);
       $isDismax = $config->get(SettingsForm::EDISMAX_SEARCH_FLAG);
@@ -207,10 +206,11 @@ public function alterQuery(Request $request, SolariumQueryInterface &$solarium_q
         if ($isSearchAllFields) {
           // Get configured query fields from settings.
           $configured_query_fields = $config->get(SettingsForm::QUERY_FIELDS) ?: [];
-          
-          // field_mapping structure: [field_id => [language => solr_field_name]]
+
+          // field_mapping structure:
+          // [field_id => [language => solr_field_name]].
           foreach ($field_mapping as $field_id => $languages) {
-            foreach ($languages as $lang => $solr_field_name) {
+            foreach ($languages as $solr_field_name) {
               // bs_ are boolean fields, do not work well with text search.
               if (substr($solr_field_name, 0, 3) !== "bs_") {
 
@@ -230,7 +230,7 @@ public function alterQuery(Request $request, SolariumQueryInterface &$solarium_q
         $dismax->setQueryFields($query_fields);
       }
 
-      // if all fields are searched, use the query_fields for highlighting.
+      // If all fields are searched, use the query_fields for highlighting.
       if ($isSearchAllFields && isset($query_fields)) {
         // Convert back to an array.
         $highlight_source_fields = explode(" ", $query_fields);
@@ -241,7 +241,7 @@ public function alterQuery(Request $request, SolariumQueryInterface &$solarium_q
 
       if ($backend->getConfiguration()['highlight_data']) {
         // Just highlight string and text fields to avoid Solr exceptions.
-        // Exclude tm_X3b_*_fulltext_title
+        // Exclude tm_X3b_*_fulltext_title.
         $highlighted_fields = array_filter(array_unique($highlight_source_fields), function ($v) {
           return !empty($v) && (preg_match('/^t.*?[sm]_/', $v) || preg_match('/^s[sm]_/', $v)) && !preg_match('/^tm_X3b_.*_fulltext_title$/', $v);
         });
@@ -256,7 +256,7 @@ public function alterQuery(Request $request, SolariumQueryInterface &$solarium_q
         // Since we are getting the highlighting result from Solr instead
         // of using the Search API processor to create one, we just need
         // make this field non-empty.
-        //$search_api_query->keys("advanced search");
+        // $search_api_query->keys("advanced search");.
       }
 
       $solarium_query->setQuery($q);

src/AdvancedSearchQueryTerm.php

@@ -321,10 +321,10 @@ public function toSolrQuery(array $solr_field_mapping) {
         }
       }
       // Fixed for https://github.com/digitalutsc/advanced_search/issues/4
-      if ($this->field !== "all"){
+      if ($this->field !== "all") {
         $search_fields = "(";
         foreach ($solr_field_mapping[$this->field] as $field) {
-            $search_fields .= " $field:$value";
+          $search_fields .= " $field:$value";
         }
         $search_fields .= ")";
         return $search_fields;
@@ -386,7 +386,6 @@ public function toSolrQuery(array $solr_field_mapping) {
    */
   public function toSolrFields(array $solr_field_mapping) {
     $terms = [];
-    $query_helper = \Drupal::service('solarium.query_helper');
 
     if ($this->field !== "all") {
       foreach ($solr_field_mapping[$this->field] as $field) {

src/Controller/AjaxBlocksController.php

@@ -11,6 +11,7 @@
 use Drupal\Core\Routing\CurrentRouteMatch;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Symfony\Component\Routing\RouterInterface;
 
@@ -68,6 +69,13 @@ class AjaxBlocksController extends ControllerBase {
    */
   protected $container;
 
+  /**
+   * The request stack.
+   *
+   * @var \Symfony\Component\HttpFoundation\RequestStack
+   */
+  protected $requestStack;
+
   /**
    * Constructs a FacetBlockAjaxController object.
    *
@@ -83,15 +91,26 @@ class AjaxBlocksController extends ControllerBase {
    *   The current route match service.
    * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
    *   The drupal container.
+   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
+   *   The request stack.
    */
-  final public function __construct(RendererInterface $renderer, CurrentPathStack $currentPath, RouterInterface $router, PathProcessorManager $pathProcessor, CurrentRouteMatch $currentRouteMatch, ContainerInterface $container) {
+  final public function __construct(
+    RendererInterface $renderer,
+    CurrentPathStack $currentPath,
+    RouterInterface $router,
+    PathProcessorManager $pathProcessor,
+    CurrentRouteMatch $currentRouteMatch,
+    ContainerInterface $container,
+    RequestStack $request_stack,
+  ) {
     $this->storage = $this->entityTypeManager()->getStorage('block');
     $this->renderer = $renderer;
     $this->currentPath = $currentPath;
     $this->router = $router;
     $this->pathProcessor = $pathProcessor;
     $this->currentRouteMatch = $currentRouteMatch;
     $this->container = $container;
+    $this->requestStack = $request_stack;
   }
 
   /**
@@ -104,7 +123,8 @@ public static function create(ContainerInterface $container) {
       $container->get('router'),
       $container->get('path_processor_manager'),
       $container->get('current_route_match'),
-      $container
+      $container,
+      $container->get('request_stack')
     );
   }
 
@@ -136,7 +156,7 @@ public function respond(Request $request) {
 
     $new_request = Request::create($path);
     $new_request->setSession($request->getSession());
-    $request_stack = \Drupal::requestStack();
+    $request_stack = $this->requestStack;
     $processed = $this->pathProcessor->processInbound($new_request->getPathInfo(), $new_request);
 
     $this->currentPath->setPath($processed);