Merge pull request #2605 from MushroomObserver/standardize-controller…

…-indexes

More Query refactoring in anticipation of new `with_descriptions` `with_observations` params

app/classes/query/image_base.rb

@@ -3,6 +3,7 @@
 module Query
   # base class for all flavors of Query which return Images
   class ImageBase < Query::Base
+    include Query::Initializers::Images
     include Query::Initializers::Names
     include Query::Initializers::AdvancedSearch
 
@@ -11,33 +12,8 @@ def model
     end
 
     def parameter_declarations
-      super.merge(
-        created_at?: [:time],
-        updated_at?: [:time],
-        date?: [:date],
-        ids?: [Image],
-        by_user?: User,
-        users?: [User],
-        locations?: [:string],
-        outer?: :query, # for images inside observations
-        observation?: Observation, # for images inside observations
-        observations?: [Observation],
-        project?: Project,
-        projects?: [:string],
-        species_lists?: [:string],
-        with_observation?: { boolean: [true] },
-        size?: { string: Image::ALL_SIZES - [:full_size] },
-        content_types?: [{ string: Image::ALL_EXTENSIONS }],
-        with_notes?: :boolean,
-        notes_has?: :string,
-        copyright_holder_has?: :string,
-        license?: [License],
-        with_votes?: :boolean,
-        quality?: [:float],
-        confidence?: [:float],
-        ok_for_export?: :boolean,
-        pattern?: :string
-      ).merge(names_parameter_declarations).
+      super.merge(images_only_parameter_declarations).
+        merge(names_parameter_declarations).
         merge(advanced_search_parameter_declarations)
     end
 
@@ -46,63 +22,22 @@ def initialize_flavor
       super
       unless is_a?(Query::ImageWithObservations)
         add_ids_condition
-        add_inside_observation_conditions
+        add_img_inside_observation_conditions
         add_owner_and_time_stamp_conditions
         add_by_user_condition
         add_date_condition("images.when", params[:date])
         add_join(:observation_images) if params[:with_observation]
-        initialize_notes_parameters
-        initialize_association_parameters
+        initialize_img_notes_parameters
+        initialize_img_association_parameters
       end
       add_pattern_condition
-      add_advanced_search_conditions
+      add_img_advanced_search_conditions
       initialize_name_parameters(:observation_images, :observations)
-      initialize_image_parameters
-      initialize_vote_parameters
+      initialize_img_record_parameters
+      initialize_img_vote_parameters
     end
     # rubocop:enable Metrics/AbcSize
 
-    def initialize_notes_parameters
-      add_boolean_condition("LENGTH(COALESCE(images.notes,'')) > 0",
-                            "LENGTH(COALESCE(images.notes,'')) = 0",
-                            params[:with_notes])
-      add_search_condition("images.notes", params[:notes_has])
-    end
-
-    def initialize_association_parameters
-      initialize_observations_parameter
-      add_where_condition("observations", params[:locations],
-                          :observation_images, :observations)
-      add_for_project_condition(:project_images)
-      initialize_projects_parameter(:project_images, [:project_images])
-      initialize_species_lists_parameter(
-        :species_list_observations,
-        [:observation_images, :observations, :species_list_observations]
-      )
-      add_id_condition("images.license_id", params[:license])
-    end
-
-    def initialize_image_parameters
-      add_search_condition("images.copyright_holder",
-                           params[:copyright_holder_has])
-      add_image_size_condition(params[:size])
-      add_image_type_condition(params[:content_types])
-      add_boolean_condition(
-        "images.ok_for_export IS TRUE",
-        "images.ok_for_export IS FALSE",
-        params[:ok_for_export]
-      )
-    end
-
-    def initialize_vote_parameters
-      add_boolean_condition("images.vote_cache IS NOT NULL",
-                            "images.vote_cache IS NULL",
-                            params[:with_votes])
-      add_range_condition("images.vote_cache", params[:quality])
-      add_range_condition("observations.vote_cache", params[:confidence],
-                          :observation_images, :observations)
-    end
-
     def add_pattern_condition
       return if params[:pattern].blank?
 
@@ -112,64 +47,6 @@ def add_pattern_condition
       super
     end
 
-    def add_advanced_search_conditions
-      return if advanced_search_params.all? { |key| params[key].blank? }
-      return if handle_content_search!
-
-      add_join(:observation_images, :observations)
-      initialize_advanced_search
-    end
-
-    # Perform content search as an observation query, then
-    # coerce into images.
-    def handle_content_search!
-      return false if params[:content].blank?
-
-      self.executor = lambda do |args|
-        execute_content_search(args)
-      end
-    end
-
-    def execute_content_search(args)
-      # [Sorry, yes, this is a mess. But I don't expect this type of search
-      # to survive much longer. Image searches are in desperate need of
-      # critical revision for performance concerns, anyway. -JPH 20210809]
-      args2 = args.except(:select, :order, :group)
-      params2 = params.except(:by)
-      ids = Query.lookup(:Observation, flavor, params2).result_ids(args2)
-      ids = clean_id_set(ids)
-      args2 = args.dup
-      extend_join(args2) << :observation_images
-      extend_where(args2) << "observation_images.observation_id IN (#{ids})"
-      model.connection.select_rows(query(args2))
-    end
-
-    def add_inside_observation_conditions
-      return unless params[:observation] && params[:outer]
-
-      obs = find_cached_parameter_instance(Observation, :observation)
-      @title_args[:observation] = obs.unique_format_name
-      imgs = image_set(obs)
-      where << "images.id IN (#{imgs})"
-      self.order = "FIND_IN_SET(images.id,'#{imgs}') ASC"
-      self.outer_id = params[:outer]
-      skip_observations_with_no_images
-    end
-
-    def image_set(obs)
-      ids = []
-      ids << obs.thumb_image_id if obs.thumb_image_id
-      ids += obs.image_ids - [obs.thumb_image_id]
-      clean_id_set(ids)
-    end
-
-    # Tell outer query to skip observations with no images!
-    def skip_observations_with_no_images
-      self.tweak_outer_query = lambda do |outer|
-        extend_where(outer.params) << "observations.thumb_image_id IS NOT NULL"
-      end
-    end
-
     def search_fields
       "CONCAT(" \
         "names.search_name," \

app/classes/query/initializers/images.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module Query
+  module Initializers
+    # initializing methods inherited by all Query's for Images
+    module Images
+      def images_only_parameter_declarations
+        {
+          created_at?: [:time],
+          updated_at?: [:time],
+          date?: [:date],
+          ids?: [Image],
+          by_user?: User,
+          users?: [User],
+          locations?: [:string],
+          outer?: :query, # for images inside observations
+          observation?: Observation, # for images inside observations
+          observations?: [Observation],
+          project?: Project,
+          projects?: [:string],
+          species_lists?: [:string],
+          with_observation?: { boolean: [true] },
+          size?: { string: Image::ALL_SIZES - [:full_size] },
+          content_types?: [{ string: Image::ALL_EXTENSIONS }],
+          with_notes?: :boolean,
+          notes_has?: :string,
+          copyright_holder_has?: :string,
+          license?: [License],
+          with_votes?: :boolean,
+          quality?: [:float],
+          confidence?: [:float],
+          ok_for_export?: :boolean,
+          pattern?: :string
+        }
+      end
+
+      def initialize_img_notes_parameters
+        add_boolean_condition("LENGTH(COALESCE(images.notes,'')) > 0",
+                              "LENGTH(COALESCE(images.notes,'')) = 0",
+                              params[:with_notes])
+        add_search_condition("images.notes", params[:notes_has])
+      end
+
+      def initialize_img_association_parameters
+        initialize_observations_parameter
+        add_where_condition("observations", params[:locations],
+                            :observation_images, :observations)
+        add_for_project_condition(:project_images)
+        initialize_projects_parameter(:project_images, [:project_images])
+        initialize_species_lists_parameter(
+          :species_list_observations,
+          [:observation_images, :observations, :species_list_observations]
+        )
+        add_id_condition("images.license_id", params[:license])
+      end
+
+      def initialize_img_record_parameters
+        add_search_condition("images.copyright_holder",
+                             params[:copyright_holder_has])
+        add_image_size_condition(params[:size])
+        add_image_type_condition(params[:content_types])
+        add_boolean_condition(
+          "images.ok_for_export IS TRUE",
+          "images.ok_for_export IS FALSE",
+          params[:ok_for_export]
+        )
+      end
+
+      def initialize_img_vote_parameters
+        add_boolean_condition("images.vote_cache IS NOT NULL",
+                              "images.vote_cache IS NULL",
+                              params[:with_votes])
+        add_range_condition("images.vote_cache", params[:quality])
+        add_range_condition("observations.vote_cache", params[:confidence],
+                            :observation_images, :observations)
+      end
+
+      def add_img_advanced_search_conditions
+        return if advanced_search_params.all? { |key| params[key].blank? }
+        return if handle_img_content_search!
+
+        add_join(:observation_images, :observations)
+        initialize_advanced_search
+      end
+
+      # Perform content search as an observation query, then
+      # coerce into images.
+      def handle_img_content_search!
+        return false if params[:content].blank?
+
+        self.executor = lambda do |args|
+          execute_img_content_search(args)
+        end
+      end
+
+      def execute_img_content_search(args)
+        # [Sorry, yes, this is a mess. But I don't expect this type of search
+        # to survive much longer. Image searches are in desperate need of
+        # critical revision for performance concerns, anyway. -JPH 20210809]
+        args2 = args.except(:select, :order, :group)
+        params2 = params.except(:by)
+        ids = Query.lookup(:Observation, flavor, params2).result_ids(args2)
+        ids = clean_id_set(ids)
+        args2 = args.dup
+        extend_join(args2) << :observation_images
+        extend_where(args2) << "observation_images.observation_id IN (#{ids})"
+        model.connection.select_rows(query(args2))
+      end
+
+      def add_img_inside_observation_conditions
+        return unless params[:observation] && params[:outer]
+
+        obs = find_cached_parameter_instance(Observation, :observation)
+        @title_args[:observation] = obs.unique_format_name
+        imgs = image_set(obs)
+        where << "images.id IN (#{imgs})"
+        self.order = "FIND_IN_SET(images.id,'#{imgs}') ASC"
+        self.outer_id = params[:outer]
+        skip_observations_with_no_images
+      end
+
+      def image_set(obs)
+        ids = []
+        ids << obs.thumb_image_id if obs.thumb_image_id
+        ids += obs.image_ids - [obs.thumb_image_id]
+        clean_id_set(ids)
+      end
+
+      # Tell outer query to skip observations with no images!
+      def skip_observations_with_no_images
+        self.tweak_outer_query = lambda do |outer|
+          extend_where(outer.params) <<
+            "observations.thumb_image_id IS NOT NULL"
+        end
+      end
+    end
+  end
+end

app/classes/query/initializers/locations.rb

@@ -4,6 +4,21 @@ module Query
   module Initializers
     # initializing methods inherited by all Query's for Locations
     module Locations
+      # Either not compatible, redundant, or just not used with other queries.
+      def locations_only_parameter_declarations
+        {
+          created_at?: [:time],
+          updated_at?: [:time],
+          ids?: [Location],
+          by_user?: User,
+          by_editor?: User,
+          users?: [User],
+          pattern?: :string,
+          regexp?: :string
+        }
+      end
+
+      # Used in coerced queries for obs, plus observation queries
       def bounding_box_parameter_declarations
         {
           north?: :float,
@@ -12,6 +27,14 @@ def bounding_box_parameter_declarations
           west?: :float
         }
       end
+
+      def add_regexp_condition
+        return if params[:regexp].blank?
+
+        @title_tag = :query_title_regexp_search
+        regexp = escape(params[:regexp].to_s.strip_squeeze)
+        where << "locations.name REGEXP #{regexp}"
+      end
     end
   end
 end