如何在没有数据库的情况下将静态页面的搜索功能添加到 Ruby on Rails 应用程序？

Question

任何人都知道关于如何在 Rails 应用程序中索引静态页面以添加搜索功能的任何优秀 gem 或文档？到目前为止，我的搜索将我带到了 Sunspot 和 Cobweb，但两者似乎都比我想要实现的要复杂一些。

这是我的视图目录外观的示例：

views
|
|__Folder_1
   |
   |__ View-1
   |__ View-2
   |
   Folder_2
   |
   |__ View-3
   |__ View-4

每个文件夹都是一个控制器，其视图作为定义的操作，如果在考虑如何设置它时有任何区别。最终目标是返回包含搜索词的页面的链接列表。

编辑：

每个搜索查询都旨在爬取所有静态页面的 HTML 内容，并返回与所搜索的任何非停用词词匹配的页面的链接列表。我还计划根据静态页面中搜索词的频率和单词放置来增加搜索的相关性。

例子：

搜索查询：“炒鸡蛋的食谱” - 将返回包含“recipe”、“scrambled”和“eggs”字样的任何页面的链接，其中最相关的链接位于返回列表的顶部：

Search Results:
Page 1 (Most relevant because includes all 3 terms)
Page 2 (Includes 2 terms)
Page 3 (Includes 1 terms)

最好，搜索功能只尝试将搜索词与每个视图的文本匹配，这样如果用户输入“div”作为搜索词，它就不会返回每个页面，因为 div 元素存在于 HTML 内容中。

答案：

在学习 Ruby 几周后，这就是我想出的 - 基本上我正在过滤 /app/views/ 目录中的每个子目录，读取子目录内容中的每个文件，处理文本删除 HTML 标记和常用停用词，并将其存储在搜索索引哈希中。

search_controller.rb

#include sanitize helper to enable use of strip_tags method in controller
include ActionView::Helpers::SanitizeHelper

class SearchController < ApplicationController

  prepend_before_filter :search

  def search
    if params[:q]
      stopwords = ["a", "about", "above", "after", "again", "against", "all", "am", "an", "and", "any", "are", "aren't", "as", "at", "be", "because", "been", "before", "being", "below", "between", "both", "but", "by", "can't", "cannot", "could", "couldn't", "did", "didn't", "do", "does", "doesn't", "doing", "don't", "down", "during", "each", "few", "for", "from", "further", "had", "hadn't", "has", "hasn't", "have", "haven't", "having", "he", "he'd", "he'll", "he's", "her", "here", "here's", "hers", "herself", "him", "himself", "his", "how", "how's", "i", "i'd", "i'll", "i'm", "i've", "if", "in", "into", "is", "isn't", "it", "it's", "its", "itself", "let's", "me", "more", "most", "mustn't", "my", "myself", "no", "nor", "not", "of", "off", "on", "once", "only", "or", "other", "ought", "our", "ours", "ourselves", "out", "over", "own", "same", "shan't", "she", "she'd", "she'll", "she's", "should", "shouldn't", "so", "some", "such", "than", "that", "that's", "the", "their", "theirs", "them", "themselves", "then", "there", "there's", "these", "they", "they'd", "they'll", "they're", "they've", "this", "those", "through", "to", "too", "under", "until", "up", "very", "was", "wasn't", "we", "we'd", "we'll", "we're", "we've", "were", "weren't", "what", "what's", "when", "when's", "where", "where's", "which", "while", "who", "who's", "whom", "why", "why's", "with", "won't", "would", "wouldn't", "you", "you'd", "you'll", "you're", "you've", "your", "yours", "yourself"]
      #cleanse all stop words from search query
      @search_terms = strip_tags(params[:q]).downcase.split.delete_if{|x| stopwords.include?(x)}

      #declare empty index hash
      @search_index = {}

      #filter through each view and add view text to search entry
      Rails.root.join('app', "views").entries.each do |view_dir| 
        unless %w(. .. search shared layouts).include?(view_dir.to_s) 
          Rails.root.join('app', "views", view_dir.to_s).entries.each do |view| 
            unless %w(. ..).include?(view.to_s)
              #add relative path for view and processed contents to search index hash as key, value pair
              @search_index["/" + view_dir.to_s + "/" + view.to_s.gsub('.html.erb', '')] = strip_tags(IO.read(Rails.root.join('app', "views", view_dir.to_s, view.to_s))).downcase.squish.split.delete_if{|x| stopwords.include?(x)}.join(" ")
            end
          end
        end
      end

    end
  end

end

如果有人有任何改进或建议，我很乐意听取他们的意见！

Answer 1

如果您有预定义的搜索词列表及其匹配的视图，则可以使用硬编码词索引实现静态页面搜索功能的受限版本：

# app/controllers/searches_controller.rb
class SearchesController < ApplicationController
  def index
    query = params[:query]

    # Convert query string to lowercase tokens, e.g. 
    # /search?query=cAT+aNd+doG => ['cat', 'and', 'dog']
    terms = query.downcase.split

    # Match each search term against the index, collecting all matching pages.
    @pages = terms.collect do |term|
      get_search_index[term]
    end

    # Remove nil objects resulting from terms not matching anything.
    @pages.compact!

    # Flatten all nested arrays into one array of pages for easy looping.
    @pages.flatten!
  end

  private
    def get_search_index
      @@index ||= {
        "homepage" => [
          {:path => root_path, :name => "Home"}
        ],
        "home" => [
          {:path => root_path, :name => "Home"}
        ],
        "user" => [
          {:path => new_user_path, :name => "Create New User"}, 
          {:path => users_path, :name => "User Index"}
        ]
      }
    end
end

现在来看：

# app/views/searches/index.html.erb
Search results:
<ol>
<% @pages.each do |page| %>
    <li><%= link_to page[:name], page[:path] %></li>
<% end %>
</ol>

现在您可以转到/searches?query=some+User+page，新的用户表单和用户索引页面都应该出现在搜索结果中（因为“用户”字词匹配）。

您也可以扩展这种静态方法以获得更精美的效果。例如，您实际上可以从静态页面中获取示例文本正文并将其拆分为术语，而不是硬编码术语。例如：

# Get a corpus, lowercase it, replace punctuation with whitespace, and tokenize.
@@homepage_terms = "Block of homepage text.".downcase.gsub(/[^a-z0-9]/, ' ').split
@@about_page_terms = "Block of about page text.".downcase.gsub(/[^a-z0-9]/, ' ').split

def get_search_index
  # Memoize the index so we only build it once.
  @@index ||= build_search_index
end

def build_search_index
  index = {}
  @@homepage_terms.each do |term|
    index[term] ||= []
    index[term] << {path: root_path, name: "Home"}
  end
  @@about_page_terms.each do |term|
    index[term] ||= []
    index[term] << {path: root_path, name: "About page"}
  end
  index
end

您的build_search_index 函数可以根据需要变得复杂且功能丰富。本质上，您正在做的是重新发明轮子。 Solr 和其他搜索后端旨在为您完成此类工作。我把排名、从磁盘读取视图文件和 HTML 清理作为读者的练习:)

如果您想要更动态的东西，即随着页面的变化而自动调整的东西，它看起来很相似，除了将通过扫描视图文件夹生成散列。但是，动态方法要复杂得多。一方面，您从哪里获得搜索结果的可读页面标题？该元数据不包含在 Rails 的任何地方。另外，你怎么知道哪些页面是 GET 页面？如果您有安全页面或不想出现在搜索结果中的页面怎么办？另外，您必须解释 ERB。在服务器端呈现静态视图并非不可能，但如果这些页面因用户而异怎么办？那么国际化呢？

像我上面给出的那样手动策划的解决方案对我来说似乎是最好的选择。如果您的网站与大多数网站一样，您的静态页面不会有太大变化，因此维护应该不是一个大问题。