query_helper 0.2.21 → 0.2.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7fa1887aad7e034e96bc261c6683e21b8eda27b21d7039986dd03d72c837a83
-  data.tar.gz: 292df8c5f4cd2bacc4790cc5d4afc1c88815c5bf605edaae74c34a52cdef2e51
+  metadata.gz: 6393029fea1bbf5dcc2e0c724689a7a9eada99b0bcba65896ddfcb4704442130
+  data.tar.gz: a988a611a54efa8ea34080294b92c278bb5dbc3cf59e3598b1e7a3668f87343c
 SHA512:
-  metadata.gz: d4ad632451fb4798096381a2d9698d77ecffa01e38868f0b7d7eac1423918d6ad5917748090ac426571e2cd2f230a74b9a7659ed4a609325562d2cd2fe379e1d
-  data.tar.gz: f40530e5d23c849f077b217747b4ec71e0bba1f90de740a0e2363a1a249669f8a52d0be3c693d0bca80748315d5ad7a75c7066e3bfdeea1ad605e41e5b44580d
+  metadata.gz: 8c9a16cf6b3706de8eede885b7301d433b2317ea8bb1136d4386d7248c11dd06851d51d9ba6bd3536382b37103ed22554ce757ddb63ea85f6af43e62dcbc6650
+  data.tar.gz: b6f5bf13fee17da7f195a6ff4e38afe68020379782ada889514654c769014ec41dc31ca7eafc743299dac5cf729cc27c842c7b72cb5ce55984dc3bb9548666f2

data/.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: CI
+
+on: [push]
+
+env:
+  RAILS_ENV: test
+  GEMFILE_RUBY_VERSION: 2.7.2
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby 2.7.2
+        uses: ruby/setup-ruby@v1
+        with:
+          # Not needed with a .ruby-version file
+          ruby-version: 2.7.2
+          # runs 'bundle install' and caches installed gems automatically
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rspec spec

data/.gitignore

@@ -10,3 +10,4 @@
 # rspec failure tracking
 .rspec_status
 .byebug_history
+.DS_Store

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ 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 eamigo13@gmail.com. All
+reported by contacting the project team at opensource@pattern.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.

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    query_helper (0.2.21)
+    query_helper (0.2.29)
       activerecord (> 5)
       activesupport (> 5)
+      sqlite3
 
 GEM
   remote: https://rubygems.org/
@@ -46,12 +47,12 @@ GEM
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
-    mini_portile2 (2.6.1)
+    mini_portile2 (2.8.0)
     minitest (5.14.4)
-    nokogiri (1.12.4)
-      mini_portile2 (~> 2.6.1)
+    nokogiri (1.13.3)
+      mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    racc (1.5.2)
+    racc (1.6.0)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -88,7 +89,7 @@ GEM
       rspec-mocks (~> 3.10)
       rspec-support (~> 3.10)
     rspec-support (3.10.2)
-    sqlite3 (1.3.13)
+    sqlite3 (1.4.2)
     thor (1.1.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
@@ -107,7 +108,6 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   rspec-rails
-  sqlite3 (~> 1.3.6)
 
 BUNDLED WITH
-   2.2.27
+   2.2.29

data/README.md

@@ -1,6 +1,6 @@
 # QueryHelper
-[![TravisCI](https://travis-ci.org/iserve-products/query_helper.svg?branch=master)](https://travis-ci.org/iserve-products/query_helper)
 [![Gem Version](https://badge.fury.io/rb/query_helper.svg)](https://badge.fury.io/rb/query_helper)
+[![CI](https://github.com/patterninc/query_helper/actions/workflows/ci.yml/badge.svg)](https://github.com/patterninc/query_helper/actions)
 
 QueryHelper is a ruby gem used to paginate, sort, and filter your API calls in Ruby on Rails using URL params in your HTTP requests.  It currently only supports Postgres.  
 
@@ -88,6 +88,37 @@ Multiple Sorts: `http://www.example.com/resources?sort=resource_name:desc,resour
 
 Lowercase Sort: `http://www.example.com/resources?sort=resource_name:desc:lowercase`
 
+Custom Sort: `http://www.example.com/resources?custom_sort=resource_name:desc`
+Example:
+  Custom Sort is basically used for enum based column.
+  ```
+  class Customer < ApplicationRecord
+    enum customer_type: {
+      enum1: 0,
+      enum2: 1,
+      enum3: 3
+    }
+  end
+  ```
+
+  Usage at Controller
+
+  ```
+  class SomeController
+
+    def index
+      sort_column, sort_direction = params[:custom_sort]&.split(':')  
+
+      column_sort_order = {
+        column_name: sort_column,
+        direction: sort_direction,
+        sort_values: Customer.send(sort_column.pluralize).values
+      }
+
+      @query_helper.update(query: query, column_sort_order: column_sort_order)
+    end
+  end
+  ```
 #### Filtering
 
 `filter[column][operator_code]=value`
@@ -316,7 +347,7 @@ or
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/iserve_products/query_helper. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/patterninc/query_helper. 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
 

data/lib/query_helper/filter.rb

@@ -3,18 +3,20 @@ require "query_helper/invalid_query_error"
 class QueryHelper
   class Filter
 
-    attr_accessor :operator, :criterion, :comparate, :operator_code, :bind_variable, :aggregate
+    attr_accessor :operator, :criterion, :comparate, :operator_code, :bind_variable, :aggregate, :qualify_clause
 
     def initialize(
       operator_code:,
       criterion:,
       comparate:,
-      aggregate: false
+      aggregate: false,
+      qualify_clause: false
     )
       @operator_code = operator_code
       @criterion = criterion # Converts to a string to be inserted into sql.
       @comparate = comparate
       @aggregate = aggregate
+      @qualify_clause = qualify_clause
       @bind_variable = ('a'..'z').to_a.shuffle[0,20].join.to_sym
 
       translate_operator_code()

data/lib/query_helper/query_helper_concern.rb

@@ -31,7 +31,7 @@ class QueryHelper
       end
 
       def create_query_helper_sort
-        QueryHelper::SqlSort.new(sort_string: params[:sort], sort_tiebreak: params[:sort_tiebreak])
+        QueryHelper::SqlSort.new(sort_string: params[:sort], sort_tiebreak: params[:sort_tiebreak], column_sort_order: params[:column_sort_order])
       end
 
       def create_query_helper_associations
@@ -48,7 +48,7 @@ class QueryHelper
       def query_helper_params_no_pagination
         helpers = {}
         helpers[:sql_filter] = create_query_helper_filter() if params[:filter]
-        helpers[:sql_sort] = create_query_helper_sort() if params[:sort] || params[:sort_tiebreak]
+        helpers[:sql_sort] = create_query_helper_sort() if params[:sort] || params[:sort_tiebreak] || params[:custom_sort]
         helpers[:associations] = create_query_helper_associations() if params[:include]
         helpers[:search_string] = params[:search_for] if params[:search_for]
         helpers

data/lib/query_helper/sql_filter.rb

@@ -3,11 +3,13 @@ require "query_helper/invalid_query_error"
 class QueryHelper
   class SqlFilter
 
-    attr_accessor :filter_values, :column_maps
+    attr_accessor :filter_values, :column_maps, :options, :qualify_filters
 
-    def initialize(filter_values: [], column_maps: [])
+    def initialize(filter_values: [], column_maps: [], qualify_filters: [], options: {})
       @column_maps = column_maps
       @filter_values = filter_values
+      @options = options
+      @qualify_filters = qualify_filters
     end
 
     def create_filters
@@ -23,13 +25,22 @@ class QueryHelper
           operator_code: criteria.keys.first,
           criterion: criteria.values.first,
           comparate: map.sql_expression,
-          aggregate: map.aggregate
+          aggregate: map.aggregate,
+          qualify_clause: aggregated_attribute?(comparate: map.sql_expression)
         )
       end
     end
 
+    def aggregated_attribute?(comparate:)
+      @options['qualify_clause'] && qualify_filters.include?(comparate)
+    end
+
+    def qualify_clauses
+      @filters.select{ |f| aggregated_attribute?(comparate: f.comparate) }.map(&:sql_string)
+    end
+
     def where_clauses
-      @filters.select{ |f| f.aggregate == false }.map(&:sql_string)
+      @filters.select{ |f| f.aggregate == false && !f.qualify_clause }.map(&:sql_string)
     end
 
     def having_clauses

data/lib/query_helper/sql_manipulator.rb

@@ -9,14 +9,17 @@ class QueryHelper
       sql:,
       where_clauses: nil,
       having_clauses: nil,
+      qualify_clauses: nil,
       order_by_clauses: nil,
       include_limit_clause: false,
       additional_select_clauses: []
     )
+      sql = remove_qualified_count(sql)
       @parser = SqlParser.new(sql)
       @sql = @parser.sql.dup
       @where_clauses = where_clauses
       @having_clauses = having_clauses
+      @qualify_clauses = qualify_clauses
       @order_by_clauses = order_by_clauses
       @include_limit_clause = include_limit_clause
       @additional_select_clauses = additional_select_clauses
@@ -24,28 +27,69 @@ class QueryHelper
 
     def build
       insert_having_clauses()
+      insert_qualify_clauses()
       insert_where_clauses()
       insert_select_clauses()
       insert_order_by_and_limit_clause()
+      insert_qualified_count_clauses if (qualify_clause_applicable? || @qualify_present) && @include_limit_clause
+
       @sql.squish
     end
 
     private
 
     def insert_select_clauses
-      total_count_clause = "count(*) over () as _query_full_count"
-      @additional_select_clauses << total_count_clause if @include_limit_clause
+      @additional_select_clauses << count_sql if @include_limit_clause && !(qualify_clause_applicable? || @qualify_present)
       @sql.insert(@parser.insert_select_index, " , #{@additional_select_clauses.join(", ")} ") if @additional_select_clauses.length > 0
     end
 
+    def count_sql
+      "count(*) over () as _query_full_count"
+    end
+
+    def qualify_clauses(index)
+      if index == 0
+        "qualified_results AS ( "
+      else
+        ", qualified_results AS ( "
+      end
+    end
+
+    # If modifying something please check remove_qualified_count method too
+    def insert_qualified_count_clauses
+      @sql.insert(@parser.select_index, qualify_clauses(@parser.select_index))
+      @sql.insert(@sql.length, ") SELECT qualified_results.*, #{count_sql} FROM qualified_results")
+    end
+
+    # If modifying something please check insert_qualified_count_clauses method too
+    def remove_qualified_count(unparsed_sql)
+      @qualify_present = unparsed_sql.include?("qualified_results") || unparsed_sql.include?(" qualify ")
+      return unparsed_sql unless @qualify_present
+
+      unparsed_sql = unparsed_sql.gsub(/[\,\s]?qualified_results AS \( /, '')
+      unparsed_sql = unparsed_sql.gsub(") SELECT qualified_results.*, count(*) over () as _query_full_count FROM qualified_results", '')
+      unparsed_sql
+    end
+
     def insert_where_clauses
       return unless @where_clauses.length > 0
       begin_string = @parser.where_included? ? "and" : "where"
       filter_string = @where_clauses.join(" and ")
-      "  #{begin_string} #{filter_string}  "
       @sql.insert(@parser.insert_where_index, " #{begin_string} #{filter_string} ")
     end
 
+    def insert_qualify_clauses
+      return unless qualify_clause_applicable?
+
+      begin_string = @parser.qualify_included? ? "and" : "qualify"
+      filter_string = @qualify_clauses.join(" and ")
+      @sql.insert(@parser.insert_qualify_index, " #{begin_string} #{filter_string} ")
+    end
+
+    def qualify_clause_applicable?
+      @qualify_clauses.length > 0
+    end
+
     def insert_having_clauses
       return unless @having_clauses.length > 0
       begin_string = @parser.having_included? ? "and" : "having"

data/lib/query_helper/sql_parser.rb

@@ -48,6 +48,11 @@ class QueryHelper
       find_index(regex, position)
     end
 
+    def qualify_index(position=:start)
+      regex = / [Qq][Uu][Aa][Ll][Ii][Ff][Yy] /
+      find_index(regex, position)
+    end
+
     def group_by_index(position=:start)
       regex = / [Gg][Rr][Oo][Uu][Pp] [Bb][Yy] /
       find_index(regex, position)
@@ -80,6 +85,10 @@ class QueryHelper
       !where_index.nil?
     end
 
+    def qualify_included?
+      !qualify_index.nil?
+    end
+
     def group_by_included?
       !group_by_index.nil?
     end
@@ -108,6 +117,10 @@ class QueryHelper
       group_by_index() || order_by_index() || limit_index() || @sql.length
     end
 
+    def insert_qualify_index
+      order_by_index() || limit_index() || @sql.length
+    end
+
     def insert_having_index
       # raise InvalidQueryError.new("Cannot calculate insert_having_index because the query has no group by clause") unless group_by_included?
       order_by_index() || limit_index() || @sql.length
@@ -173,7 +186,7 @@ class QueryHelper
         ColumnMap.new(
           alias_name: sql_alias,
           sql_expression: sql_expression.squish,
-          aggregate: /(array_agg|avg|bit_and|bit_or|bool_and|bool_or|count|every|json_agg|jsonb_agg|json_object_agg|jsonb_object_agg|max|min|string_agg|sum|xmlagg)\((.*)\)/.match?(sql_expression)
+          aggregate: /(array_agg|avg|bit_and|bit_or|bool_and|bool_or|boolor_agg|booland_agg|count|every|json_agg|jsonb_agg|json_object_agg|jsonb_object_agg|max|min|string_agg|sum|xmlagg)\((.*)\)/.match?(sql_expression)
         ) if sql_alias
       end
       column_maps.compact

data/lib/query_helper/sql_sort.rb

@@ -3,17 +3,18 @@ require "query_helper/invalid_query_error"
 class QueryHelper
   class SqlSort
 
-    attr_accessor :column_maps, :select_strings, :sort_tiebreak
+    attr_accessor :column_maps, :select_strings, :sort_tiebreak, :column_sort_order
 
-    def initialize(sort_string: "", sort_tiebreak: "", column_maps: [])
+    def initialize(sort_string: "", sort_tiebreak: "", column_maps: [], column_sort_order: {})
       @sort_string = sort_string
       @column_maps = column_maps
       @sort_tiebreak = sort_tiebreak
+      @column_sort_order = column_sort_order
       @select_strings = []
     end
 
     def parse_sort_string
-      return [] if @sort_string.blank? && @sort_tiebreak.blank?
+      return [] if @sort_string.blank? && @sort_tiebreak.blank? && @column_sort_order.blank?
 
       return attributes_sql_expression(@sort_tiebreak) if @sort_string.blank?
 
@@ -25,38 +26,55 @@ class QueryHelper
 
     def attributes_sql_expression(sort_attribute)
       sql_strings = []
-      sorts = sort_attribute.split(",")
-      sorts.each_with_index do |sort, index|
-        sort_alias = sort.split(":")[0]
-        direction = sort.split(":")[1]
-        modifier = sort.split(":")[2]
-        begin
-          sql_expression = @column_maps.find{ |m| m.alias_name.casecmp?(sort_alias) }.sql_expression
-        rescue NoMethodError => e
-          raise InvalidQueryError.new("Sorting not allowed on column '#{sort_alias}'")
-        end
+      if sort_attribute.present?
+        sorts = sort_attribute.split(",")
+        sorts.each_with_index do |sort, index|
+          sort_alias = sort.split(":")[0]
+          direction = sort.split(":")[1]
+          modifier = sort.split(":")[2]
+          begin
+            sql_expression = @column_maps.find{ |m| m.alias_name.casecmp?(sort_alias) }.sql_expression
+          rescue NoMethodError => e
+            raise InvalidQueryError.new("Sorting not allowed on column '#{sort_alias}'")
+          end
 
-        if direction == "desc"
-          case ActiveRecord::Base.connection.adapter_name
-          when "SQLite" # SQLite is used in the test suite
-            direction = "desc"
+          if direction == "desc"
+            case ActiveRecord::Base.connection.adapter_name
+            when "SQLite" # SQLite is used in the test suite
+              direction = "desc"
+            else
+              direction = "desc nulls last"
+            end
           else
-            direction = "desc nulls last"
+            direction = "asc"
           end
-        else
-          direction = "asc"
-        end
 
-        case modifier
-        when "lowercase"
-          sql_expression = "lower(#{sql_expression})"
-          # When select distincts are used, the order by clause must be included in the select clause
-          @select_strings << sql_expression
-        end
+          case modifier
+          when "lowercase"
+            sql_expression = "lower(#{sql_expression})"
+            # When select distincts are used, the order by clause must be included in the select clause
+            @select_strings << sql_expression
+          end
 
-        sql_strings << "#{sql_expression} #{direction}"
+          sql_strings << "#{sql_expression} #{direction}"
+        end
       end
+      sql_strings << parse_custom_sort_string if @column_sort_order.present? && @column_sort_order[:sort_values].present?
       sql_strings
     end
+
+    # This method is used for sorting enum based column
+    def parse_custom_sort_string
+      sort_column = @column_sort_order[:column_name]
+      sort_values = @column_sort_order[:sort_values]
+      direction = @column_sort_order[:direction]
+
+      sql_expression = '(CASE'
+      sort_values.each_with_index do |value, index|
+          sql_expression << " WHEN #{sort_column}=#{value} THEN #{index}"
+      end
+      sql_expression << " END) #{direction}" 
+      sql_expression
+    end
   end
 end

data/lib/query_helper/version.rb

@@ -1,3 +1,3 @@
 class QueryHelper
-  VERSION = "0.2.21"
+  VERSION = "0.2.29"
 end

data/lib/query_helper.rb

@@ -67,6 +67,7 @@ class QueryHelper
     sql_filter: nil,
     sql_sort: nil,
     sort_tiebreak: nil,
+    column_sort_order: nil,
     page: nil,
     per_page: nil,
     search_string: nil,
@@ -85,6 +86,7 @@ class QueryHelper
     @sql_filter = sql_filter if sql_filter
     @sql_sort = sql_sort if sql_sort
     @sql_sort.sort_tiebreak = sort_tiebreak if sort_tiebreak
+    @sql_sort.column_sort_order = column_sort_order if column_sort_order
     @search_string = search_string if search_string
     @page = determine_page(page: page, per_page: per_page) if page
     @per_page = determine_per_page(page: page, per_page: per_page) if per_page
@@ -119,6 +121,7 @@ class QueryHelper
 
     having_clauses = @sql_filter.having_clauses
     where_clauses = @sql_filter.where_clauses
+    qualify_clauses = @sql_filter.qualify_clauses
 
     if @search_string
       search_filter = search_filter(column_maps)
@@ -138,6 +141,7 @@ class QueryHelper
       sql: @query,
       where_clauses: where_clauses,
       having_clauses: having_clauses,
+      qualify_clauses: qualify_clauses,
       order_by_clauses: @sql_sort.parse_sort_string,
       include_limit_clause: @page && @per_page ? true : false,
       additional_select_clauses:  @sql_sort.select_strings

data/query_helper.gemspec

@@ -35,11 +35,11 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.6.0"
 
   spec.add_development_dependency "bundler", "~> 2.2.27"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "sqlite3", "~> 1.3.6"
   spec.add_development_dependency "faker", "~> 1.9.3"
   spec.add_development_dependency "byebug"
   spec.add_development_dependency 'rspec-rails'
@@ -48,4 +48,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "activerecord", "> 5"
   spec.add_dependency "activesupport", "> 5"
+  spec.add_dependency "sqlite3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: query_helper
 version: !ruby/object:Gem::Version
-  version: 0.2.21
+  version: 0.2.29
 platform: ruby
 authors:
 - Evan McDaniel
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-23 00:00:00.000000000 Z
+date: 2022-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.6
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +150,20 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '5'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: Ruby gem developed to help with pagination, filtering, sorting, and including
   associations on both active record queries and custom sql queries
 email:
@@ -172,9 +172,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -207,14 +207,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Ruby Gem to help with pagination and data formatting at Pattern, Inc.

data/.travis.yml

@@ -1,7 +0,0 @@
-sudo: false
-dist: xenial
-language: ruby
-cache: bundler
-rvm:
-  - 2.4.5
-before_install: gem install bundler -v 1.16.6