rails-simple-search 1.2.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 290634cd836385acaa327ac5b5971e75a716291d51629d8c54dc3c8db728e466
-  data.tar.gz: 9a8c7d6985147d3669c9cf1d98cf41fed6854e1039bdddf7fc271b6b4c4d5f01
+  metadata.gz: c6310535f7e545c8b29ca69421df5a8f23efca79dab7ccec6311ed00c632c51d
+  data.tar.gz: 5379c314d28a7e06acf4e12ec23d78799e81b89843d1abf2717122e2f90cbbfc
 SHA512:
-  metadata.gz: 890be5b99ab922d000adad63885a50a4bd678a1294b4915c32db93d808ac89774934626a0b73b3dd117728beb7d6b62a2df15c3b9353fb0113a80a05f11a57fa
-  data.tar.gz: 2e72fd3aef31f0b0b3fdf7b34e80a5f1035cac36b869a62d543d178c5bee132a78caf00605bd1bc93e60e675b52ced76a9fffffb0d22be23acad1e65adf0269b
+  metadata.gz: 25829545f58e17b7234400719ef2707369cc2a5dbd608d3527c1aafd9a41cf7a5189e4f04857ea263887307faaaa66cce9850c8af024e450fd98095c95ea2989
+  data.tar.gz: 47bc9c46c5c56017bc1b6c468e811987f1738e1f38c4379217d77f474c62c640bbf1d9e154d7eaa099905b3337f7819d937718964b441af2c6c87958eb169259

data/README.md

@@ -1,10 +1,30 @@
+[![Gem Version](https://badge.fury.io/rb/rails-simple-search.svg)](https://badge.fury.io/rb/rails-simple-search)
+
+### Table of Contents
+
+* [What is rails-simple-search?](#what-is-rails-simple-search)
+
+* [Why rails-simple-search?](#why-rails-simple-search)
+
+* [Installation](#installation)
+
+* [Usage](#usage)
+
+* [How to construct field names](#how-to-construct-field-names)
+
+* [Demo projects](#demo-projects)
+
+* [Version history](#version-history)
+
+* [License](#license)
+
 ## What is rails-simple-search?
 rails-simple-search is a Ruby gem. It can help Ruby on Rails developers **quickly**
 implement searching/filtering function against database. If you're not looking
 for a full-text searching solution, this plugin will most probably **satisfy all**
 your searching requirement.
 
-## Why?
+## Why rails-simple-search?
 From time to time, I need to build pages to show a list of narrowed down records
 from a database table by giving some searching criteria on some columns of the
 table and/or of some referencing tables. Before I implemented this plugin, I usually
@@ -67,6 +87,8 @@ The following is how we implement this searching function with rails-simple-sear
 ```
 
 4. Code in views:
+   **Pay attention to the name of the form fields**.
+
 ```
     <% form_for @search, url => "/xxxxxx", data: {turbo: false} do |f| %>
 
@@ -105,6 +127,50 @@ The following is how we implement this searching function with rails-simple-sear
     post "/xxxxxx" => "yyyyyyy#zzzzzz"
 ```
 
+## How to construct field names
+1. Let's call the model we're search for is the base model. If you just want to search
+against any direct fields of the base model, we just use the table field name as the html
+input field name. For example
+```
+   "email"
+```
+
+2. If you need to search against fields of the base model's association, you can just
+use the association name and the table field name with a dot "." connecting them. Like this
+```
+   "address.city"
+```
+
+3. You can chain the associations more than 2 layers. For example, we're going to
+find out the users whose posts have been commented by someone whose first name we happen to know.
+```
+   "posts.comments.user.first_name"
+```
+
+4. Sometimes we need to find out something according to a range of time, or a range of numbers,
+we can attach "_greater_than", "_greater_than_equal_to", "_less_than", or "_less_than_equal_to".
+For example, we need to find out the users who birth date is between a range, the field names
+can be like this
+```
+   birth_date_greater_than
+```
+and
+```
+   birth_date_greater_than
+```
+
+5. Sometimes we need to express the idea of "or", for example, I know roughly a user's name, but
+not sure if it's her first name or last name, we can do it like this
+```
+   first_name_or_last_name
+```
+
+6. We can even use the "or" relation with association fields. For example
+```
+   posts.comments.user.first_name_or_posts.comments.user.last_name
+```
+
+
 ## Demo projects
 There are 2 demo projects for this gem, one for [Rails 5](https://github.com/yzhanginwa/demo_app_for_rails_simple_search)
 and one for [Rails 7](https://github.com/yzhanginwa/rails_simple_search_demo). You are encouraged to clone them to your local and
@@ -122,7 +188,7 @@ From version 1.1.0 on, we started to support the "or" relation, e.g., we can use
 
 From version 1.1.3 on, we started to support Rails 5.
 
-For Rails 7, please use version 1.2.0.
+For Rails 7, please use version 1.2.2.
 
 ## License
 

data/lib/sql_handler.rb

@@ -80,7 +80,7 @@ module RailsSimpleSearch
       format('A%02d', @joins[table_name][0])
     end
 
-    def insert_join(base_class, asso_ref)
+    def insert_join(base_class, asso_ref, new_asso_chain)
       base_table = base_class.table_name
       asso_table = asso_ref.klass.table_name
 
@@ -89,7 +89,7 @@ module RailsSimpleSearch
       return unless @joins[asso_table].nil?
 
       @join_count += 1
-      base_table_alias = @join_count < 2 ? base_table : table_name_to_alias(base_table)
+      base_table_alias = new_asso_chain ? base_table : table_name_to_alias(base_table)
       asso_table_alias = format('A%02d', @join_count)
 
       if asso_ref.belongs_to?
@@ -126,9 +126,11 @@ module RailsSimpleSearch
       field = association_fields.pop
 
       base_class = @model_class
+      new_asso_chain = true
       until association_fields.empty?
         association_fields[0] = base_class.reflect_on_association(association_fields[0].to_sym)
-        insert_join(base_class, association_fields[0])
+        insert_join(base_class, association_fields[0], new_asso_chain)
+        new_asso_chain = false
         base_class = association_fields.shift.klass
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-simple-search
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Yi Zhang
@@ -32,7 +32,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="