active_record_query_fixer 0.0.8 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 748952394d906b747d5be0d64efd08b2c45b37015f0d3ce928622b63770c1eb9
-  data.tar.gz: f9ac5f0a73434c61e06058fad5dbad01167238caba974876135e3f13514e594b
+  metadata.gz: 95ad037bd6f75eeb6769488d667a077f6607414ff3c18e38b75dfe68ef783f3d
+  data.tar.gz: b1ad2dc43c9eb7fe1ccf671f5f184754329b964d66c1021f6bee2e7e25ae3507
 SHA512:
-  metadata.gz: fe806b25d8a1176f108450ba2e0d86cd5ff3b7e4a612cee1415b054bb3ffd33661e068eb1b9ecc4ce18f38714d083afd0405e9d4910ddf55db34baa593730d59
-  data.tar.gz: 027b8b485cf08c9d62a2ddcbaa33acf05ae3338da4f24d5454cfa266ef8939f9f79a880f66069048807e9333f374f54f00de285ef7a8d28a1ddc8daf609cb136
+  metadata.gz: 9312bb60d8dcc8c8d239e3dda2c6d6a5ef428751270bf86a19a99b0af8099ddd93c39444a93511f5e6aaf0daf499c2cd023b7632c5d3782349a276f6ac764a5f
+  data.tar.gz: bab25343f025ce024634c8403f7eccc08b4f966c7463658cbc72ba4ec44822ad2579715c8586ba4588e27fb78153c7938a548b4cbd7721f7c647dd679a34b830

data/lib/active_record_query_fixer.rb

@@ -1,3 +1,5 @@
+require "dig_bang"
+
 class ActiveRecordQueryFixer
   autoload :RelationExtentions, "#{__dir__}/active_record_query_fixer/relation_extentions"
 
@@ -16,31 +18,25 @@ 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_distinct_group_select if @query.values[:distinct] && @query.values[:group] && @query.values[:select]
+    fix_select_group if query.values[:select] && query.values[:group]
 
     self
   end
 
-  def fix_distinct_group_select
-    require "dig_bang"
-    require "pg_query"
-
-    parsed_query = PgQuery.parse(@query.to_sql)
-    select_targets = parsed_query.tree.dig!(0, "RawStmt", "stmt", "SelectStmt", "targetList")
-
+  def fix_select_group
     select_targets.each do |select_target|
-      fields = select_target.dig!("ResTarget", "val", "ColumnRef", "fields")
-      next if fields.length != 2
+      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}")
+        @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")
+        @query = query.group("#{table}.id")
       end
     end
 
@@ -48,33 +44,52 @@ class ActiveRecordQueryFixer
   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
@@ -82,35 +97,56 @@ class ActiveRecordQueryFixer
 
 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 group_by_order?(order)
-    order.is_a?(String) && !order.match?(/\A\s*(COUNT|SUM)\(/i)
+  def parsed_query
+    require "pg_query" unless defined?(PgQuery)
+    @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 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.8".freeze
+  VERSION = "0.0.13".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_query_fixer
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.13
 platform: ruby
 authors:
 - kaspernj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-20 00:00:00.000000000 Z
+date: 2020-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dig_bang
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !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: