query_helper 0.2.26 → 0.2.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b424d779be28de32e24c3ec31668d775915e0053ddc7099691b51f48ecb1edf4
-  data.tar.gz: 43c360e9e47dd3b5b410632f91e58ded247c9ab20848d43eea510ce4c1ba3665
+  metadata.gz: c635a27696eb10b152787a3b66132760bf79e3b2e695037bf6dcc2b06b39e9b9
+  data.tar.gz: bfc80f15f647d447a6115423308368c39a2f034938731eb94f91d23a7f4c1f53
 SHA512:
-  metadata.gz: 8cd9187f8a136f15b5ab1f27cd5ba184531f1976a91a7f72149f1b4e1efb3ba8627ed4a8083a6e71420f45d3bf7c58ffdd05099e4cedc43d94ebbb0875b6fe5d
-  data.tar.gz: 4beaf1b6c5dffecfe84bf1e7a7caf174c29defe585e3cd6cf195c2b39e045f1fd6900d1e40119c8e6a61f997a6fb7b80c8c126d18d4f45705ec4ade868237e52
+  metadata.gz: d61105466f4cadc1b111ed38afd7e764c3d3fde76fb4db786029654516fb893df43ccf02e2b6f07693dd118ceabbc15ffa9281b2c1c7dbc388091a4f65b9e300
+  data.tar.gz: b3c6b12c6594e1a3f068ce0d1de484f3e49bc53e1da5c99c6b7c68b27fc9c1f90e334e653b711281f0d93334a2ee95dc666d1d620a17de67ca378117e3e4c806

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/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.26)
+    query_helper (0.2.28)
       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,5 +1,6 @@
 # QueryHelper
 [![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.  
 

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/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_where_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

data/lib/query_helper/sql_sort.rb

@@ -59,14 +59,12 @@ class QueryHelper
           sql_strings << "#{sql_expression} #{direction}"
         end
       end
-      sql_strings << parse_custom_sort_string
+      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
-      return '' if @column_sort_order.blank? || @column_sort_order[:sort_values].blank?
-
       sort_column = @column_sort_order[:column_name]
       sort_values = @column_sort_order[:sort_values]
       direction = @column_sort_order[:direction]

data/lib/query_helper/version.rb

@@ -1,3 +1,3 @@
 class QueryHelper
-  VERSION = "0.2.26"
+  VERSION = "0.2.28"
 end

data/lib/query_helper.rb

@@ -121,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)
@@ -140,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

@@ -6,12 +6,12 @@ require "query_helper/version"
 Gem::Specification.new do |spec|
   spec.name          = "query_helper"
   spec.version       = QueryHelper::VERSION
-  spec.authors       = ["Patterninc"]
-  spec.email         = ["tech@pattern.com"]
+  spec.authors       = ["Evan McDaniel"]
+  spec.email         = ["eamigo13@gmail.com"]
 
   spec.summary       = %q{Ruby Gem to help with pagination and data formatting at Pattern, Inc.}
   spec.description   = %q{Ruby gem developed to help with pagination, filtering, sorting, and including associations on both active record queries and custom sql queries}
-  spec.homepage      = "https://github.com/patterninc/query_helper"
+  spec.homepage      = "https://github.com/iserve-products/query_helper"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
@@ -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.26
+  version: 0.2.28
 platform: ruby
 authors:
-- Patterninc
+- Evan McDaniel
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-15 00:00:00.000000000 Z
+date: 2022-04-05 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,15 +150,29 @@ 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:
-- tech@pattern.com
+- eamigo13@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/actions/publish_rubygems.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - CODE_OF_CONDUCT.md
@@ -195,7 +195,7 @@ files:
 - lib/query_helper/sql_sort.rb
 - lib/query_helper/version.rb
 - query_helper.gemspec
-homepage: https://github.com/patterninc/query_helper
+homepage: https://github.com/iserve-products/query_helper
 licenses:
 - MIT
 metadata: {}
@@ -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.2.26
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Ruby Gem to help with pagination and data formatting at Pattern, Inc.

data/.github/actions/publish_rubygems.yml

@@ -1,20 +0,0 @@
-name: Publish Gem
-
-on:
-  push:
-    tags:
-      - v*
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v1
-
-      - name: Release Gem
-        if: contains(github.ref, 'refs/tags/v')
-        uses: cadwallion/publish-rubygems-action@master
-        env:
-          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
-          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
-          RELEASE_COMMAND: rake release