plok 1.0.3 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d547235d31f52b56077f2329d5e654fb84bab1bcde461161d922f89b745ebd9
-  data.tar.gz: 25e975e1bbe1e10d5c574e0ca0a86f8ccf22b7f1085be5bc42ad35b80b55a120
+  metadata.gz: 7801b68f7ae1a30624a95fcf9713bb1251f2e7831960ddd173e64b152ba24f94
+  data.tar.gz: 057c7d13a8922bdeba6150e6d2df6ecec65d0f8af169a50b879ccadbee3688b3
 SHA512:
-  metadata.gz: '045079c93e3c9f510fc29831a908c3de4c29a2a803e62fa3fd6288f3ed030efc6f91de118c36bc9b7be29504a8edbb3c0f67d4cd95666c3c76d7848b720815cc'
-  data.tar.gz: 1c1ff0f3a2fa04de54c55c6a409bfb1da55cebea2ce56dd3ad9b1206ac01cef359da4220d71f897e749904353cebf62836a65da6ea20747ce2ed7cef8f30bcea
+  metadata.gz: '087677f2caccca0fc4d2e342790860f8514aa002447f2555e018aa4e60e5bb817111209c7cea3c84452ec24b717291fe1e05dc061623cc7b5dd2cd5791271f4b'
+  data.tar.gz: 394542cf38ab37c5740622fee0fc6de8c0b9bd9697e91b94323a3b0edd84ce60aa750af2daf14ccdaaa5782282d548c5ac7a9a77fd56567e936f9164c9a631c2

data/app/assets/javascripts/plok/searchable.js

@@ -19,7 +19,7 @@ var search = search || {
   },
 
   target: function() {
-    return $('#plok-search input');
+    return $('[data-plok-searchable] input');
   }
 };
 

data/app/models/concerns/plok/searchable.rb

@@ -1,8 +1,9 @@
+# TODO: Find a way to spec this properly.
 module Plok::Searchable
   extend ActiveSupport::Concern
 
   included do
-    has_many :search_indices, as: :searchable, dependent: :destroy
+    has_many :search_indices, as: :searchable
 
     # The after_save block creates or saves indices for every indicated
     # searchable field. Takes both translations and flexible content into
@@ -15,16 +16,18 @@ module Plok::Searchable
     end
 
     def trigger_indices_save!
-      self.class.searchable_fields_list.each do |key|
-        if key == :flexible_content
-          save_flexible_content_search_indices! && next
-        end
+      self.class.searchable_fields_list.each do |namespace, keys|
+        keys.each do |key|
+          if key == :flexible_content
+            save_flexible_content_search_indices!(namespace) && next
+          end
 
-        if respond_to?(:translatable?) && self.class.translatable_fields_list.include?(key)
-          save_translatable_search_index!(key) && next
-        end
+          if respond_to?(:translatable?) && self.class.translatable_fields_list.include?(key)
+            save_translatable_search_index!(namespace, key) && next
+          end
 
-        save_search_index!(key)
+          save_search_index!(namespace, key)
+        end
       end
     end
 
@@ -38,38 +41,37 @@ module Plok::Searchable
     # to help facilitate searchable management. Note that said code was
     # initially present in this class, and it was such a mess that it became
     # unpractical to maintain.
-    def save_flexible_content_search_indices!
+    def save_flexible_content_search_indices!(namespace)
       content_rows.each do |row|
         row.columns.each do |column|
           next unless column.content.is_a?(ContentText)
           key = "flexible_content:#{column.content_id}"
-          save_index!(key, value: column.content.content, locale: row.locale)
+          save_search_index!(namespace, key, value: column.content.content, locale: row.locale)
         end
       end
     end
 
-    def save_index!(key, value: nil, locale: nil)
-      value = read_attribute(key) if value.blank? && respond_to?(key)
+    def save_search_index!(namespace, key, value: nil, locale: nil)
+      value = if value.present?
+                value
+              elsif ActiveRecord::Base.connection.column_exists?(self.class.table_name, key)
+                read_attribute(key)
+              elsif respond_to?(key)
+                send(key)
+              end
+
       return if value.blank?
 
       search_indices
-        .find_or_create_by!(name: key, locale: locale)
+        .find_or_create_by!(namespace: namespace, name: key, locale: locale)
         .update_column(:value, value)
     end
 
-    # This exists so we can use #save_search_index! as the main method
-    # to override, and then be able to call #save_index! in the overridden
-    # method to accommodate further defaults.
-    def save_search_index!(key)
-      value = read_attribute(key)
-      save_index!(key, value: value)
-    end
-
-    def save_translatable_search_index!(key)
+    def save_translatable_search_index!(namespace, key)
       # TODO: locales can't be hardcoded
       %w(nl fr).each do |locale|
         value = translation(locale.to_sym).send(key)
-        save_index!(key, value: value, locale: locale)
+        save_search_index!(namespace, key, value: value, locale: locale)
       end
     end
 
@@ -79,18 +81,22 @@ module Plok::Searchable
   end
 
   module ClassMethods
-    def searchable_field(key)
-      unless searchable_fields_list.include?(key.to_sym)
-        searchable_fields_list << key.to_sym
+    def searchable_field(namespace, key)
+      return if searchable_fields_list.dig(namespace.to_sym)&.include?(key.to_sym)
+
+      if searchable_fields_list[namespace.to_sym].blank?
+        searchable_fields_list[namespace.to_sym] = []
       end
+
+      searchable_fields_list[namespace.to_sym] << key.to_sym
     end
 
-    def searchable_fields(*args)
-      args.each { |key| searchable_field(key) }
+    def plok_searchable(namespace: nil, fields: [], conditions: [])
+      fields.each { |key| searchable_field(namespace, key) }
     end
 
     def searchable_fields_list
-      @searchable_fields_list ||= []
+      @searchable_fields_list ||= {}
     end
   end
 end

data/app/models/search_module.rb

@@ -1,11 +1,12 @@
 class SearchModule < ActiveRecord::Base
-  scope :weighted, -> { order('weight DESC') }
 
-  validates :name, presence: true
+  scope :searchable, -> { where('search_modules.searchable': true) }
+  scope :weighted, -> { order('search_modules.weight DESC') }
 
-  def indices
-    SearchIndex
-      .joins('INNER JOIN search_modules ON search_indices.searchable_type = search_modules.name')
-      .where('search_modules.name = ?', name)
+  validates :klass, presence: true
+
+  def search_indices
+    SearchIndex.where(searchable_type: klass)
   end
+
 end

data/db/migrate/20221021133242_rename_name_to_klass_for_search_modules.rb

@@ -0,0 +1,9 @@
+class RenameNameToKlassForSearchModules < ActiveRecord::Migration[6.1]
+  def up
+    rename_column :search_modules, :name, :klass
+  end
+
+  def down
+    rename_column :search_modules, :klass, :name
+  end
+end

data/db/migrate/20221031143932_add_namespace_to_search_indices.rb

@@ -0,0 +1,5 @@
+class AddNamespaceToSearchIndices < ActiveRecord::Migration[6.1]
+  def change
+    add_column :search_indices, :namespace, :string, after: :searchable_id, index: true
+  end
+end

data/lib/generators/plok/search/USAGE

@@ -0,0 +1,10 @@
+Description:
+    This generates a Plok::Search class for a given namespace, which you can
+    use to search for search_indices tagged with the same namespace.
+
+Example:
+    bin/rails g plok/search/class --namespace backend
+
+    This will create:
+        lib/plok/search/backend.rb
+        spec/lib/plok/search/backend_spec.rb

data/lib/generators/plok/search/class_generator.rb

@@ -0,0 +1,36 @@
+require 'rails/generators/base'
+
+class Plok::Search::ClassGenerator < Rails::Generators::Base
+  source_root File.expand_path('templates', __dir__)
+  class_option :namespace, type: :string
+
+  def create
+    copy_file "namespace_class.rb", namespace_class_path
+    copy_file "namespace_class_spec.rb", namespace_class_spec_path
+    gsub_file(namespace_class_path, '[namespace]', namespace_class)
+    gsub_file(namespace_class_spec_path, '[namespace]', namespace_class)
+    gsub_file(namespace_class_spec_path, '[snakecased_namespace]', options.namespace)
+  end
+
+  private
+
+  def app_name
+    Rails.application.class.name.split('::').first
+  end
+
+  def namespace_class_path
+    "lib/plok/search/#{options.namespace}.rb"
+  end
+
+  def namespace_class_spec_path
+    "spec/lib/plok/search/#{options.namespace}_spec.rb"
+  end
+
+  def file_contains?(file, content)
+    File.readlines(file).grep(content).any?
+  end
+
+  def namespace_class
+    options.namespace.to_s.camelcase
+  end
+end

data/lib/generators/plok/search/result_object_generator.rb

@@ -0,0 +1,41 @@
+require 'rails/generators/base'
+
+class Plok::Search::ResultObjectGenerator < Rails::Generators::Base
+  source_root File.expand_path('templates', __dir__)
+  class_option :name, type: :string
+  class_option :namespace, type: :string
+
+  def create
+    # TODO: Check for missing params
+    copy_file 'result_object.rb', class_path
+    gsub_file(class_path, '[name]', options.name)
+    gsub_file(class_path, '[namespace]', options.namespace)
+    gsub_file(class_path, '[class_name]', to_snakecase(options.name))
+    gsub_file(class_path, '[namespace_module_name]', to_snakecase(options.namespace))
+
+    copy_file 'result_object.html.erb', markup_path
+    gsub_file(markup_path, '[name]', options.name)
+  end
+
+  private
+
+  def app_name
+    Rails.application.class.name.split('::').first
+  end
+
+  def class_path
+    "lib/plok/search/result_objects/#{options.namespace}/#{options.name}.rb"
+  end
+
+  def markup_path
+    "app/views/plok/search/result_objects/#{options.namespace}/_#{options.name}.html.erb"
+  end
+
+  def namespace_class_spec_path
+    "spec/lib/plok/search/#{options.namespace}_spec.rb"
+  end
+
+  def to_snakecase(name)
+    name.to_s.camelcase
+  end
+end

data/lib/generators/plok/search/templates/namespace_class.rb

@@ -0,0 +1,25 @@
+module Plok::Search
+  # The reason this class exists is mainly to provide a context layer to
+  # override Plok::Search::Base. It provides a manipulated version of the
+  # filtered index data that we can use in the result set of an
+  # autocomplete-triggered search query.
+  class [namespace] < Plok::Search::Base
+    # This translates the filtered indices into meaningful result objects.
+    #
+    # #search_indices will return an ActiveRecord::Relation of SearchIndex
+    # records. Because #lazy is chained after it, we still have a way to fiddle
+    # with the AR query when necessary.
+    #
+    # #format_search_results will return a list of jquery-ui friendly hashes:
+    #   [
+    #     { label: ... value: ... },
+    #     { label: ... value: ... }
+    #   ]
+    #
+    def search(modules: [])
+      format_search_results(
+        search_indices(modules: modules).lazy
+      )
+    end
+  end
+end

data/lib/generators/plok/search/templates/namespace_class_spec.rb

@@ -0,0 +1,20 @@
+require 'rails_helper'
+
+describe Plok::Search::[namespace] do
+  subject { described_class.new('John', namespace: '[snakecased_namespace]') }
+
+  describe '#search' do
+    it 'defaults to an empty list' do
+      # Have to cast to an array because search lazy loads results.
+      expect(subject.search.to_a).to eq []
+    end
+
+    it 'returns relevant indices' do
+      # TODO:
+    end
+  end
+
+  it '#respond_to?' do
+    expect(subject).to respond_to(:format_search_results, :search_indices)
+  end
+end

data/lib/generators/plok/search/templates/result_object.html.erb

@@ -0,0 +1,4 @@
+<% [name] = [name].decorate if [name].respond_to?(:decorate) %>
+
+<strong><%= t 'b.[name]' %></strong><br>
+<small class="text-muted"><%= [name].id %></small>

data/lib/generators/plok/search/templates/result_object.rb

@@ -0,0 +1,19 @@
+module Plok::Search::ResultObjects
+  # This class should be used to further manipulate any of the data provided
+  # through #search_context or Plok::Search::ResultObjects::Base.
+  #
+  # A search context class is accessible through #search_context. This
+  # gives you access to #search_context.controller, which can be used to
+  # call routes upon.
+  #
+  # Example of: If an autocomplete requires additional data to be rendered in
+  # the partial (think another model, or an API call), one could override
+  # the #locals method to include more variables. You could do this directly
+  # in the partial as well, but this way we have separation of concerns.
+  class [namespace_module_name]::[class_name] < Plok::Search::ResultObjects::Base
+    def url
+      # TODO: Add a path to where people should end up by clicking the result.
+      #search_context.controller.[namespace]_[name]_path(searchable)
+    end
+  end
+end

data/lib/plok/search/base.rb

@@ -4,7 +4,7 @@ module Plok::Search
   # result set (think autocomplete results) is done by extending this class.
   #
   # Examples of class extensions could be:
-  # Plok::Search::Backend - included in Plok
+  # Plok::Search::Backend
   # Plok::Search::Frontend
   # Plok::Search::Api
   #
@@ -22,44 +22,36 @@ module Plok::Search
   #
   # However these result objects are structured are also up to the developer.
   class Base
-    attr_reader :term, :controller
 
-    def initialize(term, controller: nil, namespace: nil)
+    attr_reader :term, :namespace, :controller
+
+    def initialize(term, namespace: nil, controller: nil)
       @term = Plok::Search::Term.new(term, controller: controller)
-      @controller = controller
       @namespace = namespace
+      @controller = controller
     end
 
-    def indices
-      # Having the searchmodules sorted by weight returns indices in the
-      # correct order.
-      @indices ||= SearchModule.weighted.inject([]) do |stack, m|
-        # The group happens to make sure we end up with just 1 copy of
-        # a searchable result. Otherwise matches from both an indexed
-        # Page#title and Page#description would be in the result set.
-        stack << m.indices
-                  .where(
-                    '(searchable_id = ? OR search_indices.value LIKE ?)',
-                    term.value,
-                    "%#{term.value}%"
-                  )
-                  .group([:searchable_type, :searchable_id])
-      end.flatten
-    end
+    def format_search_results(indices, options = {})
+      options.reverse_merge!(
+        label_method: :build_html,
+        value_method: :url
+      )
+
+      indices.map do |index|
+        result = result_object(index)
 
-    def namespace
-      # This looks daft, but it gives us a foot in the door for when a frontend
-      # search is triggered in the backend.
-      return @namespace unless @namespace.nil?
-      return 'Frontend' if controller.nil?
-      controller.class.module_parent.to_s
+        {
+          label: result.send(options[:label_method]),
+          value: result.send(options[:value_method])
+        }
+      end
     end
 
     # In order to provide a good result set in a search autocomplete, we have
     # to translate the raw index to a class that makes an index adhere
     # to a certain interface (that can include links).
     def result_object(index)
-      klass = "Plok::Search::ResultObjects::#{namespace}::#{index.searchable_type}"
+      klass = "Plok::Search::ResultObjects::#{@namespace.camelcase}::#{index.searchable_type}"
       klass = 'Plok::Search::ResultObjects::Base' unless result_object_exists?(klass)
       klass.constantize.new(index, search_context: self)
     end
@@ -67,5 +59,28 @@ module Plok::Search
     def result_object_exists?(name)
       Plok::Engine.class_exists?(name) && name.constantize.method_defined?(:build_html)
     end
+
+    # TODO: SearchIndexCollection
+    # TODO: What if records are hidden? Make this smart and have SearchIndex#visible?
+    # TODO: See if there's a way to pass weight through individual records.
+    def search_indices(modules: [])
+      modules = SearchModule.searchable.pluck(:klass) if modules.blank?
+
+      # Having the searchmodules sorted by weight returns indices in the
+      # correct order.
+      #
+      # The group happens to make sure we end up with just 1 copy of
+      # a searchable result. Otherwise matches from both an indexed
+      # Page#title and Page#description would be in the result set.
+      @search_indices ||= SearchIndex
+        .joins('INNER JOIN search_modules ON search_indices.searchable_type = search_modules.klass')
+        .where('search_modules.searchable': true)
+        .where('search_modules.klass in (?)', modules)
+        .where('search_indices.namespace = ?', @namespace)
+        .where('search_indices.value LIKE ?', "%#{term.value}%")
+        .group([:searchable_type, :searchable_id])
+        .preload(:searchable) # ".includes" for polymorphic relations
+    end
+
   end
 end

data/lib/plok/search/result_objects/base.rb

@@ -52,12 +52,23 @@ module Plok
       { "#{partial_target}": index.searchable, index: index }
     end
 
+    def namespace
+      search_context.namespace.to_s.underscore
+    end
+
     def partial
       "#{partial_path}/#{partial_target}"
     end
 
     def partial_path
-      "#{search_context.namespace.to_s.underscore}/search"
+      # TODO: This is a fallback for older Plok versions whose result object
+      # partials still reside in app/views/backens/search/*. Best to remove
+      # this at a later stage, but for now they can be backwards compatible.
+      if File.exists?("app/views/#{namespace}/search/_#{partial_target}.html.erb")
+        return "#{namespace}/search/"
+      end
+
+      "plok/search/result_objects/#{namespace}"
     end
 
     def partial_target

data/lib/plok/version.rb

@@ -1,3 +1,3 @@
 module Plok
-  VERSION = '1.0.3'
+  VERSION = '1.1.1'
 end

data/lib/tasks/plok_tasks.rake

@@ -1,11 +1,46 @@
 namespace 'plok:search' do
-  desc 'Rebuild all search indices'
+  # The official Rails way to pass arguments to Rake tasks is this:
+  #
+  #   task :rebuild_indices, [:modules] => :environment do |_t, args|
+  #     args.with_defaults(modules: SearchModule.searchable.pluck(:klass))
+  #   end
+  #
+  # The problem with that is that you can't comma-separate multiple modules
+  # unless you escape them. This is because commas denote multiple arguments.
+  #
+  # In short, this wouldn't work:
+  #
+  #   bin/rails plok:search:rebuild_indices[EmailTemplate,Article]
+  #
+  # And you'd need to do this:
+  #
+  #   bin/rails plok:search:rebuild_indices["EmailTemplate\,Article"]
+  #
+  # I don't agree with that notation, so instead I opted for ENV vars instead:
+  #
+  #   bin/rails plok:search:rebuild_indices modules=EmailTemplate,Article
+  #
+  desc 'Rebuild select search indices (or all of them without additional arguments).'
   task rebuild_indices: :environment do
-    SearchIndex.destroy_all
-    SearchModule.where(searchable: true).each do |m|
-      puts "Rebuilding #{m.name} indices..."
-      m.name.constantize.all.each(&:trigger_indices_save!)
+    # Default to all searchable modules
+    modules = ENV['modules']&.split(',') || SearchModule.searchable.pluck(:klass)
+
+    # A safeguard to prevent mishaps
+    modules.select! do |m|
+      SearchModule.exists?(klass: m) && # Only known modules
+        Plok::Engine.class_exists?(m.constantize) # Only existing classes
     end
+
+    # Faster than SearchIndex.where(searchable_type: modules).destroy_all
+    ActiveRecord::Base
+      .connection
+      .execute("DELETE FROM search_indices WHERE searchable_type in ('#{modules.join("','")}')")
+
+    SearchModule.where(klass: modules).each do |m|
+      puts "Rebuilding #{m.klass} indices..."
+      m.klass.constantize.all.each(&:trigger_indices_save!)
+    end
+
     puts "Done."
   end
 end

data/spec/factories/search_modules.rb

@@ -1,5 +1,5 @@
 FactoryBot.define do
   factory :search_module do
-    name { 'Page' }
+    klass { 'Page' }
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plok
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.1
 platform: ruby
 authors:
 - Davy Hellemans
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-28 00:00:00.000000000 Z
+date: 2022-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -104,6 +104,15 @@ files:
 - db/migrate/20220512142356_add_index_to_queued_task_weight.rb
 - db/migrate/20220923162300_create_search_indices.rb
 - db/migrate/20220923164100_create_search_modules.rb
+- db/migrate/20221021133242_rename_name_to_klass_for_search_modules.rb
+- db/migrate/20221031143932_add_namespace_to_search_indices.rb
+- lib/generators/plok/search/USAGE
+- lib/generators/plok/search/class_generator.rb
+- lib/generators/plok/search/result_object_generator.rb
+- lib/generators/plok/search/templates/namespace_class.rb
+- lib/generators/plok/search/templates/namespace_class_spec.rb
+- lib/generators/plok/search/templates/result_object.html.erb
+- lib/generators/plok/search/templates/result_object.rb
 - lib/generators/plok/sidebar/USAGE
 - lib/generators/plok/sidebar/sidebar_generator.rb
 - lib/generators/plok/sidebar/templates/_menu_item.html.erb
@@ -112,7 +121,6 @@ files:
 - lib/generators/plok/sidebar/templates/_wrapper.html.erb
 - lib/plok.rb
 - lib/plok/engine.rb
-- lib/plok/search/backend.rb
 - lib/plok/search/base.rb
 - lib/plok/search/result_objects/base.rb
 - lib/plok/search/term.rb

data/lib/plok/search/backend.rb

@@ -1,22 +0,0 @@
-# Due to the load order of classes, Backend precedes the required Base class.
-require_relative 'base'
-
-module Plok::Search
-  # The goal of this class is to provide a manipulated version of the filtered
-  # index data that we can use in the result set of an autocomplete-triggered
-  # search query. See Plok::Search::Base for more information on how this
-  # search functionality is designed.
-  class Backend < Plok::Search::Base
-    # This translates the filtered indices into meaningful result objects.
-    # These require a { label: ... value: ... } to accommodate jquery-ui.
-    #
-    # Note that the result_object#url method is defined in
-    # Plok::Search::ResultObjects::Backend::Page.
-    def search
-      indices.map do |index|
-        result = result_object(index)
-        { label: result.build_html, value: result.url }
-      end
-    end
-  end
-end