default_where 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76676565331ffd1fd8c5a7a70fa82c99d0510bc9
-  data.tar.gz: 302ec514e8c0457073945d86a93d9c8a1778950e
+  metadata.gz: 7bab77731f3e0efe12e228a3056d8d30278d9e07
+  data.tar.gz: 25da3de8c6506403490c7171aef25dc931ac82e6
 SHA512:
-  metadata.gz: c5c6264304b2f92c847dc9324fc503d363e3bc5f621331c09eebf16b9bbb01502bf42057cd5a4bef3f422928cf37b2b8bbcde1bd4e3fd2d9acbfb7fa6d8ad904
-  data.tar.gz: 3f78b9b76db2b62dfd471b419dbd256a567a69b687c6025f84b2546f2b9b74d1df62a756cfc5dd2319b0150c5c7085b77afc40e83b06c1e60d90ed3a5a63ddc2
+  metadata.gz: 2b9579575f9f65a863a6c3243fb705009a4728e1297aff129ce9c5165495805c9b637e3f059a494f10649e51a45a27a5ae895c030c8fc3f692c64c0ac2efc7f1
+  data.tar.gz: 569ad85a1a09f9d9fe3bb8619f11fcac5e9a182286a36b3c02b97b31c248d19a6d21b08bab78221d2806c76f91a4d1df01d882e7764cbebdb88559de02d7bf67

data/README.md

@@ -0,0 +1,34 @@
+## DefaultWhere
+
+This Library set default params process for where query in ActiveRecord
+
+## Usage
+
+- Before use default_where
+
+```ruby
+#  Parameters: {"role_id"=>"1", "age"=>"20", "teacher_id"=> "2"}
+User.includes(:student).where(role_id: params[:role_id], age: params[:age], student: {teacher_id: params[:teacher_id]})
+
+```
+
+- after Use default_where
+
+params must use string key
+
+```ruby
+User.default_where(params, student: :teacher_id)
+
+# It will generate the query scope to above
+```
+
+## Features
+- remove blank where query, need not write where query like this
+
+```ruby
+# if not remove blank query params
+users = Users.where(role_id: params[:role_id])
+users = users.where(age: params[:age]) if params[:age]
+```
+
+

data/lib/default_where/equal.rb

@@ -1,52 +1,38 @@
-module DefaultWhere::Equal
+module DefaultWhere
+  module Equal
 
-  def equal_scope(params, options)
-    @where_string = ''
-    @where_hash = {}
+    def equal_scope(params, options)
+      @where_string = ''
+      @where_hash = {}
 
-    params = equal_params(params, options)
-    equal_process(params) # 处理相等条件的参数
+      params = equal_params(params, options)
+      equal_process(params)
 
-    @where_string.sub!(/^\sand/, '') if @where_string.start_with?(' and')
+      @where_string.sub!(/^\sand/, '') if @where_string.start_with?(' and')
 
-    condition = [@where_string, @where_hash]
+      condition = [@where_string, @where_hash]
 
-    where(condition)
-  end
-
-  private
-  # 处理等于参数
-  def equal_process(params)
-    params.each do |key, value|
-      origin_key = key.split('.').last
-
-      @where_string << " and #{key} = :#{origin_key}"
-      @where_hash.merge! origin_key.to_sym => value
-    end
-  end
-
-  # 带表格的参数
-  def equal_params(params, options)
-    options.each do |assoc, column|
-      assoc_model = reflections[assoc.to_sym]
-      value = params.delete(column.to_s)
-      if assoc_model && value
-        params["#{assoc_model.table_name}.#{column}"] = value
-      elsif assoc_model.blank?
-        raise 'Wrong Association Name'
-      end
+      where(condition)
     end
 
-    # since 1.9 is using lazy iteration
-    params.to_a.each do |key, _|
-      if column_names.include?(key)
-        params["#{table_name}.#{key}"] = params.delete(key.to_s)
-      elsif !key.include?('.')
-        params.delete(key.to_s)
+    private
+    # process equal params
+    def equal_process(params)
+      params.each do |key, value|
+        origin_key = key.split('.').last
+
+        @where_string << " and #{key} = :#{origin_key}"
+        if value.to_i.to_s == value
+          @where_hash.merge! origin_key.to_sym => value.to_i
+        elsif 'true' == value
+          @where_hash.merge! origin_key.to_sym => true
+        elsif 'false' == value
+          @where_hash.merge! origin_key.to_sym => false
+        else
+          @where_hash.merge! origin_key.to_sym => value
+        end
       end
     end
 
-    params
   end
-
 end

data/lib/default_where/order.rb

@@ -0,0 +1,25 @@
+module DefaultWhere
+  module Order
+
+    def order_scope(params)
+      @order_array = []
+
+      order_process(params)
+
+      order(@order_array)
+    end
+
+    def order_process(params)
+
+      params.select{ |key, _| key.end_with?('_asc') }.each do |k, _|
+        @order_array << k.sub(/_asc$/, ' asc')
+      end
+
+      params.select{ |key, _| key.end_with?('_desc') }.each do |k, _|
+         @order_array << k.sub(/_desc$/, ' desc')
+      end
+
+    end
+
+  end
+end

data/lib/default_where/range.rb

@@ -1,69 +1,58 @@
-module DefaultWhere::Range
+module DefaultWhere
+  module Range
+    PATTERN = {
+      '>' => /_gt$/,
+      '>=' => /_gte$/,
+      '<' => /_lt$/,
+      '<=' => /_lte$/
+    }
+    SPATTERN = {
+      '_gt' => '>',
+      '_gte' => '>=',
+      '_lt' => '<',
+      '_lte' => '<='
+    }
 
-  PATTERN = {
-    '>' => /_gt$/,
-    '>=' => /_gte$/,
-    '<' => /_lt$/,
-    '<=' => /_lte$/
-  }
 
-  def range_scope(params, options)
-    @range_string = ''
-    @range_hash = {}
+    def range_scope(params)
+      @range_string = ''
+      @range_hash = {}
 
-    range_process(params, options) # 处理范围查询的参数
+      range_process(params)
 
-    @range_string.sub!(/^\sand/, '') if @range_string.start_with?(' and')
+      @range_string.sub!(/^\sand/, '') if @range_string.start_with?(' and')
 
-    condition = [@range_string, @range_hash]
+      condition = [@range_string, @range_hash]
 
-    where(condition)
-  end
-
-  # 处理范围参数
-  def range_process_compare(params, compare)
-    params.each do |origin_key, value|
-      key = origin_key.sub(PATTERN[compare], '')
-
-      @range_string << " and #{key} #{compare} :#{origin_key}"
-      @range_hash.merge! origin_key.to_sym => value
+      where(condition)
     end
 
-    params
-  end
+    # process with table
+    # gt: greater than
+    # gte: greater than or equal to
+    # lt: less than
+    # lte: less than or equal to
+    def range_process(params)
+      SPATTERN.each do |k, v|
+        gt_options = params.select { |key, _| key.end_with?(k) }
+        range_process_compare(gt_options, v)
+      end
+    end
 
+    def range_process_compare(params, compare)
+      params.each do |origin_key, value|
+        key = origin_key.sub(PATTERN[compare], '')
 
-  # 带表格的参数
-  # 先检查是否有范围查询的参数，生成范围的条件
-  # gt: 大于
-  # gte: 大于等于
-  # lt: 小于
-  # lte: 小于等于
-  def range_process(params, options)
-    options.each do |assoc, column|
-      assoc_model = reflections[assoc.to_sym]
-      if assoc_model
-        params.select{ |k, _| k.start_with?(column.to_s) }.each do |key, _|
-          params["#{assoc_model.table_name}.#{key}"] = params.delete(key)
+        @range_string << " and #{key} #{compare} :#{origin_key}"
+        if value.to_i.to_s == value
+          @range_hash.merge! origin_key.to_sym => value.to_i
+        else
+          @range_hash.merge! origin_key.to_sym => value
         end
-      else
-        raise 'Wrong Association Name'
       end
-    end
 
-    params.each do |key, _|
-      params["#{table_name}.#{key}"] = params.delete(key.to_s)
+      params
     end
 
-    gt_options = params.select { |key, _| key.end_with?('_gt') }
-    gte_options = params.select { |key, _| key.end_with?('_gte') }
-    lt_options = params.select { |key, _| key.end_with?('_lt') }
-    lte_options = params.select { |key, _| key.end_with?('_lte') }
-
-    range_process_compare(gt_options, '>')
-    range_process_compare(gte_options, '>=')
-    range_process_compare(lt_options, '<')
-    range_process_compare(lte_options, '<=')
   end
-
 end

data/lib/default_where/version.rb

@@ -1,3 +1,3 @@
 module DefaultWhere
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/default_where.rb

@@ -1,43 +1,84 @@
+require 'default_where/equal'
+require 'default_where/range'
+require 'default_where/order'
+
 module DefaultWhere
-  require 'default_where/equal'
-  require 'default_where/range'
   include DefaultWhere::Equal
   include DefaultWhere::Range
+  include DefaultWhere::Order
 
-  # 参数格式
-  # options 格式：
+  # options：
   # <association_name> => <column_name>
   # student: 'teacher_id'
-  def query_scope(params, options = {}, include = true)
-    params ||= {}
+  def default_where(params = {}, options = {})
+    return all if params.blank?
+
+    params = params_with_table(params, options)
 
-    params = filter_params(params)
     range_params = filter_range(params)
-    equal_params = params.except!(range_params.keys)
+    params = params.except!(range_params.keys)
+
+    order_params = filter_order(params)
+    equal_params = params.except!(order_params.keys)
+
+    include = options.present? && !self.values.keys.include?(:includes)
+
+    if include
+      includes(options.keys)
+    end
 
-    include = include && options.present?
+    if range_params.present?
+      range_scope(range_params, options)
+    end
 
-    if include && range_params.present?
-      includes(options.keys).range_scope(range_params, options).equal_scope(equal_params, options)
-    elsif include && range_params.blank?
-      includes(options.keys).equal_scope(equal_params, options)
-    elsif !include && range_params.present?
-      range_scope(range_params, options).equal_scope(equal_params, options)
-    elsif !include && range_params.blank?
+    if equal_params.present?
       equal_scope(equal_params, options)
     end
-  end
 
-  private
-  # remove blank values
-  def filter_params(params)
-    params.select { |_, v| v.present? }
+    if order_params
+      order_scope(order_params, options)
+    end
   end
 
   def filter_range(params)
-    params.select do |key, _|
-      key.end_with?('gt', 'gte', 'lt', 'lte')
+    params.select do |k, _|
+      k.end_with?('_gt', '_gte', '_lt', '_lte')
+    end
+  end
+
+  def filter_order(params)
+    params.select do |k, _|
+      k.end_with?('_asc', '_desc')
+    end
+  end
+
+  # params with table
+  def params_with_table(params, options)
+    params.stringify_keys!
+    params.compact!
+
+    options.each do |assoc, column|
+      assoc_model = reflections[assoc.to_s]
+
+      if assoc_model
+        params.select{ |k, _| k.start_with?(column.to_s) }.each do |k, _|
+          params["#{assoc_model.table_name}.#{k}"] = params.delete(k)
+        end
+      else
+        raise 'Wrong Association Name'
+      end
     end
+
+    # since 1.9 is using lazy iteration
+    params.to_a.each do |key, _|
+      if column_names.include?(key)
+        params["#{table_name}.#{key}"] = params.delete(key.to_s)
+      elsif !key.include?('.')
+        params.delete(key.to_s)
+      end
+    end
+
+    params
   end
 
 end

data/test/default_where_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+class DefaultWhereTest < ActiveSupport::TestCase
+
+  test "truth" do
+    assert_kind_of Module, DefaultWhere
+  end
+
+  test "" do
+    params = { id: 1, uid: 2, name: 3 }
+    options = { signs: 'name' }
+
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: default_where
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - qinmingyuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-11 00:00:00.000000000 Z
+date: 2015-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 4.0.0
 description: Description of QueryScope.
 email:
 - mingyuan0715@foxmail.com
@@ -32,12 +32,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
+- README.md
 - Rakefile
 - lib/default_where.rb
 - lib/default_where/equal.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/dummy/README.rdoc
 - test/dummy/Rakefile
 - test/dummy/app/assets/javascripts/application.js
@@ -71,7 +74,6 @@ files:
 - test/dummy/public/422.html
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
-- test/query_scope_test.rb
 - test/test_helper.rb
 homepage: https://github.com/qinmingyuan/default_where
 licenses:
@@ -93,11 +95,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: Summary of QueryScope.
+summary: default process params for where
 test_files:
+- test/default_where_test.rb
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/controllers/application_controller.rb
@@ -131,5 +134,4 @@ test_files:
 - test/dummy/public/favicon.ico
 - test/dummy/Rakefile
 - test/dummy/README.rdoc
-- test/query_scope_test.rb
 - test/test_helper.rb

data/test/query_scope_test.rb

@@ -1,7 +0,0 @@
-require 'test_helper'
-
-class QueryScopeTest < ActiveSupport::TestCase
-  test "truth" do
-    assert_kind_of Module, QueryScope
-  end
-end