plok 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4281765768b325decfff165db5df09cf406e2f6d9e211f6ecdfedbfa0dfd0a9
-  data.tar.gz: b654970a986c50e67112464b33649650f9fb0e43f858d8aade49330ae1cbad60
+  metadata.gz: fe8e289922e36071642ae46ff78b49eded873476b9721668a5c9df0f8d51bd4f
+  data.tar.gz: 06ee8edde78842db587ee3e0076b9a791cd78247d9987ba07a5441bd0f03c270
 SHA512:
-  metadata.gz: 866911090a04393d7d92c618daac7dd6bb02330e939d23a654375b014c363d44c574f2948cf3cd6f7bf536c44c2ccac24086774685436054a8557cb400b05ba2
-  data.tar.gz: 89fa51203f3af3018585810f1631ef15a5f71f53dd9a0ac27a8141c929b22a57f8890d53581dcf53e1aec26af9a7f7dca7c5c730fab7bb71dc2c1a7e3c939113
+  metadata.gz: 562556d7edcf1db8f174203ba55fd3e7cf111ffdab3b1b63d0532a44f3d09d955c9ff7545e83a08e0ed7cf22dff9afd2b14fd5e0857217eae08448f47d8f2915
+  data.tar.gz: c2d565bdfdd0aae5244dd82d9e7bcd04dcb672a7cb7fcc7f8fe40bf5cdd87f3f085a4f33a51c912db353b76d633c0b53b9e5a98a40704b1d0e0d3640c78ec2de

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

@@ -16,17 +16,17 @@ module Plok::Searchable
     end
 
     def trigger_indices_save!
-      self.class.searchable_fields_list.each do |namespace, keys|
-        keys.each do |key|
-          if key == :flexible_content
+      self.class.searchable_fields_list.each do |namespace, fields|
+        fields.each do |field|
+          if field[:name] == :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!(namespace, key) && next
+          if respond_to?(:translatable?) && self.class.translatable_fields_list.include?(field[:name])
+            save_translatable_search_index!(namespace, field[:name]) && next
           end
 
-          save_search_index!(namespace, key)
+          save_search_index!(namespace, field[:name], conditions: field[:conditions])
         end
       end
     end
@@ -51,7 +51,11 @@ module Plok::Searchable
       end
     end
 
-    def save_search_index!(namespace, key, value: nil, locale: nil)
+    def save_search_index!(namespace, key, value: nil, locale: nil, conditions: [])
+      if conditions.any?
+        return unless conditions.map { |c| send(c) }.all?
+      end
+
       value = if value.present?
                 value
               elsif ActiveRecord::Base.connection.column_exists?(self.class.table_name, key)
@@ -81,18 +85,23 @@ module Plok::Searchable
   end
 
   module ClassMethods
-    def searchable_field(namespace, key)
-      return if searchable_fields_list.dig(namespace.to_sym)&.include?(key.to_sym)
+    def searchable_field(namespace, key, conditions)
+      return if !!searchable_fields_list.dig(namespace.to_sym)&.detect do |field|
+        field[:name] == key.to_sym
+      end
 
       if searchable_fields_list[namespace.to_sym].blank?
         searchable_fields_list[namespace.to_sym] = []
       end
 
-      searchable_fields_list[namespace.to_sym] << key.to_sym
+      searchable_fields_list[namespace.to_sym] << {
+        name: key.to_sym,
+        conditions: conditions
+      }
     end
 
     def plok_searchable(namespace: nil, fields: [], conditions: [])
-      fields.each { |key| searchable_field(namespace, key) }
+      fields.each { |key| searchable_field(namespace, key, conditions) }
     end
 
     def searchable_fields_list

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/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/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.1.0'
+  VERSION = '1.1.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plok
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Davy Hellemans
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-04 00:00:00.000000000 Z
+date: 2022-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -108,8 +108,11 @@ files:
 - 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