query_helper 0.2.17 → 0.2.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 761535bdbebea924ac3d4ab1ed900f50a047f2e79ed5c2121b5f0eecf0327388
-  data.tar.gz: bb55e4554e416e2729d35c2fc1091d65726bde73fc1db93e192baf1275237bb0
+  metadata.gz: b7fa1887aad7e034e96bc261c6683e21b8eda27b21d7039986dd03d72c837a83
+  data.tar.gz: 292df8c5f4cd2bacc4790cc5d4afc1c88815c5bf605edaae74c34a52cdef2e51
 SHA512:
-  metadata.gz: 0ba6ddb3222dba240810b0df6e1bc1025a2510d4b00c06430fc91c8786dbacc3d06df83f7986766a1d0755988550fdc44396fa1357c7c1cd2accc54edc904345
-  data.tar.gz: 33c4194f5bd8da5abdf8e7f2e78f0fcd9d84e5184c89ac3e926b8435e2a125f8b0f4428532fbfe24f6288e20f4c8520731c88720f2261788738f16048d8f0a49
+  metadata.gz: d4ad632451fb4798096381a2d9698d77ecffa01e38868f0b7d7eac1423918d6ad5917748090ac426571e2cd2f230a74b9a7659ed4a609325562d2cd2fe379e1d
+  data.tar.gz: f40530e5d23c849f077b217747b4ec71e0bba1f90de740a0e2363a1a249669f8a52d0be3c693d0bca80748315d5ad7a75c7066e3bfdeea1ad605e41e5b44580d

data/Gemfile.lock

@@ -1,97 +1,98 @@
 PATH
   remote: .
   specs:
-    query_helper (0.2.17)
+    query_helper (0.2.21)
       activerecord (> 5)
       activesupport (> 5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.0.3.2)
-      actionview (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
-      rack (~> 2.0, >= 2.0.8)
+    actionpack (6.1.4.1)
+      actionview (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.3.2)
-      activesupport (= 6.0.3.2)
+    actionview (6.1.4.1)
+      activesupport (= 6.1.4.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activemodel (6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activerecord (6.0.3.2)
-      activemodel (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activesupport (6.0.3.2)
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activerecord (6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     builder (3.2.4)
     byebug (11.1.3)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.9)
     crass (1.0.6)
     diff-lcs (1.4.4)
-    erubi (1.9.0)
+    erubi (1.10.0)
     faker (1.9.6)
       i18n (>= 0.7)
-    i18n (1.8.5)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    loofah (2.6.0)
+    loofah (2.12.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
-    mini_portile2 (2.4.0)
-    minitest (5.14.1)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
+    mini_portile2 (2.6.1)
+    minitest (5.14.4)
+    nokogiri (1.12.4)
+      mini_portile2 (~> 2.6.1)
+      racc (~> 1.4)
+    racc (1.5.2)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
-    railties (6.0.3.2)
-      actionpack (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
+    railties (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       method_source
-      rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
-    rake (13.0.1)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+      rake (>= 0.13)
+      thor (~> 1.0)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-rails (4.0.1)
-      actionpack (>= 4.2)
-      activesupport (>= 4.2)
-      railties (>= 4.2)
-      rspec-core (~> 3.9)
-      rspec-expectations (~> 3.9)
-      rspec-mocks (~> 3.9)
-      rspec-support (~> 3.9)
-    rspec-support (3.9.3)
+      rspec-support (~> 3.10.0)
+    rspec-rails (5.0.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.10.2)
     sqlite3 (1.3.13)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    zeitwerk (2.4.0)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -99,7 +100,7 @@ PLATFORMS
 DEPENDENCIES
   actionpack
   activesupport
-  bundler (~> 1.17)
+  bundler (~> 2.2.27)
   byebug
   faker (~> 1.9.3)
   query_helper!
@@ -109,4 +110,4 @@ DEPENDENCIES
   sqlite3 (~> 1.3.6)
 
 BUNDLED WITH
-   1.17.3
+   2.2.27

data/lib/query_helper/column_map.rb

@@ -13,7 +13,7 @@ class QueryHelper
 
       model.attribute_names.each do |attribute|
         if maps.select{|x| x.alias_name == attribute}.empty?
-          maps << ColumnMap.new(alias_name: attribute, sql_expression: "#{model.to_s.underscore.pluralize}.#{attribute}")
+          maps << ColumnMap.new(alias_name: attribute, sql_expression: "#{model.table_name.pluralize}.#{attribute}")
         end
       end
 

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])
+        QueryHelper::SqlSort.new(sort_string: params[:sort], sort_tiebreak: params[:sort_tiebreak])
       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]
+        helpers[:sql_sort] = create_query_helper_sort() if params[:sort] || params[:sort_tiebreak]
         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_sort.rb

@@ -3,24 +3,35 @@ require "query_helper/invalid_query_error"
 class QueryHelper
   class SqlSort
 
-    attr_accessor :column_maps, :select_strings
+    attr_accessor :column_maps, :select_strings, :sort_tiebreak
 
-    def initialize(sort_string: "", column_maps: [])
+    def initialize(sort_string: "", sort_tiebreak: "", column_maps: [])
       @sort_string = sort_string
       @column_maps = column_maps
+      @sort_tiebreak = sort_tiebreak
       @select_strings = []
     end
 
     def parse_sort_string
+      return [] if @sort_string.blank? && @sort_tiebreak.blank?
+
+      return attributes_sql_expression(@sort_tiebreak) if @sort_string.blank?
+
+      sql_strings = attributes_sql_expression(@sort_string)
+      return sql_strings if @sort_tiebreak.blank?
+
+      sql_strings + attributes_sql_expression(@sort_tiebreak)
+    end
+
+    def attributes_sql_expression(sort_attribute)
       sql_strings = []
-      sorts = @sort_string.split(",")
+      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 == sort_alias }.sql_expression
+          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
@@ -45,8 +56,7 @@ class QueryHelper
 
         sql_strings << "#{sql_expression} #{direction}"
       end
-
-      return sql_strings
+      sql_strings
     end
   end
 end

data/lib/query_helper/version.rb

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

data/lib/query_helper.rb

@@ -66,6 +66,7 @@ class QueryHelper
     search_fields: nil,
     sql_filter: nil,
     sql_sort: nil,
+    sort_tiebreak: nil,
     page: nil,
     per_page: nil,
     search_string: nil,
@@ -80,13 +81,14 @@ class QueryHelper
     @as_json_options = as_json_options if as_json_options
     @custom_mappings = custom_mappings if custom_mappings
     @preload = preload if preload
-    @search_fields = search_fields if search_fields 
-    @sql_filter = sql_filter if sql_filter 
-    @sql_sort = sql_sort if sql_sort 
-    @search_string = search_string if search_string 
+    @search_fields = search_fields if search_fields
+    @sql_filter = sql_filter if sql_filter
+    @sql_sort = sql_sort if sql_sort
+    @sql_sort.sort_tiebreak = sort_tiebreak if sort_tiebreak
+    @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
-    @metadata = metadata if metadata 
+    @metadata = metadata if metadata
     set_limit_and_offset()
     return self
   end
@@ -116,21 +118,21 @@ class QueryHelper
     @sql_filter.create_filters()
 
     having_clauses = @sql_filter.having_clauses
-    where_clauses = @sql_filter.where_clauses 
-    
+    where_clauses = @sql_filter.where_clauses
+
     if @search_string
       search_filter = search_filter(column_maps)
       if search_filter[:placement] == :where
         where_clauses << search_filter[:filter]
-      else 
+      else
         having_clauses << search_filter[:filter]
       end
-    end 
+    end
 
 
     # merge the filter bind variables into the query bind variables
     @bind_variables.merge!(@sql_filter.bind_variables)
-    
+
     # Execute Sql Query
     manipulator = SqlManipulator.new(
       sql: @query,
@@ -152,7 +154,7 @@ class QueryHelper
     return query if @bind_variables.length == 0
     begin
       return @model.sanitize_sql_array([query, @bind_variables])
-    rescue NoMethodError 
+    rescue NoMethodError
       # sanitize_sql_array is a protected method before Rails v5.2.3
       return @model.send(:sanitize_sql_array, [query, @bind_variables])
     end
@@ -181,10 +183,10 @@ class QueryHelper
 
   def pagination_results(count=@count)
     # Set pagination params if they aren't provided
-    results_per_page = @per_page || count 
-    results_page = @page || 1 
+    results_per_page = @per_page || count
+    results_page = @page || 1
 
-    total_pages = (count/(results_per_page.nonzero? || 1).to_f).ceil
+    total_pages = (count.to_i/(results_per_page.nonzero? || 1).to_f).ceil
     next_page = results_page + 1 if results_page.between?(1, total_pages - 1)
     previous_page = results_page - 1 if results_page.between?(2, total_pages)
     first_page = results_page == 1
@@ -205,16 +207,16 @@ class QueryHelper
   private
 
     def determine_page(page:, per_page:)
-      return page.to_i if page 
-      return 1 if !page && per_page 
+      return page.to_i if page
+      return 1 if !page && per_page
       return nil
-    end 
+    end
 
     def determine_per_page(page:, per_page:)
-      return per_page.to_i if per_page 
-      return 100 if !per_page && page 
+      return per_page.to_i if per_page
+      return 100 if !per_page && page
       return nil
-    end 
+    end
 
     def set_limit_and_offset
       if @page && @per_page
@@ -226,7 +228,7 @@ class QueryHelper
         @bind_variables[:limit] = limit
         @bind_variables[:offset] = offset
       end
-    end 
+    end
 
     def paginated_results
       { pagination: pagination_results(),
@@ -273,16 +275,16 @@ class QueryHelper
     def search_filter(column_maps)
       raise ArgumentError.new("search_fields not defined") unless @search_fields.length > 0
       placement = :where
-      maps = column_maps.select do |cm| 
+      maps = column_maps.select do |cm|
         placement = :having if cm.aggregate
         @search_fields.include? cm.alias_name
-      end 
+      end
       bind_variable = ('a'..'z').to_a.shuffle[0,20].join.to_sym
       @bind_variables[bind_variable] = "%#{@search_string}%"
-      filter = "#{maps.map{|m| "#{m.sql_expression}::varchar"}.join(" || ")} ilike :#{bind_variable}"
+      filter = "#{maps.map{|m| "coalesce(#{m.sql_expression}::varchar, '')"}.join(" || ")} ilike :#{bind_variable}"
       return {
         filter: filter,
         placement: placement
       }
-    end 
+    end
 end

data/query_helper.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.17"
+  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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: query_helper
 version: !ruby/object:Gem::Version
-  version: 0.2.17
+  version: 0.2.21
 platform: ruby
 authors:
 - Evan McDaniel
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-28 00:00:00.000000000 Z
+date: 2021-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.2.27
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.2.27
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -199,7 +199,7 @@ homepage: https://github.com/iserve-products/query_helper
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -215,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Ruby Gem to help with pagination and data formatting at Pattern, Inc.
 test_files: []