active_record_query_fixer 0.0.9 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 211d95cbf9d6f076875db25b572d387ccae0bab79966e5956b407fa585054114
-  data.tar.gz: 74dd84ce0e7573bd2a52864f02a2b0856d8c11caa45716946880476760a813d0
+  metadata.gz: d5997cfbf763c93ff62479b46f02fa52c769723be216b7c2f60e57847e90a41e
+  data.tar.gz: d7fc6189ee2f6ad8c8af6244ab1f9e1e8ab8f67b9ba5142f3465460efcf589cd
 SHA512:
-  metadata.gz: 497005381f08f135df4b672560b3a200ab9486252a8e1079d5e2f23fd11c6f22479296d9ff2eeada9f0b9d98b82a952ade57fa71f80c568cd43fcd0242a9f505
-  data.tar.gz: cc59eea2a2f6b2842d8d1583632780b91811171b69f50d3c0fe9fca8d7e78c80453bbc8dfd011c148f6527e2374aaa35729db7ce8c9e70887abfe4e9a36940ff
+  metadata.gz: 942395bf5a468635a435503793793c80e914b2b37036033b0ab7fd9fc714a6c8e16d46be0167088ad9eaf4b308cc0c1274db45b4668ec2aa96e45808e55d4215
+  data.tar.gz: 155a52f9bcc3720b1bff57fae6ccafe5167b3ae9b515fedb5e257a109e702f2f5227a7813b743aad256389e45fd4d6e475ec08e8d32611def21cabecf396727d

data/lib/active_record_query_fixer.rb

@@ -1,17 +1,19 @@
 require "dig_bang"
-require "pg_query"
 
 class ActiveRecordQueryFixer
   autoload :RelationExtentions, "#{__dir__}/active_record_query_fixer/relation_extentions"
 
-  attr_reader :query
+  attr_reader :count_select, :query
+
+  delegate :connection, to: :query
+  delegate :quote_column_name, :quote_table_name, to: :connection
 
   def self.fix(query)
     new(query: query).fix.query
   end
 
-  def initialize(args)
-    @query = args.fetch(:query)
+  def initialize(query:)
+    @query = query
     @count_select = 0
   end
 
@@ -19,74 +21,80 @@ 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
+  def fix_select_group # rubocop:disable Metrics/AbcSize
     select_targets.each do |select_target|
-      fields = select_target.dig!("ResTarget", "val", "ColumnRef", "fields")
-      next if fields.length != 2
+      fields = select_target.res_target.val.column_ref.fields
+      next if !fields || fields.length != 2
 
-      table = fields[0].dig("String", "str")
-      column = fields[1].dig("String", "str")
+      table = fields[0].string.str
+      column = fields[1].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")
+        @query = query.group("#{quote_table_name(table)}.#{quote_column_name(column)}")
+      elsif fields[1].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("#{quote_table_name(table)}.#{quote_column_name("id")}")
       end
     end
 
     self
   end
 
-  def fix_order_group
-    @query = @query.group(@query.model.arel_table[@query.model.primary_key])
+  def fix_order_group # rubocop:disable Metrics/AbcSize
+    @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")
+      fields = sort_target.sort_by.node.column_ref&.fields
+
       next if !fields || fields.length != 2
 
-      table = fields.dig(0, "String", "str")
-      column = fields.dig(1, "String", "str")
+      table = fields[0].string.str
+      column = fields[1].string.str
 
-      @query = @query.group("#{table}.#{column}") if table && column
+      @query = query.group("#{quote_table_name(table)}.#{quote_column_name(column)}") if table && column
     end
 
     self
   end
 
-  def fix_order_select_distinct
-    changed = false
+  def fix_order_select_distinct # rubocop:disable Metrics/AbcSize
+    select_appends = []
 
     sort_targets.each do |sort_target|
-      fields = sort_target.dig("SortBy", "node", "ColumnRef", "fields")
+      fields = sort_target.sort_by.node.column_ref.fields
       next if !fields || fields.length != 2
 
-      table = fields.dig(0, "String", "str")
-      column = fields.dig(1, "String", "str")
+      table = fields[0].string.str
+      column = fields[1].string.str
 
       next if !table || !column
 
-      @query = @query.select("#{table}.#{column} AS active_record_query_fixer_#{@count_select}")
-      changed = true
+      select_appends << "#{quote_table_name(table)}.#{quote_column_name(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("#{quote_table_name(reference)}.#{quote_column_name("id")}")
     end
 
     self
@@ -95,28 +103,53 @@ class ActiveRecordQueryFixer
 private
 
   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)
+    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 ||= "#{quote_table_name(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.stmts.fetch(0).stmt.select_stmt
   end
 
   def select_targets
-    @select_targets ||= parsed_query.tree.dig!(0, "RawStmt", "stmt", "SelectStmt", "targetList")
+    @select_targets ||= select_statement.target_list
   end
 
   def sort_targets
-    @sort_targets ||= parsed_query.tree.dig!(0, "RawStmt", "stmt", "SelectStmt", "sortClause")
+    @sort_targets ||= select_statement.sort_clause
   end
 end
 

data/lib/active_record_query_fixer/version.rb

@@ -1,3 +1,3 @@
 class ActiveRecordQueryFixer
-  VERSION = "0.0.9".freeze
+  VERSION = "0.0.14".freeze
 end

metadata

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