redi_search_rails 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53fd6d815f84aaacba7a129c7e5bd574124b1937
-  data.tar.gz: 6e00184db536350ce5e3d30e9c25f182b7fb8ea1
+  metadata.gz: 8bac86f5f0acbceaf4952a150531ddedc0c59e72
+  data.tar.gz: 1dbe06379bff95b1ef9d81e328871e808f693a47
 SHA512:
-  metadata.gz: 914e17adff80e11950a6b63af883ef90b9e1bd97f2884e07b6ceea8d3d7f177d46e5411dcee5c879100d2a353943b5b506fab71dc4b411d362400060f2e6130b
-  data.tar.gz: 730fb0ee494f8c79c7d5ffd6f28edc59b720737f5ae1d8855c8e522487ccb1816e24011030e1250a03055f496709965ffeadae642d3db355081abb3b9f638a0c
+  metadata.gz: fe54ebbd8202130643d8cedc40158faf6edd830f7ad524c4fdbf7864c734ca4f8738559cfee67a65580387fd4501052396337e654195f9722c1621f3f721ea19
+  data.tar.gz: a0c895f524468aa0f5777eff292f82512f148cbe7db3488fd951dd639010d559b28e5e3814e5e9d83d1856048ed4a149b4e15387b29237e8646b69f693aeb9fa

data/CHANGELOG.md

@@ -0,0 +1,37 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+### Added
+
+### Changed
+
+### Removed
+
+### Fixed
+
+## 0.1.3 - 2017-05-19
+
+### Added
+- ft_search_format and ft_search_count methods
+- ft_search_format returns array of objects
+- ft_add_hash and ft_del_all methods
+- ft_sug* methods
+
+### Changed
+- ft_search returns raw FT.SEARCH results
+- switched to keyword arguments
+- passing offset and num to FT.SEARCH
+
+## 0.1.2 - 2017-04-23
+
+### Fixed
+- variable scope with redi_search_schema
+
+### Changed
+- changed ft_search output to be an array of hashes
+- changed dependencies to > Rails 4.2.8

data/README.md

@@ -1,5 +1,9 @@
 # RediSearchRails
 
+[![Code Climate](https://codeclimate.com/github/dmitrypol/redi_search_rails.svg)](https://codeclimate.com/github/dmitrypol/redi_search_rails)
+[![Inline docs](http://inch-ci.org/github/dmitrypol/redi_search_rails.svg?branch=master)](http://inch-ci.org/github/dmitrypol/redi_search_rails)
+[![Gem Version](https://badge.fury.io/rb/redi_search_rails.svg)](http://badge.fury.io/rb/redi_search_rails)
+
 This gems simplifies integration with RediSearch module (http://redisearch.io/).  This software is of Alpha quality and is provided with no warranties whatsoever.  Additionally RediSearch is still not officially released so major features may change.  
 
 ## Installation
@@ -42,7 +46,11 @@ User.ft_add_all
 # => or you can do it for specific record
 User.ft_add(User.where(id: 1))
 # => search
-User.ft_search('keyword here')
+User.ft_search(keyword: 'keyword here', offset: 0, num: 10)
+# => output
+[1, "gid://application_name/User/unique_id", ["name", "Bob", "age", "100"]]
+# => format results as array of objects
+User.ft_search_format(keyword: 'keyword here', offset: 0, num: 10)
 # => output
 [{"id": "gid://application_name/User/unique_id", "name": "Bob", "age": "100"}, {...}]
 ```
@@ -63,9 +71,9 @@ Testing this gem requires having local Redis with RediSearch module.  This makes
 
 * ActiveModel callbacks to index records on saving and remove from Redis on delete
 * Rake tasks to manage indexes
-* Support additional RediSearch API calls (SUGGADD, SUGGET, ...)
 * Support configuring SCORE, WEIGHT and other options
 * Support indexing fields from related models (index group name if user belongs to a group)
+* Support GEO filters
 * Stopwords configuration
 * Minimum keyword length to index
 * Configurable method for doc_id, not just default to_global_id

data/lib/redi_search_rails.rb

@@ -1,5 +1,6 @@
 require "redi_search_rails/version"
 require "active_support/concern"
+require "ostruct"
 
 module RediSearchRails
   extend ActiveSupport::Concern
@@ -24,15 +25,37 @@ module RediSearchRails
     # search the index for specific keyword(s)
     #
     # @param keyword [String]  'some keyword'
-    # @return [Array]   [{"id": "gid://application_name/User/unique_id", "name": "Bob", "age": "100"}, ...]
+    # @param offset [Integer]   default 0
+    # @param keyword [Integer]  default 10
+    # @return [Array]   [1, "gid://application_name/User/unique_id", ["name", "Bob", "age", "100"]]
     # @raise [RuntimeError]
-    def ft_search keyword
-      results = REDI_SEARCH.call('FT.SEARCH', @index_name, keyword,
-       #'LIMIT', 0, 1000,
-       #'NOCONTENT', #'VERBATIM',  #'WITHSCORES', #'NOSTOPWORDS', #'WITHPAYLOADS',
-      )
-      # => [1, "gid://application_name/User/unique_id", ["name", "Bob", "age", "100"]]
-      # => transform into array of hashes
+    def ft_search keyword:, offset: 0, num: 10, filter: {}
+      if filter[:numeric_field].blank?
+        results = REDI_SEARCH.call('FT.SEARCH', @index_name, keyword.strip,
+          'LIMIT', offset, num)
+      else
+        results = REDI_SEARCH.call('FT.SEARCH', @index_name, keyword.strip,
+          'LIMIT', offset, num,
+          'FILTER', filter[:numeric_field], filter[:min], filter[:max]
+        )
+      end
+      #'NOCONTENT', 'VERBATIM',  'WITHSCORES', 'NOSTOPWORDS', 'WITHPAYLOADS',
+      #'INKEYS', 'INFIELDS', 'SLOP', 'LANGUAGE', 'EXPANDER', 'SCORER', 'PAYLOAD', 'SORTBY'
+      return results
+    rescue Exception => e
+      Rails.logger.error e if defined? Rails
+      return e.message
+    end
+
+    # search the index for specific keyword(s) and return output as array of objects
+    #
+    # @param keyword [String]  'some keyword'
+    # @param offset [Integer]   default 0
+    # @param keyword [Integer]  default 10
+    # @return [Array]   [{"id": "gid://application_name/User/unique_id", "name": "Bob", "age": "100"}, ...]
+    def ft_search_format(args)
+      results = ft_search(args)
+      # => transform into array of objects
       output = []
       results.shift  # => remove count
       results.each_slice(2) do |result|
@@ -40,7 +63,8 @@ module RediSearchRails
         result[1].each_slice(2) do |attribute|
           attributes[attribute[0]] = attribute[1]
         end
-        output << {id: result[0]}.merge(attributes)
+        hash = {id: result[0]}.merge(attributes)
+        output << OpenStruct.new(hash)
       end
       return output
     rescue Exception => e
@@ -48,13 +72,24 @@ module RediSearchRails
       return e.message
     end
 
+    # number of records found for keywords
+    #
+    # @param keyword [Hash]  keyword that gets passed to ft_search
+    # @return [Integer]   number of results matching the search
+    def ft_search_count(args)
+      ft_search(args).first
+    rescue Exception => e
+      Rails.logger.error e if defined? Rails
+      return e.message
+    end
+
     # create index for specific model
     #
     # @return [String]
     def ft_create
       REDI_SEARCH.call('FT.CREATE', @index_name,
-        #'NOFIELDS', 'NOSCOREIDX', 'NOOFFSETS',
         'SCHEMA', @schema
+        #'NOFIELDS', 'NOSCOREIDX', 'NOOFFSETS',
       )
       ft_optimize
     rescue Exception => e
@@ -66,7 +101,8 @@ module RediSearchRails
     #
     # @return [String]
     def ft_add_all
-      @model.all.each {|record| ft_add(record) }
+      @model.all.each {|record| ft_add(record: record) }
+      ft_optimize
     rescue Exception => e
       Rails.logger.error e if defined? Rails
       return e.message
@@ -76,24 +112,46 @@ module RediSearchRails
     #
     # @param record [Object] Object to index
     # @return [String]
-    def ft_add record
+    def ft_add record:
       fields = []
       @fields.each { |field| fields.push(field, record.send(field)) }
       REDI_SEARCH.call('FT.ADD', @index_name, record.to_global_id.to_s, @score,
         'REPLACE',
-        #'NOSAVE', 'PAYLOAD', record.name,
         'FIELDS', fields
+        #'NOSAVE', 'PAYLOAD', 'LANGUAGE'
       )
     rescue Exception => e
       Rails.logger.error e if defined? Rails
       return e.message
     end
 
+    # index existing Hash
+    #
+    # @param record [string] key of existing HASH key in Redis that will hold the fields the index needs.
+    # @return [String]
+    def ft_addhash redis_key:
+      REDI_SEARCH.call('FT.ADDHASH', @index_name, redis_key, @score, 'REPLACE')
+    rescue Exception => e
+      Rails.logger.error e if defined? Rails
+      return e.message
+    end
+
+    # delete all records in specific model
+    #
+    # @return [String]
+    def ft_del_all
+      @model.all.each {|record| ft_del(record: record) }
+      ft_optimize
+    rescue Exception => e
+      Rails.logger.error e if defined? Rails
+      return e.message
+    end
+
     # delete specific document from index
     #
     # @param record [Object] Object to delete
     # @return [String]
-    def ft_del record
+    def ft_del record:
       doc_id = record.to_global_id
       REDI_SEARCH.call('FT.DEL', @index_name, doc_id)
     rescue Exception => e
@@ -131,6 +189,82 @@ module RediSearchRails
       return e.message
     end
 
+    # add all values for a model attribute to autocomplete
+    #
+    # @param attribute [String] - name, email, etc
+    def ft_sugadd_all (attribute:)
+      @model.all.each {|record| ft_sugadd(record: record, attribute: attribute) }
+    rescue Exception => e
+      Rails.logger.error e if defined? Rails
+      return e.message
+    end
+
+    # add string to autocomplete dictionary
+    #
+    # @param record [Object] object
+    # @param attribute [String] - name, email, etc
+    # @param score [Integer] - score
+    # @return [Integer] - current size of the dictionary
+    def ft_sugadd (record:, attribute:, score: 1)
+      # => combine model with attribute to create unique key like user_name
+      key = "#{@model.to_s}:#{attribute}"
+      string = record.send(attribute)
+      REDI_SEARCH.call('FT.SUGADD', key, string, score)
+      # => INCR
+    rescue Exception => e
+      Rails.logger.error e if defined? Rails
+      return e.message
+    end
+
+    # query dictionary for suggestion
+    #
+    # @param attribute [String] - name, email, etc
+    # @param prefix [String] - prefix to query dictionary
+    # @return [Array] - suggestions for prefix
+    def ft_sugget (attribute:, prefix:)
+      key = "#{@model}:#{attribute}"
+      REDI_SEARCH.call('FT.SUGGET', key, prefix)
+    rescue Exception => e
+      Rails.logger.error e if defined? Rails
+      return e.message
+    end
+
+    # delete all values for a model attribute to autocomplete
+    #
+    # @param attribute [String] - name, email, etc
+    def ft_sugdel_all (attribute:)
+      @model.all.each {|record| ft_sugdel(record: record, attribute: attribute) }
+    rescue Exception => e
+      Rails.logger.error e if defined? Rails
+      return e.message
+    end
+
+    # delete a string from a suggestion index.
+    #
+    # @param attribute [String]
+    # @param value [String] - string to delete
+    # @return [Integer] - 1 if found, 0 if not
+    def ft_sugdel (record:, attribute:)
+      key = "#{@model}:#{attribute}"
+      string = record.send(attribute)
+      REDI_SEARCH.call('FT.SUGDEL', key, string)
+    rescue Exception => e
+      Rails.logger.error e if defined? Rails
+      return e.message
+    end
+
+    # size of dictionary
+    #
+    # @param attribute [String]
+    # @return [Integer] - number of possible suggestions
+    def ft_suglen (attribute:)
+      key = "#{@model}:#{attribute}"
+      REDI_SEARCH.call('FT.SUGLEN', key)
+    rescue Exception => e
+      Rails.logger.error e if defined? Rails
+      return e.message
+    end
+
   end
 
 end

data/lib/redi_search_rails/version.rb

@@ -1,3 +1,3 @@
 module RediSearchRails
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redi_search_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Dmitry Polyakovsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-23 00:00:00.000000000 Z
+date: 2017-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -118,6 +118,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -149,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Simplifies integration with http://redisearch.io/.