active_record_query_fixer 0.0.7 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65c48f74a79cfa27fcc9c02cf33eba5dde33ce47d86e395ecb354d6819ae8943
-  data.tar.gz: 5bbb57d47062a495de2b1c337551f7b82063ae569094ab5e0b538974b6c1b581
+  metadata.gz: e42bc2e925978449204db3564990728f9d82b66da3c977f74cadaf502095e1a8
+  data.tar.gz: 749e0f1224b32818616e91487cd93ec9ef0cd47ed3cb716be41f8748ac777289
 SHA512:
-  metadata.gz: 0cc9451b46d0a9df30beb5c5135c733bd3df30fd0c6758c033764d74e52052b9644b7c1fc3eadfdfeb5a8c3d01acd31ecb4379882d17ae423761574da6fef3fd
-  data.tar.gz: 2a8d48a3d80ad51d45fe2a7ff501337200e41ea2665078dc8cc380ac585941778919a861d48e4db2a5d57181734ea4f51aa270692cbcfd7c22dbb9db228ef83f
+  metadata.gz: 9bda979fc9bade5a2d07435866be6290eeeb20d876462de6a598e070c9d2ec636251b7bfc190a4491c5fdcd6a994a7e9a8e6362a38ba44458c0a3a7a895edb7f
+  data.tar.gz: 542b47e254a9001b151c534ce251df809d0be23867fd42f6146af6d1b1e5ae25db63a045a175a39420abd1bb2f36957d2cc160d1132066f0a4064aca05f436c2

data/lib/active_record_query_fixer.rb

@@ -1,3 +1,6 @@
+require "dig_bang"
+require "pg_query"
+
 class ActiveRecordQueryFixer
   autoload :RelationExtentions, "#{__dir__}/active_record_query_fixer/relation_extentions"
 
@@ -16,70 +19,134 @@ class ActiveRecordQueryFixer
     fix_reference_group if fix_reference_group?
     fix_order_group if fix_order_group?
     fix_order_select_distinct if fix_order_select_distinct?
+    fix_select_group if query.values[:select] && query.values[:group]
+
+    self
+  end
+
+  def fix_select_group
+    select_targets.each do |select_target|
+      fields = select_target.dig!("ResTarget", "val").dig("ColumnRef", "fields")
+      next if !fields || fields.length != 2
+
+      table = fields[0].dig("String", "str")
+      column = fields[1].dig("String", "str")
+
+      if column
+        # A table and a column has been selected - make sure to group by that
+        @query = query.group("#{table}.#{column}")
+      elsif fields[1].key?("A_Star")
+        # A table and a star has been selected - assume the primary key is called "id" and group by that
+        @query = query.group("#{table}.id")
+      end
+    end
+
     self
   end
 
   def fix_order_group
-    @query = @query.group(@query.model.arel_table[@query.model.primary_key])
+    @query = query.group(query.model.arel_table[query.model.primary_key])
+
+    sort_targets.each do |sort_target|
+      fields = sort_target.dig("SortBy", "node", "ColumnRef", "fields")
+      next if !fields || fields.length != 2
 
-    @query.values[:order]&.each do |order|
-      @query = @query.group(extract_table_and_column_from_expression(order)) if group_by_order?(order)
+      table = fields.dig(0, "String", "str")
+      column = fields.dig(1, "String", "str")
+
+      @query = query.group("#{table}.#{column}") if table && column
     end
 
     self
   end
 
   def fix_order_select_distinct
-    changed = false
-    @query.values[:order]&.each do |order|
-      @query = @query.select("#{extract_table_and_column_from_expression(order)} AS active_record_query_fixer_#{@count_select}")
-      changed = true
+    select_appends = []
+
+    sort_targets.each do |sort_target|
+      fields = sort_target.dig("SortBy", "node", "ColumnRef", "fields")
+      next if !fields || fields.length != 2
+
+      table = fields.dig(0, "String", "str")
+      column = fields.dig(1, "String", "str")
+
+      next if !table || !column
+
+      select_appends << "#{table}.#{column} AS active_record_query_fixer_#{@count_select}"
       @count_select += 1
     end
 
-    @query = @query.select("#{@query.table_name}.*") if changed
+    # Start by prepending a wild-card select before doing the fix-selects to avoid any issues with `DISTINCT COUNT`
+    prepend_table_wildcard if !table_wildcard_prepended? && select_appends.any? && query.values[:select].blank?
+
+    select_appends.each do |select_append|
+      @query = query.select(select_append)
+    end
+
     self
   end
 
   def fix_reference_group
-    @query = @query.group(@query.model.arel_table[@query.model.primary_key])
+    @query = query.group(query.model.arel_table[query.model.primary_key])
 
-    @query.values[:references].each do |reference|
-      @query = @query.group("#{reference}.id")
+    query.values[:references].each do |reference|
+      @query = query.group("#{reference}.id")
     end
+
+    self
   end
 
 private
 
-  def extract_table_and_column_from_expression(order)
-    if order.is_a?(Arel::Nodes::Ascending) || order.is_a?(Arel::Nodes::Descending)
-      if order.expr.relation.respond_to?(:right)
-        "#{order.expr.relation.right}.#{order.expr.name}"
-      else
-        "#{order.expr.relation.table_name}.#{order.expr.name}"
-      end
-    elsif order.is_a?(String)
-      order
-    else
-      raise "Couldn't extract table and column from: #{order}"
-    end
-  end
-
   def fix_order_group?
-    @query.values[:joins].blank? && @query.values[:distinct].present? ||
-      @query.values[:group].present? && @query.values[:order].present?
+    query.values[:joins].blank? && query.values[:distinct].present? && query.values[:order].present? ||
+      query.values[:group].present? && query.values[:order].present?
   end
 
   def fix_order_select_distinct?
-    @query.values[:distinct].present? && @query.values[:order].present?
+    query.values[:distinct].present? && query.values[:order].present?
   end
 
   def fix_reference_group?
-    @query.values[:references].present? && @query.values[:group].present?
+    query.values[:references].present? && query.values[:group].present?
+  end
+
+  def parsed_query
+    @parsed_query ||= PgQuery.parse(query.to_sql)
+  end
+
+  # Prepends 'table_name.*' to the query. It needs to be pre-pended in case a `COUNT` or another aggregate function has been added to work with `DISTINCT`.
+  def prepend_table_wildcard
+    old_select = query.values[:select]&.clone || []
+    old_select = old_select.keep_if { |select_statement| select_statement != select_table_wildcard_sql }
+
+    @query = query.except(:select).select(select_table_wildcard_sql)
+
+    old_select.each do |select_statement|
+      @query = query.select(select_statement)
+    end
+  end
+
+  def select_table_wildcard_sql
+    @select_table_wildcard_sql ||= "#{query.table_name}.*"
+  end
+
+  def table_wildcard_prepended?
+    query.values[:select]&.first == select_table_wildcard_sql
   end
 
-  def group_by_order?(order)
-    order.is_a?(String) && !order.match?(/\A\s*(COUNT|SUM)\(/i)
+  def select_statement
+    @select_statement ||= parsed_query.tree.dig!(0, "RawStmt", "stmt", "SelectStmt")
+  end
+
+  def select_targets
+    @select_targets ||= select_statement.fetch("targetList")
+  end
+
+  def sort_targets
+    return [] unless select_statement.key?("sortClause")
+
+    @sort_targets ||= parsed_query.tree.dig!(0, "RawStmt", "stmt", "SelectStmt", "sortClause")
   end
 end
 

data/lib/active_record_query_fixer/version.rb

@@ -1,3 +1,3 @@
 class ActiveRecordQueryFixer
-  VERSION = "0.0.7".freeze
+  VERSION = "0.0.12".freeze
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: active_record_query_fixer
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.12
 platform: ruby
 authors:
 - kaspernj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-17 00:00:00.000000000 Z
-dependencies: []
+date: 2020-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dig_bang
+  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'
+- !ruby/object:Gem::Dependency
+  name: pg_query
+  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: A library for automatically added `.select` on a column used for `.distinct`
   or automatically adding `.group` for a column used for order.
 email:
@@ -44,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A library for automatically added `.select` on a column used for `.distinct`