card-mod-fulltext 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 93a52bd07ccc0265fd84b336b56756dd8a4ef2aa2b8e5152b4f44e4f453b2492
+  data.tar.gz: def54ecc50932efc833d39b2f6657c5c67ba3f18d28ee9039b17fb26a21f207c
+SHA512:
+  metadata.gz: 005e152195747735d7dcda0622790d165bcc6564cbc1174efcce62651721005de2cf42669df721c2b8bc38ee7deb78ea0d3dc12a6e357e3c8c28427abba8ef95
+  data.tar.gz: fa89c31f7e9581f5441328c52552685f6153e29308a279953a477ab712f85faf6a12aee121eb12f2e692fdd2ae2814b89d9c319a1542854da90c362957b1dc03

data/README.md

@@ -0,0 +1,44 @@
+<!--
+# @title README - mod: fulltext
+-->
+
+# Fulltext mod
+
+This mod adds MySQL fulltext support for card searches.
+
+It does so by adding a `search_content` field to the cards table and indexing the
+`name` and `search_content` fields.
+
+For simple cards, the `search_content` simply duplicates the `db_content` field (which
+contains default card content). But the fulltext search becomes much more powerful if
+the `search_content` is customized for different sets, often by including the content of
+select related cards.
+
+## CQL
+
+This mod adds support for fulltext matching in card queries, eg:
+
+    fulltext_match: "MYKEYWORD"
+
+Alternatively, you can trigger a fulltext match using a `:` prefix with a standard
+match statement.
+
+    match: ":MYKEYWORD"
+
+It also adds support for relevance sorting:
+
+    sort: "relevance"
+
+## Sets
+
+### Abstract::SearchContentFields
+
+After including this set, you can add a `#search_content_field_codes` method that returns
+a list of codenames. The `#search_content` field will be populated by concatenating
+the content of those fields.
+
+### Abstract::NoSearchContent
+
+With this set, the `search_content` will be blank (and fulltext matching will be use
+only the name field)
+

data/db/migrate/20200302171011_add_fulltext_indexing.rb

@@ -0,0 +1,11 @@
+class AddFulltextIndexing < ActiveRecord::Migration[6.0]
+  def up
+    add_column :cards, :search_content, :text, limit: 1.megabyte
+    add_index :cards, %i[name search_content],
+              name: "name, search_content_index", type: :fulltext
+  end
+
+  def down
+    remove_column :cards, :search_content
+  end
+end

data/lib/card/query/card_query/full_text_matching.rb

@@ -0,0 +1,67 @@
+
+class Card
+  module Query
+    attributes[:fulltext_match] = :relational
+
+    class CardQuery
+      # handle `fulltext_match` condition in card queries
+      module FullTextMatching
+        def fulltext_match value
+          return if value.strip.empty?
+          if prefixed_match? value
+            name_match value
+          else
+            add_condition Value.new([:match, ":#{value}"], self).to_sql(:name)
+          end
+        end
+
+        def prefixed_match? value
+          value.match?(/^[\~\:\=]/)
+        end
+      end
+    end
+
+    class SqlStatement
+      # handle `fulltext_match` relevance sorting in card queries
+      module FullTextOrdering
+        # when there is full text matching in the where clause,
+        # the default ordering is by relevance, so we just need to
+        # make sure there is no explicit order by clause
+        def order
+          super unless order_config == "relevance"
+        end
+
+        # Note: the more explicit route (which will be necessary if we want to support
+        # relevance as one of multiple sort options), is to do something like
+        # select MATCH (x) AGAINST (y) as relevance... order by relevance desc
+      end
+      include FullTextOrdering
+    end
+
+    class Value
+      def self.match_prefices
+        @match_prefices ||= %w[= ~ :]
+      end
+
+      module FullTextValue
+        def match_sql _field
+          return super unless fulltext_match_term?
+          "MATCH (#{fulltext_fields}) AGAINST (#{quote match_term} #{fulltext_mode})"
+        end
+
+        def fulltext_match_term?
+          match_prefix.match? ":"
+        end
+
+        def fulltext_fields
+          %i[search_content name].map { |fld| "#{@query.table_alias}.#{fld}" }.join ", "
+        end
+
+        def fulltext_mode
+          match_prefix == "::" ? "IN BOOLEAN MODE" : ""
+        end
+      end
+      include FullTextValue
+    end
+  end
+end

data/set/abstract/filter.rb

@@ -0,0 +1,27 @@
+format do
+  def sort_options
+    handling_fulltext do
+      # TODO: make it possible to use super here
+      { "Alphabetical": :name, "Recently Added": :create }
+    end
+  end
+
+  private
+  # This only shows relevance sorting when the page is loaded with an explicit
+  # fulltext prefix (:) in the name search. Otherwise "relevance" sorting doesn't
+  # make sense.
+  def handling_fulltext
+    options = yield
+    add_sort_by_relevance options if fulltext_name_filtering?
+    options
+  end
+
+  def add_sort_by_relevance options
+    options["Relevance"] = :relevance
+    params[:sort] = :relevance unless sort_param
+  end
+
+  def fulltext_name_filtering?
+    params.dig(:filter, :name)&.match?(/^\:/)
+  end
+end

data/set/abstract/no_search_content.rb

@@ -0,0 +1,3 @@
+def content_for_search
+  nil
+end

data/set/abstract/search_content_fields.rb

@@ -0,0 +1,15 @@
+def content_for_search
+  content_for_search_from_fields
+end
+
+def search_content_cards
+  search_content_field_codes.map do |code|
+    fetch code, new: {}
+  end.compact
+end
+
+def search_content_field_names
+  search_content_field_codes.map do |code|
+    name.trait_name code
+  end
+end

data/set/all/search_content.rb

@@ -0,0 +1,45 @@
+event :set_search_content, after: :set_content do
+  self.search_content = tagless { content_for_search.to_s }
+end
+
+event :trigger_left_search_content_update, after: :set_search_content do
+  return unless name.compound?
+  l = left
+
+  return unless l&.real? && l.search_content_field_names&.include?(name)
+
+  l.set_search_content
+  l.save if l.search_content_changed?
+end
+
+def tagless
+  ::ActionView::Base.full_sanitizer.sanitize yield
+end
+
+def name_for_search
+  name
+end
+
+def content_for_search
+  structure ? content_for_search_from_fields : content
+end
+
+def search_content_cards
+  return [] unless structure && nest_chunks
+
+  nest_chunks.map(&:referee_card).compact
+end
+
+def search_content_field_names
+  search_content_cards.map(&:name)
+end
+
+def content_for_search_from_fields
+  search_content_cards.map(&:content).compact.join "\n"
+end
+
+format do
+  view :search_content do
+    card.search_content
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: card-mod-fulltext
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Philipp Kühl
+- Ethan McCutchen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: card
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- info@decko.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- db/migrate/20200302171011_add_fulltext_indexing.rb
+- lib/card/query/card_query/full_text_matching.rb
+- set/abstract/filter.rb
+- set/abstract/no_search_content.rb
+- set/abstract/search_content_fields.rb
+- set/all/search_content.rb
+homepage: http://decko.org
+licenses:
+- GPL-3.0
+metadata:
+  card-mod: fulltext
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.28
+signing_key:
+specification_version: 4
+summary: MySQL fulltext searches for decko
+test_files: []