default_where 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6efeb771f8cfd12da8bd75a029ad32915b05965
-  data.tar.gz: b93da85fe5ec94e864cf8b46ba3fdd54967207af
+  metadata.gz: bab39ef3d31eaf2792f44350e22cdc97ea35d3e3
+  data.tar.gz: fd311a5d219d7cf5b5ee6ecf5f3240fd9b79408c
 SHA512:
-  metadata.gz: b64755c308fba999be677d7063137e92592bd33acdbfb0332b3dbc5c5d8b553918f118dfb1e961de08a9b4dd7034d4236549ca10f941eff734f4dd3b2e4d5720
-  data.tar.gz: a9eab9b521f762795ba8508f8f97e6f132cc0c1fadb262285deec51febdb9fca7ba0c5a0df6b654e7cac2a3bad4efeaab2f1da9909770f3c36bcefae640217d7
+  metadata.gz: ae8a24b39eb7fa0a412139fb9e0be1506e9753c5c10969dbe169a4fe50c35c30b6973cfd1e9649f146ad2ad706d8351d0bfa479dc4a21d30e39d34e093c81f41
+  data.tar.gz: 46bc20372f0a1f118fe25ec723ab29d2b64f9c9e4568bbdd82ac7e46568848abcebcc8aada55e763a40e9cd72832bc3e8e7600bb9f0ee0e77607ef2ecf4c4829

data/README.md

@@ -9,7 +9,7 @@ This Library set default params process for where query in ActiveRecord
 - Params:
 
 ```ruby
-# rails 4 and  above, default_where does nothing
+# rails 4 and later, default_where does nothing
 params = { role_id: 1, age: 20 }
 User.default_where(params)
 ```
@@ -20,6 +20,9 @@ User.default_where(params)
 ```ruby
 User.belongs_to :role
 params = { name: 'dhh', 'role.id': 2 }
+
+# you can use any table name or reference name
+params = { name: 'dhh', 'roles.id': 2 }
 ```
 - Before use `default_where`
 ```ruby
@@ -58,12 +61,15 @@ users = users.where(age: params[:age]) if params[:age]
 - After use `default_where`
 ```ruby
 User.default_where(params)
+
+# also can control which blank value can use
+User.default_where(params, { allow: [nil] })
 ```
 
 ### Order params
 - Params
 ```ruby
-params = { o1: 'age-asc', o2: 'last_login_at-asc' }
+params = { 'age-asc': '1', 'last_login_at-asc': '2' }
 ```
 - Before use `default_where`
 ```ruby
@@ -77,7 +83,7 @@ User.default_where(params)
 ## A sample with all params above
 - Params
 ```ruby
-{ name: 'dhh', 'role.id': 2, 'age-lte': 2, o1: 'age-asc', o2: 'last_login_at-asc' }
+{ name: 'dhh', 'role.id': 2, 'age-lte': 2, 'age-asc': '1', 'last_login_at-asc': '2' }
 ```
 - Before use `default_where`
 ```ruby
@@ -86,7 +92,4 @@ User.includes(:role).where(name: params[:name], 'roles.id': params[:'role.id']).
 - After use `default_where`
 ```ruby
 User.default_where(params)
-```
-
-It will generate the query scope to above
-params must use string key
+```

data/lib/default_where.rb

@@ -1,42 +1,43 @@
 require 'default_where/not'
 require 'default_where/range'
+require 'default_where/like'
 require 'default_where/order'
 
 module DefaultWhere
   include DefaultWhere::Not
   include DefaultWhere::Range
   include DefaultWhere::Order
+  include DefaultWhere::Like
+
+  REJECT = ['', ' ', nil]
+
 
   def default_where(params = {}, options = {})
     return all if params.blank?
 
-    params, tables = params_with_table(params, options)
+    params, refs, tables = params_with_table(params, options)
 
     range_params = filter_range(params)
-    params = params.except!(*range_params.keys)
-
     order_params = filter_order(params)
-    params = params.except!(*order_params.keys)
-
     not_params = filter_not(params)
-    equal_params = params.except!(*not_params.keys)
+    like_params = filter_like(params)
+
+    equal_params = params.except!(*range_params.keys, *order_params.keys, *not_params.keys, *like_params.keys)
 
-    includes(tables).where(equal_params).references(tables)
+    includes(refs).where(equal_params).references(tables)
       .not_scope(not_params)
+      .like_scope(like_params)
       .range_scope(range_params)
       .order_scope(order_params)
   end
 
   def params_with_table(params = {}, options = {})
-    default_reject = ['', ' ', nil]
-
-    if options[:allow_nil]
-      default_reject.delete(nil)
-    end
-
-    # todo secure bug
-    if params.respond_to?(:permitted?) && !params.permitted?
-      params.permit!
+    if options[:reject]
+      default_reject = [options[:reject]].flatten
+    elsif options[:allow]
+      default_reject = REJECT - [options[:allow]].flatten
+    else
+      default_reject = REJECT
     end
 
     params = params.to_h
@@ -44,33 +45,36 @@ module DefaultWhere
     params.reject! { |_, value| default_reject.include?(value) }
 
     refs = []
+    tables = []
+    final_params = {}
 
-    # since 1.9 is using lazy iteration
-    params.to_a.each do |key, _|
-
+    params.each do |key, _|
       if key =~ /\./
-        as, col = key.split('.')
+        table, col = key.split('.')
+        as_model = reflections[table]
         f_col, _ = col.split('-')
-        as_model = reflections[as]
 
         if as_model && as_model.klass.column_names.include?(f_col)
-          params["#{as_model.table_name}.#{col}"] = params.delete(key)
-          refs << as.to_sym
-        else
-          params.delete(key)
+          final_params["#{as_model.table_name}.#{col}"] = params[key]
+          tables << as_model.table_name
+          refs << table.to_sym
+        elsif connection.data_sources.include? table
+          final_params["#{table}.#{col}"] = params[key]
+          tables << table
+          keys = reflections.select { |_, v| v.table_name == table }.keys
+          if keys && keys.size == 1
+            refs << keys.first.to_sym
+          end
         end
       else
         f_key, _ = key.split('-')
         if column_names.include?(f_key)
-          params["#{table_name}.#{key}"] = params.delete(key)
-        else
-          params.delete(key)
+          final_params["#{table_name}.#{key}"] = params[key]
         end
       end
-
     end
 
-    [params, refs]
+    [final_params, refs, tables]
   end
 
 end

data/lib/default_where/like.rb

@@ -0,0 +1,33 @@
+module DefaultWhere
+  module Like
+
+    def like_scope(params)
+      where_string = []
+      where_hash = {}
+
+      params.select{ |k, _| k.end_with?('-like') }.each do |key, value|
+        real_key = key.sub(/-like$/, '')
+        agent_key = key.gsub(/[-\.]/, '_')
+
+        where_string << "#{real_key} like :#{agent_key}"
+        where_hash.merge! agent_key.to_sym => '%' + value.to_s + '%'
+      end
+
+      where_string = where_string.join ' AND '
+
+      if where_string.present?
+        condition = [where_string, where_hash]
+        where(condition)
+      else
+        all
+      end
+    end
+
+    def filter_like(params)
+      params.select do |k, _|
+        k.end_with?('-like')
+      end
+    end
+
+  end
+end

data/lib/default_where/order.rb

@@ -5,11 +5,11 @@ module DefaultWhere
       order_array = []
 
       params.select{ |key, _| key.end_with?('-asc') }.each do |k, _|
-        order_array << k.sub(/-asc$/, ' asc')
+        order_array << k.sub(/-asc$/, ' ASC')
       end
 
       params.select{ |key, _| key.end_with?('-desc') }.each do |k, _|
-        order_array << k.sub(/-desc$/, ' desc')
+        order_array << k.sub(/-desc$/, ' DESC')
       end
 
       order(order_array)
@@ -17,7 +17,7 @@ module DefaultWhere
 
     def filter_order(params)
       params.select do |k, v|
-        k =~ /o\d/ && v.end_with?('-asc', '-desc')
+        k.end_with?('-asc', '-desc') && v =~ /^[1-9]$/
       end
     end
 

data/lib/default_where/range.rb

@@ -9,7 +9,7 @@ module DefaultWhere
     }
 
     def range_scope(params)
-      where_string = ''
+      where_string = []
       where_hash = {}
 
       PATTERN.each do |char, sign|
@@ -20,13 +20,13 @@ module DefaultWhere
           real_key = key.sub(exp, '')
           agent_key = key.gsub(/[-\.]/, '_')
 
-          where_string << " AND #{real_key} #{sign} :#{agent_key}"
+          where_string << "#{real_key} #{sign} :#{agent_key}"
 
           where_hash.merge! agent_key.to_sym => value
         end
       end
 
-      where_string.sub!(/^ AND /, '') if where_string.start_with?(' AND ')
+      where_string = where_string.join ' AND '
 
       if where_string.present?
         condition = [where_string, where_hash]

data/lib/default_where/version.rb

@@ -1,3 +1,3 @@
 module DefaultWhere
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: default_where
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - qinmingyuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-13 00:00:00.000000000 Z
+date: 2017-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -35,11 +35,11 @@ files:
 - README.md
 - Rakefile
 - lib/default_where.rb
+- lib/default_where/like.rb
 - lib/default_where/not.rb
 - lib/default_where/order.rb
 - lib/default_where/range.rb
 - lib/default_where/version.rb
-- lib/tasks/query_scope_tasks.rake
 - test/default_where_test.rb
 - test/test_helper.rb
 homepage: https://github.com/qinmingyuan/default_where
@@ -62,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: default process params for where

data/lib/tasks/query_scope_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :query_scope do
-#   # Task goes here
-# end