Scoped-search on ext_method

thomasmckay · February 6, 2018, 9:23pm

I would like to provide auto-complete on “digest” for docker tags. This is not a column, though, so have an ext_method to get the values. The auto-complete code tries to get a column, which doesn’t exist. Is this a bug or a mistake on my part?

https://github.com/Katello/katello/compare/master...thomasmckay:22501-digest-search

github.com

wvanbergen/scoped_search/blob/master/lib/scoped_search/definition.rb#L123


      
            end
          end
          
          # Returns true if this is a virtual field.
          def virtual?
            !ext_method.nil?
          end
          
          # Returns the ActiveRecord column definition that corresponds to this field.
          def column
            @column ||= begin
              if klass.columns_hash.has_key?(field.to_s)
                klass.columns_hash[field.to_s]
              else
                raise ActiveRecord::UnknownAttributeError.new(klass, field)
              end
            end
          end
          
          # Returns the column type of this field.
          def type

thomasmckay · February 7, 2018, 2:29pm

I think this will work:

github.com

theforeman/foreman/blob/develop/app/models/host/managed.rb#L22-L31


def self.complete_for(query, opts = {})
  matcher = /(\s*(?:(?:user\.[a-z]+)|owner)\s*[=~])\s*(\S*)\s*\z/
  matches = matcher.match(query)
  output = super(query, opts)
  if matches.present? && 'current_user'.start_with?(matches[2])
    current_user_result = query.sub(matcher, '\1 current_user')
    output = [current_user_result] + output
  end
  output
end

thomasmckay · February 7, 2018, 7:30pm

I don’t think I’ll be able to do this w/o changes in scoped-search. Where is the best place to open an RFE and get assistance in getting changes in?

stbenjam · February 7, 2018, 7:57pm

Scoped search has always been receptive to PR’s from the Foreman community, just open a PR or issue. https://github.com/wvanbergen/scoped_search/

Where are you trying to auto-complete? There’s some stuff for plugins allowing you to override the default auto complete route:

https://projects.theforeman.org/projects/foreman/wiki/How_to_Create_a_Plugin#Specifying-alternate-auto-complete-path-for-Role-Filters

I’m not sure if that will work for what you need.

thomasmckay · February 8, 2018, 12:02am

Thanks! I’ll check out the docs. I’d be glad to submit a PR… but probably
need some guidance on what/where/how.

tbrisker · February 8, 2018, 10:34am

You could override complete_for for the specific model and check if it starts with the field you are searching on or not and then either defer to super or take other action, but keep in mind there may be more then one search clause that needs to be handled.
I would be weary of adding autocomplete (or even searching) on fields that aren’t in the database though, as that is what scoped search is designed for. Perhaps it would be best, if possible, to define additional relations between the different models, so that scoped search can be used for searching in the relation using its default methods.