full_search 0.1.0

data/lib/full_search/tokenizer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module FullSearch
+  module Tokenizer
+    VALID = %w[unicode61 porter trigram].freeze
+
+    def self.validate!(value)
+      value = value.to_s
+      unless VALID.include?(value)
+        raise InvalidFieldError, "Unsupported tokenizer: #{value.inspect}. Use one of #{VALID.inspect}"
+      end
+      value
+    end
+  end
+end

data/lib/full_search/typo.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module FullSearch
+  module Typo
+    MIN_SQLITE_VERSION = [3, 34].freeze
+
+    class << self
+      def supported?
+        major, minor = sqlite_version_parts
+        major > MIN_SQLITE_VERSION.first || (major == MIN_SQLITE_VERSION.first && minor >= MIN_SQLITE_VERSION.last)
+      end
+
+      def warn_unsupported!
+        warn "[full_search] SQLite #{sqlite_version} does not support the trigram tokenizer. typo_tolerance requires SQLite >= 3.34."
+      end
+
+      private
+
+      def sqlite_version_parts
+        sqlite_version.split(".").first(2).map(&:to_i)
+      end
+
+      def sqlite_version
+        ActiveRecord::Base.connection.execute("SELECT sqlite_version() AS v").first["v"]
+      end
+    end
+  end
+end

data/lib/full_search/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FullSearch
+  VERSION = "0.1.0"
+end

data/lib/full_search.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "active_support"
+require "active_support/concern"
+
+require "full_search/version"
+require "full_search/config"
+require "full_search/errors"
+require "full_search/tokenizer"
+require "full_search/dsl"
+require "full_search/model"
+require "full_search/index"
+require "full_search/exact_match"
+require "full_search/query_parser"
+require "full_search/highlighter"
+require "full_search/typo"
+require "full_search/search"
+require "full_search/soft_delete"
+require "full_search/callbacks"
+require "full_search/reindex_job"
+require "full_search/test_helpers"
+
+ActiveSupport.on_load(:active_record) do
+  include FullSearch::Model
+end
+
+module FullSearch
+  class << self
+    def models
+      @models ||= []
+    end
+  end
+end
+
+require "full_search/railtie" if defined?(Rails::Railtie)

data/lib/generators/full_search/install/install_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module FullSearch
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def create_initializer
+        template "full_search.rb", "config/initializers/full_search.rb"
+      end
+    end
+  end
+end

data/lib/generators/full_search/install/templates/full_search.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+FullSearch.configure do |config|
+  config.auto_manage_schema = Rails.env.local?
+
+  config.stale_query_behavior = Rails.env.production? ? :log_and_fallback : :raise
+
+  config.lock_rebuilds = true
+end

data/lib/tasks/full_search.rake

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+namespace :full_search do
+  desc "Rebuild full_search indexes"
+  task :rebuild, [:models] => :environment do |_t, args|
+    Rails.application.eager_load!
+
+    models = if args[:models]
+               args[:models].split(",").map do |name|
+                 klass = name.singularize.camelize.constantize rescue nil
+                 klass || FullSearch.models.find { |m| m.table_name == name }
+               end.compact
+             else
+               FullSearch.models
+             end
+
+    models.each do |model|
+      FullSearch::Index.rebuild!(model)
+      puts "Rebuilt #{FullSearch::Index.fts_table_name(model)}"
+    end
+  end
+
+  desc "Optimize full_search indexes"
+  task optimize: :environment do
+    Rails.application.eager_load!
+    FullSearch.models.each do |model|
+      FullSearch::Index.optimize!(model)
+      puts "Optimized #{FullSearch::Index.fts_table_name(model)}"
+    end
+  end
+
+  desc "Show full_search index status"
+  task status: :environment do
+    Rails.application.eager_load!
+    FullSearch.models.each do |model|
+      stored = FullSearch::Index.stored_config_hash(model)
+      current = model.full_search_dsl.config_hash
+      status = stored == current ? "ok" : "stale"
+      puts "#{model.table_name}: #{status} (stored=#{stored}, current=#{current})"
+    end
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: full_search
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben D'Angelo
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: Declarative full-text search for Rails apps backed by SQLite FTS5
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/full_search.rb
+- lib/full_search/callbacks.rb
+- lib/full_search/config.rb
+- lib/full_search/dsl.rb
+- lib/full_search/errors.rb
+- lib/full_search/exact_match.rb
+- lib/full_search/highlighter.rb
+- lib/full_search/index.rb
+- lib/full_search/model.rb
+- lib/full_search/query_parser.rb
+- lib/full_search/railtie.rb
+- lib/full_search/reindex_job.rb
+- lib/full_search/search.rb
+- lib/full_search/soft_delete.rb
+- lib/full_search/test_helpers.rb
+- lib/full_search/tokenizer.rb
+- lib/full_search/typo.rb
+- lib/full_search/version.rb
+- lib/generators/full_search/install/install_generator.rb
+- lib/generators/full_search/install/templates/full_search.rb
+- lib/tasks/full_search.rake
+homepage: https://github.com/bendangelo/full_search
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 4.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.15
+specification_version: 4
+summary: SQLite FTS5 full-text search for Rails/ActiveRecord
+test_files: []