search by keyword in details and title of Content Block

This now matches keywords agains the user
generated free text on a block. Select options
will be added for Organisation, date etc.

If any other free text options were added (such as
internal instructions, description) we'd need to
add them to this keyword match here too.

lib/engines/content_block_manager/app/controllers/content_block_manager/content_block/documents_controller.rb

@@ -28,7 +28,7 @@ def new_document_options_redirect
 private
 
   def params_filters
-    params.slice(:title)
+    params.slice(:keyword)
           .permit!
           .to_h
   end

lib/engines/content_block_manager/app/models/content_block_manager/content_block/document.rb

@@ -1,7 +1,7 @@
 module ContentBlockManager
   module ContentBlock
     class Document < ApplicationRecord
-      include Scopes::SearchableByTitle
+      include Scopes::SearchableByKeyword
 
       extend FriendlyId
       friendly_id :title, use: :slugged, slug_column: :content_id_alias, routes: :default

lib/engines/content_block_manager/app/models/content_block_manager/content_block/document/document_filter.rb

@@ -7,7 +7,7 @@ def initialize(filters = {})
     def documents
       documents = ContentBlock::Document
       documents = documents.live
-      documents = documents.with_title(@filters[:title]) if @filters[:title].present?
+      documents = documents.with_keyword(@filters[:keyword]) if @filters[:keyword].present?
       documents
     end
   end

lib/engines/content_block_manager/app/models/content_block_manager/content_block/document/scopes/searchable_by_keyword.rb

@@ -0,0 +1,18 @@
+module ContentBlockManager
+  module ContentBlock::Document::Scopes::SearchableByKeyword
+    extend ActiveSupport::Concern
+
+    included do
+      scope :with_keyword,
+            lambda { |keywords|
+              split_keywords = keywords.split
+              pattern = split_keywords.map { |k|
+                escaped_word = Regexp.escape(k)
+                "(?=.*#{escaped_word})"
+              }.join
+              joins(:latest_edition)
+                .where("content_block_documents.title REGEXP :pattern OR content_block_editions.details REGEXP :pattern", pattern:)
+            }
+    end
+  end
+end

lib/engines/content_block_manager/app/views/content_block_manager/content_block/documents/_filter_options.html.erb

@@ -1,13 +1,13 @@
 <%= form_with url: content_block_manager.content_block_manager_content_block_documents_path, method: :get do %>
     <%= render "govuk_publishing_components/components/input", {
       label: {
-        text: "Title",
+        text: "Keyword",
         bold: true,
       },
       hint: 'For example, "driving standards"',
-      name: "title",
-      id: "title_filter",
-      value: [email protected]? && @filters[:title],
+      name: "keyword",
+      id: "keyword_filter",
+      value: [email protected]? && @filters[:keyword],
     } %>
 
   <%= render "govuk_publishing_components/components/button", {

lib/engines/content_block_manager/features/search_for_object.feature

@@ -6,13 +6,24 @@ Feature: Search for a content object
     And a schema "email_address" exists with the following fields:
       | email_address |
     And an email address content block has been created
-    And an email address content block has been created with the title "example search title"
+    And an email address content block has been created with the following email address and title:
+      | title                  |  "example search title" |
+      | email_address          |  "ministry@justice.com" |
 
   Scenario: GDS Editor searches for a content object by keyword in title
     When I visit the Content Block Manager home page
     Then I should see the details for all documents
     And "2" content blocks are returned
-    When I enter the title "example search"
+    When I enter the keyword "example search"
+    And I click to view results
+    Then I should see the content block with title "example search title" returned
+    And "1" content blocks are returned
+
+  Scenario: GDS Editor searches for a content object by keyword in details
+    When I visit the Content Block Manager home page
+    Then I should see the details for all documents
+    And "2" content blocks are returned
+    When I enter the keyword "ministry justice"
     And I click to view results
     Then I should see the content block with title "example search title" returned
     And "1" content blocks are returned

lib/engines/content_block_manager/features/step_definitions/content_block_manager_steps.rb

@@ -187,16 +187,17 @@
   @content_blocks.push(@content_block)
 end
 
-Given("an email address content block has been created with the title {string}") do |title|
+Given("an email address content block has been created with the following email address and title:") do |table|
+  fields = table.rows_hash
   @content_blocks ||= []
   @email_address = "[email protected]"
   organisation = create(:organisation)
-  document = create(:content_block_document, :email_address, title:)
+  document = create(:content_block_document, :email_address, title: fields[:title])
   @content_block = create(
     :content_block_edition,
     :email_address,
     document:,
-    details: { email_address: @email_address },
+    details: { email_address: fields[:email_address] },
     creator: @user,
     organisation:,
   )
@@ -476,8 +477,8 @@ def should_show_edit_form_for_email_address_content_block(document_title, email_
   fill_in_date_and_time_field(past_date)
 end
 
-When("I enter the title {string}") do |title|
-  fill_in "Title", with: title
+When("I enter the keyword {string}") do |keyword|
+  fill_in "Keyword", with: keyword
 end
 
 Then("the edition should have been scheduled successfully") do

lib/engines/content_block_manager/test/unit/app/models/content_block_edition/document/document_filter_test.rb

@@ -8,18 +8,18 @@ class ContentBlockManager::DocumentFilterTest < ActiveSupport::TestCase
       it "returns live documents" do
         document_scope_mock = mock
         ContentBlockManager::ContentBlock::Document.expects(:live).returns(document_scope_mock)
-        document_scope_mock.expects(:with_title).never
+        document_scope_mock.expects(:with_keyword).never
 
         ContentBlockManager::ContentBlock::Document::DocumentFilter.new({}).documents
       end
     end
 
-    describe "when a title filter is given" do
-      it "returns live documents with keyword in title" do
+    describe "when a keyword filter is given" do
+      it "returns live documents with keyword" do
         document_scope_mock = mock
         ContentBlockManager::ContentBlock::Document.expects(:live).returns(document_scope_mock)
-        document_scope_mock.expects(:with_title).returns([])
-        ContentBlockManager::ContentBlock::Document::DocumentFilter.new({ title: "ministry of example" }).documents
+        document_scope_mock.expects(:with_keyword).with("ministry of example").returns([])
+        ContentBlockManager::ContentBlock::Document::DocumentFilter.new({ keyword: "ministry of example" }).documents
       end
     end
   end

lib/engines/content_block_manager/test/unit/app/models/content_block_edition/document/scopes/searchable_by_keyword_test.rb

@@ -0,0 +1,52 @@
+require "test_helper"
+
+class ContentBlockManager::SearchableByKeywordTest < ActiveSupport::TestCase
+  extend Minitest::Spec::DSL
+
+  describe ".with_keyword" do
+    test "should find documents with title containing keyword" do
+      document_with_first_keyword = create(:content_block_document, :email_address, title: "klingons and such")
+      _edition_with_first_keyword = create(:content_block_edition,
+                                           :email_address,
+                                           document: document_with_first_keyword,
+                                           details: { "email_address" => "[email protected]" })
+      document_without_first_keyword = create(:content_block_document, :email_address, title: "this document is about muppets")
+      _edition_without_first_keyword = create(:content_block_edition, :email_address, document: document_without_first_keyword)
+      assert_equal [document_with_first_keyword], ContentBlockManager::ContentBlock::Document.with_keyword("klingons")
+    end
+
+    test "should find documents with title containing keywords not in order" do
+      document_with_first_keyword = create(:content_block_document, :email_address, title: "klingons and such")
+      _edition_with_first_keyword = create(:content_block_edition,
+                                           :email_address,
+                                           document: document_with_first_keyword,
+                                           details: { "email_address" => "[email protected]" })
+      _document_without_first_keyword = create(:content_block_document, :email_address, title: "muppets and such")
+      assert_equal [document_with_first_keyword], ContentBlockManager::ContentBlock::Document.with_keyword("such klingons")
+    end
+
+    test "should find documents with latest edition's details containing keyword" do
+      document_with_first_keyword = create(:content_block_document, :email_address, title: "example title")
+      _edition_with_first_keyword = create(:content_block_edition,
+                                           document: document_with_first_keyword,
+                                           details: { "foo" => "Foo text", "bar" => "Bar text" })
+      document_without_first_keyword = create(:content_block_document, :email_address, title: "this document is about muppets")
+      _edition_without_first_keyword = create(:content_block_edition,
+                                              document: document_without_first_keyword,
+                                              details: { "something" => "something" })
+      assert_equal [document_with_first_keyword], ContentBlockManager::ContentBlock::Document.with_keyword("foo bar")
+    end
+
+    test "should find documents with details or title containing keyword" do
+      document_with_keyword_in_details = create(:content_block_document, :email_address, title: "example title")
+      _edition_with_keyword = create(:content_block_edition,
+                                     document: document_with_keyword_in_details,
+                                     details: { "foo" => "Foo text", "bar" => "Bar text" })
+      document_with_keyword_in_title = create(:content_block_document, :email_address, title: "this document is about bar foo")
+      _edition_without_keyword = create(:content_block_edition,
+                                        document: document_with_keyword_in_title,
+                                        details: { "something" => "something" })
+      assert_equal [document_with_keyword_in_details, document_with_keyword_in_title], ContentBlockManager::ContentBlock::Document.with_keyword("foo bar")
+    end
+  end
+end