iron-cms 0.13.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df1628d66898cfa63c2b67f3c56356c2a54ab28e9dda6847bd09e8d858387faf
-  data.tar.gz: fed29be07cb73783aa5c17d985dd80601657fd82ed73924eac39a00d2eb83122
+  metadata.gz: 579a71fed1f35c24d51560f6055a00ab5d8072b6f2ff934e64a80363f86a6690
+  data.tar.gz: 3d512392984fa15623c10c13dc06500a4f839966404f12849f55ce3cf894031b
 SHA512:
-  metadata.gz: ad72aa423676395f52e94681ea4a0d273338fdea905a82d8251ded0fe724b7b9ec36fef7188fe5cb839ac5fbcf4702101b7fe834955b4be12ac33c20a5c26de2
-  data.tar.gz: d8690faeabdf6e02edc3756f733017e5a8eff33974202e9fc87ffc604a75801681ba8b3e30c6376a0e8ba40099cca81bc6917cc1dd3e9d35dad2c69dc3b55a10
+  metadata.gz: 3d39a0aeeaaa0a9b5e07f6fa60b4e18b078d4cdae252565a984ad54980ffc1e08ec8d2abcf9dcf7f168999fa9f68f3c7cb0b272b2dcc96f2439f90e61429724e
+  data.tar.gz: fc378916749f9802f668e61b303d86d563b2e910269cddc3b053770dca41ec1d2d5b71dbbd551756f76c90817a801bddf809e3c768ea62d60d9b9bbb716a0111

data/app/controllers/iron/field_definitions_controller.rb

@@ -42,7 +42,7 @@ module Iron
       end
 
       def field_definition_params
-        params.expect(field_definition: [ :type, :name, :handle, :rank, :allowed_values_text, :required, :file_scope, selected_presets: [], supported_block_definition_ids: [], supported_content_type_ids: [] ])
+        params.expect(field_definition: [ :type, :name, :handle, :rank, :allowed_values_text, :required, :searchable, :file_scope, selected_presets: [], supported_block_definition_ids: [], supported_content_type_ids: [] ])
       end
 
       def selected_field_definition_type

data/app/jobs/iron/reindex_search_job.rb

@@ -0,0 +1,7 @@
+module Iron
+  class ReindexSearchJob < ApplicationJob
+    def perform(field_definition)
+      field_definition.reindex_entries
+    end
+  end
+end

data/app/models/iron/entry/searchable.rb

@@ -0,0 +1,85 @@
+module Iron
+  module Entry::Searchable
+    extend ActiveSupport::Concern
+
+    SEARCH_CONTENT_LIMIT = 32.kilobytes
+
+    included do
+      has_many :search_records, dependent: :destroy
+
+      after_create_commit :reindex
+      after_update_commit :reindex
+
+      scope :search, ->(query, locale: nil) {
+        parsed = Search::Query.new(query)
+        return none if parsed.blank?
+
+        joins(:search_records)
+          .merge(SearchRecord.matching(parsed.to_s))
+          .merge(SearchRecord.for_locale(locale))
+          .distinct
+      }
+    end
+
+    def reindex
+      searchable_definitions = collect_searchable_definitions
+
+      if searchable_definitions.empty?
+        search_records.destroy_all
+        return
+      end
+
+      active_locale_ids = fields.map(&:locale_id).uniq
+      Locale.where(id: active_locale_ids).find_each do |locale|
+        title_text = title_field_for(locale)&.value
+        content_text = assemble_search_content(searchable_definitions, locale)
+
+        if title_text.present? || content_text.present?
+          SearchRecord.upsert!(
+            entry_id: id,
+            locale_id: locale.id,
+            title: title_text,
+            content: content_text,
+            created_at: created_at || Time.current
+          )
+        else
+          search_records.where(locale:).destroy_all
+        end
+      end
+
+      search_records.where.not(locale_id: active_locale_ids).destroy_all
+    end
+
+    private
+      def collect_searchable_definitions(field_definitions = content_type.field_definitions.reload, visited = Set.new)
+        field_definitions.flat_map { |fd|
+          nested = case fd
+          when FieldDefinitions::Block
+            block_def = fd.supported_block_definition
+            block_def && visited.add?(block_def.id) ? collect_searchable_definitions(block_def.field_definitions, visited) : []
+          when FieldDefinitions::BlockList
+            fd.supported_block_definitions.flat_map { |bd|
+              visited.add?(bd.id) ? collect_searchable_definitions(bd.field_definitions, visited) : []
+            }
+          else
+            []
+          end
+
+          fd.searchable? ? [ fd, *nested ] : nested
+        }
+      end
+
+      def assemble_search_content(definitions, locale)
+        definition_ids = definitions.map(&:id).to_set
+
+        matching_fields = fields.select { |f|
+          f.locale_id == locale.id && definition_ids.include?(f.definition_id)
+        }
+
+        matching_fields
+          .filter_map(&:searchable_text)
+          .join(" ")
+          .truncate_bytes(SEARCH_CONTENT_LIMIT, omission: "")
+      end
+  end
+end

data/app/models/iron/entry/titlable.rb

@@ -15,17 +15,20 @@ module Iron
     end
 
     def title
-      return default_title if title_field.blank?
+      field = title_field_for(Current.locale || Locale.default)
+      return default_title if field.blank?
 
-      title_field.value.presence || default_title
+      field.value.presence || default_title
     end
 
     private
 
-      def title_field
+      def title_field_for(locale)
         return nil unless content_type.title_field_definition.present?
 
-        @title_field ||= fields.find_by(definition: content_type.title_field_definition)
+        fields.find { |f|
+          f.definition_id == content_type.title_field_definition_id && f.locale_id == locale.id
+        }
       end
 
       def default_title

data/app/models/iron/entry.rb

@@ -1,6 +1,6 @@
 module Iron
   class Entry < ApplicationRecord
-    include Titlable, Schemable, WebPublishable, Presentable, DeepValidation, InstanceScoped, Exportable, Importable
+    include Titlable, Schemable, Searchable, WebPublishable, Presentable, DeepValidation, InstanceScoped, Exportable, Importable
 
     belongs_to :creator, class_name: "Iron::User", default: -> { Current.user }
     has_many :fields, inverse_of: :entry, dependent: :destroy

data/app/models/iron/field.rb

@@ -13,6 +13,10 @@ module Iron
       type.demodulize.underscore
     end
 
+    def searchable_text
+      nil
+    end
+
     def value
       raise "Field type '#{type}' value method not supported"
     end

data/app/models/iron/field_definition/ranked.rb

@@ -0,0 +1,10 @@
+module Iron
+  module FieldDefinition::Ranked
+    extend ActiveSupport::Concern
+
+    included do
+      has_rank scoped_by: :schemable
+      before_create :move_to_bottom
+    end
+  end
+end

data/app/models/iron/field_definition/searchable.rb

@@ -0,0 +1,54 @@
+module Iron
+  module FieldDefinition::Searchable
+    extend ActiveSupport::Concern
+
+    SEARCHABLE_TYPES = %w[Iron::FieldDefinitions::TextField Iron::FieldDefinitions::TextArea Iron::FieldDefinitions::RichTextArea].freeze
+
+    included do
+      scope :searchable, -> { where(type: SEARCHABLE_TYPES).where("json_extract(metadata, '$.searchable') = 1") }
+
+      after_update_commit :reindex_entries_later, if: :searchable_previously_changed?
+    end
+
+    def searchable
+      ActiveModel::Type::Boolean.new.cast(metadata&.dig("searchable"))
+    end
+
+    def searchable?
+      !!searchable
+    end
+
+    def searchable=(value)
+      self.metadata = (metadata || {}).merge("searchable" => ActiveModel::Type::Boolean.new.cast(value))
+    end
+
+    def reindex_entries
+      entries_for_reindex.find_each(&:reindex)
+    end
+
+    private
+      def reindex_entries_later
+        ReindexSearchJob.perform_later(self)
+      end
+
+      def searchable_previously_changed?
+        return false unless saved_change_to_metadata?
+
+        old_metadata = saved_changes["metadata"]&.first || {}
+        new_metadata = saved_changes["metadata"]&.last || {}
+
+        old_metadata["searchable"] != new_metadata["searchable"]
+      end
+
+      def entries_for_reindex
+        case schemable
+        when ContentType
+          schemable.entries
+        when BlockDefinition
+          Entry.joins(:fields).where(iron_fields: { definition_id: schemable.referencing_field_definition_ids }).distinct
+        else
+          Entry.none
+        end
+      end
+  end
+end

data/app/models/iron/field_definition.rb

@@ -1,14 +1,11 @@
 module Iron
   class FieldDefinition < ApplicationRecord
-    include Exportable, Importable
+    include Ranked, Searchable, Exportable, Importable
 
     TYPES = %w[text_field text_area rich_text_area number file boolean date block block_list reference_list reference].freeze
 
     belongs_to :schemable, polymorphic: true
 
-    has_rank scoped_by: :schemable
-    before_create :move_to_bottom
-
     has_many :fields, as: :definition, inverse_of: :definition, dependent: :destroy
 
     has_one :titlable_content_type, class_name: "Iron::ContentType", inverse_of: :title_field_definition, dependent: :nullify

data/app/models/iron/fields/block.rb

@@ -70,19 +70,7 @@ module Iron
     end
 
     def title
-      text_types = %w[Iron::Fields::TextField Iron::Fields::TextArea Iron::Fields::RichTextArea]
-
-      text_field = fields.find { |f| text_types.include?(f.type) }
-      return nil unless text_field
-
-      content = case text_field
-      when Fields::RichTextArea
-        text_field.rich_text&.to_plain_text
-      else
-        text_field.value
-      end
-
-      content&.truncate(300)
+      fields.filter_map(&:searchable_text).first&.truncate(300)
     end
 
     def thumbnail

data/app/models/iron/fields/rich_text_area.rb

@@ -4,6 +4,10 @@ module Iron
 
     has_rich_text :rich_text
 
+    def searchable_text
+      rich_text&.to_plain_text
+    end
+
     def value
       rich_text&.to_s
     end

data/app/models/iron/fields/text_area.rb

@@ -1,5 +1,9 @@
 module Iron
   class Fields::TextArea < Field
+    def searchable_text
+      value
+    end
+
     def value
       value_text
     end

data/app/models/iron/fields/text_field.rb

@@ -2,6 +2,10 @@ module Iron
   class Fields::TextField < Field
     validate :validate_required_field
 
+    def searchable_text
+      value
+    end
+
     def value
       value_string
     end

data/app/models/iron/search/query.rb

@@ -0,0 +1,33 @@
+module Iron
+  class Search::Query
+    attr_reader :terms
+
+    def initialize(raw)
+      @terms = sanitize(raw)
+    end
+
+    def blank? = terms.blank?
+    def to_s = terms.to_s
+
+    private
+      def sanitize(raw)
+        return nil if raw.blank?
+        result = strip_special_characters(raw)
+        return nil if result.blank?
+        result = remove_unbalanced_quotes(result)
+        neutralize_operators(result)
+      end
+
+      def strip_special_characters(text)
+        text.gsub(/[^\w\s"]/, "").squish
+      end
+
+      def remove_unbalanced_quotes(text)
+        text.count('"').even? ? text : text.delete('"')
+      end
+
+      def neutralize_operators(text)
+        text.downcase
+      end
+  end
+end

data/app/models/iron/search_record/fts.rb

@@ -0,0 +1,20 @@
+module Iron
+  class SearchRecord::Fts < ApplicationRecord
+    self.table_name = "iron_search_records_fts"
+    self.primary_key = "rowid"
+
+    attribute :rowid, :integer
+    attribute :title, :string
+    attribute :content, :string
+
+    scope :with_rowid, -> { select(:rowid, :title, :content) }
+
+    def self.upsert(rowid, title, content)
+      connection.exec_query(
+        "INSERT OR REPLACE INTO iron_search_records_fts(rowid, title, content) VALUES (?, ?, ?)",
+        "Iron::SearchRecord::Fts Upsert",
+        [ rowid, title, content ]
+      )
+    end
+  end
+end

data/app/models/iron/search_record.rb

@@ -0,0 +1,31 @@
+module Iron
+  class SearchRecord < ApplicationRecord
+    belongs_to :entry
+    belongs_to :locale
+
+    has_one :search_records_fts, -> { with_rowid },
+      class_name: "Iron::SearchRecord::Fts", foreign_key: :rowid, primary_key: :id, dependent: :destroy
+
+    after_save :upsert_to_fts5_table
+
+    scope :matching, ->(query) { joins(:search_records_fts).where("iron_search_records_fts MATCH ?", query) }
+    scope :for_locale, ->(locale) { locale ? where(locale:) : all }
+
+    class << self
+      def upsert!(attributes)
+        record = find_by(entry_id: attributes[:entry_id], locale_id: attributes[:locale_id])
+        if record
+          record.update!(attributes)
+          record
+        else
+          create!(attributes)
+        end
+      end
+    end
+
+    private
+      def upsert_to_fts5_table
+        Fts.upsert(id, title, content)
+      end
+  end
+end

data/app/views/iron/field_definitions/rich_text_area/_form.html.erb

@@ -1,2 +1,6 @@
-<%= render layout: "iron/field_definitions/layouts/form", locals: { field_definition: field_definition } do %>
+<%= render layout: "iron/field_definitions/layouts/form", locals: { field_definition: field_definition } do |form| %>
+  <div class="field flex items-center justify-between">
+    <%= form.label :searchable, t("iron.field_definitions.rich_text_area.searchable") %>
+    <%= form.toggle :searchable %>
+  </div>
 <% end %>

data/app/views/iron/field_definitions/text_area/_form.html.erb

@@ -1,2 +1,6 @@
-<%= render layout: "iron/field_definitions/layouts/form", locals: { field_definition: field_definition } do %>
+<%= render layout: "iron/field_definitions/layouts/form", locals: { field_definition: field_definition } do |form| %>
+  <div class="field flex items-center justify-between">
+    <%= form.label :searchable, t("iron.field_definitions.text_area.searchable") %>
+    <%= form.toggle :searchable %>
+  </div>
 <% end %>

data/app/views/iron/field_definitions/text_field/_form.html.erb

@@ -4,6 +4,11 @@
     <%= form.toggle :required %>
   </div>
 
+  <div class="field flex items-center justify-between">
+    <%= form.label :searchable, t("iron.field_definitions.text_field.searchable") %>
+    <%= form.toggle :searchable %>
+  </div>
+
   <div class="field">
     <%= form.label :allowed_values_text, t("iron.field_definitions.text_field.allowed_values") %>
     <div>

data/config/locales/en.yml

@@ -207,10 +207,15 @@ en:
         title: "New Field"
       reference:
         supported_content_types: "Supported content types"
+      rich_text_area:
+        searchable: "Searchable"
+      text_area:
+        searchable: "Searchable"
       text_field:
         allowed_values: "Allowed values"
         allowed_values_help: "One value per line, leave blank to allow any value"
         required: "Required"
+        searchable: "Searchable"
     first_runs:
       show:
         description: "Start managing your content with Iron CMS"

data/db/migrate/20260210220330_create_iron_search_records.rb

@@ -0,0 +1,31 @@
+class CreateIronSearchRecords < ActiveRecord::Migration[8.1]
+  def up
+    create_table :iron_search_records do |t|
+      t.references :entry, null: false, foreign_key: { to_table: :iron_entries }
+      t.references :locale, null: false, foreign_key: { to_table: :iron_locales }
+      t.string :title
+      t.text :content
+      t.datetime :created_at, null: false
+
+      t.index [ :entry_id, :locale_id ], unique: true
+    end
+
+    return unless connection.adapter_name == "SQLite"
+
+    execute <<-SQL
+      CREATE VIRTUAL TABLE iron_search_records_fts USING fts5(
+        title,
+        content,
+        tokenize='porter'
+      )
+    SQL
+  end
+
+  def down
+    if connection.adapter_name == "SQLite"
+      execute "DROP TABLE IF EXISTS iron_search_records_fts"
+    end
+
+    drop_table :iron_search_records, if_exists: true
+  end
+end

data/lib/iron/engine.rb

@@ -12,6 +12,7 @@ require "iron/sdk"
 require "pagy"
 require "iron/routing"
 require "iron/image_analyzer"
+require "iron/fts5"
 
 module Iron
   class Engine < ::Rails::Engine
@@ -58,6 +59,12 @@ module Iron
       end
     end
 
+    initializer "iron.fts5" do |app|
+      app.config.after_initialize do
+        ActiveSupport.on_load(:active_record) { Fts5.ensure_virtual_table }
+      end
+    end
+
     config.to_prepare do
       ActionView::Base.include(Module.new do
         def attachment_url(attachment, **options)

data/lib/iron/fts5.rb

@@ -0,0 +1,23 @@
+# SQLite FTS5 virtual tables are not captured by Rails' schema.rb dumper.
+# When a database is created via db:schema:load (instead of running migrations),
+# the FTS5 table will be missing. This ensures it exists on boot.
+
+module Iron
+  module Fts5
+    def self.ensure_virtual_table
+      ActiveRecord::Base.connection_pool.with_connection do |conn|
+        return unless conn.adapter_name == "SQLite"
+        return unless conn.table_exists?(:iron_search_records)
+        return if conn.execute("SELECT name FROM sqlite_master WHERE type='table' AND name='iron_search_records_fts'").any?
+
+        conn.execute <<~SQL
+          CREATE VIRTUAL TABLE iron_search_records_fts USING fts5(
+            title,
+            content,
+            tokenize='porter'
+          )
+        SQL
+      end
+    end
+  end
+end

data/lib/iron/version.rb

@@ -1,3 +1,3 @@
 module Iron
-  VERSION = "0.13.1"
+  VERSION = "0.14.0"
 end

data/lib/tasks/iron_tasks.rake

@@ -1,4 +1,18 @@
 namespace :iron do
+  namespace :search do
+    desc "Rebuild the full-text search index for all entries"
+    task reindex: :environment do
+      puts "Clearing search records..."
+      ActiveRecord::Base.connection.execute("DELETE FROM iron_search_records")
+      ActiveRecord::Base.connection.execute("DELETE FROM iron_search_records_fts")
+
+      puts "Reindexing entries..."
+      Iron::Entry.find_each(&:reindex)
+
+      puts "Done! Processed #{Iron::Entry.count} entries."
+    end
+  end
+
   namespace :seed do
     desc "Dump CMS schema and content to db/seeds/iron.zip"
     task dump: :environment do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iron-cms
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Massimo De Marchi
@@ -321,6 +321,7 @@ files:
 - app/jobs/iron/export_job.rb
 - app/jobs/iron/generate_entry_routes_job.rb
 - app/jobs/iron/import_job.rb
+- app/jobs/iron/reindex_search_job.rb
 - app/mailers/iron/application_mailer.rb
 - app/mailers/iron/passwords_mailer.rb
 - app/models/concerns/iron/broadcastable.rb
@@ -350,6 +351,7 @@ files:
 - app/models/iron/entry/importable.rb
 - app/models/iron/entry/presentable.rb
 - app/models/iron/entry/schemable.rb
+- app/models/iron/entry/searchable.rb
 - app/models/iron/entry/titlable.rb
 - app/models/iron/entry/web_publishable.rb
 - app/models/iron/exporter.rb
@@ -358,6 +360,8 @@ files:
 - app/models/iron/field_definition.rb
 - app/models/iron/field_definition/exportable.rb
 - app/models/iron/field_definition/importable.rb
+- app/models/iron/field_definition/ranked.rb
+- app/models/iron/field_definition/searchable.rb
 - app/models/iron/field_definitions/block.rb
 - app/models/iron/field_definitions/block_list.rb
 - app/models/iron/field_definitions/boolean.rb
@@ -386,6 +390,9 @@ files:
 - app/models/iron/locale.rb
 - app/models/iron/qr_code_link.rb
 - app/models/iron/reference.rb
+- app/models/iron/search/query.rb
+- app/models/iron/search_record.rb
+- app/models/iron/search_record/fts.rb
 - app/models/iron/seed.rb
 - app/models/iron/session.rb
 - app/models/iron/user.rb
@@ -523,6 +530,7 @@ files:
 - db/migrate/20251209103110_create_iron_account_imports.rb
 - db/migrate/20260207103057_add_language_to_iron_users.rb
 - db/migrate/20260209215027_add_active_to_iron_users.rb
+- db/migrate/20260210220330_create_iron_search_records.rb
 - lib/generators/iron/pages/pages_generator.rb
 - lib/generators/iron/pages/templates/pages_controller.rb
 - lib/generators/iron/pages/templates/show.html.erb
@@ -531,6 +539,7 @@ files:
 - lib/iron-cms.rb
 - lib/iron.rb
 - lib/iron/engine.rb
+- lib/iron/fts5.rb
 - lib/iron/global_id/instance_scoped_locator.rb
 - lib/iron/image_analyzer.rb
 - lib/iron/lexorank.rb