xapian_db 1.3.3.1 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba9b119225f8d88f6210a6bab5c805da9d304f03
-  data.tar.gz: 9ee4b79e23d221af19240cade73e42f577b9422a
+  metadata.gz: 629bfb4aa9ec303fad2535c704879fa91a3130e2
+  data.tar.gz: 70f8b7b084498b194891372992ec54cddcf8c51e
 SHA512:
-  metadata.gz: 82d67bc2c6d9458e61e1cfb4d29afee34c78929efc897c108658452be12ead8e07bf445f8ee24e38e6790b064687934ad256a969c1f90a5777b95fe164ccaec8
-  data.tar.gz: 266bd99d634de8468c4921686b5cfbf4d4cf61751ec0b3f6dede7a6d058d71a50f61378ab438714d4236fae8b632666571d67367076d8efa2dd112e0706d4f60
+  metadata.gz: 5e1d4a205c21a0e988ba43cace4d94921f5375f91d130845c8207152397f92f394e606be71d88684253ce22f9814c01fa030b6afb83efd8c35970ca0a2cdb369
+  data.tar.gz: 6b4785131589a8110202a805c8711dc1ac7b765af193d41ee22c0fa6245eb4e023fdee582e2e1e60e725bf40412de9bdab7bca3db6b636f222c5a64f3e9b7d31

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+##1.3.4 (July 26th, 2013)
+
+Changes:
+
+  - support for sidekiq queues
+
+
 ##1.3.3.1 (June 23th, 2013)
 
 Fixes:

data/README.rdoc

@@ -84,8 +84,8 @@ You can override these defaults by placing a config file named 'xapian_db.yml' i
   - language: any iso language code, default: :none (activates spelling corrections, stemmer and stop words if an iso language code ist set)
   - term_min_length: <n>, default: 1 (do not index terms shorter than n)
   - term_splitter_count: <n>, default: 0 (see chapter Term Splitting)
-  - enable_query_flags: <list of flags, separated by colons>
-  - disable_query_flags: <list of flags, separated by colons>
+  - enabled_query_flags: <list of flags, separated by colons>
+  - disabled_query_flags: <list of flags, separated by colons>
 
   The following query flags are enabled by default:
 
@@ -94,7 +94,7 @@ You can override these defaults by placing a config file named 'xapian_db.yml' i
     - FLAG_BOOLEAN_ANY_CASE
     - FLAG_SPELLING_CORRECTION
 
-  See the xapian docs for all available query flags
+  See the xapian docs for all available query flags; if you use the enabled_query_flags option, you must list all query flags that you want to enable since enabled_query_flags overwrites the defaults
 
 If you do not configure settings for an environment in this file, xapian_db applies the defaults.
 
@@ -398,7 +398,7 @@ If you want to build a realtime search showing results while the user types, you
 
 Since Xapian allows only one database instance to write to the index, the default setup of XapianDb will not work
 with multiple app instances trying to write to the same database (you will get lock errors).
-Therefore, XapianDb provides two solutions based on queueing systems to overcome this. The first solution uses beanstalk and the second one uses resque.
+Therefore, XapianDb provides three solutions based on queueing systems to overcome this. The first solution uses beanstalk, the second one uses resque and the third uses sidekiq.
 
 == Installation with beanstalk
 
@@ -487,3 +487,27 @@ Be sure to specify the correct queue name when starting the worker.
 
 <b>If you don't provide a queue name, it WON'T take 'xapian_db' by default! Do not start multiple
 instances of this worker!</b>
+
+== Installation with Sidekiq
+
+=== 1. Install and start redis
+
+Install and start redis as described on the {resque github page}[https://github.com/defunkt/resque].
+
+=== 2. Add the sidekiq gem to your config
+
+  gem 'sidekiq'
+  bundle install
+
+=== 3. Configure XapianDb to use sidekiq in production
+
+  production:
+    database:     db/xapian_db/production
+    writer:       sidekiq
+    sidekiq_queue: my_queue
+
+If you don't specify a queue name XapianDb will use 'xapian_db' by default.
+
+=== 4. Start sidekiq
+
+  RAILS_ENV=production bundle exec sidekiq

data/lib/xapian_db.rb

@@ -10,7 +10,7 @@ require 'xapian'
 require 'json'
 
 do_not_require = %w(update_stopwords railtie base_adapter generic_adapter active_record_adapter datamapper_adapter
-                    beanstalk_writer resque_writer utilities install_generator datamapper)
+                    beanstalk_writer resque_writer sidekiq_writer utilities install_generator datamapper)
 files = Dir.glob("#{File.dirname(__FILE__)}/**/*.rb").reject{|path| do_not_require.include?(File.basename(path, ".rb"))}
 # Require these first
 require "#{File.dirname(__FILE__)}/xapian_db/utilities"

data/lib/xapian_db/config.rb

@@ -49,6 +49,10 @@ module XapianDb
         @config.instance_variable_get("@_resque_queue") || 'xapian_db'
       end
 
+      def sidekiq_queue
+        @config.instance_variable_get("@_sidekiq_queue") || 'xapian_db'
+      end
+
       def term_min_length
         @config.instance_variable_get("@_term_min_length") || 1
       end
@@ -70,8 +74,8 @@ module XapianDb
     # DSL methods
     # ---------------------------------------------------------------------------------
 
-    attr_reader :_database, :_adapter, :_writer, :_beanstalk_daemon, :_resque_queue, :_stemmer, :_stopper,
-                :_term_min_length, :_term_splitter_count, :_enabled_query_flags
+    attr_reader :_database, :_adapter, :_writer, :_beanstalk_daemon, :_resque_queue, :_sidekiq_queue, 
+                :_stemmer, :_stopper, :_term_min_length, :_term_splitter_count, :_enabled_query_flags
 
     # Set the global database to use
     # @param [String] path The path to the database. Either apply a file sytem path or :memory
@@ -115,6 +119,7 @@ module XapianDb
     #   - :direct ({XapianDb::IndexWriters::DirectWriter})
     #   - :beanstalk ({XapianDb::IndexWriters::BeanstalkWriter})
     #   - :resque ({XapianDb::IndexWriters::ResqueWriter})
+    #   - :sidekiq ({XapianDb::IndexWriters::SidekiqWriter})
     def writer(type)
       # We try to guess the writer name
       begin
@@ -138,6 +143,12 @@ module XapianDb
       @_resque_queue = name
     end
 
+    # Set the name of the sidekiq queue
+    # @param [String] name The name of the sidekiq queue
+    def sidekiq_queue(name)
+      @_sidekiq_queue = name
+    end
+
     # Set the language.
     # @param [Symbol] lang The language; apply the two letter ISO639 code for the language
     # @example

data/lib/xapian_db/index_writers/sidekiq_worker.rb

@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+module XapianDb
+  module IndexWriters
+    # Worker to update the Xapian index; the worker will be called by sidekiq
+    # and uses the DirectWriter to do the real work
+    # @author Michael Stämpfli and John Bradley
+    class SidekiqWorker
+
+      extend XapianDb::Utilities
+
+      APPROVED_TASKS = [:index, :delete_doc, :reindex_class]
+
+      def perform(task, options)
+        self.class.send(task, options) if APPROVED_TASKS.include?(task.to_sym)
+      end
+
+      class << self
+        def queue
+          XapianDb::Config.sidekiq_queue
+        end
+
+        def perform(task, options)
+          send(task, options) if APPROVED_TASKS.include?(task.to_sym)
+        end
+
+        def index(options)
+          klass = constantize options['class']
+          obj   = klass.respond_to?('get') ? klass.get(options['id']) : klass.find(options['id'])
+          DirectWriter.index obj
+        end
+
+        def delete_doc(options)
+          DirectWriter.delete_doc_with options['xapian_id']
+        end
+
+        def reindex_class(options)
+          klass = constantize options['class']
+          DirectWriter.reindex_class klass, :verbose => false
+        end
+      end
+    end
+  end
+end

data/lib/xapian_db/index_writers/sidekiq_writer.rb

@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+# This writer uses sidekiq to enqueue index jobs
+# @author Michael Stämpfli and John Bradley
+
+require 'sidekiq'
+
+module XapianDb
+  module IndexWriters
+    class SidekiqWriter
+
+      SidekiqWorker.class_eval do
+        include Sidekiq::Worker
+      end
+
+      class << self
+
+        # Update an object in the index
+        # @param [Object] obj An instance of a class with a blueprint configuration
+        def index(obj, commit=true)
+          Sidekiq::Client.enqueue worker_class, :index, :class => obj.class.name, :id => obj.id
+        end
+
+        # Remove an object from the index
+        # @param [String] xapian_id The document id
+        def delete_doc_with(xapian_id, commit=true)
+          Sidekiq::Client.enqueue worker_class, :delete_doc, :xapian_id => xapian_id
+        end
+
+        # Reindex all objects of a given class
+        # @param [Class] klass The class to reindex
+        def reindex_class(klass, options = {})
+          Sidekiq::Client.enqueue worker_class, :reindex_class, :class => klass.name
+        end
+
+        def worker_class
+          SidekiqWorker
+        end
+        private :worker_class
+      end
+
+    end
+  end
+end

data/lib/xapian_db/railtie.rb

@@ -49,6 +49,7 @@ module XapianDb
         config.writer @writer.try(:to_sym)
         config.beanstalk_daemon_url @beanstalk_daemon
         config.resque_queue @resque_queue
+        config.sidekiq_queue @sidekiq_queue
         config.language @language.try(:to_sym)
         config.term_min_length @term_min_length
         config.term_splitter_count @term_splitter_count
@@ -74,6 +75,7 @@ module XapianDb
       @writer               = env_config["writer"]   || :direct
       @beanstalk_daemon_url = env_config["beanstalk_daemon"]
       @resque_queue         = env_config["resque_queue"]
+      @sidekiq_queue        = env_config["sidekiq_queue"]
       @language             = env_config["language"]
       @term_min_length      = env_config["term_min_length"]
       @enable_phrase_search = env_config["enable_phrase_search"] == true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xapian_db
 version: !ruby/object:Gem::Version
-  version: 1.3.3.1
+  version: 1.3.4
 platform: ruby
 authors:
 - Gernot Kogler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-23 00:00:00.000000000 Z
+date: 2013-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: daemons
@@ -122,6 +122,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 1.19.0
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.13.0
 - !ruby/object:Gem::Dependency
   name: xapian-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -173,6 +187,8 @@ files:
 - lib/xapian_db/index_writers/no_op_writer.rb
 - lib/xapian_db/index_writers/resque_worker.rb
 - lib/xapian_db/index_writers/resque_writer.rb
+- lib/xapian_db/index_writers/sidekiq_worker.rb
+- lib/xapian_db/index_writers/sidekiq_writer.rb
 - lib/xapian_db/index_writers/transactional_writer.rb
 - lib/xapian_db/indexer.rb
 - lib/xapian_db/model_extenders/active_record.rb