redi_search_rails 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b44c7956cc281079bd1791948a8cc4f166d4711
-  data.tar.gz: cfb12628b5f38e841fc7e045fca4576796ebd841
+  metadata.gz: 382515dc3277d39c0c8389db1424fe6d73cda0ca
+  data.tar.gz: 86727dec2fe4a6e642314d0a805571dfac49efd7
 SHA512:
-  metadata.gz: 7034488828576a549979c08b50227c9ec6f854c7bf449f8168f4015b8943aeca2457e60641ab0bf74ad381a935a4c5d964f7553ed9ea19b57aed6fb375adac81
-  data.tar.gz: 6196ff4ab6d475b783f4d84de6905eedcdee6d56a5b7942ac0087dc3fead2a701b54db6cdfb34f7362ff317ba494a645be74450d14f1b5882ecbf3be472bd775
+  metadata.gz: 50dc588fb78895feefec03a17d88a080b37fab8e285519a954583401509d41b5ce5a4c30c00d387a4a68771f69a89f57db932d427d57deda660b27046268dd2c
+  data.tar.gz: ab851b7e3b939cc017c7ce0956ca6dfc3e075cf3e54e639a73cd8422d1ef5899d3861a3d9362127bb4482bec8158a312119b2e823eb227258a4a37a40f1be143

data/README.md

@@ -4,7 +4,7 @@ This gems simplifies integration with RediSearch module (http://redisearch.io/).
 
 ## Installation
 
-Install Redis and RediSearch following instructions on http://redisearch.io/Quick_Start/.  
+Install Redis and RediSearch following instructions on http://redisearch.io/Quick_Start/.  Until modules are released with Redis 4 this requires compiling Redis from unstable branch from GitHub.  
 
 Add this line to your application's Gemfile:
 
@@ -33,32 +33,43 @@ REDI_SEARCH = Redis.new(host: '127.0.0.1', port: '6379')
 ```ruby
 class User < ApplicationRecord
   include RediSearchRails
-  redisearch_schema   name: 'TEXT', email: 'TEXT', age: 'NUMERIC'
+  redi_search_schema   name: 'TEXT', email: 'TEXT', age: 'NUMERIC'
 end
-# => create index
-rails r User.ft_create
-# => populate with records
-rails r User.ft_add_all
+# => to create index run in rails console
+User.ft_create
+# => populate index with records for all users
+User.ft_add_all
+# => or you can do it for specific record
+User.ft_add(User.where(id: 1))
 # => search
-rails r "User.ft_search('query here')"
+User.ft_search('keyword here')
+# => output
+[1, "gid://application_name/User/unique_id", ["name", "Bob", "age", "100"]]
 ```
 
+As unique identifier (doc_id) for records in Redis it uses https://github.com/rails/globalid.  You need to make sure you models support it if you are using ORM other than ActiveRecord.  
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.  To understand the code look in `lib/redi_search_rails`.
 
 To install this gem onto your local machine, run `bundle exec rake install`. 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).
 
+## Testing
+
+Testing this gem requires having local Redis with RediSearch module.  This makes it very difficult to set it up with services like Codeship.  
+
 ## TODOs
 
-* Tests
+* 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
-* Rake tasks
-* ActiveModel callbacks to index records on saving
+* Support configuring SCORE, WEIGHT and other options
 * Support indexing fields from related models (index group name if user belongs to a group)
 * Stopwords configuration
 * Minimum keyword length to index
+* Configurable method for doc_id, not just default to_global_id
+* More test coverage and documentation
 
 ## Contributing
 

data/lib/redi_search_rails/version.rb

@@ -1,3 +1,3 @@
 module RediSearchRails
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/redi_search_rails.rb

@@ -1,11 +1,19 @@
 require "redi_search_rails/version"
+require "active_support/concern"
 
 module RediSearchRails
   extend ActiveSupport::Concern
 
+  included do
+  end
+
   module ClassMethods
 
-    def redisearch_schema(schema)
+    # will configure the RediSearch for the specific model
+    #
+    # @see https://github.com/dmitrypol/redi_search_rails
+    # @param schema [Hash]  name: 'TEXT', age: 'NUMERIC'
+    def redi_search_schema(schema)
       @@schema = schema.to_a.flatten
       @@fields = schema.keys
       @@model = self.name.constantize
@@ -13,8 +21,13 @@ module RediSearchRails
       @@score = 1
     end
 
-    def ft_search query
-      results = REDI_SEARCH.call('FT.SEARCH', @@index_name, query,
+    # search the index for specific keyword(s)
+    #
+    # @param keyword [String]  'some keyword'
+    # @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',
       )
@@ -24,6 +37,9 @@ module RediSearchRails
       return e.message
     end
 
+    # create index for specific model
+    #
+    # @return [String]
     def ft_create
       REDI_SEARCH.call('FT.CREATE', @@index_name,
         #'NOFIELDS', 'NOSCOREIDX', 'NOOFFSETS',
@@ -35,6 +51,9 @@ module RediSearchRails
       return e.message
     end
 
+    # index all records in specific model
+    #
+    # @return [String]
     def ft_add_all
       @@model.all.each {|record| ft_add(record) }
     rescue Exception => e
@@ -42,6 +61,10 @@ module RediSearchRails
       return e.message
     end
 
+    # index specific record
+    #
+    # @param record [Object] Object to index
+    # @return [String]
     def ft_add record
       fields = []
       @@fields.each { |field| fields.push(field, record.send(field)) }
@@ -55,13 +78,21 @@ module RediSearchRails
       return e.message
     end
 
-    def ft_del doc_id
+    # delete specific document from index
+    #
+    # @param record [Object] Object to delete
+    # @return [String]
+    def ft_del record
+      doc_id = record.to_global_id
       REDI_SEARCH.call('FT.DEL', @@index_name, doc_id)
     rescue Exception => e
       Rails.logger.error e
       return e.message
     end
 
+    # optimize specific index
+    #
+    # @return [String]
     def ft_optimize
       REDI_SEARCH.call('FT.OPTIMIZE', @@index_name)
     rescue Exception => e
@@ -69,6 +100,9 @@ module RediSearchRails
       return e.message
     end
 
+    # drop specific index
+    #
+    # @return [String]
     def ft_drop
       REDI_SEARCH.call('FT.DROP', @@index_name)
     rescue Exception => e
@@ -76,8 +110,11 @@ module RediSearchRails
       return e.message
     end
 
+    # get info about specific index
+    #
+    # @return [String]
     def ft_info
-      ap REDI_SEARCH.call('FT.INFO', @@index_name)
+      REDI_SEARCH.call('FT.INFO', @@index_name)
     rescue Exception => e
       Rails.logger.error e
       return e.message

data/redi_search_rails.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "activemodel", "~> 5.0.0"
   # =>
   spec.add_runtime_dependency "activesupport", "~> 5.0.0"
   spec.add_runtime_dependency "redis", "~> 3.3"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redi_search_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dmitry Polyakovsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-06 00:00:00.000000000 Z
+date: 2017-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement