redisearch-rails 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08ae96ed9f5d7036aad94a3963da45cec27e49590fedefbed55a60bd499f488b'
-  data.tar.gz: 2edcd21c9630847d45069fb0c4c5bc72c38bb1adc06aa2ee4a6744d277380b8d
+  metadata.gz: 389ea395f1fe1ef5130083e382f435fa4515d1ab3f9952f4bc660eed47838d40
+  data.tar.gz: cb56f462ab039f9b93eb7c9310cbd50a3a9678a1b2eb1d2c4205caec3066754c
 SHA512:
-  metadata.gz: 45aba119df5a95c0f5be05163ea13ed160e7f5a855100f76ad831019a42d3abd67e651f7070da40895a3769b36c21498aba810ba9145e017e5f16b6a4671f670
-  data.tar.gz: 30ebd3627d3efebc36d191ae04edada8115d946db74f1111f16dc56ef6b779763187908b351e6ca8d2412bf92ad275cc2a6be0c838a919b1e6a43b729a27a562
+  metadata.gz: 9f534dafaba92007233233420f17b7230f521df2d7a82b785b6cc2c35d03201d37c38ecbb4913aa90500aedc690cd9fd8840919261234c70626f9202f9dd83b1
+  data.tar.gz: 650c151013343ab35936a565b9ad657f54fc978ee64ed77ddec04fa04751d2b513318e8c25f4327756779305996526b768e2b6bc4f6fc717d16224b9607f5227

data/README.md

@@ -1,12 +1,14 @@
-# Redisearch::Rails
+# Redisearch-rails
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/redisearch/rails`. To experiment with that code, run `bin/console` for an interactive prompt.
+Adds support for easily indexing and search ActiveRecord models using RediSearch module http://redisearch.io/
 
-TODO: Delete this and the text above, and describe your gem
+# Getting started
 
-## Installation
+First you need a Redisearch Service running, please follow [Quick Start](https://oss.redislabs.com/redisearch/Quick_Start.html) documentation.
 
-Add this line to your application's Gemfile:
+Redisearch-rails is compatible with Rails `~> 4.2` on Ruby `2.3` and later.
+
+In your Gemfile, for the last officially released gem:
 
 ```ruby
 gem 'redisearch-rails'
@@ -14,30 +16,172 @@ gem 'redisearch-rails'
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle install
+```
+
+Once the gem installed you will need to add the configuration to cannect to redisearch.
 
-Or install it yourself as:
+Go to your initializers (`config/initializers`), add a new file and call it `redisearch.rb`
+
+```ruby
+RediSearch.configure do |config|
+  config.redis_config = {
+    host: '127.0.0.1',
+    port: '6379',
+    db: 0, # this has to be 0
+#   password: 'some password' #(optional)
+  }
+end
+```
 
-    $ gem install redisearch-rails
 
 ## Usage
 
-TODO: Write usage instructions here
+To integrate Redisearch for Rails only you need to call `redisearch` method defining the Redisearch `schema` inside of your ActiveRecord Model.
 
-## Development
+```ruby
+class User < ActiveRecord::Base
+  redisearch schema: {
+    first_name: { text: { phonetic: "dm:es" } },
+    last_name: { text: { phonetic: "dm:es" } },
+    email: :text,
+    age: :numeric
+  }
+end
+```
 
-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.
+This will add the `reindex` and `rediseach` class methods.
 
-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).
+Now you can index all the recods, using `User.reindex` and search using `redisearch` method with [RediSearch Query Syntax](https://oss.redislabs.com/redisearch/Query_Syntax.html).
 
-## Contributing
+```ruby
+irb(main):004:0> User.redisearch('@first_name:(Jon|Jane) @last_name:"Doe"')
+  User Load (0.5ms)  SELECT  `users`.* FROM `users` WHERE `users`.`id` IN (2, 1)
+=> [#<User id: 1, email: "jon@test.com", first_name: "Jon", last_name: "Doe", created_at: "2020-1-06 19:21:36", updated_at: "2020-1-06 19:24:43", age: 15>, #<User id: 2, email: "Jane@other.com", first_name: "Jane", last_name: "Doe", created_at: "2020-1-06 22:19:00", updated_at: "2020-1-06 22:19:00", age: 20>]
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/pbeckmann/redisearch-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
-## License
+## Indexing
+Each Model with defined `redisearch` is a **Redisearch Index** representation, and an instantiated Object its a **Redisearch Document** where the ID attribute of the instance is the ID of the Document.
+
+By default, `reindex` will use `all` scope for find, you can change overwriting the scope
+
+```ruby
+class User < ActiveRecord::Base
+  scope :redisearch_import, -> { where(email: 'some@email.com') }
+end
+```
+
+If you need to recreate the Index, you can use `recreate: true` option on `reindex`
+
+```ruby
+irb(main):004:0> User.reindex(recreate: true)
+=> nil
+```
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+this will drop the **Index** with all the **Documents** and start to reindexing.
 
-## Code of Conduct
+### Custom Attributes
+You can use Custom attributes defining a method or attr_accessor.
+
+```ruby
+# == Schema Information
+#
+# Table name: users
+#  first_name             :string(255)
+#  last_name              :string(255)
+#  email                  :string(255)      default(""), not null
+#  company_id             :integer
+#
+class User < ActiveRecord::Base
+  redisearch schema: {
+    full_name: { text: { phonetic: "dm:es" } },
+    company_name: :text
+  }
+
+  belongs_to :company
+
+  scope :redisearch_import, -> { all.includes(:company) }
+
+  after_commit :redisearch_add, on: [ :create, :update ]
+  after_commit :redisearch_delete, on: :destroy
+
+  def company_name
+    company.name
+  end
+
+  def full_name
+    "#{first_name} #{last_name}"
+  end
+
+  private
+
+  def redisearch_add
+    redisearch_document.add(replace: true, partial: true)
+  end
+
+  def redisearch_delete
+    redisearch_document.del(dd: true)
+  end
+
+end
+```
+
+You can add a Serializer to the indexer like this
+
+```ruby
+# == Schema Information
+#
+# Table name: company
+#  name             :string(255)
+#
+class Company < ActiveRecord::Base
+  redisearch schema: {
+    name: { :text },
+    users_ids: :tag # Array
+  }, index_serializer: Company::RedisearchSerlializer
+  has_many :users
+
+  scope :redisearch_import, -> { includes(:users) }
+end
+
+class Company::RedisearchSerlializer
+  attr_reader :company
+
+  def initialize(company)
+    @company = company
+  end
+
+  def users_ids
+    company.users.ids #Array of ids
+  end
+end
+```
+
+
+
+
+## Search
+
+Simply use the `redisearch` method with a [RediSearch Query Syntax](https://oss.redislabs.com/redisearch/Query_Syntax.html).
+
+This ask to Redisearch the Documents ids and then use ActiveRecord find method to brings the elements.
+
+## TODOs
+
+* ActiveModel callbacks to index records on saving and remove from Redis on delete
+* More Configurations like batch size when reindexing
+* Support GEO filters
+* Stopwords configuration
+* Configurable doc_id reference, for now use ID and find method to search
+* Test coverage and better documentation
+* Multiple redisearch indexes for the same model
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Ticketplus/redisearch-rails. This project is intended to be a safe, welcoming space for collaboration.
+
+## License
 
-Everyone interacting in the Redisearch::Rails project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/pbeckmann/redisearch-rails/blob/master/CODE_OF_CONDUCT.md).
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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

@@ -2,10 +2,11 @@ module RediSearch
   module RediSearchable
     module ClassMethods
 
-      attr_reader :redisearch_index
+      attr_reader :redisearch_index, :redisearch_index_serializer
 
       def redisearch(*args, schema:, **options)
         prefix = options[:prefix]
+        @redisearch_index_serializer = options[:index_serializer]
 
         index_name = [prefix, model_name.plural].compact.join("_")
         @redisearch_index = RediSearch.client.generate_index(index_name, schema)
@@ -23,6 +24,7 @@ module RediSearch
       def redisearch(query, **options)
         result = redisearch_index.search(query, options.deep_merge(nocontent: true))
         result.shift # remove the first element (count)
+        result.map! { |elem| elem.sub("#{redisearch_index.name}_", '')}
         self.find(result)
       end
 

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

@@ -10,13 +10,18 @@ module RediSearch
 
       def generate_redisearch_document
         index = self.class.redisearch_index
+        serializer = redisearch_serializer || self
         fields = index.schema.fields.map(&:name)
-        fields_values = Hash[fields.flatten.map! { |field| [field, public_send(field)] }]
+        fields_values = Hash[fields.flatten.map! { |field| [field, serializer.public_send(field)] }]
         index.generate_document(redisearch_document_id, fields_values)
       end
 
       def redisearch_document_id
-        "0#{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
 
     end

data/lib/redisearch-rails/version.rb

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

data/redisearch-rails.gemspec

@@ -29,6 +29,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'redi_searcher', '~> 0.1', '>= 0.1.3'
 
   spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redisearch-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Patricio Beckmann
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-28 00:00:00.000000000 Z
+date: 2020-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -76,16 +76,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -112,7 +112,6 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile

data/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2020 Ticketplus.cl
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.