redis-search 1.0.0.beta1 → 1.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3db9e3cf11d6d82edb9366ec887db853a684468
-  data.tar.gz: 349c2ad7333803b7f868cabd5ee4053f216b9e14
+  metadata.gz: 7f2a414c25a8c0f48c9cc236fdb4c905da7bd5e4
+  data.tar.gz: 3b9074ed892c0711245c342fcd1c381140ea17d8
 SHA512:
-  metadata.gz: e1d2dcf8826e6c4e0e3a9414fdc0a8f1b11fc9d0cf024f5c6d5ab27e56e7da3c436f5ab20d1c487f6e2feab09d24462de24cee03209ecccf5c4ce7c51a56d423
-  data.tar.gz: 9389c3f640c4ff76719507d681fb0d8ba4bc24cb7d36544617c76c4d209709121ec87e052e2ae4e6d52ecbb9cba3e09b212aafc1fa07e025c1dbc0a840dffbf1
+  metadata.gz: 765e256b56b74776f33275ddfe8dfb8aac31ccfd283398d27e29057eb94e2db3808f1dd3ac2025a7dbe34ac10b0e9a23d5a31bbc2fd5e061e591be6af4662433
+  data.tar.gz: b1b642a1701492a20b2b5db3856e03ac787f28e6a1e0aa57791445f5cffd27248c6a4d7a77c0e4dd47ef9f4ae67d18d391f06f5f538ebb290f0deb7260552ae6

data/README.md

@@ -13,7 +13,7 @@ High performance real-time search (Support Chinese), index in Redis for Rails ap
 
 * Real-time search
 * High performance
-* Segment words search and prefix match search
+* Prefix match search
 * Support match with alias
 * Support ActiveRecord and Mongoid
 * Sort results by one field
@@ -54,8 +54,6 @@ Redis::Search.configure do |config|
   config.redis = redis
   config.complete_max_length = 100
   config.pinyin_match = true
-  # use rmmseg, true to disable it, it can save memroy
-  config.disable_rmmseg = false
 end
 ```
 
@@ -70,10 +68,10 @@ class Post < ActiveRecord::Base
   belongs_to :user
   belongs_to :category
 
-  redis_search_index(title_field: :title,
-                     score_field: :hits,
-                     condition_fields: [:user_id, :category_id],
-                     ext_fields: [:category_name])
+  redis_search title_field: :title,
+               score_field: :hits,
+               condition_fields: [:user_id, :category_id],
+               ext_fields: [:category_name]
 
   def category_name
     self.category.name
@@ -87,24 +85,18 @@ class User < ActiveRecord::Base
 
   serialize :alias_names, Array
 
-  redis_search_index(title_field: :name,
-                     alias_field: :alias_names,
-                     prefix_index_enable: true,
-                     score_field: :followers_count,
-                     ext_fields: [:email, :tagline])
+  redis_search title_field: :name,
+               alias_field: :alias_names,
+               score_field: :followers_count,
+               ext_fields: [:email, :tagline]
 end
 ```
 
 ```ruby
 class SearchController < ApplicationController
-  # GET /searchs?q=title
-  def index
-    Redis::Search.query("Post", params[:q], conditions: { user_id: 12 })
-  end
-
   # GET /search_users?q=j
   def search_users
-    Redis::Search.complete("Post", params[:q], conditions: { user_id: 12, category_id: 4 })
+    Post.prefix_match(params[:q], conditions: { user_id: 12, category_id: 4 })
   end
 end
 ```

data/lib/redis-search/base.rb

@@ -38,8 +38,7 @@ class Redis
         exts: redis_search_fields_to_hash(redis_search_options[:ext_fields]),
         type: redis_search_options[:class_name] || self.class.name,
         condition_fields: redis_search_options[:condition_fields],
-        score: send(redis_search_options[:score_field]).to_i,
-        prefix_index_enable: redis_search_options[:prefix_index_enable]
+        score: send(redis_search_options[:score_field]).to_i
       }
 
       s = Search::Index.new(opts)
@@ -114,13 +113,11 @@ class Redis
       # == Params:
       #   title_field   Query field for Search
       #   alias_field   Alias field for search, can accept multi field (String or Array type) it type is String, redis-search will split by comma
-      #   prefix_index_enable   Is use prefix index search
       #   ext_fields    What kind fields do you need inlucde to search indexes
       #   score_field   Give a score for search sort, need Integer value, default is `created_at`
-      def redis_search_index(opts = {})
+      def redis_search(opts = {})
         opts[:title_field] ||= :title
         opts[:alias_field] ||= nil
-        opts[:prefix_index_enable] ||= false
         opts[:ext_fields] ||= []
         opts[:score_field] ||= :created_at
         opts[:condition_fields] ||= []
@@ -139,6 +136,15 @@ class Redis
         class_variable_set('@@redis_search_options'.freeze, opts)
       end
 
+      def redis_search_index(opts = {})
+        Kernel.warn 'DEPRECATION WARNING: redis_search_index is deprecated, use redis_search instead. '
+        redis_search(opts)
+      end
+
+      def prefix_match(q, opts = {})
+        Redis::Search.complete(self.name, q, opts)
+      end
+
       def redis_search_index_batch_create(batch_size = 1000, progressbar = false)
         count = 0
         if ancestors.collect(&:to_s).include?('ActiveRecord::Base'.freeze)

data/lib/redis-search/config.rb

@@ -5,12 +5,6 @@ class Redis
 
       def configure
         yield @config ||= Config.new
-
-        unless @config.disable_rmmseg
-          require 'rmmseg'
-          # loading RMMSeg chinese word dicts.
-          RMMSeg::Dictionary.load_dictionaries
-        end
       end
     end
 
@@ -29,15 +23,12 @@ class Redis
       # When you search "de" will -> 得|的|德...
       # When you search "得" will -> "de" -> 得|的|德...
       attr_accessor :pinyin_match
-      # Disable RMMSeg, if you don't need, disable this will save memory. (true|false) default = true
-      attr_accessor :disable_rmmseg
 
       def initialize
         @debug               = false
         @redis               = nil
         @complete_max_length = 100
         @pinyin_match        = false
-        @disable_rmmseg      = false
       end
     end
   end

data/lib/redis-search/finder.rb

@@ -2,11 +2,6 @@
 class Redis
   module Search
     class << self
-      # use rmmseg to split words
-      def split(text)
-        _split(text)
-      end
-
       # Use for short title search, this method is search by chars, for example Tag, User, Category ...
       #
       # h3. params:
@@ -98,108 +93,13 @@ class Redis
         hmget(type, ids)
       end
 
-      # Search items, this will split words by Libmmseg
-      #
-      # h3. params:
-      #   type      model name
-      #   text         search text
-      #   :limit    result limit
-      #
-      # h3. usage:
-      # * Redis::Search.query("Tag","Ruby vs Python")
-      #
-      def query(type, text, options = {})
-        tm         = Time.now
-        result     = []
-        limit      = options[:limit] || 10
-        sort_field = options[:sort_field] || 'id'
-        conditions = options[:conditions] || []
-
-        # 如果搜索文本和查询条件均没有，那就直接返回 []
-        return result if text.strip.blank? && conditions.blank?
-
-        words = split(text)
-        words = words.collect { |w| mk_sets_key(type, w) }
-
-        condition_keys = []
-        unless conditions.blank?
-          conditions = conditions[0] if conditions.is_a?(Array)
-          conditions.keys.each do |c|
-            condition_keys << mk_condition_key(type, c, conditions[c])
-          end
-          # 将条件的 key 放入关键词搜索集合内，用于 sinterstore 搜索
-          words += condition_keys
-        end
-
-        return result if words.blank?
-
-        temp_store_key = "tmpinterstore:#{words.join('+')}"
-
-        if words.length > 1
-          unless config.redis.exists(temp_store_key)
-            config.redis.pipelined do
-              # 将多个词语组合对比，得到交集，并存入临时区域
-              config.redis.sinterstore(temp_store_key, *words)
-              # 将临时搜索设为1天后自动清除
-              config.redis.expire(temp_store_key, 86_400)
-
-              # 拼音搜索
-              if config.pinyin_match
-                pinyin_words = split_pinyin(text)
-                pinyin_words = pinyin_words.collect { |w| mk_sets_key(type, w) }
-                pinyin_words += condition_keys
-                temp_sunion_key = "tmpsunionstore:#{words.join('+')}"
-                temp_pinyin_store_key = "tmpinterstore:#{pinyin_words.join('+')}"
-                # 找出拼音的
-                config.redis.sinterstore(temp_pinyin_store_key, *pinyin_words)
-                # 合并中文和拼音的搜索结果
-                config.redis.sunionstore(temp_sunion_key, *[temp_store_key, temp_pinyin_store_key])
-                # 将临时搜索设为1天后自动清除
-                config.redis.expire(temp_pinyin_store_key, 86_400)
-                config.redis.expire(temp_sunion_key, 86_400)
-              end
-              temp_store_key = temp_sunion_key
-            end
-          end
-        else
-          temp_store_key = words.first
-        end
+      alias_method :query, :complete
 
-        # 根据需要的数量取出 ids
-        ids = config.redis.sort(temp_store_key,
-                                limit: [0, limit],
-                                by: mk_score_key(type, '*'),
-                                order: 'desc')
-        result = hmget(type, ids, sort_field: sort_field)
-        info("{#{type} : \"#{text}\"} | Time spend: #{Time.now - tm}s")
-        result
-      end
     end # end class << self
 
-    protected
-
-    def self.split_pinyin(text)
-      # Pinyin search split as pinyin again
-      _split(PinYin.sentence(text))
-    end
 
     private
 
-    def self._split(text)
-      return [] if text.blank?
-      # return chars if disabled rmmseg
-      return text.split('') if Search.config.disable_rmmseg
-
-      algor = RMMSeg::Algorithm.new(text)
-      words = []
-      loop do
-        tok = algor.next_token
-        break if tok.nil?
-        words << tok.text
-      end
-      words
-    end
-
     def self.warn(msg)
       return unless Redis::Search.config.debug
       msg = "\e[33m[redis-search] #{msg}\e[0m"

data/lib/redis-search/index.rb

@@ -3,7 +3,7 @@ class Redis
   module Search
     class Index
       attr_accessor :type, :title, :id, :score, :aliases, :exts,
-                    :condition_fields, :prefix_index_enable
+                    :condition_fields
 
       class << self
         def redis
@@ -27,20 +27,6 @@ class Redis
           end
         end
 
-        def split_words_for_index(title)
-          words = Search.split(title)
-          if Search.config.pinyin_match
-            # covert Chinese to pinyin to as an index
-            pinyin_full = Search.split_pinyin(title)
-            pinyin_first = pinyin_full.collect { |p| p[0] }.join('')
-            words += pinyin_full
-            words << pinyin_first
-            pinyin_full = nil
-            pinyin_first = nil
-          end
-          words.uniq
-        end
-
         def bm
           t1 = Time.now
           yield
@@ -58,7 +44,6 @@ class Redis
         @condition_fields    = []
         @exts                = []
         @aliases             = []
-        @prefix_index_enable = false
 
         # set attributes value from params
         options.keys.each do |k|
@@ -98,7 +83,7 @@ class Redis
           end
 
           # 建立前缀索引
-          save_prefix_index if prefix_index_enable
+          save_prefix_index
         end
       end
 
@@ -115,7 +100,7 @@ class Redis
           redis.sadd(Search.mk_sets_key(@type, val), @id)
 
           if Search.config.pinyin_match
-            pinyin_full = Search.split_pinyin(val.downcase)
+            pinyin_full = self.class.split_pinyin(val.downcase)
             pinyin_first = pinyin_full.collect { |p| p[0] }.join('')
             pinyin = pinyin_full.join('')
 
@@ -123,10 +108,6 @@ class Redis
             words << pinyin_first
 
             redis.sadd(Search.mk_sets_key(@type, pinyin), @id)
-
-            pinyin_full = nil
-            pinyin_first = nil
-            pinyin = nil
           end
 
           words.each do |word|
@@ -140,6 +121,25 @@ class Redis
 
         redis.zadd(sorted_set_key, sorted_vals)
       end
+
+      def self.split_words_for_index(title)
+        words = title.split('')
+        if Search.config.pinyin_match
+          # covert Chinese to pinyin to as an index
+          pinyin_full = split_pinyin(title)
+          pinyin_first = pinyin_full.collect { |p| p[0] }.join('')
+          words += pinyin_full
+          words << pinyin_first
+        end
+        words.uniq
+      end
+
+      def self.split_pinyin(text)
+        # Pinyin search split as pinyin again
+        pinyin = PinYin.sentence(text)
+        pinyin.split(' ')
+      end
+
     end # end Index
   end
 end

data/lib/redis-search/version.rb

@@ -1,5 +1,5 @@
 class Redis
   module Search
-    VERSION = '1.0.0.beta1'
+    VERSION = '1.0.0.beta2'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-search
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta1
+  version: 1.0.0.beta2
 platform: ruby
 authors:
 - Jason Lee