effective_search 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4eebd4b86b285679dd65b0e5240bbf4c6bee508e73a38506d192529749a7b17f
-  data.tar.gz: 604f92513481a00bfc13fddc4b9e90a64e54d4068b5dd381b4e233a508d72601
+  metadata.gz: 11770692b109202d028619f343a7f20e32cf84ebb5d25862c1783af0b7247522
+  data.tar.gz: 9feec5773a0e9cb0c0f308f94d956dd68f7d92e063781d2e6a45a65359a4423a
 SHA512:
-  metadata.gz: 4b8f79bbd7181bcf238a17719f34c3d92f7294d7fd33ae2812a394eec87adec23ac01a0e5fb10c5526d898353d7a197a07ae9dc51444d3600d456ee81ee6c4a4
-  data.tar.gz: 1ebca0f4b46495d5eebd0175b7c4c8ad1a8ffea8a0f49276137a44e9add02a385d7089db906cf1214b08e05c46cacc4fac9c2d7aca52a5b2e74de3dff7617d0a
+  metadata.gz: 62b1a07b867c7ab4d071b637971d61066703053e7489487fc59dda87cb4a20f0a866085c7021e566ae7557f7e8769c871f769a4912c2d0c882ab973b5c3ddeaa
+  data.tar.gz: 2b683dcf2e40676564757a1b5ab93dd9b1a5618a8fccba94f7a24b0c88f11de4cf8a360d661c0a54a1c630dc4edee9ded771e5729154264b1a7f36970752fd52

data/app/assets/stylesheets/effective_search/base.scss

@@ -29,3 +29,29 @@ div.effective-search {
     background-position: calc(100% - 0.75rem) center !important;
   }
 }
+
+// Search contents
+.search-content {
+  box-shadow: 0px 3px 16px #00000029 !important;
+  border-radius: 0.25rem !important;
+  margin-bottom: 3rem;
+}
+
+.search-content-title {
+  font-size: 1.75rem;
+  margin-bottom: 0.5rem;
+}
+
+.search-content-image {
+  min-width: 300px;
+  min-height: 300px;
+}
+
+.search-content-body {
+  padding: 30px;
+}
+
+.search-content-link {
+  font-weight: 700;
+  text-decoration: none;
+}

data/app/controllers/admin/search_contents_controller.rb

@@ -0,0 +1,13 @@
+module Admin
+  class SearchContentsController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_search) }
+
+    include Effective::CrudController
+
+    def permitted_params
+      params.require(:effective_search_content).permit!
+    end
+
+  end
+end

data/app/datatables/admin/effective_search_contents_datatable.rb

@@ -0,0 +1,23 @@
+module Admin
+  class EffectiveSearchContentsDatatable < Effective::Datatable
+    datatable do
+      order :updated_at, :desc
+
+      col :id, visible: false
+      col :created_at, visible: false
+      col :updated_at, visible: false
+
+      col :title
+      col :url
+      col :keywords
+      col :rich_text_body, label: 'Body', visible: false
+      col :file, visible: false
+
+      actions_col
+    end
+
+    collection do
+      Effective::SearchContent.deep.all
+    end
+  end
+end

data/app/models/concerns/effective_search_search.rb

@@ -30,6 +30,11 @@ module EffectiveSearchSearch
     nil
   end
 
+  # These classes should not be searched
+  def unsearchable_types
+    ['Effective::Permalink', 'Effective::SearchContent']
+  end
+
   def per_page
     24
   end
@@ -47,6 +52,18 @@ module EffectiveSearchSearch
     @search_results
   end
 
+  # This is Set #1 of results we display on the search page
+  def search_contents
+    return [] unless present?
+    @search_contents ||= Effective::Resource.new(Effective::SearchContent.deep).search_any(term, columns: [:keywords])
+  end
+
+  # This is Set #2 of results we display on the search page
+  def permalinks
+    return [] unless present?
+    @permalinks ||= Effective::Resource.new(Effective::Permalink.deep).search_any(term, columns: [:title, :summary])
+  end
+
   # The unpaginated results of the search
   def search_results
     @search_results || []
@@ -62,9 +79,7 @@ module EffectiveSearchSearch
 
   # View helper
   def authorized?(result)
-    raise('expected a PgSearch::Document') unless result.kind_of?(PgSearch::Document)
-
-    searchable = result.searchable
+    searchable = result.try(:searchable) || result
 
     return false if searchable.blank?
     return false if searchable.try(:draft?)
@@ -79,7 +94,7 @@ module EffectiveSearchSearch
 
   # View helper
   def title(result)
-    (result.try(:searchable).try(:title) || result.to_s).html_safe
+    (result.try(:searchable).try(:title) || result.try(:title) || result).to_s.html_safe
   end
 
   # View helper
@@ -89,7 +104,7 @@ module EffectiveSearchSearch
 
   # View helper
   def body(result)
-    content = result.try(:pg_search_highlight) || result.to_s
+    content = (result.try(:pg_search_highlight) || result.try(:rich_text_body) || result).to_s
     scrubs.each { |pattern| content.gsub!(pattern, '') }
     content.html_safe
   end
@@ -120,6 +135,10 @@ module EffectiveSearchSearch
       collection = collection.where(searchable_type: searchable_types)
     end
 
+    if unsearchable_types.present?
+      collection = collection.where.not(searchable_type: unsearchable_types)
+    end
+
     # Preload what we need
     collection = collection.includes(searchable: [:rich_text_body])
 
@@ -129,7 +148,9 @@ module EffectiveSearchSearch
 
   # Sort of a view helper. The result is passed through here
   def effective_path(result)
-    case result.searchable_type
+    class_name = result.try(:searchable_type) || result.class.name
+
+    case class_name
     when 'Effective::Page'
       EffectivePages::Engine.routes.url_helpers.page_path(result.searchable)
     when 'Effective::Permalink'
@@ -138,6 +159,8 @@ module EffectiveSearchSearch
       EffectivePosts::Engine.routes.url_helpers.post_path(result.searchable)
     when 'Effective::Event'
       EffectiveEvents::Engine.routes.url_helpers.event_path(result.searchable)
+    when 'Effective::SearchContent'
+      result.url
     end
   end
 

data/app/models/effective/search_content.rb

@@ -0,0 +1,42 @@
+# Provides content areas that will be displayed for specific search terms
+
+module Effective
+  class SearchContent < ActiveRecord::Base
+    self.table_name = (EffectiveSearch.search_contents_table_name || :search_contents).to_s
+
+    # For the body
+    has_many_rich_texts
+
+    has_one_attached :file
+    has_one_purgable :file
+
+    log_changes if respond_to?(:log_changes)
+
+    effective_resource do
+      title          :string
+      url            :string
+      keywords       :string
+
+      timestamps
+    end
+
+    validates :title, presence: true
+    validates :url, presence: true, url: true
+    validates :keywords, presence: true
+
+    validates :file, content_type: :image
+    validates :file, size: { less_than: 2.megabytes }
+
+    scope :deep, -> { with_attached_file.includes(:rich_texts) }
+    scope :sorted, -> { order(:title) }
+
+    def to_s
+      title.presence || model_name.human
+    end
+
+    # As per has_many_rich_texts
+    def body
+      rich_text_body
+    end
+  end
+end

data/app/views/admin/search_contents/_form.html.haml

@@ -0,0 +1,7 @@
+= tabs do
+  = tab 'Search Content' do
+    = render '/admin/search_contents/form_search_content', search_content: search_content
+
+  - if search_content.persisted?
+    = tab 'Logs' do
+      = render_datatable(search_content.log_changes_datatable, inline: true, namespace: :admin)

data/app/views/admin/search_contents/_form_search_content.html.haml

@@ -0,0 +1,13 @@
+= effective_form_with(model: [:admin, search_content], engine: true) do |f|
+  = f.text_field :title
+  = f.url_field :url, hint: 'The URL of the page to link to'
+  = f.text_field :keywords, hint: 'A comma separated list of keywords'
+
+  - if defined?(EffectiveArticleEditor)
+    = f.article_editor :rich_text_body, label: 'Body', hint: 'The main content'
+  - else
+    = f.rich_text_area :rich_text_body, label: 'Body', hint: 'The main content'
+
+  = f.file_field :file, label: 'Attachment', hint: 'Upload an image to display on this search content'
+
+  = effective_submit(f)

data/app/views/effective/search/_form.html.haml

@@ -1,5 +1,7 @@
 = effective_form_with(scope: :q, model: search, method: :get, url: effective_search.search_path) do |f|
-  = f.text_field :term, label: 'Search'
+  .row
+    .col-lg-4
+      = f.text_field :term, label: false, placeholder: 'Search', autofocus: true, class: "py-4 px-3 shadow-sm border-0"
 
-  = f.save('Search', class: 'btn btn-primary btn-search mr-3', name: nil)
-  = link_to 'Reset', request.path
+  -# = f.save('Search', class: 'btn btn-primary btn-search mr-3', name: nil)
+  -# = link_to 'Reset', request.path

data/app/views/effective/search/_search.html.haml

@@ -5,13 +5,32 @@
     %hr
 
     - results = search.results(page: params[:page])
+    - search_contents = search.search_contents.select { |resource| search.authorized?(resource) }
+    - permalinks = search.permalinks.select { |resource| search.authorized?(resource) }
 
-    - if results.length == 0
-      .alert.alert-info There are no results for your search. Please try again.
+    - if search_contents.present?
+      = render(collection: search_contents, partial: 'effective/search_contents/search_content', locals: { search: search })
 
-    - if results.length > 0
-      - collection = results.with_pg_search_highlight.select { |result| search.authorized?(result) }
-      = render(collection: collection, partial: 'effective/search/result', locals: { search: search })
+    .row
+      - if permalinks.present?
+        .col-xl-4.col-lg-5
+          %h3 Downloads
+          %hr.mt-0
+          %ul
+            - permalinks.each do |permalink|
+              %li= link_to(permalink.title, permalink.redirect_path, target: '_blank', title: permalink.title)
 
-    %nav.d-flex.justify-content-center
-      = bootstrap_paginate(results, per_page: search.per_page)
+      -# Search results
+      %div{class: (permalinks.present? ? 'col-xl-8 col-lg-7' : 'col')}
+        %h3 Pages
+        %hr.mt-0
+
+        - if results.length == 0
+          .alert.alert-info There are no results for your search. Please try again.
+
+        - if results.length > 0
+          - collection = results.with_pg_search_highlight.select { |result| search.authorized?(result) }
+          = render(collection: collection, partial: 'effective/search/result', locals: { search: search })
+
+        %nav.d-flex.justify-content-center
+          = bootstrap_paginate(results, per_page: search.per_page)

data/app/views/effective/search/index.html.haml

@@ -1 +1,8 @@
+.row
+  .col
+    %ol.breadcrumb
+      %li.breadcrumb-item= link_to "Home", "/"
+      %li.breadcrumb-item.active{"aria-current": "page"}= @page_title
+
+%h1= @page_title
 = render('effective/search/search', search: @search)

data/app/views/effective/search_contents/_search_content.html.haml

@@ -0,0 +1,16 @@
+.search-content.d-flex
+  - title = search.title(search_content)
+  - url = search.path(search_content)
+
+  - if search_content.file.attached?
+    = link_to(url, title: title) do
+      = image_tag(url_for(search_content.file), alt: title, class: 'img-fluid search-content-image d-none d-md-block', height: search_content.file.metadata['height'], width: search_content.file.metadata['width'])
+
+  .search-content-body
+    %h4.search-content-title= link_to(title, url, title: title)
+    = search.body(search_content)
+
+    .search-content-link
+      = link_to(url, title: title) do
+        View more
+        %span.pl-1 →

data/config/routes.rb

@@ -11,6 +11,7 @@ EffectiveSearch::Engine.routes.draw do
   end
 
   namespace :admin do
+    resources :search_contents, except: [:show]
   end
 
 end

data/db/migrate/101_create_effective_search.rb

@@ -11,6 +11,14 @@ class CreateEffectiveSearch < ActiveRecord::Migration[7.0]
       t.belongs_to :searchable, polymorphic: true, index: true
       t.timestamps null: false
     end
+
+    create_table :search_contents, if_not_exists: true do |t|
+      t.string :title
+      t.string :url
+      t.string :keywords
+
+      t.timestamps
+    end
   end
 
   def down
@@ -21,5 +29,6 @@ class CreateEffectiveSearch < ActiveRecord::Migration[7.0]
 
     # PgSearch multisearch table
     drop_table :pg_search_documents, if_exists: true
+    drop_table :search_contents, if_exists: true
   end
 end

data/lib/effective_search/version.rb

@@ -1,3 +1,3 @@
 module EffectiveSearch
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.2.1'.freeze
 end

data/lib/effective_search.rb

@@ -5,7 +5,7 @@ require 'effective_search/version'
 module EffectiveSearch
 
   def self.config_keys
-    [:search_class_name, :authenticate_user, :layout]
+    [:search_class_name, :search_contents_table_name, :authenticate_user, :layout]
   end
 
   include EffectiveGem

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: effective_search
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Code and Effect
@@ -165,16 +165,22 @@ files:
 - app/assets/javascripts/effective_search/base.js
 - app/assets/stylesheets/effective_search.scss
 - app/assets/stylesheets/effective_search/base.scss
+- app/controllers/admin/search_contents_controller.rb
 - app/controllers/effective/search_controller.rb
+- app/datatables/admin/effective_search_contents_datatable.rb
 - app/helpers/effective_search_helper.rb
 - app/models/concerns/effective_search_search.rb
 - app/models/effective/search.rb
+- app/models/effective/search_content.rb
+- app/views/admin/search_contents/_form.html.haml
+- app/views/admin/search_contents/_form_search_content.html.haml
 - app/views/effective/search/_form.html.haml
 - app/views/effective/search/_form_nav_item.html.haml
 - app/views/effective/search/_layout.html.haml
 - app/views/effective/search/_result.html.haml
 - app/views/effective/search/_search.html.haml
 - app/views/effective/search/index.html.haml
+- app/views/effective/search_contents/_search_content.html.haml
 - config/effective_search.rb
 - config/routes.rb
 - db/migrate/101_create_effective_search.rb