make_model_searchable 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 648050f19bf2182a6c7fd2831efb9abe048ed2d5
-  data.tar.gz: 5051a9071d1da32de090dc14679f4851b537df8a
+  metadata.gz: 19fd45656ce822e0504e5a13573d18f0a8830b1d
+  data.tar.gz: d47a63dbe9b19e9dd1d12ad15160a0f097908d16
 SHA512:
-  metadata.gz: 27a94d9a4c6269ce01dde0496f730dd3a960f525c7c69ec159a77faeee6606964ac6302da1a868265f6ac2f97215c68460cdacd4889bd7655890b796c91c56b3
-  data.tar.gz: 2ddb9171f8e56db3e78a9cb301ce1bfd560ddf83d169fa400d76de5e5130ad98b82277dff7233c9ee4d0f981ef5fffae8c3ad6f3db6e321f9884479b6c05a649
+  metadata.gz: 542ec1f765ae022d7f40c1b493ba2af6357487e2c1045329f5a7f94ba567958bc2c07b927e941e87067739e4e3ab28b59c85eacf403016f89f1c5bc49eade9ae
+  data.tar.gz: e605d9ce316df5acd3fb478cdcde439e6cab75b15569218d2f98af2f608de9ba68b13363e95bfc1250e1d738d72afc2779d2547b0714ca30c24ca0155fa6505d

data/README.md

@@ -21,24 +21,52 @@ Or install it yourself as:
 
 ## Usage
 
-To add search functionality to a model, for example User add following line to your model.
+###### To add search functionality to a model, for example User add following line to your model.
 
 ```ruby
 class User < ActiveRecord::Base
-	searchable_attributes :attribute1, :attribute2
+	searchable_attributes :first_name, :last_name
 end
 ```
 Then use 
 ```ruby
 def index
- User.search("something")
+	User.search("something")
 end
 ```
 
 searchable_attributes line makes model searchable by adding search method to User model. 
-Specifying attributes by :attribute1, :attribute2 enables searching in specied fields. It is optional to specify attributes, if no attributes are specified then all attributes are searched.
+Specifying attributes by :first_name, :last_name enables searching in specied fields. It is optional to specify attributes, if no attributes are specified then all attributes are searched.
 
 
+###### To enable searching from associations, you can mention asssociation name with attributes to be searched from that association as below: 
+
+Suppose our user has many posts, then in our model
+
+```ruby
+class User < ActiveRecord::Base
+	has_many :posts
+	searchable_attributes :name, posts: [:title]
+end
+```
+
+or if you want to search from all text or string fields,
+
+```ruby
+class User < ActiveRecord::Base
+	has_many :posts
+	searchable_attributes :name, posts: []
+end
+```
+
+
+Then use,
+```ruby
+def index
+ 	User.search("something")
+end
+```
+
 ## 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.
@@ -47,7 +75,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/make_model_searchable. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/8parth/make_model_searchable. 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

data/lib/make_model_searchable.rb

@@ -5,9 +5,9 @@ require 'models/searchable_field'
 module MakeModelSearchable
 
 	def searchable_attributes(*options)
+    # self.connection
     joined_options = options.select{ |option| option.is_a? (Hash) }
     options = options.select{ |option| !option.is_a?(Hash) }
-    self.connection
     setup_fields(options)
     if joined_options.present?
       setup_joined_fields(joined_options)
@@ -49,22 +49,22 @@ module MakeModelSearchable
       end
     end
     if searchable_columns.present?
-      options.select!{ |option| searchable_columns.include?(option.to_s) }
+      valid_fields = options.select{ |option| searchable_columns.include?(option.to_s) }
     else
-      options = []
+      valid_fields = []
     end
-    options
+    valid_fields
   end
 
   def get_valid_joined_fields(key, columns_array)
     associated_model = self.reflect_on_association(key).klass
     associated_model.connection
     if columns_array.empty?
-      options = associated_model.columns.select{ |col| col.type == :string or col.type == :text }
+      valid_joied_fields = associated_model.columns.select{ |col| col.type == :string or col.type == :text }
     else
-      options = associated_model.columns.select{ |col| (col.type == :string or col.type == :text) and columns_array.include?(col.name.to_sym) }
+      valid_joied_fields = associated_model.columns.select{ |col| (col.type == :string or col.type == :text) and columns_array.include?(col.name.to_sym) }
     end
-    options
+    valid_joied_fields
   end
 
   module ClassMethods 

data/lib/make_model_searchable/version.rb

@@ -1,3 +1,3 @@
 module MakeModelSearchable
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: make_model_searchable
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - 8parth
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-27 00:00:00.000000000 Z
+date: 2017-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -176,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Adds simple search functionality to your models.