acts_as_queryable 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4d75d05457ec86014535f58614982634b6ed0054
+  data.tar.gz: 170273be76174998d5d846d4d53157ba1fa3d04e
+SHA512:
+  metadata.gz: 1a52e16c951a71db4b8cbb23dcdedb98fd7c3209d3a5a3f194534fd6aae240854ce6a0468fc971fc8a9c3d60ae8c080f12e78e48f8d3c92386acc37917a58b16
+  data.tar.gz: 152bb78207467e409aaf38c8deb80f59783cf9c1e9a3333921f0053fee71973d410224b7c820bd063c112e34cd805ecdba2b20846bf09c08bedf3940476a4237

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.13.6

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 ch3rub1m@foxmail.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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in acts_as_queryable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ch3rub1m
+
+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,145 @@
+# ActsAsQueryable
+
+A Rails plugin to add support of Query by url search params.
+
+This gem can be used to Query records without any scope.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'acts_as_queryable'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### In your model:
+
+``` ruby
+class Brand < ActiveRecord::Base
+  acts_as_queryable
+
+  # ...
+end
+```
+
+Calling `query` with any attributes of the model will now get the filtered results:
+
+``` ruby
+>> Brand.all
+=> #<ActiveRecord::Relation [#<V1::Brand id: 1, name: "Apple">,
+                             #<V1::Brand id: 2, name: "Sony">,
+                             #<V1::Brand id: 3, name: "Nintendo">,
+                             #<V1::Brand id: 4, name: "Amazon">,
+                             #<V1::Brand id: 5, name: nil>]>
+
+>> Brand.query(name: 'Apple')
+=> #<ActiveRecord::Relation [#<V1::Brand id: 1, name: "Apple">]>
+```
+
+If the type of attribute is `string`, the Query will use `contains` method.
+
+``` ruby
+>> Brand.query(name: 'So')
+=> #<ActiveRecord::Relation [#<V1::Brand id: 2, name: "Sony">]>
+```
+
+#### Fetch the records that an attribute is NULL
+
+``` ruby
+>> Brand.query(name: 'NULL')
+=> #<ActiveRecord::Relation [#<V1::Brand id: 5, name: nil>]>
+```
+
+#### Numeric comparison
+
+If the type of attribute is `integer`, `float` or `datetime`, the Query will add numeric comparison support.
+
+``` ruby
+>> Brand.query(id_gt: 4)
+=> #<ActiveRecord::Relation [#<V1::Brand id: 5, name: nil>]>
+
+>> Brand.query(id_lt: 2)
+=> #<ActiveRecord::Relation [#<V1::Brand id: 1, name: "Apple">]>
+```
+
+#### Multiple fetch
+
+Multiple fetch is available by using a string split by comma(`,`) instead of a integer attribute.
+
+``` ruby
+>> Brand.query(id: '2,3')
+=> #<ActiveRecord::Relation [#<V1::Brand id: 2, name: "Sony">, #<V1::Brand id: 3, name: "Nintendo">]>
+```
+
+
+### In your controller:
+
+``` ruby
+class BrandsController < ApplicationController
+  def index
+    @brands = Brand.query(params)
+
+    # ...
+  end
+end
+```
+
+### Customize
+
+#### excpet
+
+If you don't want to use many attributes for Query , you can pass them as an option:
+
+``` ruby
+class Client < ActiveRecord::Base
+  acts_as_queryable except: [:name]
+
+  ...
+end
+```
+
+#### order
+
+If you want to open the `order` feature:
+
+``` ruby
+class Client < ActiveRecord::Base
+  acts_as_queryable order: true
+
+  ...
+end
+```
+
+Now you can fetch the records order by an attribute:
+
+`GET https://api.restful.com/v1/brands?order=id desc`
+
+``` ruby
+=> #<ActiveRecord::Relation [#<V1::Brand id: 5, name: nil>,
+                             #<V1::Brand id: 4, name: "Amazon">,
+                             #<V1::Brand id: 3, name: "Nintendo">,
+                             #<V1::Brand id: 2, name: "Sony">,
+                             #<V1::Brand id: 1, name: "Apple">]>
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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/ch3rub1m/acts_as_queryable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/acts_as_queryable.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acts_as_queryable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "acts_as_queryable"
+  spec.version       = ActsAsQueryable::VERSION
+  spec.authors       = ["Ch3rub1m"]
+  spec.email         = ["ch3rub1m@foxmail.com"]
+
+  spec.summary       = %q{Active Record plugin which allows you to query records without any scope.}
+  spec.description   = %q{Check the home page for more in-depth information.}
+  spec.homepage      = "https://github.com/ch3rub1m/acts_as_queryable"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "acts_as_queryable"
+
+# 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

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/acts_as_queryable.rb

@@ -0,0 +1,75 @@
+require "acts_as_queryable/version"
+
+module ActsAsQueryable
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def acts_as_queryable(options = {})
+      raise ArgumentError, "Hash expected, got #{options.class.name}" unless options.is_a?(Hash) || options.empty?
+      except = options[:except] || []
+      raise ArgumentError, "Array expected, got #{except.class.name}" unless except.class.name || options.empty?
+      except.map! { |e| e.to_s }
+      @query_param_names = self.attribute_names - except
+      @order = options[:order]
+    end
+
+    def query(query_params)
+      conditions = []
+      params = []
+      query_params.each do |key, value|
+        key = key.to_s
+        next unless self.columns_hash[key] && @query_param_names.include?(key)
+        if value == 'NULL'
+          conditions << "#{key} IS NULL"
+          next
+        end
+        case self.columns_hash[key].type
+        when :string, :text
+          conditions << "#{key} LIKE ?"
+          params << "%#{value}%"
+        when :integer
+          sub_conditions = []
+          value.split(',').each do |integer|
+            sub_conditions << "#{key} = ?"
+            params << integer
+          end
+          conditions << "(#{sub_conditions.join(' OR ')})"
+        else
+          conditions << "#{key} = ?"
+          params << value
+        end
+      end
+      query_params.each do |key, value|
+        key = key.to_s
+        suffix = suffix(key)
+        key = remove_suffix(key)
+        next unless self.columns_hash[key]
+        case self.columns_hash[key].type
+        when :integer, :float, :datetime
+          case suffix
+          when 'gt'
+            conditions << "#{key} > ?"
+            params << value
+          when 'lt'
+            conditions << "#{key} < ?"
+            params << value
+          end
+        end
+      end
+      query = conditions.join(' AND ')
+      self.where(query, *params).order(@order && query_params[:order])
+    end
+
+    private
+      def remove_suffix(string)
+        suffix_length = suffix(string).length + 1
+        string.slice(0...string.length - suffix_length)
+      end
+
+      def suffix(string)
+        string.split('_').last
+      end
+  end
+end
+
+ActiveRecord::Base.send :include, ActsAsQueryable

data/lib/acts_as_queryable/version.rb

@@ -0,0 +1,3 @@
+module ActsAsQueryable
+  VERSION = "0.1.2"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_queryable
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Ch3rub1m
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Check the home page for more in-depth information.
+email:
+- ch3rub1m@foxmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- acts_as_queryable.gemspec
+- bin/console
+- bin/setup
+- lib/acts_as_queryable.rb
+- lib/acts_as_queryable/version.rb
+homepage: https://github.com/ch3rub1m/acts_as_queryable
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Active Record plugin which allows you to query records without any scope.
+test_files: []