typesense-rails 1.0.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e981befd9505d72dc1611c7953461d541f86c2c7725bad89389cbc959a6985db
+  data.tar.gz: 04ff3d8c767bd6714180da4604bde3540324b1cc24f295910742472fe4c5ffb0
+SHA512:
+  metadata.gz: 0e4fa549a44fb57064738447a2fd198b8832ec6f154467e0a381bc0c46edd8e1260f1f36f2ea38fbe7e6cd7bbde4e7b4a96c2d366c80def2349d52234e450eed
+  data.tar.gz: 97d3bc5ac70c9f622b620eede98e456fe25589975bc3858f1ce51430f45db4e2f0f8c4122e768e47e9361da76dfeea5ac89dcce2b5608cc95cea645d299087c1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,42 @@
+source "http://rubygems.org"
+
+gem 'json', '>= 1.5.1'
+gem "typesense", "~> 0.13.0"
+
+
+if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
+  gem 'rubysl', '~> 2.0', :platform => :rbx
+end
+
+group :test do
+  rails_version = ENV["RAILS_VERSION"] || '6.1'
+  gem 'rails', "~> #{rails_version}"
+  gem 'active_model_serializers'
+  if Gem::Version.new(rails_version) >= Gem::Version.new('6.0')
+    gem 'sqlite3', '~> 1.6.0', :platform => [:rbx, :ruby]
+  else
+    gem 'sqlite3', '< 1.4.0', :platform => [:rbx, :ruby]
+  end
+  gem 'rspec', '~> 3.0'
+  gem 'jdbc-sqlite3', :platform => :jruby
+  gem 'activerecord-jdbc-adapter', :platform => :jruby
+  gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
+  gem 'redgreen'
+
+  sequel_version = ENV['SEQUEL_VERSION'] ? "~> #{ENV['SEQUEL_VERSION']}" : '>= 4.0'
+  gem 'sequel', sequel_version
+end
+
+group :development do
+  gem 'rake', '>= 10.1.0'
+  gem 'rdoc'
+  gem "rubocop", "~> 1.19"
+end
+
+group :test, :development do
+  gem 'will_paginate', '>= 2.3.15'
+  gem 'kaminari', '< 1'
+  gem 'pagy'
+end
+
+gem "lefthook", "~> 0.7.6"

data/Gemfile.lock

@@ -0,0 +1,260 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actioncable (6.1.7.10)
+      actionpack (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.7.10)
+      actionpack (= 6.1.7.10)
+      activejob (= 6.1.7.10)
+      activerecord (= 6.1.7.10)
+      activestorage (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+      mail (>= 2.7.1)
+    actionmailer (6.1.7.10)
+      actionpack (= 6.1.7.10)
+      actionview (= 6.1.7.10)
+      activejob (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.7.10)
+      actionview (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.7.10)
+      actionpack (= 6.1.7.10)
+      activerecord (= 6.1.7.10)
+      activestorage (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.7.10)
+      activesupport (= 6.1.7.10)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    active_model_serializers (0.10.15)
+      actionpack (>= 4.1)
+      activemodel (>= 4.1)
+      case_transform (>= 0.2)
+      jsonapi-renderer (>= 0.1.1.beta1, < 0.3)
+    activejob (6.1.7.10)
+      activesupport (= 6.1.7.10)
+      globalid (>= 0.3.6)
+    activemodel (6.1.7.10)
+      activesupport (= 6.1.7.10)
+    activerecord (6.1.7.10)
+      activemodel (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+    activestorage (6.1.7.10)
+      actionpack (= 6.1.7.10)
+      activejob (= 6.1.7.10)
+      activerecord (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.7.10)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.3)
+    base64 (0.2.0)
+    bigdecimal (3.1.9)
+    builder (3.3.0)
+    case_transform (0.2)
+      activesupport
+    cgi (0.4.2)
+    concurrent-ruby (1.3.5)
+    crass (1.0.6)
+    date (3.4.1)
+    diff-lcs (1.6.2)
+    erb (4.0.4)
+      cgi (>= 0.3.3)
+    erubi (1.13.1)
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
+    ffi (1.17.2)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    json (2.12.0)
+    jsonapi-renderer (0.2.2)
+    kaminari (0.17.0)
+      actionpack (>= 3.0.0)
+      activesupport (>= 3.0.0)
+    language_server-protocol (3.17.0.5)
+    lefthook (0.7.7)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    loofah (2.24.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    method_source (1.1.0)
+    mini_mime (1.1.5)
+    mini_portile2 (2.8.9)
+    minitest (5.25.5)
+    net-imap (0.4.22)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.1)
+      net-protocol
+    nio4r (2.7.4)
+    nokogiri (1.15.7)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    oj (3.16.10)
+      bigdecimal (>= 3.0)
+      ostruct (>= 0.2)
+    ostruct (0.6.1)
+    pagy (6.5.0)
+    parallel (1.27.0)
+    parser (3.3.8.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.4.0)
+    psych (5.2.6)
+      date
+      stringio
+    racc (1.8.1)
+    rack (2.2.15)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rails (6.1.7.10)
+      actioncable (= 6.1.7.10)
+      actionmailbox (= 6.1.7.10)
+      actionmailer (= 6.1.7.10)
+      actionpack (= 6.1.7.10)
+      actiontext (= 6.1.7.10)
+      actionview (= 6.1.7.10)
+      activejob (= 6.1.7.10)
+      activemodel (= 6.1.7.10)
+      activerecord (= 6.1.7.10)
+      activestorage (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+      bundler (>= 1.15.0)
+      railties (= 6.1.7.10)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.3.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (6.1.7.10)
+      actionpack (= 6.1.7.10)
+      activesupport (= 6.1.7.10)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rdoc (6.14.0)
+      erb
+      psych (>= 4.0.0)
+    redgreen (1.2.2)
+    regexp_parser (2.10.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.3)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.3)
+    rubocop (1.75.6)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.44.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    ruby-progressbar (1.13.0)
+    sequel (5.92.0)
+      bigdecimal
+    sprockets (4.2.2)
+      concurrent-ruby (~> 1.0)
+      logger
+      rack (>= 2.2.4, < 4)
+    sprockets-rails (3.5.2)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.6.9)
+      mini_portile2 (~> 2.8.0)
+    stringio (3.1.7)
+    thor (1.3.2)
+    timeout (0.4.3)
+    typesense (0.13.0)
+      oj (~> 3.11)
+      typhoeus (~> 1.4)
+    typhoeus (1.4.1)
+      ethon (>= 0.9.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    websocket-driver (0.7.7)
+      base64
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    will_paginate (4.0.1)
+    zeitwerk (2.6.18)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_model_serializers
+  activerecord-jdbc-adapter
+  activerecord-jdbcsqlite3-adapter
+  jdbc-sqlite3
+  json (>= 1.5.1)
+  kaminari (< 1)
+  lefthook (~> 0.7.6)
+  pagy
+  rails (~> 6.1)
+  rake (>= 10.1.0)
+  rdoc
+  redgreen
+  rspec (~> 3.0)
+  rubocop (~> 1.19)
+  sequel (>= 4.0)
+  sqlite3 (~> 1.6.0)
+  typesense (~> 0.13.0)
+  will_paginate (>= 2.3.15)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2013-Present Algolia
+Copyright (c) 2021-Present Typesense
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,239 @@
+# typesense-rails
+
+A Ruby on Rails integration for Typesense search engine that provides seamless integration with ActiveRecord, Sequel and Mongoid models. 
+
+This gem is a fork of the [algolia-rails](https://github.com/algolia/algoliasearch-rails) gem, adapted to work with Typesense while maintaining similar functionality and API patterns.
+The core integration patterns and much of the functionality were inspired by Algolia's excellent work. 
+Special thanks to the Algolia team for their original implementation, which provided a solid foundation for this Typesense integration.
+
+## Features
+
+- Seamless integration with ActiveRecord, Sequel, and Mongoid models
+- Automatic indexing of model data with callbacks
+- Support for multiple pagination backends (Kaminari, WillPaginate, Pagy)
+- Rich attribute customization and serialization
+- Support for nested relationships and hierarchical data
+- Background job processing via ActiveJob integration
+- Conditional indexing based on model state
+- Environment-specific indexing
+- Support for faceted search and filtering
+- Customizable schema with predefined fields
+- Multi-way and one-way synonyms support
+- Rake tasks for index management
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'typesense-rails', '~> 1.0.0.rc1'
+```
+
+Then execute:
+
+```bash
+$ bundle install
+```
+
+## Configuration
+
+Initialize Typesense in your Rails application (e.g., in `config/initializers/typesense.rb`):
+
+```ruby
+Typesense.configuration = {
+  nodes: [{
+    host: 'localhost',     # For Typesense Cloud use xxx.a1.typesense.net
+    port: '8108',         # For Typesense Cloud use 443
+    protocol: 'http'     # For Typesense Cloud use https
+  }],
+  api_key: 'your-api-key',
+  connection_timeout_seconds: 2
+}
+```
+
+## Usage
+
+### Basic Model Configuration
+
+```ruby
+class Product < ApplicationRecord
+  include Typesense
+  
+  typesense do
+    # Define attributes to be indexed
+    attributes :name, :description, :price
+    
+    # Add dynamic attributes
+    attribute :full_name do
+      "#{first_name} #{last_name}"
+    end
+    
+    # Define predefined fields with specific types
+    predefined_fields [
+      { 'name' => 'name', 'type' => 'string', 'facet' => true },
+      { 'name' => 'price', 'type' => 'float' }
+    ]
+    
+    # Set default sorting
+    default_sorting_field 'price'
+    
+    # Configure synonyms
+    multi_way_synonyms [
+      { "phone-synonym" => %w[galaxy samsung samsung_electronics] }
+    ]
+    
+    one_way_synonyms [
+      { "smart-phone-synonym" => {
+          "root" => "smartphone",
+          "synonyms" => %w[nokia samsung motorola android]
+        }
+      }
+    ]
+
+    # Symbols to index
+    symbols_to_index ["-", "_"]
+
+    # Token separators
+    token_separator ["-", "_"]
+
+    # Enable nested fields
+    enable_nested_fields true
+  end
+end
+```
+
+### Working with Relationships
+
+```ruby
+class Profile < ApplicationRecord
+  include Typesense
+  belongs_to :user
+  has_many :specializations
+  
+  typesense do
+    # Nest user data
+    attribute :user do
+      { name: user.name, email: user.email }
+    end
+    
+    # Include related data
+    attribute :specializations do
+      specializations.select(&:public?).map do |s|
+        { title: s.title, category: s.category }
+      end
+    end
+  end
+end
+```
+
+### Searching
+
+```ruby
+# Basic search
+results = Product.search('phone', 'name')
+
+# Search with filters and sorting
+results = Product.search('phone', 'name', {
+  filter_by: 'price:< 500',
+  sort_by: 'price:asc'
+})
+
+# Faceted search
+results = Product.search('*', '', {
+  facet_by: 'category',
+  per_page: 20
+})
+```
+
+### Indexing
+
+```ruby
+# Reindex all records (with zero-downtime)
+Product.reindex
+
+# Regular reindexing (overwrites existing records)
+Product.reindex!
+
+# Index specific records
+Product.where('updated_at > ?', 10.minutes.ago).reindex!
+
+# Index a single record
+product.index!
+
+# Remove from index
+product.remove_from_index!
+
+# Conditional indexing
+typesense if: :published?, unless: :draft? do
+  # indexing configuration
+end
+```
+
+### Background Jobs
+
+Process indexing operations asynchronously using ActiveJob:
+
+```ruby
+class Product < ApplicationRecord
+  include Typesense
+  
+  typesense enqueue: true do
+    attributes :name, :description, :price
+  end
+end
+```
+
+Or define custom job processing:
+
+```ruby
+class Product < ApplicationRecord
+  include Typesense
+  
+  typesense enqueue: :trigger_worker do
+    attributes :name, :description, :price
+  end
+  
+  def self.trigger_worker(record, remove)
+    IndexingWorker.perform_async(record.id, remove)
+  end
+end
+```
+
+## Pagination Support
+
+The gem supports multiple pagination backends:
+
+```ruby
+# Configure pagination backend
+Typesense.configuration = {
+  # ... other configuration ...
+  pagination_backend: :kaminari  # or :will_paginate or :pagy
+}
+```
+
+## Testing
+
+To run the test suite:
+
+```bash
+bundle install
+bundle exec rake
+```
+
+## Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin feature/my-new-feature`)
+5. Create a new Pull Request
+
+Please make sure to update tests as appropriate and follow the existing coding style.
+
+### Releasing
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'rake'
+require 'bundler/gem_tasks'
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Typesense Rails #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/typesense/config.rb

@@ -0,0 +1,30 @@
+module Typesense
+  module Config
+    def initiliaze
+      @client = nil
+    end
+
+    def configuration
+      @@configuration || raise(NotConfigured,
+                               "Please configure Typesense. Set Typesense.configuration = {nodes: [{host: 'localhost', port: 8108, protocol: 'http'}], api_key: 'xyz'}")
+    end
+
+    def configuration=(configuration)
+      @@pagination_backend = configuration[:pagination_backend] if configuration.key?(:pagination_backend)
+      @@configuration = configuration
+    end
+
+    def pagination_backend
+      @@pagination_backend
+    end
+
+    def client
+      setup_client if @client.nil?
+      @client
+    end
+
+    def setup_client
+      @client = Typesense::Client.new(@@configuration)
+    end
+  end
+end

data/lib/typesense/import_job.rb

@@ -0,0 +1,21 @@
+module Typesense
+  class ImportJob < ::ActiveJob::Base
+    queue_as { Typesense.configuration[:queue_name] }
+
+    def self.perform(jsonl_object, collection_name, batch_size)
+      new.perform_later(jsonl_object, collection_name, batch_size)
+    end
+
+    def perform_later(jsonl_object, collection_name, batch_size)
+      # Initialize client with longer timeout for batch operations
+      client = Typesense::Client.new(Typesense.configuration.merge(
+        connection_timeout_seconds: 3600,
+      ))
+
+      client.collections[collection_name].documents.import(jsonl_object, {
+        action: "upsert",
+        batch_size: batch_size,
+      })
+    end
+  end
+end

data/lib/typesense/pagination/kaminari.rb

@@ -0,0 +1,39 @@
+unless defined? Kaminari
+  raise(Typesense::BadConfiguration, "Typesense: Please add 'kaminari' to your Gemfile to use kaminari pagination backend")
+end
+
+require 'kaminari/models/array_extension'
+
+module Typesense
+  module Pagination
+    class Kaminari < ::Kaminari::PaginatableArray
+      def initialize(array, options)
+        super(array, **options)
+      end
+
+      def limit(_num)
+        # noop
+        self
+      end
+
+      def offset(_num)
+        # noop
+        self
+      end
+
+      class << self
+        def create(results, total_hits, options = {})
+          offset = ((options[:page] - 1) * options[:per_page])
+          array = new results, offset: offset, limit: options[:per_page], total_count: total_hits
+          if array.empty? && !results.empty?
+            # since Kaminari 0.16.0, you need to pad the results with nil values so it matches the offset param
+            # otherwise you'll get an empty array: https://github.com/amatsuda/kaminari/commit/29fdcfa8865f2021f710adaedb41b7a7b081e34d
+            results = ([nil] * offset) + results
+            array = new results, offset: offset, limit: options[:per_page], total_count: total_hits
+          end
+          array
+        end
+      end
+    end
+  end
+end