query_helper 0.2.21 → 0.2.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7fa1887aad7e034e96bc261c6683e21b8eda27b21d7039986dd03d72c837a83
-  data.tar.gz: 292df8c5f4cd2bacc4790cc5d4afc1c88815c5bf605edaae74c34a52cdef2e51
+  metadata.gz: b424d779be28de32e24c3ec31668d775915e0053ddc7099691b51f48ecb1edf4
+  data.tar.gz: 43c360e9e47dd3b5b410632f91e58ded247c9ab20848d43eea510ce4c1ba3665
 SHA512:
-  metadata.gz: d4ad632451fb4798096381a2d9698d77ecffa01e38868f0b7d7eac1423918d6ad5917748090ac426571e2cd2f230a74b9a7659ed4a609325562d2cd2fe379e1d
-  data.tar.gz: f40530e5d23c849f077b217747b4ec71e0bba1f90de740a0e2363a1a249669f8a52d0be3c693d0bca80748315d5ad7a75c7066e3bfdeea1ad605e41e5b44580d
+  metadata.gz: 8cd9187f8a136f15b5ab1f27cd5ba184531f1976a91a7f72149f1b4e1efb3ba8627ed4a8083a6e71420f45d3bf7c58ffdd05099e4cedc43d94ebbb0875b6fe5d
+  data.tar.gz: 4beaf1b6c5dffecfe84bf1e7a7caf174c29defe585e3cd6cf195c2b39e045f1fd6900d1e40119c8e6a61f997a6fb7b80c8c126d18d4f45705ec4ade868237e52

data/.github/actions/publish_rubygems.yml

@@ -0,0 +1,20 @@
+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

data/.gitignore

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    query_helper (0.2.21)
+    query_helper (0.2.26)
       activerecord (> 5)
       activesupport (> 5)
 

data/README.md

@@ -1,5 +1,4 @@
 # 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)
 
 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 +87,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 +346,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/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_parser.rb

@@ -173,7 +173,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,57 @@ 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
       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]
+
+      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.26"
 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

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       = ["Evan McDaniel"]
-  spec.email         = ["eamigo13@gmail.com"]
+  spec.authors       = ["Patterninc"]
+  spec.email         = ["tech@pattern.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/iserve-products/query_helper"
+  spec.homepage      = "https://github.com/patterninc/query_helper"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: query_helper
 version: !ruby/object:Gem::Version
-  version: 0.2.21
+  version: 0.2.26
 platform: ruby
 authors:
-- Evan McDaniel
+- Patterninc
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-23 00:00:00.000000000 Z
+date: 2022-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -167,14 +167,14 @@ dependencies:
 description: Ruby gem developed to help with pagination, filtering, sorting, and including
   associations on both active record queries and custom sql queries
 email:
-- eamigo13@gmail.com
+- tech@pattern.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/actions/publish_rubygems.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -195,7 +195,7 @@ files:
 - lib/query_helper/sql_sort.rb
 - lib/query_helper/version.rb
 - query_helper.gemspec
-homepage: https://github.com/iserve-products/query_helper
+homepage: https://github.com/patterninc/query_helper
 licenses:
 - MIT
 metadata: {}
@@ -214,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.26
 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