active_record_query_fixer 0.0.10 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fc75b0466693604d010e4489ac07fd724b21d3f5199b6379b92c3733c342cb4
-  data.tar.gz: bf0a66c2fb45fdcb762058c3749d13fe6273f0eba822462c4c112f7fece00b71
+  metadata.gz: 5faf0cd7f5d3fa4a60edd9a520032fc2d2c1d21f017c1bb5e8701d62cc341d1c
+  data.tar.gz: 7863addd51c71f1a5799cbac6ed94e1987742b19efb9a218f954384222f723b3
 SHA512:
-  metadata.gz: 00f4f4cbaf9d3e81e82c27e1a78a43867b8f511b29d398ff84624d462b7fef370a51b8e15d46e8462791222feb46e7d9a51718cafbec275aecb9a9da224e7c89
-  data.tar.gz: 92b877b63ae9e03d15d79ff9611091935aa94983fb7676b8d34a478919c67fc64e108e8f7615662dea586a16b49c2c1569a1880fdac72784b3917c2cc800b267
+  metadata.gz: a61caaae41ab19741b1837df67332e6a882625f8b7cd64c4ca5480c1e0c99bffd9ccf9d332004539e827c023db37a86f390fee502a093b9cdc0172b4ebca5df0
+  data.tar.gz: 6b76c2ba3b64bec72a0fb49f0ac17c71524c6d2cd48188fceb8c445fbc84485d98ea2c91dd13c719f7468e4d6bea97a6a16b4339ca31069644774f2edf12ae87

data/lib/active_record_query_fixer.rb

@@ -1,5 +1,4 @@
 require "dig_bang"
-require "pg_query"
 
 class ActiveRecordQueryFixer
   autoload :RelationExtentions, "#{__dir__}/active_record_query_fixer/relation_extentions"
@@ -19,25 +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_select_group if @query.values[:select] && @query.values[:group]
+    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", "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
 
@@ -45,7 +44,7 @@ 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")
@@ -54,14 +53,14 @@ class ActiveRecordQueryFixer
       table = fields.dig(0, "String", "str")
       column = fields.dig(1, "String", "str")
 
-      @query = @query.group("#{table}.#{column}") if table && column
+      @query = query.group("#{table}.#{column}") if table && column
     end
 
     self
   end
 
   def fix_order_select_distinct
-    changed = false
+    select_appends = []
 
     sort_targets.each do |sort_target|
       fields = sort_target.dig("SortBy", "node", "ColumnRef", "fields")
@@ -72,21 +71,25 @@ class ActiveRecordQueryFixer
 
       next if !table || !column
 
-      @query = @query.select("#{table}.#{column} AS active_record_query_fixer_#{@count_select}")
-      changed = true
+      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
@@ -95,20 +98,41 @@ class ActiveRecordQueryFixer
 private
 
   def fix_order_group?
-    @query.values[:joins].blank? && @query.values[:distinct].present? && @query.values[:order].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)
+    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

data/lib/active_record_query_fixer/version.rb

@@ -1,3 +1,3 @@
 class ActiveRecordQueryFixer
-  VERSION = "0.0.10".freeze
+  VERSION = "0.0.15".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_query_fixer
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.15
 platform: ruby
 authors:
 - kaspernj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-21 00:00:00.000000000 Z
+date: 2021-04-11 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: