the_where 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 42e1bbaf99803b72a1c4fa60b671368bc2058d7da23131e919f0ef0f06e6964e
+  data.tar.gz: ee258e9d5d1048dc39b532028fe828d623a75cc8ab962e82a898dfe20d91dda4
+SHA512:
+  metadata.gz: '088f831bd174328c580ce978f981a5f14fbb02e97f530fda8326219d6ed0b3ed491b9d89f89b1d2ec2fae1a4a7c8a13623f1be7ed10e5c530fac701334c0358d'
+  data.tar.gz: '08026322f674724d5fdc38939087c0d3e6589aa2e9cbad710b3fb76ba10959c67476125ad5e559decf3c945cd1aa9837760f54d01e4865be12ee5678f55aa6b5'

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at liuya@163.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in the_where.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    the_where (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (12.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  the_where!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 sai
+
+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

@@ -0,0 +1,139 @@
+# TheWhere
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/the_where`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'the_where'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install the_where
+
+## Usage
+
+## TheWhere
+
+This Library set default params process for where query in ActiveRecord
+
+## Features and Usage
+
+### Normal equal params
+
+- Params:
+
+```ruby
+# rails 4 and later, the_where does nothing
+params = { role_id: 1, age: 20 }
+User.the_where(params)
+```
+
+### Equal params with association
+
+- 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 `the_where`
+```ruby
+User.includes(:student).where(name: params[:name], role: {id: params[:'role.id']})
+```
+- After Use `the_where`
+```ruby
+User.the_where(params)
+```
+
+### Range params
+- params
+```ruby
+params = { 'role_id-lte': 2 }
+```
+- Before use `the_where`
+```ruby
+User.where('role_id >= ?', params[:'role_id-lte'])
+```
+- After use `the_where`
+```ruby
+User.the_where(params)
+```
+
+### Auto remove blank params by default, no need write query with `if else`
+- params
+```ruby
+params = { age: '', role_id: 1 }
+```
+
+- Before use `the_where`
+```ruby
+users = User.where(role_id: params[:role_id])
+users = users.where(age: params[:age]) if params[:age]
+```
+- After use `the_where`
+```ruby
+User.the_where(params)
+
+# also can control which blank value can use
+User.the_where(params, { allow: [nil] })
+```
+
+### Order params
+- Params
+```ruby
+params = { 'age-asc': '1', 'last_login_at-asc': '2' }
+```
+- Before use `the_where`
+```ruby
+User.order(age: :asc, last_login_at: :asc)
+```
+- After use `the_where`
+```ruby
+User.the_where(params)
+```
+
+## A sample with all params above
+- Params
+```ruby
+{ name: 'dhh', 'role.id': 2, 'age-lte': 2, 'age-asc': '1', 'last_login_at-asc': '2' }
+```
+- Before use `the_where`
+```ruby
+User.includes(:role).where(name: params[:name], 'roles.id': params[:'role.id']).order(age: :asc, last_login_at: :asc)
+```
+- After use `the_where`
+```ruby
+User.the_where(params)
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/the_where. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/the_where/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TheWhere project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/the_where/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "the_where"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/the_where.rb

@@ -0,0 +1,88 @@
+require 'the_where/not'
+require 'the_where/range'
+require 'the_where/like'
+require 'the_where/order'
+
+module TheWhere
+  include TheWhere::Not
+  include TheWhere::Range
+  include TheWhere::Order
+  include TheWhere::Like
+
+  REJECT = ['', ' ', nil]
+  STRIP = true
+
+  def the_where(params = {}, options = {})
+    return all if params.blank?
+
+    params, refs, tables = params_with_table(params, options)
+
+    range_params = filter_range(params)
+    order_params = filter_order(params)
+    not_params = filter_not(params)
+    like_params = filter_like(params)
+
+    equal_params = params.except!(*range_params.keys, *order_params.keys, *not_params.keys, *like_params.keys)
+
+    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 = {})
+    if options[:reject]
+      default_reject = [options[:reject]].flatten
+    elsif options[:allow]
+      default_reject = REJECT - [options[:allow]].flatten
+    else
+      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) }
+
+    refs = []
+    tables = []
+    final_params = {}
+
+    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}"] = value
+          tables << as_model.table_name
+          refs << table.to_sym
+        elsif connection.data_sources.include? table
+          final_params["#{table}.#{col}"] = value
+          tables << table
+          keys = reflections.select { |_, v| !v.polymorphic? && 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)
+          final_params["#{table_name}.#{key}"] = value
+        end
+      end
+    end
+
+    [final_params, refs, tables]
+  end
+
+end
+
+ActiveRecord::Base.extend TheWhere

data/lib/the_where/like.rb

@@ -0,0 +1,33 @@
+module TheWhere
+  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/the_where/not.rb

@@ -0,0 +1,26 @@
+module TheWhere
+  module Not
+
+    def not_scope(params)
+      where_hash = {}
+
+      params.each do |key, value|
+        real_key = key.sub(/-not$/, '')
+        where_hash.merge! real_key.to_sym => 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/the_where/order.rb

@@ -0,0 +1,25 @@
+module TheWhere
+  module Order
+
+    def order_scope(params)
+      order_array = []
+
+      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
+
+      order(order_array)
+    end
+
+    def filter_order(params)
+      params.select do |k, v|
+        k.end_with?('-asc', '-desc') && v =~ /^[1-9]$/
+      end
+    end
+
+  end
+end

data/lib/the_where/range.rb

@@ -0,0 +1,46 @@
+module TheWhere
+  module Range
+
+    PATTERN = {
+      '-gt' => '>',
+      '-gte' => '>=',
+      '-lt' => '<',
+      '-lte' => '<='
+    }
+
+    def range_scope(params)
+      where_string = []
+      where_hash = {}
+
+      PATTERN.each do |char, sign|
+        options = params.select{ |key, _| key.end_with?(char) }
+
+        options.each do |key, value|
+          exp = Regexp.new(char + '$')
+          real_key = key.sub(exp, '')
+          agent_key = key.gsub(/[-\.]/, '_')
+
+          where_string << "#{real_key} #{sign} :#{agent_key}"
+
+          where_hash.merge! agent_key.to_sym => value
+        end
+      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

data/lib/the_where/version.rb

@@ -0,0 +1,3 @@
+module TheWhere
+  VERSION = "0.1.0"
+end

data/the_where.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/the_where/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "the_where"
+  spec.version       = TheWhere::VERSION
+  spec.authors       = ["sai1024"]
+  spec.email         = ["rubyer1993@gmail.com"]
+
+  spec.summary       = "Simpler query for ruby"
+  spec.description   = "Simpler query for ruby"
+  spec.homepage      = "https://github.com/sai1024/the_where"
+  spec.license       = "MIT"
+  # spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  # spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "https://github.com/sai1024/the_where"
+  # spec.metadata["changelog_uri"] = "https://github.com/sai1024/the_where/blob/main/README.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: the_where
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sai1024
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-01-06 00:00:00.000000000 Z
+dependencies: []
+description: Simpler query for ruby
+email:
+- rubyer1993@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/the_where.rb
+- lib/the_where/like.rb
+- lib/the_where/not.rb
+- lib/the_where/order.rb
+- lib/the_where/range.rb
+- lib/the_where/version.rb
+- the_where.gemspec
+homepage: https://github.com/sai1024/the_where
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.10
+signing_key: 
+specification_version: 4
+summary: Simpler query for ruby
+test_files: []