pattern_query_helper 0.2.7 → 0.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c3503df41d4640984dac6772f15d439c23b8fd3904514d58fb98b2af7efbc45
-  data.tar.gz: d40370dd2f2e9c2da4b0993a7ac21d08dbc512b76bd2da031ff1e3ce56605507
+  metadata.gz: 110f333cc3a7f82ece7bce90a4eb59d0084d57a90259f17594ae46ef63279d45
+  data.tar.gz: ef87d0577d5f011a4a491bec04b892a33bc1ced8df47dd801a2bc4aea3cb9f5d
 SHA512:
-  metadata.gz: 30a723aca45d1ceb20f914826367ca92bfc6381ebe621d823163c0cc3eb6615b4398dc1e4147f4dad4b40b41c8c71bb52191ab8909d384b6ff345caf1982f224
-  data.tar.gz: 8c8c2855b31e831ed3b22c6c1f2709e15f2ee332515becf48e8a31637a82cf1ded7712155444d89e740bde76a0f62f53a765e61b4686930870507c755e63e8a7
+  metadata.gz: 5f934ef37549782fb366945f0e3aee027902927d53d1de11c77398bc8aef4cffa1f7f99ff4ac64cde752716e7e466f157f860c3a5d70a384910108850e4691cf
+  data.tar.gz: 3ba6c72d6d6d44b25d2384eb8b9db304436b3f93e265be9f44920529a84e0d58c18c72d37610c930e7353877a26b023c4b75b8fa53204118451af50188de8ec8

data/.travis.yml

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

data/Gemfile

@@ -4,3 +4,5 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in pattern_query_helper.gemspec
 gemspec
+
+gem 'sqlite3', '~> 1.4'

data/Gemfile.lock

@@ -1,37 +1,36 @@
 PATH
   remote: .
   specs:
-    pattern_query_helper (0.2.6)
-      activerecord (~> 5.0)
+    pattern_query_helper (0.2.11)
+      activerecord (>= 5.0)
       kaminari (~> 1.1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionview (5.2.3)
-      activesupport (= 5.2.3)
+    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.0, >= 1.0.3)
-    activemodel (5.2.3)
-      activesupport (= 5.2.3)
-    activerecord (5.2.3)
-      activemodel (= 5.2.3)
-      activesupport (= 5.2.3)
-      arel (>= 9.0)
-    activesupport (5.2.3)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    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)
-    arel (9.0.0)
-    builder (3.2.3)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    builder (3.2.4)
     byebug (11.0.1)
     concurrent-ruby (1.1.4)
-    crass (1.0.4)
+    crass (1.0.6)
     diff-lcs (1.3)
-    erubi (1.8.0)
+    erubi (1.10.0)
     faker (1.9.3)
       i18n (>= 0.7)
     i18n (1.6.0)
@@ -48,18 +47,18 @@ GEM
       activerecord
       kaminari-core (= 1.1.1)
     kaminari-core (1.1.1)
-    loofah (2.2.3)
+    loofah (2.12.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    mini_portile2 (2.4.0)
-    minitest (5.11.3)
-    nokogiri (1.10.3)
-      mini_portile2 (~> 2.4.0)
+    minitest (5.14.4)
+    nokogiri (1.12.3-x86_64-darwin)
+      racc (~> 1.4)
+    racc (1.5.2)
     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)
+    rails-html-sanitizer (1.4.1)
+      loofah (~> 2.3)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -74,10 +73,10 @@ GEM
       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)
+    sqlite3 (1.4.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -89,7 +88,7 @@ DEPENDENCIES
   pattern_query_helper!
   rake (~> 10.0)
   rspec (~> 3.0)
-  sqlite3 (~> 1.3.6)
+  sqlite3 (~> 1.4)
 
 BUNDLED WITH
    1.17.3

data/lib/pattern_query_helper/filtering.rb

@@ -1,13 +1,16 @@
 module PatternQueryHelper
   class Filtering
-    def self.create_filters(filters, valid_columns=nil, symbol_prefix="")
+    def self.create_filters(filters:, valid_columns_map: nil, symbol_prefix: "", include_where: true)
       filters ||= {}
-      filter_string = "true = true"
+      all_conditions = []
       filter_params = {}
       filter_array = []
       filters.each do |filter_attribute, criteria|
-        if valid_columns
-          raise ArgumentError.new("Invalid filter '#{filter_attribute}'") unless valid_columns.include? filter_attribute
+        if valid_columns_map
+          raise ArgumentError.new("Invalid filter '#{filter_attribute}'") unless valid_columns_map[filter_attribute]
+          filter_column = valid_columns_map[filter_attribute]
+        else
+          filter_column = filter_attribute
         end
         criteria.each do |operator_code, criterion|
           filter_symbol = "#{symbol_prefix}#{filter_attribute}_#{operator_code}"
@@ -25,22 +28,22 @@ module PatternQueryHelper
             when "noteql"
               operator = "!="
             when "like"
-              modified_filter_attribute = "lower(#{filter_attribute})"
+              modified_filter_column = "lower(#{filter_column})"
               operator = "like"
               criterion.downcase!
             when "in"
               operator = "in (:#{filter_symbol})"
-              # if criterion are anything but numbers, downcase the filter_attribute
+              # if criterion are anything but numbers, downcase the filter_column
               if criterion.scan(/[^\d|,|\s]/).any?
-                modified_filter_attribute = "lower(#{filter_attribute})"
+                modified_filter_column = "lower(#{filter_column})"
               end
               criterion = criterion.downcase.split(",")
               filter_symbol_already_embedded = true
             when "notin"
               operator = "not in (:#{filter_symbol})"
-              # if criterion are anything but numbers, downcase the filter_attribute
+              # if criterion are anything but numbers, downcase the filter_column
               if criterion.scan(/[^\d|,|\s]/).any?
-                modified_filter_attribute = "lower(#{filter_attribute})"
+                modified_filter_column = "lower(#{filter_column})"
               end
               criterion = criterion.downcase.split(",")
               filter_symbol_already_embedded = true
@@ -50,9 +53,10 @@ module PatternQueryHelper
             else
               raise ArgumentError.new("Invalid operator code '#{operator_code}' on '#{filter_attribute}' filter")
           end
-          filter_column = modified_filter_attribute || filter_attribute
-          filter_string = "#{filter_string} and #{filter_column} #{operator}"
-          filter_string << " :#{filter_symbol}" unless filter_symbol_already_embedded or filter_symbol.blank?
+          filter_column = modified_filter_column || filter_column
+          condition = "#{filter_column} #{operator}"
+          condition << " :#{filter_symbol}" unless filter_symbol_already_embedded or filter_symbol.blank?
+          all_conditions << condition
           filter_params["#{filter_symbol}"] = criterion unless filter_symbol.blank?
           filter_array << {
             column: filter_attribute,
@@ -63,6 +67,12 @@ module PatternQueryHelper
         end
       end
 
+      if include_where
+        filter_string = "where " + all_conditions.join("\n and ") unless all_conditions.empty?
+      else
+        filter_string = all_conditions.empty? ? "1 = 1" : all_conditions.join("\n and ")
+      end
+
       {
         filter_string: filter_string,
         filter_params: filter_params,

data/lib/pattern_query_helper/sql.rb

@@ -1,14 +1,12 @@
 module PatternQueryHelper
   class Sql
+    QUERY_COUNT_COLUMN = "_query_full_count".freeze
     def self.sql_query(config)
       model = config[:model]
-      query = config[:query]
       query_params = config[:query_params] || {}
       page = config[:page]
       per_page = config[:per_page]
-      filter_string = config[:filter_string]
       filter_params = config[:filter_params] || {}
-      sort_string = config[:sort_string]
 
       if page && per_page
         query_params[:limit] = per_page
@@ -16,46 +14,44 @@ module PatternQueryHelper
         limit = "limit :limit offset :offset"
       end
 
+      full_count_join = "cross join (select count(*) as #{QUERY_COUNT_COLUMN} from filtered_query) as filtered_query_count" if page || per_page
       query_params = query_params.merge(filter_params).symbolize_keys
-      sort_string = "order by #{sort_string}" if !sort_string.blank?
-      filter_string = "where #{filter_string}" if !filter_string.blank?
 
       sql = %(
-          with query as (#{query})
-          select *
-          from query
-          #{filter_string}
-          #{sort_string}
-          #{limit}
-        )
+        with filtered_query as (#{filtered_query(config)})
+        select *
+        from filtered_query
+        #{full_count_join}
+        #{limit}
+      )
 
       model.find_by_sql([sql, query_params])
     end
 
-    def self.sql_query_count(config)
-      model = config[:model]
+    def self.sql_query_count(sql_query_results)
+      sql_query_results.empty? ? 0 : sql_query_results.first[QUERY_COUNT_COLUMN]
+    end
+
+    def self.single_record_query(config)
+      results = sql_query(config)
+      results.first
+    end
+
+    private
+
+    def self.filtered_query(config)
       query = config[:query]
-      query_params = config[:query_params] || {}
       filter_string = config[:filter_string]
-      filter_params = config[:filter_params] || {}
-
-      query_params = query_params.merge(filter_params).symbolize_keys
-      filter_string = "where #{filter_string}" if !filter_string.blank?
+      sort_string = config[:sort_string]
+      sort_string = "order by #{sort_string}" if !sort_string.blank?
 
-      count_sql = %(
+      sql = %(
           with query as (#{query})
-          select count(*) as count
+          select *
           from query
           #{filter_string}
+          #{sort_string}
         )
-
-      model.find_by_sql([count_sql, query_params]).first["count"]
-    end
-
-    def self.single_record_query(config)
-      results = sql_query(config)
-      results.first
     end
-
   end
 end

data/lib/pattern_query_helper/version.rb

@@ -1,3 +1,3 @@
 module PatternQueryHelper
-  VERSION = "0.2.7"
+  VERSION = "0.2.11"
 end

data/lib/pattern_query_helper.rb

@@ -39,7 +39,8 @@ module PatternQueryHelper
 
     data = PatternQueryHelper::Sql.sql_query(query_config)
     data = PatternQueryHelper::Associations.load_associations(data, query_helpers[:associations], query_helpers[:as_json])
-    count = PatternQueryHelper::Sql.sql_query_count(query_config)
+    count = PatternQueryHelper::Sql.sql_query_count(data)
+    data.map! { |d| d.except(PatternQueryHelper::Sql::QUERY_COUNT_COLUMN) } if query_config[:page] or query_config[:per_page]
     pagination = PatternQueryHelper::Pagination.create_pagination_payload(count, query_helpers[:pagination])
 
     {
@@ -89,7 +90,11 @@ module PatternQueryHelper
   end
 
   def self.parse_helpers(query_helpers, valid_columns)
-    filtering = PatternQueryHelper::Filtering.create_filters(query_helpers[:filter], valid_columns)
+    valid_columns_map = {}
+    valid_columns.each do |c|
+      valid_columns_map["#{c}"] = c
+    end
+    filtering = PatternQueryHelper::Filtering.create_filters(filters: query_helpers[:filter], valid_columns_map: valid_columns_map)
     sorting = PatternQueryHelper::Sorting.parse_sorting_params(query_helpers[:sort], valid_columns)
     associations = PatternQueryHelper::Associations.process_association_params(query_helpers[:include])
     pagination = PatternQueryHelper::Pagination.parse_pagination_params(query_helpers[:page], query_helpers[:per_page])

data/pattern_query_helper.gemspec

@@ -43,6 +43,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "faker", "~> 1.9.3"
   spec.add_development_dependency "byebug"
 
-  spec.add_dependency "activerecord", "~> 5.0"
+  spec.add_dependency "activerecord", ">= 5.0"
   spec.add_dependency "kaminari", "~> 1.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pattern_query_helper
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.11
 platform: ruby
 authors:
 - Evan McDaniel
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-05-17 00:00:00.000000000 Z
+date: 2021-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,14 +98,14 @@ dependencies:
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
@@ -153,7 +153,7 @@ homepage: https://github.com/iserve-products/pattern_query_helper
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -168,9 +168,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Ruby Gem to help with pagination and data formatting at Pattern, Inc.
 test_files: []