redisearch-rails 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 389ea395f1fe1ef5130083e382f435fa4515d1ab3f9952f4bc660eed47838d40
-  data.tar.gz: cb56f462ab039f9b93eb7c9310cbd50a3a9678a1b2eb1d2c4205caec3066754c
+  metadata.gz: f416956f2ec55228c53f37ddaadc2f0a5200caa7ccf6399c1f991217ed2242f3
+  data.tar.gz: 01624db3f4e81c614550dc998e0214bfaddb61a2b301e052b05612de2e9c12db
 SHA512:
-  metadata.gz: 9f534dafaba92007233233420f17b7230f521df2d7a82b785b6cc2c35d03201d37c38ecbb4913aa90500aedc690cd9fd8840919261234c70626f9202f9dd83b1
-  data.tar.gz: 650c151013343ab35936a565b9ad657f54fc978ee64ed77ddec04fa04751d2b513318e8c25f4327756779305996526b768e2b6bc4f6fc717d16224b9607f5227
+  metadata.gz: 452964535c36fda982b1c7dc2299df33bacaf9e58bdc93969ed5e8ebf787c5fca1bd7f6e461bf09f4006fbbc47b2e7535770b8a62b969f92b55df91d8eeaee0b
+  data.tar.gz: 1e2f6985c7b5bec11b1a8b5c223925c6e66995f91ec21cf558ce409de9fbeb936f30f7ced8d78605199c57efc95d26cc8b291d101e26a5340e32265400ebda11

data/.travis.yml

@@ -1,7 +1,28 @@
 ---
-sudo: false
+os: linux
+
 language: ruby
 cache: bundler
+
 rvm:
-  - 2.6.1
-before_install: gem install bundler -v 1.17.2
+  - 2.6.5
+  - 2.5.7
+  - 2.4.9
+
+env:
+  - BV=1.17.2
+
+before_install:
+  - gem install bundler -v $BV
+  - docker run -d -p 127.0.0.1:6379:6379 redislabs/redisearch:latest
+  - docker ps -a
+
+jobs:
+  include:
+    # Ruby-head (we want to know how we're doing, but not fail the build)
+    - rvm: ruby-head
+      env: BV=2.1.4
+
+  allow_failures:
+    - rvm: ruby-head
+      env: BV=2.1.4

data/README.md

@@ -1,4 +1,5 @@
 # Redisearch-rails
+[![Build Status](https://travis-ci.org/eventBrain/redisearch-rails.svg?branch=master)](https://travis-ci.org/eventBrain/redisearch-rails)
 
 Adds support for easily indexing and search ActiveRecord models using RediSearch module http://redisearch.io/
 

data/lib/redisearch-rails/batches_indexer.rb

@@ -0,0 +1,44 @@
+module RediSearch
+  class BatchesIndexer
+
+    attr_reader :klass
+
+    def initialize(klass)
+      @klass = klass
+      @index = klass.redisearch_index
+    end
+
+    def reindex(mode: :inline, **options)
+      unless [:inline, true, :async].include?(mode)
+        raise ArgumentError, "#{mode} its not a valid value for mode"
+      end
+
+      batch_size = klass.redisearch_index_options[:batch_size] || DEFAULT_BATCH_SIZE
+
+      #this make a select count
+      size = klass.redisearch_import.find_in_batches(batch_size: batch_size).size
+      case mode
+      when :async
+        for i in 1..size
+          start = (i-1)*batch_size
+          finish = (i*batch_size)-1
+          RediSearch::ReindexBatchesJob.perform_later(klass.name, start.to_s, finish.to_s, batch_size.to_s)
+        end
+      else
+        reindex_in_batches(batch_size, options)
+      end
+    end
+
+    private
+
+    def reindex_in_batches(batch_size, **options)
+      klass.redisearch_import.find_in_batches(batch_size: batch_size) do |records|
+        klass.redisearch_index.client.multi do
+          records.each do |record|
+            record.reindex(mode: :inline, **options.deep_merge(replace: true, partial: true))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/redisearch-rails/configuration.rb

@@ -1,9 +1,13 @@
 module RediSearch
   class Configuration
-    attr_accessor :redis_config
+    attr_accessor :redis_config, :index_prefix, :index_suffix, :queue_name, :model_options
 
     def initialize
       @redis_config = {}
+      @index_prefix = nil
+      @index_suffix = nil
+      @queue_name = :redisearch
+      @model_options = {}
     end
   end
 end

data/lib/redisearch-rails/record_indexer.rb

@@ -0,0 +1,37 @@
+module RediSearch
+  class RecordIndexer
+
+    attr_reader :record, :index
+
+    def initialize(record)
+      @record = record
+      @index = record.class.redisearch_index
+    end
+
+    def reindex(mode: nil, **options)
+      unless [:inline, true, nil, :async].include?(mode)
+        raise ArgumentError, "#{mode} its not a valid value for mode"
+      end
+
+      mode ||= RediSearch.callbacks_value || record.class.redisearch_index_options[:callbacks] || true
+
+      case mode
+      when :async
+        RediSearch::ReindexRecordJob.perform_later(record.class.name, record.id.to_s)
+      else
+        reindex_record
+      end
+    end
+
+    private
+
+    def reindex_record
+      if record.destroyed? || !record.persisted? || !record.should_index?
+        document = index.generate_document(record.redisearch_document_id, {})
+        document.del(dd: true)
+      else
+        record.redisearch_add
+      end
+    end
+  end
+end

data/lib/redisearch-rails/redisearchable/class_methods.rb

@@ -2,21 +2,48 @@ module RediSearch
   module RediSearchable
     module ClassMethods
 
-      attr_reader :redisearch_index, :redisearch_index_serializer
-
       def redisearch(*args, schema:, **options)
-        prefix = options[:prefix]
-        @redisearch_index_serializer = options[:index_serializer]
+        options = RediSearch.model_options.merge(options)
+
+        raise "Only call redisearch once per model" if respond_to?(:redisearch_index)
+
+        prefix = options[:prefix] || RediSearch.index_prefix
+        prefix = prefix.call if prefix.respond_to?(:call)
+
+        suffix = options[:suffix] || RediSearch.index_suffix
+        suffix = suffix.call if suffix.respond_to?(:call)
+
+        callbacks = options.key?(:callbacks) ? options[:callbacks] : :inline
+        unless [:inline, true, false, :async].include?(callbacks)
+          raise ArgumentError, "#{callbacks} its not permited value for callbacks"
+        end
+
+        class << self
+          attr_reader :redisearch_index, :redisearch_index_serializer, :redisearch_index_options
+        end
 
-        index_name = [prefix, model_name.plural].compact.join("_")
+        index_name = [prefix, model_name.plural, suffix].compact.join("_")
+        @redisearch_index_serializer = options[:index_serializer]
         @redisearch_index = RediSearch.client.generate_index(index_name, schema)
 
+        RediSearch.models << self
+
+        @redisearch_index_options = options
+
         scope :redisearch_import, -> { all }
 
+        # always add callbacks, even when callbacks is false
+        # so Model.callbacks block can be used
+        if respond_to?(:after_commit)
+          after_commit :reindex, if: -> { RediSearch.callbacks?(default: callbacks) }
+        elsif respond_to?(:after_save)
+          after_save :reindex, if: -> { RediSearch.callbacks?(default: callbacks) }
+          after_destroy :reindex, if: -> { RediSearch.callbacks?(default: callbacks) }
+        end
+
         include InstanceMethods
         extend RediSearchClassMethods
       end
-
     end
 
     module RediSearchClassMethods
@@ -33,21 +60,15 @@ module RediSearch
       end
 
       # Reindex all
-      def reindex(recreate: false, only: [], **options)
+      def reindex(recreate: false, mode: :inline, **options)
         index = redisearch_index
 
         index.drop if recreate
         index.create unless index.exists?
 
-        redisearch_import.find_in_batches do |elements|
-          redisearch_index.client.multi do
-            elements.each do |element|
-              element.redisearch_document.add(options.deep_merge(replace: true, partial: true))
-            end
-          end
-        end
-        true
+        RediSearch::BatchesIndexer.new(self).reindex(mode: mode)
       end
+
     end
   end
 end

data/lib/redisearch-rails/redisearchable/instance_methods.rb

@@ -6,6 +6,27 @@ module RediSearch
         @redisearch_document ||= generate_redisearch_document
       end
 
+      def redisearch_reindex(**options)
+        RediSearch::RecordIndexer.new(self).reindex(options)
+      end
+      alias_method :reindex, :redisearch_reindex unless method_defined?(:reindex)
+
+      def should_index?
+        true
+      end
+
+      def redisearch_add
+        redisearch_document.add(replace: true, partial: true)
+      end
+
+      def redisearch_delete
+        redisearch_document.del(dd: true)
+      end
+
+      def redisearch_document_id
+        [self.class.redisearch_index.name, self.id].join('_')
+      end
+
       private
 
       def generate_redisearch_document
@@ -16,10 +37,6 @@ module RediSearch
         index.generate_document(redisearch_document_id, fields_values)
       end
 
-      def redisearch_document_id
-        [self.class.redisearch_index.name, self.id].join('_')
-      end
-
       def redisearch_serializer
         self.class.redisearch_index_serializer.new(self) if self.class.redisearch_index_serializer
       end

data/lib/redisearch-rails/reindex_batches_job.rb

@@ -0,0 +1,26 @@
+module RediSearch
+  class ReindexBatchesJob < ActiveJob::Base
+    queue_as { RediSearch.queue_name }
+
+    def perform(klass, start, finish, batch_size)
+      klass = klass.constantize
+
+      batches_relation = nil
+
+      if ActiveRecord::VERSION::STRING >= "5.0"
+        batches_relation = klass.redisearch_import.find_in_batches(batch_size: batch_size, start: start, finish: finish)
+      else
+        batches_relation = klass.redisearch_import.where(klass.arel_table[:id].lteq(finish.to_i)).find_in_batches(batch_size: batch_size, start: start)
+      end
+
+      batches_relation.each do |records|
+        klass.redisearch_index.client.multi do
+          records.each do |record|
+            record.reindex(mode: :inline, replace: true)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/redisearch-rails/reindex_record_job.rb

@@ -0,0 +1,30 @@
+module RediSearch
+  class ReindexRecordJob < ActiveJob::Base
+    RECORD_NOT_FOUND_CLASSES = [
+      "ActiveRecord::RecordNotFound"
+    ]
+
+    queue_as { RediSearch.queue_name }
+
+    def perform(klass, id)
+      model = klass.constantize
+
+      record =
+        begin
+          model.redisearch_import.find(id)
+        rescue => e
+          # check by name rather than rescue directly so we don't need
+          # to determine which classes are defined
+          raise e unless RECORD_NOT_FOUND_CLASSES.include?(e.class.name)
+          nil
+        end
+
+        unless record
+          record = model.new
+          record.id = id
+        end
+
+      RecordIndexer.new(record).reindex(mode: :inline)
+    end
+  end
+end

data/lib/redisearch-rails/version.rb

@@ -1,3 +1,3 @@
 module RediSearch
-  VERSION = '0.2.0'
+  VERSION = '0.5.0'
 end

data/lib/redisearch-rails.rb

@@ -6,8 +6,17 @@ require 'redi_searcher'
 
 module RediSearch
   autoload :RediSearchable, 'redisearch-rails/redisearchable'
+  autoload :BatchesIndexer, 'redisearch-rails/batches_indexer'
+  autoload :RecordIndexer, 'redisearch-rails/record_indexer'
+
+  #jobs
+  autoload :ReindexRecordJob, 'redisearch-rails/reindex_record_job'
+  autoload :ReindexBatchesJob, 'redisearch-rails/reindex_batches_job'
+
+  DEFAULT_BATCH_SIZE = 1_000
 
   class << self
+    attr_accessor :models
     attr_writer :configuration
 
     def configuration
@@ -22,7 +31,55 @@ module RediSearch
       @client ||= RediSearcher::Client.new(configuration.redis_config)
     end
 
+    def enable_callbacks
+      self.callbacks_value = nil
+    end
+
+    def disable_callbacks
+      self.callbacks_value = false
+    end
+
+    def callbacks?(default: true)
+      if self.callbacks_value.nil?
+        default
+      else
+        self.callbacks_value != false
+      end
+    end
+
+    def callbacks_value
+      Thread.current[:redisearch_callbacks_enabled]
+    end
+
+    def callbacks_value=(value)
+      Thread.current[:redisearch_callbacks_enabled] = value
+    end
+
+    def callbacks(value)
+      if block_given?
+        previous_value = self.callbacks_value
+        begin
+          self.callbacks_value = value
+          result = yield
+          result
+        ensure
+          self.callbacks_value = previous_value
+        end
+      else
+        self.callbacks_value = value
+      end
+    end
+
+    private
+
+    def method_missing(m, *args, &block)
+      return configuration.send(m) if configuration.respond_to?(m)
+      super
+    end
   end
+
+  @models = []
+
 end
 
 ActiveSupport.on_load(:active_record) do

data/redisearch-rails.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activerecord', '~> 4.2'
   spec.add_dependency 'activesupport', '~> 4.2'
+  spec.add_dependency 'activejob', '~> 4.2'
   spec.add_dependency 'redi_searcher', '~> 0.1', '>= 0.1.3'
 
   spec.add_development_dependency "bundler", "~> 1.17"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redisearch-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Patricio Beckmann
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-02 00:00:00.000000000 Z
+date: 2020-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: redi_searcher
   requirement: !ruby/object:Gem::Requirement
@@ -118,10 +132,14 @@ files:
 - bin/console
 - bin/setup
 - lib/redisearch-rails.rb
+- lib/redisearch-rails/batches_indexer.rb
 - lib/redisearch-rails/configuration.rb
+- lib/redisearch-rails/record_indexer.rb
 - lib/redisearch-rails/redisearchable.rb
 - lib/redisearch-rails/redisearchable/class_methods.rb
 - lib/redisearch-rails/redisearchable/instance_methods.rb
+- lib/redisearch-rails/reindex_batches_job.rb
+- lib/redisearch-rails/reindex_record_job.rb
 - lib/redisearch-rails/version.rb
 - redisearch-rails.gemspec
 homepage: https://github.com/Ticketplus/redisearch-rails