queryko 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c91af5a14ce3447dbd85a0ed6e9d057ade7b9ac
+  data.tar.gz: bee0aa72bec7eac273133407caee6849136edc49
+SHA512:
+  metadata.gz: a479ff93aba7aed45cfdb72245d0759ae87cc58c835b130be8305ffab51e960f3d1fccd14f786e4db6ce5ec65bf346b32fa6c09fdfde875cbab9a7eab67500b1
+  data.tar.gz: d8e93266b61f3cc15f49b53e450f673ff5c16f54004072477baf216e2d3d339f0fa9fc3f429aa2a4de6e4ce89a8165ac59fcdc2f257908100267da7e6935da28

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

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 valerosjoseph@gmail.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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in queryko.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: .
+  specs:
+    queryko (0.1.0)
+      activerecord (>= 5.1, < 5.2)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionview (5.1.6)
+      activesupport (= 5.1.6)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activemodel (5.1.6)
+      activesupport (= 5.1.6)
+    activerecord (5.1.6)
+      activemodel (= 5.1.6)
+      activesupport (= 5.1.6)
+      arel (~> 8.0)
+    activesupport (5.1.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    erubi (1.7.1)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
+    kaminari (1.1.1)
+      activesupport (>= 4.1.0)
+      kaminari-actionview (= 1.1.1)
+      kaminari-activerecord (= 1.1.1)
+      kaminari-core (= 1.1.1)
+    kaminari-actionview (1.1.1)
+      actionview
+      kaminari-core (= 1.1.1)
+    kaminari-activerecord (1.1.1)
+      activerecord
+      kaminari-core (= 1.1.1)
+    kaminari-core (1.1.1)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    nokogiri (1.8.4)
+      mini_portile2 (~> 2.3.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    sqlite3 (1.3.13)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  kaminari
+  queryko!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sqlite3
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Joseph Nelson Valeros
+
+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,51 @@
+# Queryko
+This gem provides additional functionality on your query objects. It will filter and paginate your query by supplying an option
+
+## Installation
+
+```ruby
+gem 'queryko'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install queryko
+
+## Usage
+### Create a query object
+``` ruby
+class ProductsQuery < Queryko::QueryObject
+  add_range_attributes :created_at, :price
+  add_searchables :name, :vendor
+
+  def initialize params={}, relation = Product.all
+    super(params, relation)
+  end
+end
+```
+
+### Using your query object
+Filter your query by appending `_min` or `_max` on your defined attributes. You can also filter searc3h by attribute.
+As long as you defined it in your query object definition.
+``` ruby
+products = ProductsQuery.new(price_min: 100, price_max: 150, name: 'Milk').call
+```
+### Other available options
+| Option   | description                  |
+|:---------|:-----------------------------|
+| since_id | retrieves records after `id` |
+| page     | page to retrieve             |
+| limit    | number of records per page   |
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/neume/queryko. 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,5 @@
+require "queryko/version"
+require "queryko/query_object"
+module Queryko
+  # Your code goes here...
+end

data/lib/queryko/after_attributes.rb

@@ -0,0 +1,31 @@
+module Queryko
+  module AfterAttributes
+  def self.included(base)
+    base.extend(ClassMethods)
+    base.class_eval do
+      class_attribute :after_attributes, default: [], instance_writer: false
+      self.after_attributes = []
+
+      private
+
+      def filter_after_attributes
+        self.after_attributes.each do |attribute|
+          if params["after_#{attribute}".to_sym].present?
+            filter_after attribute
+          end
+        end
+      end
+      def filter_after attribute
+        self.relation = relation.where("#{attribute} > ?", params["after_#{attribute}".to_sym])
+      end
+    end
+  end
+
+  module ClassMethods
+    def add_after_attributes(*args)
+      self.after_attributes ||= []
+      self.after_attributes += args
+    end
+  end
+end
+end

data/lib/queryko/query_object.rb

@@ -0,0 +1,72 @@
+require "active_support/core_ext/class/attribute"
+require "queryko/range_attributes"
+require "queryko/searchables"
+require "queryko/after_attributes"
+module Queryko
+  class QueryObject
+    include Queryko::RangeAttributes
+    include Queryko::Searchables
+    # include AfterAttributes
+
+    def initialize(params = {}, rel)
+      @relation = rel
+      @params = params
+    end
+
+    def call
+      pre_filter
+      filter
+      filter_by_range_attributes
+      filter_by_searchables
+      return relation
+    end
+
+    private
+
+    attr_reader :params, :relation
+    attr_writer :relation
+
+    def config
+      @config ||= {
+        paginate: true,
+        since_id: true,
+        ids: true
+      }
+    end
+
+    def pre_filter
+      self.relation = paginate if config[:paginate]
+      self.relation = by_ids if config[:ids] && params[:ids]
+      self.relation = since_id if config[:since_id] && params[:since_id]
+    end
+
+    def filter
+    end
+
+    def paginate
+      relation.page(page).per(limit)
+    end
+
+    def page
+      params[:page] || 1
+    end
+
+    def limit
+      @limit ||= get_limit
+    end
+
+    def get_limit
+      params[:limit] || 50
+      # lim > 100 ? 100 : lim.to_i
+    end
+
+    def by_ids
+      relation.where(id: params[:ids])
+    end
+
+    def since_id
+      relation.where("id > ?", params[:since_id])
+    end
+
+  end
+end

data/lib/queryko/range_attributes.rb

@@ -0,0 +1,40 @@
+module Queryko
+  module RangeAttributes
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.class_eval do
+        class_attribute :range_attributes, default: Array.new, instance_writer: false
+        self.range_attributes = []
+
+        private
+
+        def filter_by_range_attributes
+          self.range_attributes.each do |range_attribute|
+            self.relation = attribute_max("#{range_attribute}_max") if params["#{range_attribute}_max".to_sym]
+            self.relation = attribute_min("#{range_attribute}_min") if params["#{range_attribute}_min".to_sym]
+          end
+        end
+
+
+        def attribute_min key
+          # Calm down. column_name is whitelisted. check #add_range_attributes method
+          column_name = key.to_s.gsub(/_min$/, "")
+          relation.where("#{column_name} >= ?", params[key.to_sym])
+        end
+
+        def attribute_max key
+          # Calm down. column_name is whitelisted. check #add_range_attributes method
+          column_name = key.to_s.gsub(/_max$/, "")
+          relation.where("#{column_name} <= ?", params[key.to_sym])
+        end
+      end
+    end
+
+    module ClassMethods
+      def add_range_attributes(*args)
+        self.range_attributes ||= []
+        self.range_attributes += args
+      end
+    end
+  end
+end

data/lib/queryko/searchables.rb

@@ -0,0 +1,27 @@
+module Queryko
+  module Searchables
+  def self.included(base)
+    base.extend(ClassMethods)
+    base.class_eval do
+      class_attribute :searchables, default: Array.new, instance_writer: false
+      self.searchables = []
+
+      private
+
+      def filter_by_searchables
+        self.searchables.each do |searchable|
+          column = searchable.to_sym
+          self.relation = relation.where(column => params[column]) if params[column].present?
+        end
+      end
+    end
+  end
+
+  module ClassMethods
+    def add_searchables(*args)
+      self.searchables ||= []
+      self.searchables += args
+    end
+  end
+end
+end

data/lib/queryko/version.rb

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

data/queryko.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "queryko/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "queryko"
+  spec.version       = Queryko::VERSION
+  spec.authors       = ["Joseph Nelson Valeros"]
+  spec.email         = ["valerosjoseph@gmail.com"]
+
+  spec.summary       = %q{ A gem that simplifies query objects }
+  spec.description   = %q{ This gem provides additional functionality on your query objects. It will filter and paginate your query by supplying an option }
+  spec.homepage      = "https://github.com/neume/queryko"
+  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"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # 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"]
+
+	spec.add_dependency 'activerecord', '>= 5.1', "< 5.2"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'kaminari'
+
+  spec.add_dependency "activesupport"
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: queryko
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joseph Nelson Valeros
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: kaminari
+  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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: " This gem provides additional functionality on your query objects. It
+  will filter and paginate your query by supplying an option "
+email:
+- valerosjoseph@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/queryko.rb
+- lib/queryko/after_attributes.rb
+- lib/queryko/query_object.rb
+- lib/queryko/range_attributes.rb
+- lib/queryko/searchables.rb
+- lib/queryko/version.rb
+- queryko.gemspec
+homepage: https://github.com/neume/queryko
+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.6.14
+signing_key: 
+specification_version: 4
+summary: A gem that simplifies query objects
+test_files: []