activerecord-search 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 217894347fbc21e9e8da4a2f689545b07e40d686
-  data.tar.gz: 65347e45036d075da50cbb653c649c787a2c5241
+  metadata.gz: 7ff2752e5628305c3b0fa90597daa07c5d4ae703
+  data.tar.gz: 6105dd3dc5fcfd2dfc5133eef9eefc3aed36aba4
 SHA512:
-  metadata.gz: 0d46b3eab25c60f7f1efac04c6888331fbf154dffbca141e353a4f6afccc31b08dc90c59867f86cb48bff6bf241a5c23f5a330a684874da904d6714eda8c7651
-  data.tar.gz: ab40537696a950a5f04cf8be2c60e6ac6cafc788819ddb0f803a13c89842e6829200e3dde031659f47873f983197f9a5802ffb33aff162fed8c4d3756247da7d
+  metadata.gz: df000a180adcdd0645d478d45bdaba4c4857a3ffedcd1b42bd1bde69b2ba0fae6397d5e11b0e2a7a01742dc4045772be6c12d3854eeb4fe001e6310f931fcbdf
+  data.tar.gz: b760b7dc43af4a0c31fc078cc0d93349598759516f3a318e9b1c7909e8b09cd01f61015a01b244b3694e181c6763c2da65b0acc28b14d7e8dd01b3a84e88c121

data/README.md

@@ -27,7 +27,6 @@ Below is an example of the features offered by this plugin:
 Use case:
 
 A model named Post that contains 2 fields: `title:string` and `content:text`.
-We want to search any posts that include `Ruby` in their content:
 
 ##### In `app/models/posts.rb`:
 
@@ -43,7 +42,15 @@ end
 class PostsController < ApplicationController
 
     def index
-        Post.search_post("Ruby")
+        Post.search_post("Ruby") # It uses the :search_field and :search_option values
+        Post.search_post("Ruby", :start_with) # It's possible to override the :search_option value
+        Post.search_post("Ruby", :start_with, [:name, :content]) # It's possible to override the :search_option and :search_field values
+        
+        # Some helper method are available
+        Post.start_with("Ruby")      # all record that start with 'Ruby'
+        Post.end_with("Ruby")        # all record that end with 'Ruby'
+        Post.search_anywhere("Ruby") # all record that search anywhere with 'Ruby'
+       
     end
     
     ...
@@ -52,7 +59,7 @@ end
 
 ## More about the API
 
-##### search_option method
+##### search_option method (Call in model)
 
 `search_option` method specifies where to search in the sentence. Available options:
 
@@ -60,20 +67,31 @@ end
 - `:end_with`   : the sentence ends with the pattern.
 - `:anywhere`   : search anywhere in the sentence. [DEFAULT OPTION]
 
+##### search_field method (Call in model)
+
+`search_field` method specifies which field is used for the search. It's possible to search in multiple fields by using the method `search_fields([])`: 
+
+```ruby
+class Post < ActiveRecord::Base
+    search_fields [:title, :content] # search on :title OR :content 
+end
+```
+
 ##### search_MODEL method
 
-A method :search_MODEL is auto-generated. It's the method used in controller in our above example. some examples:
+A method :search_MODEL is auto-generated. some examples:
  
 - for a model Post a method `search_post` is generated.
 - for a model Book a method `search_book` is generated.
 
-The method can accept a second argument which is a `search_option`. Example:
+The method can accept more arguments. Example:
 
 ```ruby
 class PostsController < ApplicationController
 
     def index
         Post.search_post("Ruby", :start_with) # See search_option method section for more information
+        Post.search_post("Ruby", :start_with, [:name, :content]) # it's possible to override the search_field option
     end
     
     ...
@@ -82,20 +100,6 @@ end
 
 Append the model name to this method results from the following question: What is the probability that a `search` method already exists in the model?
 
-In this example, the search-engine will search any posts that the content starts with `"Ruby"`.
-
-##### search_field method
-
-`search_field` method specifies which field is used for the search. It's possible to search in multiple fields by using the method `search_fields([])`: 
-
-```ruby
-class Post < ActiveRecord::Base
-    search_fields [:title, :content]
-end
-```
-
-In this example, the search-engine will search any posts that include `"Ruby"` in their content OR in their title.
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/activerecord-search.gemspec

@@ -7,7 +7,7 @@ require 'activerecord/base'
 Gem::Specification.new do |spec|
   spec.name          = "activerecord-search"
   spec.version       = Activerecord::Search::VERSION
-  spec.date          = '2015-10-05'
+  spec.date          = Time.now.strftime("%F")
   spec.authors       = ["Mehdi FARSI"]
   spec.email         = ["mehdifarsi.pro@gmail.com"]
 

data/lib/activerecord/search/version.rb

@@ -1,5 +1,5 @@
 module Activerecord
   module Search
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-search
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Mehdi FARSI
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-05 00:00:00.000000000 Z
+date: 2015-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler