default_where 2.2.3 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9860242afa48f1b00939bf840ab9c905891a664498082c3596853b856a6014df
-  data.tar.gz: df25ea89826f20d10291780ae4e9f90770a1627bbef83a7f9cf82bc3447a7549
+  metadata.gz: b496f6c6778aac3b2e8ef9d0a47f8d7e8557f2080aeaa0dc15605f80266c3760
+  data.tar.gz: 0320e5570248726e1a4716f852ba951480fccb386b298db0d1118181fb1180eb
 SHA512:
-  metadata.gz: 3a4542d9ccc386102203d62ae0aadcdadc4c688f09365b96d7a620ade26050bd872f7f399f12d5e5e0cb6c3f40aa0e4feb19c844872e8d4819f927c85240862a
-  data.tar.gz: 37dab845591f27c34813b29d0cf1b4139568de7670b6b56ae0faefcc32c9d8be09e71f0117060df667a760f0b59c2db6984d5ac2d286ff0cf5fac4e32a92cf53
+  metadata.gz: 0fec4d669be1436bdf7cb217bdb0cee4a30fdd4e7dd4e8b201a9c444da07bc3a5ef100a0329a7c4c3c679af045aa08e48ef2137105b24cc15adcc44f69af7ddf
+  data.tar.gz: 2633a6a9cab857a51fc321efce967f7fe4c7fbcc835abed292066a2c90367ad4f6a2746e76bdf4a8418f62f18707851c944ecff1a93a7dec73987d98e37a8fdc

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015-Present Mingyuan Qin <mingyuan0715@foxmail.com>
+
+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.

data/README.md

@@ -1,7 +1,7 @@
 ## DefaultWhere
 
 
-This Library set default params process for where query in ActiveRecord
+`default_where` set default params process for where query in ActiveRecord
 
 It's a wise decision to use `default_where` with [default_form](https://github.com/qinmingyuan/default_form) to replace `ransack`
 
@@ -14,6 +14,8 @@ It's a wise decision to use `default_where` with [default_form](https://github.c
 * 范围：key-gte: value, 
 * 排序：key-asc: 1, key-desc: 2
 * 排除：key-not: value
+#### 对于postgresql 数据库
+* 包含任一值：key-any: value
 
 ### Normal equal params
 
@@ -71,14 +73,25 @@ users = users.where(age: params[:age]) if params[:age]
 ```ruby
 User.default_where(params)
 
-# also can control which blank value can use
-User.default_where(params, { allow: [nil] })
+```
+
+### allow
+you can control which blank value can use
+
+```ruby
+{
+  name: nil,
+  allow: { name: nil }
+}
 ```
 
 ### OR
 ```ruby
 params = {
-  'users.email-not-or-name': 'dhh'
+  or: { 
+    'users.email-not': 'qin',
+    'name': 'qin'
+  }
 }
 
 ```
@@ -97,7 +110,13 @@ User.where(name: params[:name].strip)
 User.default_where(params)
 
 # also can control whether use strip
-User.default_where(params, { strip: false })
+
+{
+  name: ' qin',
+  strip: { 
+    name: false
+  }
+}
 ```
 
 ### Order params
@@ -114,10 +133,30 @@ User.order(age: :asc, last_login_at: :asc)
 User.default_where(params)
 ```
 
+## For Postgresql
+* support JSONB filter，just use like this: `column_name/json_key`, just notice jsonb all value is string type;
+```ruby
+# before
+Order.where("extra->>'maintain_id' = :key", key: id.to_s) 
+# after
+Order.default_where('extra/maintain_id': id.to_s)
+```
+
 ## A sample with all params above
 * Params
 ```ruby
-{ name: 'dhh', 'role.id': 2, 'age-lte': 2, 'age-asc': '1', 'last_login_at-asc': '2' }
+{ 
+  name: 'dhh',
+  'role.id': 2, 
+  'age-lte': 2, 
+  'age-asc': '1', 
+  'last_login_at-asc': '2',
+  or: {
+    name: 'dhh',
+    email: 'dhh'
+  },
+  allow: { name: nil }
+}
 ```
 * Before use `default_where`
 ```ruby
@@ -127,3 +166,6 @@ User.includes(:role).where(name: params[:name], 'roles.id': params[:'role.id']).
 ```ruby
 User.default_where(params)
 ```
+
+## 许可证
+遵循 MIT 协议

data/lib/default_where.rb

@@ -1,93 +1,69 @@
-require 'default_where/not'
-require 'default_where/range'
-require 'default_where/like'
+# frozen_string_literal: true
+
+require 'default_where/scope'
 require 'default_where/order'
-require 'default_where/or'
+require 'default_where/params'
+require 'default_where/group'
 
 module DefaultWhere
-  include DefaultWhere::Not
-  include DefaultWhere::Range
-  include DefaultWhere::Order
-  include DefaultWhere::Like
-  #include DefaultWhere::Or
+  include Scope
+  include Order
+  include Params
+  include Group
 
-  REJECT = ['', nil]
+  REJECT = ['', nil].freeze
   STRIP = true
 
-  def default_where(params = {}, options = {})
+  def default_where(params = {})
     return all if params.blank?
 
     params = params.to_h
-    params, refs, tables = params_with_table(params, options)
+    options = {}
+    [:strip, :allow, :reject].each do |key|
+      options[key] = params.delete(key) if params[key].respond_to?(:to_hash)
+    end
+    or_params = {}
+    or_params = params.delete(:or) if params[:or].respond_to?(:to_hash)
 
-    #or_params = filter_or(params)
-    range_params = filter_range(params)
-    order_params = filter_order(params)
-    not_params = filter_not(params)
-    like_params = filter_like(params)
+    and_params, and_refs, and_tables = default_where_params(params, options)
+    order_params = default_where_order_filter(and_params)
+    and_params.except!(*order_params.keys)
 
-    equal_params = params.except!(*range_params.keys, *order_params.keys, *not_params.keys, *like_params.keys)
+    or_params, or_refs, or_tables = default_where_params(or_params, options)
+    refs = and_refs + or_refs
+    tables = and_tables + or_tables
 
-    includes(refs).where(equal_params).references(tables)
-      .not_scope(not_params)
-      .like_scope(like_params)
-      .range_scope(range_params)
-      .order_scope(order_params)
+    includes(refs).default_where_and(and_params).default_where_or(or_params).default_where_order(order_params).references(tables)
   end
 
-  def params_with_table(params = {}, options = {})
-    if options.has_key?(:reject)
-      default_reject = Array(options[:reject])
-    elsif options.has_key?(:allow)
-      default_reject = REJECT - Array(options[:allow])
-    else
-      default_reject = REJECT
-    end
+  def default_where_and(params = {})
+    return current_scope if params.blank?
 
-    unless options.has_key? :strip
-      options[:strip] = STRIP
+    equal_params = {}
+    params.each do |key, _|
+      equal_params[key] = params.delete(key) unless key.match? /[-\/]/
     end
+    where_string, where_hash = default_where_scope(params)
+    where_string = where_string.join ' AND '
 
-    refs = []
-    tables = []
-    final_params = {}
-
-    params.each do |key, value|
-      value = value.strip if value.is_a?(String) && options[:strip]
-      next if default_reject.include?(value)
-      key = key.to_s
-
-      if key =~ /\./
-        _table, _column = key.split('.')
-        _real_column = _column.split('-').first
-        _ref = reflections[_table]
-        if _ref && _ref.klass.column_names.include?(_real_column)
-          _table = _ref.table_name
-        elsif connection.data_sources.include?(_table) && connection.column_exists?(_table, _real_column)
-          _refs = reflections.select { |_, v| v.table_name == _table && !v.polymorphic? }
-          if _refs.size == 1
-            _ref = _refs.first
-          else
-            raise "#{key} makes confused, please use reflection name!"
-          end
-        else
-          next
-        end
-        refs << _ref.name unless refs.include?(_ref.name)
-        tables << _table unless tables.include?(_table)
-        final_params["#{_table}.#{_column}"] = value
-      else
-        _real_column = key.split('-').first
-        next unless column_names.include?(_real_column)
-        final_params[key] = value
-      end
-    end
+    where(equal_params).where(where_string, where_hash)
+  end
 
-    [final_params, refs, tables]
+  def default_where_or(params = {})
+    return current_scope if params.blank?
+
+    where_string, where_hash = default_where_scope(params)
+    where_string = where_string.join ' OR '
+
+    where(where_string, where_hash)
+  end
+
+  def logger
+    ::ActiveRecord::Base.logger
   end
 
 end
 
 ActiveSupport.on_load :active_record do
   extend DefaultWhere
-end
+end

data/lib/default_where/group.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module DefaultWhere
+  module Group
+
+    # {
+    #   select: 'sum(total_amount)',
+    #   select: {
+    #     a: 'sum(total_amount)',
+    #     b: 'sum()'
+    #   }
+    # }
+    #  group: 'date(created_at)',
+    def default_group(*group, select:)
+      if select.respond_to?(:to_hash)
+        selected = select.map do |k, v|
+          "#{v} AS #{k}"
+        end
+      else
+        selected = Array(select)
+      end
+      
+      unscoped.select(*selected, *group).group(*select.values)
+    end
+    
+  end
+end

data/lib/default_where/order.rb

@@ -1,17 +1,24 @@
+# frozen_string_literal: true
+
 module DefaultWhere
   module Order
+    PATTERN = {
+      '-asc': :asc,
+      '-desc': :desc
+    }
 
-    def order_scope(params)
-      order_array = []
+    def default_where_order(params)
+      order_hash = {}
 
       params.sort_by{ |_, v| v.to_i }.each do |i|
-        order_array << i[0].sub(/-(asc|desc)$/, '-asc' => ' ASC', '-desc' => ' DESC')
+        k, v = i[0].split('-')
+        order_hash[k] = v
       end
 
-      order(order_array)
+      order(order_hash)
     end
 
-    def filter_order(params)
+    def default_where_order_filter(params)
       params.select do |k, v|
         k.end_with?('-asc', '-desc') && String(v) =~ /^[1-9]$/
       end

data/lib/default_where/params.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module DefaultWhere
+  module Params
+
+    def default_where_params(params = {}, options = {})
+      refs = []
+      tables = []
+      final_params = {}
+
+      params.each do |key, value|
+        # strip, if assign key to false, will not works
+        strip = options.fetch(:strip, {}).fetch(key, STRIP)
+        value = value.strip if value.is_a?(String) && strip
+
+        # reject
+        if options.key?(:reject)
+          reject = options.fetch(:reject, {}).fetch(key, REJECT)
+          if reject == nil
+            reject = [nil]
+          elsif reject == []
+            reject = [[]]
+          else
+            reject = Array(reject)
+          end
+        else
+          allow = options.fetch(:allow, {}).fetch(key, [])
+          if allow == nil
+            allow = [nil]
+          else
+            allow = Array(allow)
+          end
+          reject = REJECT - allow
+        end
+        next if reject.include?(value)
+
+        items = key.to_s.split('.')
+        column = items[-1]
+        real_column = column.split(/[-\/]/)[0]
+
+        if items.size == 1
+          next unless column_names.include?(real_column)
+          table = nil
+        else
+          prefix = items[0]
+          ref = reflections[prefix]
+
+          # 检查 prefix 是否为关联关系的名称
+          if ref && !ref.polymorphic?
+            table = ref.table_name
+            # 检查 prefix 是否为表名，且表中存在 real_column 字段
+          elsif connection.data_sources.include?(prefix) && connection.column_exists?(prefix, real_column)
+            possible_refs = reflections.select { |_, v| v.table_name == prefix }
+            if possible_refs.size < 1
+              ref = nil
+            elsif possible_refs.size == 1
+              ref = possible_refs[0]
+            else
+              raise "#{key} makes confused, please use reflection name!"
+            end
+
+            table = prefix
+          else
+            next
+          end
+
+          if ref && !ref.klass.column_names.include?(real_column)
+            next
+          end
+
+          if ref && !refs.include?(ref.name)
+            refs << ref.name
+          end
+
+          unless tables.include?(table)
+            tables << table
+          end
+        end
+
+        if table
+          final_params["#{table}.#{column}"] = value
+        else
+          final_params[column] = value
+        end
+      end
+
+      [final_params, refs, tables]
+    end
+
+  end
+end

data/lib/default_where/scope.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module DefaultWhere
+  module Scope
+    PATTERN = {
+      gt: '>',
+      gte: '>=',
+      lt: '<',
+      lte: '<=',
+      not: '!=',
+      like: 'LIKE',
+      rl: 'LIKE',
+      ll: 'LIKE',
+      :'' => '='
+    }.freeze
+
+    def default_where_scope(params)
+      where_string = []
+      where_hash = {}
+
+      params.each do |key, value|
+        real_key, sign_str = key.split('-')
+        agent_key = key.gsub(/[-.\/]/, '_')
+
+        if value.nil? || value == []
+          if sign_str == 'not'
+            where_string << "#{real_key} IS NOT NULL"
+          elsif sign_str.nil?
+            where_string << "#{real_key} IS NULL"
+          else
+            raise "#{key}'s value can not be nil"
+          end
+        elsif sign_str == 'any' # 支持 postgres array 查询
+          where_string << ":#{agent_key} = ANY(#{real_key})"
+          where_hash.merge! agent_key.to_sym => value
+        elsif real_key.match?(/.\/./) # 支持 postgres json 查询
+          real_key, i18n_key = key.split('/')
+          where_string << "#{real_key}->>'#{i18n_key}' = :#{agent_key}"
+          where_hash.merge! agent_key.to_sym => value
+        else
+          case sign_str
+          when 'll'
+            real_value = "#{value}%"
+          when 'rl'
+            real_value = "%#{value}"
+          when 'like'
+            real_value = "%#{value}%"
+          else
+            real_value = value
+          end
+
+          where_string << "#{table_name}.#{real_key} #{PATTERN[sign_str.to_s.to_sym]} :#{agent_key}"
+          where_hash.merge! agent_key.to_sym => real_value
+        end
+      end
+
+      [where_string, where_hash]
+    end
+
+  end
+end

data/lib/default_where/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DefaultWhere
-  VERSION = '2.2.3'
+  VERSION = '2.3.0'
 end

data/test/helper.rb

@@ -1,14 +1,3 @@
-# $DEBUG = true
-
-require 'rubygems'
-require 'bundler/setup'
-begin
-  Bundler.setup(:default, :test, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
 require 'active_record'
 require 'minitest/autorun'
 require 'factory_bot'
@@ -33,4 +22,4 @@ def teardown_db
     ActiveRecord::Base.connection.truncate(table)
   end
 end
-teardown_db
+teardown_db

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: default_where
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 2.3.0
 platform: ruby
 authors:
 - qinmingyuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-26 00:00:00.000000000 Z
+date: 2021-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -19,7 +19,7 @@ dependencies:
         version: '4.0'
     - - "<="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,65 +29,50 @@ dependencies:
         version: '4.0'
     - - "<="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: sdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: factory_bot_rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-description: Description of QueryScope.
+        version: '12.3'
+description: Default where
 email:
 - mingyuan0715@foxmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
 - Rakefile
-- lib/default_or.rb
 - lib/default_where.rb
-- lib/default_where/like.rb
-- lib/default_where/not.rb
-- lib/default_where/or.rb
+- lib/default_where/group.rb
 - lib/default_where/order.rb
-- lib/default_where/range.rb
+- lib/default_where/params.rb
+- lib/default_where/scope.rb
 - lib/default_where/version.rb
 - test/config/database.yml
 - test/config/database.yml.example
@@ -98,7 +83,7 @@ files:
 - test/models/user.rb
 homepage: https://github.com/qinmingyuan/default_where
 licenses:
-- LGPL-3.0
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -115,16 +100,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: default process params for where
 test_files:
-- test/default_where_test.rb
-- test/migrations/20180508082145_test_init.rb
-- test/config/database.yml.example
 - test/config/database.yml
+- test/config/database.yml.example
+- test/default_where_test.rb
+- test/factories/users.rb
 - test/helper.rb
+- test/migrations/20180508082145_test_init.rb
 - test/models/user.rb
-- test/factories/users.rb

data/lib/default_or.rb

@@ -1,20 +0,0 @@
-module DefaultWhere::DefaultOr
-
-  def default_or(hash)
-    return all if hash.blank?
-
-    keys = hash.keys
-    query = where(keys[0] => hash[keys[0]])
-
-    keys[1..-1].each do |key|
-      query = query.or(where(key => hash[key]))
-    end
-
-    query
-  end
-
-end
-
-ActiveSupport.on_load :active_record do
-  extend DefaultWhere::DefaultOr
-end

data/lib/default_where/like.rb

@@ -1,47 +0,0 @@
-module DefaultWhere
-  module Like
-    PATTERN = ['-like', '-rl', '-ll']
-
-    def like_scope(params)
-      where_string = []
-      where_hash = {}
-
-      params.each do |key, value|
-        real_key = key.sub(/-like$/, '')
-        agent_key = key.gsub(/[-.]/, '_')
-
-        if column_names.include?(real_key)
-          real_key = "#{table_name}.#{real_key}"
-        end
-
-        where_string << "#{real_key} like :#{agent_key}"
-
-        if key.end_with?('-ll')
-          like_value = "#{value}%"
-        elsif key.end_with?('-rl')
-          like_value = "%#{value}"
-        else
-          like_value = "%#{value}%"
-        end
-
-        where_hash.merge! agent_key.to_sym => like_value
-      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?(*PATTERN)
-      end
-    end
-
-  end
-end

data/lib/default_where/not.rb

@@ -1,32 +0,0 @@
-module DefaultWhere
-  module Not
-
-    def not_scope(params)
-      where_hash = {}
-
-      params.each do |key, value|
-        real_key = key.sub(/-not$/, '')
-
-        if column_names.include?(real_key)
-          real_key = "#{table_name}.#{real_key}"
-        end
-
-        where_hash.merge! real_key => value
-      end
-
-      if where_hash.present?
-        where.not(where_hash)
-      else
-        all
-      end
-    end
-
-    def filter_not(params)
-      params.select do |k, _|
-        k.end_with?('-not')
-      end
-    end
-
-  end
-end
-

data/lib/default_where/or.rb

@@ -1,32 +0,0 @@
-module DefaultWhere
-  module Or
-
-    def or_scope(params)
-      where_hash = {}
-
-      params.each do |key, value|
-        real_key = key.split('-or-')
-
-        if column_names.include?(real_key)
-          real_key = "#{table_name}.#{real_key}"
-        end
-
-        where_hash.merge! real_key => value
-      end
-
-      if where_hash.present?
-        where.not(where_hash)
-      else
-        all
-      end
-    end
-
-    def filter_or(params)
-      params.select do |k, _|
-        k.include?('-or-')
-      end
-    end
-
-  end
-end
-

data/lib/default_where/range.rb

@@ -1,47 +0,0 @@
-module DefaultWhere
-  module Range
-
-    PATTERN = {
-      '-gt' => '>',
-      '-gte' => '>=',
-      '-lt' => '<',
-      '-lte' => '<='
-    }
-
-    def range_scope(params)
-      where_string = []
-      where_hash = {}
-
-      params.each do |key, value|
-        exp = /-(gt|gte|lt|lte)$/
-        real_key = key.sub(exp, '')
-        sign_str = key.match(exp).to_s
-        agent_key = key.gsub(/[-.]/, '_')
-
-        if column_names.include?(real_key)
-          real_key = "#{table_name}.#{real_key}"
-        end
-
-        where_string << "#{real_key} #{PATTERN[sign_str]} :#{agent_key}"
-
-        where_hash.merge! agent_key.to_sym => value
-      end
-
-      where_string = where_string.join ' AND '
-
-      if where_string.present?
-        condition = [where_string, where_hash]
-        where(condition)
-      else
-        all
-      end
-    end
-
-    def filter_range(params)
-      params.select do |k, _|
-        k.end_with?(*PATTERN.keys)
-      end
-    end
-
-  end
-end