Add initial search feature

Can search pages through their titles and block attributes

Author: rsmithlal

app/assets/stylesheets/better_together/navigation.scss

@@ -2,3 +2,8 @@
 #main-nav {
   z-index: 500;
 }
+
+#navbarSearch {
+  transition: height 0.3s ease;
+}
+

app/concerns/better_together/searchable.rb

@@ -0,0 +1,30 @@
+# app/models/concerns/searchable.rb
+
+module BetterTogether
+  # Enables ElasticSearch
+  module Searchable
+    extend ActiveSupport::Concern
+  
+    included do
+      include Elasticsearch::Model
+      include Elasticsearch::Model::Callbacks
+
+      after_commit :index_document, if: :persisted?
+      after_commit on: [:destroy] do
+        __elasticsearch__.delete_document
+      end
+
+      # Need to create another way to access elasticsearch import.
+      # class.import is using by activerecord-import, I think
+      def self.elastic_import
+        __elasticsearch__.import
+      end
+    end
+
+    private
+
+    def index_document
+      __elasticsearch__.index_document
+    end
+  end
+end

app/controllers/better_together/search_controller.rb

@@ -0,0 +1,12 @@
+ module BetterTogether
+  class SearchController < ApplicationController
+    def search
+      @query = params[:q]
+      if @query.present?
+        @results = BetterTogether::Page.search(@query).records
+      else
+        @results = []
+      end
+    end
+  end
+ end

app/models/better_together/content/block.rb

@@ -6,6 +6,7 @@ module BetterTogether
   module Content
     # Base class from which all other content blocks types inherit
     class Block < ApplicationRecord
+      include Searchable
       include ::Storext.model
 
       has_many :page_blocks, dependent: :destroy

app/models/better_together/page.rb

@@ -6,6 +6,7 @@ class Page < ApplicationRecord
     include Identifier
     include Protected
     include Privacy
+    include Searchable
 
     PAGE_LAYOUTS = [
       'layouts/better_together/page',
@@ -14,12 +15,33 @@ class Page < ApplicationRecord
 
     has_many :page_blocks, -> { positioned }, dependent: :destroy, class_name: 'BetterTogether::Content::PageBlock'
     has_many :blocks, through: :page_blocks
+    has_many :image_blocks, -> { where(type: 'BetterTogether::Content::Image') }, through: :page_blocks, source: :block
+    has_many :rich_text_blocks, -> { where(type: 'BetterTogether::Content::RichText') }, through: :page_blocks, source: :block
 
     accepts_nested_attributes_for :page_blocks, allow_destroy: true
 
     translates :title, type: :string
     translates :content, backend: :action_text
 
+    settings index: { number_of_shards: 1 } do
+      mappings dynamic: 'false' do
+        indexes :title, as: 'title'
+        indexes :content, as: 'content'
+        indexes :rich_text_content, type: 'nested' do
+          indexes :body, type: 'text'
+        end
+
+        indexes :blocks, type: 'nested' do
+          indexes :rich_text_content, type: 'nested' do
+            indexes :body, type: 'text'
+          end
+          indexes :rich_text_translations, type: 'nested' do
+            indexes :body, type: 'text'
+          end
+        end
+      end
+    end
+
     slugged :title, min_length: 1
 
     # Validations
@@ -30,6 +52,25 @@ class Page < ApplicationRecord
     scope :published, -> { where.not(published_at: nil) }
     scope :by_publication_date, -> { order(published_at: :desc) }
 
+    # Customize the data sent to Elasticsearch for indexing
+    def as_indexed_json(options = {})
+      self.as_json(
+        methods: [:title, :content, *self.class.localized_attribute_list],
+        
+        include: {
+          rich_text_content: { only: :body },
+          image_blocks: {
+
+          },
+          rich_text_blocks: {
+            include: {
+              rich_text_content: { only: :body }
+            }
+          }
+        }
+      )
+    end
+
     def published?
       published_at.present? && published_at < Time.zone.now
     end

app/views/better_together/search/search.html.erb

@@ -0,0 +1,29 @@
+<!-- app/views/pages/search.html.erb -->
+
+<div class="container mt-4">
+  <!-- Search Results -->
+  <% if @query.present? %>
+    <h2>Search Results for "<%= @query %>"</h2>
+
+    <% if @results.any? %>
+      <table class="table table-striped mt-3">
+        <thead>
+          <tr>
+            <th>Title</th>
+            <th>Content</th>
+          </tr>
+        </thead>
+        <tbody>
+          <% @results.each do |result| %>
+            <tr>
+              <td><%= link_to result.title, render_page_path(result.slug) %></td>
+              <td><%= truncate(strip_tags(result.content.to_s), length: 100) %></td>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+    <% else %>
+      <p>No results found for "<%= @query %>". Please try another search term.</p>
+    <% end %>
+  <% end %>
+</div>

app/views/better_together/shared/_search_bar.html.erb

@@ -0,0 +1,8 @@
+<!-- app/views/better_together/shared/_search_bar.html.erb -->
+<!-- Search Form -->
+<%= form_with url: search_path, method: :get do %>
+  <div class="input-group">
+    <%= text_field_tag :q, params[:q], class: 'form-control', placeholder: 'Search for pages...' %>
+    <button type="submit" class="btn btn-primary"><i class="fas fa-search"></i> Search</button>
+  </div>
+<% end %>

app/views/layouts/better_together/_header.html.erb

@@ -23,6 +23,13 @@
           <%= render 'better_together/navigation_items/navigation_items', navigation_items: platform_host_nav_items %>
         <% end %>
 
+        <!-- Search Icon -->
+        <li class="nav-item">
+          <a class="nav-link" href="#" data-bs-toggle="collapse" data-bs-target="#navbarSearch" aria-expanded="false" aria-controls="navbarSearch">
+            <i class="fas fa-search"></i>
+          </a>
+        </li>
+
         <!-- User Auth Nav Item -->
         <% if user_signed_in? %>
           <li class="nav-item">
@@ -55,3 +62,10 @@
     </div>
   </div>
 </nav>
+
+<!-- Hidden Search Form below navbar -->
+<div class="collapse <%= 'show' if current_page?(search_path) %>" id="navbarSearch">
+  <div class="container mt-3">
+    <%= render 'better_together/shared/search_bar' %>
+  </div>
+</div>

config/routes.rb

@@ -30,7 +30,8 @@
                    sign_up: 'sign-up'
                  },
                  defaults: { format: :html, locale: I18n.locale }
-
+      
+      get 'search', to: 'search#search'
       authenticated :user do # rubocop:todo Metrics/BlockLength
         resources :communities, only: %i[index show]
         resources :conversations, only: %i[index new create show] do