default_where 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bab39ef3d31eaf2792f44350e22cdc97ea35d3e3
-  data.tar.gz: fd311a5d219d7cf5b5ee6ecf5f3240fd9b79408c
+SHA256:
+  metadata.gz: 2b85a4951acd26f1a6797d490d439eee08d8c67e3ffb85b448b575e397944198
+  data.tar.gz: 4170d4c7ef435d25c74ba47baf650d55b2bf452552be983a853df4be470a7034
 SHA512:
-  metadata.gz: ae8a24b39eb7fa0a412139fb9e0be1506e9753c5c10969dbe169a4fe50c35c30b6973cfd1e9649f146ad2ad706d8351d0bfa479dc4a21d30e39d34e093c81f41
-  data.tar.gz: 46bc20372f0a1f118fe25ec723ab29d2b64f9c9e4568bbdd82ac7e46568848abcebcc8aada55e763a40e9cd72832bc3e8e7600bb9f0ee0e77607ef2ecf4c4829
+  metadata.gz: fdd9c0a69cb31188ce01230ace81e618e4c14ad92f88f9e6622d2857c253ca6363c34d17bd5c1269cf8a7c7f7338e4a4d463cfde03950616e274ad6dd6129de3
+  data.tar.gz: eb48499fae1cbe71cb4adb659982b31145a1f29a3d22ce950e25735ac4a2df6e3614641b9b419da35e677a75b84c22358a166a0da2abaaa77857f18613c70a40

data/README.md

@@ -2,12 +2,13 @@
 
 This Library 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`
+
 ## Features and Usage
 
 ### Normal equal params
 
-- Params:
-
+* Params:
 ```ruby
 # rails 4 and later, default_where does nothing
 params = { role_id: 1, age: 20 }
@@ -16,7 +17,7 @@ User.default_where(params)
 
 ### Equal params with association
 
-- params
+* params
 ```ruby
 User.belongs_to :role
 params = { name: 'dhh', 'role.id': 2 }
@@ -24,41 +25,40 @@ 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`
+* Before use `default_where`
 ```ruby
 User.includes(:student).where(name: params[:name], role: {id: params[:'role.id']})
 ```
-- After Use `default_where`
+* After Use `default_where`
 ```ruby
 User.default_where(params)
 ```
 
 ### Range params
-- params
+* params
 ```ruby
 params = { 'role_id-lte': 2 }
 ```
-- Before use `default_where`
+* Before use `default_where`
 ```ruby
 User.where('role_id >= ?', params[:'role_id-lte'])
 ```
-- After use `default_where`
+* After use `default_where`
 ```ruby
 User.default_where(params)
 ```
 
 ### Auto remove blank params by default, no need write query with `if else`
-- params
+* params
 ```ruby
 params = { age: '', role_id: 1 }
 ```
-
-- Before use `default_where`
+* Before use `default_where`
 ```ruby
 users = User.where(role_id: params[:role_id])
 users = users.where(age: params[:age]) if params[:age]
 ```
-- After use `default_where`
+* After use `default_where`
 ```ruby
 User.default_where(params)
 
@@ -66,30 +66,47 @@ User.default_where(params)
 User.default_where(params, { allow: [nil] })
 ```
 
+### Auto call strip for string 
+* params
+```ruby
+params= { name: ' dhh ' }
+```
+* Before use `default_where`
+```ruby
+User.where(name: params[:name].strip)
+```
+* After use `default_where`
+```ruby
+User.default_where(params)
+
+# also can control whether use strip
+User.default_where(params, { strip: false })
+```
+
 ### Order params
-- Params
+* Params
 ```ruby
 params = { 'age-asc': '1', 'last_login_at-asc': '2' }
 ```
-- Before use `default_where`
+* Before use `default_where`
 ```ruby
 User.order(age: :asc, last_login_at: :asc)
 ```
-- After use `default_where`
+* After use `default_where`
 ```ruby
 User.default_where(params)
 ```
 
 ## A sample with all params above
-- Params
+* Params
 ```ruby
 { name: 'dhh', 'role.id': 2, 'age-lte': 2, 'age-asc': '1', 'last_login_at-asc': '2' }
 ```
-- Before use `default_where`
+* Before use `default_where`
 ```ruby
 User.includes(:role).where(name: params[:name], 'roles.id': params[:'role.id']).order(age: :asc, last_login_at: :asc)
 ```
-- After use `default_where`
+* After use `default_where`
 ```ruby
 User.default_where(params)
 ```

data/lib/default_where.rb

@@ -10,7 +10,7 @@ module DefaultWhere
   include DefaultWhere::Like
 
   REJECT = ['', ' ', nil]
-
+  STRIP = true
 
   def default_where(params = {}, options = {})
     return all if params.blank?
@@ -40,6 +40,10 @@ module DefaultWhere
       default_reject = REJECT
     end
 
+    unless options.has_key? :strip
+      options[:strip] = STRIP
+    end
+
     params = params.to_h
     params.stringify_keys!
     params.reject! { |_, value| default_reject.include?(value) }
@@ -48,20 +52,22 @@ module DefaultWhere
     tables = []
     final_params = {}
 
-    params.each do |key, _|
+    params.each do |key, value|
+      value = value.strip if value.is_a?(String) && options[:strip]
+
       if key =~ /\./
         table, col = key.split('.')
         as_model = reflections[table]
         f_col, _ = col.split('-')
 
         if as_model && as_model.klass.column_names.include?(f_col)
-          final_params["#{as_model.table_name}.#{col}"] = params[key]
+          final_params["#{as_model.table_name}.#{col}"] = value
           tables << as_model.table_name
           refs << table.to_sym
         elsif connection.data_sources.include? table
-          final_params["#{table}.#{col}"] = params[key]
+          final_params["#{table}.#{col}"] = value
           tables << table
-          keys = reflections.select { |_, v| v.table_name == table }.keys
+          keys = reflections.select { |_, v| !v.polymorphic? && v.table_name == table }.keys
           if keys && keys.size == 1
             refs << keys.first.to_sym
           end
@@ -69,7 +75,7 @@ module DefaultWhere
       else
         f_key, _ = key.split('-')
         if column_names.include?(f_key)
-          final_params["#{table_name}.#{key}"] = params[key]
+          final_params["#{key}"] = value
         end
       end
     end

data/lib/default_where/like.rb

@@ -7,7 +7,11 @@ module DefaultWhere
 
       params.select{ |k, _| k.end_with?('-like') }.each do |key, value|
         real_key = key.sub(/-like$/, '')
-        agent_key = key.gsub(/[-\.]/, '_')
+        agent_key = key.gsub(/[-.]/, '_')
+
+        if column_names.include?(real_key)
+          real_key = "#{table_name}.#{real_key}"
+        end
 
         where_string << "#{real_key} like :#{agent_key}"
         where_hash.merge! agent_key.to_sym => '%' + value.to_s + '%'

data/lib/default_where/not.rb

@@ -6,7 +6,12 @@ module DefaultWhere
 
       params.each do |key, value|
         real_key = key.sub(/-not$/, '')
-        where_hash.merge! real_key.to_sym => value
+
+        if column_names.include?(real_key)
+          real_key = "#{table_name}.#{real_key}"
+        end
+
+        where_hash.merge! real_key => value
       end
 
       if where_hash.present?

data/lib/default_where/range.rb

@@ -18,7 +18,11 @@ module DefaultWhere
         options.each do |key, value|
           exp = Regexp.new(char + '$')
           real_key = key.sub(exp, '')
-          agent_key = key.gsub(/[-\.]/, '_')
+          agent_key = key.gsub(/[-.]/, '_')
+
+          if column_names.include?(real_key)
+            real_key = "#{table_name}.#{real_key}"
+          end
 
           where_string << "#{real_key} #{sign} :#{agent_key}"
 

data/lib/default_where/version.rb

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

data/test/database.yml

@@ -0,0 +1,16 @@
+sqlite:
+  adapter: sqlite3
+  database: "file:memdb1?mode=memory&cache=shared"
+
+mysql:
+  adapter: mysql2
+  username: root
+  password:
+  database: default_where
+
+postgresql:
+  adapter: postgresql
+  username: postgres
+  password:
+  database: default_where
+  min_messages: ERROR

data/test/default_where_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require 'helper'
 
 class DefaultWhereTest < ActiveSupport::TestCase
 

data/test/helper.rb

@@ -0,0 +1,24 @@
+# $DEBUG = true
+
+require "rubygems"
+require "bundler/setup"
+begin
+  Bundler.setup(:default, :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"
+
+db_config = YAML.load_file(File.expand_path("../database.yml", __FILE__)).fetch(ENV["DB"] || "sqlite")
+ActiveRecord::Base.establish_connection(db_config)
+ActiveRecord::Schema.verbose = false
+
+def teardown_db
+  tables = ActiveRecord::Base.connection.data_sources
+  tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: default_where
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - qinmingyuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-05 00:00:00.000000000 Z
+date: 2018-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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.
 email:
 - mingyuan0715@foxmail.com
@@ -40,8 +68,9 @@ files:
 - lib/default_where/order.rb
 - lib/default_where/range.rb
 - lib/default_where/version.rb
+- test/database.yml
 - test/default_where_test.rb
-- test/test_helper.rb
+- test/helper.rb
 homepage: https://github.com/qinmingyuan/default_where
 licenses:
 - MIT
@@ -62,10 +91,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: default process params for where
 test_files:
 - test/default_where_test.rb
-- test/test_helper.rb
+- test/helper.rb
+- test/database.yml

data/test/test_helper.rb

@@ -1,18 +0,0 @@
-# Configure Rails Environment
-ENV["RAILS_ENV"] = "test"
-
-require File.expand_path("../../test/dummy/config/environment.rb",  __FILE__)
-ActiveRecord::Migrator.migrations_paths = [File.expand_path("../../test/dummy/db/migrate", __FILE__)]
-require "rails/test_help"
-
-# Filter out Minitest backtrace while allowing backtrace from other libraries
-# to be shown.
-Minitest.backtrace_filter = Minitest::BacktraceFilter.new
-
-# Load support files
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
-
-# Load fixtures from the engine
-if ActiveSupport::TestCase.method_defined?(:fixture_path=)
-  ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
-end